celt.h 11 KB
Newer Older
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
6
7
 */

8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
   
   - Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
   
   - Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
   
   - Neither the name of the Xiph.org Foundation nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
   
   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef CELT_H
#define CELT_H

Jean-Marc Valin's avatar
Jean-Marc Valin committed
40
41
#include "celt_types.h"

42
43
44
45
#ifdef __cplusplus
extern "C" {
#endif

46
47
48
49
50
51
52
53
#if defined(__GNUC__) && defined(CELT_BUILD)
#define EXPORT __attribute__ ((visibility ("default")))
#elif defined(WIN32)
#define EXPORT __declspec(dllexport)
#else
#define EXPORT
#endif

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
/** An encoder or decoder structure is invalid or already freed */
71
#define CELT_INVALID_STATE    -6
72
/** Memory allocation has failed */
73
#define CELT_ALLOC_FAIL       -7
74

75
/* Requests */
76
77
78
#define CELT_GET_MODE_REQUEST    1
/** Get the CELTMode used by an encoder or decoder */
#define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, _celt_check_mode_ptr_ptr(x)
79
#define CELT_SET_COMPLEXITY_REQUEST    2
Jean-Marc Valin's avatar
Jean-Marc Valin committed
80
/** Controls the complexity from 0-10 (int) */
81
#define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
82
83
84
85
86
87
88
#define CELT_SET_PREDICTION_REQUEST    4
/** Controls the use of interframe prediction.
    0=Independent frames
    1=Short term interframe prediction allowed
    2=Long term prediction allowed
 */
#define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, _celt_check_int(x)
89
#define CELT_SET_VBR_RATE_REQUEST    6
90
/** Set the target VBR rate in bits per second(int); 0=CBR (default) */
91
#define CELT_SET_VBR_RATE(x) CELT_SET_VBR_RATE_REQUEST, _celt_check_int(x)
92
93
94
/** Reset the encoder/decoder memories to zero*/
#define CELT_RESET_STATE_REQUEST        8
#define CELT_RESET_STATE       CELT_RESET_STATE_REQUEST
95

Jean-Marc Valin's avatar
Jean-Marc Valin committed
96
/** GET the frame size used in the current mode */
Jean-Marc Valin's avatar
Jean-Marc Valin committed
97
#define CELT_GET_FRAME_SIZE   1000
Jean-Marc Valin's avatar
Jean-Marc Valin committed
98
/** GET the lookahead used in the current mode */
Jean-Marc Valin's avatar
Jean-Marc Valin committed
99
#define CELT_GET_LOOKAHEAD    1001
100
101
/** GET the sample rate used in the current mode */
#define CELT_GET_SAMPLE_RATE  1003
102

103
104
105
/** GET the bit-stream version for compatibility check */
#define CELT_GET_BITSTREAM_VERSION 2000

106

107
108
109
/** Contains the state of an encoder. One encoder state is needed 
    for each stream. It is initialised once at the beginning of the
    stream. Do *not* re-initialise the state for every frame.
110
111
   @brief Encoder state
 */
112
typedef struct CELTEncoder CELTEncoder;
113

114
115
116
/** State of the decoder. One decoder state is needed for each stream.
    It is initialised once at the beginning of the stream. Do *not*
    re-initialise the state for every frame */
117
typedef struct CELTDecoder CELTDecoder;
118

119
120
121
122
/** The mode contains all the information necessary to create an
    encoder. Both the encoder and decoder need to be initialised
    with exactly the same mode, otherwise the quality will be very 
    bad */
Jean-Marc Valin's avatar
Jean-Marc Valin committed
123
typedef struct CELTMode CELTMode;
124

125

126
127
128
129
/** \defgroup codec Encoding and decoding */
/*  @{ */

/* Mode calls */
130

131
132
133
/** Creates a new mode struct. This will be passed to an encoder or 
    decoder. The mode MUST NOT BE DESTROYED until the encoders and 
    decoders that use it are destroyed as well.
Gregory Maxwell's avatar
Gregory Maxwell committed
134
 @param Fs Sampling rate (32000 to 96000 Hz)
135
 @param channels Number of channels
136
137
 @param frame_size Number of samples (per channel) to encode in each 
                   packet (even values; 64 - 512)
138
139
140
 @param error Returned error code (if NULL, no error will be returned)
 @return A newly created mode
*/
141
EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int frame_size, int *error);
142

143
144
/** Destroys a mode struct. Only call this after all encoders and 
    decoders using this mode are destroyed as well.
145
146
 @param mode Mode to be destroyed
*/
147
EXPORT void celt_mode_destroy(CELTMode *mode);
148

149
/** Query information from a mode */
150
EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
151

152
153
/* Encoder stuff */

154

155
156
157
158
159
/** Creates a new encoder state. Each stream needs its own encoder 
    state (can't be shared across simultaneous streams).
 @param mode Contains all the information about the characteristics of
 *  the stream (must be the same characteristics as used for the 
 *  decoder)
160
161
 @return Newly created encoder state.
*/
162
EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode, int channels, int *error);
163
164

/** Destroys a an encoder state.
165
 @param st Encoder state to be destroyed
166
 */
167
EXPORT void celt_encoder_destroy(CELTEncoder *st);
168

