webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Typedefs | Functions
Opus Custom

Typedefs

typedef struct OpusCustomEncoder OpusCustomEncoder
 Encoder state. More...
 
typedef struct OpusCustomDecoder OpusCustomDecoder
 Decoder state. More...
 
typedef struct OpusCustomMode OpusCustomMode
 Mode configuration. More...
 

Functions

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomMode * opus_custom_mode_create (opus_int32 Fs, int frame_size, int *error)
 
OPUS_CUSTOM_EXPORT void opus_custom_mode_destroy (OpusCustomMode *mode)
 
OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_encoder_get_size (const OpusCustomMode *mode, int channels) OPUS_ARG_NONNULL(1)
 
OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomEncoder * opus_custom_encoder_create (const OpusCustomMode *mode, int channels, int *error) OPUS_ARG_NONNULL(1)
 
OPUS_CUSTOM_EXPORT void opus_custom_encoder_destroy (OpusCustomEncoder *st)
 
OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode_float (OpusCustomEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4)
 
OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode (OpusCustomEncoder *st, const opus_int16 *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4)
 
OPUS_CUSTOM_EXPORT int opus_custom_encoder_ctl (OpusCustomEncoder *OPUS_RESTRICT st, int request,...) OPUS_ARG_NONNULL(1)
 
OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_decoder_get_size (const OpusCustomMode *mode, int channels) OPUS_ARG_NONNULL(1)
 
OPUS_CUSTOM_EXPORT_STATIC int opus_custom_decoder_init (OpusCustomDecoder *st, const OpusCustomMode *mode, int channels) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2)
 
OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomDecoder * opus_custom_decoder_create (const OpusCustomMode *mode, int channels, int *error) OPUS_ARG_NONNULL(1)
 
OPUS_CUSTOM_EXPORT void opus_custom_decoder_destroy (OpusCustomDecoder *st)
 
OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode_float (OpusCustomDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4)
 
OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode (OpusCustomDecoder *st, const unsigned char *data, int len, opus_int16 *pcm, int frame_size) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4)
 
OPUS_CUSTOM_EXPORT int opus_custom_decoder_ctl (OpusCustomDecoder *OPUS_RESTRICT st, int request,...) OPUS_ARG_NONNULL(1)
 

Detailed Description

Opus Custom is an optional part of the Opus specification and reference implementation which uses a distinct API from the regular API and supports frame sizes that are not normally supported. Use of Opus Custom is discouraged for all but very special applications for which a frame size different from 2.5, 5, 10, or 20 ms is needed (for either complexity or latency reasons) and where interoperability is less important.

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.

Typedef Documentation

◆ OpusCustomDecoder

typedef struct OpusCustomDecoder OpusCustomDecoder

Decoder state.

State of the decoder. 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.

◆ OpusCustomEncoder

typedef struct OpusCustomEncoder OpusCustomEncoder

Encoder state.

Contains the state of an encoder. 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.

◆ OpusCustomMode

typedef struct OpusCustomMode OpusCustomMode

Mode configuration.

The mode contains all the information necessary to create an encoder. Both the encoder and decoder need to be initialized with exactly the same mode, otherwise the output will be corrupted.

Function Documentation

◆ opus_custom_decode()

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode ( OpusCustomDecoder *  st,
const unsigned char *  data,
int  len,
opus_int16 *  pcm,
int  frame_size 
)

Decode an opus custom frame

Parameters
[in]stOpusCustomDecoder*: Decoder state
[in]datachar*: Input payload. Use a NULL pointer to indicate packet loss
[in]lenint: Number of bytes in payload
[out]pcmopus_int16*: Output signal (interleaved if 2 channels). length is frame_size*channels*sizeof(opus_int16)
[in]frame_sizeNumber of samples per channel of available space in *pcm.
Returns
Number of decoded samples or Error codes

◆ opus_custom_decode_float()

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT 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

Parameters
[in]stOpusCustomDecoder*: Decoder state
[in]datachar*: Input payload. Use a NULL pointer to indicate packet loss
[in]lenint: Number of bytes in payload
[out]pcmfloat*: Output signal (interleaved if 2 channels). length is frame_size*channels*sizeof(float)
[in]frame_sizeNumber of samples per channel of available space in *pcm.
Returns
Number of decoded samples or Error codes

◆ opus_custom_decoder_create()

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomDecoder* opus_custom_decoder_create ( const OpusCustomMode *  mode,
int  channels,
int *  error 
)

