celt.h 9.63 KB
Newer Older
1
/* (C) 2007-2008 Jean-Marc Valin, CSIRO
2
   (C) 2008 Gregory Maxwell */
3
4
5
6
7
/**
  @file celt.h
  @brief Contains all the functions for encoding and decoding audio streams
 */

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
55
#define _celt_check_int(x) (((void)((x) == (int)0)), (int)(x))

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
Jean-Marc Valin's avatar
Jean-Marc Valin committed
72
/** Controls the complexity from 0-10 (int) */
73
#define CELT_SET_COMPLEXITY(x) CELT_SET_COMPLEXITY_REQUEST, _celt_check_int(x)
74
75
76
#define CELT_SET_LTP_REQUEST    3
/** Activate or deactivate the use of the long term predictor (PITCH) from 0 or 1 (int) */
#define CELT_SET_LTP(x) CELT_SET_LTP_REQUEST, _celt_check_int(x)
77

Jean-Marc Valin's avatar
Jean-Marc Valin committed
78
/** GET the frame size used in the current mode */
Jean-Marc Valin's avatar
Jean-Marc Valin committed
79
#define CELT_GET_FRAME_SIZE   1000
Jean-Marc Valin's avatar
Jean-Marc Valin committed
80
/** GET the lookahead used in the current mode */
Jean-Marc Valin's avatar
Jean-Marc Valin committed
81
#define CELT_GET_LOOKAHEAD    1001
Jean-Marc Valin's avatar
Jean-Marc Valin committed
82
/** GET the number of channels used in the current mode */
83
#define CELT_GET_NB_CHANNELS  1002
84

85
86
87
/** GET the bit-stream version for compatibility check */
#define CELT_GET_BITSTREAM_VERSION 2000

88
89
90
91
92
93

/** 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.
   @brief Encoder state
 */
94
typedef struct CELTEncoder CELTEncoder;
95
96
97
98

/** 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 */
99
typedef struct CELTDecoder CELTDecoder;
100

101
102
103
/** 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
104
typedef struct CELTMode CELTMode;
105

106

107
108
109
110
/** \defgroup codec Encoding and decoding */
/*  @{ */

/* Mode calls */
111
112
113
114

/** 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
115
 @param Fs Sampling rate (32000 to 96000 Hz)
116
117
118
119
120
121
 @param channels Number of channels
 @param frame_size Number of samples (per channel) to encode in each packet (64 - 256)
 @param lookahead Extra latency (in samples per channel) in addition to the frame size (between 32 and frame_size). The larger that value, the better the quality (at the expense of latency)
 @param error Returned error code (if NULL, no error will be returned)
 @return A newly created mode
*/
122
EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int channels, int frame_size, int *error);
123
124
125
126
127

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

130
/** Query information from a mode */
131
EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
132

133
134
/* Encoder stuff */

135

136
137
138
139
140
141
/** 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)
 @return Newly created encoder state.
*/
142
EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode);
143
144

/** Destroys a an encoder state.
145
 @param st Encoder state to be destroyed
146
 */
147
EXPORT void celt_encoder_destroy(CELTEncoder *st);
148

149
150
/** Encodes a frame of audio.
 @param st Encoder state
Jean-Marc Valin's avatar
Jean-Marc Valin committed
151
152
153
154
155
156
 @param pcm PCM audio in signed float format. There must be 
 *          exactly frame_size samples per channel. The input data is 
 *          overwritten by a copy of what the remote decoder would decode.
 @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.
157
158
 @param compressed The compressed data is written here
 @param nbCompressedBytes Number of bytes to use for compressing the frame
Jean-Marc Valin's avatar
Jean-Marc Valin committed
159
 *                        (can change from one frame to another)
160
 @return Number of bytes written to "compressed". Should be the same as 
Jean-Marc Valin's avatar
Jean-Marc Valin committed
161
162
163
 *       "nbCompressedBytes" unless the stream is VBR. If negative, an error
 *       has occured (see error codes). It is IMPORTANT that the length returned
 *       be somehow transmitted to the decoder. Otherwise, no decoding is possible.
164
*/
165
EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
Jean-Marc Valin's avatar
Jean-Marc Valin committed
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/** Encodes a frame of audio.
 @param st Encoder state
 @param pcm PCM audio in signed 16-bit format (native endian). There must be 
 *          exactly frame_size samples per channel. The input data is 
 *          overwritten by a copy of what the remote decoder would decode.
 @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.
 @param compressed The compressed data is written here
 @param nbCompressedBytes Number of bytes to use for compressing the frame
 *                        (can change from one frame to another)
 @return Number of bytes written to "compressed". Should be the same as 
 *       "nbCompressedBytes" unless the stream is VBR. If negative, an error
 *       has occured (see error codes). It is IMPORTANT that the length returned
 *       be somehow transmitted to the decoder. Otherwise, no decoding is possible.
 */
182
EXPORT int celt_encode(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
183

184
185
186
187
188
189
/** 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
*/
190
EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, ...);
191

192
193
/* Decoder stuff */

194

195
196
197
198
199
200
/** 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.
 */
201
EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode);
202
203

/** Destroys a a decoder state.
204
 @param st Decoder state to be destroyed
205
 */
206
EXPORT void celt_decoder_destroy(CELTDecoder *st);
207

208
209
210
211
212
213
/** 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
214
            returned here in float format. 
215
216
 @return Error code.
   */
217
EXPORT int celt_decode_float(CELTDecoder *st, unsigned char *data, int len, float *pcm);
Jean-Marc Valin's avatar
Jean-Marc Valin committed
218
219
220
221
222
223
224
225
226
/** 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.
 */
227
EXPORT int celt_decode(CELTDecoder *st, unsigned char *data, int len, celt_int16_t *pcm);
228

229
/*  @} */
Jean-Marc Valin's avatar
Jean-Marc Valin committed
230
231


232
233
234
235
#ifdef __cplusplus
}
#endif

236
#endif /*CELT_H */