audio_samples 1.0.5

A typed audio processing library for Rust that treats audio as a first-class, invariant-preserving object rather than an unstructured numeric buffer.
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

#[cfg(not(all(feature = "plotting", feature = "statistics")))]
fn main() {
    eprintln!("error: This example requires the `plotting` and `statistics` features.");
    std::process::exit(1);
}

#[cfg(all(feature = "plotting", feature = "transforms"))]
fn main() -> audio_samples::AudioSampleResult<()> {
    {
        use audio_samples::operations::{
            AudioPlotting, AudioStatistics, ChannelManagementStrategy, Layout, PlotParams,
            PlotUtils, SpectrogramPlotParams, WaveformPlotParams,
        };
        use audio_samples::sample_rate;
        println!("Creating test audio signal...");
        let duration = std::time::Duration::from_secs(2);
        let audio = audio_samples::sine_wave::<f64>(440.0, duration, sample_rate!(44100), 0.5);

        println!(
            "Audio stats: {} channels, {} samples, peak = {}",
            audio.num_channels(),
            audio.len(),
            audio.peak()
        );

        // Test waveform plot with overlays
        println!("\nCreating waveform plot with overlays...");
        let waveform_params = WaveformPlotParams::new(
            &PlotParams::new(
                Some("Waveform with Event Markers".to_string()),
                Some("Time (s)".to_string()),
                Some("Amplitude".to_string()),
                None,
                true,
                Some("Events".to_string()),
                None,
                true,
            ),
            Some(ChannelManagementStrategy::Separate(Layout::Vertical)),
            None,
            None,
            None,
            false,
            None,
        );

        let waveform_plot = audio
            .plot_waveform(&waveform_params)
            .expect("Failed to create waveform plot")
            .add_vline(0.5, Some("Event 1"), Some("red"))
            .add_vline(1.0, Some("Event 2"), Some("blue"))
            .add_vline(1.5, Some("Event 3"), Some("green"))
            .add_hline(0.0, Some("Zero"), Some("black"))
            .add_marker(0.25, 0.4, Some("Peak"), None)
            .add_shaded_region(0.8, 1.2, Some("rgba(255,200,0,0.2)"), None);

        waveform_plot
            .save("outputs/test_waveform_overlays.html")
            .expect("Failed to save waveform plot");
        println!("Saved waveform plot with overlays to outputs/test_waveform_overlays.html");

        // Test spectrogram plot with overlays
        println!("\nCreating spectrogram plot with overlays...");
        let spec_params = SpectrogramPlotParams::mel_db();
        let spec_plot = audio
            .plot_spectrogram(&spec_params)
            .expect("Failed to create spectrogram plot")
            .add_vline(0.5, Some("Onset"))
            .add_vline(1.5, Some("Offset"))
            .add_hline(440.0, Some("F0 (A4)"));

        spec_plot
            .save("outputs/test_spectrogram_overlays.html")
            .expect("Failed to save spectrogram plot");
        println!("Saved spectrogram plot with overlays to outputs/test_spectrogram_overlays.html");

        // Test pitch contour overlay
        println!("\nCreating spectrogram with pitch contour...");

        // Simulate a simple pitch contour (rising then falling)
        let n_points = 20;
        let times: Vec<f64> = (0..n_points)
            .map(|i| i as f64 * 2.0 / n_points as f64)
            .collect();
        let freqs: Vec<f64> = times
            .iter()
            .map(|&t| {
                // Sine wave modulation of frequency around 440 Hz
                440.0 + 100.0 * (t * std::f64::consts::PI).sin()
            })
            .collect();

        let spec_with_contour = audio
            .plot_spectrogram(&spec_params)
            .expect("Failed to create spectrogram plot")
            .overlay_contour(&times, &freqs, Some("F0 Contour"));

        spec_with_contour
            .save("outputs/test_spectrogram_contour.html")
            .expect("Failed to save spectrogram with contour");
        println!("Saved spectrogram with pitch contour to outputs/test_spectrogram_contour.html");
        Ok(())
    }
}