dhwani 0.1.1

A real-time audio processing engine for DAWs
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
extern crate dhwani;

use std::{fs::File, sync::Arc};

use anyhow::anyhow;
use cpal::{
    SupportedStreamConfig,
    traits::{DeviceTrait, HostTrait, StreamTrait},
};
use crossbeam_channel::{Receiver, Sender, bounded};
use dhwani::{
    channel::ChannelPositionsMask,
    controller::{CtrlRingBufReceiver, CtrlSender, start_controller},
    event, events,
    midi_note::MidiNote,
    nodes::{self, SampleInfo},
    time::{SampleRateBaseType, TimeFrom, TimeRange, TimeUnit},
};
use eframe::{
    App, Frame,
    egui::{self},
};
use egui_plot::{Line, Plot, PlotPoints};
use symphonia::{
    core::{
        audio::sample::Sample,
        codecs::audio::AudioDecoderOptions,
        formats::{FormatOptions, TrackType, probe::Hint},
        io::MediaSourceStream,
        meta::MetadataOptions,
    },
    default::{get_codecs, get_probe},
};

const BUFFER_SIZE: usize = 44100 / 10;
const STRIDE: usize = BUFFER_SIZE / 5;
const CHANNEL_MASK: ChannelPositionsMask = ChannelPositionsMask::from_bits(
    ChannelPositionsMask::FRONT_LEFT.bits() | ChannelPositionsMask::FRONT_RIGHT.bits(),
)
.unwrap();

pub struct PlotData {
    i: usize,
    data: Vec<f32>,
    sender: Sender<Vec<f32>>,
}

impl PlotData {
    pub fn new(sender: Sender<Vec<f32>>) -> Self {
        Self {
            i: 0usize,
            data: vec![0f32; BUFFER_SIZE],
            sender,
        }
    }

    pub fn push(&mut self, buffer: &[f32]) {
        for value in buffer {
            self.data[BUFFER_SIZE - STRIDE + self.i] = *value;
            self.i += 1;
            if self.i >= STRIDE {
                self.i = 0;
                let _ = self.sender.try_send(self.data.clone());
                for i in 0..BUFFER_SIZE - STRIDE {
                    self.data[i] = self.data[STRIDE + i];
                }
            }
        }
    }
}

pub struct Plotter {
    is_playing: bool,
    data: [f32; BUFFER_SIZE / 2],
    receiver: Receiver<Vec<f32>>,
    ctrl_sender: CtrlSender,
}

impl Plotter {
    pub fn new(receiver: Receiver<Vec<f32>>, ctrl_sender: CtrlSender) -> Self {
        Self {
            is_playing: true,
            data: [0f32; BUFFER_SIZE / 2],
            receiver,
            ctrl_sender,
        }
    }

    pub fn play(&mut self, is_playing: bool) {
        self.is_playing = is_playing;
        println!("Play: {is_playing}");
        let ctrl_sender = self.ctrl_sender.clone();
        tokio::spawn(async move {
            let _ = ctrl_sender.play(is_playing).await;
        });
    }

    pub fn demo(&mut self) {
        println!("Demo");
        let ctrl_sender = self.ctrl_sender.clone();
        tokio::spawn(async move {
            if let Err(e) = ctrl_sender.clear().await {
                eprintln!("Failed to clear, {e:?}");
                return;
            }
            // Piano -> Output(L)
            // Piano -> Output(R)
            let track_id = match ctrl_sender
                .add_track(TimeRange::new(TimeUnit::Seconds(0f64), None))
                .await
            {
                Ok(id) => id,
                Err(e) => {
                    eprintln!("Failed to add track, {e:?}");
                    return;
                }
            };
            // Simple piano
            let simple_piano_node_id = match ctrl_sender
                .add_node(
                    track_id,
                    Box::new(nodes::SimplePianoProps::new(
                        CHANNEL_MASK,
                        events![
                            (
                                0,
                                TimeUnit::Samples(0),
                                event::EventData::NoteOn {
                                    note: MidiNote::from_midi_str("C4").unwrap(), // C4
                                    vel: 1f32,
                                }
                            ),
                            (0, TimeUnit::Seconds(1f64), event::EventData::NoteOff),
                            (
                                0, // Since previous note ends, reusing the same event id
                                TimeUnit::Seconds(2f64),
                                event::EventData::NoteOn {
                                    note: MidiNote::from_midi_str("D4").unwrap(), // D4
                                    vel: 1f32,
                                }
                            ),
                            (0, TimeUnit::Seconds(4f64), event::EventData::NoteOff),
                            (
                                0,
                                TimeUnit::Seconds(5f64),
                                event::EventData::NoteOn {
                                    note: MidiNote::from_midi_str("E4").unwrap(), // E4
                                    vel: 1f32,
                                }
                            ),
                            (0, TimeUnit::Seconds(20f64), event::EventData::NoteOff),
                        ],
                    )),
                )
                .await
            {
                Ok(node_id) => node_id,
                Err(e) => {
                    eprintln!("Failed to add Node, {e:?}");
                    return;
                }
            };
            // Sampler
            let info = match get_sample_info(
                "core/examples/giomilko-c-major-9-bossa-nova-guitar.wav".into(),
            ) {
                Ok(id) => id,
                Err(e) => {
                    eprintln!("Failed to get sample info, {e:?}");
                    return;
                }
            };
            let sampler_node_id = match ctrl_sender
                .add_node(track_id, Box::new(nodes::SamplerProps::new(info).unwrap()))
                .await
            {
                Ok(node_id) => node_id,
                Err(e) => {
                    eprintln!("Failed to add Node, {e:?}");
                    return;
                }
            };
            // Mixer
            let simple_mixer_node_id = match ctrl_sender
                .add_node(
                    track_id,
                    Box::new(nodes::SimpleMixerProps::new(
                        CHANNEL_MASK,
                        vec![0.1f32, 0.5f32],
                    )),
                )
                .await
            {
                Ok(node_id) => node_id,
                Err(e) => {
                    eprintln!("Failed to add Node, {e:?}");
                    return;
                }
            };
            // Connect simple piano to mixer
            if let Err(e) = ctrl_sender
                .connect_nodes(simple_piano_node_id, simple_mixer_node_id)
                .await
            {
                eprintln!("Failed to connect, {e:?}");
            }
            // Connect sampler to mixer
            if let Err(e) = ctrl_sender
                .connect_nodes(sampler_node_id, simple_mixer_node_id)
                .await
            {
                eprintln!("Failed to connect, {e:?}");
            }
            // Set output port
            if let Err(e) = ctrl_sender
                .set_output_port(Some((
                    simple_mixer_node_id,
                    nodes::SimpleMixerProps::PORT_ID_OUTPUT,
                )))
                .await
            {
                eprintln!("Failed to set output port, {e:?}");
                return;
            }
            let _ = ctrl_sender.play(true).await;
        });
    }
}

