phonic 0.16.0

Audio playback library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

//! Modulation system for parameter automation.
//!
//! Provides modulation matrix architecture where sources (LFOs, envelopes, velocity, keytracking) can route to
//! target parameters with configurable depth and polarity.

use four_cc::FourCC;

use crate::parameter::{EnumParameter, FloatParameter, Parameter, ParameterPolarity};

// -------------------------------------------------------------------------------------------------

pub(crate) mod matrix;
pub(crate) mod processor;
pub(crate) mod state;

// -------------------------------------------------------------------------------------------------

/// Configuration for a modulation source for a modulation source (e.g. LFO, AHDSR envelope,
/// velocity, keytracking) within a [`ModulationConfig`] as used by [`Generator`](crate::Generator).
#[derive(Debug, Clone)]
#[allow(clippy::large_enum_variant)]
pub enum ModulationSource {
    /// LFO with rate and waveform parameters.
    Lfo {
        id: FourCC,
        name: &'static str,
        rate_param: FloatParameter,
        waveform_param: EnumParameter,
    },
    /// AHDSR envelope with attack, hold, decay, sustain, and release parameters.
    Envelope {
        id: FourCC,
        name: &'static str,
        attack_param: FloatParameter,
        hold_param: FloatParameter,
        decay_param: FloatParameter,
        sustain_param: FloatParameter,
        release_param: FloatParameter,
    },
    /// Velocity (static per note, no parameters).
    Velocity { id: FourCC, name: &'static str },
    /// Keytracking (static per note, no parameters).
    Keytracking { id: FourCC, name: &'static str },
}

impl ModulationSource {
    /// Get the source ID.
    pub fn id(&self) -> FourCC {
        match self {
            Self::Lfo { id, .. } => *id,
            Self::Envelope { id, .. } => *id,
            Self::Velocity { id, .. } => *id,
            Self::Keytracking { id, .. } => *id,
        }
    }

    /// Get the source name.
    pub fn name(&self) -> &'static str {
        match self {
            Self::Lfo { name, .. } => name,
            Self::Envelope { name, .. } => name,
            Self::Velocity { name, .. } => name,
            Self::Keytracking { name, .. } => name,
        }
    }

    /// Get parameter descriptors for this modulation source.
    pub fn parameters(&self) -> Vec<&dyn Parameter> {
        match self {
            Self::Lfo {
                rate_param,
                waveform_param,
                ..
            } => vec![rate_param as &dyn Parameter, waveform_param],
            Self::Envelope {
                attack_param,
                hold_param,
                decay_param,
                sustain_param,
                release_param,
                ..
            } => vec![
                attack_param as &dyn Parameter,
                hold_param,
                decay_param,
                sustain_param,
                release_param,
            ],
            Self::Velocity { .. } | Self::Keytracking { .. } => vec![],
        }
    }

    /// Get the polarity of this modulation source.
    pub fn polarity(&self) -> ParameterPolarity {
        match self {
            Self::Lfo { .. } => ParameterPolarity::Bipolar,
            Self::Envelope { .. } | Self::Velocity { .. } | Self::Keytracking { .. } => {
                ParameterPolarity::Unipolar
            }
        }
    }
}

// -------------------------------------------------------------------------------------------------

/// Identifies a modulatable target parameter by ID and name within a [`ModulationSource`]
/// as used by [`Generator`](crate::Generator).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ModulationTarget {
    id: FourCC,
    name: &'static str,
}

impl ModulationTarget {
    /// Create a new modulation target.
    pub const fn new(id: FourCC, name: &'static str) -> Self {
        Self { id, name }
    }

    /// Unique identifier for this modulation source.
    #[inline]
    pub const fn id(&self) -> FourCC {
        self.id
    }

    /// Human-readable name for display.
    #[inline]
    pub const fn name(&self) -> &'static str {
        self.name
    }
}

// -------------------------------------------------------------------------------------------------

/// Defines available modulation sources and targets for a [`Generator`](crate::Generator).
#[derive(Debug, Clone, Default)]
pub struct ModulationConfig {
    /// Available modulation sources
    pub sources: Vec<ModulationSource>,
    /// Parameters that can receive modulation
    pub targets: Vec<ModulationTarget>,
}

impl ModulationConfig {
    /// Get all modulation source parameters of all configs.
    pub fn source_parameters(&self) -> Vec<Box<dyn Parameter>> {
        self.sources
            .iter()
            .flat_map(|source_config| {
                source_config
                    .parameters()
                    .iter()
                    .map(|p| p.dyn_clone())
                    .collect::<Vec<_>>()
            })
            .collect()
    }
}