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 / lpc10codec.h < prev    next >
C/C++ Source or Header  |  2002-09-15  |  5KB  |  175 lines
  1. /*
  2.  * lpc10codec.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): ______________________________________.
  25.  *
  26.  * $Log: lpc10codec.h,v $
  27.  * Revision 1.9  2002/09/16 01:14:15  robertj
  28.  * Added #define so can select if #pragma interface/implementation is used on
  29.  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  30.  *
  31.  * Revision 1.8  2002/09/03 05:41:25  robertj
  32.  * Normalised the multi-include header prevention ifdef/define symbol.
  33.  * Added globally accessible functions for media format name.
  34.  *
  35.  * Revision 1.7  2002/08/14 19:35:08  rogerh
  36.  * fix typo
  37.  *
  38.  * Revision 1.6  2002/08/05 10:03:47  robertj
  39.  * Cosmetic changes to normalise the usage of pragma interface/implementation.
  40.  *
  41.  * Revision 1.5  2001/10/24 01:20:34  robertj
  42.  * Added code to help with static linking of H323Capability names database.
  43.  *
  44.  * Revision 1.4  2001/02/09 05:16:24  robertj
  45.  * Added #pragma interface for GNU C++.
  46.  *
  47.  * Revision 1.3  2001/01/25 07:27:14  robertj
  48.  * Major changes to add more flexible OpalMediaFormat class to normalise
  49.  *   all information about media types, especially codecs.
  50.  *
  51.  * Revision 1.2  2000/06/10 09:04:56  rogerh
  52.  * fix typo in a comment
  53.  *
  54.  * Revision 1.1  2000/06/05 04:45:02  robertj
  55.  * Added LPC-10 2400bps codec
  56.  *
  57.  */
  58.  
  59. #ifndef __OPAL_LPC10CODEC_H
  60. #define __OPAL_LPC10CODEC_H
  61.  
  62. #ifdef P_USE_PRAGMA
  63. #pragma interface
  64. #endif
  65.  
  66.  
  67. #include "h323caps.h"
  68.  
  69.  
  70. struct lpc10_encoder_state;
  71. struct lpc10_decoder_state;
  72.  
  73. #define OPAL_LPC10 "LPC-10"
  74.  
  75. extern OpalMediaFormat const OpalLPC10;
  76.  
  77.  
  78. #ifdef H323_STATIC_LIB
  79. H323_STATIC_LOAD_REGISTER_CAPABILITY(H323_LPC10Capability);
  80. #endif
  81.  
  82.  
  83. ///////////////////////////////////////////////////////////////////////////////
  84.  
  85. /**This class describes the LPC-10 (FS-1015) codec capability.
  86.  */
  87. class H323_LPC10Capability : public H323NonStandardAudioCapability
  88. {
  89.   PCLASSINFO(H323_LPC10Capability, H323NonStandardAudioCapability);
  90.  
  91.   public:
  92.   /**@name Construction */
  93.   //@{
  94.     /**Create a new LPC-10 capability.
  95.      */
  96.     H323_LPC10Capability(
  97.       H323EndPoint & endpoint   // Endpoint to get NonStandardInfo from.
  98.     );
  99.   //@}
  100.  
  101.   /**@name Overrides from class PObject */
  102.   //@{
  103.     /**Create a copy of the object.
  104.       */
  105.     virtual PObject * Clone() const;
  106.   //@}
  107.  
  108.   /**@name Operations */
  109.   //@{
  110.     /**Create the codec instance, allocating resources as required.
  111.      */
  112.     virtual H323Codec * CreateCodec(
  113.       H323Codec::Direction direction  /// Direction in which this instance runs
  114.     ) const;
  115.   //@}
  116.  
  117.   /**@name Identification functions */
  118.   //@{
  119.     /**Get the name of the media data format this class represents.
  120.      */
  121.     virtual PString GetFormatName() const;
  122.   //@}
  123. };
  124.  
  125.  
  126. /**This class is a LPC-10 codec.
  127.  */
  128. class H323_LPC10Codec : public H323FramedAudioCodec
  129. {
  130.   PCLASSINFO(H323_LPC10Codec, H323FramedAudioCodec)
  131.  
  132.   public:
  133.   /**@name Construction */
  134.   //@{
  135.     /**Create a new LPC-10 codec.
  136.      */
  137.     H323_LPC10Codec(
  138.       Direction direction         /// Direction in which this instance runs
  139.     );
  140.     ~H323_LPC10Codec();
  141.   //@}
  142.  
  143.     /**Encode a sample block into the buffer specified.
  144.        The samples have been read and are waiting in the readBuffer member
  145.        variable. it is expected this function will encode exactly
  146.        encodedBlockSize bytes.
  147.      */
  148.     virtual BOOL EncodeFrame(
  149.       BYTE * buffer,    /// Buffer into which encoded bytes are placed
  150.       unsigned & length /// Actual length of encoded data buffer
  151.     );
  152.  
  153.     /**Decode a sample block from the buffer specified.
  154.        The samples must be placed into the writeBuffer member variable. It is
  155.        expected that no more than frameSamples is decoded. The return value
  156.        is the number of samples decoded. Zero indicates an error.
  157.      */
  158.     virtual BOOL DecodeFrame(
  159.       const BYTE * buffer,  /// Buffer from which encoded data is found
  160.       unsigned length,      /// Length of encoded data buffer
  161.       unsigned & written    /// Number of bytes used from data buffer
  162.     );
  163.  
  164.   protected:
  165.     struct lpc10_encoder_state * encoder;
  166.     struct lpc10_decoder_state * decoder;
  167. };
  168.  
  169.  
  170. #endif // __OPAL_LPC10CODEC_H
  171.  
  172.  
  173. /////////////////////////////////////////////////////////////////////////////
  174.  
  175.