Add brief descriptions to the encode/decode groups to avoid weird autobreif strings.
[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 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 Frame sizes from 2.5 ms to 60 ms
62  * @li Good loss robustness and packet loss concealment (PLC)
63  * @li Floating point and fixed-point implementation
64  *
65  * Documentation sections:
66  * @li @ref opus_encoder
67  * @li @ref opus_decoder
68  * @li @ref opus_repacketizer
69  * @li @ref opus_libinfo
70  * @li @ref opus_custom
71  */
72
73 /** @defgroup opus_encoder Opus Encoder
74   * @{
75   *
76   * @brief This page describes the process and functions used to encode Opus.
77   *
78   * Since Opus is a stateful codec, the encoding process starts with creating an encoder
79   * state. This can be done with:
80   *
81   * @code
82   * int          error;
83   * OpusEncoder *enc;
84   * enc = opus_encoder_create(Fs, channels, application, &error);
85   * @endcode
86   *
87   * From this point, @c enc can be used for encoding an audio stream. An encoder state
88   * @b must @b not be used for more than one stream at the same time. Similarly, the encoder
89   * state @b must @b not be re-initialized for each frame.
90   *
91   * While opus_encoder_create() allocates memory for the state, it's also possible
92   * to initialize pre-allocated memory:
93   *
94   * @code
95   * int          size;
96   * int          error;
97   * OpusEncoder *enc;
98   * size = opus_encoder_get_size(channels);
99   * enc = malloc(size);
100   * error = opus_encoder_init(enc, Fs, channels, application);
101   * @endcode
102   *
103   * where opus_encoder_get_size() returns the required size for the encoder state. Note that
104   * future versions of this code may change the size, so no assuptions should be made about it.
105   *
106   * The encoder state is always continuous in memory and only a shallow copy is sufficient
107   * to copy it (e.g. memcpy())
108   *
109   * It is possible to change some of the encoder's settings using the opus_encoder_ctl()
110   * interface. All these settings already default to the recommended value, so they should
111   * only be changed when necessary. The most common settings one may want to change are:
112   *
113   * @code
114   * opus_encoder_ctl(enc, OPUS_SET_BITRATE(bitrate));
115   * opus_encoder_ctl(enc, OPUS_SET_COMPLEXITY(complexity));
116   * opus_encoder_ctl(enc, OPUS_SET_SIGNAL(signal_type));
117   * @endcode
118   *
119   * where
120   *
121   * @arg bitrate is in bits per second (b/s)
122   * @arg complexity is a value from 1 to 10, where 1 is the lowest complexity and 10 is the highest
123   * @arg signal_type is either OPUS_AUTO (default), OPUS_SIGNAL_VOICE, or OPUS_SIGNAL_MUSIC
124   *
125   * 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.
126   *
127   * 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:
128   * @code
129   * len = opus_encode(enc, audio_frame, frame_size, packet, max_packet);
130   * @endcode
131   *
132   * where
133   * <ul>
134   * <li>audio_frame is the audio data in opus_int16 (or float for opus_encode_float())</li>
135   * <li>frame_size is the duration of the frame in samples (per channel)</li>
136   * <li>packet is the byte array to which the compressed data is written</li>
137   * <li>max_packet is the maximum number of bytes that can be written in the packet (4000 bytes is recommended)</li>
138   * </ul>
139   *
140   * opus_encode() and opus_encode_frame() return the number of bytes actually written to the packet.
141   * The return value <b>can be negative</b>, which indicates that an error has occurred. If the return value
142   * is 1 byte, then the packet does not need to be transmitted (DTX).
143   *
144   * Once the encoder state if no longer needed, it can be destroyed with
145   *
146   * @code
147   * opus_encoder_destroy(enc);
148   * @endcode
149   *
150   * If the encoder was created with opus_encoder_init() rather than opus_encoder_create(),
151   * then no action is required aside from potentially freeing the memory that was manually
152   * allocated for it (calling free(enc) for the example above)
153   *
154   */
155
156 /** Opus encoder state.
157   * This contains the complete state of an Opus encoder.
158   * It is position independent and can be freely copied.
159   * @see opus_encoder_create,opus_encoder_init
160   */
161 typedef struct OpusEncoder OpusEncoder;
162
163 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_encoder_get_size(int channels);
164
165 /**
166  */
167
168 /** Allocates and initializes an encoder state.
169  * There are three coding modes:
170  *
171  * @ref OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
172  *    signals. It enhances the  input signal by high-pass filtering and
173  *    emphasizing formants and harmonics. Optionally  it includes in-band
174  *    forward error correction to protect against packet loss. Use this
175  *    mode for typical VoIP applications. Because of the enhancement,
176  *    even at high bitrates the output may sound different from the input.
177  *
178  * @ref OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
179  *    non-voice signals like music. Use this mode for music and mixed
180  *    (music/voice) content, broadcast, and applications requiring less
181  *    than 15 ms of coding delay.
182  *
183  * @ref OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that
184  *    disables the speech-optimized mode in exchange for slightly reduced delay.
185  *    This mode can only be set on an newly initialized or freshly reset encoder
186  *    because it changes the codec delay.
187  *
188  * This is useful when the caller knows that the speech-optimized modes will not be needed (use with caution).
189  * @param [in] Fs <tt>opus_int32</tt>: Sampling rate of input signal (Hz)
190  * @param [in] channels <tt>int</tt>: Number of channels (1/2) in input signal
191  * @param [in] application <tt>int</tt>: Coding mode (@ref OPUS_APPLICATION_VOIP/@ref OPUS_APPLICATION_AUDIO/@ref OPUS_APPLICATION_RESTRICTED_LOWDELAY)
192  * @param [out] error <tt>int*</tt>: @ref opus_errorcodes
193  * @note Regardless of the sampling rate and number channels selected, the Opus encoder
194  * can switch to a lower audio audio bandwidth or number of channels if the bitrate
195  * selected is too low. This also means that it is safe to always use 48 kHz stereo input
196  * and let the encoder optimize the encoding.
197  */
198 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusEncoder *opus_encoder_create(
199     opus_int32 Fs,
200     int channels,
201     int application,
202     int *error
203 );
204
205 /** Initializes a previously allocated encoder state
206   * The memory pointed to by st must be the size returned by opus_encoder_get_size.
207   * This is intended for applications which use their own allocator instead of malloc.
208   * @see opus_encoder_create(),opus_encoder_get_size()
209   * To reset a previously initialized state use the OPUS_RESET_STATE CTL.
210   * @param [in] st <tt>OpusEncoder*</tt>: Encoder state
211   * @param [in] Fs <tt>opus_int32</tt>: Sampling rate of input signal (Hz)
212   * @param [in] channels <tt>int</tt>: Number of channels (1/2) in input signal
213   * @param [in] application <tt>int</tt>: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY)
214   * @retval OPUS_OK Success or @ref opus_errorcodes
215   */
216 OPUS_EXPORT int opus_encoder_init(
217     OpusEncoder *st,
218     opus_int32 Fs,
219     int channels,
220     int application
221 ) OPUS_ARG_NONNULL(1);
222
223 /** Encodes an Opus frame.
224   * The passed frame_size must an opus frame size for the encoder's sampling rate.
225   * For example, at 48kHz the permitted values are 120, 240, 480, or 960.
226   * Passing in a duration of less than 10ms (480 samples at 48kHz) will
227   * prevent the encoder from using the LPC or hybrid modes.
228   * @param [in] st <tt>OpusEncoder*</tt>: Encoder state
229   * @param [in] pcm <tt>opus_int16*</tt>: Input signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16)
230   * @param [in] frame_size <tt>int</tt>: Number of samples per frame of input signal
231   * @param [out] data <tt>char*</tt>: Output payload (at least max_data_bytes long)
232   * @param [in] max_data_bytes <tt>opus_int32</tt>: Allocated memory for payload; don't use for controlling bitrate
233   * @returns length of the data payload (in bytes) or @ref opus_errorcodes
234   */
235 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode(
236     OpusEncoder *st,
237     const opus_int16 *pcm,
238     int frame_size,
239     unsigned char *data,
240     opus_int32 max_data_bytes
241 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
242
243 /** Encodes an Opus frame from floating point input.
244   * The passed frame_size must an opus frame size for the encoder's sampling rate.
245   * For example, at 48kHz the permitted values are 120, 240, 480, or 960.
246   * Passing in a duration of less than 10ms (480 samples at 48kHz) will
247   * prevent the encoder from using the LPC or hybrid modes.
248   * @param [in] st <tt>OpusEncoder*</tt>: Encoder state
249   * @param [in] pcm <tt>float*</tt>: Input in float format (interleaved if 2 channels), with a normal range of +/-1.0.
250   *          Samples with a range beyond +/-1.0 are supported but will
251   *          be clipped by decoders using the integer API and should
252   *          only be used if it is known that the far end supports
253   *          extended dynamic range.
254   *          length is frame_size*channels*sizeof(float)
255   * @param [in] frame_size <tt>int</tt>: Number of samples per frame of input signal
256   * @param [out] data <tt>char*</tt>: Output payload (at least max_data_bytes long)
257   * @param [in] max_data_bytes <tt>opus_int32</tt>: Allocated memory for payload; don't use for controlling bitrate
258   * @returns length of the data payload (in bytes) or @ref opus_errorcodes
259   */
260 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode_float(
261     OpusEncoder *st,
262     const float *pcm,
263     int frame_size,
264     unsigned char *data,
265     opus_int32 max_data_bytes
266 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
267
268 /** Frees an OpusEncoder allocated by opus_encoder_create.
269   * @param[in] st <tt>OpusEncoder*</tt>: State to be freed.
270   */
271 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
272
273 /** Perform a CTL function on an Opus encoder.
274   *
275   * Generally the request and subsequent arguments are generated
276   * by a convenience macro.
277   * @see opus_encoderctls
278   */
279 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...) OPUS_ARG_NONNULL(1);
280 /**@}*/
281
282 /** @defgroup opus_decoder Opus Decoder
283   * @{
284   *
285   * @brief This page describes the process and functions used to decode Opus.
286   *
287   * The decoding process also starts with creating a decoder
288   * state. This can be done with:
289   * @code
290   * int          error;
291   * OpusDecoder *dec;
292   * dec = opus_decoder_create(Fs, channels, &error);
293   * @endcode
294   * where
295   * @li Fs is the sampling rate and must be 8000, 12000, 16000, 24000, or 48000
296   * @li channels is the number of channels (1 or 2)
297   * @li error will hold the error code in case or failure (or OPUS_OK on success)
298   * @li the return value is a newly created decoder state to be used for decoding
299   *
300   * While opus_decoder_create() allocates memory for the state, it's also possible
301   * to initialize pre-allocated memory:
302   * @code
303   * int          size;
304   * int          error;
305   * OpusDecoder *dec;
306   * size = opus_decoder_get_size(channels);
307   * dec = malloc(size);
308   * error = opus_decoder_init(dec, Fs, channels);
309   * @endcode
310   * where opus_decoder_get_size() returns the required size for the decoder state. Note that
311   * future versions of this code may change the size, so no assuptions should be made about it.
312   *
313   * The decoder state is always continuous in memory and only a shallow copy is sufficient
314   * to copy it (e.g. memcpy())
315   *
316   * To decode a frame, opus_decode() or opus_decode_float() must be called with a packet of compressed audio data:
317   * @code
318   * frame_size = opus_decode(dec, packet, len, decoded, max_size, 0);
319   * @endcode
320   * where
321   *
322   * @li packet is the byte array containing the compressed data
323   * @li len is the exact number of bytes contained in the packet
324   * @li decoded is the decoded audio data in opus_int16 (or float for opus_decode_float())
325   * @li max_size is the max duration of the frame in samples (per channel) that can fit into the decoded_frame array
326   *
327   * opus_decode() and opus_decode_float() return the number of samples (per channel) decoded from the packet.
328   * If that value is negative, then an error has occured. This can occur if the packet is corrupted or if the audio
329   * buffer is too small to hold the decoded audio.
330
331 */
332
333 /** Opus decoder state.
334   * This contains the complete state of an Opus decoder.
335   * It is position independent and can be freely copied.
336   * @see opus_decoder_create,opus_decoder_init
337   */
338 typedef struct OpusDecoder OpusDecoder;
339
340 /** Gets the size of an OpusDecoder structure.
341   * @param [in] channels <tt>int</tt>: Number of channels
342   * @returns size
343   */
344 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decoder_get_size(int channels);
345
346 /** Allocates and initializes a decoder state.
347   * @param [in] Fs <tt>opus_int32</tt>: Sample rate to decode at (Hz)
348   * @param [in] channels <tt>int</tt>: Number of channels (1/2) to decode
349   * @param [out] error <tt>int*</tt>: OPUS_OK Success or @ref opus_errorcodes
350   *
351   * Internally Opus stores data at 48000 Hz, so that should be the default
352   * value for Fs. However, the decoder can efficiently decode to buffers
353   * at 8, 12, 16, and 24 kHz so if for some reason the caller cannot use
354   * data at the full sample rate, or knows the compressed data doesn't
355   * use the full frequency range, it can request decoding at a reduced
356   * rate. Likewise, the decoder is capable of filling in either mono or
357   * interleaved stereo pcm buffers, at the caller's request.
358   */
359 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusDecoder *opus_decoder_create(
360     opus_int32 Fs,
361     int channels,
362     int *error
363 );
364
365 /** Initializes a previously allocated decoder state.
366   * The state must be the size returned by opus_decoder_get_size.
367   * This is intended for applications which use their own allocator instead of malloc. @see opus_decoder_create,opus_decoder_get_size
368   * To reset a previously initialized state use the OPUS_RESET_STATE CTL.
369   * @param [in] st <tt>OpusDecoder*</tt>: Decoder state.
370   * @param [in] Fs <tt>opus_int32</tt>: Sampling rate to decode to (Hz)
371   * @param [in] channels <tt>int</tt>: Number of channels (1/2) to decode
372   * @retval OPUS_OK Success or @ref opus_errorcodes
373   */
374 OPUS_EXPORT int opus_decoder_init(
375     OpusDecoder *st,
376     opus_int32 Fs,
377     int channels
378 ) OPUS_ARG_NONNULL(1);
379
380 /** Decode an Opus frame
381   * @param [in] st <tt>OpusDecoder*</tt>: Decoder state
382   * @param [in] data <tt>char*</tt>: Input payload. Use a NULL pointer to indicate packet loss
383   * @param [in] len <tt>opus_int32</tt>: Number of bytes in payload*
384   * @param [out] pcm <tt>opus_int16*</tt>: Output signal (interleaved if 2 channels). length
385   *  is frame_size*channels*sizeof(opus_int16)
386   * @param [in] frame_size Number of samples per channel of available space in *pcm,
387   *  if less than the maximum frame size (120ms) some frames can not be decoded
388   * @param [in] decode_fec <tt>int</tt>: Flag (0/1) to request that any in-band forward error correction data be
389   *  decoded. If no such data is available the frame is decoded as if it were lost.
390   * @returns Number of decoded samples or @ref opus_errorcodes
391   */
392 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode(
393     OpusDecoder *st,
394     const unsigned char *data,
395     opus_int32 len,
396     opus_int16 *pcm,
397     int frame_size,
398     int decode_fec
399 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
400
401 /** Decode an opus frame with floating point output
402   * @param [in] st <tt>OpusDecoder*</tt>: Decoder state
403   * @param [in] data <tt>char*</tt>: Input payload. Use a NULL pointer to indicate packet loss
404   * @param [in] len <tt>opus_int32</tt>: Number of bytes in payload
405   * @param [out] pcm <tt>float*</tt>: Output signal (interleaved if 2 channels). length
406   *  is frame_size*channels*sizeof(float)
407   * @param [in] frame_size Number of samples per channel of available space in *pcm,
408   *  if less than the maximum frame size (120ms) some frames can not be decoded
409   * @param [in] decode_fec <tt>int</tt>: Flag (0/1) to request that any in-band forward error correction data be
410   *  decoded. If no such data is available the frame is decoded as if it were lost.
411   * @returns Number of decoded samples or @ref opus_errorcodes
412   */
413 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode_float(
414     OpusDecoder *st,
415     const unsigned char *data,
416     opus_int32 len,
417     float *pcm,
418     int frame_size,
419     int decode_fec
420 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
421
422 /** Perform a CTL function on an Opus decoder.
423   *
424   * Generally the request and subsequent arguments are generated
425   * by a convenience macro.
426   * @see opus_genericctls
427   */
428 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...) OPUS_ARG_NONNULL(1);
429
430 /** Frees an OpusDecoder allocated by opus_decoder_create.
431   * @param[in] st <tt>OpusDecoder*</tt>: State to be freed.
432   */
433 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
434
435 /** Parse an opus packet into one or more frames.
436   * Opus_decode will perform this operation internally so most applications do
437   * not need to use this function.
438   * This function does not copy the frames, the returned pointers are pointers into
439   * the input packet.
440   * @param [in] data <tt>char*</tt>: Opus packet to be parsed
441   * @param [in] len <tt>opus_int32</tt>: size of data
442   * @param [out] out_toc <tt>char*</tt>: TOC pointer
443   * @param [out] frames <tt>char*[48]</tt> encapsulated frames
444   * @param [out] size <tt>short[48]</tt> sizes of the encapsulated frames
445   * @param [out] payload_offset <tt>int*</tt>: returns the position of the payload within the packet (in bytes)
446   * @returns number of frames
447   */
448 OPUS_EXPORT int opus_packet_parse(
449    const unsigned char *data,
450    opus_int32 len,
451    unsigned char *out_toc,
452    const unsigned char *frames[48],
453    short size[48],
454    int *payload_offset
455 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
456
457 /** Gets the bandwidth of an Opus packet.
458   * @param [in] data <tt>char*</tt>: Opus packet
459   * @retval OPUS_BANDWIDTH_NARROWBAND Narrowband (4kHz bandpass)
460   * @retval OPUS_BANDWIDTH_MEDIUMBAND Mediumband (6kHz bandpass)
461   * @retval OPUS_BANDWIDTH_WIDEBAND Wideband (8kHz bandpass)
462   * @retval OPUS_BANDWIDTH_SUPERWIDEBAND Superwideband (12kHz bandpass)
463   * @retval OPUS_BANDWIDTH_FULLBAND Fullband (20kHz bandpass)
464   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
465   */
466 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_bandwidth(const unsigned char *data) OPUS_ARG_NONNULL(1);
467
468 /** Gets the number of samples per frame from an Opus packet.
469   * @param [in] data <tt>char*</tt>: Opus packet
470   * @param [in] Fs <tt>opus_int32</tt>: Sampling rate in Hz
471   * @returns Number of samples per frame
472   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
473   */
474 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_samples_per_frame(const unsigned char *data, opus_int32 Fs) OPUS_ARG_NONNULL(1);
475
476 /** Gets the number of channels from an Opus packet.
477   * @param [in] data <tt>char*</tt>: Opus packet
478   * @returns Number of channels
479   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
480   */
481 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_channels(const unsigned char *data) OPUS_ARG_NONNULL(1);
482
483 /** Gets the number of frames in an Opus packet.
484   * @param [in] packet <tt>char*</tt>: Opus packet
485   * @param [in] len <tt>opus_int32</tt>: Length of packet
486   * @returns Number of frames
487   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
488   */
489 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_frames(const unsigned char packet[], opus_int32 len) OPUS_ARG_NONNULL(1);
490
491 /** Gets the number of samples of an Opus packet.
492   * @param [in] dec <tt>OpusDecoder*</tt>: Decoder state
493   * @param [in] packet <tt>char*</tt>: Opus packet
494   * @param [in] len <tt>opus_int32</tt>: Length of packet
495   * @returns Number of samples
496   * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
497   */
498 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);
499 /**@}*/
500
501 /** @defgroup opus_repacketizer Repacketizer
502   * @{
503   *
504   * The repacketizer can be used to merge multiple Opus packets into a single packet
505   * or alternatively to split Opus packets that have previously been merged.
506   *
507   */
508
509 typedef struct OpusRepacketizer OpusRepacketizer;
510
511 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_size(void);
512
513 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1);
514
515 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusRepacketizer *opus_repacketizer_create(void);
516
517 OPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp);
518
519 OPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, opus_int32 len) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);
520
521 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);
522
523 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1);
524
525 OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, opus_int32 maxlen) OPUS_ARG_NONNULL(1);
526
527 /**@}*/
528
529 #ifdef __cplusplus
530 }
531 #endif
532
533 #endif /* OPUS_H */