[][src]Function flac_sys::FLAC__stream_encoder_set_max_residual_partition_order

pub unsafe extern "C" fn FLAC__stream_encoder_set_max_residual_partition_order(
    encoder: *mut FLAC__StreamEncoder,
    value: c_uint
) -> FLAC__bool

Set the maximum partition order to search when coding the residual. This is used in tandem with FLAC__stream_encoder_set_min_residual_partition_order().

The partition order determines the context size in the residual. The context size will be approximately blocksize / (2 ^ order).

Set both min and max values to \c 0 to force a single context, whose Rice parameter is based on the residual signal variance. Otherwise, set a min and max order, and the encoder will search all orders, using the mean of each context for its Rice parameter, and use the best.

\default \c 0 \param encoder An encoder instance to set. \param value See above. \assert \code encoder != NULL \endcode \retval FLAC__bool \c false if the encoder is already initialized, else \c true.