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