Creates a new decoder state. Each stream needs its own decoder state (can't be shared across simultaneous streams).

Parameters
[in]modeOpusCustomMode: Contains all the information about the characteristics of the stream (must be the same characteristics as used for the encoder)
[in]channelsint: Number of channels
[out]errorint*: Returns an error code
Returns
Newly created decoder state.

◆ opus_custom_decoder_ctl()

OPUS_CUSTOM_EXPORT int opus_custom_decoder_ctl ( OpusCustomDecoder *OPUS_RESTRICT  st,
int  request,
  ... 
)

Perform a CTL function on an Opus custom decoder.

Generally the request and subsequent arguments are generated by a convenience macro.

See also
Generic CTLs

◆ opus_custom_decoder_destroy()

OPUS_CUSTOM_EXPORT void opus_custom_decoder_destroy ( OpusCustomDecoder *  st)

Destroys a an decoder state.

Parameters
[in]stOpusCustomDecoder*: State to be freed.

◆ opus_custom_decoder_get_size()

OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_decoder_get_size ( const OpusCustomMode *  mode,
int  channels 
)

Gets the size of an OpusCustomDecoder structure.

Parameters
[in]modeOpusCustomMode *: Mode configuration
[in]channelsint: Number of channels
Returns
size

◆ opus_custom_decoder_init()

OPUS_CUSTOM_EXPORT_STATIC 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. This is intended for applications which use their own allocator instead of malloc.

See also
opus_custom_decoder_create(),opus_custom_decoder_get_size() To reset a previously initialized state use the OPUS_RESET_STATE CTL.
Parameters
[in]stOpusCustomDecoder*: Decoder state
[in]modeOpusCustomMode *: Contains all the information about the characteristics of the stream (must be the same characteristics as used for the encoder)
[in]channelsint: Number of channels
Returns
OPUS_OK Success or Error codes

◆ opus_custom_encode()

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode ( OpusCustomEncoder *  st,
const opus_int16 *  pcm,
int  frame_size,
unsigned char *  compressed,
int  maxCompressedBytes 
)

Encodes a frame of audio.

Parameters
[in]stOpusCustomEncoder*: Encoder state
[in]pcmopus_int16*: PCM audio in signed 16-bit format (native endian). There must be exactly frame_size samples per channel.
[in]frame_sizeint: Number of samples per frame of input signal
[out]compressedchar *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.
[in]maxCompressedBytesint: Maximum number of bytes to use for compressing the frame (can change from one frame to another)
Returns
Number of bytes written to "compressed". If negative, an error has occurred (see error codes). It is IMPORTANT that the length returned be somehow transmitted to the decoder. Otherwise, no decoding is possible.

◆ opus_custom_encode_float()

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode_float ( OpusCustomEncoder *  st,
const float *  pcm,
int  frame_size,
unsigned char *  compressed,
int  maxCompressedBytes 
)

Encodes a frame of audio.

Parameters
[in]stOpusCustomEncoder*: Encoder state
[in]pcmfloat*: PCM audio in float format, 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. There must be exactly frame_size samples per channel.
[in]frame_sizeint: Number of samples per frame of input signal
[out]compressedchar *: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.
[in]maxCompressedBytesint: Maximum number of bytes to use for compressing the frame (can change from one frame to another)
Returns
Number of bytes written to "compressed". If negative, an error has occurred (see error codes). It is IMPORTANT that the length returned be somehow transmitted to the decoder. Otherwise, no decoding is possible.

◆ opus_custom_encoder_create()

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomEncoder* opus_custom_encoder_create ( const OpusCustomMode *  mode,
int  channels,
int *  error 
)

Creates a new encoder state. Each stream needs its own encoder state (can't be shared across simultaneous streams).

Parameters
[in]modeOpusCustomMode*: Contains all the information about the characteristics of the stream (must be the same characteristics as used for the decoder)
[in]channelsint: Number of channels
[out]errorint*: Returns an error code
Returns
Newly created encoder state.

◆ opus_custom_encoder_ctl()

OPUS_CUSTOM_EXPORT int opus_custom_encoder_ctl ( OpusCustomEncoder *OPUS_RESTRICT  st,
int  request,
  ... 
)

Perform a CTL function on an Opus custom encoder.

Generally the request and subsequent arguments are generated by a convenience macro.

See also
Encoder related CTLs

◆ opus_custom_encoder_destroy()

OPUS_CUSTOM_EXPORT void opus_custom_encoder_destroy ( OpusCustomEncoder *  st)

Destroys a an encoder state.

Parameters
[in]stOpusCustomEncoder*: State to be freed.

◆ opus_custom_encoder_get_size()

OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_encoder_get_size ( const OpusCustomMode *  mode,
int  channels 
)

Gets the size of an OpusCustomEncoder structure.

Parameters
[in]modeOpusCustomMode *: Mode configuration
[in]channelsint: Number of channels
Returns
size

◆ opus_custom_mode_create()

OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomMode* opus_custom_mode_create ( opus_int32  Fs,
int  frame_size,
int *  error 
)

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.

Parameters
[in]Fsint: Sampling rate (8000 to 96000 Hz)
[in]frame_sizeint: Number of samples (per channel) to encode in each packet (64 - 1024, prime factorization must contain zero or more 2s, 3s, or 5s and no other primes)
[out]errorint*: Returned error code (if NULL, no error will be returned)
Returns
A newly created mode

◆ opus_custom_mode_destroy()

OPUS_CUSTOM_EXPORT void opus_custom_mode_destroy ( OpusCustomMode *  mode)

Destroys a mode struct. Only call this after all encoders and decoders using this mode are destroyed as well.

Parameters
[in]modeOpusCustomMode*: Mode to be freed.
Generated by   doxygen 1.8.13