fb49b0b1fe0fa0654a8121cc8e2a9d7db009c41d
[opus.git] / src / opus.h
1 /* Copyright (c) 2010-2011 Xiph.Org Foundation, Skype Limited
2    Written by Jean-Marc Valin and Koen Vos */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef OPUS_H
29 #define OPUS_H
30
31 #include "opus_types.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #if defined(__GNUC__) && defined(OPUS_BUILD)
38
39 # define OPUS_EXPORT __attribute__ ((visibility ("default")))
40
41 #elif defined(WIN32)
42
43 # ifdef OPUS_BUILD
44 #   define OPUS_EXPORT __declspec(dllexport)
45 # else
46 #   define OPUS_EXPORT __declspec(dllimport)
47 # endif
48
49 #else
50
51 # define OPUS_EXPORT
52
53 #endif
54
55 #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
56 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
57 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
58
59 /* Error codes */
60 /** No error */
61 #define OPUS_OK                0
62 /** An (or more) invalid argument (e.g. out of range) */
63 #define OPUS_BAD_ARG          -1
64 /** The mode struct passed is invalid */
65 #define OPUS_BUFFER_TOO_SMALL -2
66 /** An internal error was detected */
67 #define OPUS_INTERNAL_ERROR   -3
68 /** The data passed (e.g. compressed data to decoder) is corrupted */
69 #define OPUS_CORRUPTED_DATA   -4
70 /** Invalid/unsupported request number */
71 #define OPUS_UNIMPLEMENTED    -5
72 /** An encoder or decoder structure is invalid or already freed */
73 #define OPUS_INVALID_STATE    -6
74 /** Memory allocation has failed */
75 #define OPUS_ALLOC_FAIL       -7
76
77 #define OPUS_BITRATE_AUTO       -1
78
79 #define OPUS_APPLICATION_VOIP        2000
80 #define OPUS_APPLICATION_AUDIO       2001
81
82 #define OPUS_SIGNAL_AUTO             3000
83 #define OPUS_SIGNAL_VOICE            3001
84 #define OPUS_SIGNAL_MUSIC            3002
85
86 #define OPUS_BANDWIDTH_AUTO          1100
87 #define OPUS_BANDWIDTH_NARROWBAND    1101
88 #define OPUS_BANDWIDTH_MEDIUMBAND    1102
89 #define OPUS_BANDWIDTH_WIDEBAND      1103
90 #define OPUS_BANDWIDTH_SUPERWIDEBAND 1104
91 #define OPUS_BANDWIDTH_FULLBAND      1105
92
93
94 /* OPUS_APPLICATION_VOIP or OPUS_APPLICATION_AUDIO */
95 #define OPUS_SET_APPLICATION_REQUEST 0
96 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
97 #define OPUS_GET_APPLICATION_REQUEST 1
98 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
99
100 /* Coding bit-rate in bit/second */
101 #define OPUS_SET_BITRATE_REQUEST 2
102 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
103 #define OPUS_GET_BITRATE_REQUEST 3
104 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
105
106 /* 0 for CBR, 1 for VBR */
107 #define OPUS_SET_VBR_REQUEST 6
108 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
109 #define OPUS_GET_VBR_REQUEST 7
110 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
111
112 #define OPUS_SET_BANDWIDTH_REQUEST 8
113 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
114 #define OPUS_GET_BANDWIDTH_REQUEST 9
115 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
116
117 #define OPUS_SET_COMPLEXITY_REQUEST 10
118 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
119 #define OPUS_GET_COMPLEXITY_REQUEST 11
120 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
121
122 #define OPUS_SET_INBAND_FEC_REQUEST 12
123 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
124 #define OPUS_GET_INBAND_FEC_REQUEST 13
125 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
126
127 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
128 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
129 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
130 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
131
132 #define OPUS_SET_DTX_REQUEST 16
133 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
134 #define OPUS_GET_DTX_REQUEST 17
135 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
136
137 #define OPUS_SET_VOICE_RATIO_REQUEST 18
138 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __opus_check_int(x)
139 #define OPUS_GET_VOICE_RATIO_REQUEST 19
140 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __opus_check_int_ptr(x)
141
142 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 20
143 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
144 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 21
145 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
146
147 #define OPUS_SET_FORCE_MONO_REQUEST 22
148 #define OPUS_SET_FORCE_MONO(x) OPUS_SET_FORCE_MONO_REQUEST, __opus_check_int(x)
149 #define OPUS_GET_FORCE_MONO_REQUEST 23
150 #define OPUS_GET_FORCE_MONO(x) OPUS_GET_FORCE_MONO_REQUEST, __opus_check_int_ptr(x)
151
152 #define OPUS_SET_SIGNAL_REQUEST 24
153 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
154 #define OPUS_GET_SIGNAL_REQUEST 25
155 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
156
157 #define OPUS_GET_LOOKAHEAD_REQUEST 27
158 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
159
160 /* For testing purposes: the encoder and decoder state should
161    always be identical after coding a payload */
162 #define OPUS_GET_FINAL_RANGE_REQUEST 29
163 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
164
165 typedef struct OpusEncoder OpusEncoder;
166 typedef struct OpusDecoder OpusDecoder;
167
168 OPUS_EXPORT int opus_encoder_get_size(int channels);
169
170 /*
171  * There are two coding modes:
172  * OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
173  *    signals. It enhances the  input signal by high-pass filtering and
174  *    emphasizing formants and harmonics. Optionally  it includes in-band
175  *    forward error correction to protect against packet loss. Use this
176  *    mode for typical VoIP applications. Because of the enhancement,
177  *    even at high bitrates the output may sound different from the input.
178  * OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
179  *    non-voice signals like music. Use this mode for music and mixed
180  *    (music/voice) content, broadcast, and applications requiring less
181  *    than 15 ms of coding delay.
182  */
183
184 /* Returns initialized encoder state */
185 OPUS_EXPORT OpusEncoder *opus_encoder_create(
186     int Fs,                     /* Sampling rate of input signal (Hz) */
187     int channels,               /* Number of channels (1/2) in input signal */
188     int application,            /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
189     int *error                  /* Error code */
190 );
191
192 OPUS_EXPORT int opus_encoder_init(
193     OpusEncoder *st,            /* Encoder state */
194     int Fs,                     /* Sampling rate of input signal (Hz) */
195     int channels,               /* Number of channels (1/2) in input signal */
196     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
197 );
198
199 /* Returns length of the data payload (in bytes) */
200 OPUS_EXPORT int opus_encode(
201     OpusEncoder *st,            /* Encoder state */
202     const opus_int16 *pcm,      /* Input signal (interleaved if 2 channels). length is frame_size*channels */
203     int frame_size,             /* Number of samples per frame of input signal */
204     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
205     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
206 );
207
208 /* Returns length of the data payload (in bytes) */
209 OPUS_EXPORT int opus_encode_float(
210     OpusEncoder *st,            /* Encoder state */
211     const float *pcm,           /* Input signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of +/-1.0*/
212     int frame_size,             /* Number of samples per frame of input signal */
213     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
214     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
215 );
216
217 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
218
219 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
220
221
222
223 OPUS_EXPORT int opus_decoder_get_size(int channels);
224
225 OPUS_EXPORT OpusDecoder *opus_decoder_create(
226     int Fs,                     /* Sampling rate of output signal (Hz) */
227     int channels,               /* Number of channels (1/2) in output signal */
228     int *error                  /* Error code*/
229 );
230
231 OPUS_EXPORT int opus_decoder_init(OpusDecoder *st,
232     int Fs,                     /* Sampling rate of output signal (Hz) */
233     int channels                /* Number of channels (1/2) in output signal */
234 );
235
236 /* Returns the number of samples decoded or a negative error code */
237 OPUS_EXPORT int opus_decode(
238     OpusDecoder *st,            /* Decoder state */
239     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
240     int len,                    /* Number of bytes in payload */
241     opus_int16 *pcm,            /* Output signal (interleaved if 2 channels). length is frame_size*channels */
242     int frame_size,             /* Number of samples per frame of input signal */
243     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
244                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
245 );
246
247 /* Returns the number of samples decoded or a negative error code */
248 OPUS_EXPORT int opus_decode_float(
249     OpusDecoder *st,            /* Decoder state */
250     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
251     int len,                    /* Number of bytes in payload */
252     float *pcm,                 /* Output signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of -/+1.0*/
253     int frame_size,             /* Number of samples per frame of input signal */
254     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
255                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
256 );
257
258 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
259
260 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
261
262 OPUS_EXPORT int opus_packet_parse(const unsigned char *data, int len,
263       unsigned char *out_toc, const unsigned char *frames[48],
264       short size[48], int *payload_offset);
265
266 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
267 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, int Fs);
268 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
269 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
270 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
271
272 OPUS_EXPORT const char *opus_strerror(int error);
273
274 OPUS_EXPORT const char *opus_get_version_string(void);
275
276 /* Repacketizer */
277 typedef struct OpusRepacketizer OpusRepacketizer;
278
279 OPUS_EXPORT int opus_repacketizer_get_size(void);
280
281 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp);
282
283 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_create(void);
284
285 OPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp);
286
287 OPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, int len);
288
289 OPUS_EXPORT int opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, int maxlen);
290
291 OPUS_EXPORT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp);
292
293 OPUS_EXPORT int opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, int maxlen);
294
295 #ifdef __cplusplus
296 }
297 #endif
298
299 #endif /* OPUS_H */