Struct Collector 

pub struct Collector { /* private fields */ }

Buffers audio for later analysis.

The collector is designed to be placed in the audio thread, buffering audio chunks for the Analyzer to analyze later.

Implementations

impl Collector

pub fn initialize(&mut self, config: &ProcessorConfig) -> Result<(), AicError>

Configures the collector for specific audio settings.

This function must be called before buffering any audio. For the lowest delay use the sample rate and frame size returned by Model::optimal_sample_rate and Model::optimal_num_frames.

Arguments

• config - Audio buffering configuration

Returns

Returns Ok(()) on success or an AicError if initialization fails.

Warning

Do not call from audio processing threads as this allocates memory.

Note

All channels are mixed to mono for buffering. To buffer channels independently, create separate Collector instances.

Example

let config = ProcessorConfig::optimal(&model);
collector.initialize(&config)?;

pub fn buffer_planar<V: AsRef<[f32]>>( &mut self, audio: &[V], ) -> Result<(), AicError>

Buffers audio with separate buffers for each channel (planar layout).

Memory Layout:

• Separate buffer for each channel
• Each buffer contains num_frames floats
• Maximum of 16 channels supported
• Example for 2 channels, 4 frames:

  audio[0] -> [ch0_f0, ch0_f1, ch0_f2, ch0_f3]
  audio[1] -> [ch1_f0, ch1_f1, ch1_f2, ch1_f3]

The function accepts any type of collection of f32 values that implements as_mut, e.g.:

• [vec![0.0; 128]; 2]
• [[0.0; 128]; 2]
• [&mut ch1, &mut ch2]

Arguments

• audio - Array of mutable channel buffer slices to be buffered. Each channel buffer must be exactly of size num_frames, or if allow_variable_frames was enabled, less than the initialization value.

Notes

• All channels are mixed to mono for buffering. To buffer channels independently, create separate Collector instances.
• Maximum supported number of channels is 16. Exceeding this will return an error.

Returns

Returns Ok(()) on success or an AicError if buffering fails.

Example

let config = ProcessorConfig::optimal(&model).with_num_channels(2);
collector.initialize(&config)?;
let audio = vec![vec![0.0f32; config.num_frames]; config.num_channels as usize];
collector.buffer_planar(&audio)?;

pub fn buffer_interleaved(&mut self, audio: &[f32]) -> Result<(), AicError>

Buffers audio with interleaved channel data.

Memory Layout:

• Single contiguous buffer with samples alternating between channels
• Buffer size: num_channels * num_frames floats
• Example for 2 channels, 4 frames:

  audio -> [ch0_f0, ch1_f0, ch0_f1, ch1_f1, ch0_f2, ch1_f2, ch0_f3, ch1_f3]

Arguments

• audio - Interleaved audio buffer to be buffered. Must be exactly of size num_channels * num_frames, or if allow_variable_frames was enabled, less than the initialization value per channel.

Note

All channels are mixed to mono for buffering. To buffer channels independently, create separate Collector instances.

Returns

Returns Ok(()) on success or an AicError if buffering fails.

Example

let config = ProcessorConfig::optimal(&model).with_num_channels(2);
collector.initialize(&config)?;
let audio = vec![0.0f32; config.num_channels as usize * config.num_frames];
collector.buffer_interleaved(&audio)?;

pub fn buffer_sequential(&mut self, audio: &[f32]) -> Result<(), AicError>

Buffers audio with sequential channel data.

Memory Layout:

• Single contiguous buffer with all samples for each channel stored sequentially
• Buffer size: num_channels * num_frames floats
• Example for 2 channels, 4 frames:

  audio -> [ch0_f0, ch0_f1, ch0_f2, ch0_f3, ch1_f0, ch1_f1, ch1_f2, ch1_f3]

Arguments

• audio - Sequential audio buffer to be buffered. Must be exactly of size num_channels * num_frames, or if allow_variable_frames was enabled, less than the initialization value per channel.

Note

All channels are mixed to mono for buffering. To buffer channels independently, create separate Collector instances.

Returns

Returns Ok(()) on success or an AicError if buffering fails.

Example

let config = ProcessorConfig::optimal(&model).with_num_channels(2);
collector.initialize(&config)?;
let audio = vec![0.0f32; config.num_channels as usize * config.num_frames];
collector.buffer_sequential(&audio)?;

Trait Implementations

impl Drop for Collector

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Collector

impl Sync for Collector