Struct ProcInfo

pub struct ProcInfo<'a> {
    pub frames: usize,
    pub in_silence_mask: SilenceMask,
    pub out_silence_mask: SilenceMask,
    pub clock_seconds: Range<ClockSeconds>,
    pub clock_samples: ClockSamples,
    pub transport_info: Option<TransportInfo<'a>>,
    pub stream_status: StreamStatus,
    pub declick_values: &'a DeclickValues,
}

Additional information for processing audio

Fields

frames: usize

The number of samples (in a single channel of audio) in this processing block.

Not to be confused with video frames.

in_silence_mask: SilenceMask

An optional optimization hint on which input channels contain all zeros (silence). The first bit (0b1) is the first channel, the second bit is the second channel, and so on.

out_silence_mask: SilenceMask

An optional optimization hint on which output channels contain all zeros (silence). The first bit (0b1) is the first channel, the second bit is the second channel, and so on.

clock_seconds: Range<ClockSeconds>

The current interval of time of the internal clock in units of seconds. The start of the range is the instant of time at the first sample in the block (inclusive), and the end of the range is the instant of time at the end of the block (exclusive).

This uses the clock from the OS’s audio API so it should be quite accurate, and it correctly accounts for any output underflows that may occur.

clock_samples: ClockSamples

The total number of samples (in a single channel of audio) that have been processed since the start of the audio stream.

This value can be used for more accurate timing than ProcInfo::clock_seconds, but note it does NOT account for any output underflows that may occur.

transport_info: Option<TransportInfo<'a>>

Information about the musical transport.

This will be None if no musical transport is currently active, or if the current transport is currently paused.

stream_status: StreamStatus

Flags indicating the current status of the audio stream

declick_values: &'a DeclickValues

A buffer of values that linearly ramp up/down between 0.0 and 1.0 which can be used to implement efficient declicking when pausing/resuming/stopping.