Struct decibel::AmplitudeRatio

pub struct AmplitudeRatio<T: Float>(pub T);

An amplitude value.

Methods

impl<T: Float> AmplitudeRatio<T>

fn amplitude_value(&self) -> T

Returns the wrapped amplitude value.

Trait Implementations

impl<T: Copy + Float> Copy for AmplitudeRatio<T>

impl<T: Clone + Float> Clone for AmplitudeRatio<T>

fn clone(&self) -> AmplitudeRatio<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Float> Debug for AmplitudeRatio<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: PartialEq + Float> PartialEq for AmplitudeRatio<T>

fn eq(&self, __arg_0: &AmplitudeRatio<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &AmplitudeRatio<T>) -> bool

This method tests for !=.

impl<T: Float + Constants> From<DecibelRatio<T>> for AmplitudeRatio<T>

Converts from a decibel value into an amplitude.

Example

Let's say we want to scale our audio by 10dB. To figure out how much we need to scale each sample by, let's convert this into an amplitude ratio:

extern crate decibel;

use decibel::{AmplitudeRatio, DecibelRatio};

fn main() {
    // A +10dB gain should require us to scale each sample by around
    // 3.1622776601683795.
    let result: AmplitudeRatio<_> = DecibelRatio(10.0).into();
    let expected_amplitude = 3.1622776601683795;
    assert!(result.amplitude_value() >= expected_amplitude - 0.001
         && result.amplitude_value() <= expected_amplitude + 0.001);
}

To scale our audio by 10dB, we need to scale each sample by approximately 3.162 times.

fn from(decibels: DecibelRatio<T>) -> AmplitudeRatio<T>

Performs the conversion.