[][src]Function libaom_sys::aom_codec_control

pub unsafe extern "C" fn aom_codec_control(
    ctx: *mut aom_codec_ctx_t,
    ctrl_id: c_int,
     ...
) -> aom_codec_err_t

\name Codec Control

The aom_codec_control function exchanges algorithm specific data with the codec instance. Additionally, the macro AOM_CODEC_CONTROL_TYPECHECKED is provided, which will type-check the parameter against the control ID before calling aom_codec_control - note that this macro requires the control ID to be directly encoded in it, e.g., AOM_CODEC_CONTROL_TYPECHECKED(&ctx, AOME_SET_CPUUSED, 8).

The codec control IDs can be found in aom.h, aomcx.h, and aomdx.h (defined as aom_com_control_id, aome_enc_control_id, and aom_dec_control_id). @{

aom_codec_control takes a context, a control ID, and a third parameter (with varying type). If the context is non-null and an error occurs, ctx->err will be set to the same value as the return value.

\param[in] ctx Pointer to this instance's context \param[in] ctrl_id Algorithm specific control identifier

\retval #AOM_CODEC_OK The control request was processed. \retval #AOM_CODEC_ERROR The control request was not processed. \retval #AOM_CODEC_INVALID_PARAM The data was not valid.