Struct replaygain::ReplayGain

source ·
pub struct ReplayGain { /* private fields */ }

Implementations§

source§

impl ReplayGain

source

pub fn new(sample_rate: usize) -> Option<ReplayGain>

Create a new ReplayGain filter for the given sample rate. Returns None if the sample rate is not supported.

source

pub fn frame_size(&self) -> usize

Returns the size of a single audio frame (one of which we analyze at a time) in floats. Note that because we expect stereo audio, this means that you need to divide this by 2 to get the number of samples.

source

pub fn process_frame(&mut self, frame: &[f32])

Processes a single audio frame.

Panics

Panics if frame.len() != self.frame_size() or if there’s anything in process_samples’s buffer. If you need buffering, use process_samples() and only that instead.

source

pub fn process_samples(&mut self, frame: &[f32])

Processes a given amount of audio samples.

Note that because we expect stereo audio, it doesn’t actually make sense to pass an odd number of floats to this function but we buffer it to chunks of frame_size() anyways so we don’t care.

source

pub fn finish(self) -> (f32, f32)

Completes the analysis and returns the two replaygain values (gain, peak).

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.