- This page describes the process and functions used to encode Opus.
typedef struct OpusEncoder OpusEncoder
Opus encoder state.
int opus_encoder_get_size (int channels)
Gets the size of an OpusEncoder structure.
OpusEncoder * opus_encoder_create (opus_int32 Fs, int channels, int application, int *error)
Allocates and initializes an encoder state.
int opus_encoder_init (OpusEncoder *st, opus_int32 Fs, int channels, int application)
Initializes a previously allocated encoder state The memory pointed to by st must be at least the size returned by opus_encoder_get_size().
opus_int32 opus_encode (OpusEncoder *st, const opus_int16 *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes)
Encodes an Opus frame.
opus_int32 opus_encode_float (OpusEncoder *st, const float *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes)
Encodes an Opus frame from floating point input.
void opus_encoder_destroy (OpusEncoder *st)
Frees an OpusEncoder allocated by opus_encoder_create().
int opus_encoder_ctl (OpusEncoder *st, int request,...)
Perform a CTL function on an Opus encoder.
This page describes the process and functions used to encode Opus.
Since Opus is a stateful codec, the encoding process starts with creating an encoder state. This can be done with:
int error; OpusEncoder *enc; enc = opus_encoder_create(Fs, channels, application, &error);
From this point, enc can be used for encoding an audio stream. An encoder state must not be used for more than one stream at the same time. Similarly, the encoder state must not be re-initialized for each frame.
While opus_encoder_create() allocates memory for the state, it's also possible to initialize pre-allocated memory:
int size; int error; OpusEncoder *enc; size = opus_encoder_get_size(channels); enc = malloc(size); error = opus_encoder_init(enc, Fs, channels, application);
where opus_encoder_get_size() returns the required size for the encoder state. Note that future versions of this code may change the size, so no assuptions should be made about it.
The encoder state is always continuous in memory and only a shallow copy is sufficient to copy it (e.g. memcpy())
It is possible to change some of the encoder's settings using the opus_encoder_ctl() interface. All these settings already default to the recommended value, so they should only be changed when necessary. The most common settings one may want to change are:
opus_encoder_ctl(enc, OPUS_SET_BITRATE(bitrate)); opus_encoder_ctl(enc, OPUS_SET_COMPLEXITY(complexity)); opus_encoder_ctl(enc, OPUS_SET_SIGNAL(signal_type));
where
See Encoder related CTLs and Generic CTLs 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.
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:
len = opus_encode(enc, audio_frame, frame_size, packet, max_packet);
where
opus_encode() and opus_encode_float() return the number of bytes actually written to the packet. The return value can be negative, which indicates that an error has occurred. If the return value is 2 bytes or less, then the packet does not need to be transmitted (DTX).
Once the encoder state if no longer needed, it can be destroyed with
opus_encoder_destroy(enc);
If the encoder was created with opus_encoder_init() rather than opus_encoder_create(), then no action is required aside from potentially freeing the memory that was manually allocated for it (calling free(enc) for the example above)
Opus encoder state. This contains the complete state of an Opus encoder. It is position independent and can be freely copied.
See also
Encodes an Opus frame.
Parameters
Returns
Encodes an Opus frame from floating point input.
Parameters
Returns
Allocates and initializes an encoder state. There are three coding modes:
OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice signals. It enhances the input signal by high-pass filtering and emphasizing formants and harmonics. Optionally it includes in-band forward error correction to protect against packet loss. Use this mode for typical VoIP applications. Because of the enhancement, even at high bitrates the output may sound different from the input.
OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most non-voice signals like music. Use this mode for music and mixed (music/voice) content, broadcast, and applications requiring less than 15 ms of coding delay.
OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that disables the speech-optimized mode in exchange for slightly reduced delay. This mode can only be set on an newly initialized or freshly reset encoder because it changes the codec delay.
This is useful when the caller knows that the speech-optimized modes will not be needed (use with caution).
Parameters
Note
Perform a CTL function on an Opus encoder. Generally the request and subsequent arguments are generated by a convenience macro.
Parameters
See also
Encoder related CTLs
Frees an OpusEncoder allocated by opus_encoder_create().
Parameters
Gets the size of an OpusEncoder structure.
Parameters
Returns
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 also
Parameters
Return values
Generated automatically by Doxygen for Opus from the source code.