impl App for Plotter {
    fn ui(&mut self, ui: &mut egui::Ui, _frame: &mut Frame) {
        let mut should_close = false;
        let ctx = ui.ctx().clone();
        ctx.input(|i| {
            for event in &i.events {
                if let egui::Event::Key {
                    key,
                    pressed,
                    modifiers,
                    ..
                } = event
                    && *pressed
                {
                    match *key {
                        egui::Key::R => {
                            self.demo();
                        }
                        egui::Key::Q => {
                            should_close = true;
                        }
                        egui::Key::Space => {
                            self.play(!self.is_playing);
                        }
                        egui::Key::Comma => {
                            if !modifiers.command {
                                let time = TimeUnit::Seconds(-4f64);
                                println!("Set Time to {time:?} from current");
                                let ctrl_sender = self.ctrl_sender.clone();
                                tokio::spawn(async move {
                                    let _ = ctrl_sender.set_time(TimeFrom::Current(time)).await;
                                });
                            } else {
                                println!("Set Time to start");
                                let ctrl_sender = self.ctrl_sender.clone();
                                tokio::spawn(async move {
                                    let _ = ctrl_sender
                                        .set_time(TimeFrom::Start(TimeUnit::default()))
                                        .await;
                                });
                            }
                        }
                        egui::Key::Period => {
                            if !modifiers.command {
                                let time = TimeUnit::Seconds(4f64);
                                println!("Set Time to {time:?} from current");
                                let ctrl_sender = self.ctrl_sender.clone();
                                tokio::spawn(async move {
                                    let _ = ctrl_sender.set_time(TimeFrom::Current(time)).await;
                                });
                            } else {
                                println!("Set Time to end");
                                let ctrl_sender = self.ctrl_sender.clone();
                                tokio::spawn(async move {
                                    let _ = ctrl_sender
                                        .set_time(TimeFrom::End(TimeUnit::default()))
                                        .await;
                                });
                            }
                        }
                        #[cfg(feature = "debug")]
                        egui::Key::P => {
                            println!("Render graph");
                            let ctrl_sender = self.ctrl_sender.clone();
                            tokio::spawn(async move {
                                let _ = ctrl_sender.debug_render_graph("graph.html".into()).await;
                            });
                        }
                        _ => {}
                    }
                }
            }
        });
        if should_close {
            ctx.send_viewport_cmd(egui::ViewportCommand::Close);
            return;
        }
        // update your data here
        let points: PlotPoints<'_> = PlotPoints::from_ys_f32(&self.data);
        let line = Line::new("left", points).color(egui::Color32::from_rgb(100, 200, 100));
        egui::CentralPanel::default().show_inside(ui, |ui| {
            Plot::new("live")
                .show_axes(true)
                .default_y_bounds(-1.5f64, 1.5f64)
                .view_aspect(2.0)
                .show(ui, |plot_ui| {
                    plot_ui.line(line);
                });
        });
        if !self.is_playing {
            return;
        }
        if let Ok(data) = self.receiver.try_recv() {
            for i in 0..data.len() / 2 {
                self.data[i] = data[i * 2];
            }
        }
        ctx.request_repaint(); // keep redrawing for live update
    }
}

