Trait culsynth::DspFormatBase

pub trait DspFormatBase: Sized + Copy + Default + Send {
    type Sample: DspType<Self>;
    type Note: DspType<Self>;
    type NoteOffset: DspType<Self>;
    type Frequency: DspType<Self>;
    type Scalar: DspType<Self>;
    type IScalar: DspType<Self>;
    type EnvParam: DspType<Self>;
    type EnvSignal: EnvType<Self> + Send;
    type Phase: DspType<Self>;
    type LfoFreq: DspType<Self>;
    type WideSample: Copy + Default + Add<Self::WideSample, Output = Self::WideSample>;
    type Context: Send + GetContext;

    // Required methods
    fn default_note() -> Self::Note;
    fn note_to_freq(note: Self::Note) -> Self::Frequency;
    fn sample_from_fixed(value: IScalarFxP) -> Self::Sample;
    fn sample_to_float(value: Self::Sample) -> f32;
    fn widen_sample(smp: Self::Sample) -> Self::WideSample;
    fn narrow_sample(wide_smp: Self::WideSample) -> Self::Sample;
    fn note_from_scalar(scalar: Self::Scalar) -> Self::Note;
    fn apply_note_offset(
        note: Self::Note,
        offset: Self::NoteOffset
    ) -> Self::Note;
}

Type aliases defining the data types of various internal signals within the synthesizer. This is primariliy to be generic over fixed/floating point

Required Associated Types

type Sample: DspType<Self>

A type representing a sample of audio data

type Note: DspType<Self>

A type representing a MIDI note number

type NoteOffset: DspType<Self>

A type representing an offset to a MIDI note number

type Frequency: DspType<Self>

A type representing a frequency

type Scalar: DspType<Self>

A type representing a value between 0 and 1

type IScalar: DspType<Self>

A type representing a value between -1 and 1

type EnvParam: DspType<Self>

A type representing a parameter to an envelope

type EnvSignal: EnvType<Self> + Send

A type representing internal envelope signal levels

type Phase: DspType<Self>

A type representing the phase of a sinusoid

type LfoFreq: DspType<Self>

A type representing the frequency of a LFO

type WideSample: Copy + Default + Add<Self::WideSample, Output = Self::WideSample>

A type representing a sample that may have higher precision/range

type Context: Send + GetContext

Type-specific context information

Required Methods

fn default_note() -> Self::Note

Provide a value of the default note, definied as A440 (MIDI NN #69)

fn note_to_freq(note: Self::Note) -> Self::Frequency

Convert a midi Note into a Frequency

fn sample_from_fixed(value: IScalarFxP) -> Self::Sample

Convert a signed scalar to a Sample

fn sample_to_float(value: Self::Sample) -> f32

Convert a sample to a 32 bit float

fn widen_sample(smp: Self::Sample) -> Self::WideSample

Widen a sample to a WideSample

fn narrow_sample(wide_smp: Self::WideSample) -> Self::Sample

Narrow a WideSample to a Sample

fn note_from_scalar(scalar: Self::Scalar) -> Self::Note

Convert a Scalar to a Note (where 0 maps to the lowest representable note, and 1 maps to the highest)

fn apply_note_offset(note: Self::Note, offset: Self::NoteOffset) -> Self::Note

Apply a note offset

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl DspFormatBase for i16

type Sample = FixedI16<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>>

type Note = FixedU16<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>

type NoteOffset = FixedI16<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>

type Frequency = FixedU32<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>, B0>>

type Scalar = FixedU16<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>>

type IScalar = FixedI16<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B1>>

type EnvParam = FixedU16<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B1>>

type EnvSignal = FixedI32<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B0>, B1>>

type Phase = FixedI32<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B0>, B0>>

type LfoFreq = FixedU16<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>

type WideSample = FixedI32<<FixedI16<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>> as Fixed>::Frac>

type Context = ContextFxP

fn default_note() -> Self::Note

fn note_to_freq(note: NoteFxP) -> FrequencyFxP

fn sample_from_fixed(value: IScalarFxP) -> Self::Sample

fn sample_to_float(value: Self::Sample) -> f32

fn widen_sample(smp: Self::Sample) -> Self::WideSample

fn narrow_sample(wide_smp: Self::WideSample) -> SampleFxP

fn note_from_scalar(scalar: ScalarFxP) -> NoteFxP

fn apply_note_offset(note: NoteFxP, offset: SignedNoteFxP) -> NoteFxP

Implementors

impl<T> DspFormatBase for T

where T: From<IScalarFxP> + From<NoteFxP> + Float + Send,

type Sample = T

type Note = T

type NoteOffset = T

type Frequency = T

type Scalar = T

type IScalar = T

type EnvParam = T

type EnvSignal = T

type Phase = T

type LfoFreq = T

type WideSample = T

type Context = Context<T>