include/rfc2190avcodec.h

   1 /*
   2  * rfc2190avcodec.h
   3  *
   4  * H.323 protocol handler
   5  *
   6  * Open H323 Library
   7  *
   8  * Copyright (c) 2001 March Networks Corporation
   9  * Copyright (c) 1999-2000 Equivalence Pty. Ltd.
  10  *
  11  * The contents of this file are subject to the Mozilla Public License
  12  * Version 1.0 (the "License"); you may not use this file except in
  13  * compliance with the License. You may obtain a copy of the License at
  14  * http://www.mozilla.org/MPL/
  15  *
  16  * Software distributed under the License is distributed on an "AS IS"
  17  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  18  * the License for the specific language governing rights and limitations
  19  * under the License.
  20  *
  21  * The Original Code is Open H323 Library.
  22  *
  23  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  24  *
  25  * Contributor(s): Guilhem Tardy (gtardy@salyens.com)
  26  *
  27  * $Log$
  28  * Revision 1.6  2006/08/01 06:17:50  csoutheren
  29  * Fix bit rate control units
  30  * Add access function on code for max bit rate
  31  * Thanks to Paolo Amadini
  32  *
  33  * Revision 1.5  2006/07/19 07:18:17  csoutheren
  34  * Fixed problem with timing in H.263 video codec
  35  * Thanks to Paolo Amadini
  36  *
  37  * Revision 1.4  2004/05/12 23:18:44  csoutheren
  38  * Adjusted copyright notices for ffh263 and rfc2190 files
  39  *
  40  * Revision 1.3  2004/04/24 00:41:14  rjongbloed
  41  * Fixed file names in header comment.
  42  *
  43  * Revision 1.2  2004/04/22 22:35:00  csoutheren
  44  * Fixed mispelling of Guilhem Tardy - my apologies to him
  45  *
  46  * Revision 1.1  2004/04/22 22:20:34  csoutheren
  47  * New files for RFC2190 H.263 video codec
  48  * Added RFC 2190 H.263 code as created by Guilhem Tardy and AliceStreet
  49  * Many thanks to them for their contributions.
  50  *
  51  * Revision 1.5  2003/10/31 00:00:00  Guilhem Tardy
  52  * Restored RFC2190 compliance.
  53  *
  54  * Revision 1.4  2003/10/05 00:00:00  Guilhem Tardy
  55  * Reintroduce ffmpeg own packet slicing technique (now working better).
  56  *
  57  * Revision 1.3  2003/08/04 00:03:16  dereksmithies
  58  * Reorganise tests for enabled
  59  *
  60  * Revision 1.2  2003/07/31 05:08:24  dereksmithies
  61  * Switch to manual packet fragment technique. Much more reliable, especially so on windows.
  62  *
  63  * Revision 1.1  2003/07/24 05:23:06  dereksmithies
  64  * Move ffmpeg h263 support to this file, and designate non standard.
  65  *
  66  * Revision 1.12  2003/06/06 05:18:54  dereksmithies
  67  * Fix startup delay bug. Remove all large packets from the network. Improve reliability.
  68  *
  69  * Revision 1.11  2003/05/27 09:22:55  dereksmithies
  70  * Updates for code revisions in h263 codec
  71  *
  72  * Revision 1.10  2003/05/14 13:47:58  rjongbloed
  73  * Removed static "initialisation" function as this should be done
  74  *   internally and not in the application.
  75  *
  76  * Revision 1.9  2003/05/05 11:59:21  robertj
  77  * Changed to use autoconf style selection of options and subsystems.
  78  *
  79  * Revision 1.8  2003/05/02 04:22:10  craigs
  80  * Added lots of extra H.263 support
  81  *
  82  * Revision 1.7  2003/04/27 09:16:38  rogerh
  83  * use PBYTE_ORDER instead of endian.h
  84  *
  85  * Revision 1.6  2003/04/21 21:50:22  dereks
  86  * Implement suggestion from Guilhem Tardy. Many thanks.
  87  *
  88  * Revision 1.5  2003/04/16 04:26:57  dereks
  89  * Initial release of h263 codec, which utilises the ffmpeg library.
  90  * Thanks to Guilhem Tardy, and to AliceStreet.
  91  *
  92  * Revision 1.4  2002/09/16 01:14:15  robertj
  93  * Added #define so can select if #pragma interface/implementation is used on
  94  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  95  *
  96  * Revision 1.3  2002/09/03 06:19:36  robertj
  97  * Normalised the multi-include header prevention ifdef/define symbol.
  98  *
  99  * Revision 1.2  2002/08/05 10:03:47  robertj
 100  * Cosmetic changes to normalise the usage of pragma interface/implementation.
 101  *
 102  * Revision 1.1  2002/05/19 22:32:46  dereks
 103  * Initial release of stub file for h263 codec. Thanks Guilhem Tardy.
 104  *
 105  *
 106  *
 107  */
 108
 109 /*
 110  * Initial release notes from Guilhem Tardy::
 111  *
 112  * Added support for video capabilities & codec, only tested under Linux!
 113  * The code for varying bit rate is copied from h261codec.cxx,
 114  * until it is moved to a separate file common to both video codecs.
 115  *
 116  */
 117
 118 #ifndef __OPAL_FFH263CODEC_H
 119 #define __OPAL_FFH263CODEC_H
 120
 121 #ifdef P_USE_PRAGMA
 122 #pragma interface
 123 #endif
 124
 125 #ifdef H323_RFC2190_AVCODEC
 126 struct AVCodec;
 127 struct AVCodecContext;
 128 struct AVFrame;
 129
 130 #include <ptclib/delaychan.h>
 131
 132 ///////////////////////////////////////////////////////////////////////////////
 133
 134 /**This class is a H.263 video capability.
 135  */
 136 class H323_RFC2190_H263Capability : public H323VideoCapability
 137 {
 138   PCLASSINFO(H323_RFC2190_H263Capability, H323VideoCapability)
 139
 140   public:
 141   /**@name Construction */
 142   //@{
 143     /**Create a new FFH263 Capability
 144      */
 145     H323_RFC2190_H263Capability(
 146       unsigned sqcifMPI = 1,    // {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
 147       unsigned qcifMPI = 2,
 148       unsigned cifMPI = 4,
 149       unsigned cif4MPI = 8,
 150       unsigned cif16MPI = 32,
 151       unsigned maxBitRate = 400,
 152       BOOL unrestrictedVector = FALSE,
 153       BOOL arithmeticCoding = FALSE, // not supported
 154       BOOL advancedPrediction = FALSE,
 155       BOOL pbFrames = FALSE,
 156       BOOL temporalSpatialTradeOff = FALSE, // not supported
 157       unsigned hrd_B = 0, // not supported
 158       unsigned bppMaxKb = 0, // not supported
 159       unsigned slowSqcifMPI = 0,
 160       unsigned slowQcifMPI = 0,
 161       unsigned slowCifMPI = 0,
 162       unsigned slowCif4MPI = 0,
 163       unsigned slowCif16MPI = 0,
 164       BOOL errorCompensation = FALSE // not supported
 165     );
 166   //@}
 167
 168   /**@name Overrides from class PObject */
 169   //@{
 170     /**Create a copy of the object.
 171       */
 172     virtual PObject * Clone() const;
 173   //@}
 174
 175   /**@name Overrides from class PObject */
 176   //@{
 177     /**Compare object
 178       */
 179     Comparison Compare(const PObject & obj) const;
 180    //@}
 181
 182     /**@name Identification functions */
 183   //@{
 184     /**Get the sub-type of the capability. This is a code dependent on the
 185        main type of the capability.
 186
 187        This returns one of the four possible combinations of mode and speed
 188        using the enum values of the protocol ASN H245_AudioCapability class.
 189      */
 190     virtual unsigned GetSubType() const;
 191
 192     /**Get the name of the media data format this class represents.
 193      */
 194     virtual PString GetFormatName() const;
 195   //@}
 196
 197   /**@name Protocol manipulation */
 198   //@{
 199     /**This function is called whenever and outgoing TerminalCapabilitySet
 200        or OpenLogicalChannel PDU is being constructed for the control channel.
 201        It allows the capability to set the PDU fields from information in
 202        members specific to the class.
 203
 204        The default behaviour sets the data rate field in the PDU.
 205      */
 206     virtual BOOL OnSendingPDU(
 207       H245_VideoCapability & pdu  /// PDU to set information on
 208     ) const;
 209
 210     /**This function is called whenever and outgoing RequestMode
 211        PDU is being constructed for the control channel. It allows the
 212        capability to set the PDU fields from information in members specific
 213        to the class.
 214
 215        The default behaviour sets the resolution and bit rate.
 216      */
 217     virtual BOOL OnSendingPDU(
 218       H245_VideoMode & pdu  /// PDU to set information on
 219     ) const;
 220
 221     /**This function is called whenever and incoming TerminalCapabilitySet
 222        or OpenLogicalChannel PDU has been used to construct the control
 223        channel. It allows the capability to set from the PDU fields,
 224        information in members specific to the class.
 225
 226        The default behaviour gets the data rate field from the PDU.
 227      */
 228     virtual BOOL OnReceivedPDU(
 229       const H245_VideoCapability & pdu  /// PDU to set information on
 230     );
 231
 232     /**Create the codec instance, allocating resources as required.
 233      */
 234     virtual H323Codec * CreateCodec(
 235       H323Codec::Direction direction  /// Direction in which this instance runs
 236     ) const;
 237
 238     /** Get sqcifMPI
 239      */
 240     unsigned GetSQCIFMPI() const
 241       { return sqcifMPI; }
 242
 243     /** Get qcifMPI
 244      */
 245     unsigned GetQCIFMPI() const
 246       { return qcifMPI; }
 247
 248     /** Get cifMPI
 249      */
 250     unsigned GetCIFMPI() const
 251       { return cifMPI; }
 252
 253     /** Get cif4MPI
 254      */
 255     unsigned GetCIF4MPI() const
 256       { return cif4MPI; }
 257
 258     /** Get cif16MPI
 259      */
 260     unsigned GetCIF16MPI() const
 261       { return cif16MPI; }
 262
 263     /** Get maximum bit rate
 264      */
 265     unsigned GetMaxBitRate() const
 266       { return maxBitRate; }
 267
 268     /** Get unrestrictedVector capabilty
 269      */
 270     BOOL GetUnrestrictedVectorCapability() const
 271       { return unrestrictedVector; }
 272
 273     /** Get arithmeticCoding capabilty
 274      */
 275     BOOL GetArithmeticCodingCapability() const
 276       { return arithmeticCoding; }
 277
 278     /** Get advancedPrediction capabilty
 279      */
 280     BOOL GetAdvancedPredictionCapability() const
 281       { return advancedPrediction; }
 282
 283     /** Get  pbFrames capabilty
 284      */
 285     BOOL GetPbFramesCapability() const
 286       { return pbFrames; }
 287
 288     /** Get temporal/spatial tradeoff capabilty
 289      */
 290     BOOL GetTemporalSpatialTradeOffCapability() const
 291       { return temporalSpatialTradeOff; }
 292
 293     /** Get hrd_B
 294      */
 295     BOOL GetHrd_B() const
 296       { return hrd_B; }
 297
 298     /** Get bppMaxKb
 299      */
 300     BOOL GetBppMaxKb() const
 301       { return bppMaxKb; }
 302
 303     /** Get slowSqcifMPI
 304      */
 305     unsigned GetSlowSQCIFMPI() const
 306       { return (sqcifMPI<0?-sqcifMPI:0); }
 307
 308     /** Get slowQcifMPI
 309      */
 310     unsigned GetSlowQCIFMPI() const
 311       { return (qcifMPI<0?-qcifMPI:0); }
 312
 313     /** Get slowCifMPI
 314      */
 315     unsigned GetSlowCIFMPI() const
 316       { return (cifMPI<0?-cifMPI:0); }
 317
 318     /** Get slowCif4MPI
 319      */
 320     unsigned GetSlowCIF4MPI() const
 321       { return (cif4MPI<0?-cif4MPI:0); }
 322
 323     /** Get slowCif16MPI
 324      */
 325     unsigned GetSlowCIF16MPI() const
 326       { return (cif16MPI<0?-cif16MPI:0); }
 327
 328     /** Get errorCompensation capabilty
 329      */
 330     BOOL GetErrorCompensationCapability() const
 331       { return errorCompensation; }
 332   //@}
 333
 334 protected:
 335
 336     signed sqcifMPI;            // {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
 337     signed qcifMPI;
 338     signed cifMPI;
 339     signed cif4MPI;
 340     signed cif16MPI;
 341
 342     unsigned maxBitRate;        // units of bit/s
 343
 344     BOOL     unrestrictedVector;
 345     BOOL     arithmeticCoding;
 346     BOOL     advancedPrediction;
 347     BOOL     pbFrames;
 348     BOOL     temporalSpatialTradeOff;
 349
 350     long unsigned hrd_B;        // units of 128 bits
 351     unsigned bppMaxKb;          // units of 1024 bits
 352
 353     BOOL     errorCompensation;
 354 };
 355
 356 ////////////////////////////////////////////////////////////////
 357
 358 class H263Packet : public PObject
 359 {
 360   PCLASSINFO(H263Packet, PObject)
 361
 362   public:
 363
 364     H263Packet() { data_size = hdr_size = 0; hdr = data = NULL; };
 365     ~H263Packet() {};
 366
 367     void Store(void *data, int data_size, void *hdr, int hdr_size);
 368     BOOL Read(unsigned & length, RTP_DataFrame & frame);
 369
 370   private:
 371
 372     void *data;
 373     int data_size;
 374     void *hdr;
 375     int hdr_size;
 376 };
 377
 378 PDECLARE_LIST(H263PacketList, H263Packet)
 379 #if 0
 380 {
 381 #endif
 382 };
 383
 384 //////////////////////////////////////////////////////////////////////
 385
 386 /**This class is a H.263 video codec.
 387  */
 388 class H323_RFC2190_H263Codec : public H323VideoCodec
 389 {
 390   PCLASSINFO(H323_RFC2190_H263Codec, H323VideoCodec)
 391
 392   public:
 393     /**Create a new H263 video codec
 394      */
 395     H323_RFC2190_H263Codec(
 396       Direction direction,      /// Direction in which this instance runs
 397       signed sqcifMPI,          /// {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
 398       signed qcifMPI,
 399       signed cifMPI,
 400       signed cif4MPI,
 401       signed cif16MPI,
 402       unsigned maxBitRate, /// Maximum bitrate (in bits per second); see SetMaxBitRate
 403       BOOL unrestrictedVector,
 404       BOOL arithmeticCoding,
 405       BOOL advancedPrediction,
 406       BOOL pbFrames
 407     );
 408
 409     ~H323_RFC2190_H263Codec();
 410
 411     /**Encode the data from the appropriate device.
 412        This will encode a frame of data for transmission. The exact size and
 413        description of the data placed in the buffer is codec dependent but
 414        should be less than H323Capability::GetTxFramesInPacket() *
 415        OpalMediaFormat::GetFrameSize()  in length.
 416
 417        The length parameter is filled with the actual length of the encoded
 418        data, often this will be the same as the size parameter.
 419
 420        This function is called every GetFrameRate() timestamp units, so MUST
 421        take less than (or equal to) that amount of time to complete!
 422
 423        Note that a returned length of zero indicates that time has passed but
 424        there is no data encoded. This is typically used for silence detection
 425        in an audio codec.
 426      */
 427     virtual BOOL Read(
 428       BYTE * buffer,            /// Buffer of encoded data
 429       unsigned & length,        /// Actual length of encoded data buffer
 430       RTP_DataFrame & rtpFrame  /// RTP data frame
 431     );
 432
 433     /**Decode the data and output it to appropriate device.
 434        This will decode a single frame of received data. The exact size and
 435        description of the data required in the buffer is codec dependent but
 436        should be less than H323Capability::GetRxFramesInPacket() *
 437        OpalMediaFormat::GetFrameSize()  in length.
 438
 439        It is expected this function anunciates the data. That is, for example
 440        with audio data, the sound is output on a speaker.
 441
 442        This function is called every GetFrameRate() timestamp units, so MUST
 443        take less than that amount of time to complete!
 444      */
 445     virtual BOOL Write(
 446       const BYTE * buffer,        /// Buffer of encoded data
 447       unsigned length,            /// Length of encoded data buffer
 448       const RTP_DataFrame & rtp,  /// RTP data frame
 449       unsigned & written          /// Number of bytes used from data buffer
 450     );
 451
 452     /**Get the frame rate in RTP timestamp units.
 453       */
 454     virtual unsigned GetFrameRate() const { return rtpTimestampDelta; }
 455
 456     /**Quality of the transmitted video. 1 is good, 31 is poor.
 457      */
 458     void SetTxQualityLevel(int qLevel);
 459
 460     /**Minimum quality limit for the transmitted video.
 461      * Default is 1. Encode quality will not be set below this value.
 462      */
 463     virtual void SetTxMinQuality(int qlevel);
 464
 465     /**Maximum quality limit for the transmitted video.
 466      * Default is 24. Encode quality will not be set above this value.
 467      */
 468     virtual void SetTxMaxQuality(int qlevel);
 469
 470     /**Number of blocks (that haven't changed) transmitted with each
 471      * frame. These blocks fill in the background.
 472      */
 473     void SetBackgroundFill(int fillLevel);
 474
 475     /**Set the current value for video control mode
 476      * return the resulting value video control mode
 477      */
 478     virtual void SetVideoMode(unsigned mode);
 479
 480     /**Set maximum bitrate when transmitting video, in bps. A value of 0
 481        disables bit rate control. The average bitrate will be less depending
 482        on channel dead time, i.e. time that the channel could be transmitting
 483        bits but is not.
 484
 485        The same value is both suggested to the H.263 codec and used for
 486        adaptive packet delay. Use SetVideoMode to enable the appropriate
 487        bitrate control mode.
 488
 489        @return TRUE if success
 490     */
 491     virtual BOOL SetMaxBitRate(unsigned bitRate);
 492
 493     /**Get the current value of the maximum bitrate, in bps. If SetMaxBitRate
 494        was never called, the returned value is the one negotiated by the
 495        capability. A value of 0 indicates that bitrate control is disabled.
 496     */
 497     virtual unsigned GetMaxBitRate() const { return bitRateHighLimit; }
 498
 499     /**Process a OnVideoTemporalSpatialTradeOff indication from remote endpoint.
 500        The default behaviour does nothing.
 501      */
 502     virtual void OnVideoTemporalSpatialTradeOff();
 503
 504     /**Process a request for a new frame,
 505        as part of the picture has been lost.
 506     */
 507     virtual void OnLostPartialPicture();
 508
 509     /**Process a request for a new frame,
 510        as the entire picture has been lost.
 511     */
 512     virtual void OnLostPicture();
 513
 514     /**
 515        The ffmpeg library calls this routine, everytime it has a new packet to
 516        send. Note that for every encode thread, this one method is called. Consequently,
 517        the 'priv_data' is used to separate out packets from different encode threads.
 518     */
 519     static void RtpCallback(void *data, int data_size,
 520                             void *hdr, int hdr_size, void *priv_data);
 521
 522   protected:
 523
 524     BOOL Resize(int width, int height);
 525
 526     BOOL RenderFrame(const void *buffer);
 527     BOOL RenderFrame(const AVFrame *pict);
 528
 529     BOOL OpenCodec();
 530
 531     void CloseCodec();
 532
 533     H263PacketList encodedPackets;
 534     H263PacketList unusedPackets;
 535
 536     PBYTEArray encFrameBuffer;
 537     PBYTEArray rawFrameBuffer;
 538
 539     PINDEX encFrameLen;
 540     PINDEX rawFrameLen;
 541
 542     AVCodec        *codec;
 543     AVCodecContext *context;
 544     AVFrame        *picture;
 545
 546     PTime lastFrameTime;
 547     unsigned rtpTimestampDelta;
 548     PAdaptiveDelay packetDelay;
 549     PTime lastPacketTime;
 550     PINDEX lastPacketBits;
 551
 552     enum StdSize {UnknownStdSize, SQCIF = 1, QCIF, CIF, CIF4, CIF16, NumStdSizes};
 553
 554     static int GetStdSize(int width, int height); //
 555     static int GetStdWidth (StdSize size);
 556     static int GetStdHeight (StdSize size);
 557
 558     signed videoFrameRate[NumStdSizes]; /// {1..3600 units seconds/frame, 1..32 units 1/29.97 Hz}
 559     StdSize videoSize;
 560     BOOL unrestrictedVector;
 561     BOOL arithmeticCoding;
 562     BOOL advancedPrediction;
 563     BOOL pbFrames;
 564 };
 565
 566 #endif // H323_AVCODEC
 567
 568 #endif // __OPAL_FFH263CODEC_H
 569
 570
 571 /////////////////////////////////////////////////////////////////////////////