This code does a very naive reset of the state. It is possible (even likely)
[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
56 /* Error codes */
57 /** No error */
58 #define CELT_OK                0
59 /** An (or more) invalid argument (e.g. out of range) */
60 #define CELT_BAD_ARG          -1
61 /** The mode struct passed is invalid */
62 #define CELT_INVALID_MODE     -2
63 /** An internal error was detected */
64 #define CELT_INTERNAL_ERROR   -3
65 /** The data passed (e.g. compressed data to decoder) is corrupted */
66 #define CELT_CORRUPTED_DATA   -4
67 /** Invalid/unsupported request number */
68 #define CELT_UNIMPLEMENTED    -5
69
70 /* Requests */
71 #define CELT_SET_COMPLEXITY_REQUEST    2
72 /** Controls the complexity from 0-10 (int) */
73 #define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
74 #define CELT_SET_LTP_REQUEST    4
75 /** Activate or deactivate the use of the long term predictor (PITCH) from 0 or 1 (int) */
76 #define CELT_SET_LTP(x) CELT_SET_LTP_REQUEST, _celt_check_int(x)
77 #define CELT_SET_VBR_RATE_REQUEST    6
78 /** Set the target VBR rate in bits per second (int); 0=CBR (default) */
79 #define CELT_SET_VBR_RATE(x) CELT_SET_VBR_RATE_REQUEST, _celt_check_int(x)
80 /** Reset the encoder/decoder memories to zero*/
81 #define CELT_RESET_STATE_REQUEST        8
82 #define CELT_RESET_STATE       CELT_RESET_STATE_REQUEST
83
84 /** GET the frame size used in the current mode */
85 #define CELT_GET_FRAME_SIZE   1000
86 /** GET the lookahead used in the current mode */
87 #define CELT_GET_LOOKAHEAD    1001
88 /** GET the number of channels used in the current mode */
89 #define CELT_GET_NB_CHANNELS  1002
90
91 /** GET the bit-stream version for compatibility check */
92 #define CELT_GET_BITSTREAM_VERSION 2000
93
94
95 /** Contains the state of an encoder. One encoder state is needed for each 
96     stream. It is initialised once at the beginning of the stream. Do *not*
97     re-initialise the state for every frame.
98    @brief Encoder state
99  */
100 typedef struct CELTEncoder CELTEncoder;
101
102 /** State of the decoder. One decoder state is needed for each stream. It is
103     initialised once at the beginning of the stream. Do *not* re-initialise
104     the state for every frame */
105 typedef struct CELTDecoder CELTDecoder;
106
107 /** The mode contains all the information necessary to create an encoder. Both
108     the encoder and decoder need to be initialised with exactly the same mode,
109     otherwise the quality will be very bad */
110 typedef struct CELTMode CELTMode;
111
112
113 /** \defgroup codec Encoding and decoding */
114 /*  @{ */
115
116 /* Mode calls */
117
118 /** Creates a new mode struct. This will be passed to an encoder or decoder.
119     The mode MUST NOT BE DESTROYED until the encoders and decoders that use it
120     are destroyed as well.
121  @param Fs Sampling rate (32000 to 96000 Hz)
122  @param channels Number of channels
123  @param frame_size Number of samples (per channel) to encode in each packet (even values; 64 - 512)
124  @param lookahead Extra latency (in samples per channel) in addition to the frame size (between 32 and frame_size). 
125  @param error Returned error code (if NULL, no error will be returned)
126  @return A newly created mode
127 */
128 EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int channels, int frame_size, int *error);
129
130 /** Destroys a mode struct. Only call this after all encoders and decoders
131     using this mode are destroyed as well.
132  @param mode Mode to be destroyed
133 */
134 EXPORT void celt_mode_destroy(CELTMode *mode);
135
136 /** Query information from a mode */
137 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
138
139 /* Encoder stuff */
140
141
142 /** Creates a new encoder state. Each stream needs its own encoder state (can't
143     be shared across simultaneous streams).
144  @param mode Contains all the information about the characteristics of the stream
145              (must be the same characteristics as used for the decoder)
146  @return Newly created encoder state.
147 */
148 EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode);
149
150 /** Destroys a an encoder state.
151  @param st Encoder state to be destroyed
152  */
153 EXPORT void celt_encoder_destroy(CELTEncoder *st);
154
155 /** Encodes a frame of audio.
156  @param st Encoder state
157  @param pcm PCM audio in float format, with a normal range of ±1.0. 
158  *          Samples with a range beyond ±1.0 are supported but will be clipped by 
159  *          decoders using the integer API and should only be used if it is known that
160  *          the far end supports extended dynmaic range. There must be exactly
161  *          frame_size samples per channel. 
162  @param optional_synthesis If not NULL, the encoder copies the audio signal that
163  *                         the decoder would decode. It is the same as calling the
164  *                         decoder on the compressed data, just faster.
165  *                         This may alias pcm. 
166  @param compressed The compressed data is written here. This may not alias pcm or
167  *                         optional_synthesis.
168  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
169  *                        (can change from one frame to another)
170  @return Number of bytes written to "compressed". Will be the same as 
171  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
172  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
173  *       the length returned be somehow transmitted to the decoder. Otherwise, no
174  *       decoding is possible.
175 */
176 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
177
178 /** Encodes a frame of audio.
179  @param st Encoder state
180  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
181  *          exactly frame_size samples per channel. 
182  @param optional_synthesis If not NULL, the encoder copies the audio signal that
183  *                         the decoder would decode. It is the same as calling the
184  *                         decoder on the compressed data, just faster.
185  *                         This may alias pcm. 
186  @param compressed The compressed data is written here. This may not alias pcm or
187  *                         optional_synthesis.
188  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
189  *                        (can change from one frame to another)
190  @return Number of bytes written to "compressed". Will be the same as 
191  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
192  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
193  *       the length returned be somehow transmitted to the decoder. Otherwise, no
194  *       decoding is possible.
195  */
196 EXPORT int celt_encode(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
197
198 /** Query and set encoder parameters 
199  @param st Encoder state
200  @param request Parameter to change or query
201  @param value Pointer to a 32-bit int value
202  @return Error code
203 */
204 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
205
206 /* Decoder stuff */
207
208
209 /** Creates a new decoder state. Each stream needs its own decoder state (can't
210     be shared across simultaneous streams).
211  @param mode Contains all the information about the characteristics of the
212              stream (must be the same characteristics as used for the encoder)
213  @return Newly created decoder state.
214  */
215 EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode);
216
217 /** Destroys a a decoder state.
218  @param st Decoder state to be destroyed
219  */
220 EXPORT void celt_decoder_destroy(CELTDecoder *st);
221
222 /** Decodes a frame of audio.
223  @param st Decoder state
224  @param data Compressed data produced by an encoder
225  @param len Number of bytes to read from "data". This MUST be exactly the number
226             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
227  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
228             returned here in float format. 
229  @return Error code.
230    */
231 EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm);
232
233 /** Decodes a frame of audio.
234  @param st Decoder state
235  @param data Compressed data produced by an encoder
236  @param len Number of bytes to read from "data". This MUST be exactly the number
237             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
238  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
239             returned here in 16-bit PCM format (native endian). 
240  @return Error code.
241  */
242 EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16_t *pcm);
243
244 /** Query and set decoder parameters
245    @param st Decoder state
246    @param request Parameter to change or query
247    @param value Pointer to a 32-bit int value
248    @return Error code
249  */
250 EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);
251
252
253 /*  @} */
254
255
256 #ifdef __cplusplus
257 }
258 #endif
259
260 #endif /*CELT_H */