$treeview $search $mathjax
|
|
$projectbrief
|
$searchbox |
opus_encode_ctl
interface.
More...Defines | |
#define | OPUS_SET_COMPLEXITY(x) |
Configures the encoder's computational complexity. More... | |
#define | OPUS_GET_COMPLEXITY(x) |
Gets the encoder's complexity configuration. More... | |
#define | OPUS_SET_BITRATE(x) |
Configures the bitrate in the encoder. More... | |
#define | OPUS_GET_BITRATE(x) |
Gets the encoder's bitrate configuration. More... | |
#define | OPUS_SET_VBR(x) |
Enables or disables variable bitrate (VBR) in the encoder. More... | |
#define | OPUS_GET_VBR(x) |
Determine if variable bitrate (VBR) is enabled in the encoder. More... | |
#define | OPUS_SET_VBR_CONSTRAINT(x) |
Enables or disables constrained VBR in the encoder. More... | |
#define | OPUS_GET_VBR_CONSTRAINT(x) |
Determine if constrained VBR is enabled in the encoder. More... | |
#define | OPUS_SET_FORCE_CHANNELS(x) |
Configures mono/stereo forcing in the encoder. More... | |
#define | OPUS_GET_FORCE_CHANNELS(x) |
Gets the encoder's forced channel configuration. More... | |
#define | OPUS_SET_MAX_BANDWIDTH(x) |
Configures the maximum bandpass that the encoder will select automatically. More... | |
#define | OPUS_GET_MAX_BANDWIDTH(x) |
Gets the encoder's configured maximum allowed bandpass. More... | |
#define | OPUS_SET_BANDWIDTH(x) |
Sets the encoder's bandpass to a specific value. More... | |
#define | OPUS_SET_SIGNAL(x) |
Configures the type of signal being encoded. More... | |
#define | OPUS_GET_SIGNAL(x) |
Gets the encoder's configured signal type. More... | |
#define | OPUS_SET_APPLICATION(x) |
Configures the encoder's intended application. More... | |
#define | OPUS_GET_APPLICATION(x) |
Gets the encoder's configured application. More... | |
#define | OPUS_GET_SAMPLE_RATE(x) |
Gets the sampling rate the encoder or decoder was initialized with. More... | |
#define | OPUS_GET_LOOKAHEAD(x) |
Gets the total samples of delay added by the entire codec. More... | |
#define | OPUS_SET_INBAND_FEC(x) |
Configures the encoder's use of inband forward error correction (FEC). More... | |
#define | OPUS_GET_INBAND_FEC(x) |
Gets encoder's configured use of inband forward error correction. More... | |
#define | OPUS_SET_PACKET_LOSS_PERC(x) |
Configures the encoder's expected packet loss percentage. More... | |
#define | OPUS_GET_PACKET_LOSS_PERC(x) |
Gets the encoder's configured packet loss percentage. More... | |
#define | OPUS_SET_DTX(x) |
Configures the encoder's use of discontinuous transmission (DTX). More... | |
#define | OPUS_GET_DTX(x) |
Gets encoder's configured use of discontinuous transmission. More... | |
#define | OPUS_SET_LSB_DEPTH(x) |
Configures the depth of signal being encoded. More... | |
#define | OPUS_GET_LSB_DEPTH(x) |
Gets the encoder's configured signal depth. More... | |
#define | OPUS_GET_LAST_PACKET_DURATION(x) |
Gets the duration (in samples) of the last packet successfully decoded or concealed. More... |
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:
int ret; ret = opus_encoder_ctl(enc_ctx, OPUS_SET_BANDWIDTH(OPUS_AUTO)); if (ret != OPUS_OK) return ret; opus_int32 rate; opus_encoder_ctl(enc_ctx, OPUS_GET_BANDWIDTH(&rate)); opus_encoder_ctl(enc_ctx, OPUS_RESET_STATE);
|
Gets the encoder's configured application.
|
|
Gets the encoder's bitrate configuration.
|
|
Gets the encoder's complexity configuration.
|
|
Gets encoder's configured use of discontinuous transmission.
|
|
Gets the encoder's forced channel configuration.
|
|
Gets encoder's configured use of inband forward error correction.
|
|
Gets the duration (in samples) of the last packet successfully decoded or concealed.
|
|
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.
|
|
Gets the encoder's configured signal depth.
|
|
Gets the encoder's configured maximum allowed bandpass.
|
|
Gets the encoder's configured packet loss percentage.
|
|
Gets the sampling rate the encoder or decoder was initialized with.
This simply returns the
|
|
Gets the encoder's configured signal type.
|
|
Determine if variable bitrate (VBR) is enabled in the encoder.
|
|
Determine if constrained VBR is enabled in the encoder.
|
|
Configures the encoder's intended application. The initial value is a mandatory argument to the encoder_create function.
|
|
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.
|
|
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.
|
|
Configures the encoder's computational complexity. The supported range is 0-10 inclusive with 10 representing the highest complexity.
|
|
Configures the encoder's use of discontinuous transmission (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.
|
|
Configures the encoder's use of inband forward error correction (FEC).
|
|
Configures the depth of signal being encoded. This is a hint which helps the encoder identify silence and near-silence.
|
|
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.
|
|
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.
|
|
Configures the type of signal being encoded. This is a hint which helps the encoder's mode selection.
|
|
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.
|
|
Enables or disables constrained VBR in the encoder. This setting is ignored when the encoder is in CBR mode.
|
For more information visit the Opus Website. |
©$year $generatedby doxygen 1.2.11.1 |