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>
impl<T: Transcendental> SimpleFmSynth<T>
Sourcepub fn new(carrier_freq: f32, modulator_ratio: f32, modulation_index: T) -> Self
pub fn new(carrier_freq: f32, modulator_ratio: f32, modulation_index: T) -> Self
Create a new FM synthesizer
§Arguments
carrier_freq- carrier frequency in Hzmodulator_ratio- frequency ratio (modulator/carrier)modulation_index- modulation index (0.0 - 10.0)
Sourcepub fn with_carrier_waveform(self, waveform: Waveform) -> Self
pub fn with_carrier_waveform(self, waveform: Waveform) -> Self
Set carrier waveform
Default is sine wave
Sourcepub fn with_modulator_waveform(self, waveform: Waveform) -> Self
pub fn with_modulator_waveform(self, waveform: Waveform) -> Self
Set modulator waveform
Default is sine wave
Sourcepub fn set_carrier_frequency(&mut self, freq: f32)
pub fn set_carrier_frequency(&mut self, freq: f32)
Set carrier frequency
Sourcepub fn set_modulation_index(&mut self, index: T)
pub fn set_modulation_index(&mut self, index: T)
Sourcepub fn modulation_index(&self) -> T
pub fn modulation_index(&self) -> T
Get current modulation index
Trait Implementations§
Source§impl<T: Transcendental> Algorithm<T> for SimpleFmSynth<T>
impl<T: Transcendental> Algorithm<T> for SimpleFmSynth<T>
Source§fn process(
&mut self,
_input: Option<&[T]>,
output: &mut [T],
) -> ProcessResult<()>
fn process( &mut self, _input: Option<&[T]>, output: &mut [T], ) -> ProcessResult<()>
Process one block of signal. Read more
Source§fn metadata(&self) -> AlgorithmMetadata
fn metadata(&self) -> AlgorithmMetadata
Descriptive metadata (defaults to empty).
Source§fn apply_command(&mut self, _value: T)
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>
impl<T: Clone + Transcendental> Clone for SimpleFmSynth<T>
Source§fn clone(&self) -> SimpleFmSynth<T>
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)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl<T: Copy + Transcendental> Copy for SimpleFmSynth<T>
Source§impl<T: Transcendental> Generator<T> for SimpleFmSynth<T>
impl<T: Transcendental> Generator<T> for SimpleFmSynth<T>
Source§fn set_frequency(&mut self, freq: f32)
fn set_frequency(&mut self, freq: f32)
Set frequency
Source§fn set_amplitude(&mut self, amp: T)
fn set_amplitude(&mut self, amp: T)
Set amplitude
Source§fn reset_phase(&mut self)
fn reset_phase(&mut self)
Reset phase to 0
Source§impl<T: Transcendental> ModulatableGenerator<T> for SimpleFmSynth<T>
impl<T: Transcendental> ModulatableGenerator<T> for SimpleFmSynth<T>
Source§fn modulate_frequency(&mut self, amount: T)
fn modulate_frequency(&mut self, amount: T)
Apply frequency modulation Read more
Source§fn modulation_index(&self) -> T
fn modulation_index(&self) -> T
Modulation index (current FM amount)
Source§fn set_modulation_index(&mut self, index: T)
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more