Including redundant frames in the final range coder state
[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) == (int)0)), (int)(x))
56 #define __check_int_ptr(ptr) ((ptr) + ((ptr) - (int*)(ptr)))
57
58 /* Error codes */
59 /** No error */
60 #define OPUS_OK                0
61 /** An (or more) invalid argument (e.g. out of range) */
62 #define OPUS_BAD_ARG          -1
63 /** The mode struct passed is invalid */
64 #define OPUS_BUFFER_TOO_SMALL -2
65 /** An internal error was detected */
66 #define OPUS_INTERNAL_ERROR   -3
67 /** The data passed (e.g. compressed data to decoder) is corrupted */
68 #define OPUS_CORRUPTED_DATA   -4
69 /** Invalid/unsupported request number */
70 #define OPUS_UNIMPLEMENTED    -5
71 /** An encoder or decoder structure is invalid or already freed */
72 #define OPUS_INVALID_STATE    -6
73 /** Memory allocation has failed */
74 #define OPUS_ALLOC_FAIL       -7
75
76 #define OPUS_BITRATE_AUTO       -1
77
78 #define OPUS_APPLICATION_VOIP        2000
79 #define OPUS_APPLICATION_AUDIO       2001
80
81 #define OPUS_SIGNAL_AUTO             3000
82 #define OPUS_SIGNAL_VOICE            3001
83 #define OPUS_SIGNAL_MUSIC            3002
84
85 #define MODE_SILK_ONLY          1000
86 #define MODE_HYBRID             1001
87 #define MODE_CELT_ONLY          1002
88
89 #define OPUS_BANDWIDTH_AUTO          1100
90 #define OPUS_BANDWIDTH_NARROWBAND    1101
91 #define OPUS_BANDWIDTH_MEDIUMBAND    1102
92 #define OPUS_BANDWIDTH_WIDEBAND      1103
93 #define OPUS_BANDWIDTH_SUPERWIDEBAND 1104
94 #define OPUS_BANDWIDTH_FULLBAND      1105
95
96
97 /* OPUS_APPLICATION_VOIP or OPUS_APPLICATION_AUDIO */
98 #define OPUS_SET_APPLICATION_REQUEST 0
99 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __check_int(x)
100 #define OPUS_GET_APPLICATION_REQUEST 1
101 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __check_int_ptr(x)
102
103 /* Coding bit-rate in bit/second */
104 #define OPUS_SET_BITRATE_REQUEST 2
105 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
106 #define OPUS_GET_BITRATE_REQUEST 3
107 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
108
109 /* 0 for CBR, 1 for VBR */
110 #define OPUS_SET_VBR_REQUEST 6
111 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __check_int(x)
112 #define OPUS_GET_VBR_REQUEST 7
113 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __check_int_ptr(x)
114
115 #define OPUS_SET_BANDWIDTH_REQUEST 8
116 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
117 #define OPUS_GET_BANDWIDTH_REQUEST 9
118 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
119
120 #define OPUS_SET_COMPLEXITY_REQUEST 10
121 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
122 #define OPUS_GET_COMPLEXITY_REQUEST 11
123 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
124
125 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
126 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
127 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
128 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
129
130 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
131 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
132 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
133 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
134
135 #define OPUS_SET_DTX_FLAG_REQUEST 16
136 #define OPUS_SET_DTX_FLAG(x) OPUS_SET_DTX_FLAG_REQUEST, __check_int(x)
137 #define OPUS_GET_DTX_FLAG_REQUEST 17
138 #define OPUS_GET_DTX_FLAG(x) OPUS_GET_DTX_FLAG_REQUEST, __check_int_ptr(x)
139
140 #define OPUS_SET_VOICE_RATIO_REQUEST 18
141 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __check_int(x)
142 #define OPUS_GET_VOICE_RATIO_REQUEST 19
143 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __check_int_ptr(x)
144
145 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 20
146 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __check_int(x)
147 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 21
148 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __check_int_ptr(x)
149
150 #define OPUS_SET_FORCE_MONO_REQUEST 22
151 #define OPUS_SET_FORCE_MONO(x) OPUS_SET_FORCE_MONO_REQUEST, __check_int(x)
152 #define OPUS_GET_FORCE_MONO_REQUEST 23
153 #define OPUS_GET_FORCE_MONO(x) OPUS_GET_FORCE_MONO_REQUEST, __check_int_ptr(x)
154
155 #define OPUS_SET_SIGNAL_REQUEST 24
156 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __check_int(x)
157 #define OPUS_GET_SIGNAL_REQUEST 25
158 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __check_int_ptr(x)
159
160 #define OPUS_GET_LOOKAHEAD_REQUEST 27
161 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __check_int_ptr(x)
162
163 typedef struct OpusEncoder OpusEncoder;
164 typedef struct OpusDecoder OpusDecoder;
165
166 /*
167  * There are two coding modes:
168  * OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
169  *    signals. It enhances the  input signal by high-pass filtering and
170  *    emphasizing formants and harmonics. Optionally  it includes in-band
171  *    forward error correction to protect against packet loss. Use this
172  *    mode for typical VoIP applications. Because of the enhancement,
173  *    even at high bitrates the output may sound different from the input.
174  * OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
175  *    non-voice signals like music. Use this mode for music and mixed
176  *    (music/voice) content, broadcast, and applications requiring less
177  *    than 15 ms of coding delay.
178  */
179
180 /* Returns initialized encoder state */
181 OPUS_EXPORT OpusEncoder *opus_encoder_create(
182     int Fs,                     /* Sampling rate of input signal (Hz) */
183     int channels,               /* Number of channels (1/2) in input signal */
184     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
185 );
186
187 OPUS_EXPORT OpusEncoder *opus_encoder_init(
188     OpusEncoder *st,            /* Encoder state */
189     int Fs,                     /* Sampling rate of input signal (Hz) */
190     int channels,               /* Number of channels (1/2) in input signal */
191     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
192 );
193
194 /* Returns length of the data payload (in bytes) */
195 OPUS_EXPORT int opus_encode(
196     OpusEncoder *st,            /* Encoder state */
197     const opus_int16 *pcm,      /* Input signal (interleaved if 2 channels). length is frame_size*channels */
198     int frame_size,             /* Number of samples per frame of input signal */
199     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
200     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
201 );
202
203 /* Returns length of the data payload (in bytes) */
204 OPUS_EXPORT int opus_encode_float(
205     OpusEncoder *st,            /* Encoder state */
206     const float *pcm,           /* Input signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of +/-1.0*/
207     int frame_size,             /* Number of samples per frame of input signal */
208     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
209     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
210 );
211
212 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
213
214 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
215
216 OPUS_EXPORT OpusDecoder *opus_decoder_create(
217     int Fs,                     /* Sampling rate of output signal (Hz) */
218     int channels                /* Number of channels (1/2) in output signal */
219 );
220
221 OPUS_EXPORT OpusDecoder *opus_decoder_init(OpusDecoder *st,
222     int Fs,                     /* Sampling rate of output signal (Hz) */
223     int channels                /* Number of channels (1/2) in output signal */
224 );
225
226 /* Returns the number of samples decoded or a negative error code */
227 OPUS_EXPORT int opus_decode(
228     OpusDecoder *st,            /* Decoder state */
229     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
230     int len,                    /* Number of bytes in payload */
231     opus_int16 *pcm,            /* Output signal (interleaved if 2 channels). length is frame_size*channels */
232     int frame_size,             /* Number of samples per frame of input signal */
233     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
234                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
235 );
236
237 /* Returns the number of samples decoded or a negative error code */
238 OPUS_EXPORT int opus_decode_float(
239     OpusDecoder *st,            /* Decoder state */
240     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
241     int len,                    /* Number of bytes in payload */
242     float *pcm,                 /* Output signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of -/+1.0*/
243     int frame_size,             /* Number of samples per frame of input signal */
244     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
245                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
246 );
247
248 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
249
250 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
251
252 OPUS_EXPORT int opus_packet_parse(const unsigned char *data, int len,
253       unsigned char *out_toc, const unsigned char *frames[48],
254       short size[48], int *payload_offset);
255
256 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
257 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, int Fs);
258 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
259 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
260 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
261
262 OPUS_EXPORT const char *opus_strerror(int error);
263
264 OPUS_EXPORT const char *opus_get_version_string(void);
265
266 /* For testing purposes: the encoder and decoder state should
267    always be identical after coding a payload */
268 OPUS_EXPORT int opus_encoder_get_final_range(OpusEncoder *st);
269 OPUS_EXPORT int opus_decoder_get_final_range(OpusDecoder *st);
270
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 */