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 / h261codec.h < prev    next >
C/C++ Source or Header  |  2003-04-03  |  13KB  |  407 lines
  1. /*
  2.  * h261codec.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): Michele Piccini (michele@piccini.com).
  25.  *                 Derek Smithies (derek@indranet.co.nz)
  26.  *
  27.  * $Log: h261codec.h,v $
  28.  * Revision 1.32  2003/04/03 23:54:11  robertj
  29.  * Added fast update to H.261 codec, thanks Gustavo Garcφa Bernardo
  30.  *
  31.  * Revision 1.31  2002/12/16 09:11:15  robertj
  32.  * Added new video bit rate control, thanks Walter H. Whitlock
  33.  *
  34.  * Revision 1.30  2002/09/16 01:14:15  robertj
  35.  * Added #define so can select if #pragma interface/implementation is used on
  36.  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  37.  *
  38.  * Revision 1.29  2002/09/03 06:19:36  robertj
  39.  * Normalised the multi-include header prevention ifdef/define symbol.
  40.  *
  41.  * Revision 1.28  2002/08/05 10:03:47  robertj
  42.  * Cosmetic changes to normalise the usage of pragma interface/implementation.
  43.  *
  44.  * Revision 1.27  2002/01/09 06:06:37  robertj
  45.  * Fixed setting of RTP timestamp values on video transmission.
  46.  *
  47.  * Revision 1.26  2002/01/09 00:21:36  robertj
  48.  * Changes to support outgoing H.245 RequstModeChange.
  49.  *
  50.  * Revision 1.25  2001/12/04 04:26:03  robertj
  51.  * Added code to allow change of video quality in H.261, thanks Damian Sandras
  52.  *
  53.  * Revision 1.24  2001/10/23 02:18:06  dereks
  54.  * Initial release of CU30 video codec.
  55.  *
  56.  * Revision 1.23  2001/09/25 03:14:47  dereks
  57.  * Add constant bitrate control for the h261 video codec.
  58.  * Thanks Tiziano Morganti for the code to set bit rate. Good work!
  59.  *
  60.  * Revision 1.22  2001/05/25 01:10:26  dereks
  61.  * Remove unnecessary packet receive variable.
  62.  * Alter the position of the check for change in frame size.
  63.  *
  64.  * Revision 1.21  2001/02/09 05:16:24  robertj
  65.  * Added #pragma interface for GNU C++.
  66.  *
  67.  * Revision 1.20  2001/01/25 07:27:14  robertj
  68.  * Major changes to add more flexible OpalMediaFormat class to normalise
  69.  *   all information about media types, especially codecs.
  70.  *
  71.  * Revision 1.19  2000/12/19 22:33:44  dereks
  72.  * Adjust so that the video channel is used for reading/writing raw video
  73.  * data, which better modularizes the video codec.
  74.  *
  75.  * Revision 1.18  2000/08/21 04:45:06  dereks
  76.  * Fix dangling pointer that caused segfaults for windows&unix users.
  77.  * Improved the test image which is used when video grabber won't open.
  78.  * Added code to handle setting of video Tx Quality.
  79.  * Added code to set the number of background blocks sent with every frame.
  80.  *
  81.  * Revision 1.17  2000/07/04 13:00:36  craigs
  82.  * Fixed problem with selecting large and small video sizes
  83.  *
  84.  * Revision 1.16  2000/05/18 11:53:33  robertj
  85.  * Changes to support doc++ documentation generation.
  86.  *
  87.  * Revision 1.15  2000/05/10 04:05:26  robertj
  88.  * Changed capabilities so has a function to get name of codec, instead of relying on PrintOn.
  89.  *
  90.  * Revision 1.14  2000/05/02 04:32:24  robertj
  91.  * Fixed copyright notice comment.
  92.  *
  93.  * Revision 1.13  2000/03/30 23:10:50  robertj
  94.  * Fixed error in comments regarding GetFramerate() function.
  95.  *
  96.  * Revision 1.12  2000/03/21 03:06:47  robertj
  97.  * Changes to make RTP TX of exact numbers of frames in some codecs.
  98.  *
  99.  * Revision 1.11  2000/02/04 05:00:08  craigs
  100.  * Changes for video transmission
  101.  *
  102.  * Revision 1.10  2000/01/13 04:03:45  robertj
  103.  * Added video transmission
  104.  *
  105.  * Revision 1.9  1999/12/23 23:02:34  robertj
  106.  * File reorganision for separating RTP from H.323 and creation of LID for VPB support.
  107.  *
  108.  * Revision 1.8  1999/11/29 08:59:56  craigs
  109.  * Added new stuff for new video codec interface
  110.  *
  111.  * Revision 1.7  1999/11/01 00:52:00  robertj
  112.  * Fixed various problems in video, especially ability to pass error return value.
  113.  *
  114.  * Revision 1.6  1999/10/08 09:59:02  robertj
  115.  * Rewrite of capability for sending multiple audio frames
  116.  *
  117.  * Revision 1.5  1999/10/08 04:58:37  robertj
  118.  * Added capability for sending multiple audio frames in single RTP packet
  119.  *
  120.  * Revision 1.4  1999/09/21 14:03:41  robertj
  121.  * Changed RTP data frame parameter in Write() to be const.
  122.  *
  123.  * Revision 1.3  1999/09/21 08:12:50  craigs
  124.  * Added support for video codecs and H261
  125.  *
  126.  * Revision 1.2  1999/09/18 13:27:24  craigs
  127.  * Added ability disable jitter buffer for codecs
  128.  * Added ability to access entire RTP frame from codec Write
  129.  *
  130.  * Revision 1.1  1999/09/08 04:05:48  robertj
  131.  * Added support for video capabilities & codec, still needs the actual codec itself!
  132.  *
  133.  */
  134.  
  135. #ifndef __OPAL_H261CODEC_H
  136. #define __OPAL_H261CODEC_H
  137.  
  138. #ifdef P_USE_PRAGMA
  139. #pragma interface
  140. #endif
  141.  
  142.  
  143. #include "h323caps.h"
  144.  
  145.  
  146. class P64Decoder;
  147. class P64Encoder;
  148.  
  149.  
  150.  
  151. ///////////////////////////////////////////////////////////////////////////////
  152.  
  153. /**This class is a H.261 video capability.
  154.  */
  155. class H323_H261Capability : public H323VideoCapability
  156. {
  157.   PCLASSINFO(H323_H261Capability, H323VideoCapability)
  158.  
  159.   public:
  160.   /**@name Construction */
  161.   //@{
  162.     /**Create a new H261 Capability
  163.      */
  164.     H323_H261Capability(
  165.       unsigned qcifMPI,
  166.       unsigned cifMPI,
  167.       BOOL temporalSpatialTradeOffCapability = TRUE,
  168.       BOOL stillImageTransmission = FALSE,
  169.       unsigned maxBitRate = 850
  170.     );
  171.   //@}
  172.  
  173.   /**@name Overrides from class PObject */
  174.   //@{
  175.     /**Create a copy of the object.
  176.       */
  177.     virtual PObject * Clone() const;
  178.   //@}
  179.  
  180.   
  181.   /**@name Overrides from class PObject */
  182.   //@{
  183.     /**Compare object
  184.       */
  185.    Comparison Compare(const PObject & obj) const;
  186.    //@}
  187.  
  188.   /**@name Identification functions */
  189.   //@{
  190.     /**Get the sub-type of the capability. This is a code dependent on the
  191.        main type of the capability.
  192.  
  193.        This returns one of the four possible combinations of mode and speed
  194.        using the enum values of the protocol ASN H245_AudioCapability class.
  195.      */
  196.     virtual unsigned GetSubType() const;
  197.  
  198.     /**Get the name of the media data format this class represents.
  199.      */
  200.     virtual PString GetFormatName() const;
  201.   //@}
  202.  
  203.   /**@name Protocol manipulation */
  204.   //@{
  205.     /**This function is called whenever and outgoing TerminalCapabilitySet
  206.        or OpenLogicalChannel PDU is being constructed for the control channel.
  207.        It allows the capability to set the PDU fields from information in
  208.        members specific to the class.
  209.  
  210.        The default behaviour sets the data rate field in the PDU.
  211.      */
  212.     virtual BOOL OnSendingPDU(
  213.       H245_VideoCapability & pdu  /// PDU to set information on
  214.     ) const;
  215.  
  216.     /**This function is called whenever and outgoing RequestMode
  217.        PDU is being constructed for the control channel. It allows the
  218.        capability to set the PDU fields from information in members specific
  219.        to the class.
  220.  
  221.        The default behaviour sets the resolution and bit rate.
  222.      */
  223.     virtual BOOL OnSendingPDU(
  224.       H245_VideoMode & pdu  /// PDU to set information on
  225.     ) const;
  226.  
  227.     /**This function is called whenever and incoming TerminalCapabilitySet
  228.        or OpenLogicalChannel PDU has been used to construct the control
  229.        channel. It allows the capability to set from the PDU fields,
  230.        information in members specific to the class.
  231.  
  232.        The default behaviour gets the data rate field from the PDU.
  233.      */
  234.     virtual BOOL OnReceivedPDU(
  235.       const H245_VideoCapability & pdu  /// PDU to set information on
  236.     );
  237.  
  238.     /**Create the codec instance, allocating resources as required.
  239.      */
  240.     virtual H323Codec * CreateCodec(
  241.       H323Codec::Direction direction  /// Direction in which this instance runs
  242.     ) const;
  243.  
  244.     /** Get temporal/spatial tradeoff capabilty
  245.      */
  246.     BOOL GetTemporalSpatialTradeOffCapability() const
  247.       { return temporalSpatialTradeOffCapability; }
  248.  
  249.     /** Get still image transmission flag
  250.      */
  251.     BOOL GetStillImageTransmission() const
  252.       { return stillImageTransmission; }
  253.  
  254.     /** Get maximum bit rate
  255.      */
  256.     unsigned GetMaxBitRate() const
  257.       { return maxBitRate; }
  258.  
  259.     /** Get qcifMPI
  260.      */
  261.     unsigned GetQCIFMPI() const
  262.       { return qcifMPI; }
  263.  
  264.     /** Get cifMPI
  265.      */
  266.     unsigned GetCIFMPI() const
  267.       { return cifMPI; }
  268.  
  269.   //@}
  270.  
  271.   protected:
  272.     unsigned qcifMPI;                   // 1..4 units 1/29.97 Hz
  273.     unsigned cifMPI;                    // 1..4 units 1/29.97 Hz
  274.     BOOL     temporalSpatialTradeOffCapability;
  275.     unsigned maxBitRate;                // units of 100 bit/s
  276.     BOOL     stillImageTransmission;    // Annex D of H.261
  277. };
  278.  
  279.  
  280. /**This class is a H.261 video codec.
  281.  */
  282. class H323_H261Codec : public H323VideoCodec
  283. {
  284.   PCLASSINFO(H323_H261Codec, H323VideoCodec)
  285.  
  286.   public:
  287.     /**Create a new H261 video codec
  288.      */
  289.     H323_H261Codec(
  290.       Direction direction,        /// Direction in which this instance runs
  291.       BOOL isqCIF
  292.     );
  293.     ~H323_H261Codec();
  294.  
  295.     /**Encode the data from the appropriate device.
  296.        This will encode a frame of data for transmission. The exact size and
  297.        description of the data placed in the buffer is codec dependent but
  298.        should be less than H323Capability::GetTxFramesInPacket() *
  299.        OpalMediaFormat::GetFrameSize()  in length.
  300.  
  301.        The length parameter is filled with the actual length of the encoded
  302.        data, often this will be the same as the size parameter.
  303.  
  304.        This function is called every GetFrameRate() timestamp units, so MUST
  305.        take less than (or equal to) that amount of time to complete!
  306.  
  307.        Note that a returned length of zero indicates that time has passed but
  308.        there is no data encoded. This is typically used for silence detection
  309.        in an audio codec.
  310.      */
  311.     virtual BOOL Read(
  312.       BYTE * buffer,            /// Buffer of encoded data
  313.       unsigned & length,        /// Actual length of encoded data buffer
  314.       RTP_DataFrame & rtpFrame  /// RTP data frame
  315.     );
  316.  
  317.     /**Decode the data and output it to appropriate device.
  318.        This will decode a single frame of received data. The exact size and
  319.        description of the data required in the buffer is codec dependent but
  320.        should be less than H323Capability::GetRxFramesInPacket() *
  321.        OpalMediaFormat::GetFrameSize()  in length.
  322.  
  323.        It is expected this function anunciates the data. That is, for example
  324.        with audio data, the sound is output on a speaker.
  325.  
  326.        This function is called every GetFrameRate() timestamp units, so MUST
  327.        take less than that amount of time to complete!
  328.      */
  329.     virtual BOOL Write(
  330.       const BYTE * buffer,        /// Buffer of encoded data
  331.       unsigned length,            /// Length of encoded data buffer
  332.       const RTP_DataFrame & rtp,  /// RTP data frame
  333.       unsigned & written          /// Number of bytes used from data buffer
  334.     );
  335.  
  336.     /**Get the frame rate in RTP timestamp units.
  337.       */
  338.     virtual unsigned GetFrameRate() const { return timestampDelta; }
  339.  
  340.     /**Set the quality level of transmitted video data. 
  341.        Is irrelevant when this codec is used to receive video data.
  342.        Has a value of 1 (good quality) to 31 (poor quality).
  343.        Quality is improved at the expense of bit rate.
  344.     */
  345.     void SetTxQualityLevel(int qLevel);
  346.  
  347.     /**Minimum quality limit for the transmitted video.
  348.      * Default is 1.  Encode quality will not be set below this value.
  349.      */
  350.     void SetTxMinQuality(int qlevel);
  351.  
  352.     /**Maximum quality limit for the transmitted video.
  353.      * Default is 24.  Encode quality will not be set above this value.
  354.      */
  355.     void SetTxMaxQuality(int qlevel);
  356.  
  357.     /**Set the number of blocks in the background that need
  358.        to be transmitted with each frame
  359.     */
  360.     void SetBackgroundFill(int fillLevel);
  361.  
  362.     /**Process a FastUpdatePicture command from remote endpoint.
  363.        The default behaviour does nothing.
  364.      */
  365.     virtual void OnFastUpdatePicture();
  366.  
  367.     /**Process a request for a new frame, 
  368.        as part of the picture has been lost.
  369.     */
  370.     virtual void OnLostPartialPicture();
  371.  
  372.     /**Process a request for a new frame, 
  373.        as all of the picture has been lost.
  374.     */
  375.     virtual void OnLostPicture();
  376.  
  377.     ////////////////////////////////////////////////////////////////
  378.     //There is a problem with the H261codec. It needs to be able to 
  379.     //carry out two tasks. 1)Grab data from the camera.
  380.     //2)Render data from an array.
  381.     //Thus, we either: two PVideoChannels, or one PVideoChannel to both
  382.     //grab and render.
  383.     //We use one PVideoChannel, which is not consistant with elsewhere,
  384.     //but enables us to (later) have a grab and display process irrespective
  385.     //of there being a H323 connection.
  386.  
  387.  
  388.   protected:
  389.     BOOL Resize(int width, int height);
  390.     BOOL Redraw();
  391.     BOOL RenderFrame();
  392.  
  393.     P64Decoder       * videoDecoder;
  394.     P64Encoder       * videoEncoder;
  395.  
  396.     int now;
  397.     BYTE * rvts;
  398.     int ndblk, nblk;
  399.     unsigned timestampDelta;
  400. };
  401.  
  402.  
  403. #endif // __OPAL_H261CODEC_H
  404.  
  405.  
  406. /////////////////////////////////////////////////////////////////////////////
  407.