Struct Gain 

pub struct Gain { /* private fields */ }

Multiply every sample by a fixed gain.

The gain is a Q15 integer, so y = (x * g + 2^14) >> 15 (round half up) then saturate. Unity is 32768 and is byte-identical passthrough. The largest representable gain is about +30 dB (i32::MAX >> 15).

Implementations

impl Gain

pub const UNITY: Gain

Unity gain.

pub fn linear(factor: f32) -> Self

A gain from a linear factor (negative factors invert).

pub const fn from_q15(q15: i32) -> Self

A gain from a raw Q15 factor, clamped to the representable range.

The oracle test needs to reach an exact q15 – including the values either side of where the product stops fitting i32 – which going through linear cannot promise.

pub fn from_db(db: f32) -> Self

A gain from decibels.

pub const fn q15(&self) -> i32

The Q15 factor in use.

pub fn apply(&self, x: i16) -> i16

Apply this gain to one sample.

Trait Implementations

impl Clone for Gain

fn clone(&self) -> Gain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Gain

impl Debug for Gain

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

Formats the value using the given formatter.

impl Element for Gain

fn output_format(&self, input: PcmFormat) -> Result<PcmFormat>

The format this element emits for blocks in input, or Err(Unsupported) if it cannot take input at all.

fn process(&mut self, input: PcmBlock<'_>, out: &mut [u8]) -> Result<usize>

Process one block into out, returning the bytes written — a whole number of output frames, possibly zero.

fn max_output_bytes(&self, input: PcmFormat, input_bytes: usize) -> usize

Upper bound on the bytes process writes for an input block of input_bytes bytes in input. Defaults to input_bytes (same-size elements); resamplers and channel converters override it.

fn reset(&mut self)

Forget all state (filter memories, gains, phases).

impl Eq for Gain

impl PartialEq for Gain

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Gain