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