Skip to main content

SimpleFmSynth

Struct SimpleFmSynth 

Source
pub struct SimpleFmSynth<T: Transcendental> { /* private fields */ }
Expand description

Simple 2-operator FM synthesizer

Basic FM architecture: one modulator modulates one carrier. Ideal for:

  • Creating metallic timbres
  • Bell-like sounds
  • Complex harmonic structures

§Example

use rill_core::time::ClockTick;
use rill_core::traits::ActionContext;
use rill_core_dsp::generators::*;
use rill_core::traits::algorithm::Algorithm;

let tick = ClockTick::default();
let ctx = ActionContext::new(&tick);

// Create FM synthesizer with 2:1 frequency ratio
let mut fm = SimpleFmSynth::<f32>::new(
    440.0,  // carrier frequency (A4)
    2.0,    // modulator one octave higher
    1.5     // modulation index
);
fm.init(44100.0);

// Generate sample
let mut output = [0.0_f32];
fm.process(None, &mut output).unwrap();
let sample = output[0];

Implementations§

Source§

impl<T: Transcendental> SimpleFmSynth<T>

Source

pub fn new(carrier_freq: f32, modulator_ratio: f32, modulation_index: T) -> Self

Create a new FM synthesizer

§Arguments
  • carrier_freq - carrier frequency in Hz
  • modulator_ratio - frequency ratio (modulator/carrier)
  • modulation_index - modulation index (0.0 - 10.0)
Source

pub fn with_carrier_waveform(self, waveform: Waveform) -> Self

Set carrier waveform

Default is sine wave

Source

pub fn with_modulator_waveform(self, waveform: Waveform) -> Self

Set modulator waveform

Default is sine wave

Source

pub fn set_carrier_frequency(&mut self, freq: f32)

Set carrier frequency

Source

pub fn set_modulation_index(&mut self, index: T)

Set modulation index

§Arguments
  • index - modulation index (0.0 - 10.0)
Source

pub fn set_ratio(&mut self, ratio: f32)

Set frequency ratio

§Arguments
  • ratio - ratio (modulator/carrier), typically 0.1 - 10.0
Source

pub fn modulation_index(&self) -> T

Get current modulation index

Source

pub fn ratio(&self) -> f32

Get current frequency ratio

Trait Implementations§

Source§

impl<T: Transcendental> Algorithm<T> for SimpleFmSynth<T>

Source§

fn init(&mut self, sample_rate: f32)

Initialise the algorithm with a sample rate. Read more
Source§

fn reset(&mut self)

Reset the algorithm to its initial state. Read more
Source§

fn process( &mut self, _input: Option<&[T]>, output: &mut [T], ) -> ProcessResult<()>

Process one block of signal. Read more
Source§

fn metadata(&self) -> AlgorithmMetadata

Descriptive metadata (defaults to empty).
Source§

fn apply_command(&mut self, _value: T)

Receive a real-time command value from the control path. Read more
Source§

impl<T: Clone + Transcendental> Clone for SimpleFmSynth<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy + Transcendental> Copy for SimpleFmSynth<T>

Source§

impl<T: Transcendental> Generator<T> for SimpleFmSynth<T>

Source§

fn phase(&self) -> T

Get current phase (0.0 - 1.0)
Source§

fn set_phase(&mut self, phase: T)

Set phase
Source§

fn frequency(&self) -> f32

Get frequency in Hz
Source§

fn set_frequency(&mut self, freq: f32)

Set frequency
Source§

fn amplitude(&self) -> T

Get amplitude
Source§

fn set_amplitude(&mut self, amp: T)

Set amplitude
Source§

fn reset_phase(&mut self)

Reset phase to 0
Source§

impl<T: Transcendental> ModulatableGenerator<T> for SimpleFmSynth<T>

Source§

fn modulate_frequency(&mut self, amount: T)

Apply frequency modulation Read more
Source§

fn modulation_index(&self) -> T

Modulation index (current FM amount)
Source§

fn set_modulation_index(&mut self, index: T)

Set modulation index

Auto Trait Implementations§

§

impl<T> Freeze for SimpleFmSynth<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for SimpleFmSynth<T>
where T: RefUnwindSafe,

§

impl<T> Send for SimpleFmSynth<T>

§

impl<T> Sync for SimpleFmSynth<T>

§

impl<T> Unpin for SimpleFmSynth<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for SimpleFmSynth<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for SimpleFmSynth<T>
where T: UnwindSafe,

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> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V