Interface AudioNodeProcessor

crates/firewheel-core/src/node.rs:486–564

The trait describing the realtime processor counterpart to an audio node.

/// The trait describing the realtime processor counterpart to an
/// audio node.
pub trait AudioNodeProcessor: 'static + Send {
    /// Called when there are new events for this node to process.
    ///
    /// This is called once before the first call to `process`, and after that
    /// it will be called whenever there are new events (including when the
    /// node is bypassed).
    ///
    /// Unless this node is bypassed, then [`AudioNodeProcessor::process`] will be
    /// called immediately after.
    ///
    /// * `info` - Information about this processing block.
    /// * `events` - A list of events for this node to process.
    /// * `extra` - Additional buffers and utilities.
    ///
    /// This is always called in a realtime thread, so do not perform any
    /// realtime-unsafe operations.
    fn events(&mut self, info: &ProcInfo, events: &mut ProcEvents, extra: &mut ProcExtra) {
        let _ = info;
        let _ = events;
        let _ = extra;
    }

    /// Called when the node has been fully bypassed/un-bypassed.
    ///
    /// The Firewheel processor automatically handles bypass declicking, so
    /// there is no need to handle that manually.
    ///
    /// This is always called in a realtime thread, so do not perform any
    /// realtime-unsafe operations.
    fn bypassed(&mut self, bypassed: bool) {
        let _ = bypassed;
    }

    /// Process the given block of audio.
    ///
    /// * `info` - Information about this processing block.
    /// * `buffers` - The buffers of data to process.
    /// * `extra` - Additional buffers and utilities.
    ///
    /// WARNING: Audio nodes *MUST* either completely fill all output buffers
    /// with data, or return [`ProcessStatus::ClearAllOutputs`]/[`ProcessStatus::Bypass`].
    /// Failing to do this will result in audio glitches. If using
    /// [`AudioNodeInfo::in_place_buffers`], then the output buffers in the
    /// range `[0..num_inputs_in_config.min(num_outputs_in_config)]` do not
    /// need to be filled with data.
    ///
    /// This is always called in a realtime thread, so do not perform any
    /// realtime-unsafe operations.
    fn process(
        &mut self,
        info: &ProcInfo,
        buffers: ProcBuffers,
        extra: &mut ProcExtra,
    ) -> ProcessStatus {
        let _ = info;
        let _ = buffers;
        let _ = extra;