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 / speexcodec.h < prev    next >
C/C++ Source or Header  |  2002-12-08  |  10KB  |  319 lines
  1. /*
  2.  * speexcodec.h
  3.  *
  4.  * Speex codec handler
  5.  *
  6.  * Open H323 Library
  7.  *
  8.  * Copyright (c) 2002 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: speexcodec.h,v $
  27.  * Revision 1.15  2002/12/08 22:59:41  rogerh
  28.  * Add XiphSpeex codec. Not yet finished.
  29.  *
  30.  * Revision 1.14  2002/12/06 10:11:54  rogerh
  31.  * Back out the Xiph Speex changes on a tempoary basis while the Speex
  32.  * spec is being redrafted.
  33.  *
  34.  * Revision 1.13  2002/12/05 12:57:17  rogerh
  35.  * Speex now uses the manufacturer ID assigned to Xiph.Org.
  36.  * To support existing applications using Speex, applications can use the
  37.  * EquivalenceSpeex capabilities.
  38.  *
  39.  * Revision 1.12  2002/11/09 07:08:02  robertj
  40.  * Hide speex library from OPenH323 library users.
  41.  * Made public the media format names.
  42.  * Other cosmetic changes.
  43.  *
  44.  * Revision 1.11  2002/10/24 05:32:57  robertj
  45.  * MSVC compatibility
  46.  *
  47.  * Revision 1.10  2002/10/22 11:54:32  rogerh
  48.  * Fix including of speex.h
  49.  *
  50.  * Revision 1.9  2002/10/22 11:33:04  rogerh
  51.  * Use the local speex.h header file
  52.  *
  53.  * Revision 1.8  2002/09/16 01:14:15  robertj
  54.  * Added #define so can select if #pragma interface/implementation is used on
  55.  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  56.  *
  57.  * Revision 1.7  2002/08/22 08:30:23  craigs
  58.  * Fixed remainder of Clone operators
  59.  *
  60.  * Revision 1.6  2002/08/20 15:22:50  rogerh
  61.  * Make the codec name include the bitstream format for Speex to prevent users
  62.  * with incompatible copies of Speex trying to use this codec.
  63.  *
  64.  * Revision 1.5  2002/08/15 18:35:36  rogerh
  65.  * Fix more bugs with the Speex codec
  66.  *
  67.  * Revision 1.4  2002/08/14 19:34:31  rogerh
  68.  * fix typo
  69.  *
  70.  * Revision 1.3  2002/08/14 04:26:20  craigs
  71.  * Fixed ifdef problem
  72.  *
  73.  * Revision 1.2  2002/08/13 14:25:25  craigs
  74.  * Added trailing newlines to avoid Linux warnings
  75.  *
  76.  * Revision 1.1  2002/08/13 14:14:28  craigs
  77.  * Initial version
  78.  *
  79.  */
  80.  
  81.  
  82. #ifndef __OPAL_SPEEXCODEC_H
  83. #define __OPAL_SPEEXCODEC_H
  84.  
  85. #ifdef P_USE_PRAGMA
  86. #pragma interface
  87. #endif
  88.  
  89. #include "h323caps.h"
  90. #include "codecs.h"
  91.  
  92.  
  93. #define OPAL_SPEEX_NARROW_5k95 "SpeexNarrow-5.95k"
  94. #define OPAL_SPEEX_NARROW_8k   "SpeexNarrow-8k"
  95. #define OPAL_SPEEX_NARROW_11k  "SpeexNarrow-11k"
  96. #define OPAL_SPEEX_NARROW_15k  "SpeexNarrow-15k"
  97. #define OPAL_SPEEX_NARROW_18k2 "SpeexNarrow-18.2k"
  98.  
  99. extern OpalMediaFormat const OpalSpeexNarrow_5k95;
  100. extern OpalMediaFormat const OpalSpeexNarrow_8k;
  101. extern OpalMediaFormat const OpalSpeexNarrow_11k;
  102. extern OpalMediaFormat const OpalSpeexNarrow_15k;
  103. extern OpalMediaFormat const OpalSpeexNarrow_18k2;
  104.  
  105.  
  106. struct SpeexBits;
  107.  
  108.  
  109. ///////////////////////////////////////////////////////////////////////////////
  110.  
  111. /**This class describes the Speex codec capability.
  112.  */
  113. class SpeexNonStandardAudioCapability : public H323NonStandardAudioCapability
  114. {
  115.   PCLASSINFO(SpeexNonStandardAudioCapability, H323NonStandardAudioCapability);
  116.  
  117.   public:
  118.     SpeexNonStandardAudioCapability(int mode);
  119. };
  120.  
  121. /////////////////////////////////////////////////////////////////////////
  122.  
  123. class SpeexNarrow2AudioCapability : public SpeexNonStandardAudioCapability
  124. {
  125.   PCLASSINFO(SpeexNarrow2AudioCapability, SpeexNonStandardAudioCapability);
  126.  
  127.   public:
  128.     SpeexNarrow2AudioCapability();
  129.     PObject * Clone() const;
  130.     PString GetFormatName() const;
  131.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  132. };
  133.  
  134. class SpeexNarrow3AudioCapability : public SpeexNonStandardAudioCapability
  135. {
  136.   PCLASSINFO(SpeexNarrow3AudioCapability, SpeexNonStandardAudioCapability);
  137.  
  138.   public:
  139.     SpeexNarrow3AudioCapability();
  140.     PObject * Clone() const;
  141.     PString GetFormatName() const;
  142.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  143. };
  144.  
  145. class SpeexNarrow4AudioCapability : public SpeexNonStandardAudioCapability
  146. {
  147.   PCLASSINFO(SpeexNarrow4AudioCapability, SpeexNonStandardAudioCapability);
  148.  
  149.   public:
  150.     SpeexNarrow4AudioCapability();
  151.     PObject * Clone() const;
  152.     PString GetFormatName() const;
  153.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  154. };
  155.  
  156. class SpeexNarrow5AudioCapability : public SpeexNonStandardAudioCapability
  157. {
  158.   PCLASSINFO(SpeexNarrow5AudioCapability, SpeexNonStandardAudioCapability);
  159.  
  160.   public:
  161.     SpeexNarrow5AudioCapability();
  162.     PObject * Clone() const;
  163.     PString GetFormatName() const;
  164.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  165. };
  166.  
  167. class SpeexNarrow6AudioCapability : public SpeexNonStandardAudioCapability
  168. {
  169.   PCLASSINFO(SpeexNarrow6AudioCapability, SpeexNonStandardAudioCapability);
  170.  
  171.   public:
  172.     SpeexNarrow6AudioCapability();
  173.     PObject * Clone() const;
  174.     PString GetFormatName() const;
  175.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  176. };
  177.  
  178.  
  179. #ifdef H323_STATIC_LIB
  180. H323_STATIC_LOAD_REGISTER_CAPABILITY(SpeexNarrow2AudioCapability);
  181. H323_STATIC_LOAD_REGISTER_CAPABILITY(SpeexNarrow3AudioCapability);
  182. H323_STATIC_LOAD_REGISTER_CAPABILITY(SpeexNarrow4AudioCapability);
  183. H323_STATIC_LOAD_REGISTER_CAPABILITY(SpeexNarrow5AudioCapability);
  184. H323_STATIC_LOAD_REGISTER_CAPABILITY(SpeexNarrow6AudioCapability);
  185. #endif
  186.  
  187.  
  188. ///////////////////////////////////////////////////////////////////////////////
  189.  
  190. /**This class describes the Xiph Speex codec capability.
  191.  */
  192. class XiphSpeexNonStandardAudioCapability : public H323NonStandardAudioCapability
  193. {
  194.   PCLASSINFO(XiphSpeexNonStandardAudioCapability, H323NonStandardAudioCapability);
  195.  
  196.   public:
  197.     XiphSpeexNonStandardAudioCapability(int mode);
  198. };
  199.  
  200. /////////////////////////////////////////////////////////////////////////
  201.  
  202. class XiphSpeexNarrow2AudioCapability : public XiphSpeexNonStandardAudioCapability
  203. {
  204.   PCLASSINFO(XiphSpeexNarrow2AudioCapability, XiphSpeexNonStandardAudioCapability);
  205.  
  206.   public:
  207.     XiphSpeexNarrow2AudioCapability();
  208.     PObject * Clone() const;
  209.     PString GetFormatName() const;
  210.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  211. };
  212.  
  213. class XiphSpeexNarrow3AudioCapability : public XiphSpeexNonStandardAudioCapability
  214. {
  215.   PCLASSINFO(XiphSpeexNarrow3AudioCapability, XiphSpeexNonStandardAudioCapability);
  216.  
  217.   public:
  218.     XiphSpeexNarrow3AudioCapability();
  219.     PObject * Clone() const;
  220.     PString GetFormatName() const;
  221.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  222. };
  223.  
  224. class XiphSpeexNarrow4AudioCapability : public XiphSpeexNonStandardAudioCapability
  225. {
  226.   PCLASSINFO(XiphSpeexNarrow4AudioCapability, XiphSpeexNonStandardAudioCapability);
  227.  
  228.   public:
  229.     XiphSpeexNarrow4AudioCapability();
  230.     PObject * Clone() const;
  231.     PString GetFormatName() const;
  232.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  233. };
  234.  
  235. class XiphSpeexNarrow5AudioCapability : public XiphSpeexNonStandardAudioCapability
  236. {
  237.   PCLASSINFO(XiphSpeexNarrow5AudioCapability, XiphSpeexNonStandardAudioCapability);
  238.  
  239.   public:
  240.     XiphSpeexNarrow5AudioCapability();
  241.     PObject * Clone() const;
  242.     PString GetFormatName() const;
  243.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  244. };
  245.  
  246. class XiphSpeexNarrow6AudioCapability : public XiphSpeexNonStandardAudioCapability
  247. {
  248.   PCLASSINFO(XiphSpeexNarrow6AudioCapability, XiphSpeexNonStandardAudioCapability);
  249.  
  250.   public:
  251.     XiphSpeexNarrow6AudioCapability();
  252.     PObject * Clone() const;
  253.     PString GetFormatName() const;
  254.     H323Codec * CreateCodec(H323Codec::Direction direction) const;
  255. };
  256.  
  257.  
  258. #ifdef H323_STATIC_LIB
  259. H323_STATIC_LOAD_REGISTER_CAPABILITY(XiphSpeexNarrow2AudioCapability);
  260. H323_STATIC_LOAD_REGISTER_CAPABILITY(XiphSpeexNarrow3AudioCapability);
  261. H323_STATIC_LOAD_REGISTER_CAPABILITY(XiphSpeexNarrow4AudioCapability);
  262. H323_STATIC_LOAD_REGISTER_CAPABILITY(XiphSpeexNarrow5AudioCapability);
  263. H323_STATIC_LOAD_REGISTER_CAPABILITY(XiphSpeexNarrow6AudioCapability);
  264. #endif
  265.  
  266.  
  267. /////////////////////////////////////////////////////////////////////////
  268.  
  269. class SpeexCodec : public H323FramedAudioCodec
  270. {
  271.   PCLASSINFO(SpeexCodec, H323FramedAudioCodec);
  272.   public:
  273.  
  274.   /**@name Construction */
  275.   //@{
  276.     /**Create a new Speex codec.
  277.      */
  278.     SpeexCodec(
  279.       const char * name,   /// Speex codec name
  280.       int mode,            /// Quality parameter passed to compressor
  281.       Direction direction  /// Direction in which this instance runs
  282.     );
  283.  
  284.     ~SpeexCodec();
  285.   //@}
  286.  
  287.     /**Encode a sample block into the buffer specified.
  288.        The samples have been read and are waiting in the readBuffer member
  289.        variable. it is expected this function will encode exactly
  290.        encodedBlockSize bytes.
  291.      */
  292.     virtual BOOL EncodeFrame(
  293.       BYTE * buffer,    /// Buffer into which encoded bytes are placed
  294.       unsigned & length /// Actual length of encoded data buffer
  295.     );
  296.  
  297.     /**Decode a sample block from the buffer specified.
  298.        The samples must be placed into the writeBuffer member variable. It is
  299.        expected that no more than frameSamples is decoded. The return value
  300.        is the number of samples decoded. Zero indicates an error.
  301.      */
  302.     virtual BOOL DecodeFrame(
  303.       const BYTE * buffer,  /// Buffer from which encoded data is found
  304.       unsigned length,      /// Length of encoded data buffer
  305.       unsigned & written    /// Number of bytes used from data buffer
  306.     );
  307.  
  308.   protected:
  309.     SpeexBits * bits;
  310.     void      * coder_state;
  311.     unsigned    encoder_frame_size;
  312. };
  313.  
  314.  
  315. #endif // __OPAL_SPEEXCODEC_H
  316.  
  317.  
  318. /////////////////////////////////////////////////////////////////////////
  319.