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 / gsmcodec.h < prev    next >
C/C++ Source or Header  |  2002-09-15  |  7KB  |  230 lines
  1. /*
  2.  * gsmcodec.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.  * 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: gsmcodec.h,v $
  30.  * Revision 1.14  2002/09/16 01:14:15  robertj
  31.  * Added #define so can select if #pragma interface/implementation is used on
  32.  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  33.  *
  34.  * Revision 1.13  2002/09/03 06:19:36  robertj
  35.  * Normalised the multi-include header prevention ifdef/define symbol.
  36.  *
  37.  * Revision 1.12  2002/08/05 10:03:47  robertj
  38.  * Cosmetic changes to normalise the usage of pragma interface/implementation.
  39.  *
  40.  * Revision 1.11  2001/10/24 01:20:34  robertj
  41.  * Added code to help with static linking of H323Capability names database.
  42.  *
  43.  * Revision 1.10  2001/02/11 22:48:30  robertj
  44.  * Added #pragma interface for GNU C++.
  45.  *
  46.  * Revision 1.9  2001/01/25 07:27:14  robertj
  47.  * Major changes to add more flexible OpalMediaFormat class to normalise
  48.  *   all information about media types, especially codecs.
  49.  *
  50.  * Revision 1.8  2000/10/13 03:43:14  robertj
  51.  * Added clamping to avoid ever setting incorrect tx frame count.
  52.  *
  53.  * Revision 1.7  2000/05/10 04:05:26  robertj
  54.  * Changed capabilities so has a function to get name of codec, instead of relying on PrintOn.
  55.  *
  56.  * Revision 1.6  2000/05/02 04:32:24  robertj
  57.  * Fixed copyright notice comment.
  58.  *
  59.  * Revision 1.5  1999/12/31 00:05:36  robertj
  60.  * Added Microsoft ACM G.723.1 codec capability.
  61.  *
  62.  * Revision 1.4  1999/12/23 23:02:34  robertj
  63.  * File reorganision for separating RTP from H.323 and creation of LID for VPB support.
  64.  *
  65.  * Revision 1.3  1999/10/08 09:59:01  robertj
  66.  * Rewrite of capability for sending multiple audio frames
  67.  *
  68.  * Revision 1.2  1999/10/08 04:58:37  robertj
  69.  * Added capability for sending multiple audio frames in single RTP packet
  70.  *
  71.  * Revision 1.1  1999/09/08 04:05:48  robertj
  72.  * Added support for video capabilities & codec, still needs the actual codec itself!
  73.  *
  74.  */
  75.  
  76. #ifndef __OPAL_GSMCODEC_H
  77. #define __OPAL_GSMCODEC_H
  78.  
  79. #ifdef P_USE_PRAGMA
  80. #pragma interface
  81. #endif
  82.  
  83.  
  84. #include "h323caps.h"
  85.  
  86.  
  87.  
  88. #ifdef H323_STATIC_LIB
  89. H323_STATIC_LOAD_REGISTER_CAPABILITY(H323_GSM0610Capability);
  90. #endif
  91.  
  92.  
  93. ///////////////////////////////////////////////////////////////////////////////
  94.  
  95. /**This class describes the GSM 06.10 codec capability.
  96.  */
  97. class H323_GSM0610Capability : public H323AudioCapability
  98. {
  99.   PCLASSINFO(H323_GSM0610Capability, H323AudioCapability)
  100.  
  101.   public:
  102.   /**@name Construction */
  103.   //@{
  104.     /**Create a new GSM 06.10 capability.
  105.      */
  106.     H323_GSM0610Capability();
  107.   //@}
  108.  
  109.   /**@name Overrides from class PObject */
  110.   //@{
  111.     /**Create a copy of the object.
  112.       */
  113.     virtual PObject * Clone() const;
  114.   //@}
  115.  
  116.   /**@name Operations */
  117.   //@{
  118.     /**Create the codec instance, allocating resources as required.
  119.      */
  120.     virtual H323Codec * CreateCodec(
  121.       H323Codec::Direction direction  /// Direction in which this instance runs
  122.     ) const;
  123.   //@}
  124.  
  125.   /**@name Identification functions */
  126.   //@{
  127.     /**Get the sub-type of the capability. This is a code dependent on the
  128.        main type of the capability.
  129.  
  130.        This returns one of the four possible combinations of mode and speed
  131.        using the enum values of the protocol ASN H245_AudioCapability class.
  132.      */
  133.     virtual unsigned GetSubType() const;
  134.  
  135.     /**Get the name of the media data format this class represents.
  136.      */
  137.     virtual PString GetFormatName() const;
  138.  
  139.     /**Set the maximum size (in frames) of data that will be transmitted in a
  140.        single PDU.
  141.  
  142.        This will also be the desired number that will be sent by most codec
  143.        implemetations.
  144.  
  145.        The default behaviour sets the txFramesInPacket variable.
  146.      */
  147.     virtual void SetTxFramesInPacket(
  148.       unsigned frames   /// Number of frames per packet
  149.     );
  150.   //@}
  151.  
  152.   /**@name Protocol manipulation */
  153.   //@{
  154.     /**This function is called whenever and outgoing TerminalCapabilitySet
  155.        or OpenLogicalChannel PDU is being constructed for the control channel.
  156.        It allows the capability to set the PDU fields from information in
  157.        members specific to the class.
  158.  
  159.        The default behaviour sets the data rate field in the PDU.
  160.      */
  161.     virtual BOOL OnSendingPDU(
  162.       H245_AudioCapability & pdu,  /// PDU to set information on
  163.       unsigned packetSize          /// Packet size to use in capability
  164.     ) const;
  165.  
  166.     /**This function is called whenever and incoming TerminalCapabilitySet
  167.        or OpenLogicalChannel PDU has been used to construct the control
  168.        channel. It allows the capability to set from the PDU fields,
  169.        information in members specific to the class.
  170.  
  171.        The default behaviour gets the data rate field from the PDU.
  172.      */
  173.     virtual BOOL OnReceivedPDU(
  174.       const H245_AudioCapability & pdu,  /// PDU to get information from
  175.       unsigned & packetSize              /// Packet size to use in capability
  176.     );
  177.   //@}
  178. };
  179.  
  180.  
  181. struct gsm_state;
  182.  
  183. /**This class is a GSM 06.10 codec.
  184.  */
  185. class H323_GSM0610Codec : public H323FramedAudioCodec
  186. {
  187.   PCLASSINFO(H323_GSM0610Codec, H323FramedAudioCodec)
  188.  
  189.   public:
  190.   /**@name Construction */
  191.   //@{
  192.     /**Create a new GSM 06.10 codec for ALaw.
  193.      */
  194.     H323_GSM0610Codec(
  195.       Direction direction         /// Direction in which this instance runs
  196.     );
  197.     ~H323_GSM0610Codec();
  198.   //@}
  199.  
  200.     /**Encode a sample block into the buffer specified.
  201.        The samples have been read and are waiting in the readBuffer member
  202.        variable. it is expected this function will encode exactly
  203.        encodedBlockSize bytes.
  204.      */
  205.     virtual BOOL EncodeFrame(
  206.       BYTE * buffer,    /// Buffer into which encoded bytes are placed
  207.       unsigned & length /// Actual length of encoded data buffer
  208.     );
  209.  
  210.     /**Decode a sample block from the buffer specified.
  211.        The samples must be placed into the writeBuffer member variable. It is
  212.        expected that no more than frameSamples is decoded. The return value
  213.        is the number of samples decoded. Zero indicates an error.
  214.      */
  215.     virtual BOOL DecodeFrame(
  216.       const BYTE * buffer,  /// Buffer from which encoded data is found
  217.       unsigned length,      /// Length of encoded data buffer
  218.       unsigned & written    /// Number of bytes used from data buffer
  219.     );
  220.  
  221.   protected:
  222.     struct gsm_state * gsm;
  223. };
  224.  
  225.  
  226. #endif // __OPAL_GSMCODEC_H
  227.  
  228.  
  229. /////////////////////////////////////////////////////////////////////////////
  230.