Skip to main content

Analyzer

Struct Analyzer 

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

Incremental PCM analyzer. Push decoded audio in any block size, then finish.

Each channel is high-passed at 80 Hz for detection only, the channel powers are averaged, and every hop produces one frame level in dBFS over a window centered on that hop. Only the frame levels and signal-free flags are kept, about 1.8 MB per hour at the default 10 ms hop. Samples that are not finite (NaN or infinite) are read as zero. A frame is signal-free when all raw samples are zero or its filtered mean power is at most 1e-20 (-200 dBFS).

Implementations§

Source§

impl Analyzer

Source

pub fn new(layout: Layout, config: &AnalyzeConfig) -> Result<Self, ConfigError>

An analyzer for audio with layout.

§Errors

ConfigError::ZeroSampleRate, ConfigError::ZeroChannels, ConfigError::SampleRateTooLow if the rate is at or below 160 Hz, ConfigError::HopTooShort if the hop rounds to zero samples, or ConfigError::InvalidFrames if the hop exceeds u32::MAX samples or the window exceeds u64::MAX samples.

Source

pub fn push_interleaved<S: Sample>(&mut self, pcm: &[S])

Pushes interleaved samples. A trailing partial frame is kept until the next push.

Source

pub fn push_planar<S: Sample>(&mut self, pcm: &[&[S]])

Pushes one slice per channel.

§Panics

If the number of slices differs from the channel count, the slices differ in length, or a partial interleaved frame from push_interleaved is pending.

Source

pub fn finish(self) -> Analysis

Finishes the stream and returns the frame levels. A partial interleaved frame is dropped.

Trait Implementations§

Source§

impl Clone for Analyzer

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Analyzer

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.