Skip to main content

FrameAdapter

Struct FrameAdapter 

Source
pub struct FrameAdapter { /* private fields */ }
Expand description

Adapts audio frames to match a VAD backend’s requirements.

Buffers incoming samples and produces frames of the exact size required by the wrapped detector. Also handles sample rate validation.

Implementations§

Source§

impl FrameAdapter

Source

pub fn new(inner: Box<dyn VoiceActivityDetector>) -> Self

Create a new frame adapter wrapping a VAD detector.

Source

pub fn capabilities(&self) -> &VadCapabilities

Returns the capabilities of the wrapped detector.

Source

pub fn sample_rate(&self) -> u32

Returns the required sample rate.

Source

pub fn frame_size(&self) -> usize

Returns the required frame size in samples.

Source

pub fn process( &mut self, samples: &[i16], sample_rate: u32, ) -> Result<Option<f32>, VadError>

Process audio samples, buffering until a complete frame is available.

Returns Some(probability) when a complete frame was processed, or None if more samples are needed.

§Arguments
  • samples - Audio samples (any length)
  • sample_rate - Sample rate of the input audio
§Errors

Returns an error if the sample rate doesn’t match the detector’s requirements.

Source

pub fn process_all( &mut self, samples: &[i16], sample_rate: u32, ) -> Result<Vec<f32>, VadError>

Process all complete frames in the buffer.

Returns a vector of probabilities, one for each complete frame processed. Useful when you want to process multiple frames at once.

Source

pub fn process_latest( &mut self, samples: &[i16], sample_rate: u32, ) -> Result<f32, VadError>

Returns the last probability from processing, or 0.0 if no frame was complete.

This is a convenience method for real-time processing where you only care about the most recent result.

Source

pub fn reset(&mut self)

Reset the adapter and the wrapped detector.

Source

pub fn buffered_samples(&self) -> usize

Returns the number of samples currently buffered.

Source

pub fn timings(&self) -> ProcessTimings

Returns accumulated processing timings from the inner detector.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,