These are convenience macros for use with the opus_encode_ctl
interface.
More...
Detailed Description
These are convenience macros for use with the opus_encode_ctl
interface.
They are used to generate the appropriate series of arguments for that call, passing the correct type, size and so on as expected for each particular request.
Some usage examples:
- See also:
- Generic CTLs, Opus Encoder
Define Documentation
Gets the encoder's bitrate configuration.
- See also:
- OPUS_SET_BITRATE
- Parameters:
-
[out] | x | opus_int32 * : Returns the bitrate in bits per second. The default is determined based on the number of channels and the input sampling rate. |
Gets the encoder's complexity configuration.
- See also:
- OPUS_SET_COMPLEXITY
- Parameters:
-
[out] | x | opus_int32 * : Returns a value in the range 0-10, inclusive. |
Gets encoder's configured use of discontinuous transmission.
- See also:
- OPUS_SET_DTX
- Parameters:
-
[out] | x | opus_int32 * : Returns one of the following values:
- 0
- DTX disabled (default).
- 1
- DTX enabled.
|
Gets the encoder's forced channel configuration.
- See also:
- OPUS_SET_FORCE_CHANNELS
- Parameters:
-
[out] | x | opus_int32 * :
- OPUS_AUTO
- Not forced (default)
- 1
- Forced mono
- 2
- Forced stereo
|
Gets encoder's configured use of inband forward error correction.
- See also:
- OPUS_SET_INBAND_FEC
- Parameters:
-
[out] | x | opus_int32 * : Returns one of the following values:
- 0
- Inband FEC disabled (default).
- 1
- Inband FEC enabled.
|
Gets the duration (in samples) of the last packet successfully decoded or concealed.
- Parameters:
-
[out] | x | opus_int32 * : Number of samples (at current sampling rate). |
Gets the total samples of delay added by the entire codec.
This can be queried by the encoder and then the provided number of samples can be skipped on from the start of the decoder's output to provide time aligned input and output. From the perspective of a decoding application the real data begins this many samples late.
The decoder contribution to this delay is identical for all decoders, but the encoder portion of the delay may vary from implementation to implementation, version to version, or even depend on the encoder's initial configuration. Applications needing delay compensation should call this CTL rather than hard-coding a value.
- Parameters:
-
[out] | x | opus_int32 * : Number of lookahead samples |
Gets the encoder's configured signal depth.
- See also:
- OPUS_SET_LSB_DEPTH
- Parameters:
-
[out] | x | opus_int32 * : Input precision in bits, between 8 and 24 (default: 24). |
Gets the encoder's configured packet loss percentage.
- See also:
- OPUS_SET_PACKET_LOSS_PERC
- Parameters:
-
[out] | x | opus_int32 * : Returns the configured loss percentage in the range 0-100, inclusive (default: 0). |
Gets the sampling rate the encoder or decoder was initialized with.
This simply returns the Fs
value passed to opus_encoder_init() or opus_decoder_init().
- Parameters:
-
[out] | x | opus_int32 * : Sampling rate of encoder or decoder. |
Gets the encoder's configured signal type.
- See also:
- OPUS_SET_SIGNAL
- Parameters:
-
Determine if variable bitrate (VBR) is enabled in the encoder.
- See also:
- OPUS_SET_VBR
-
OPUS_GET_VBR_CONSTRAINT
- Parameters:
-
[out] | x | opus_int32 * : Returns one of the following values:
- 0
- Hard CBR.
- 1
VBR (default). The exact type of VBR may be retrieved via
OPUS_GET_VBR_CONSTRAINT.
|
Determine if constrained VBR is enabled in the encoder.
- See also:
- OPUS_SET_VBR_CONSTRAINT
-
OPUS_GET_VBR
- Parameters:
-
[out] | x | opus_int32 * : Returns one of the following values:
- 0
- Unconstrained VBR.
- 1
- Constrained VBR (default).
|
Configures the encoder's intended application.
The initial value is a mandatory argument to the encoder_create function.
- See also:
- OPUS_GET_APPLICATION
- Parameters:
-
Sets the encoder's bandpass to a specific value.
This prevents the encoder from automatically selecting the bandpass based on the available bitrate. If an application knows the bandpass of the input audio it is providing, it should normally use OPUS_SET_MAX_BANDWIDTH instead, which still gives the encoder the freedom to reduce the bandpass when the bitrate becomes too low, for better overall quality.
- See also:
- OPUS_GET_BANDWIDTH
- Parameters:
-
Configures the bitrate in the encoder.
Rates from 500 to 512000 bits per second are meaningful, as well as the special values OPUS_AUTO and OPUS_BITRATE_MAX. The value OPUS_BITRATE_MAX can be used to cause the codec to use as much rate as it can, which is useful for controlling the rate by adjusting the output buffer size.
- See also:
- OPUS_GET_BITRATE
- Parameters:
-
[in] | x | opus_int32 : Bitrate in bits per second. The default is determined based on the number of channels and the input sampling rate. |
Configures the encoder's computational complexity.
The supported range is 0-10 inclusive with 10 representing the highest complexity.
- See also:
- OPUS_GET_COMPLEXITY
- Parameters:
-
[in] | x | opus_int32 : Allowed values: 0-10, inclusive. |
Configures the encoder's use of discontinuous transmission (DTX).
- Note:
- This is only applicable to the LPC layer
- See also:
- OPUS_GET_DTX
- Parameters:
-
[in] | x | opus_int32 : Allowed values:
- 0
- Disable DTX (default).
- 1
- Enabled DTX.
|
Configures mono/stereo forcing in the encoder.
This can force the encoder to produce packets encoded as either mono or stereo, regardless of the format of the input audio. This is useful when the caller knows that the input signal is currently a mono source embedded in a stereo stream.
- See also:
- OPUS_GET_FORCE_CHANNELS
- Parameters:
-
[in] | x | opus_int32 : Allowed values:
- OPUS_AUTO
- Not forced (default)
- 1
- Forced mono
- 2
- Forced stereo
|
Configures the encoder's use of inband forward error correction (FEC).
- Note:
- This is only applicable to the LPC layer
- See also:
- OPUS_GET_INBAND_FEC
- Parameters:
-
[in] | x | opus_int32 : Allowed values:
- 0
- Disable inband FEC (default).
- 1
- Enable inband FEC.
|
Configures the depth of signal being encoded.
This is a hint which helps the encoder identify silence and near-silence.
- See also:
- OPUS_GET_LSB_DEPTH
- Parameters:
-
[in] | x | opus_int32 : Input precision in bits, between 8 and 24 (default: 24). |
Configures the maximum bandpass that the encoder will select automatically.
Applications should normally use this instead of OPUS_SET_BANDWIDTH (leaving that set to the default, OPUS_AUTO). This allows the application to set an upper bound based on the type of input it is providing, but still gives the encoder the freedom to reduce the bandpass when the bitrate becomes too low, for better overall quality.
- See also:
- OPUS_GET_MAX_BANDWIDTH
- Parameters:
-
[in] | x | opus_int32 : Allowed values:
- OPUS_BANDWIDTH_NARROWBAND
- 4 kHz passband
- OPUS_BANDWIDTH_MEDIUMBAND
- 6 kHz passband
- OPUS_BANDWIDTH_WIDEBAND
- 8 kHz passband
- OPUS_BANDWIDTH_SUPERWIDEBAND
- 12 kHz passband
- OPUS_BANDWIDTH_FULLBAND
- 20 kHz passband (default)
|
Configures the encoder's expected packet loss percentage.
Higher values with trigger progressively more loss resistant behavior in the encoder at the expense of quality at a given bitrate in the lossless case, but greater quality under loss.
- See also:
- OPUS_GET_PACKET_LOSS_PERC
- Parameters:
-
[in] | x | opus_int32 : Loss percentage in the range 0-100, inclusive (default: 0). |
Configures the type of signal being encoded.
This is a hint which helps the encoder's mode selection.
- See also:
- OPUS_GET_SIGNAL
- Parameters:
-
Enables or disables variable bitrate (VBR) in the encoder.
The configured bitrate may not be met exactly because frames must be an integer number of bytes in length.
- Warning:
- Only the MDCT mode of Opus can provide hard CBR behavior.
- See also:
- OPUS_GET_VBR
-
OPUS_SET_VBR_CONSTRAINT
- Parameters:
-
[in] | x | opus_int32 : Allowed values:
- 0
- Hard CBR. For LPC/hybrid modes at very low bit-rate, this can cause noticeable quality degradation.
- 1
VBR (default). The exact type of VBR is controlled by
OPUS_SET_VBR_CONSTRAINT.
|
Enables or disables constrained VBR in the encoder.
This setting is ignored when the encoder is in CBR mode.
- Warning:
- Only the MDCT mode of Opus currently heeds the constraint. Speech mode ignores it completely, hybrid mode may fail to obey it if the LPC layer uses more bitrate than the constraint would have permitted.
- See also:
- OPUS_GET_VBR_CONSTRAINT
-
OPUS_SET_VBR
- Parameters:
-
[in] | x | opus_int32 : Allowed values:
- 0
- Unconstrained VBR.
- 1
- Constrained VBR (default). This creates a maximum of one frame of buffering delay assuming a transport with a serialization speed of the nominal bitrate.
|