Expand description
Unsafe opus-sys bindings
Structs§
Constants§
- OPUS_
ALLOC_ FAIL - OPUS_
APPLICATION_ AUDIO - OPUS_
APPLICATION_ RESTRICTED_ LOWDELAY - OPUS_
APPLICATION_ VOIP - OPUS_
AUTO - OPUS_
BAD_ ARG - OPUS_
BANDWIDTH_ FULLBAND - OPUS_
BANDWIDTH_ MEDIUMBAND - OPUS_
BANDWIDTH_ NARROWBAND - OPUS_
BANDWIDTH_ SUPERWIDEBAND - OPUS_
BANDWIDTH_ WIDEBAND - OPUS_
BITRATE_ MAX - OPUS_
BUFFER_ TOO_ SMALL - OPUS_
FRAMESIZE_ 2_ 5_ MS - OPUS_
FRAMESIZE_ 5_ MS - OPUS_
FRAMESIZE_ 10_ MS - OPUS_
FRAMESIZE_ 20_ MS - OPUS_
FRAMESIZE_ 40_ MS - OPUS_
FRAMESIZE_ 60_ MS - OPUS_
FRAMESIZE_ 80_ MS - OPUS_
FRAMESIZE_ 100_ MS - OPUS_
FRAMESIZE_ 120_ MS - OPUS_
FRAMESIZE_ ARG - OPUS_
GET_ APPLICATION_ REQUEST - OPUS_
GET_ BANDWIDTH_ REQUEST - OPUS_
GET_ BITRATE_ REQUEST - OPUS_
GET_ COMPLEXITY_ REQUEST - OPUS_
GET_ DTX_ REQUEST - OPUS_
GET_ EXPERT_ FRAME_ DURATION_ REQUEST - OPUS_
GET_ FINAL_ RANGE_ REQUEST - OPUS_
GET_ FORCE_ CHANNELS_ REQUEST - OPUS_
GET_ GAIN_ REQUEST - OPUS_
GET_ INBAND_ FEC_ REQUEST - OPUS_
GET_ IN_ DTX_ REQUEST - OPUS_
GET_ LAST_ PACKET_ DURATION_ REQUEST - OPUS_
GET_ LOOKAHEAD_ REQUEST - OPUS_
GET_ LSB_ DEPTH_ REQUEST - OPUS_
GET_ MAX_ BANDWIDTH_ REQUEST - OPUS_
GET_ PACKET_ LOSS_ PERC_ REQUEST - OPUS_
GET_ PHASE_ INVERSION_ DISABLED_ REQUEST - OPUS_
GET_ PITCH_ REQUEST - OPUS_
GET_ PREDICTION_ DISABLED_ REQUEST - OPUS_
GET_ SAMPLE_ RATE_ REQUEST - OPUS_
GET_ SIGNAL_ REQUEST - OPUS_
GET_ VBR_ CONSTRAINT_ REQUEST - OPUS_
GET_ VBR_ REQUEST - OPUS_
INTERNAL_ ERROR - OPUS_
INVALID_ PACKET - OPUS_
INVALID_ STATE - OPUS_OK
- OPUS_
RESET_ STATE - OPUS_
SET_ APPLICATION_ REQUEST - OPUS_
SET_ BANDWIDTH_ REQUEST - OPUS_
SET_ BITRATE_ REQUEST - OPUS_
SET_ COMPLEXITY_ REQUEST - OPUS_
SET_ DTX_ REQUEST - OPUS_
SET_ EXPERT_ FRAME_ DURATION_ REQUEST - OPUS_
SET_ FORCE_ CHANNELS_ REQUEST - OPUS_
SET_ GAIN_ REQUEST - OPUS_
SET_ INBAND_ FEC_ REQUEST - OPUS_
SET_ LSB_ DEPTH_ REQUEST - OPUS_
SET_ MAX_ BANDWIDTH_ REQUEST - OPUS_
SET_ PACKET_ LOSS_ PERC_ REQUEST - OPUS_
SET_ PHASE_ INVERSION_ DISABLED_ REQUEST - OPUS_
SET_ PREDICTION_ DISABLED_ REQUEST - OPUS_
SET_ SIGNAL_ REQUEST - OPUS_
SET_ VBR_ CONSTRAINT_ REQUEST - OPUS_
SET_ VBR_ REQUEST - OPUS_
SIGNAL_ MUSIC - OPUS_
SIGNAL_ VOICE - OPUS_
UNIMPLEMENTED
Functions§
- opus_
decode ⚠ - Decode an Opus packet. @param [in] st OpusDecoder*: Decoder state @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss @param [in] len opus_int32: Number of bytes in payload* @param [out] pcm opus_int16*: Output signal (interleaved if 2 channels). length is frame_sizechannelssizeof(opus_int16) @param [in] frame_size Number of samples per channel of available space in \a pcm. If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), then frame_size needs to be exactly the duration of audio that is missing, otherwise the decoder will not be in the optimal state to decode the next incoming packet. For the PLC and FEC cases, frame_size must be a multiple of 2.5 ms. @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be decoded. If no such data is available, the frame is decoded as if it were lost. @returns Number of decoded samples or @ref opus_errorcodes
- opus_
decode_ ⚠float - Decode an Opus packet with floating point output. @param [in] st OpusDecoder*: Decoder state @param [in] data char*: Input payload. Use a NULL pointer to indicate packet loss @param [in] len opus_int32: Number of bytes in payload @param [out] pcm float*: Output signal (interleaved if 2 channels). length is frame_sizechannelssizeof(float) @param [in] frame_size Number of samples per channel of available space in \a pcm. If this is less than the maximum packet duration (120ms; 5760 for 48kHz), this function will not be capable of decoding some packets. In the case of PLC (data==NULL) or FEC (decode_fec=1), then frame_size needs to be exactly the duration of audio that is missing, otherwise the decoder will not be in the optimal state to decode the next incoming packet. For the PLC and FEC cases, frame_size must be a multiple of 2.5 ms. @param [in] decode_fec int: Flag (0 or 1) to request that any in-band forward error correction data be decoded. If no such data is available the frame is decoded as if it were lost. @returns Number of decoded samples or @ref opus_errorcodes
- opus_
decoder_ ⚠create - Allocates and initializes a decoder state. @param [in] Fs opus_int32: Sample rate to decode at (Hz). This must be one of 8000, 12000, 16000, 24000, or 48000. @param [in] channels int: Number of channels (1 or 2) to decode @param [out] error int*: #OPUS_OK Success or @ref opus_errorcodes
- opus_
decoder_ ⚠ctl - Perform a CTL function on an Opus decoder.
- opus_
decoder_ ⚠destroy - Frees an
OpusDecoderallocated by opus_decoder_create(). @param[in] st OpusDecoder*: State to be freed. - opus_
decoder_ ⚠get_ nb_ samples - Gets the number of samples of an Opus packet. @param [in] dec OpusDecoder*: Decoder state @param [in] packet char*: Opus packet @param [in] len opus_int32: Length of packet @returns Number of samples @retval OPUS_BAD_ARG Insufficient data was passed to the function @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
- opus_
decoder_ ⚠get_ size - Gets the size of an
OpusDecoderstructure. @param [in] channels int: Number of channels. This must be 1 or 2. @returns The size in bytes. - opus_
decoder_ ⚠init - Initializes a previously allocated decoder state. The state must be at least the size returned by opus_decoder_get_size(). This is intended for applications which use their own allocator instead of malloc. @see opus_decoder_create,opus_decoder_get_size To reset a previously initialized state, use the #OPUS_RESET_STATE CTL. @param [in] st OpusDecoder*: Decoder state. @param [in] Fs opus_int32: Sampling rate to decode to (Hz). This must be one of 8000, 12000, 16000, 24000, or 48000. @param [in] channels int: Number of channels (1 or 2) to decode @retval #OPUS_OK Success or @ref opus_errorcodes
- opus_
encode ⚠ - Encodes an Opus frame. @param [in] st OpusEncoder*: Encoder state @param [in] pcm opus_int16*: Input signal (interleaved if 2 channels). length is frame_sizechannelssizeof(opus_int16) @param [in] frame_size int: Number of samples per channel in the input signal. This must be an Opus frame size for the encoder’s sampling rate. For example, at 48 kHz the permitted values are 120, 240, 480, 960, 1920, and 2880. Passing in a duration of less than 10 ms (480 samples at 48 kHz) will prevent the encoder from using the LPC or hybrid modes. @param [out] data unsigned char*: Output payload. This must contain storage for at least \a max_data_bytes. @param [in] max_data_bytes opus_int32: Size of the allocated memory for the output payload. This may be used to impose an upper limit on the instant bitrate, but should not be used as the only bitrate control. Use #OPUS_SET_BITRATE to control the bitrate. @returns The length of the encoded packet (in bytes) on success or a negative error code (see @ref opus_errorcodes) on failure.
- opus_
encode_ ⚠float - Encodes an Opus frame from floating point input. @param [in] st OpusEncoder*: Encoder state @param [in] pcm float*: Input in float format (interleaved if 2 channels), with a normal range of +/-1.0. Samples with a range beyond +/-1.0 are supported but will be clipped by decoders using the integer API and should only be used if it is known that the far end supports extended dynamic range. length is frame_sizechannelssizeof(float) @param [in] frame_size int: Number of samples per channel in the input signal. This must be an Opus frame size for the encoder’s sampling rate. For example, at 48 kHz the permitted values are 120, 240, 480, 960, 1920, and 2880. Passing in a duration of less than 10 ms (480 samples at 48 kHz) will prevent the encoder from using the LPC or hybrid modes. @param [out] data unsigned char*: Output payload. This must contain storage for at least \a max_data_bytes. @param [in] max_data_bytes opus_int32: Size of the allocated memory for the output payload. This may be used to impose an upper limit on the instant bitrate, but should not be used as the only bitrate control. Use #OPUS_SET_BITRATE to control the bitrate. @returns The length of the encoded packet (in bytes) on success or a negative error code (see @ref opus_errorcodes) on failure.
- opus_
encoder_ ⚠create - Allocates and initializes an encoder state. There are three coding modes:
- opus_
encoder_ ⚠ctl - Perform a CTL function on an Opus encoder.
- opus_
encoder_ ⚠destroy - Frees an
OpusEncoderallocated by opus_encoder_create(). @param[in] st OpusEncoder*: State to be freed. - opus_
encoder_ ⚠get_ size - Gets the size of an
OpusEncoderstructure. @param[in] channels int: Number of channels. This must be 1 or 2. @returns The size in bytes. - opus_
encoder_ ⚠init - Initializes a previously allocated encoder state The memory pointed to by st must be at least the size returned by opus_encoder_get_size(). This is intended for applications which use their own allocator instead of malloc. @see opus_encoder_create(),opus_encoder_get_size() To reset a previously initialized state, use the #OPUS_RESET_STATE CTL. @param [in] st OpusEncoder*: Encoder state @param [in] Fs opus_int32: Sampling rate of input signal (Hz) This must be one of 8000, 12000, 16000, 24000, or 48000. @param [in] channels int: Number of channels (1 or 2) in input signal @param [in] application int: Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO/OPUS_APPLICATION_RESTRICTED_LOWDELAY) @retval #OPUS_OK Success or @ref opus_errorcodes
- opus_
get_ ⚠version_ string - Gets the libopus version string.
- opus_
multistream_ ⚠packet_ pad - Pads a given Opus multi-stream packet to a larger size (possibly changing the TOC sequence). @param[in,out] data const unsigned char*: The buffer containing the packet to pad. @param len opus_int32: The size of the packet. This must be at least 1. @param new_len opus_int32: The desired size of the packet after padding. This must be at least 1. @param nb_streams opus_int32: The number of streams (not channels) in the packet. This must be at least as large as len. @returns an error code @retval #OPUS_OK \a on success. @retval #OPUS_BAD_ARG \a len was less than 1. @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
- opus_
multistream_ ⚠packet_ unpad - Remove all padding from a given Opus multi-stream packet and rewrite the TOC sequence to minimize space usage. @param[in,out] data const unsigned char*: The buffer containing the packet to strip. @param len opus_int32: The size of the packet. This must be at least 1. @param nb_streams opus_int32: The number of streams (not channels) in the packet. This must be at least 1. @returns The new size of the output packet on success, or an error code on failure. @retval #OPUS_BAD_ARG \a len was less than 1 or new_len was less than len. @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
- opus_
packet_ ⚠get_ bandwidth - Gets the bandwidth of an Opus packet. @param [in] data char*: Opus packet @retval OPUS_BANDWIDTH_NARROWBAND Narrowband (4kHz bandpass) @retval OPUS_BANDWIDTH_MEDIUMBAND Mediumband (6kHz bandpass) @retval OPUS_BANDWIDTH_WIDEBAND Wideband (8kHz bandpass) @retval OPUS_BANDWIDTH_SUPERWIDEBAND Superwideband (12kHz bandpass) @retval OPUS_BANDWIDTH_FULLBAND Fullband (20kHz bandpass) @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
- opus_
packet_ ⚠get_ nb_ channels - Gets the number of channels from an Opus packet. @param [in] data char*: Opus packet @returns Number of channels @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
- opus_
packet_ ⚠get_ nb_ frames - Gets the number of frames in an Opus packet. @param [in] packet char*: Opus packet @param [in] len opus_int32: Length of packet @returns Number of frames @retval OPUS_BAD_ARG Insufficient data was passed to the function @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
- opus_
packet_ ⚠get_ nb_ samples - Gets the number of samples of an Opus packet. @param [in] packet char*: Opus packet @param [in] len opus_int32: Length of packet @param [in] Fs opus_int32: Sampling rate in Hz. This must be a multiple of 400, or inaccurate results will be returned. @returns Number of samples @retval OPUS_BAD_ARG Insufficient data was passed to the function @retval OPUS_INVALID_PACKET The compressed data passed is corrupted or of an unsupported type
- opus_
packet_ ⚠get_ samples_ per_ frame - Gets the number of samples per frame from an Opus packet. @param [in] data char*: Opus packet. This must contain at least one byte of data. @param [in] Fs opus_int32: Sampling rate in Hz. This must be a multiple of 400, or inaccurate results will be returned. @returns Number of samples per frame.
- opus_
packet_ ⚠pad - Pads a given Opus packet to a larger size (possibly changing the TOC sequence). @param[in,out] data const unsigned char*: The buffer containing the packet to pad. @param len opus_int32: The size of the packet. This must be at least 1. @param new_len opus_int32: The desired size of the packet after padding. This must be at least as large as len. @returns an error code @retval #OPUS_OK \a on success. @retval #OPUS_BAD_ARG \a len was less than 1 or new_len was less than len. @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
- opus_
packet_ ⚠parse - Parse an opus packet into one or more frames. Opus_decode will perform this operation internally so most applications do not need to use this function. This function does not copy the frames, the returned pointers are pointers into the input packet. @param [in] data char*: Opus packet to be parsed @param [in] len opus_int32: size of data @param [out] out_toc char*: TOC pointer @param [out] frames char*[48] encapsulated frames @param [out] size opus_int16[48] sizes of the encapsulated frames @param [out] payload_offset int*: returns the position of the payload within the packet (in bytes) @returns number of frames
- opus_
packet_ ⚠unpad - Remove all padding from a given Opus packet and rewrite the TOC sequence to minimize space usage. @param[in,out] data const unsigned char*: The buffer containing the packet to strip. @param len opus_int32: The size of the packet. This must be at least 1. @returns The new size of the output packet on success, or an error code on failure. @retval #OPUS_BAD_ARG \a len was less than 1. @retval #OPUS_INVALID_PACKET \a data did not contain a valid Opus packet.
- opus_
pcm_ ⚠soft_ clip - Applies soft-clipping to bring a float signal within the [-1,1] range. If the signal is already in that range, nothing is done. If there are values outside of [-1,1], then the signal is clipped as smoothly as possible to both fit in the range and avoid creating excessive distortion in the process. @param [in,out] pcm float*: Input PCM and modified PCM @param [in] frame_size int Number of samples per channel to process @param [in] channels int: Number of channels @param [in,out] softclip_mem float*: State memory for the soft clipping process (one float per channel, initialized to zero)
- opus_
repacketizer_ ⚠cat - Add a packet to the current repacketizer state. This packet must match the configuration of any packets already submitted for repacketization since the last call to opus_repacketizer_init(). This means that it must have the same coding mode, audio bandwidth, frame size, and channel count. This can be checked in advance by examining the top 6 bits of the first byte of the packet, and ensuring they match the top 6 bits of the first byte of any previously submitted packet. The total duration of audio in the repacketizer state also must not exceed 120 ms, the maximum duration of a single packet, after adding this packet.
- opus_
repacketizer_ ⚠create - Allocates memory and initializes the new repacketizer with opus_repacketizer_init().
- opus_
repacketizer_ ⚠destroy - Frees an
OpusRepacketizerallocated by opus_repacketizer_create(). @param[in] rp OpusRepacketizer*: State to be freed. - opus_
repacketizer_ ⚠get_ nb_ frames - Return the total number of frames contained in packet data submitted to the repacketizer state so far via opus_repacketizer_cat() since the last call to opus_repacketizer_init() or opus_repacketizer_create(). This defines the valid range of packets that can be extracted with opus_repacketizer_out_range() or opus_repacketizer_out(). @param rp OpusRepacketizer*: The repacketizer state containing the frames. @returns The total number of frames contained in the packet data submitted to the repacketizer state.
- opus_
repacketizer_ ⚠get_ size - Gets the size of an
OpusRepacketizerstructure. @returns The size in bytes. - opus_
repacketizer_ ⚠init - (Re)initializes a previously allocated repacketizer state. The state must be at least the size returned by opus_repacketizer_get_size(). This can be used for applications which use their own allocator instead of malloc(). It must also be called to reset the queue of packets waiting to be repacketized, which is necessary if the maximum packet duration of 120 ms is reached or if you wish to submit packets with a different Opus configuration (coding mode, audio bandwidth, frame size, or channel count). Failure to do so will prevent a new packet from being added with opus_repacketizer_cat(). @see opus_repacketizer_create @see opus_repacketizer_get_size @see opus_repacketizer_cat @param rp OpusRepacketizer*: The repacketizer state to (re)initialize. @returns A pointer to the same repacketizer state that was passed in.
- opus_
repacketizer_ ⚠out - Construct a new packet from data previously submitted to the repacketizer
state via opus_repacketizer_cat().
This is a convenience routine that returns all the data submitted so far
in a single packet.
It is equivalent to calling
@code
opus_repacketizer_out_range(rp, 0, opus_repacketizer_get_nb_frames(rp),
data, maxlen)
@endcode
@param rp OpusRepacketizer*: The repacketizer state from which to
construct the new packet.
@param[out] data const unsigned char*: The buffer in which to
store the output packet.
@param maxlen opus_int32: The maximum number of bytes to store in
the output buffer. In order to guarantee
success, this should be at least
1277opus_repacketizer_get_nb_frames(rp). However,1opus_repacketizer_get_nb_frames(rp)plus the size of all packet data submitted to the repacketizer since the last call to opus_repacketizer_init() or opus_repacketizer_create() is also sufficient, and possibly much smaller. @returns The total size of the output packet on success, or an error code on failure. @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the complete output packet. - opus_
repacketizer_ ⚠out_ range - Construct a new packet from data previously submitted to the repacketizer
state via opus_repacketizer_cat().
@param rp OpusRepacketizer*: The repacketizer state from which to
construct the new packet.
@param begin int: The index of the first frame in the current
repacketizer state to include in the output.
@param end int: One past the index of the last frame in the
current repacketizer state to include in the
output.
@param[out] data const unsigned char*: The buffer in which to
store the output packet.
@param maxlen opus_int32: The maximum number of bytes to store in
the output buffer. In order to guarantee
success, this should be at least
1276for a single frame, or for multiple frames,1277*(end-begin). However,1*(end-begin)plus the size of all packet data submitted to the repacketizer since the last call to opus_repacketizer_init() or opus_repacketizer_create() is also sufficient, and possibly much smaller. @returns The total size of the output packet on success, or an error code on failure. @retval #OPUS_BAD_ARG[begin,end)was an invalid range of frames (begin < 0, begin >= end, or end > opus_repacketizer_get_nb_frames()). @retval #OPUS_BUFFER_TOO_SMALL \a maxlen was insufficient to contain the complete output packet. - opus_
strerror ⚠ - Converts an opus error code into a human readable string.