home *** CD-ROM | disk | FTP | other *** search
/ ftp.muug.mb.ca / 2014.06.ftp.muug.mb.ca.tar / ftp.muug.mb.ca / pub / openh323.tar.gz / openh323.tar / openh323 / include / h263codec.h < prev    next >
C/C++ Source or Header  |  2003-08-03  |  13KB  |  465 lines
  1. /*
  2.  * h263codec.h
  3.  *
  4.  * H.323 protocol handler
  5.  *
  6.  * Open H323 Library
  7.  *
  8.  * Copyright (c) 1999-2000 Equivalence Pty. Ltd.
  9.  *
  10.  * The contents of this file are subject to the Mozilla Public License
  11.  * Version 1.0 (the "License"); you may not use this file except in
  12.  * compliance with the License. You may obtain a copy of the License at
  13.  * http://www.mozilla.org/MPL/
  14.  *
  15.  * Software distributed under the License is distributed on an "AS IS"
  16.  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17.  * the License for the specific language governing rights and limitations
  18.  * under the License.
  19.  *
  20.  * The Original Code is Open H323 Library.
  21.  *
  22.  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  23.  *
  24.  * Contributor(s): Guilhem Tardy (gtardy@marchnetworks.com)
  25.  *
  26.  * $Log: h263codec.h,v $
  27.  * Revision 1.14  2003/08/04 00:03:22  dereksmithies
  28.  * Reorganise tests for enabled
  29.  *
  30.  * Revision 1.13  2003/07/24 08:08:42  dereksmithies
  31.  * Update to use vich263 codec, instead of ffmpeg.
  32.  *
  33.  * Revision 1.12  2003/06/06 05:18:54  dereksmithies
  34.  * Fix startup delay bug. Remove all large packets from the network. Improve reliability.
  35.  *
  36.  * Revision 1.11  2003/05/27 09:22:55  dereksmithies
  37.  * Updates for code revisions in h263 codec
  38.  *
  39.  * Revision 1.10  2003/05/14 13:47:58  rjongbloed
  40.  * Removed static "initialisation" function as this should be done
  41.  *   internally and not in the application.
  42.  *
  43.  * Revision 1.9  2003/05/05 11:59:21  robertj
  44.  * Changed to use autoconf style selection of options and subsystems.
  45.  *
  46.  * Revision 1.8  2003/05/02 04:22:10  craigs
  47.  * Added lots of extra H.263 support
  48.  *
  49.  * Revision 1.7  2003/04/27 09:16:38  rogerh
  50.  * use PBYTE_ORDER instead of endian.h
  51.  *
  52.  * Revision 1.6  2003/04/21 21:50:22  dereks
  53.  * Implement suggestion from Guilhem Tardy. Many thanks.
  54.  *
  55.  * Revision 1.5  2003/04/16 04:26:57  dereks
  56.  * Initial release of h263 codec, which utilises the ffmpeg library.
  57.  * Thanks to Guilhem Tardy, and to AliceStreet.
  58.  *
  59.  * Revision 1.4  2002/09/16 01:14:15  robertj
  60.  * Added #define so can select if #pragma interface/implementation is used on
  61.  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  62.  *
  63.  * Revision 1.3  2002/09/03 06:19:36  robertj
  64.  * Normalised the multi-include header prevention ifdef/define symbol.
  65.  *
  66.  * Revision 1.2  2002/08/05 10:03:47  robertj
  67.  * Cosmetic changes to normalise the usage of pragma interface/implementation.
  68.  *
  69.  * Revision 1.1  2002/05/19 22:32:46  dereks
  70.  * Initial release of stub file for h263 codec. Thanks Guilhem Tardy.
  71.  *
  72.  *
  73.  *
  74.  */
  75.  
  76. /*
  77.  * Initial release notes from Guilhem Tardy::
  78.  *
  79.  * Added support for video capabilities & codec, only tested under Linux!
  80.  * The code for varying bit rate is copied from h261codec.cxx,
  81.  * until it is moved to a separate file common to both video codecs.
  82.  *
  83.  */
  84.  
  85. #ifndef __OPAL_H263CODEC_H
  86. #define __OPAL_H263CODEC_H
  87.  
  88. #ifdef P_USE_PRAGMA
  89. #pragma interface
  90. #endif
  91.  
  92. #include <openh323buildopts.h>
  93.  
  94.  
  95. #include "h323caps.h"
  96.  
  97. #if defined(H323_VICH263)
  98.  
  99. class H263Decoder;
  100. class H263Encoder;
  101.  
  102. ///////////////////////////////////////////////////////////////////////////////
  103.  
  104. /**This class is a H.263 video capability.
  105.  */
  106.  
  107. class H323_H263Capability : public H323VideoCapability
  108. {
  109.   PCLASSINFO(H323_H263Capability, H323VideoCapability)
  110.  
  111.   public:
  112.   /**@name Construction */
  113.   //@{
  114.     /**Create a new H263 Capability
  115.      */
  116.     H323_H263Capability(
  117.       unsigned sqcifMPI,
  118.       unsigned qcifMPI,
  119.       unsigned cifMPI,
  120.       unsigned cif4MPI,
  121.       unsigned cif16MPI,
  122.       unsigned maxBitRate = 850,
  123.       unsigned videoFrameRate = 25,
  124.       BOOL unrestrictedVector = FALSE,
  125.       BOOL arithmeticCoding = FALSE,
  126.       BOOL advancedPrediction = FALSE,
  127.       BOOL pbFrames = FALSE,
  128.       BOOL temporalSpatialTradeOff = TRUE,
  129.       unsigned hrd_B = 0,
  130.       unsigned bppMaxKb = 0,
  131.       unsigned slowSqcifMPI = 0,
  132.       unsigned slowQcifMPI = 0,
  133.       unsigned slowCifMPI = 0,
  134.       unsigned slowCif4MPI = 0,
  135.       unsigned slowCif16MPI = 0,
  136.       BOOL errorCompensation = FALSE
  137.     );
  138.   //@}
  139.  
  140.   /**@name Overrides from class PObject */
  141.   //@{
  142.     /**Create a copy of the object.
  143.       */
  144.     virtual PObject * Clone() const;
  145.   //@}
  146.  
  147.   
  148.   /**@name Overrides from class PObject */
  149.   //@{
  150.     /**Compare object
  151.       */
  152.     Comparison Compare(const PObject & obj) const;
  153.    //@}
  154.  
  155.   /**@name Identification functions */
  156.   //@{
  157.     /**Get the sub-type of the capability. This is a code dependent on the
  158.        main type of the capability.
  159.  
  160.        This returns one of the four possible combinations of mode and speed
  161.        using the enum values of the protocol ASN H245_AudioCapability class.
  162.      */
  163.     virtual unsigned GetSubType() const;
  164.  
  165.     /**Get the name of the media data format this class represents.
  166.      */
  167.     virtual PString GetFormatName() const;
  168.   //@}
  169.  
  170.   /**@name Protocol manipulation */
  171.   //@{
  172.     /**This function is called whenever and outgoing TerminalCapabilitySet
  173.        or OpenLogicalChannel PDU is being constructed for the control channel.
  174.        It allows the capability to set the PDU fields from information in
  175.        members specific to the class.
  176.  
  177.        The default behaviour sets the data rate field in the PDU.
  178.      */
  179.     virtual BOOL OnSendingPDU(
  180.       H245_VideoCapability & pdu  /// PDU to set information on
  181.     ) const;
  182.  
  183.     /**This function is called whenever and outgoing RequestMode
  184.        PDU is being constructed for the control channel. It allows the
  185.        capability to set the PDU fields from information in members specific
  186.        to the class.
  187.  
  188.        The default behaviour sets the resolution and bit rate.
  189.      */
  190.     virtual BOOL OnSendingPDU(
  191.       H245_VideoMode & pdu  /// PDU to set information on
  192.     ) const;
  193.  
  194.     /**This function is called whenever and incoming TerminalCapabilitySet
  195.        or OpenLogicalChannel PDU has been used to construct the control
  196.        channel. It allows the capability to set from the PDU fields,
  197.        information in members specific to the class.
  198.  
  199.        The default behaviour gets the data rate field from the PDU.
  200.      */
  201.     virtual BOOL OnReceivedPDU(
  202.       const H245_VideoCapability & pdu  /// PDU to set information on
  203.     );
  204.  
  205.     /**Create the codec instance, allocating resources as required.
  206.      */
  207.     virtual H323Codec * CreateCodec(
  208.       H323Codec::Direction direction  /// Direction in which this instance runs
  209.     ) const;
  210.  
  211. #if 0
  212.     /** Get sqcifMPI
  213.      */
  214.     unsigned GetSQCIFMPI() const
  215.       { return sqcifMPI); }
  216.  
  217.     /** Get qcifMPI
  218.      */
  219.     unsigned GetQCIFMPI() const
  220.       { return qcifMPI; }
  221.  
  222.     /** Get cifMPI
  223.      */
  224.     unsigned GetCIFMPI() const
  225.       { return cifMPI; }
  226.  
  227.     /** Get cif4MPI
  228.      */
  229.     unsigned GetCIF4MPI() const
  230.       { return cif4MPI; }
  231.  
  232.     /** Get cif16MPI
  233.      */
  234.     unsigned GetCIF16MPI() const
  235.       { return cif16MPI; }
  236.  
  237.     /** Get maximum bit rate
  238.      */
  239.     unsigned GetMaxBitRate() const
  240.       { return maxBitRate; }
  241.  
  242.     /** Get unrestrictedVector capabilty
  243.      */
  244.     BOOL GetUnrestrictedVectorCapability() const
  245.       { return unrestrictedVector; }
  246.  
  247.     /** Get arithmeticCoding capabilty
  248.      */
  249.     BOOL GetArithmeticCodingCapability() const
  250.       { return arithmeticCoding; }
  251.  
  252.     /** Get advancedPrediction capabilty
  253.      */
  254.     BOOL GetAdvancedPredictionCapability() const
  255.       { return advancedPrediction; }
  256.  
  257.     /** Get  pbFrames capabilty
  258.      */
  259.     BOOL GetPbFramesCapability() const
  260.       { return pbFrames; }
  261.  
  262.     /** Get temporal/spatial tradeoff capabilty
  263.      */
  264.     BOOL GetTemporalSpatialTradeOffCapability() const
  265.       { return temporalSpatialTradeOff; }
  266.  
  267.     /** Get hrd_B
  268.      */
  269.     BOOL GetHrd_B() const
  270.       { return hrd_B; }
  271.  
  272.     /** Get bppMaxKb
  273.      */
  274.     BOOL GetBppMaxKb() const
  275.       { return bppMaxKb; }
  276.  
  277.     /** Get slowSqcifMPI
  278.      */
  279.     unsigned GetSlowSQCIFMPI() const
  280.       { return (sqcifMPI<0?-sqcifMPI:0); }
  281.  
  282.     /** Get slowQcifMPI
  283.      */
  284.     unsigned GetSlowQCIFMPI() const
  285.       { return (qcifMPI<0?-qcifMPI:0); }
  286.  
  287.     /** Get slowCifMPI
  288.      */
  289.     unsigned GetSlowCIFMPI() const
  290.       { return (cifMPI<0?-cifMPI:0); }
  291.  
  292.     /** Get slowCif4MPI
  293.      */
  294.     unsigned GetSlowCIF4MPI() const
  295.       { return (cif4MPI<0?-cif4MPI:0); }
  296.  
  297.     /** Get slowCif16MPI
  298.      */
  299.     unsigned GetSlowCIF16MPI() const
  300.       { return (cif16MPI<0?-cif16MPI:0); }
  301.  
  302.     /** Get errorCompensation capabilty
  303.      */
  304.     BOOL GetErrorCompensationCapability() const
  305.       { return errorCompensation; }
  306. #endif
  307.  
  308.   //@}
  309.  
  310. protected:
  311.     // H.263 v1
  312.     signed sqcifMPI;        // {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
  313.     signed qcifMPI;        // {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
  314.     signed cifMPI;        // {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
  315.     signed cif4MPI;        // {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
  316.     signed cif16MPI;        // {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
  317.  
  318.     unsigned maxBitRate;    // units of bit/s
  319.     unsigned videoFrameRate;   // frames per second.
  320.  
  321.     BOOL     unrestrictedVector;
  322.     BOOL     arithmeticCoding;
  323.     BOOL     advancedPrediction;
  324.     BOOL     pbFrames;
  325.     BOOL     temporalSpatialTradeOff;
  326.  
  327.     long unsigned hrd_B;    // units of 128 bits
  328.     unsigned bppMaxKb;        // units of 1024 bits
  329.  
  330.     BOOL     errorCompensation;
  331. };
  332.  
  333. ///////////////////////////////////////////////////////////////
  334. /**This class is a H.263 video codec.
  335.  */
  336. class H323_H263Codec : public H323VideoCodec
  337. {
  338.   PCLASSINFO(H323_H263Codec, H323VideoCodec)
  339.  
  340.   public:
  341.     /**Create a new H263 video codec
  342.      */
  343.     H323_H263Codec(
  344.       Direction direction,    /// Direction in which this instance runs      
  345.       unsigned sqcifMPI,
  346.       unsigned qcifMPI,
  347.       unsigned cifMPI,
  348.       unsigned cif4MPI,
  349.       unsigned cif16MPI,
  350.       unsigned maxBitRate,
  351.       unsigned videoFrameRate
  352.     );
  353.  
  354.     ~H323_H263Codec();
  355.  
  356.     /**Encode the data from the appropriate device.
  357.        This will encode a frame of data for transmission. The exact size and
  358.        description of the data placed in the buffer is codec dependent but
  359.        should be less than H323Capability::GetTxFramesInPacket() *
  360.        OpalMediaFormat::GetFrameSize()  in length.
  361.  
  362.        The length parameter is filled with the actual length of the encoded
  363.        data, often this will be the same as the size parameter.
  364.  
  365.        This function is called every GetFrameRate() timestamp units, so MUST
  366.        take less than (or equal to) that amount of time to complete!
  367.  
  368.        Note that a returned length of zero indicates that time has passed but
  369.        there is no data encoded. This is typically used for silence detection
  370.        in an audio codec.
  371.      */
  372.     virtual BOOL Read(
  373.       BYTE * buffer,        /// Buffer of encoded data
  374.       unsigned & length,    /// Actual length of encoded data buffer
  375.       RTP_DataFrame & rtpFrame    /// RTP data frame
  376.     );
  377.  
  378.     /**Decode the data and output it to appropriate device.
  379.        This will decode a single frame of received data. The exact size and
  380.        description of the data required in the buffer is codec dependent but
  381.        should be less than H323Capability::GetRxFramesInPacket() *
  382.        OpalMediaFormat::GetFrameSize()  in length.
  383.  
  384.        It is expected this function anunciates the data. That is, for example
  385.        with audio data, the sound is output on a speaker.
  386.  
  387.        This function is called every GetFrameRate() timestamp units, so MUST
  388.        take less than that amount of time to complete!
  389.      */
  390.     virtual BOOL Write(
  391.       const BYTE * buffer,      /// Buffer of encoded data
  392.       unsigned length,          /// Length of encoded data buffer
  393.       const RTP_DataFrame & rtp,  /// RTP data frame
  394.       unsigned & written      /// Number of bytes used from data buffer
  395.     );
  396.  
  397.     /**Get the frame rate in RTP timestamp units.
  398.       */
  399.     virtual unsigned GetFrameRate() const { return timestampDelta; }
  400.  
  401.     /**Set the quality level of transmitted video data. 
  402.        Is irrelevant when this codec is used to receive video data.
  403.        Has a value of 1 (good quality) to 31 (poor quality).
  404.        Quality is improved at the expense of bit rate.
  405.     */
  406.     void SetTxQualityLevel(int qLevel);
  407.  
  408.     /**Set the number of blocks in the background that need
  409.        to be transmitted with each frame
  410.     */
  411.     void SetBackgroundFill(int fillLevel);
  412.  
  413.     /**Process a request for a new frame, 
  414.        as part of the picture has been lost.
  415.     */
  416.     virtual void OnLostPartialPicture();
  417.  
  418.     /**
  419.        Process a request for a new frame, 
  420.        as all of the picture has been lost.
  421.     */
  422.     virtual void OnLostPicture();
  423.  
  424.     /**
  425.        The ffmpeg library calls this routine, everytime it has a new packet to 
  426.        send. Note that for every encode thread, this 1 method is called. Consequently, 
  427.        code is required to separate out packets from different encode threads.
  428.     */
  429.     static void RtpCallback(void *data, int size, int packetNumber);
  430.  
  431.   protected:
  432.     BOOL Resize(int width, int height);
  433.  
  434.     BOOL RenderFrame(); 
  435.     BOOL RenderFrame(const void * buffer);
  436.  
  437.  
  438.  
  439.     void InitialiseCodec();
  440.     void CloseCodec();
  441.  
  442.  
  443.     unsigned timestampDelta;
  444.  
  445.     H263Decoder *videoDecoder;
  446.     H263Encoder *videoEncoder;
  447.  
  448.     int now;
  449.     BYTE * rvts;
  450.     int ndblk, nblk;
  451.    
  452.     PTime           startTime;
  453.     PINDEX          bitsSent;
  454.  
  455.     unsigned        lastebits;
  456. };
  457.  
  458. #endif // H323_VICH263
  459. #endif // __OPAL_H263CODEC_H
  460.  
  461.  
  462.  
  463.  
  464. /////////////////////////////////////////////////////////////////////////////
  465.