Struct ProcessingContext 

#[non_exhaustive]
pub struct ProcessingContext<'a, T: Sample> {
    pub input_buffer: &'a dyn AudioBuffer<T>,
    pub output_buffer: &'a mut dyn AudioBuffer<T>,
    pub channel_selection: Option<ChannelSelection>,
    pub num_frames: FrameSize,
}

The audio processing context used by a Processor to perform its processing operation

The context includes references to input and output buffers, an optional channel selection to specify which channels to process, and the number of frames to process.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

input_buffer: &'a dyn AudioBuffer<T>

output_buffer: &'a mut dyn AudioBuffer<T>

channel_selection: Option<ChannelSelection>

num_frames: FrameSize

Number of frames to process from each channel. This may be less than or equal to the total number of frames available in the buffers.

Implementations

impl<'a, T: Sample> ProcessingContext<'a, T>

pub fn create_unchecked( input_buffer: &'a dyn AudioBuffer<T>, output_buffer: &'a mut dyn AudioBuffer<T>, channel_selection: Option<ChannelSelection>, num_frames: FrameSize, ) -> Self

Creates a new processing context without validation

This constructor does not validate that the channel selection and frame size are within the bounds of the provided buffers. Use this method when you have already validated these parameters.

pub fn create_checked( input_buffer: &'a dyn AudioBuffer<T>, output_buffer: &'a mut dyn AudioBuffer<T>, channel_selection: ChannelSelection, num_frames: FrameSize, ) -> Self

Creates a new processing context with validation and clamping of channel selection and frame size

This constructor automatically adjusts the channel selection and frame count to ensure they do not exceed the capabilities of the provided buffers.

pub fn for_each_channel(&mut self, f: impl FnMut(&[T], &mut [T]))

Iterates over selected channels, applying a function to each input/output channel pair

This helper method simplifies the common pattern of processing audio data channel by channel. If a channel selection is specified, only those channels are processed. Otherwise, all channels up to the minimum of input and output channel counts are processed.

Example

context.for_each_channel(|input, output| {
    for (i, o) in input.iter().zip(output.iter_mut()) {
        *o = *i * 0.5; // Apply 0.5 gain
    }
});