maudio 0.1.3

Rust bindings to the miniaudio 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
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
use std::{marker::PhantomData, mem::MaybeUninit, path::Path};

use maudio_sys::ffi as sys;

use crate::{engine::resource::rm_builder::ResourceManagerBuilder, AsRawRef, Binding, MaResult};

pub mod rm_builder;
pub mod rm_flags;

pub struct ResourceManager {
    inner: *mut sys::ma_resource_manager,
}

// ma_resource_manager is intended to be used from multiple threads
// it uses a multi-producer/multi-consumer job queue and background job threads
// NOTE: Everything else added to the Rust struct needs to be Send and Sync!!!
unsafe impl Send for ResourceManager {}
unsafe impl Sync for ResourceManager {}

impl Binding for ResourceManager {
    type Raw = *mut sys::ma_resource_manager;

    /// !!! unimplemented !!!
    fn from_ptr(_raw: Self::Raw) -> Self {
        unimplemented!()
    }

    fn to_raw(&self) -> Self::Raw {
        self.inner
    }
}

pub struct ResourceManagerRef<'a> {
    inner: *mut sys::ma_resource_manager,
    _marker: PhantomData<&'a ()>,
}

impl Binding for ResourceManagerRef<'_> {
    type Raw = *mut sys::ma_resource_manager;

    /// !!! unimplemented !!!
    fn from_ptr(raw: Self::Raw) -> Self {
        Self {
            inner: raw,
            _marker: PhantomData,
        }
    }

    fn to_raw(&self) -> Self::Raw {
        self.inner
    }
}

mod private_rm {
    use super::*;
    use maudio_sys::ffi as sys;

    pub trait RmPtrProvider<T: ?Sized> {
        fn as_rm_ptr(t: &T) -> *mut sys::ma_resource_manager;
    }

    pub struct RmProvider;
    pub struct RmRefProvider;

    impl RmPtrProvider<ResourceManager> for RmProvider {
        fn as_rm_ptr(t: &ResourceManager) -> *mut sys::ma_resource_manager {
            t.to_raw()
        }
    }

    impl RmPtrProvider<ResourceManagerRef<'_>> for RmRefProvider {
        fn as_rm_ptr(t: &ResourceManagerRef<'_>) -> *mut sys::ma_resource_manager {
            t.to_raw()
        }
    }

    pub fn rm_ptr<T: AsRmPtr + ?Sized>(t: &T) -> *mut sys::ma_resource_manager {
        <T as AsRmPtr>::__PtrProvider::as_rm_ptr(t)
    }
}

#[doc(hidden)]
pub trait AsRmPtr {
    type __PtrProvider: private_rm::RmPtrProvider<Self>;
}

impl AsRmPtr for ResourceManager {
    type __PtrProvider = private_rm::RmProvider;
}

impl AsRmPtr for ResourceManagerRef<'_> {
    type __PtrProvider = private_rm::RmRefProvider;
}

impl RmOps for ResourceManager {}
impl RmOps for ResourceManagerRef<'_> {}

pub struct ResourceRegistration<'a> {
    rm: &'a ResourceManager,
}

pub trait RmOps: AsRmPtr {
    fn register(&self) {}

    fn register_file(&self, path: &Path, flags: u32) -> MaResult<()> {
        #[cfg(unix)]
        {
            use crate::engine::cstring_from_path;

            let path = cstring_from_path(path)?;
            resource_ffi::ma_resource_manager_register_file(self, path, flags)?;
            Ok(())
        }

        #[cfg(windows)]
        {
            use crate::engine::wide_null_terminated;

            let path = wide_null_terminated(path);

            decoder_ffi::ma_resource_manager_register_file_w(self, path, flags)?;
            Ok(())
        }

        #[cfg(not(any(unix, windows)))]
        compile_error!("init decoder from file is only supported on unix and windows");
    }

    // fn register_decoder_u8<'a>(
    //     &self,
    //     name: String,
    //     data: &'a [u8],
    //     channels: u32,
    //     sample_rate: SampleRate,
    // ) -> MaResult<()> {
    //     resource_ffi::ma_resource_manager_register_decoded_data_internal::<u8, Self>(
    //         self,
    //         &name,
    //         data,
    //         Format::U8,
    //         channels,
    //         sample_rate,
    //     )
    // }

    // fn register_decoder_i16<'a>(
    //     &self,
    //     _name: String,
    //     _data: &'a [i16],
    //     _channels: u32,
    //     _sample_rate: SampleRate,
    // ) {
    // }

    // fn register_decoder_i32<'a>(
    //     &mut self,
    //     _name: String,
    //     _data: &'a [i32],
    //     _channels: u32,
    //     _sample_rate: SampleRate,
    // ) {
    // }

    // TODO: register_decoded_data does not copy, so the converted data needs to be stored somewhere else
    // fn register_decoder_s24() {}

