Final range coder state now exposed through the ctl() interface
[opus.git] / src / opus.h
1 /* Copyright (c) 2010 Xiph.Org Foundation
2    Written by Jean-Marc Valin */
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 __check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
56 #define __check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
57 #define __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 MODE_SILK_ONLY          1000
87 #define MODE_HYBRID             1001
88 #define MODE_CELT_ONLY          1002
89
90 #define OPUS_BANDWIDTH_AUTO          1100
91 #define OPUS_BANDWIDTH_NARROWBAND    1101
92 #define OPUS_BANDWIDTH_MEDIUMBAND    1102
93 #define OPUS_BANDWIDTH_WIDEBAND      1103
94 #define OPUS_BANDWIDTH_SUPERWIDEBAND 1104
95 #define OPUS_BANDWIDTH_FULLBAND      1105
96
97
98 /* OPUS_APPLICATION_VOIP or OPUS_APPLICATION_AUDIO */
99 #define OPUS_SET_APPLICATION_REQUEST 0
100 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __check_int(x)
101 #define OPUS_GET_APPLICATION_REQUEST 1
102 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __check_int_ptr(x)
103
104 /* Coding bit-rate in bit/second */
105 #define OPUS_SET_BITRATE_REQUEST 2
106 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
107 #define OPUS_GET_BITRATE_REQUEST 3
108 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
109
110 /* 0 for CBR, 1 for VBR */
111 #define OPUS_SET_VBR_REQUEST 6
112 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __check_int(x)
113 #define OPUS_GET_VBR_REQUEST 7
114 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __check_int_ptr(x)
115
116 #define OPUS_SET_BANDWIDTH_REQUEST 8
117 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
118 #define OPUS_GET_BANDWIDTH_REQUEST 9
119 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
120
121 #define OPUS_SET_COMPLEXITY_REQUEST 10
122 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
123 #define OPUS_GET_COMPLEXITY_REQUEST 11
124 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
125
126 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
127 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
128 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
129 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
130
131 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
132 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
133 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
134 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
135
136 #define OPUS_SET_DTX_REQUEST 16
137 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __check_int(x)
138 #define OPUS_GET_DTX_REQUEST 17
139 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __check_int_ptr(x)
140
141 #define OPUS_SET_VOICE_RATIO_REQUEST 18
142 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __check_int(x)
143 #define OPUS_GET_VOICE_RATIO_REQUEST 19
144 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __check_int_ptr(x)
145
146 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 20
147 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __check_int(x)
148 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 21
149 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __check_int_ptr(x)
150
151 #define OPUS_SET_FORCE_MONO_REQUEST 22
152 #define OPUS_SET_FORCE_MONO(x) OPUS_SET_FORCE_MONO_REQUEST, __check_int(x)
153 #define OPUS_GET_FORCE_MONO_REQUEST 23
154 #define OPUS_GET_FORCE_MONO(x) OPUS_GET_FORCE_MONO_REQUEST, __check_int_ptr(x)
155
156 #define OPUS_SET_SIGNAL_REQUEST 24
157 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __check_int(x)
158 #define OPUS_GET_SIGNAL_REQUEST 25
159 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __check_int_ptr(x)
160
161 #define OPUS_GET_LOOKAHEAD_REQUEST 27
162 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __check_int_ptr(x)
163
164 /* For testing purposes: the encoder and decoder state should
165    always be identical after coding a payload */
166 #define OPUS_GET_FINAL_RANGE_REQUEST 29
167 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __check_uint_ptr(x)
168
169 typedef struct OpusEncoder OpusEncoder;
170 typedef struct OpusDecoder OpusDecoder;
171
172 /*
173  * There are two coding modes:
174  * OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
175  *    signals. It enhances the  input signal by high-pass filtering and
176  *    emphasizing formants and harmonics. Optionally  it includes in-band
177  *    forward error correction to protect against packet loss. Use this
178  *    mode for typical VoIP applications. Because of the enhancement,
179  *    even at high bitrates the output may sound different from the input.
180  * OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
181  *    non-voice signals like music. Use this mode for music and mixed
182  *    (music/voice) content, broadcast, and applications requiring less
183  *    than 15 ms of coding delay.
184  */
185
186 /* Returns initialized encoder state */
187 OPUS_EXPORT OpusEncoder *opus_encoder_create(
188     int Fs,                     /* Sampling rate of input signal (Hz) */
189     int channels,               /* Number of channels (1/2) in input signal */
190     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
191 );
192
193 OPUS_EXPORT OpusEncoder *opus_encoder_init(
194     OpusEncoder *st,            /* Encoder state */
195     int Fs,                     /* Sampling rate of input signal (Hz) */
196     int channels,               /* Number of channels (1/2) in input signal */
197     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
198 );
199
200 /* Returns length of the data payload (in bytes) */
201 OPUS_EXPORT int opus_encode(
202     OpusEncoder *st,            /* Encoder state */
203     const opus_int16 *pcm,      /* Input signal (interleaved if 2 channels). length is frame_size*channels */
204     int frame_size,             /* Number of samples per frame of input signal */
205     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
206     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
207 );
208
209 /* Returns length of the data payload (in bytes) */
210 OPUS_EXPORT int opus_encode_float(
211     OpusEncoder *st,            /* Encoder state */
212     const float *pcm,           /* Input signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of +/-1.0*/
213     int frame_size,             /* Number of samples per frame of input signal */
214     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
215     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
216 );
217
218 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
219
220 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
221
222 OPUS_EXPORT OpusDecoder *opus_decoder_create(
223     int Fs,                     /* Sampling rate of output signal (Hz) */
224     int channels                /* Number of channels (1/2) in output signal */
225 );
226
227 OPUS_EXPORT OpusDecoder *opus_decoder_init(OpusDecoder *st,
228     int Fs,                     /* Sampling rate of output signal (Hz) */
229     int channels                /* Number of channels (1/2) in output signal */
230 );
231
232 /* Returns the number of samples decoded or a negative error code */
233 OPUS_EXPORT int opus_decode(
234     OpusDecoder *st,            /* Decoder state */
235     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
236     int len,                    /* Number of bytes in payload */
237     opus_int16 *pcm,            /* Output signal (interleaved if 2 channels). length is frame_size*channels */
238     int frame_size,             /* Number of samples per frame of input signal */
239     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
240                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
241 );
242
243 /* Returns the number of samples decoded or a negative error code */
244 OPUS_EXPORT int opus_decode_float(
245     OpusDecoder *st,            /* Decoder state */
246     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
247     int len,                    /* Number of bytes in payload */
248     float *pcm,                 /* Output signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of -/+1.0*/
249     int frame_size,             /* Number of samples per frame of input signal */
250     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
251                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
252 );
253
254 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
255
256 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
257
258 OPUS_EXPORT int opus_packet_parse(const unsigned char *data, int len,
259       unsigned char *out_toc, const unsigned char *frames[48],
260       short size[48], int *payload_offset);
261
262 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
263 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, int Fs);
264 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
265 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
266 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
267
268 OPUS_EXPORT const char *opus_strerror(int error);
269
270 OPUS_EXPORT const char *opus_get_version_string(void);
271
272 /* Repacketizer */
273 typedef struct OpusRepacketizer OpusRepacketizer;
274
275 OPUS_EXPORT int opus_repacketizer_get_size(void);
276
277 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp);
278
279 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_create(void);
280
281 OPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp);
282
283 OPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, int len);
284
285 OPUS_EXPORT int opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, int maxlen);
286
287 OPUS_EXPORT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp);
288
289 OPUS_EXPORT int opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, int maxlen);
290
291 #ifdef __cplusplus
292 }
293 #endif
294
295 #endif /* OPUS_H */