#[tokio::main(flavor = "multi_thread")]
async fn main() -> Result<(), anyhow::Error> {
    let host: cpal::Host = cpal::default_host();
    let device: cpal::Device = host
        .default_output_device()
        .ok_or_else(|| anyhow::Error::msg("Default output device is not available"))?;
    println!("Output device : {}", device.description()?);
    let default_config = device.default_output_config()?;
    let sample_rate = default_config.sample_rate();
    let config: SupportedStreamConfig = SupportedStreamConfig::new(
        default_config.channels(),
        sample_rate,
        *default_config.buffer_size(),
        default_config.sample_format(),
    );
    println!("Output config : {config:?}");
    let (ctrl_sender, ctrl_receiver) =
        start_controller(sample_rate, default_config.channels(), 1024);
    let (sender, receiver) = bounded::<Vec<f32>>(1);
    let stream = make_stream(&device, config.into(), sender, ctrl_receiver)?;
    println!("Stream playing...");
    let _ = stream.play();
    let options = eframe::NativeOptions::default();
    {
        eframe::run_native(
            "dhwani",
            options,
            Box::new(move |_cc| {
                let mut plotter = Plotter::new(receiver, ctrl_sender);
                plotter.demo();
                Ok(Box::new(plotter))
            }),
        )
        .map_err(|_| anyhow::Error::msg("Run native failed"))?;
    }
    println!("Exiting main");
    Ok(())
}

pub fn make_stream(
    device: &cpal::Device,
    config: cpal::StreamConfig,
    sender: Sender<Vec<f32>>,
    ctrl_receiver: CtrlRingBufReceiver,
) -> Result<cpal::Stream, anyhow::Error> {
    let mut plot_data = PlotData::new(sender);
    let stream: cpal::Stream = device.build_output_stream(
        config,
        move |output: &mut [f32], _output_callback_info: &cpal::OutputCallbackInfo| {
            match ctrl_receiver.get(output) {
                Ok(read) => {
                    if read != output.len() {
                        // eprintln!("Buffer underrun, read = {}/{}!", read, output.len());
                    }
                }
                Err(e) => {
                    eprintln!("{e:?}");
                }
            }
            plot_data.push(output);
            // output.fill(0f32);
        },
        |err| eprintln!("Error building output sound stream: {err}"),
        None,
    )?;
    Ok(stream)
}

fn get_sample_info(path: String) -> Result<SampleInfo, anyhow::Error> {
    // ref: https://github.com/pdeljanov/Symphonia/blob/main/symphonia/examples/getting-started.rs
    let src = File::open(path)?;
    let mss = MediaSourceStream::new(Box::new(src), Default::default());
    let hint = Hint::new();
    // Use the default options for metadata and format readers.
    let meta_opts: MetadataOptions = Default::default();
    let fmt_opts: FormatOptions = Default::default();
    // Probe the media source.
    let mut format = get_probe().probe(&hint, mss, fmt_opts, meta_opts)?;
    // Find the first audio track with a known (decodeable) codec.
    let track = format
        .default_track(TrackType::Audio)
        .ok_or_else(|| anyhow!("No audio track"))?;
    // Use the default options for the decoder.
    let dec_opts: AudioDecoderOptions = Default::default();
    // Create a decoder for the track.
    let mut decoder = get_codecs().make_audio_decoder(
        track
            .codec_params
            .as_ref()
            .ok_or_else(|| anyhow!("Codec parameters missing"))?
            .audio()
            .unwrap(),
        &dec_opts,
    )?;
    // Store the track identifier, it will be used to filter packets.
    let track_id = track.id;
    let mut samples = Vec::<f32>::new();
    let mut sample_rate: SampleRateBaseType = 0;
    let mut n_channels: u16 = 0;
    let mut n_samples_per_ch: usize = 0;
    // The decode loop.
    loop {
        // Get the next packet from the media format.
        let packet = match format.next_packet()? {
            Some(packet) => packet,
            None => {
                // Reached the end of the stream.
                break;
            }
        };
        // Consume any new metadata that has been read since the last packet.
        while !format.metadata().is_latest() {
            // Pop the old head of the metadata queue.
            format.metadata().pop();
            // Consume the new metadata at the head of the metadata queue.
        }
        // If the packet does not belong to the selected track, skip over it.
        if packet.track_id != track_id {
            continue;
        }
        // Decode the packet into audio samples.
        let audio_buf = decoder.decode(&packet)?;
        if n_channels == 0 {
            n_channels = audio_buf.spec().channels().count() as u16;
        }
        if sample_rate == 0 {
            sample_rate = audio_buf.spec().rate();
        }
        n_samples_per_ch += audio_buf.samples_planar();
        let len = samples.len();
        samples.resize(len + audio_buf.samples_interleaved(), f32::MID);
        audio_buf.copy_to_slice_interleaved(&mut samples[len..]);
    }
    Ok(SampleInfo::new(
        0,
        n_channels,
        n_samples_per_ch,
        Arc::new(samples),
    ))
}