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