Chris@70: /* Copyright (c) 2010-2011 Xiph.Org Foundation, Skype Limited Chris@70: Written by Jean-Marc Valin and Koen Vos */ Chris@70: /* Chris@70: Redistribution and use in source and binary forms, with or without Chris@70: modification, are permitted provided that the following conditions Chris@70: are met: Chris@70: Chris@70: - Redistributions of source code must retain the above copyright Chris@70: notice, this list of conditions and the following disclaimer. Chris@70: Chris@70: - Redistributions in binary form must reproduce the above copyright Chris@70: notice, this list of conditions and the following disclaimer in the Chris@70: documentation and/or other materials provided with the distribution. Chris@70: Chris@70: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS Chris@70: ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT Chris@70: LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR Chris@70: A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER Chris@70: OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, Chris@70: EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, Chris@70: PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR Chris@70: PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF Chris@70: LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING Chris@70: NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS Chris@70: SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Chris@70: */ Chris@70: Chris@70: /** Chris@70: * @file opus.h Chris@70: * @brief Opus reference implementation API Chris@70: */ Chris@70: Chris@70: #ifndef OPUS_H Chris@70: #define OPUS_H Chris@70: Chris@70: #include "opus_types.h" Chris@70: #include "opus_defines.h" Chris@70: Chris@70: #ifdef __cplusplus Chris@70: extern "C" { Chris@70: #endif Chris@70: Chris@70: /** Chris@70: * @mainpage Opus Chris@70: * Chris@70: * The Opus codec is designed for interactive speech and audio transmission over the Internet. Chris@70: * It is designed by the IETF Codec Working Group and incorporates technology from Chris@70: * Skype's SILK codec and Xiph.Org's CELT codec. Chris@70: * Chris@70: * The Opus codec is designed to handle a wide range of interactive audio applications, Chris@70: * including Voice over IP, videoconferencing, in-game chat, and even remote live music Chris@70: * performances. It can scale from low bit-rate narrowband speech to very high quality Chris@70: * stereo music. Its main features are: Chris@70: Chris@70: * @li Sampling rates from 8 to 48 kHz Chris@70: * @li Bit-rates from 6 kb/s to 510 kb/s Chris@70: * @li Support for both constant bit-rate (CBR) and variable bit-rate (VBR) Chris@70: * @li Audio bandwidth from narrowband to full-band Chris@70: * @li Support for speech and music Chris@70: * @li Support for mono and stereo Chris@70: * @li Support for multichannel (up to 255 channels) Chris@70: * @li Frame sizes from 2.5 ms to 60 ms Chris@70: * @li Good loss robustness and packet loss concealment (PLC) Chris@70: * @li Floating point and fixed-point implementation Chris@70: * Chris@70: * Documentation sections: Chris@70: * @li @ref opus_encoder Chris@70: * @li @ref opus_decoder Chris@70: * @li @ref opus_repacketizer Chris@70: * @li @ref opus_multistream Chris@70: * @li @ref opus_libinfo Chris@70: * @li @ref opus_custom Chris@70: */ Chris@70: Chris@70: /** @defgroup opus_encoder Opus Encoder Chris@70: * @{ Chris@70: * Chris@70: * @brief This page describes the process and functions used to encode Opus. Chris@70: * Chris@70: * Since Opus is a stateful codec, the encoding process starts with creating an encoder Chris@70: * state. This can be done with: Chris@70: * Chris@70: * @code Chris@70: * int error; Chris@70: * OpusEncoder *enc; Chris@70: * enc = opus_encoder_create(Fs, channels, application, &error); Chris@70: * @endcode Chris@70: * Chris@70: * From this point, @c enc can be used for encoding an audio stream. An encoder state Chris@70: * @b must @b not be used for more than one stream at the same time. Similarly, the encoder Chris@70: * state @b must @b not be re-initialized for each frame. Chris@70: * Chris@70: * While opus_encoder_create() allocates memory for the state, it's also possible Chris@70: * to initialize pre-allocated memory: Chris@70: * Chris@70: * @code Chris@70: * int size; Chris@70: * int error; Chris@70: * OpusEncoder *enc; Chris@70: * size = opus_encoder_get_size(channels); Chris@70: * enc = malloc(size); Chris@70: * error = opus_encoder_init(enc, Fs, channels, application); Chris@70: * @endcode Chris@70: * Chris@70: * where opus_encoder_get_size() returns the required size for the encoder state. Note that Chris@70: * future versions of this code may change the size, so no assuptions should be made about it. Chris@70: * Chris@70: * The encoder state is always continuous in memory and only a shallow copy is sufficient Chris@70: * to copy it (e.g. memcpy()) Chris@70: * Chris@70: * It is possible to change some of the encoder's settings using the opus_encoder_ctl() Chris@70: * interface. All these settings already default to the recommended value, so they should Chris@70: * only be changed when necessary. The most common settings one may want to change are: Chris@70: * Chris@70: * @code Chris@70: * opus_encoder_ctl(enc, OPUS_SET_BITRATE(bitrate)); Chris@70: * opus_encoder_ctl(enc, OPUS_SET_COMPLEXITY(complexity)); Chris@70: * opus_encoder_ctl(enc, OPUS_SET_SIGNAL(signal_type)); Chris@70: * @endcode Chris@70: * Chris@70: * where Chris@70: * Chris@70: * @arg bitrate is in bits per second (b/s) Chris@70: * @arg complexity is a value from 1 to 10, where 1 is the lowest complexity and 10 is the highest Chris@70: * @arg signal_type is either OPUS_AUTO (default), OPUS_SIGNAL_VOICE, or OPUS_SIGNAL_MUSIC Chris@70: * Chris@70: * 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. Chris@70: * Chris@70: * 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: Chris@70: * @code Chris@70: * len = opus_encode(enc, audio_frame, frame_size, packet, max_packet); Chris@70: * @endcode Chris@70: * Chris@70: * where Chris@70: * Chris@70: * Chris@70: * opus_encode() and opus_encode_float() return the number of bytes actually written to the packet. Chris@70: * The return value can be negative, which indicates that an error has occurred. If the return value Chris@70: * is 2 bytes or less, then the packet does not need to be transmitted (DTX). Chris@70: * Chris@70: * Once the encoder state if no longer needed, it can be destroyed with Chris@70: * Chris@70: * @code Chris@70: * opus_encoder_destroy(enc); Chris@70: * @endcode Chris@70: * Chris@70: * If the encoder was created with opus_encoder_init() rather than opus_encoder_create(), Chris@70: * then no action is required aside from potentially freeing the memory that was manually Chris@70: * allocated for it (calling free(enc) for the example above) Chris@70: * Chris@70: */ Chris@70: Chris@70: /** Opus encoder state. Chris@70: * This contains the complete state of an Opus encoder. Chris@70: * It is position independent and can be freely copied. Chris@70: * @see opus_encoder_create,opus_encoder_init Chris@70: */ Chris@70: typedef struct OpusEncoder OpusEncoder; Chris@70: Chris@70: /** Gets the size of an OpusEncoder structure. Chris@70: * @param[in] channels int: Number of channels. Chris@70: * This must be 1 or 2. Chris@70: * @returns The size in bytes. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_encoder_get_size(int channels); Chris@70: Chris@70: /** Chris@70: */ Chris@70: Chris@70: /** Allocates and initializes an encoder state. Chris@70: * There are three coding modes: Chris@70: * Chris@70: * @ref OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice Chris@70: * signals. It enhances the input signal by high-pass filtering and Chris@70: * emphasizing formants and harmonics. Optionally it includes in-band Chris@70: * forward error correction to protect against packet loss. Use this Chris@70: * mode for typical VoIP applications. Because of the enhancement, Chris@70: * even at high bitrates the output may sound different from the input. Chris@70: * Chris@70: * @ref OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most Chris@70: * non-voice signals like music. Use this mode for music and mixed Chris@70: * (music/voice) content, broadcast, and applications requiring less Chris@70: * than 15 ms of coding delay. Chris@70: * Chris@70: * @ref OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that Chris@70: * disables the speech-optimized mode in exchange for slightly reduced delay. Chris@70: * This mode can only be set on an newly initialized or freshly reset encoder Chris@70: * because it changes the codec delay. Chris@70: * Chris@70: * This is useful when the caller knows that the speech-optimized modes will not be needed (use with caution). Chris@70: * @param [in] Fs opus_int32: Sampling rate of input signal (Hz) Chris@70: * This must be one of 8000, 12000, 16000, Chris@70: * 24000, or 48000. Chris@70: * @param [in] channels int: Number of channels (1 or 2) in input signal Chris@70: * @param [in] application int: Coding mode (@ref OPUS_APPLICATION_VOIP/@ref OPUS_APPLICATION_AUDIO/@ref OPUS_APPLICATION_RESTRICTED_LOWDELAY) Chris@70: * @param [out] error int*: @ref opus_errorcodes Chris@70: * @note Regardless of the sampling rate and number channels selected, the Opus encoder Chris@70: * can switch to a lower audio bandwidth or number of channels if the bitrate Chris@70: * selected is too low. This also means that it is safe to always use 48 kHz stereo input Chris@70: * and let the encoder optimize the encoding. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusEncoder *opus_encoder_create( Chris@70: opus_int32 Fs, Chris@70: int channels, Chris@70: int application, Chris@70: int *error Chris@70: ); Chris@70: Chris@70: /** Initializes a previously allocated encoder state Chris@70: * The memory pointed to by st must be at least the size returned by opus_encoder_get_size(). Chris@70: * This is intended for applications which use their own allocator instead of malloc. Chris@70: * @see opus_encoder_create(),opus_encoder_get_size() Chris@70: * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL. Chris@70: * @param [in] st OpusEncoder*: Encoder state Chris@70: * @param [in] Fs opus_int32: Sampling rate of input signal (Hz) Chris@70: * This must be one of 8000, 12000, 16000, Chris@70: * 24000, or 48000. Chris@70: * @param [in] channels int: Number of channels (1 or 2) in input signal Chris@70: * @param [in] application int: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY) Chris@70: * @retval #OPUS_OK Success or @ref opus_errorcodes Chris@70: */ Chris@70: OPUS_EXPORT int opus_encoder_init( Chris@70: OpusEncoder *st, Chris@70: opus_int32 Fs, Chris@70: int channels, Chris@70: int application Chris@70: ) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Encodes an Opus frame. Chris@70: * @param [in] st OpusEncoder*: Encoder state Chris@70: * @param [in] pcm opus_int16*: Input signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16) Chris@70: * @param [in] frame_size int: Number of samples per channel in the Chris@70: * input signal. Chris@70: * This must be an Opus frame size for Chris@70: * the encoder's sampling rate. Chris@70: * For example, at 48 kHz the permitted Chris@70: * values are 120, 240, 480, 960, 1920, Chris@70: * and 2880. Chris@70: * Passing in a duration of less than Chris@70: * 10 ms (480 samples at 48 kHz) will Chris@70: * prevent the encoder from using the LPC Chris@70: * or hybrid modes. Chris@70: * @param [out] data unsigned char*: Output payload. Chris@70: * This must contain storage for at Chris@70: * least \a max_data_bytes. Chris@70: * @param [in] max_data_bytes opus_int32: Size of the allocated Chris@70: * memory for the output Chris@70: * payload. This may be Chris@70: * used to impose an upper limit on Chris@70: * the instant bitrate, but should Chris@70: * not be used as the only bitrate Chris@70: * control. Use #OPUS_SET_BITRATE to Chris@70: * control the bitrate. Chris@70: * @returns The length of the encoded packet (in bytes) on success or a Chris@70: * negative error code (see @ref opus_errorcodes) on failure. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode( Chris@70: OpusEncoder *st, Chris@70: const opus_int16 *pcm, Chris@70: int frame_size, Chris@70: unsigned char *data, Chris@70: opus_int32 max_data_bytes Chris@70: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4); Chris@70: Chris@70: /** Encodes an Opus frame from floating point input. Chris@70: * @param [in] st OpusEncoder*: Encoder state Chris@70: * @param [in] pcm float*: Input in float format (interleaved if 2 channels), with a normal range of +/-1.0. Chris@70: * Samples with a range beyond +/-1.0 are supported but will Chris@70: * be clipped by decoders using the integer API and should Chris@70: * only be used if it is known that the far end supports Chris@70: * extended dynamic range. Chris@70: * length is frame_size*channels*sizeof(float) Chris@70: * @param [in] frame_size int: Number of samples per channel in the Chris@70: * input signal. Chris@70: * This must be an Opus frame size for Chris@70: * the encoder's sampling rate. Chris@70: * For example, at 48 kHz the permitted Chris@70: * values are 120, 240, 480, 960, 1920, Chris@70: * and 2880. Chris@70: * Passing in a duration of less than Chris@70: * 10 ms (480 samples at 48 kHz) will Chris@70: * prevent the encoder from using the LPC Chris@70: * or hybrid modes. Chris@70: * @param [out] data unsigned char*: Output payload. Chris@70: * This must contain storage for at Chris@70: * least \a max_data_bytes. Chris@70: * @param [in] max_data_bytes opus_int32: Size of the allocated Chris@70: * memory for the output Chris@70: * payload. This may be Chris@70: * used to impose an upper limit on Chris@70: * the instant bitrate, but should Chris@70: * not be used as the only bitrate Chris@70: * control. Use #OPUS_SET_BITRATE to Chris@70: * control the bitrate. Chris@70: * @returns The length of the encoded packet (in bytes) on success or a Chris@70: * negative error code (see @ref opus_errorcodes) on failure. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_encode_float( Chris@70: OpusEncoder *st, Chris@70: const float *pcm, Chris@70: int frame_size, Chris@70: unsigned char *data, Chris@70: opus_int32 max_data_bytes Chris@70: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4); Chris@70: Chris@70: /** Frees an OpusEncoder allocated by opus_encoder_create(). Chris@70: * @param[in] st OpusEncoder*: State to be freed. Chris@70: */ Chris@70: OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st); Chris@70: Chris@70: /** Perform a CTL function on an Opus encoder. Chris@70: * Chris@70: * Generally the request and subsequent arguments are generated Chris@70: * by a convenience macro. Chris@70: * @param st OpusEncoder*: Encoder state. Chris@70: * @param request This and all remaining parameters should be replaced by one Chris@70: * of the convenience macros in @ref opus_genericctls or Chris@70: * @ref opus_encoderctls. Chris@70: * @see opus_genericctls Chris@70: * @see opus_encoderctls Chris@70: */ Chris@70: OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...) OPUS_ARG_NONNULL(1); Chris@70: /**@}*/ Chris@70: Chris@70: /** @defgroup opus_decoder Opus Decoder Chris@70: * @{ Chris@70: * Chris@70: * @brief This page describes the process and functions used to decode Opus. Chris@70: * Chris@70: * The decoding process also starts with creating a decoder Chris@70: * state. This can be done with: Chris@70: * @code Chris@70: * int error; Chris@70: * OpusDecoder *dec; Chris@70: * dec = opus_decoder_create(Fs, channels, &error); Chris@70: * @endcode Chris@70: * where Chris@70: * @li Fs is the sampling rate and must be 8000, 12000, 16000, 24000, or 48000 Chris@70: * @li channels is the number of channels (1 or 2) Chris@70: * @li error will hold the error code in case of failure (or #OPUS_OK on success) Chris@70: * @li the return value is a newly created decoder state to be used for decoding Chris@70: * Chris@70: * While opus_decoder_create() allocates memory for the state, it's also possible Chris@70: * to initialize pre-allocated memory: Chris@70: * @code Chris@70: * int size; Chris@70: * int error; Chris@70: * OpusDecoder *dec; Chris@70: * size = opus_decoder_get_size(channels); Chris@70: * dec = malloc(size); Chris@70: * error = opus_decoder_init(dec, Fs, channels); Chris@70: * @endcode Chris@70: * where opus_decoder_get_size() returns the required size for the decoder state. Note that Chris@70: * future versions of this code may change the size, so no assuptions should be made about it. Chris@70: * Chris@70: * The decoder state is always continuous in memory and only a shallow copy is sufficient Chris@70: * to copy it (e.g. memcpy()) Chris@70: * Chris@70: * To decode a frame, opus_decode() or opus_decode_float() must be called with a packet of compressed audio data: Chris@70: * @code Chris@70: * frame_size = opus_decode(dec, packet, len, decoded, max_size, 0); Chris@70: * @endcode Chris@70: * where Chris@70: * Chris@70: * @li packet is the byte array containing the compressed data Chris@70: * @li len is the exact number of bytes contained in the packet Chris@70: * @li decoded is the decoded audio data in opus_int16 (or float for opus_decode_float()) Chris@70: * @li max_size is the max duration of the frame in samples (per channel) that can fit into the decoded_frame array Chris@70: * Chris@70: * opus_decode() and opus_decode_float() return the number of samples (per channel) decoded from the packet. Chris@70: * If that value is negative, then an error has occurred. This can occur if the packet is corrupted or if the audio Chris@70: * buffer is too small to hold the decoded audio. Chris@70: * Chris@70: * Opus is a stateful codec with overlapping blocks and as a result Opus Chris@70: * packets are not coded independently of each other. Packets must be Chris@70: * passed into the decoder serially and in the correct order for a correct Chris@70: * decode. Lost packets can be replaced with loss concealment by calling Chris@70: * the decoder with a null pointer and zero length for the missing packet. Chris@70: * Chris@70: * A single codec state may only be accessed from a single thread at Chris@70: * a time and any required locking must be performed by the caller. Separate Chris@70: * streams must be decoded with separate decoder states and can be decoded Chris@70: * in parallel unless the library was compiled with NONTHREADSAFE_PSEUDOSTACK Chris@70: * defined. Chris@70: * Chris@70: */ Chris@70: Chris@70: /** Opus decoder state. Chris@70: * This contains the complete state of an Opus decoder. Chris@70: * It is position independent and can be freely copied. Chris@70: * @see opus_decoder_create,opus_decoder_init Chris@70: */ Chris@70: typedef struct OpusDecoder OpusDecoder; Chris@70: Chris@70: /** Gets the size of an OpusDecoder structure. Chris@70: * @param [in] channels int: Number of channels. Chris@70: * This must be 1 or 2. Chris@70: * @returns The size in bytes. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decoder_get_size(int channels); Chris@70: Chris@70: /** Allocates and initializes a decoder state. Chris@70: * @param [in] Fs opus_int32: Sample rate to decode at (Hz). Chris@70: * This must be one of 8000, 12000, 16000, Chris@70: * 24000, or 48000. Chris@70: * @param [in] channels int: Number of channels (1 or 2) to decode Chris@70: * @param [out] error int*: #OPUS_OK Success or @ref opus_errorcodes Chris@70: * Chris@70: * Internally Opus stores data at 48000 Hz, so that should be the default Chris@70: * value for Fs. However, the decoder can efficiently decode to buffers Chris@70: * at 8, 12, 16, and 24 kHz so if for some reason the caller cannot use Chris@70: * data at the full sample rate, or knows the compressed data doesn't Chris@70: * use the full frequency range, it can request decoding at a reduced Chris@70: * rate. Likewise, the decoder is capable of filling in either mono or Chris@70: * interleaved stereo pcm buffers, at the caller's request. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusDecoder *opus_decoder_create( Chris@70: opus_int32 Fs, Chris@70: int channels, Chris@70: int *error Chris@70: ); Chris@70: Chris@70: /** Initializes a previously allocated decoder state. Chris@70: * The state must be at least the size returned by opus_decoder_get_size(). Chris@70: * This is intended for applications which use their own allocator instead of malloc. @see opus_decoder_create,opus_decoder_get_size Chris@70: * To reset a previously initialized state, use the #OPUS_RESET_STATE CTL. Chris@70: * @param [in] st OpusDecoder*: Decoder state. Chris@70: * @param [in] Fs opus_int32: Sampling rate to decode to (Hz). Chris@70: * This must be one of 8000, 12000, 16000, Chris@70: * 24000, or 48000. Chris@70: * @param [in] channels int: Number of channels (1 or 2) to decode Chris@70: * @retval #OPUS_OK Success or @ref opus_errorcodes Chris@70: */ Chris@70: OPUS_EXPORT int opus_decoder_init( Chris@70: OpusDecoder *st, Chris@70: opus_int32 Fs, Chris@70: int channels Chris@70: ) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Decode an Opus packet. Chris@70: * @param [in] st OpusDecoder*: Decoder state Chris@70: * @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss Chris@70: * @param [in] len opus_int32: Number of bytes in payload* Chris@70: * @param [out] pcm opus_int16*: Output signal (interleaved if 2 channels). length Chris@70: * is frame_size*channels*sizeof(opus_int16) Chris@70: * @param [in] frame_size Number of samples per channel of available space in \a pcm. Chris@70: * If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will Chris@70: * not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), Chris@70: * then frame_size needs to be exactly the duration of audio that is missing, otherwise the Chris@70: * decoder will not be in the optimal state to decode the next incoming packet. For the PLC and Chris@70: * FEC cases, frame_size must be a multiple of 2.5 ms. Chris@70: * @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be Chris@70: * decoded. If no such data is available, the frame is decoded as if it were lost. Chris@70: * @returns Number of decoded samples or @ref opus_errorcodes Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode( Chris@70: OpusDecoder *st, Chris@70: const unsigned char *data, Chris@70: opus_int32 len, Chris@70: opus_int16 *pcm, Chris@70: int frame_size, Chris@70: int decode_fec Chris@70: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4); Chris@70: Chris@70: /** Decode an Opus packet with floating point output. Chris@70: * @param [in] st OpusDecoder*: Decoder state Chris@70: * @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss Chris@70: * @param [in] len opus_int32: Number of bytes in payload Chris@70: * @param [out] pcm float*: Output signal (interleaved if 2 channels). length Chris@70: * is frame_size*channels*sizeof(float) Chris@70: * @param [in] frame_size Number of samples per channel of available space in \a pcm. Chris@70: * If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will Chris@70: * not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), Chris@70: * then frame_size needs to be exactly the duration of audio that is missing, otherwise the Chris@70: * decoder will not be in the optimal state to decode the next incoming packet. For the PLC and Chris@70: * FEC cases, frame_size must be a multiple of 2.5 ms. Chris@70: * @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be Chris@70: * decoded. If no such data is available the frame is decoded as if it were lost. Chris@70: * @returns Number of decoded samples or @ref opus_errorcodes Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_decode_float( Chris@70: OpusDecoder *st, Chris@70: const unsigned char *data, Chris@70: opus_int32 len, Chris@70: float *pcm, Chris@70: int frame_size, Chris@70: int decode_fec Chris@70: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4); Chris@70: Chris@70: /** Perform a CTL function on an Opus decoder. Chris@70: * Chris@70: * Generally the request and subsequent arguments are generated Chris@70: * by a convenience macro. Chris@70: * @param st OpusDecoder*: Decoder state. Chris@70: * @param request This and all remaining parameters should be replaced by one Chris@70: * of the convenience macros in @ref opus_genericctls or Chris@70: * @ref opus_decoderctls. Chris@70: * @see opus_genericctls Chris@70: * @see opus_decoderctls Chris@70: */ Chris@70: OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Frees an OpusDecoder allocated by opus_decoder_create(). Chris@70: * @param[in] st OpusDecoder*: State to be freed. Chris@70: */ Chris@70: OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st); Chris@70: Chris@70: /** Parse an opus packet into one or more frames. Chris@70: * Opus_decode will perform this operation internally so most applications do Chris@70: * not need to use this function. Chris@70: * This function does not copy the frames, the returned pointers are pointers into Chris@70: * the input packet. Chris@70: * @param [in] data char*: Opus packet to be parsed Chris@70: * @param [in] len opus_int32: size of data Chris@70: * @param [out] out_toc char*: TOC pointer Chris@70: * @param [out] frames char*[48] encapsulated frames Chris@70: * @param [out] size opus_int16[48] sizes of the encapsulated frames Chris@70: * @param [out] payload_offset int*: returns the position of the payload within the packet (in bytes) Chris@70: * @returns number of frames Chris@70: */ Chris@70: OPUS_EXPORT int opus_packet_parse( Chris@70: const unsigned char *data, Chris@70: opus_int32 len, Chris@70: unsigned char *out_toc, Chris@70: const unsigned char *frames[48], Chris@70: opus_int16 size[48], Chris@70: int *payload_offset Chris@70: ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(5); Chris@70: Chris@70: /** Gets the bandwidth of an Opus packet. Chris@70: * @param [in] data char*: Opus packet Chris@70: * @retval OPUS_BANDWIDTH_NARROWBAND Narrowband (4kHz bandpass) Chris@70: * @retval OPUS_BANDWIDTH_MEDIUMBAND Mediumband (6kHz bandpass) Chris@70: * @retval OPUS_BANDWIDTH_WIDEBAND Wideband (8kHz bandpass) Chris@70: * @retval OPUS_BANDWIDTH_SUPERWIDEBAND Superwideband (12kHz bandpass) Chris@70: * @retval OPUS_BANDWIDTH_FULLBAND Fullband (20kHz bandpass) Chris@70: * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_bandwidth(const unsigned char *data) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Gets the number of samples per frame from an Opus packet. Chris@70: * @param [in] data char*: Opus packet. Chris@70: * This must contain at least one byte of Chris@70: * data. Chris@70: * @param [in] Fs opus_int32: Sampling rate in Hz. Chris@70: * This must be a multiple of 400, or Chris@70: * inaccurate results will be returned. Chris@70: * @returns Number of samples per frame. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_samples_per_frame(const unsigned char *data, opus_int32 Fs) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Gets the number of channels from an Opus packet. Chris@70: * @param [in] data char*: Opus packet Chris@70: * @returns Number of channels Chris@70: * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_channels(const unsigned char *data) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Gets the number of frames in an Opus packet. Chris@70: * @param [in] packet char*: Opus packet Chris@70: * @param [in] len opus_int32: Length of packet Chris@70: * @returns Number of frames Chris@70: * @retval OPUS_BAD_ARG Insufficient data was passed to the function Chris@70: * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_frames(const unsigned char packet[], opus_int32 len) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Gets the number of samples of an Opus packet. Chris@70: * @param [in] packet char*: Opus packet Chris@70: * @param [in] len opus_int32: Length of packet Chris@70: * @param [in] Fs opus_int32: Sampling rate in Hz. Chris@70: * This must be a multiple of 400, or Chris@70: * inaccurate results will be returned. Chris@70: * @returns Number of samples Chris@70: * @retval OPUS_BAD_ARG Insufficient data was passed to the function Chris@70: * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_packet_get_nb_samples(const unsigned char packet[], opus_int32 len, opus_int32 Fs) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Gets the number of samples of an Opus packet. Chris@70: * @param [in] dec OpusDecoder*: Decoder state Chris@70: * @param [in] packet char*: Opus packet Chris@70: * @param [in] len opus_int32: Length of packet Chris@70: * @returns Number of samples Chris@70: * @retval OPUS_BAD_ARG Insufficient data was passed to the function Chris@70: * @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type Chris@70: */ Chris@70: 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); Chris@70: Chris@70: /** Applies soft-clipping to bring a float signal within the [-1,1] range. If Chris@70: * the signal is already in that range, nothing is done. If there are values Chris@70: * outside of [-1,1], then the signal is clipped as smoothly as possible to Chris@70: * both fit in the range and avoid creating excessive distortion in the Chris@70: * process. Chris@70: * @param [in,out] pcm float*: Input PCM and modified PCM Chris@70: * @param [in] frame_size int Number of samples per channel to process Chris@70: * @param [in] channels int: Number of channels Chris@70: * @param [in,out] softclip_mem float*: State memory for the soft clipping process (one float per channel, initialized to zero) Chris@70: */ Chris@70: OPUS_EXPORT void opus_pcm_soft_clip(float *pcm, int frame_size, int channels, float *softclip_mem); Chris@70: Chris@70: Chris@70: /**@}*/ Chris@70: Chris@70: /** @defgroup opus_repacketizer Repacketizer Chris@70: * @{ Chris@70: * Chris@70: * The repacketizer can be used to merge multiple Opus packets into a single Chris@70: * packet or alternatively to split Opus packets that have previously been Chris@70: * merged. Splitting valid Opus packets is always guaranteed to succeed, Chris@70: * whereas merging valid packets only succeeds if all frames have the same Chris@70: * mode, bandwidth, and frame size, and when the total duration of the merged Chris@70: * packet is no more than 120 ms. The 120 ms limit comes from the Chris@70: * specification and limits decoder memory requirements at a point where Chris@70: * framing overhead becomes negligible. Chris@70: * Chris@70: * The repacketizer currently only operates on elementary Opus Chris@70: * streams. It will not manipualte multistream packets successfully, except in Chris@70: * the degenerate case where they consist of data from a single stream. Chris@70: * Chris@70: * The repacketizing process starts with creating a repacketizer state, either Chris@70: * by calling opus_repacketizer_create() or by allocating the memory yourself, Chris@70: * e.g., Chris@70: * @code Chris@70: * OpusRepacketizer *rp; Chris@70: * rp = (OpusRepacketizer*)malloc(opus_repacketizer_get_size()); Chris@70: * if (rp != NULL) Chris@70: * opus_repacketizer_init(rp); Chris@70: * @endcode Chris@70: * Chris@70: * Then the application should submit packets with opus_repacketizer_cat(), Chris@70: * extract new packets with opus_repacketizer_out() or Chris@70: * opus_repacketizer_out_range(), and then reset the state for the next set of Chris@70: * input packets via opus_repacketizer_init(). Chris@70: * Chris@70: * For example, to split a sequence of packets into individual frames: Chris@70: * @code Chris@70: * unsigned char *data; Chris@70: * int len; Chris@70: * while (get_next_packet(&data, &len)) Chris@70: * { Chris@70: * unsigned char out[1276]; Chris@70: * opus_int32 out_len; Chris@70: * int nb_frames; Chris@70: * int err; Chris@70: * int i; Chris@70: * err = opus_repacketizer_cat(rp, data, len); Chris@70: * if (err != OPUS_OK) Chris@70: * { Chris@70: * release_packet(data); Chris@70: * return err; Chris@70: * } Chris@70: * nb_frames = opus_repacketizer_get_nb_frames(rp); Chris@70: * for (i = 0; i < nb_frames; i++) Chris@70: * { Chris@70: * out_len = opus_repacketizer_out_range(rp, i, i+1, out, sizeof(out)); Chris@70: * if (out_len < 0) Chris@70: * { Chris@70: * release_packet(data); Chris@70: * return (int)out_len; Chris@70: * } Chris@70: * output_next_packet(out, out_len); Chris@70: * } Chris@70: * opus_repacketizer_init(rp); Chris@70: * release_packet(data); Chris@70: * } Chris@70: * @endcode Chris@70: * Chris@70: * Alternatively, to combine a sequence of frames into packets that each Chris@70: * contain up to TARGET_DURATION_MS milliseconds of data: Chris@70: * @code Chris@70: * // The maximum number of packets with duration TARGET_DURATION_MS occurs Chris@70: * // when the frame size is 2.5 ms, for a total of (TARGET_DURATION_MS*2/5) Chris@70: * // packets. Chris@70: * unsigned char *data[(TARGET_DURATION_MS*2/5)+1]; Chris@70: * opus_int32 len[(TARGET_DURATION_MS*2/5)+1]; Chris@70: * int nb_packets; Chris@70: * unsigned char out[1277*(TARGET_DURATION_MS*2/2)]; Chris@70: * opus_int32 out_len; Chris@70: * int prev_toc; Chris@70: * nb_packets = 0; Chris@70: * while (get_next_packet(data+nb_packets, len+nb_packets)) Chris@70: * { Chris@70: * int nb_frames; Chris@70: * int err; Chris@70: * nb_frames = opus_packet_get_nb_frames(data[nb_packets], len[nb_packets]); Chris@70: * if (nb_frames < 1) Chris@70: * { Chris@70: * release_packets(data, nb_packets+1); Chris@70: * return nb_frames; Chris@70: * } Chris@70: * nb_frames += opus_repacketizer_get_nb_frames(rp); Chris@70: * // If adding the next packet would exceed our target, or it has an Chris@70: * // incompatible TOC sequence, output the packets we already have before Chris@70: * // submitting it. Chris@70: * // N.B., The nb_packets > 0 check ensures we've submitted at least one Chris@70: * // packet since the last call to opus_repacketizer_init(). Otherwise a Chris@70: * // single packet longer than TARGET_DURATION_MS would cause us to try to Chris@70: * // output an (invalid) empty packet. It also ensures that prev_toc has Chris@70: * // been set to a valid value. Additionally, len[nb_packets] > 0 is Chris@70: * // guaranteed by the call to opus_packet_get_nb_frames() above, so the Chris@70: * // reference to data[nb_packets][0] should be valid. Chris@70: * if (nb_packets > 0 && ( Chris@70: * ((prev_toc & 0xFC) != (data[nb_packets][0] & 0xFC)) || Chris@70: * opus_packet_get_samples_per_frame(data[nb_packets], 48000)*nb_frames > Chris@70: * TARGET_DURATION_MS*48)) Chris@70: * { Chris@70: * out_len = opus_repacketizer_out(rp, out, sizeof(out)); Chris@70: * if (out_len < 0) Chris@70: * { Chris@70: * release_packets(data, nb_packets+1); Chris@70: * return (int)out_len; Chris@70: * } Chris@70: * output_next_packet(out, out_len); Chris@70: * opus_repacketizer_init(rp); Chris@70: * release_packets(data, nb_packets); Chris@70: * data[0] = data[nb_packets]; Chris@70: * len[0] = len[nb_packets]; Chris@70: * nb_packets = 0; Chris@70: * } Chris@70: * err = opus_repacketizer_cat(rp, data[nb_packets], len[nb_packets]); Chris@70: * if (err != OPUS_OK) Chris@70: * { Chris@70: * release_packets(data, nb_packets+1); Chris@70: * return err; Chris@70: * } Chris@70: * prev_toc = data[nb_packets][0]; Chris@70: * nb_packets++; Chris@70: * } Chris@70: * // Output the final, partial packet. Chris@70: * if (nb_packets > 0) Chris@70: * { Chris@70: * out_len = opus_repacketizer_out(rp, out, sizeof(out)); Chris@70: * release_packets(data, nb_packets); Chris@70: * if (out_len < 0) Chris@70: * return (int)out_len; Chris@70: * output_next_packet(out, out_len); Chris@70: * } Chris@70: * @endcode Chris@70: * Chris@70: * An alternate way of merging packets is to simply call opus_repacketizer_cat() Chris@70: * unconditionally until it fails. At that point, the merged packet can be Chris@70: * obtained with opus_repacketizer_out() and the input packet for which Chris@70: * opus_repacketizer_cat() needs to be re-added to a newly reinitialized Chris@70: * repacketizer state. Chris@70: */ Chris@70: Chris@70: typedef struct OpusRepacketizer OpusRepacketizer; Chris@70: Chris@70: /** Gets the size of an OpusRepacketizer structure. Chris@70: * @returns The size in bytes. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_size(void); Chris@70: Chris@70: /** (Re)initializes a previously allocated repacketizer state. Chris@70: * The state must be at least the size returned by opus_repacketizer_get_size(). Chris@70: * This can be used for applications which use their own allocator instead of Chris@70: * malloc(). Chris@70: * It must also be called to reset the queue of packets waiting to be Chris@70: * repacketized, which is necessary if the maximum packet duration of 120 ms Chris@70: * is reached or if you wish to submit packets with a different Opus Chris@70: * configuration (coding mode, audio bandwidth, frame size, or channel count). Chris@70: * Failure to do so will prevent a new packet from being added with Chris@70: * opus_repacketizer_cat(). Chris@70: * @see opus_repacketizer_create Chris@70: * @see opus_repacketizer_get_size Chris@70: * @see opus_repacketizer_cat Chris@70: * @param rp OpusRepacketizer*: The repacketizer state to Chris@70: * (re)initialize. Chris@70: * @returns A pointer to the same repacketizer state that was passed in. Chris@70: */ Chris@70: OPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Allocates memory and initializes the new repacketizer with Chris@70: * opus_repacketizer_init(). Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT OpusRepacketizer *opus_repacketizer_create(void); Chris@70: Chris@70: /** Frees an OpusRepacketizer allocated by Chris@70: * opus_repacketizer_create(). Chris@70: * @param[in] rp OpusRepacketizer*: State to be freed. Chris@70: */ Chris@70: OPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp); Chris@70: Chris@70: /** Add a packet to the current repacketizer state. Chris@70: * This packet must match the configuration of any packets already submitted Chris@70: * for repacketization since the last call to opus_repacketizer_init(). Chris@70: * This means that it must have the same coding mode, audio bandwidth, frame Chris@70: * size, and channel count. Chris@70: * This can be checked in advance by examining the top 6 bits of the first Chris@70: * byte of the packet, and ensuring they match the top 6 bits of the first Chris@70: * byte of any previously submitted packet. Chris@70: * The total duration of audio in the repacketizer state also must not exceed Chris@70: * 120 ms, the maximum duration of a single packet, after adding this packet. Chris@70: * Chris@70: * The contents of the current repacketizer state can be extracted into new Chris@70: * packets using opus_repacketizer_out() or opus_repacketizer_out_range(). Chris@70: * Chris@70: * In order to add a packet with a different configuration or to add more Chris@70: * audio beyond 120 ms, you must clear the repacketizer state by calling Chris@70: * opus_repacketizer_init(). Chris@70: * If a packet is too large to add to the current repacketizer state, no part Chris@70: * of it is added, even if it contains multiple frames, some of which might Chris@70: * fit. Chris@70: * If you wish to be able to add parts of such packets, you should first use Chris@70: * another repacketizer to split the packet into pieces and add them Chris@70: * individually. Chris@70: * @see opus_repacketizer_out_range Chris@70: * @see opus_repacketizer_out Chris@70: * @see opus_repacketizer_init Chris@70: * @param rp OpusRepacketizer*: The repacketizer state to which to Chris@70: * add the packet. Chris@70: * @param[in] data const unsigned char*: The packet data. Chris@70: * The application must ensure Chris@70: * this pointer remains valid Chris@70: * until the next call to Chris@70: * opus_repacketizer_init() or Chris@70: * opus_repacketizer_destroy(). Chris@70: * @param len opus_int32: The number of bytes in the packet data. Chris@70: * @returns An error code indicating whether or not the operation succeeded. Chris@70: * @retval #OPUS_OK The packet's contents have been added to the repacketizer Chris@70: * state. Chris@70: * @retval #OPUS_INVALID_PACKET The packet did not have a valid TOC sequence, Chris@70: * the packet's TOC sequence was not compatible Chris@70: * with previously submitted packets (because Chris@70: * the coding mode, audio bandwidth, frame size, Chris@70: * or channel count did not match), or adding Chris@70: * this packet would increase the total amount of Chris@70: * audio stored in the repacketizer state to more Chris@70: * than 120 ms. Chris@70: */ Chris@70: OPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, opus_int32 len) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2); Chris@70: Chris@70: Chris@70: /** Construct a new packet from data previously submitted to the repacketizer Chris@70: * state via opus_repacketizer_cat(). Chris@70: * @param rp OpusRepacketizer*: The repacketizer state from which to Chris@70: * construct the new packet. Chris@70: * @param begin int: The index of the first frame in the current Chris@70: * repacketizer state to include in the output. Chris@70: * @param end int: One past the index of the last frame in the Chris@70: * current repacketizer state to include in the Chris@70: * output. Chris@70: * @param[out] data const unsigned char*: The buffer in which to Chris@70: * store the output packet. Chris@70: * @param maxlen opus_int32: The maximum number of bytes to store in Chris@70: * the output buffer. In order to guarantee Chris@70: * success, this should be at least Chris@70: * 1276 for a single frame, Chris@70: * or for multiple frames, Chris@70: * 1277*(end-begin). Chris@70: * However, 1*(end-begin) plus Chris@70: * the size of all packet data submitted to Chris@70: * the repacketizer since the last call to Chris@70: * opus_repacketizer_init() or Chris@70: * opus_repacketizer_create() is also Chris@70: * sufficient, and possibly much smaller. Chris@70: * @returns The total size of the output packet on success, or an error code Chris@70: * on failure. Chris@70: * @retval #OPUS_BAD_ARG [begin,end) was an invalid range of Chris@70: * frames (begin < 0, begin >= end, or end > Chris@70: * opus_repacketizer_get_nb_frames()). Chris@70: * @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the Chris@70: * complete output packet. Chris@70: */ Chris@70: 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); Chris@70: Chris@70: /** Return the total number of frames contained in packet data submitted to Chris@70: * the repacketizer state so far via opus_repacketizer_cat() since the last Chris@70: * call to opus_repacketizer_init() or opus_repacketizer_create(). Chris@70: * This defines the valid range of packets that can be extracted with Chris@70: * opus_repacketizer_out_range() or opus_repacketizer_out(). Chris@70: * @param rp OpusRepacketizer*: The repacketizer state containing the Chris@70: * frames. Chris@70: * @returns The total number of frames contained in the packet data submitted Chris@70: * to the repacketizer state. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Construct a new packet from data previously submitted to the repacketizer Chris@70: * state via opus_repacketizer_cat(). Chris@70: * This is a convenience routine that returns all the data submitted so far Chris@70: * in a single packet. Chris@70: * It is equivalent to calling Chris@70: * @code Chris@70: * opus_repacketizer_out_range(rp, 0, opus_repacketizer_get_nb_frames(rp), Chris@70: * data, maxlen) Chris@70: * @endcode Chris@70: * @param rp OpusRepacketizer*: The repacketizer state from which to Chris@70: * construct the new packet. Chris@70: * @param[out] data const unsigned char*: The buffer in which to Chris@70: * store the output packet. Chris@70: * @param maxlen opus_int32: The maximum number of bytes to store in Chris@70: * the output buffer. In order to guarantee Chris@70: * success, this should be at least Chris@70: * 1277*opus_repacketizer_get_nb_frames(rp). Chris@70: * However, Chris@70: * 1*opus_repacketizer_get_nb_frames(rp) Chris@70: * plus the size of all packet data Chris@70: * submitted to the repacketizer since the Chris@70: * last call to opus_repacketizer_init() or Chris@70: * opus_repacketizer_create() is also Chris@70: * sufficient, and possibly much smaller. Chris@70: * @returns The total size of the output packet on success, or an error code Chris@70: * on failure. Chris@70: * @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the Chris@70: * complete output packet. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, opus_int32 maxlen) OPUS_ARG_NONNULL(1); Chris@70: Chris@70: /** Pads a given Opus packet to a larger size (possibly changing the TOC sequence). Chris@70: * @param[in,out] data const unsigned char*: The buffer containing the Chris@70: * packet to pad. Chris@70: * @param len opus_int32: The size of the packet. Chris@70: * This must be at least 1. Chris@70: * @param new_len opus_int32: The desired size of the packet after padding. Chris@70: * This must be at least as large as len. Chris@70: * @returns an error code Chris@70: * @retval #OPUS_OK \a on success. Chris@70: * @retval #OPUS_BAD_ARG \a len was less than 1 or new_len was less than len. Chris@70: * @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet. Chris@70: */ Chris@70: OPUS_EXPORT int opus_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len); Chris@70: Chris@70: /** Remove all padding from a given Opus packet and rewrite the TOC sequence to Chris@70: * minimize space usage. Chris@70: * @param[in,out] data const unsigned char*: The buffer containing the Chris@70: * packet to strip. Chris@70: * @param len opus_int32: The size of the packet. Chris@70: * This must be at least 1. Chris@70: * @returns The new size of the output packet on success, or an error code Chris@70: * on failure. Chris@70: * @retval #OPUS_BAD_ARG \a len was less than 1. Chris@70: * @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_packet_unpad(unsigned char *data, opus_int32 len); Chris@70: Chris@70: /** Pads a given Opus multi-stream packet to a larger size (possibly changing the TOC sequence). Chris@70: * @param[in,out] data const unsigned char*: The buffer containing the Chris@70: * packet to pad. Chris@70: * @param len opus_int32: The size of the packet. Chris@70: * This must be at least 1. Chris@70: * @param new_len opus_int32: The desired size of the packet after padding. Chris@70: * This must be at least 1. Chris@70: * @param nb_streams opus_int32: The number of streams (not channels) in the packet. Chris@70: * This must be at least as large as len. Chris@70: * @returns an error code Chris@70: * @retval #OPUS_OK \a on success. Chris@70: * @retval #OPUS_BAD_ARG \a len was less than 1. Chris@70: * @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet. Chris@70: */ Chris@70: OPUS_EXPORT int opus_multistream_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len, int nb_streams); Chris@70: Chris@70: /** Remove all padding from a given Opus multi-stream packet and rewrite the TOC sequence to Chris@70: * minimize space usage. Chris@70: * @param[in,out] data const unsigned char*: The buffer containing the Chris@70: * packet to strip. Chris@70: * @param len opus_int32: The size of the packet. Chris@70: * This must be at least 1. Chris@70: * @param nb_streams opus_int32: The number of streams (not channels) in the packet. Chris@70: * This must be at least 1. Chris@70: * @returns The new size of the output packet on success, or an error code Chris@70: * on failure. Chris@70: * @retval #OPUS_BAD_ARG \a len was less than 1 or new_len was less than len. Chris@70: * @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet. Chris@70: */ Chris@70: OPUS_EXPORT OPUS_WARN_UNUSED_RESULT opus_int32 opus_multistream_packet_unpad(unsigned char *data, opus_int32 len, int nb_streams); Chris@70: Chris@70: /**@}*/ Chris@70: Chris@70: #ifdef __cplusplus Chris@70: } Chris@70: #endif Chris@70: Chris@70: #endif /* OPUS_H */