$treeview $search $mathjax
|
|
$projectbrief
|
$searchbox |
Typedefs | |
typedef OpusCustomEncoder | OpusCustomEncoder |
Contains the state of an encoder. Encoder state. More... | |
typedef OpusCustomDecoder | OpusCustomDecoder |
State of the decoder. Decoder state. More... | |
typedef OpusCustomMode | OpusCustomMode |
The mode contains all the information necessary to create an encoder. Mode configuration. More... | |
Functions | |
OpusCustomMode * | opus_custom_mode_create (opus_int32 Fs, int frame_size, int *error) |
Creates a new mode struct. More... | |
void | opus_custom_mode_destroy (OpusCustomMode *mode) |
Destroys a mode struct. More... | |
int | opus_custom_encoder_get_size (const OpusCustomMode *mode, int channels) |
Gets the size of an OpusCustomEncoder structure. More... | |
OpusCustomEncoder * | opus_custom_encoder_create (const OpusCustomMode *mode, int channels, int *error) |
Creates a new encoder state. More... | |
int | opus_custom_encoder_init (OpusCustomEncoder *st, const OpusCustomMode *mode, int channels) |
Initializes a previously allocated encoder state The memory pointed to by st must be the size returned by opus_custom_encoder_get_size. More... | |
void | opus_custom_encoder_destroy (OpusCustomEncoder *st) |
Destroys a an encoder state. More... | |
int | opus_custom_encode_float (OpusCustomEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes) |
Encodes a frame of audio. More... | |
int | opus_custom_encode (OpusCustomEncoder *st, const opus_int16 *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes) |
Encodes a frame of audio. More... | |
int | opus_custom_encoder_ctl (OpusCustomEncoder *OPUS_RESTRICT st, int request,...) |
Perform a CTL function on an Opus custom encoder. More... | |
int | opus_custom_decoder_get_size (const OpusCustomMode *mode, int channels) |
Gets the size of an OpusCustomDecoder structure. More... | |
OpusCustomDecoder * | opus_custom_decoder_create (const OpusCustomMode *mode, int channels, int *error) |
Creates a new decoder state. More... | |
int | opus_custom_decoder_init (OpusCustomDecoder *st, const OpusCustomMode *mode, int channels) |
Initializes a previously allocated decoder state The memory pointed to by st must be the size returned by opus_custom_decoder_get_size. More... | |
void | opus_custom_decoder_destroy (OpusCustomDecoder *st) |
Destroys a an decoder state. More... | |
int | opus_custom_decode_float (OpusCustomDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size) |
Decode an opus custom frame with floating point output. More... | |
int | opus_custom_decode (OpusCustomDecoder *st, const unsigned char *data, int len, opus_int16 *pcm, int frame_size) |
Decode an opus custom frame. More... | |
int | opus_custom_decoder_ctl (OpusCustomDecoder *OPUS_RESTRICT st, int request,...) |
Perform a CTL function on an Opus custom decoder. More... |
In addition to the interoperability limitations the use of Opus custom disables a substantial chunk of the codec and generally lowers the quality available at a given bitrate. Normally when an application needs a different frame size from the codec it should buffer to match the sizes but this adds a small amount of delay which may be important in some very low latency applications. Some transports (especially constant rate RF transports) may also work best with frames of particular durations.
Libopus only supports custom modes if they are enabled at compile time.
The Opus Custom API is similar to the regular API but the opus_encoder_create and opus_decoder_create calls take an additional mode parameter which is a structure produced by a call to opus_custom_mode_create. Both the encoder and decoder must create a mode using the same sample rate (fs) and frame size (frame size) so these parameters must either be signaled out of band or fixed in a particular implementation.
Similar to regular Opus the custom modes support on the fly frame size switching, but the sizes available depend on the particular frame size in use. For some initial frame sizes on a single on the fly size is available.
|
State of the decoder. Decoder state. One decoder state is needed for each stream. It is initialized once at the beginning of the stream. Do *not* re-initialize the state for every frame. |
|
Contains the state of an encoder. Encoder state. One encoder state is needed for each stream. It is initialized once at the beginning of the stream. Do *not* re-initialize the state for every frame. |
|
The mode contains all the information necessary to create an encoder. Mode configuration. Both the encoder and decoder need to be initialized with exactly the same mode, otherwise the output will be corrupted. |
|
Decode an opus custom frame.
|
|
Decode an opus custom frame with floating point output.
|
|
Creates a new decoder state. Each stream needs its own decoder state (can't be shared across simultaneous streams).
|
|
Perform a CTL function on an Opus custom decoder. Generally the request and subsequent arguments are generated by a convenience macro.
|
|
Destroys a an decoder state.
|
|
Gets the size of an OpusCustomDecoder structure.
|
|
Initializes a previously allocated decoder state The memory pointed to by st must be the size returned by opus_custom_decoder_get_size. This is intended for applications which use their own allocator instead of malloc.
|
|
Encodes a frame of audio.
|
|
Encodes a frame of audio.
|
|
Creates a new encoder state. Each stream needs its own encoder state (can't be shared across simultaneous streams).
|
|
Perform a CTL function on an Opus custom encoder. Generally the request and subsequent arguments are generated by a convenience macro.
|
|
Destroys a an encoder state.
|
|
Gets the size of an OpusCustomEncoder structure.
|
|
Initializes a previously allocated encoder state The memory pointed to by st must be the size returned by opus_custom_encoder_get_size. This is intended for applications which use their own allocator instead of malloc.
|
|
Creates a new mode struct. This will be passed to an encoder or decoder. The mode MUST NOT BE DESTROYED until the encoders and decoders that use it are destroyed as well.
|
|
Destroys a mode struct. Only call this after all encoders and decoders using this mode are destroyed as well.
|
For more information visit the Opus Website. |
©$year $generatedby doxygen 1.2.11.1 |