audio_samples 2.0.0

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

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

#[cfg(all(feature = "plotting", feature = "transforms"))]
fn main() -> audio_samples::AudioSampleResult<()> {
    use std::time::Duration;

    use audio_samples::operations::AudioPlotting;
    use audio_samples::operations::plotting::{
        PlotUtils,
        composite::{CompositeLayout, CompositePlot},
        spectrograms::SpectrogramPlotParams,
        waveform::WaveformPlotParams,
    };
    use audio_samples::{chirp, sample_rate};

    println!("Testing CompositePlot with waveform + spectrogram...");
    // Generate a chirp signal (sweeping frequency from 200 Hz to 2000 Hz)
    let duration = Duration::from_secs_f32(2.0); // seconds
    let audio = chirp::<f32>(200.0, 2000.0, duration, sample_rate!(44100), 0.5);

    // Create waveform plot
    println!("Creating waveform plot...");
    let waveform_params = WaveformPlotParams::default();
    let waveform = audio.plot_waveform(&waveform_params)?;

    // Create spectrogram plot
    println!("Creating spectrogram plot...");
    let spec_params = SpectrogramPlotParams::mel_db();
    let spectrogram = audio.plot_spectrogram(&spec_params)?;

    // Test 1: Vertical composition (most common)
    println!("Creating vertical composite...");
    let vertical = CompositePlot::new()
        .add_plot(waveform)
        .add_plot(spectrogram)
        .layout(CompositeLayout::Vertical)
        .build()?;

    let vertical_html = vertical.html()?;
    // A composite embeds each sub-plot as a base64-encoded iframe, so we check
    // for the composite container and the embedded iframes rather than "plotly".
    assert!(
        vertical_html.contains("composite-container") && vertical_html.contains("iframe"),
        "vertical composite HTML should contain the composite container and iframes"
    );
    println!(
        "Rendered vertical composite ({} bytes)",
        vertical_html.len()
    );

    // Test 2: Horizontal composition
    // Create new plots since we consumed the originals
    println!("Creating horizontal composite...");
    let waveform2 = audio.plot_waveform(&waveform_params)?;
    let spectrogram2 = audio.plot_spectrogram(&spec_params)?;

    let horizontal = CompositePlot::new()
        .add_plot(waveform2)
        .add_plot(spectrogram2)
        .layout(CompositeLayout::Horizontal)
        .build()?;

    let horizontal_html = horizontal.html()?;
    assert!(
        horizontal_html.contains("composite-container") && horizontal_html.contains("iframe"),
        "horizontal composite HTML should contain the composite container and iframes"
    );
    println!(
        "Rendered horizontal composite ({} bytes)",
        horizontal_html.len()
    );

    // Test 3: Show vertical composite
    #[cfg(feature = "html_view")]
    {
        println!("Opening vertical composite in html_view...");
        vertical.show()?;
    }

    #[cfg(not(feature = "html_view"))]
    {
        println!("Note: Enable 'html_view' feature to open in html_view");
    }

    Ok(())
}