169
170
/** Encodes a frame of audio.
 @param st Encoder state
Gregory Maxwell's avatar
Gregory Maxwell committed
171
 @param pcm PCM audio in float format, with a normal range of ±1.0. 
172
173
174
175
 *          Samples with a range beyond ±1.0 are supported but will 
 *          be clipped by decoders using the integer API and should 
 *          only be used if it is known that the far end supports 
 *          extended dynmaic range. There must be exactly
Gregory Maxwell's avatar
Gregory Maxwell committed
176
 *          frame_size samples per channel. 
Jean-Marc Valin's avatar
Jean-Marc Valin committed
177
 @param optional_synthesis If not NULL, the encoder copies the audio signal that
178
179
180
 *          the decoder would decode. It is the same as calling the
 *          decoder on the compressed data, just faster.
 *          This may alias pcm. 
Gregory Maxwell's avatar
Gregory Maxwell committed
181
 @param compressed The compressed data is written here. This may not alias pcm or
182
 *                 optional_synthesis.
Gregory Maxwell's avatar
Gregory Maxwell committed
183
 @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
184
 *          (can change from one frame to another)
Gregory Maxwell's avatar
Gregory Maxwell committed
185
186
187
188
189
 @return Number of bytes written to "compressed". Will be the same as 
 *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
 *       If negative, an error has occurred (see error codes). It is IMPORTANT that
 *       the length returned be somehow transmitted to the decoder. Otherwise, no
 *       decoding is possible.
190
*/
191
EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
Gregory Maxwell's avatar
Gregory Maxwell committed
192

Jean-Marc Valin's avatar
Jean-Marc Valin committed
193
194
195
/** Encodes a frame of audio.
 @param st Encoder state
 @param pcm PCM audio in signed 16-bit format (native endian). There must be 
Gregory Maxwell's avatar
Gregory Maxwell committed
196
 *          exactly frame_size samples per channel. 
Jean-Marc Valin's avatar
Jean-Marc Valin committed
197
198
199
 @param optional_synthesis If not NULL, the encoder copies the audio signal that
 *                         the decoder would decode. It is the same as calling the
 *                         decoder on the compressed data, just faster.
Gregory Maxwell's avatar
Gregory Maxwell committed
200
201
202
203
 *                         This may alias pcm. 
 @param compressed The compressed data is written here. This may not alias pcm or
 *                         optional_synthesis.
 @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
Jean-Marc Valin's avatar
Jean-Marc Valin committed
204
 *                        (can change from one frame to another)
Gregory Maxwell's avatar
Gregory Maxwell committed
205
206
207
208
209
 @return Number of bytes written to "compressed". Will be the same as 
 *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
 *       If negative, an error has occurred (see error codes). It is IMPORTANT that
 *       the length returned be somehow transmitted to the decoder. Otherwise, no
 *       decoding is possible.
Jean-Marc Valin's avatar
Jean-Marc Valin committed
210
 */
211
EXPORT int celt_encode(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
212

213
214
215
216
217
218
/** Query and set encoder parameters 
 @param st Encoder state
 @param request Parameter to change or query
 @param value Pointer to a 32-bit int value
 @return Error code
*/
219
EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
220

221
222
/* Decoder stuff */

223

224
225
226
227
228
229
/** Creates a new decoder state. Each stream needs its own decoder state (can't
    be shared across simultaneous streams).
 @param mode Contains all the information about the characteristics of the
             stream (must be the same characteristics as used for the encoder)
 @return Newly created decoder state.
 */
230
EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode, int channels, int *error);
231
232

/** Destroys a a decoder state.
233
 @param st Decoder state to be destroyed
234
 */
235
EXPORT void celt_decoder_destroy(CELTDecoder *st);
236

237
238
239
240
241
242
/** Decodes a frame of audio.
 @param st Decoder state
 @param data Compressed data produced by an encoder
 @param len Number of bytes to read from "data". This MUST be exactly the number
            of bytes returned by the encoder. Using a larger value WILL NOT WORK.
 @param pcm One frame (frame_size samples per channel) of decoded PCM will be
Jean-Marc Valin's avatar
Jean-Marc Valin committed
243
            returned here in float format. 
244
245
 @return Error code.
   */
246
EXPORT int celt_decode_float(CELTDecoder *st, const unsigned char *data, int len, float *pcm);
Gregory Maxwell's avatar
Gregory Maxwell committed
247

Jean-Marc Valin's avatar
Jean-Marc Valin committed
248
249
250
251
252
253
254
255
256
/** Decodes a frame of audio.
 @param st Decoder state
 @param data Compressed data produced by an encoder
 @param len Number of bytes to read from "data". This MUST be exactly the number
            of bytes returned by the encoder. Using a larger value WILL NOT WORK.
 @param pcm One frame (frame_size samples per channel) of decoded PCM will be
            returned here in 16-bit PCM format (native endian). 
 @return Error code.
 */
257
EXPORT int celt_decode(CELTDecoder *st, const unsigned char *data, int len, celt_int16_t *pcm);
258

259
260
261
262
263
264
265
266
267
/** Query and set decoder parameters
   @param st Decoder state
   @param request Parameter to change or query
   @param value Pointer to a 32-bit int value
   @return Error code
 */
EXPORT int celt_decoder_ctl(CELTDecoder * st, int request, ...);


268
/*  @} */
Jean-Marc Valin's avatar
Jean-Marc Valin committed
269

270
271
const char *celt_strerror(int error);

Jean-Marc Valin's avatar
Jean-Marc Valin committed
272

273
274
275
276
#ifdef __cplusplus
}
#endif

277
#endif /*CELT_H */