Struct aubio_rs::Pitch

pub struct Pitch { /* fields omitted */ }

Pitch detection object

Methods

impl Pitch

pub fn new(
    method: PitchMode,
    buf_size: usize,
    hop_size: usize,
    sample_rate: u32
) -> Result<Self>

Creation of the pitch detection object

• method Pitch detection algorithm
• buf_size Size of the input buffer to analyse
• hop_size Step size between two consecutive analysis instant
• sample_rate Sampling rate of the signal

pub fn with_tolerance(self, tolerance: f32) -> Self

Change yin or yinfft tolerance threshold

pub fn with_silence(self, silence: f32) -> Self

Set the silence threshold of the pitch detection object

pub fn with_unit(self, unit: PitchUnit) -> Self

Set the output unit of the pitch detection object

pub fn get_hop(&self) -> usize

Get hop size

pub fn do_<'i, 'o, I, O>(&mut self, input: I, output: O) -> Status where
    I: Into<FVec<'i>>,
    O: Into<FVecMut<'o>>, 

Execute pitch detection on an input signal frame

• input Input signal of size hop_size
• output Output pitch candidates of size 1

pub fn do_result<'i, I>(&mut self, input: I) -> Result<f32> where
    I: Into<FVec<'i>>, 

Execute pitch detection on an input signal frame

• input Input signal of size hop_size

pub fn set_tolerance(&mut self, tolerance: f32)

Change yin or yinfft tolerance threshold

pub fn get_tolerance(&self) -> f32

Get yin or yinfft tolerance threshold

pub fn set_silence(&mut self, silence: f32)

Set the silence threshold of the pitch detection object

pub fn get_silence(&self) -> f32

Get the silence threshold of the pitch detection object

pub fn set_unit(&mut self, unit: PitchUnit)

Set the output unit of the pitch detection object

pub fn get_confidence(&self) -> f32

Get the current confidence of the pitch algorithm

Trait Implementations

impl Drop for Pitch

fn drop(&mut self)

Executes the destructor for this type.