Skip to main content

PitchTracker

Struct PitchTracker 

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

High-level streaming pitch tracker. Combines any PitchEstimator with a linear resampler that converts the host’s sample rate to the estimator’s target rate.

Feed it mono f32 audio at input_sample_rate via process. The tracker buffers internally and returns frames as they become available.

Implementations§

Source§

impl PitchTracker

Source

pub fn new<E: PitchEstimator + 'static>( estimator: E, input_sample_rate: u32, resample_chunk: usize, ) -> Result<Self>

Build a tracker from any concrete PitchEstimator.

Source

pub fn from_boxed( estimator: Box<dyn PitchEstimator>, input_sample_rate: u32, resample_chunk: usize, ) -> Result<Self>

Build a tracker from an already-boxed estimator. Useful when the estimator type is decided at runtime (e.g. from a CLI flag).

Source

pub fn algorithm(&self) -> &str

Source

pub fn input_sample_rate(&self) -> u32

Source

pub fn target_sample_rate(&self) -> u32

Source

pub fn reset(&mut self)

Source

pub fn process(&mut self, audio: &[f32]) -> Result<Vec<PitchFrame>>

Push mono f32 audio at input_sample_rate. Returns whatever frames the estimator produced after consuming this chunk. Empty at the start of the stream and after reset while the estimator’s internal buffer fills.

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V