Params

Struct Params 

Source
#[repr(C)]
pub struct Params { pub bands_per_octave: u32, pub ff_min: f64, pub ff_ref: f64, pub overlap: f64, }
Expand description

Corresponds to gaborator::parameters.

Fields§

§bands_per_octave: u32

The number of frequency bands per octave. Values from 6 to 384 (inclusive) are supported. Values outside this range may not work, or may cause degraded performance.

§ff_min: f64

The lower limit of the analysis frequency range, in units of the sample rate. The analysis filter bank will extend low enough in frequency that ff_min falls between the two lowest frequency bandpass filters. Values from 0.001 to 0.13 are supported.

§ff_ref: f64

The reference frequency, in units of the sample rate. This allows fine-tuning of the analysis and synthesis filter banks such that the center frequency of one of the filters is aligned with ff_ref. If ff_ref falls outside the frequency range of the bandpass filter bank, this works as if the range were extended to include ff_ref. Must be positive. A typical value when analyzing music is 440.0 / fs, where fs is the sample rate in Hz.

Default value in C++ code is 1.0.

§overlap: f64

A field not documented in Gaborator reference.

Default value in C++ code is 0.7.

Trait Implementations§

Source§

impl ExternType for Params

Source§

type Kind = Trivial

Source§

type Id

A type-level representation of the type’s C++ namespace and type name. Read more

Auto Trait Implementations§

§

impl Freeze for Params

§

impl RefUnwindSafe for Params

§

impl Send for Params

§

impl Sync for Params

§

impl Unpin for Params

§

impl UnwindSafe for Params

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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 T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.