    // fn register_decoder_s24_packed<'a>(
    //     &self,
    //     _name: String,
    //     _data: &'a [u8],
    //     _channels: u32,
    //     _sample_rate: SampleRate,
    // ) {
    // }

    // fn register_decoder_f32<'a>(
    //     &self,
    //     _name: String,
    //     _data: &'a [f32],
    //     _channels: u32,
    //     _sample_rate: SampleRate,
    // ) -> MaResult<()> {
    //     todo!()
    // }

    // fn register_decoded_data<'a, F: PcmFormat>(
    //     &mut self,
    //     name: String,
    //     data: &'a [F::PcmUnit],
    //     channels: u32,
    //     sample_rate: SampleRate
    // ) -> MaResult<()> {
    // }
}

impl ResourceManager {
    fn new_with_config(config: &ResourceManagerBuilder) -> MaResult<Self> {
        let mut mem: Box<MaybeUninit<sys::ma_resource_manager>> = Box::new(MaybeUninit::uninit());

        resource_ffi::ma_resource_manager_init(config.as_raw_ptr(), mem.as_mut_ptr())?;

        let inner: *mut sys::ma_resource_manager =
            Box::into_raw(mem) as *mut sys::ma_resource_manager;

        Ok(Self { inner })
    }
}

pub(crate) mod resource_ffi {
    use crate::engine::resource::private_rm;
    use maudio_sys::ffi as sys;
    use std::ffi::CString;

    #[cfg(unix)]
    use crate::engine::resource::{AsRmPtr, RmOps};
    use crate::{
        audio::{
            formats::{Format, SampleBuffer},
            sample_rate::SampleRate,
        },
        engine::resource::ResourceManager,
        pcm_frames::PcmFormat,
        Binding, MaResult, MaudioError,
    };

    #[inline]
    pub fn ma_resource_manager_init(
        config: *const sys::ma_resource_manager_config,
        rm: *mut sys::ma_resource_manager,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_resource_manager_init(config, rm) };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    pub fn ma_resource_manager_uninit(rm: &mut ResourceManager) {
        unsafe {
            sys::ma_resource_manager_uninit(rm.to_raw());
        }
    }

    // TODO: Implement Log
    #[inline]
    pub fn ma_resource_manager_get_log(rm: &mut ResourceManager) -> Option<*mut sys::ma_log> {
        let ptr = unsafe { sys::ma_resource_manager_get_log(rm.to_raw()) };
        if ptr.is_null() {
            None
        } else {
            Some(ptr)
        }
    }

    // REGISTRATION

