add speex_mode_new() and speex_mode_destroy() API calls to _noglobals API
[speexdsp.git] / include / speex / speex_noglobals.h
1 /* Copyright (C) 2004 CSIRO Australia */
2 /* Copyright (C) 2002 Jean-Marc Valin*/
3 /**
4   @file speex_noglobals.h
5   @brief Dynamically allocates the different modes of the codec
6 */
7 /*
8    Redistribution and use in source and binary forms, with or without
9    modification, are permitted provided that the following conditions
10    are met:
11    
12    - Redistributions of source code must retain the above copyright
13    notice, this list of conditions and the following disclaimer.
14    
15    - Redistributions in binary form must reproduce the above copyright
16    notice, this list of conditions and the following disclaimer in the
17    documentation and/or other materials provided with the distribution.
18    
19    - Neither the name of the Xiph.org Foundation nor the names of its
20    contributors may be used to endorse or promote products derived from
21    this software without specific prior written permission.
22    
23    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
27    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34
35 */
36
37 #ifndef SPEEX_NOGLOBALS_H
38 #define SPEEX_NOGLOBALS_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /** Default narrowband mode */
45 const SpeexMode * speex_nb_mode_new (void);
46 void speex_nb_mode_free (const SpeexMode * mode);
47
48 /** Default wideband mode */
49 const SpeexMode * speex_wb_mode_new (void);
50 void speex_wb_mode_free (const SpeexMode * mode);
51
52 /** Default "ultra-wideband" mode */
53 const SpeexMode * speex_uwb_mode_new (void);
54 void speex_uwb_mode_free (const SpeexMode * mode);
55
56 /** Query modes available */
57 const SpeexMode * speex_mode_new_byID (int id);
58
59 /** Free a mode, using its ID */
60 void speex_mode_free_byID (SpeexMode * mode, int id);
61
62 /** Instantiate a mode */
63 const SpeexMode * speex_mode_new (int modeID);
64
65 /** Destroy a mode */
66 void speex_mode_destroy (const SpeexMode * mode);
67
68 #ifdef __cplusplus
69 }
70 #endif
71
72
73 #endif