Splits out the CELT encoder and decoder
[opus.git] / include / 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 COPYRIGHT OWNER
19    OR 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 /**
29  * @file opus.h
30  * @brief Opus reference implementation API
31  */
32
33 #ifndef OPUS_H
34 #define OPUS_H
35
36 #include "opus_types.h"
37 #include "opus_defines.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /**
44  * @mainpage Opus
45  *
46  * The Opus codec is designed for interactive speech and audio transmission over the Internet.
47  * It is designed by the IETF Codec Working Group and incorporates technology from
48  * Skype's SILK codec and Xiph.Org's CELT codec.
49  *
50  * The Opus codec is designed to handle a wide range of interactive audio applications,
51  * including Voice over IP, videoconferencing, in-game chat, and even remote live music
52  * performances. It can scale from low bit-rate narrowband speech to very high quality
53  * stereo music. Its main features are:
54
55  * @li Sampling rates from 8 to 48 kHz
56  * @li Bit-rates from 6 kb/s to 510 kb/s
57  * @li Support for both constant bit-rate (CBR) and variable bit-rate (VBR)
58  * @li Audio bandwidth from narrowband to full-band
59  * @li Support for speech and music
60  * @li Support for mono and stereo
61  * @li Support for multichannel (up to 255 channels)
62  * @li Frame sizes from 2.5 ms to 60 ms
63  * @li Good loss robustness and packet loss concealment (PLC)
64  * @li Floating point and fixed-point implementation
65  *
66  * Documentation sections:
67  * @li @ref opus_encoder
68  * @li @ref opus_decoder
69  * @li @ref opus_repacketizer
70  * @li @ref opus_multistream
71  * @li @ref opus_libinfo
72  * @li @ref opus_custom
73  */
74
75 /** @defgroup opus_encoder Opus Encoder
76   * @{
77   *
78   * @brief This page describes the process and functions used to encode Opus.
79   *
80   * Since Opus is a stateful codec, the encoding process starts with creating an encoder
81   * state. This can be done with:
82   *
83   * @code
84   * int          error;
85   * OpusEncoder *enc;
86   * enc = opus_encoder_create(Fs, channels, application, &error);
87   * @endcode
88   *
89   * From this point, @c enc can be used for encoding an audio stream. An encoder state
90   * @b must @b not be used for more than one stream at the same time. Similarly, the encoder
91   * state @b must @b not be re-initialized for each frame.
92   *
93   * While opus_encoder_create() allocates memory for the state, it's also possible
94   * to initialize pre-allocated memory:
95   *
96   * @code
97   * int          size;
98   * int          error;
99   * OpusEncoder *enc;
100   * size = opus_encoder_get_size(channels);
101   * enc = malloc(size);
102   * error = opus_encoder_init(enc, Fs, channels, application);
103   * @endcode
104   *
105   * where opus_encoder_get_size() returns the required size for the encoder state. Note that
106   * future versions of this code may change the size, so no assuptions should be made about it.
107   *
108   * The encoder state is always continuous in memory and only a shallow copy is sufficient
109   * to copy it (e.g. memcpy())
110   *
111   * It is possible to change some of the encoder's settings using the opus_encoder_ctl()
112   * interface. All these settings already default to the recommended value, so they should
113   * only be changed when necessary. The most common settings one may want to change are:
114   *
115   * @code
116   * opus_encoder_ctl(enc, OPUS_SET_BITRATE(bitrate));
117   * opus_encoder_ctl(enc, OPUS_SET_COMPLEXITY(complexity));
118   * opus_encoder_ctl(enc, OPUS_SET_SIGNAL(signal_type));
119   * @endcode
120   *
121   * where
122   *
123   * @arg bitrate is in bits per second (b/s)
124   * @arg complexity is a value from 1 to 10, where 1 is the lowest complexity and 10 is the highest
125   * @arg signal_type is either OPUS_AUTO (default), OPUS_SIGNAL_VOICE, or OPUS_SIGNAL_MUSIC
126   *
127   * See @ref opus_encoderctls and @ref opus_genericctls for a complete list of parameters that can be set or queried. Most parameters can be set or changed at any time during a stream.
128   *
129   * To encode a frame, opus_encode() or opus_encode_float() must be called with exactly one frame (2.5, 5, 10, 20, 40 or 60 ms) of audio data:
130   * @code
131   * len = opus_encode(enc, audio_frame, frame_size, packet, max_packet);
132   * @endcode
133   *
134   * where
135   * <ul>
136   * <li>audio_frame is the audio data in opus_int16 (or float for opus_encode_float())</li>
137   * <li>frame_size is the duration of the frame in samples (per channel)</li>
138   * <li>packet is the byte array to which the compressed data is written</li>
139   * <li>max_packet is the maximum number of bytes that can be written in the packet (4000 bytes is recommended).
140   *     Do not use max_packet to control VBR target bitrate, instead use the #OPUS_SET_BITRATE CTL.</li>
141   * </ul>
142   *
143   * opus_encode() and opus_encode_float() return the number of bytes actually written to the packet.
144   * The return value <b>can be negative</b>, which indicates that an error has occurred. If the return value
145   * is 1 byte, then the packet does not need to be transmitted (DTX).
146   *
147   * Once the encoder state if no longer needed, it can be destroyed with
148   *
149   * @code
150   * opus_encoder_destroy(enc);
151   * @endcode
152   *
153   * If the encoder was created with opus_encoder_init() rather than opus_encoder_create(),
154   * then no action is required aside from potentially freeing the memory that was manually
155   * allocated for it (calling free(enc) for the example above)
156   *
157   */
158
159 /** Opus encoder state.
160   * This contains the complete state of an Opus encoder.
161   * It is position independent and can be freely copied.
162   * @see opus_encoder_create,opus_encoder_init
163   */
164 typedef struct OpusEncoder OpusEncoder;
165
166 /** Gets the size of an <code>OpusEncoder</code> structure.
167   * @param[in] channels <tt>int</tt>: Number of channels.
168   *                                   This must be 1 or 2.
169   * @returns The size in bytes.
170   */
171 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_encoder_get_size(int channels);
172
173 /**
174  */
175
176 /** Allocates and initializes an encoder state.
177  * There are three coding modes:
178  *
179  * @ref OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
180  *    signals. It enhances the  input signal by high-pass filtering and
181  *    emphasizing formants and harmonics. Optionally  it includes in-band
182  *    forward error correction to protect against packet loss. Use this
183  *    mode for typical VoIP applications. Because of the enhancement,
184  *    even at high bitrates the output may sound different from the input.
185  *
186  * @ref OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
187  *    non-voice signals like music. Use this mode for music and mixed
188  *    (music/voice) content, broadcast, and applications requiring less
189  *    than 15 ms of coding delay.
190  *
191  * @ref OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that
192  *    disables the speech-optimized mode in exchange for slightly reduced delay.
193  *    This mode can only be set on an newly initialized or freshly reset encoder
194  *    because it changes the codec delay.
195  *
196  * This is useful when the caller knows that the speech-optimized modes will not be needed (use with caution).
197  * @param [in] Fs <tt>opus_int32</tt>: Sampling rate of input signal (Hz)
198  *                                     This must be one of 8000, 12000, 16000,
199  *                                     24000, or 48000.
200  * @param [in] channels <tt>int</tt>: Number of channels (1 or 2) in input signal
201  * @param [in] application <tt>int</tt>: Coding mode (@ref OPUS_APPLICATION_VOIP/@ref OPUS_APPLICATION_AUDIO/@ref OPUS_APPLICATION_RESTRICTED_LOWDELAY)
202  * @param [out] error <tt>int*</tt>: @ref opus_errorcodes
203  * @note Regardless of the sampling rate and number channels selected, the Opus encoder
204  * can switch to a lower audio bandwidth or number of channels if the bitrate
205  * selected is too low. This also means that it is safe to always use 48 kHz stereo input
206  * and let the encoder optimize the encoding.
207  */
208 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusEncoder *opus_encoder_create(
209     opus_int32 Fs,
210     int channels,
211     int application,
212     int *error
213 );
214
215 /** Initializes a previously allocated encoder state
216   * The memory pointed to by st must be at least the size returned by opus_encoder_get_size().
217   * This is intended for applications which use their own allocator instead of malloc.
218   * @see opus_encoder_create(),opus_encoder_get_size()
219   * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.
220   * @param [in] st <tt>OpusEncoder*</tt>: Encoder state
221   * @param [in] Fs <tt>opus_int32</tt>: Sampling rate of input signal (Hz)
222  *                                      This must be one of 8000, 12000, 16000,
223  *                                      24000, or 48000.
224   * @param [in] channels <tt>int</tt>: Number of channels (1 or 2) in input signal
225   * @param [in] application <tt>int</tt>: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY)
226   * @retval #OPUS_OK Success or @ref opus_errorcodes
227   */
228 OPUS_EXPORT int opus_encoder_init(
229     OpusEncoder *st,
230     opus_int32 Fs,
231     int channels,
232     int application
233 ) OPUS_ARG_NONNULL(1);
234
235 /** Encodes an Opus frame.
236   * @param [in] st <tt>OpusEncoder*</tt>: Encoder state
237   * @param [in] pcm <tt>opus_int16*</tt>: Input signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16)
238   * @param [in] frame_size <tt>int</tt>: Number of samples per channel in the
239   *                                      input signal.
240   *                                      This must be an Opus frame size for
241   *                                      the encoder's sampling rate.
242   *                                      For example, at 48 kHz the permitted
243   *                                      values are 120, 240, 480, 960, 1920,
244   *                                      and 2880.
245   *                                      Passing in a duration of less than
246   *                                      10 ms (480 samples at 48 kHz) will
247   *                                      prevent the encoder from using the LPC
248   *                                      or hybrid modes.
249   * @param [out] data <tt>unsigned char*</tt>: Output payload.
250   *                                            This must contain storage for at
251   *                                            least \a max_data_bytes.
252   * @param [in] max_data_bytes <tt>opus_int32</tt>: Size of the allocated
253   *                                                 memory for the output
254   *                                                 payload. This may be
255   *                                                 used to impose an upper limit on
256   *                                                 the instant bitrate, but should
257   *                                                 not be used as the only bitrate
258   *                                                 control. Use #OPUS_SET_BITRATE to
259   *                                                 control the bitrate.
260   * @returns The length of the encoded packet (in bytes) on success or a
261   *          negative error code (see @ref opus_errorcodes) on failure.
262   */
263 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode(
264     OpusEncoder *st,
265     const opus_int16 *pcm,
266     int frame_size,
267     unsigned char *data,
268     opus_int32 max_data_bytes
269 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
270
271 /** Encodes an Opus frame from floating point input.
272   * @param [in] st <tt>OpusEncoder*</tt>: Encoder state
273   * @param [in] pcm <tt>float*</tt>: Input in float format (interleaved if 2 channels), with a normal range of +/-1.0.
274   *          Samples with a range beyond +/-1.0 are supported but will
275   *          be clipped by decoders using the integer API and should
276   *          only be used if it is known that the far end supports
277   *          extended dynamic range.
278   *          length is frame_size*channels*sizeof(float)
279   * @param [in] frame_size <tt>int</tt>: Number of samples per channel in the
280   *                                      input signal.
281   *                                      This must be an Opus frame size for
282   *                                      the encoder's sampling rate.
283   *                                      For example, at 48 kHz the permitted
284   *                                      values are 120, 240, 480, 960, 1920,
285   *                                      and 2880.
286   *                                      Passing in a duration of less than
287   *                                      10 ms (480 samples at 48 kHz) will
288   *                                      prevent the encoder from using the LPC
289   *                                      or hybrid modes.
290   * @param [out] data <tt>unsigned char*</tt>: Output payload.
291   *                                            This must contain storage for at
292   *                                            least \a max_data_bytes.
293   * @param [in] max_data_bytes <tt>opus_int32</tt>: Size of the allocated
294   *                                                 memory for the output
295   *                                                 payload. This may be
296   *                                                 used to impose an upper limit on
297   *                                                 the instant bitrate, but should
298   *                                                 not be used as the only bitrate
299   *                                                 control. Use #OPUS_SET_BITRATE to
300   *                                                 control the bitrate.
301   * @returns The length of the encoded packet (in bytes) on success or a
302   *          negative error code (see @ref opus_errorcodes) on failure.
303   */
304 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode_float(
305     OpusEncoder *st,
306     const float *pcm,
307     int frame_size,
308     unsigned char *data,
309     opus_int32 max_data_bytes
310 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
311
312 /** Frees an <code>OpusEncoder</code> allocated by opus_encoder_create().
313   * @param[in] st <tt>OpusEncoder*</tt>: State to be freed.
314   */
315 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
316
317 /** Perform a CTL function on an Opus encoder.
318   *
319   * Generally the request and subsequent arguments are generated
320   * by a convenience macro.
321   * @param st <tt>OpusEncoder*</tt>: Encoder state.
322   * @param request This and all remaining parameters should be replaced by one
323   *                of the convenience macros in @ref opus_genericctls or
324   *                @ref opus_encoderctls.
325   * @see opus_genericctls
326   * @see opus_encoderctls
327   */
328 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...) OPUS_ARG_NONNULL(1);
329 /**@}*/
330
331 /** @defgroup opus_decoder Opus Decoder
332   * @{
333   *
334   * @brief This page describes the process and functions used to decode Opus.
335   *
336   * The decoding process also starts with creating a decoder
337   * state. This can be done with:
338   * @code
339   * int          error;
340   * OpusDecoder *dec;
341   * dec = opus_decoder_create(Fs, channels, &error);
342   * @endcode
343   * where
344   * @li Fs is the sampling rate and must be 8000, 12000, 16000, 24000, or 48000
345   * @li channels is the number of channels (1 or 2)
346   * @li error will hold the error code in case of failure (or #OPUS_OK on success)
347   * @li the return value is a newly created decoder state to be used for decoding
348   *
349   * While opus_decoder_create() allocates memory for the state, it's also possible
350   * to initialize pre-allocated memory:
351   * @code
352   * int          size;
353   * int          error;
354   * OpusDecoder *dec;
355   * size = opus_decoder_get_size(channels);
356   * dec = malloc(size);
357   * error = opus_decoder_init(dec, Fs, channels);
358   * @endcode
359   * where opus_decoder_get_size() returns the required size for the decoder state. Note that
360   * future versions of this code may change the size, so no assuptions should be made about it.
361   *
362   * The decoder state is always continuous in memory and only a shallow copy is sufficient
363   * to copy it (e.g. memcpy())
364   *
365   * To decode a frame, opus_decode() or opus_decode_float() must be called with a packet of compressed audio data:
366   * @code
367   * frame_size = opus_decode(dec, packet, len, decoded, max_size, 0);
368   * @endcode
369   * where
370   *
371   * @li packet is the byte array containing the compressed data
372   * @li len is the exact number of bytes contained in the packet
373   * @li decoded is the decoded audio data in opus_int16 (or float for opus_decode_float())
374   * @li max_size is the max duration of the frame in samples (per channel) that can fit into the decoded_frame array
375   *
376   * opus_decode() and opus_decode_float() return the number of samples (per channel) decoded from the packet.
377   * If that value is negative, then an error has occurred. This can occur if the packet is corrupted or if the audio
378   * buffer is too small to hold the decoded audio.
379   *
380   * Opus is a stateful codec with overlapping blocks and as a result Opus
381   * packets are not coded independently of each other. Packets must be
382   * passed into the decoder serially and in the correct order for a correct
383   * decode. Lost packets can be replaced with loss concealment by calling
384   * the decoder with a null pointer and zero length for the missing packet.
385   *
386   * A single codec state may only be accessed from a single thread at
387   * a time and any required locking must be performed by the caller. Separate
388   * streams must be decoded with separate decoder states and can be decoded
389   * in parallel unless the library was compiled with NONTHREADSAFE_PSEUDOSTACK
390   * defined.
391   *
392   */
393
394 /** Opus decoder state.
395   * This contains the complete state of an Opus decoder.
396   * It is position independent and can be freely copied.
397   * @see opus_decoder_create,opus_decoder_init
398   */
399 typedef struct OpusDecoder OpusDecoder;
400
401 /** Gets the size of an <code>OpusDecoder</code> structure.
402   * @param [in] channels <tt>int</tt>: Number of channels.
403   *                                    This must be 1 or 2.
404   * @returns The size in bytes.
405   */
406 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decoder_get_size(int channels);
407
408 /** Allocates and initializes a decoder state.
409   * @param [in] Fs <tt>opus_int32</tt>: Sample rate to decode at (Hz).
410   *                                     This must be one of 8000, 12000, 16000,
411   *                                     24000, or 48000.
412   * @param [in] channels <tt>int</tt>: Number of channels (1 or 2) to decode
413   * @param [out] error <tt>int*</tt>: #OPUS_OK Success or @ref opus_errorcodes
414   *
415   * Internally Opus stores data at 48000 Hz, so that should be the default
416   * value for Fs. However, the decoder can efficiently decode to buffers
417   * at 8, 12, 16, and 24 kHz so if for some reason the caller cannot use
418   * data at the full sample rate, or knows the compressed data doesn't
419   * use the full frequency range, it can request decoding at a reduced
420   * rate. Likewise, the decoder is capable of filling in either mono or
421   * interleaved stereo pcm buffers, at the caller's request.
422   */
423 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusDecoder *opus_decoder_create(
424     opus_int32 Fs,
425     int channels,
426     int *error
427 );
428
429 /** Initializes a previously allocated decoder state.
430   * The state must be at least the size returned by opus_decoder_get_size().
431   * This is intended for applications which use their own allocator instead of malloc. @see opus_decoder_create,opus_decoder_get_size
432   * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL.
433   * @param [in] st <tt>OpusDecoder*</tt>: Decoder state.
434   * @param [in] Fs <tt>opus_int32</tt>: Sampling rate to decode to (Hz).
435   *                                     This must be one of 8000, 12000, 16000,
436   *                                     24000, or 48000.
437   * @param [in] channels <tt>int</tt>: Number of channels (1 or 2) to decode
438   * @retval #OPUS_OK Success or @ref opus_errorcodes
439   */
440 OPUS_EXPORT int opus_decoder_init(
441     OpusDecoder *st,
442     opus_int32 Fs,
443     int channels
444 ) OPUS_ARG_NONNULL(1);
445
446 /** Decode an Opus packet.
447   * @param [in] st <tt>OpusDecoder*</tt>: Decoder state
448   * @param [in] data <tt>char*</tt>: Input payload. Use a NULL pointer to indicate packet loss
449   * @param [in] len <tt>opus_int32</tt>: Number of bytes in payload*
450   * @param [out] pcm <tt>opus_int16*</tt>: Output signal (interleaved if 2 channels). length
451   *  is frame_size*channels*sizeof(opus_int16)
452   * @param [in] frame_size Number of samples per channel of available space in \a pcm.
453   *  If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will
454   *  not be capable of decoding some packets.
455   * @param [in] decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band forward error correction data be
456   *  decoded. If no such data is available, the frame is decoded as if it were lost.
457   * @returns Number of decoded samples or @ref opus_errorcodes
458   */
459 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode(
460     OpusDecoder *st,
461     const unsigned char *data,
462     opus_int32 len,
463     opus_int16 *pcm,
464     int frame_size,
465     int decode_fec
466 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
467
468 /** Decode an Opus packet with floating point output.
469   * @param [in] st <tt>OpusDecoder*</tt>: Decoder state
470   * @param [in] data <tt>char*</tt>: Input payload. Use a NULL pointer to indicate packet loss
471   * @param [in] len <tt>opus_int32</tt>: Number of bytes in payload
472   * @param [out] pcm <tt>float*</tt>: Output signal (interleaved if 2 channels). length
473   *  is frame_size*channels*sizeof(float)
474   * @param [in] frame_size Number of samples per channel of available space in \a pcm.
475   *  If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will
476   *  not be capable of decoding some packets.
477   * @param [in] decode_fec <tt>int</tt>: Flag (0 or 1) to request that any in-band forward error correction data be
478   *  decoded. If no such data is available the frame is decoded as if it were lost.
479   * @returns Number of decoded samples or @ref opus_errorcodes
480   */
481 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode_float(
482     OpusDecoder *st,
483     const unsigned char *data,
484     opus_int32 len,
485     float *pcm,
486     int frame_size,
487     int decode_fec
488 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
489
490 /** Perform a CTL function on an Opus decoder.
491   *
492   * Generally the request and subsequent arguments are generated
493   * by a convenience macro.
494   * @param st <tt>OpusDecoder*</tt>: Decoder state.
495   * @param request This and all remaining parameters should be replaced by one
496   *                of the convenience macros in @ref opus_genericctls or
497   *                @ref opus_decoderctls.
498   * @see opus_genericctls
499   * @see opus_decoderctls
500   */
501 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...) OPUS_ARG_NONNULL(1);
502
503 /** Frees an <code>OpusDecoder</code> allocated by opus_decoder_create().
504   * @param[in] st <tt>OpusDecoder*</tt>: State to be freed.
505   */
506 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
507
508 /** Parse an opus packet into one or more frames.
509   * Opus_decode will perform this operation internally so most applications do
510   * not need to use this function.
511   * This function does not copy the frames, the returned pointers are pointers into
512   * the input packet.
513   * @param [in] data <tt>char*</tt>: Opus packet to be parsed
514   * @param [in] len <tt>opus_int32</tt>: size of data
515   * @param [out] out_toc <tt>char*</tt>: TOC pointer
516   * @param [out] frames <tt>char*[48]</tt> encapsulated frames
517   * @param [out] size <tt>short[48]</tt> sizes of the encapsulated frames
518   * @param [out] payload_offset <tt>int*</tt>: returns the position of the payload within the packet (in bytes)
519   * @returns number of frames
520   */
521 OPUS_EXPORT int opus_packet_parse(
522    const unsigned char *data,
523    opus_int32 len,
524    unsigned char *out_toc,
525    const unsigned char *frames[48],
526    short size[48],
527    int *payload_offset
528 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
529
530 /** Gets the bandwidth of an Opus packet.
531   * @param [in] data <tt>char*</tt>: Opus packet
532   * @retval OPUS_BANDWIDTH_NARROWBAND Narrowband (4kHz bandpass)
533   * @retval OPUS_BANDWIDTH_MEDIUMBAND Mediumband (6kHz bandpass)
534   * @retval OPUS_BANDWIDTH_WIDEBAND Wideband (8kHz bandpass)
535   * @retval OPUS_BANDWIDTH_SUPERWIDEBAND Superwideband (12kHz bandpass)
536   * @retval OPUS_BANDWIDTH_FULLBAND Fullband (20kHz bandpass)
537   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
538   */
539 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_bandwidth(const unsigned char *data) OPUS_ARG_NONNULL(1);
540
541 /** Gets the number of samples per frame from an Opus packet.
542   * @param [in] data <tt>char*</tt>: Opus packet.
543   *                                  This must contain at least one byte of
544   *                                  data.
545   * @param [in] Fs <tt>opus_int32</tt>: Sampling rate in Hz.
546   *                                     This must be a multiple of 400, or
547   *                                     inaccurate results will be returned.
548   * @returns Number of samples per frame.
549   */
550 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_samples_per_frame(const unsigned char *data, opus_int32 Fs) OPUS_ARG_NONNULL(1);
551
552 /** Gets the number of channels from an Opus packet.
553   * @param [in] data <tt>char*</tt>: Opus packet
554   * @returns Number of channels
555   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
556   */
557 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_channels(const unsigned char *data) OPUS_ARG_NONNULL(1);
558
559 /** Gets the number of frames in an Opus packet.
560   * @param [in] packet <tt>char*</tt>: Opus packet
561   * @param [in] len <tt>opus_int32</tt>: Length of packet
562   * @returns Number of frames
563   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
564   */
565 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_frames(const unsigned char packet[], opus_int32 len) OPUS_ARG_NONNULL(1);
566
567 /** Gets the number of samples of an Opus packet.
568   * @param [in] dec <tt>OpusDecoder*</tt>: Decoder state
569   * @param [in] packet <tt>char*</tt>: Opus packet
570   * @param [in] len <tt>opus_int32</tt>: Length of packet
571   * @returns Number of samples
572   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
573   */
574 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], opus_int32 len) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);
575 /**@}*/
576
577 /** @defgroup opus_repacketizer Repacketizer
578   * @{
579   *
580   * The repacketizer can be used to merge multiple Opus packets into a single
581   * packet or alternatively to split Opus packets that have previously been
582   * merged. Splitting valid Opus packets is always guaranteed to succeed,
583   * whereas merging valid packets only succeeds if all frames have the same
584   * mode, bandwidth, and frame size, and when the total duration of the merged
585   * packet is no more than 120 ms.
586   * The repacketizer currently only operates on elementary Opus
587   * streams. It will not manipualte multistream packets successfully, except in
588   * the degenerate case where they consist of data from a single stream.
589   *
590   * The repacketizing process starts with creating a repacketizer state, either
591   * by calling opus_repacketizer_create() or by allocating the memory yourself,
592   * e.g.,
593   * @code
594   * OpusRepacketizer *rp;
595   * rp = (OpusRepacketizer*)malloc(opus_repacketizer_get_size());
596   * if (rp != NULL)
597   *     opus_repacketizer_init(rp);
598   * @endcode
599   *
600   * Then the application should submit packets with opus_repacketizer_cat(),
601   * extract new packets with opus_repacketizer_out() or
602   * opus_repacketizer_out_range(), and then reset the state for the next set of
603   * input packets via opus_repacketizer_init().
604   *
605   * For example, to split a sequence of packets into individual frames:
606   * @code
607   * unsigned char *data;
608   * int len;
609   * while (get_next_packet(&data, &len))
610   * {
611   *   unsigned char out[1276];
612   *   opus_int32 out_len;
613   *   int nb_frames;
614   *   int err;
615   *   int i;
616   *   err = opus_repacketizer_cat(rp, data, len);
617   *   if (err != OPUS_OK)
618   *   {
619   *     release_packet(data);
620   *     return err;
621   *   }
622   *   nb_frames = opus_repacketizer_get_nb_frames(rp);
623   *   for (i = 0; i < nb_frames; i++)
624   *   {
625   *     out_len = opus_repacketizer_out_range(rp, i, i+1, out, sizeof(out));
626   *     if (out_len < 0)
627   *     {
628   *        release_packet(data);
629   *        return (int)out_len;
630   *     }
631   *     output_next_packet(out, out_len);
632   *   }
633   *   opus_repacketizer_init(rp);
634   *   release_packet(data);
635   * }
636   * @endcode
637   *
638   * Alternatively, to combine a sequence of frames into packets that each
639   * contain up to <code>TARGET_DURATION_MS</code> milliseconds of data:
640   * @code
641   * // The maximum number of packets with duration TARGET_DURATION_MS occurs
642   * // when the frame size is 2.5 ms, for a total of (TARGET_DURATION_MS*2/5)
643   * // packets.
644   * unsigned char *data[(TARGET_DURATION_MS*2/5)+1];
645   * opus_int32 len[(TARGET_DURATION_MS*2/5)+1];
646   * int nb_packets;
647   * unsigned char out[1277*(TARGET_DURATION_MS*2/2)];
648   * opus_int32 out_len;
649   * int prev_toc;
650   * nb_packets = 0;
651   * while (get_next_packet(data+nb_packets, len+nb_packets))
652   * {
653   *   int nb_frames;
654   *   int err;
655   *   nb_frames = opus_packet_get_nb_frames(data[nb_packets], len[nb_packets]);
656   *   if (nb_frames < 1)
657   *   {
658   *     release_packets(data, nb_packets+1);
659   *     return nb_frames;
660   *   }
661   *   nb_frames += opus_repacketizer_get_nb_frames(rp);
662   *   // If adding the next packet would exceed our target, or it has an
663   *   // incompatible TOC sequence, output the packets we already have before
664   *   // submitting it.
665   *   // N.B., The nb_packets > 0 check ensures we've submitted at least one
666   *   // packet since the last call to opus_repacketizer_init(). Otherwise a
667   *   // single packet longer than TARGET_DURATION_MS would cause us to try to
668   *   // output an (invalid) empty packet. It also ensures that prev_toc has
669   *   // been set to a valid value. Additionally, len[nb_packets] > 0 is
670   *   // guaranteed by the call to opus_packet_get_nb_frames() above, so the
671   *   // reference to data[nb_packets][0] should be valid.
672   *   if (nb_packets > 0 && (
673   *       ((prev_toc & 0xFC) != (data[nb_packets][0] & 0xFC)) ||
674   *       opus_packet_get_samples_per_frame(data[nb_packets], 48000)*nb_frames >
675   *       TARGET_DURATION_MS*48))
676   *   {
677   *     out_len = opus_repacketizer_out(rp, out, sizeof(out));
678   *     if (out_len < 0)
679   *     {
680   *        release_packets(data, nb_packets+1);
681   *        return (int)out_len;
682   *     }
683   *     output_next_packet(out, out_len);
684   *     opus_repacketizer_init(rp);
685   *     release_packets(data, nb_packets);
686   *     data[0] = data[nb_packets];
687   *     len[0] = len[nb_packets];
688   *     nb_packets = 0;
689   *   }
690   *   err = opus_repacketizer_cat(rp, data[nb_packets], len[nb_packets]);
691   *   if (err != OPUS_OK)
692   *   {
693   *     release_packets(data, nb_packets+1);
694   *     return err;
695   *   }
696   *   prev_toc = data[nb_packets][0];
697   *   nb_packets++;
698   * }
699   * // Output the final, partial packet.
700   * if (nb_packets > 0)
701   * {
702   *   out_len = opus_repacketizer_out(rp, out, sizeof(out));
703   *   release_packets(data, nb_packets);
704   *   if (out_len < 0)
705   *     return (int)out_len;
706   *   output_next_packet(out, out_len);
707   * }
708   * @endcode
709   *
710   * An alternate way of merging packets is to simply call opus_repacketizer_cat()
711   * unconditionally until it fails. At that point, the merged packet can be
712   * obtained with opus_repacketizer_out() and the input packet for which
713   * opus_repacketizer_cat() needs to be re-added to a newly reinitialized
714   * repacketizer state.
715   */
716
717 typedef struct OpusRepacketizer OpusRepacketizer;
718
719 /** Gets the size of an <code>OpusRepacketizer</code> structure.
720   * @returns The size in bytes.
721   */
722 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_size(void);
723
724 /** (Re)initializes a previously allocated repacketizer state.
725   * The state must be at least the size returned by opus_repacketizer_get_size().
726   * This can be used for applications which use their own allocator instead of
727   * malloc().
728   * It must also be called to reset the queue of packets waiting to be
729   * repacketized, which is necessary if the maximum packet duration of 120 ms
730   * is reached or if you wish to submit packets with a different Opus
731   * configuration (coding mode, audio bandwidth, frame size, or channel count).
732   * Failure to do so will prevent a new packet from being added with
733   * opus_repacketizer_cat().
734   * @see opus_repacketizer_create
735   * @see opus_repacketizer_get_size
736   * @see opus_repacketizer_cat
737   * @param rp <tt>OpusRepacketizer*</tt>: The repacketizer state to
738   *                                       (re)initialize.
739   * @returns A pointer to the same repacketizer state that was passed in.
740   */
741 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1);
742
743 /** Allocates memory and initializes the new repacketizer with
744  * opus_repacketizer_init().
745   */
746 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusRepacketizer *opus_repacketizer_create(void);
747
748 /** Frees an <code>OpusRepacketizer</code> allocated by
749   * opus_repacketizer_create().
750   * @param[in] rp <tt>OpusRepacketizer*</tt>: State to be freed.
751   */
752 OPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp);
753
754 /** Add a packet to the current repacketizer state.
755   * This packet must match the configuration of any packets already submitted
756   * for repacketization since the last call to opus_repacketizer_init().
757   * This means that it must have the same coding mode, audio bandwidth, frame
758   * size, and channel count.
759   * This can be checked in advance by examining the top 6 bits of the first
760   * byte of the packet, and ensuring they match the top 6 bits of the first
761   * byte of any previously submitted packet.
762   * The total duration of audio in the repacketizer state also must not exceed
763   * 120 ms, the maximum duration of a single packet, after adding this packet.
764   *
765   * The contents of the current repacketizer state can be extracted into new
766   * packets using opus_repacketizer_out() or opus_repacketizer_out_range().
767   *
768   * In order to add a packet with a different configuration or to add more
769   * audio beyond 120 ms, you must clear the repacketizer state by calling
770   * opus_repacketizer_init().
771   * If a packet is too large to add to the current repacketizer state, no part
772   * of it is added, even if it contains multiple frames, some of which might
773   * fit.
774   * If you wish to be able to add parts of such packets, you should first use
775   * another repacketizer to split the packet into pieces and add them
776   * individually.
777   * @see opus_repacketizer_out_range
778   * @see opus_repacketizer_out
779   * @see opus_repacketizer_init
780   * @param rp <tt>OpusRepacketizer*</tt>: The repacketizer state to which to
781   *                                       add the packet.
782   * @param[in] data <tt>const unsigned char*</tt>: The packet data.
783   *                                                The application must ensure
784   *                                                this pointer remains valid
785   *                                                until the next call to
786   *                                                opus_repacketizer_init() or
787   *                                                opus_repacketizer_destroy().
788   * @param len <tt>opus_int32</tt>: The number of bytes in the packet data.
789   * @returns An error code indicating whether or not the operation succeeded.
790   * @retval #OPUS_OK The packet's contents have been added to the repacketizer
791   *                  state.
792   * @retval #OPUS_INVALID_PACKET The packet did not have a valid TOC sequence,
793   *                              the packet's TOC sequence was not compatible
794   *                              with previously submitted packets (because
795   *                              the coding mode, audio bandwidth, frame size,
796   *                              or channel count did not match), or adding
797   *                              this packet would increase the total amount of
798   *                              audio stored in the repacketizer state to more
799   *                              than 120 ms.
800   */
801 OPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, opus_int32 len) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);
802
803
804 /** Construct a new packet from data previously submitted to the repacketizer
805   * state via opus_repacketizer_cat().
806   * @param rp <tt>OpusRepacketizer*</tt>: The repacketizer state from which to
807   *                                       construct the new packet.
808   * @param begin <tt>int</tt>: The index of the first frame in the current
809   *                            repacketizer state to include in the output.
810   * @param end <tt>int</tt>: One past the index of the last frame in the
811   *                          current repacketizer state to include in the
812   *                          output.
813   * @param[out] data <tt>const unsigned char*</tt>: The buffer in which to
814   *                                                 store the output packet.
815   * @param maxlen <tt>opus_int32</tt>: The maximum number of bytes to store in
816   *                                    the output buffer. In order to guarantee
817   *                                    success, this should be at least
818   *                                    <code>1276</code> for a single frame,
819   *                                    or for multiple frames,
820   *                                    <code>1277*(end-begin)</code>.
821   *                                    However, <code>1*(end-begin)</code> plus
822   *                                    the size of all packet data submitted to
823   *                                    the repacketizer since the last call to
824   *                                    opus_repacketizer_init() or
825   *                                    opus_repacketizer_create() is also
826   *                                    sufficient, and possibly much smaller.
827   * @returns The total size of the output packet on success, or an error code
828   *          on failure.
829   * @retval #OPUS_BAD_ARG <code>[begin,end)</code> was an invalid range of
830   *                       frames (begin < 0, begin >= end, or end >
831   *                       opus_repacketizer_get_nb_frames()).
832   * @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the
833   *                                complete output packet.
834   */
835 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, opus_int32 maxlen) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
836
837 /** Return the total number of frames contained in packet data submitted to
838   * the repacketizer state so far via opus_repacketizer_cat() since the last
839   * call to opus_repacketizer_init() or opus_repacketizer_create().
840   * This defines the valid range of packets that can be extracted with
841   * opus_repacketizer_out_range() or opus_repacketizer_out().
842   * @param rp <tt>OpusRepacketizer*</tt>: The repacketizer state containing the
843   *                                       frames.
844   * @returns The total number of frames contained in the packet data submitted
845   *          to the repacketizer state.
846   */
847 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1);
848
849 /** Construct a new packet from data previously submitted to the repacketizer
850   * state via opus_repacketizer_cat().
851   * This is a convenience routine that returns all the data submitted so far
852   * in a single packet.
853   * It is equivalent to calling
854   * @code
855   * opus_repacketizer_out_range(rp, 0, opus_repacketizer_get_nb_frames(rp),
856   *                             data, maxlen)
857   * @endcode
858   * @param rp <tt>OpusRepacketizer*</tt>: The repacketizer state from which to
859   *                                       construct the new packet.
860   * @param[out] data <tt>const unsigned char*</tt>: The buffer in which to
861   *                                                 store the output packet.
862   * @param maxlen <tt>opus_int32</tt>: The maximum number of bytes to store in
863   *                                    the output buffer. In order to guarantee
864   *                                    success, this should be at least
865   *                                    <code>1277*opus_repacketizer_get_nb_frames(rp)</code>.
866   *                                    However,
867   *                                    <code>1*opus_repacketizer_get_nb_frames(rp)</code>
868   *                                    plus the size of all packet data
869   *                                    submitted to the repacketizer since the
870   *                                    last call to opus_repacketizer_init() or
871   *                                    opus_repacketizer_create() is also
872   *                                    sufficient, and possibly much smaller.
873   * @returns The total size of the output packet on success, or an error code
874   *          on failure.
875   * @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the
876   *                                complete output packet.
877   */
878 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, opus_int32 maxlen) OPUS_ARG_NONNULL(1);
879
880 /**@}*/
881
882 #ifdef __cplusplus
883 }
884 #endif
885
886 #endif /* OPUS_H */