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 / g729codec.h < prev    next >
C/C++ Source or Header  |  2003-05-05  |  6KB  |  217 lines
  1. /*
  2.  * g729codec.h
  3.  *
  4.  * H.323 interface for G.729A codec
  5.  *
  6.  * Open H323 Library
  7.  *
  8.  * Copyright (c) 2001 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.  * Portions of this code were written with the assisance of funding from
  25.  * Vovida Networks, Inc. http://www.vovida.com.
  26.  *
  27.  * Contributor(s): ______________________________________.
  28.  *
  29.  * $Log: g729codec.h,v $
  30.  * Revision 1.7  2003/05/05 11:59:21  robertj
  31.  * Changed to use autoconf style selection of options and subsystems.
  32.  *
  33.  * Revision 1.6  2002/11/12 00:06:10  robertj
  34.  * Added check for Voice Age G.729 only being able to do a single instance
  35.  *   of the encoder and decoder. Now fails the second isntance isntead of
  36.  *   interfering with the first one.
  37.  *
  38.  * Revision 1.5  2002/09/16 01:14:15  robertj
  39.  * Added #define so can select if #pragma interface/implementation is used on
  40.  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  41.  *
  42.  * Revision 1.4  2002/09/03 06:19:36  robertj
  43.  * Normalised the multi-include header prevention ifdef/define symbol.
  44.  *
  45.  * Revision 1.3  2002/08/05 10:03:47  robertj
  46.  * Cosmetic changes to normalise the usage of pragma interface/implementation.
  47.  *
  48.  * Revision 1.2  2002/06/27 03:08:31  robertj
  49.  * Added G.729 capabilitity support even though is really G.729A.
  50.  * Added code to include G.729 codecs on static linking.
  51.  *
  52.  * Revision 1.1  2001/09/21 02:54:47  robertj
  53.  * Added new codec framework with no actual implementation.
  54.  *
  55.  */
  56.  
  57. #ifndef __OPAL_G729CODEC_H
  58. #define __OPAL_G729CODEC_H
  59.  
  60. #ifdef P_USE_PRAGMA
  61. #pragma interface
  62. #endif
  63.  
  64. #include <openh323buildopts.h>
  65.  
  66. #if VOICE_AGE_G729A
  67.  
  68. #include "h323caps.h"
  69.  
  70.  
  71. #ifdef H323_STATIC_LIB
  72. H323_STATIC_LOAD_REGISTER_CAPABILITY(H323_G729Capability);
  73. H323_STATIC_LOAD_REGISTER_CAPABILITY(H323_G729ACapability);
  74. #endif
  75.  
  76.  
  77. /**This class describes the (fake) G729 codec capability.
  78.  */
  79. class H323_G729Capability : public H323AudioCapability
  80. {
  81.   PCLASSINFO(H323_G729Capability, H323AudioCapability);
  82.  
  83.   public:
  84.   /**@name Construction */
  85.   //@{
  86.     /**Create a new G.729 capability.
  87.      */
  88.     H323_G729Capability();
  89.   //@}
  90.  
  91.   /**@name Overrides from class PObject */
  92.   //@{
  93.     /**Create a copy of the object.
  94.       */
  95.     virtual PObject * Clone() const;
  96.   //@}
  97.  
  98.   /**@name Operations */
  99.   //@{
  100.     /**Create the codec instance, allocating resources as required.
  101.      */
  102.     virtual H323Codec * CreateCodec(
  103.       H323Codec::Direction direction  /// Direction in which this instance runs
  104.     ) const;
  105.   //@}
  106.  
  107.   /**@name Identification functions */
  108.   //@{
  109.     /**Get the sub-type of the capability. This is a code dependent on the
  110.        main type of the capability.
  111.  
  112.        This returns one of the four possible combinations of mode and speed
  113.        using the enum values of the protocol ASN H245_AudioCapability class.
  114.      */
  115.     virtual unsigned GetSubType() const;
  116.  
  117.     /**Get the name of the media data format this class represents.
  118.      */
  119.     virtual PString GetFormatName() const;
  120.   //@}
  121. };
  122.  
  123.  
  124. /**This class describes the VoiceAge G729A codec capability.
  125.  */
  126. class H323_G729ACapability : public H323AudioCapability
  127. {
  128.   PCLASSINFO(H323_G729ACapability, H323AudioCapability);
  129.  
  130.   public:
  131.   /**@name Construction */
  132.   //@{
  133.     /**Create a new G.729A capability.
  134.      */
  135.     H323_G729ACapability();
  136.   //@}
  137.  
  138.   /**@name Overrides from class PObject */
  139.   //@{
  140.     /**Create a copy of the object.
  141.       */
  142.     virtual PObject * Clone() const;
  143.   //@}
  144.  
  145.   /**@name Operations */
  146.   //@{
  147.     /**Create the codec instance, allocating resources as required.
  148.      */
  149.     virtual H323Codec * CreateCodec(
  150.       H323Codec::Direction direction  /// Direction in which this instance runs
  151.     ) const;
  152.   //@}
  153.  
  154.   /**@name Identification functions */
  155.   //@{
  156.     /**Get the sub-type of the capability. This is a code dependent on the
  157.        main type of the capability.
  158.  
  159.        This returns one of the four possible combinations of mode and speed
  160.        using the enum values of the protocol ASN H245_AudioCapability class.
  161.      */
  162.     virtual unsigned GetSubType() const;
  163.  
  164.     /**Get the name of the media data format this class represents.
  165.      */
  166.     virtual PString GetFormatName() const;
  167.   //@}
  168. };
  169.  
  170.  
  171. /**This class is a G.729A codec.
  172.  */
  173. class H323_G729ACodec : public H323FramedAudioCodec
  174. {
  175.   PCLASSINFO(H323_G729ACodec, H323FramedAudioCodec)
  176.  
  177.   public:
  178.   /**@name Construction */
  179.   //@{
  180.     /**Create a new Open LPC codec.
  181.      */
  182.     H323_G729ACodec(
  183.       Direction direction         /// Direction in which this instance runs
  184.     );
  185.     ~H323_G729ACodec();
  186.   //@}
  187.  
  188.     /**Encode a sample block into the buffer specified.
  189.        The samples have been read and are waiting in the readBuffer member
  190.        variable. it is expected this function will encode exactly
  191.        encodedBlockSize bytes.
  192.      */
  193.     virtual BOOL EncodeFrame(
  194.       BYTE * buffer,    /// Buffer into which encoded bytes are placed
  195.       unsigned & length /// Actual length of encoded data buffer
  196.     );
  197.  
  198.     /**Decode a sample block from the buffer specified.
  199.        The samples must be placed into the writeBuffer member variable. It is
  200.        expected that no more than frameSamples is decoded. The return value
  201.        is the number of samples decoded. Zero indicates an error.
  202.      */
  203.     virtual BOOL DecodeFrame(
  204.       const BYTE * buffer,  /// Buffer from which encoded data is found
  205.       unsigned length,      /// Length of encoded data buffer
  206.       unsigned & written    /// Number of bytes used from data buffer
  207.     );
  208. };
  209.  
  210.  
  211. #endif // VOICE_AGE_G729A
  212.  
  213. #endif // __OPAL_G729CODEC_H
  214.  
  215.  
  216. /////////////////////////////////////////////////////////////////////////////
  217.