    #[inline]
    #[cfg(unix)]
    pub fn ma_resource_manager_register_file<R: RmOps + ?Sized>(
        rm: &R,
        path: std::ffi::CString,
        flags: u32,
    ) -> MaResult<()> {
        let res = unsafe {
            use crate::engine::resource::private_rm;
            sys::ma_resource_manager_register_file(private_rm::rm_ptr(rm), path.as_ptr(), flags)
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(windows)]
    pub fn ma_resource_manager_register_file_w(
        rm: &ResourceManager,
        path: &[u16],
        flags: u32,
    ) -> MaResult<()> {
        let res =
            unsafe { sys::ma_resource_manager_register_file_w(rm.to_raw(), path.as_ptr(), flags) };
        MaudioError::check(res)?;
        Ok(())
    }

    fn ma_resource_manager_register_decoded_data_internal<F: PcmFormat, R: AsRmPtr + ?Sized>(
        rm: &R,
        name: &str,
        data: &[F::PcmUnit],
        format: Format,
        channels: u32,
        sample_rate: SampleRate,
    ) -> MaResult<()> {
        #[cfg(unix)]
        {
            let name = CString::new(name)
                .map_err(|_| crate::MaudioError::new_ma_error(crate::ErrorKinds::InvalidCString))?;
            let frame_count = 0;
            ma_resource_manager_register_decoded_data(
                rm,
                name.as_ptr(),
                data.as_ptr() as *const _,
                frame_count,
                format,
                channels,
                sample_rate,
            )
        }
        #[cfg(windows)]
        {
            use crate::engine::wide_null_terminated_name;

            let name = wide_null_terminated_name(name);
            ma_resource_manager_register_decoded_data_w(
                rm,
                name.as_ptr(),
                data.as_ptr() as *const _,
                frame_count,
                format,
                channels,
                sample_rate,
            )
        }

        #[cfg(not(any(unix, windows)))]
        compile_error!("init decoder from file is only supported on unix and windows");
    }

    #[inline]
    #[cfg(unix)]
    fn ma_resource_manager_register_decoded_data<R: AsRmPtr + ?Sized>(
        rm: &R,
        name: *const core::ffi::c_char,
        data: *const core::ffi::c_void,
        frame_count: u64,
        format: Format,
        channels: u32,
        sample_rate: SampleRate,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_register_decoded_data(
                private_rm::rm_ptr(rm),
                name,
                data,
                frame_count,
                format.into(),
                channels,
                sample_rate.into(),
            )
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(windows)]
    fn ma_resource_manager_register_decoded_data_w(
        rm: &ResourceManager,
        name: &[u16],
        data: *const core::ffi::c_void,
        frame_count: u64,
        format: Format,
        channels: u32,
        sample_rate: SampleRate,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_register_decoded_data_w(
                rm.to_raw(),
                name.as_ptr(),
                data,
                frame_count,
                format.into(),
                channels,
                sample_rate.into(),
            )
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(unix)]
    pub fn ma_resource_manager_register_encoded_data(
        rm: &ResourceManager,
        name: *const core::ffi::c_char,
        data: *const core::ffi::c_void,
        size: usize,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_register_encoded_data(rm.to_raw(), name, data, size)
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(windows)]
    pub fn ma_resource_manager_register_encoded_data_w(
        rm: &mut ResourceManager,
        name: &[u16],
        data: *const core::ffi::c_void,
        size: usize,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_register_encoded_data_w(rm.to_raw(), name, data, size)
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(unix)]
    pub fn ma_resource_manager_unregister_file(
        rm: &mut ResourceManager,
        path: std::ffi::CString,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_resource_manager_unregister_file(rm.to_raw(), path.as_ptr()) };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(windows)]
    pub fn ma_resource_manager_unregister_file_w(
        rm: &mut ResourceManager,
        path: &[u16],
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_resource_manager_unregister_file_w(rm.to_raw(), path.as_ptr()) };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(unix)]
    pub fn ma_resource_manager_unregister_data(
        rm: &mut ResourceManager,
        name: *const core::ffi::c_char,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_resource_manager_unregister_data(rm.to_raw(), name) };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(windows)]
    pub fn ma_resource_manager_unregister_data_w(
        rm: &mut ResourceManager,
        name: &[u16],
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_resource_manager_unregister_data_w(rm.to_raw(), name) };
        MaudioError::check(res)?;
        Ok(())
    }

    // DATA BUFFERS

    #[inline]
    pub fn ma_resource_manager_data_buffer_init_ex(
        rm: &mut ResourceManager,
        config: *const sys::ma_resource_manager_data_source_config,
        data_buffer: *mut sys::ma_resource_manager_data_buffer,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_data_buffer_init_ex(rm.to_raw(), config, data_buffer)
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(unix)]
    pub fn ma_resource_manager_data_buffer_init(
        rm: &mut ResourceManager,
        path: std::ffi::CString,
        flags: u32,
        notif: *const sys::ma_resource_manager_pipeline_notifications,
        data_buffer: *mut sys::ma_resource_manager_data_buffer,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_data_buffer_init(
                rm.to_raw(),
                path.as_ptr(),
                flags,
                notif,
                data_buffer,
            )
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    #[cfg(windows)]
    pub fn ma_resource_manager_data_buffer_init_w(
        rm: &mut ResourceManager,
        path: &[u16],
        flags: u32,
        notif: *const sys::ma_resource_manager_pipeline_notifications,
        data_buffer: *mut sys::ma_resource_manager_data_buffer,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_data_buffer_init_w(
                rm.to_raw(),
                path.as_ptr(),
                flags,
                notif,
                data_buffer,
            )
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    pub fn ma_resource_manager_data_buffer_init_copy(
        rm: &mut ResourceManager,
        existing: *const sys::ma_resource_manager_data_buffer,
        data_buffer: *mut sys::ma_resource_manager_data_buffer,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_data_buffer_init_copy(rm.to_raw(), existing, data_buffer)
        };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    pub fn ma_resource_manager_data_buffer_uninit(
        data_buffer: *mut sys::ma_resource_manager_data_buffer,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_resource_manager_data_buffer_uninit(data_buffer) };
        MaudioError::check(res)?;
        Ok(())
    }

    #[inline]
    pub fn ma_resource_manager_data_buffer_read_pcm_frames_into() -> MaResult<usize> {
        todo!()
    }

    // TODO
    #[inline]
    pub fn ma_resource_manager_data_buffer_read_pcm_frames<F: PcmFormat>(
        data_buffer: *mut sys::ma_resource_manager_data_buffer,
        frame_count: u64,
    ) -> MaResult<SampleBuffer<F>> {
        let mut frames_read = 0;
        let frames_out: *mut core::ffi::c_void = core::ptr::null_mut();
        let res = unsafe {
            sys::ma_resource_manager_data_buffer_read_pcm_frames(
                data_buffer,
                frames_out,
                frame_count,
                &mut frames_read,
            )
        };
        MaudioError::check(res)?;
        todo!()
    }

    // DATA SOURCES

    #[inline]
    pub fn ma_resource_manager_data_source_init_ex(
        rm: &mut ResourceManager,
        config: *const sys::ma_resource_manager_data_source_config,
        data_source: *mut sys::ma_resource_manager_data_source,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_resource_manager_data_source_init_ex(rm.to_raw(), config, data_source)
        };
        MaudioError::check(res)?;
        Ok(())
    }
}