Struct gaborator::Coefs

pub struct Coefs(_);

Reprepresents C++'s gaborator::coefs<float> Can be memory-hungry.

(I'm not sure whether this can be dropped after Analyzer. I see some mention of reference counting withing Gaborator library, but have not checked in detail.)

Implementations

impl Coefs

pub fn new(gab: &Gaborator) -> Self

Create new instance of Gaborator analyzer/synthesizer based on supplied parameters

pub fn forget_before(&mut self, g: &Gaborator, limit: i64, clean_cut: bool)

Allow the coefficients for points in time before limit (a time in units of samples) to be forgotten. Streaming applications can use this to free memory used by coefficients that are no longer needed. Coefficients that have been forgotten will read as zero. This does not guarantee that all coefficients before limit are forgotten, only that ones for limit or later are not, and that the amount of memory consumed by any remaining coefficients before limit is bounded.

pub fn process(
    &mut self,
    from_band: i32,
    to_band: i32,
    from_sample_time: i64,
    to_sample_time: i64,
    callback: impl FnMut(CoefMeta, &mut Coef)
)

Read or write values within Coefs, skipping over non-existent entries. Corresponds to process function of Gaborator. from_band and to_band may be given INT_MIN / INT_MAX values, that would mean all bands. from_sample_time and to_sample_time can also be given INT64_MIN / INT64_MAX value to mean all available data.

pub fn fill(
    &mut self,
    from_band: i32,
    to_band: i32,
    from_sample_time: i64,
    to_sample_time: i64,
    callback: impl FnMut(CoefMeta, &mut Coef)
)

Write values to Coefs, creating non-existent entries as needed. Corresponds to fill function of Gaborator. from_band and to_band may be given INT_MIN / INT_MAX values, that would mean all bands. from_sample_time / to_sample_time should not be set to overtly large range, lest memory will be exhausted.