Struct Stem 

pub struct Stem { /* private fields */ }

The stem: native-rate samples with mid and side, the beat grid, the band edge, the flat-top flag and the stereo screen.

Implementations

impl Stem

pub fn new( audio: Audio, grid: BeatGrid, notes: Option<&NoteList>, ) -> Result<Self, ConfidenceError>

Builds the stem. The median f0 of notes picks the frame length and feeds the stereo phase; without notes the frame is 4096 samples and every phase is None.

Errors

Never in practice; the reasons are built from counts and flags.

pub fn audio(&self) -> &Audio

Returns the decoded audio with every channel.

pub fn sample_rate(&self) -> SampleRate

Returns the sample rate.

pub fn duration(&self) -> Seconds

Returns the length.

pub fn mid(&self) -> &[f64]

Returns the mid, M = (L + R) / 2: the mono signal of every non-stereo estimate. A one-channel file’s mid is its channel; a file of three or more channels mixes only the first two, as the side and the stereo screen read them.

pub fn side(&self) -> Option<Vec<f64>>

Returns the side, S = (L - R) / 2, computed on demand to spare memory, or None for a one-channel file.

pub fn grid(&self) -> BeatGrid

Returns the beat grid.

pub fn median_f0(&self) -> Option<Hz>

Returns the median f0 of the note list, if one was given.

pub fn frame_len(&self) -> usize

Returns the frame length of harmonic analysis: at 44.1 kHz 8192 below a median f0 of 100 Hz, else 4096, and 4096 without a note list. At another rate the length is the power of two nearest, in log, to that length times fs / 44100, so the frame keeps its duration within a factor of the square root of 2: 32 and 48 kHz keep 4096 and 8192, 96 kHz takes 8192 and 16384.

pub fn band_edge(&self) -> &Estimate<Hz, Hz>

Returns the band edge: the highest frequency that stays above the noise floor. A filter cutoff within one octave of it is never reported.

pub fn hard_limited(&self) -> bool

Returns whether the stem is flat-topped at its peak, as a limiter or clipping leaves it, in either of its first two channels.

pub fn stereo(&self) -> &StereoScreen

Returns the stereo screen of the whole stem.

Trait Implementations

impl Clone for Stem

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stem

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

Formats the value using the given formatter.

impl PartialEq for Stem

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Stem