Add get_mode CTL for the encoder and decoder.
[opus.git] / libcelt / celt.h
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2    (C) 2008 Gregory Maxwell */
3 /**
4   @file celt.h
5   @brief Contains all the functions for encoding and decoding audio streams
6  */
7
8 /*
9    Redistribution and use in source and binary forms, with or without
10    modification, are permitted provided that the following conditions
11    are met:
12    
13    - Redistributions of source code must retain the above copyright
14    notice, this list of conditions and the following disclaimer.
15    
16    - Redistributions in binary form must reproduce the above copyright
17    notice, this list of conditions and the following disclaimer in the
18    documentation and/or other materials provided with the distribution.
19    
20    - Neither the name of the Xiph.org Foundation nor the names of its
21    contributors may be used to endorse or promote products derived from
22    this software without specific prior written permission.
23    
24    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
28    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37 #ifndef CELT_H
38 #define CELT_H
39
40 #include "celt_types.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 #if defined(__GNUC__) && defined(CELT_BUILD)
47 #define EXPORT __attribute__ ((visibility ("default")))
48 #elif defined(WIN32)
49 #define EXPORT __declspec(dllexport)
50 #else
51 #define EXPORT
52 #endif
53
54 #define _celt_check_int(x) (((void)((x) == (celt_int32_t)0)), (celt_int32_t)(x))
55 #define _celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (CELTMode**)(ptr)))
56
57 /* Error codes */
58 /** No error */
59 #define CELT_OK                0
60 /** An (or more) invalid argument (e.g. out of range) */
61 #define CELT_BAD_ARG          -1
62 /** The mode struct passed is invalid */
63 #define CELT_INVALID_MODE     -2
64 /** An internal error was detected */
65 #define CELT_INTERNAL_ERROR   -3
66 /** The data passed (e.g. compressed data to decoder) is corrupted */
67 #define CELT_CORRUPTED_DATA   -4
68 /** Invalid/unsupported request number */
69 #define CELT_UNIMPLEMENTED    -5
70
71 /* Requests */
72 #define CELT_GET_MODE_REQUEST    1
73 /** Get the CELTMode used by an encoder or decoder */
74 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, _celt_check_mode_ptr_ptr(x)
75 #define CELT_SET_COMPLEXITY_REQUEST    2
76 /** Controls the complexity from 0-10 (int) */
77 #define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
78 #define CELT_SET_LTP_REQUEST    4
79 /** Activate or deactivate the use of the long term predictor (PITCH) from 0 or 1 (int) */
80 #define CELT_SET_LTP(x) CELT_SET_LTP_REQUEST, _celt_check_int(x)
81 #define CELT_SET_VBR_RATE_REQUEST    6
82 /** Set the target VBR rate in bits per second (int); 0=CBR (default) */
83 #define CELT_SET_VBR_RATE(x) CELT_SET_VBR_RATE_REQUEST, _celt_check_int(x)
84 /** Reset the encoder/decoder memories to zero*/
85 #define CELT_RESET_STATE_REQUEST        8
86 #define CELT_RESET_STATE       CELT_RESET_STATE_REQUEST
87
88 /** GET the frame size used in the current mode */
89 #define CELT_GET_FRAME_SIZE   1000
90 /** GET the lookahead used in the current mode */
91 #define CELT_GET_LOOKAHEAD    1001
92 /** GET the number of channels used in the current mode */
93 #define CELT_GET_NB_CHANNELS  1002
94 /** GET the sample rate used in the current mode */
95 #define CELT_GET_SAMPLE_RATE  1003
96
97 /** GET the bit-stream version for compatibility check */
98 #define CELT_GET_BITSTREAM_VERSION 2000
99
100
101 /** Contains the state of an encoder. One encoder state is needed for each 
102     stream. It is initialised once at the beginning of the stream. Do *not*
103     re-initialise the state for every frame.
104    @brief Encoder state
105  */
106 typedef struct CELTEncoder CELTEncoder;
107
108 /** State of the decoder. One decoder state is needed for each stream. It is
109     initialised once at the beginning of the stream. Do *not* re-initialise
110     the state for every frame */
111 typedef struct CELTDecoder CELTDecoder;
112
113 /** The mode contains all the information necessary to create an encoder. Both
114     the encoder and decoder need to be initialised with exactly the same mode,
115     otherwise the quality will be very bad */
116 typedef struct CELTMode CELTMode;
117
118
119 /** \defgroup codec Encoding and decoding */
120 /*  @{ */
121
122 /* Mode calls */
123
124 /** Creates a new mode struct. This will be passed to an encoder or decoder.
125     The mode MUST NOT BE DESTROYED until the encoders and decoders that use it
126     are destroyed as well.
127  @param Fs Sampling rate (32000 to 96000 Hz)
128  @param channels Number of channels
129  @param frame_size Number of samples (per channel) to encode in each packet (even values; 64 - 512)
130  @param error Returned error code (if NULL, no error will be returned)
131  @return A newly created mode
132 */
133 EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int channels, int frame_size, int *error);
134
135 /** Destroys a mode struct. Only call this after all encoders and decoders
136     using this mode are destroyed as well.
137  @param mode Mode to be destroyed
138 */
139 EXPORT void celt_mode_destroy(CELTMode *mode);
140
141 /** Query information from a mode */
142 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
143
144 /* Encoder stuff */
145
146
147 /** Creates a new encoder state. Each stream needs its own encoder state (can't
148     be shared across simultaneous streams).
149  @param mode Contains all the information about the characteristics of the stream
150              (must be the same characteristics as used for the decoder)
151  @return Newly created encoder state.
152 */
153 EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode);
154
155 /** Destroys a an encoder state.
156  @param st Encoder state to be destroyed
157  */
158 EXPORT void celt_encoder_destroy(CELTEncoder *st);
159
160 /** Encodes a frame of audio.
161  @param st Encoder state
162  @param pcm PCM audio in float format, with a normal range of ±1.0. 
163  *          Samples with a range beyond ±1.0 are supported but will be clipped by 
164  *          decoders using the integer API and should only be used if it is known that
165  *          the far end supports extended dynmaic range. There must be exactly
166  *          frame_size samples per channel. 
167  @param optional_synthesis If not NULL, the encoder copies the audio signal that
168  *                         the decoder would decode. It is the same as calling the
169  *                         decoder on the compressed data, just faster.
170  *                         This may alias pcm. 
171  @param compressed The compressed data is written here. This may not alias pcm or
172  *                         optional_synthesis.
173  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
174  *                        (can change from one frame to another)
175  @return Number of bytes written to "compressed". Will be the same as 
176  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
177  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
178  *       the length returned be somehow transmitted to the decoder. Otherwise, no
179  *       decoding is possible.
180 */
181 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
182
183 /** Encodes a frame of audio.
184  @param st Encoder state
185  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
186  *          exactly frame_size samples per channel. 
187  @param optional_synthesis If not NULL, the encoder copies the audio signal that
188  *                         the decoder would decode. It is the same as calling the
189  *                         decoder on the compressed data, just faster.
190  *                         This may alias pcm. 
191  @param compressed The compressed data is written here. This may not alias pcm or
192  *                         optional_synthesis.
193  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
194  *                        (can change from one frame to another)
195  @return Number of bytes written to "compressed". Will be the same as 
196  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
197  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
198  *       the length returned be somehow transmitted to the decoder. Otherwise, no
199  *       decoding is possible.
200  */
201 EXPORT int celt_encode(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
202
203 /** Query and set encoder parameters 
204  @param st Encoder state
205  @param request Parameter to change or query
206  @param value Pointer to a 32-bit int value
207  @return Error code
208 */
209 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
210
211 /* Decoder stuff */
212
213
214 /** Creates a new decoder state. Each stream needs its own decoder state (can't
215     be shared across simultaneous streams).
216  @param mode Contains all the information about the characteristics of the
217              stream (must be the same characteristics as used for the encoder)
218  @return Newly created decoder state.
219  */
220 EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode);
221
222 /** Destroys a a decoder state.
223  @param st Decoder state to be destroyed
224  */
225 EXPORT void celt_decoder_destroy(CELTDecoder *st);
226
227 /** Decodes a frame of audio.
228  @param st Decoder state
229  @param data Compressed data produced by an encoder
230  @param len Number of bytes to read from "data". This MUST be exactly the number
231             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
232  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
233             returned here in float format. 
234  @return Error code.
235    */
236 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm);
237
238 /** Decodes a frame of audio.
239  @param st Decoder state
240  @param data Compressed data produced by an encoder
241  @param len Number of bytes to read from "data". This MUST be exactly the number
242             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
243  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
244             returned here in 16-bit PCM format (native endian). 
245  @return Error code.
246  */
247 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16_t *pcm);
248
249 /** Query and set decoder parameters
250    @param st Decoder state
251    @param request Parameter to change or query
252    @param value Pointer to a 32-bit int value
253    @return Error code
254  */
255 EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
256
257
258 /*  @} */
259
260
261 #ifdef __cplusplus
262 }
263 #endif
264
265 #endif /*CELT_H */