audio-lab 0.1.0

Toolkit for audio research and testing
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
159
160
161
162
163
164
165
166
167
168
169
170
171

use crate::signal::{TimeSignal, math::gain_to_db};
use eframe::egui;
use egui_plot::{Legend, Line, Plot, PlotPoint, PlotPoints};

use crate::plot::native_options_any_thread;
use crate::plot::save::SavePlotState;

const DB_FLOOR: f64 = -120.0;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum TimeValue {
    Amplitude,
    AmplitudeDb,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct TimePlotOptions {
    pub value: TimeValue,
}

impl Default for TimePlotOptions {
    fn default() -> Self {
        Self {
            value: TimeValue::Amplitude,
        }
    }
}

impl TimeValue {
    fn value(&self, sample: f64) -> f64 {
        match self {
            Self::Amplitude => sample,
            Self::AmplitudeDb => gain_to_db(sample.abs()).max(DB_FLOOR),
        }
    }

    fn y_label(&self) -> &'static str {
        match self {
            Self::Amplitude => "Amplitude",
            Self::AmplitudeDb => "Amplitude (dB)",
        }
    }
}

pub(crate) struct TimeSignalPlot {
    series: Vec<(String, Vec<PlotPoint>)>,
    options: TimePlotOptions,
    save: SavePlotState,
}

impl TimeSignalPlot {
    pub(crate) fn new(signals: &[&TimeSignal], title: &str, options: TimePlotOptions) -> Self {
        let mut series = Vec::new();
        for (signal_index, signal) in signals.iter().enumerate() {
            let time_steps = signal.time_steps();
            let num_channels = signal.num_channels();
            for (channel_index, channel) in signal.channel_iter().enumerate() {
                let label = crate::plot::legend::build_channel_label(
                    signal.channel_label(channel_index),
                    signal.comment(),
                    signal_index,
                    channel_index,
                    num_channels,
                );
                let points = time_steps
                    .iter()
                    .zip(channel.iter())
                    .map(|(&t, &y)| PlotPoint::new(t, options.value.value(y)))
                    .collect();
                series.push((label, points));
            }
        }
        Self {
            series,
            options,
            save: SavePlotState::new(title),
        }
    }
}

impl eframe::App for TimeSignalPlot {
    fn ui(&mut self, ui: &mut egui::Ui, _frame: &mut eframe::Frame) {
        egui::Panel::top("controls").show(ui, |ui| {
            self.save.show_panel(ui);
        });
        egui::CentralPanel::default().show(ui, |ui| {
            Plot::new("time_signal")
                .x_axis_label("Time (s)")
                .y_axis_label(self.options.value.y_label())
                .legend(Legend::default())
                .show(ui, |plot_ui| {
                    for (label, points) in &self.series {
                        plot_ui.line(Line::new(label.clone(), PlotPoints::Borrowed(points)));
                    }
                });
        });
        self.save.handle_screenshot(ui.ctx());
    }
}

pub fn show_time_with_options(
    title: &str,
    signals: &[&TimeSignal],
    options: TimePlotOptions,
) -> Result<(), crate::plot::Error> {
    Ok(eframe::run_native(
        title,
        native_options_any_thread(),
        Box::new(|_cc| Ok(Box::new(TimeSignalPlot::new(signals, title, options)))),
    )?)
}

pub fn show_time(title: &str, signals: &[&TimeSignal]) -> Result<(), crate::plot::Error> {
    show_time_with_options(title, signals, Default::default())
}

#[cfg(test)]
mod tests {
    use crate::signal::TimeSignal;

    use super::*;

    #[test]
    #[ignore]
    fn test_show_time_signal() {
        use crate::signal::ndarray::arr2;

        let sample_rate = 44100.0;
        let signal = TimeSignal::new(
            arr2(&[
                std::array::from_fn::<f64, 1000, _>(|i| {
                    (i as f64 / sample_rate * 440.0 * std::f64::consts::TAU).sin()
                }),
                std::array::from_fn::<f64, 1000, _>(|i| {
                    (i as f64 / sample_rate * 880.0 * std::f64::consts::TAU).sin()
                }),
            ]),
            sample_rate,
        )
        .unwrap();
        show_time("Time Signal Test", &[&signal]).unwrap();
    }

    #[test]
    #[ignore]
    fn test_show_time_signal_db() {
        use crate::signal::ndarray::arr2;

        let sample_rate = 44100.0;
        let signal = TimeSignal::new(
            arr2(&[
                std::array::from_fn::<f64, 1000, _>(|i| {
                    (i as f64 / sample_rate * 440.0 * std::f64::consts::TAU).sin()
                }),
                std::array::from_fn::<f64, 1000, _>(|i| {
                    (i as f64 / sample_rate * 880.0 * std::f64::consts::TAU).sin()
                }),
            ]),
            sample_rate,
        )
        .unwrap();
        show_time_with_options(
            "Time Signal Test (dB)",
            &[&signal],
            TimePlotOptions {
                value: TimeValue::AmplitudeDb,
            },
        )
        .unwrap();
    }
}