maudio 0.1.5

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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
//! In-memory PCM audio buffer.
//!
//! An `AudioBuffer` stores decoded audio samples and can be read, seeked, or
//! used as a [`DataSource`](crate::data_source::DataSource) by the engine.
//!
//! Use the builder helpers (`build_*` / `build_*_ref`) to construct a buffer from existing PCM data.
use std::{marker::PhantomData, mem::MaybeUninit, sync::Arc};

use maudio_sys::ffi as sys;

use crate::{
    audio::formats::{Format, SampleBuffer},
    data_source::{private_data_source, AsSourcePtr, DataSourceRef},
    engine::AllocationCallbacks,
    pcm_frames::{PcmFormat, PcmFormatInternal, S24Packed, S24},
    AsRawRef, Binding, MaResult,
};

/// Owned in-memory PCM audio buffer.
///
/// This type owns the underlying buffer allocation
///
/// The stored samples are **interleaved** and all positioning is in **PCM frames**
/// (`frame = channels` samples).
///
/// For 24-bit audio, prefer [`S24Packed`] when you already have packed 3-byte samples.
#[allow(dead_code)]
pub struct AudioBuffer<F: PcmFormat> {
    inner: *mut sys::ma_audio_buffer,
    format: Format,
    channels: u32,
    alloc: Option<Arc<AllocationCallbacks>>,
    _sample_format: PhantomData<F>,
}

impl<F: PcmFormat> Binding for AudioBuffer<F> {
    type Raw = *mut sys::ma_audio_buffer;

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

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

/// Borrowed (zero-copy) PCM audio buffer.
///
/// `AudioBufferRef` does not own the underlying samples. It references an
/// existing buffer, so the original backing data (and any associated allocation
/// state) must outlive `'a`.
///
/// Use this when you want to work with an existing buffer without copying.
///
/// Note that `S24` format is is not available for this type.
pub struct AudioBufferRef<'a, F: PcmFormat> {
    inner: *mut sys::ma_audio_buffer,
    format: Format,
    channels: u32,
    alloc: Option<Arc<AllocationCallbacks>>,
    _data_marker: PhantomData<&'a [u8]>,
    _sample_format: PhantomData<F>,
}

impl<F: PcmFormat> Binding for AudioBufferRef<'_, F> {
    type Raw = *mut sys::ma_audio_buffer;

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

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

// Keeps the as_buffer_ptr method on AsAudioBufferPtr private
mod private_abuffer {
    use super::*;
    use maudio_sys::ffi as sys;

    pub trait AudioBufferProvider<T: ?Sized> {
        fn as_buffer_ptr(t: &T) -> *mut sys::ma_audio_buffer;
    }

    pub struct AudioBufferPtrPrivider;
    pub struct AudioBufferRefPtrPrivider;

    impl<F: PcmFormat> AudioBufferProvider<AudioBuffer<F>> for AudioBufferPtrPrivider {
        fn as_buffer_ptr(t: &AudioBuffer<F>) -> *mut sys::ma_audio_buffer {
            t.to_raw()
        }
    }

    impl<F: PcmFormat> AudioBufferProvider<AudioBufferRef<'_, F>> for AudioBufferRefPtrPrivider {
        fn as_buffer_ptr(t: &AudioBufferRef<F>) -> *mut sys::ma_audio_buffer {
            t.to_raw()
        }
    }

    pub fn buffer_ptr<T: AsAudioBufferPtr + ?Sized>(t: &T) -> *mut sys::ma_audio_buffer {
        <T as AsAudioBufferPtr>::__PtrProvider::as_buffer_ptr(t)
    }
}

// Allows AudioBuffer to pass as a DataSource
#[doc(hidden)]
impl<F: PcmFormat> AsSourcePtr for AudioBuffer<F> {
    type __PtrProvider = private_data_source::AudioBufferProvider;
}

// Allows AudioBufferRef to pass as a DataSource
#[doc(hidden)]
impl<'a, F: PcmFormat> AsSourcePtr for AudioBufferRef<'a, F> {
    type __PtrProvider = private_data_source::AudioBufferRefProvider;
}

/// Allows both AudioBuffer and AudioBufferRef to access the same methods
pub trait AsAudioBufferPtr {
    #[doc(hidden)]
    type __PtrProvider: private_abuffer::AudioBufferProvider<Self>;
    fn format(&self) -> Format;
    fn channels(&self) -> u32;
}

impl<F: PcmFormat> AsAudioBufferPtr for AudioBuffer<F> {
    #[doc(hidden)]
    type __PtrProvider = private_abuffer::AudioBufferPtrPrivider;

    fn format(&self) -> Format {
        self.format
    }

    fn channels(&self) -> u32 {
        self.channels
    }
}

impl<F: PcmFormat> AsAudioBufferPtr for AudioBufferRef<'_, F> {
    #[doc(hidden)]
    type __PtrProvider = private_abuffer::AudioBufferRefPtrPrivider;

    fn format(&self) -> Format {
        self.format
    }

    fn channels(&self) -> u32 {
        self.channels
    }
}

impl<F: PcmFormat> AudioBufferOps for AudioBuffer<F> {
    type Format = F;
}

impl<F: PcmFormat> AudioBufferOps for AudioBufferRef<'_, F> {
    type Format = F;
}

/// AudioBufferOps trait contains shared methods for [`AudioBuffer`] and [`AudioBufferRef`]
///
/// All methods operate on **PCM frames**. A frame contains one sample per channel, and the
/// underlying sample layout is **interleaved**.
///
/// When `looping` is `true`, reads wrap back to the start after reaching the end.
pub trait AudioBufferOps: AsAudioBufferPtr + AsSourcePtr {
    type Format: PcmFormat;

    /// Reads PCM frames into `dst`, returning the number of frames read.
    fn read_pcm_frames_into(
        &mut self,
        looping: bool,
        dst: &mut [<Self::Format as PcmFormat>::PcmUnit],
    ) -> MaResult<usize> {
        buffer_ffi::ma_audio_buffer_read_pcm_frames_into::<Self::Format, Self>(self, dst, looping)
    }

    /// Allocates and reads `frame_count` PCM frames, returning a typed sample buffer.
    fn read_pcm_frames(
        &mut self,
        frame_count: u64,
        looping: bool,
    ) -> MaResult<SampleBuffer<Self::Format>> {
        buffer_ffi::ma_audio_buffer_read_pcm_frames(self, frame_count, looping)
    }

    /// Seeks to an absolute PCM frame index.
    fn seek_to_pcm(&mut self, frame_index: u64) -> MaResult<()> {
        buffer_ffi::ma_audio_buffer_seek_to_pcm_frame(self, frame_index)
    }

    /// Returns `true` if the cursor is at the end of the buffer.
    fn ended(&self) -> bool {
        buffer_ffi::ma_audio_buffer_at_end(self)
    }

    /// Returns the current cursor position in PCM frames.
    fn cursor_pcm(&self) -> MaResult<u64> {
        buffer_ffi::ma_audio_buffer_get_cursor_in_pcm_frames(self)
    }

    /// Returns the total length in PCM frames.
    fn length_pcm(&self) -> MaResult<u64> {
        buffer_ffi::ma_audio_buffer_get_length_in_pcm_frames(self)
    }

    /// Returns the number of frames available from the current cursor to the end.
    fn available_frames(&self) -> MaResult<u64> {
        buffer_ffi::ma_audio_buffer_get_available_frames(self)
    }

    /// Returns a [`DataSourceRef`] view of this buffer.
    fn as_source<'a>(&'a self) -> DataSourceRef<'a> {
        debug_assert!(!private_abuffer::buffer_ptr(self).is_null());
        let ptr = private_abuffer::buffer_ptr(self).cast::<sys::ma_data_source>();
        DataSourceRef::from_ptr(ptr)
    }
}

impl<'a, F: PcmFormat> AudioBufferRef<'a, F> {
    fn new_with_cfg_internal(config: &AudioBufferBuilder<'a>) -> MaResult<Self> {
        let mut mem: Box<std::mem::MaybeUninit<sys::ma_audio_buffer>> =
            Box::new(MaybeUninit::uninit());
        buffer_ffi::ma_audio_buffer_init(config, mem.as_mut_ptr())?;

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

        Ok(Self {
            inner,
            format: config.inner.format.try_into()?,
            channels: config.inner.channels,
            alloc: config.alloc_cb.clone(),
            _sample_format: PhantomData,
            _data_marker: PhantomData,
        })
    }
}

impl<F: PcmFormat> AudioBuffer<F> {
    fn copy_with_cfg_internal(config: &AudioBufferBuilder) -> MaResult<Self> {
        let mut mem: Box<std::mem::MaybeUninit<sys::ma_audio_buffer>> =
            Box::new(MaybeUninit::uninit());

        buffer_ffi::ma_audio_buffer_init_copy(config, mem.as_mut_ptr())?;

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

        Ok(Self {
            inner,
            format: config.inner.format.try_into()?,
            channels: config.inner.channels,
            alloc: config.alloc_cb.clone(),
            _sample_format: PhantomData,
        })
    }
}

pub(crate) mod buffer_ffi {
    use crate::{
        audio::formats::SampleBuffer,
        data_source::{
            sources::buffer::{private_abuffer, AsAudioBufferPtr, AudioBuffer, AudioBufferBuilder},
            AsSourcePtr,
        },
        pcm_frames::{PcmFormat, PcmFormatInternal},
        AsRawRef, Binding, MaResult, MaudioError,
    };
    use maudio_sys::ffi as sys;

    #[inline]
    pub fn ma_audio_buffer_init(
        config: &AudioBufferBuilder,
        buffer: *mut sys::ma_audio_buffer,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_audio_buffer_init(config.as_raw_ptr(), buffer) };
        MaudioError::check(res)
    }

    #[inline]
    pub fn ma_audio_buffer_init_copy(
        config: &AudioBufferBuilder,
        buffer: *mut sys::ma_audio_buffer,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_audio_buffer_init_copy(config.as_raw_ptr(), buffer) };
        MaudioError::check(res)
    }

    #[inline]
    pub fn ma_audio_buffer_uninit<A: AsAudioBufferPtr + AsSourcePtr + ?Sized>(buffer: &mut A) {
        unsafe {
            sys::ma_audio_buffer_uninit(private_abuffer::buffer_ptr(buffer));
        }
    }

    pub fn ma_audio_buffer_read_pcm_frames_into<F: PcmFormat, A: AsAudioBufferPtr + ?Sized>(
        audio_buffer: &mut A,
        dst: &mut [F::PcmUnit],
        looping: bool,
    ) -> MaResult<usize> {
        let channels = audio_buffer.channels();
        if channels == 0 {
            return Err(MaudioError::from_ma_result(sys::ma_result_MA_INVALID_ARGS));
        }

        let frame_count = (dst.len() / channels as usize / F::VEC_PCM_UNITS_PER_FRAME) as u64;

        match F::DIRECT_READ {
            true => {
                // Read directly into destination
                let frames_read = ma_audio_buffer_read_pcm_frames_internal(
                    audio_buffer,
                    frame_count,
                    dst.as_mut_ptr() as *mut core::ffi::c_void,
                    looping,
                )?;
                Ok(frames_read as usize)
            }
            false => {
                let tmp_len = SampleBuffer::<F>::required_len(
                    frame_count as usize,
                    channels,
                    F::VEC_STORE_UNITS_PER_FRAME,
                )?;

                let mut tmp = vec![F::StorageUnit::default(); tmp_len];
                let frames_read = ma_audio_buffer_read_pcm_frames_internal(
                    audio_buffer,
                    frame_count,
                    tmp.as_mut_ptr() as *mut core::ffi::c_void,
                    looping,
                )?;

                let _ = <F as PcmFormatInternal>::read_from_storage_internal(
                    &tmp,
                    dst,
                    frames_read as usize,
                    channels as usize,
                )?;

                Ok(frames_read as usize)
            }
        }
    }

    pub fn ma_audio_buffer_read_pcm_frames<F: PcmFormat, A: AsAudioBufferPtr + ?Sized>(
        audio_buffer: &mut A,
        frame_count: u64,
        looping: bool,
    ) -> MaResult<SampleBuffer<F>> {
        let mut buffer =
            SampleBuffer::<F>::new_zeroed(frame_count as usize, audio_buffer.channels())?;

        let frames_read = ma_audio_buffer_read_pcm_frames_internal(
            audio_buffer,
            frame_count,
            buffer.as_mut_ptr() as *mut core::ffi::c_void,
            looping,
        )?;

        SampleBuffer::<F>::from_storage(buffer, frames_read as usize, audio_buffer.channels())
    }

    #[inline]
    fn ma_audio_buffer_read_pcm_frames_internal<A: AsAudioBufferPtr + ?Sized>(
        audio_buffer: &mut A,
        frame_count: u64,
        buffer: *mut core::ffi::c_void,
        looping: bool,
    ) -> MaResult<u64> {
        let looping = looping as u32;
        let frames_read = unsafe {
            sys::ma_audio_buffer_read_pcm_frames(
                private_abuffer::buffer_ptr(audio_buffer),
                buffer,
                frame_count,
                looping,
            )
        };
        Ok(frames_read)
    }

    #[inline]
    pub fn ma_audio_buffer_seek_to_pcm_frame<A: AsAudioBufferPtr + ?Sized>(
        buffer: &mut A,
        frame_index: u64,
    ) -> MaResult<()> {
        let res = unsafe {
            sys::ma_audio_buffer_seek_to_pcm_frame(private_abuffer::buffer_ptr(buffer), frame_index)
        };
        MaudioError::check(res)
    }

    // TODO Keep private for now
    #[inline]
    pub fn ma_audio_buffer_map<F: PcmFormat>(
        buffer: &mut AudioBuffer<F>,
        frames_out: *mut *mut core::ffi::c_void,
        frame_count: *mut u64,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_audio_buffer_map(buffer.to_raw(), frames_out, frame_count) };
        MaudioError::check(res)
    }

    // TODO Keep private for now
    #[inline]
    pub fn ma_audio_buffer_unmap<F: PcmFormat>(
        buffer: &mut AudioBuffer<F>,
        frame_count: u64,
    ) -> MaResult<()> {
        let res = unsafe { sys::ma_audio_buffer_unmap(buffer.to_raw(), frame_count) };
        MaudioError::check(res)
    }

    #[inline]
    pub fn ma_audio_buffer_at_end<A: AsAudioBufferPtr + ?Sized>(buffer: &A) -> bool {
        let res =
            unsafe { sys::ma_audio_buffer_at_end(private_abuffer::buffer_ptr(buffer) as *const _) };
        res == 1
    }

    #[inline]
    pub fn ma_audio_buffer_get_cursor_in_pcm_frames<A: AsAudioBufferPtr + ?Sized>(
        buffer: &A,
    ) -> MaResult<u64> {
        let mut cursor = 0;
        let res = unsafe {
            sys::ma_audio_buffer_get_cursor_in_pcm_frames(
                private_abuffer::buffer_ptr(buffer) as *const _,
                &mut cursor,
            )
        };
        MaudioError::check(res)?;
        Ok(cursor)
    }

    #[inline]
    pub fn ma_audio_buffer_get_length_in_pcm_frames<A: AsAudioBufferPtr + ?Sized>(
        buffer: &A,
    ) -> MaResult<u64> {
        let mut length = 0;
        let res = unsafe {
            sys::ma_audio_buffer_get_length_in_pcm_frames(
                private_abuffer::buffer_ptr(buffer) as *const _,
                &mut length,
            )
        };
        MaudioError::check(res)?;
        Ok(length)
    }

    #[inline]
    pub fn ma_audio_buffer_get_available_frames<A: AsAudioBufferPtr + ?Sized>(
        buffer: &A,
    ) -> MaResult<u64> {
        let mut frames = 0;
        let res = unsafe {
            sys::ma_audio_buffer_get_available_frames(
                private_abuffer::buffer_ptr(buffer) as *const _,
                &mut frames,
            )
        };
        MaudioError::check(res)?;
        Ok(frames)
    }
}

impl<F: PcmFormat> Drop for AudioBuffer<F> {
    fn drop(&mut self) {
        buffer_ffi::ma_audio_buffer_uninit(self);
        drop(unsafe { Box::from_raw(self.to_raw()) });
    }
}

impl<'a, F: PcmFormat> Drop for AudioBufferRef<'a, F> {
    fn drop(&mut self) {
        buffer_ffi::ma_audio_buffer_uninit(self);
        drop(unsafe { Box::from_raw(self.to_raw()) });
    }
}

/// Builder for constructing [`AudioBuffer`] and [`AudioBufferRef`] from interleaved PCM data.
///
/// `channels` is the number of interleaved channels in `data`. The slice length should be a
/// multiple of `channels` (whole frames).
///
/// Use `build_*` to copy data into an owned buffer, or `build_*_ref` to borrow the slice.
pub struct AudioBufferBuilder<'a> {
    inner: sys::ma_audio_buffer_config,
    alloc_cb: Option<Arc<AllocationCallbacks>>,
    // This type and AudioBufferRef must keep a lifetime to the data provided to AudioBufferBuilder
    // Otherwise, the data can be dropped and result in a dangling pointer
    _marker: PhantomData<&'a [u8]>,
    // _data_keepalive: Option<Vec<>>
}

impl AsRawRef for AudioBufferBuilder<'_> {
    type Raw = sys::ma_audio_buffer_config;

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

impl<'a> AudioBufferBuilder<'a> {
    // TODO: Figure out a better way to keep data alive for S24
    // fn new_copy<F: PcmFormat>(
    //     format: Format,
    //     channels: u32,
    //     data: &[F::PcmUnit],
    // ) -> MaResult<(Self, Option<Vec<F::StorageUnit>>)> {
    //     let frames = data.len() / channels as usize / F::VEC_PCM_UNITS_PER_FRAME;

    //     match F::DIRECT_READ {
    //         true => {
    //             let builder = Self::init(
    //                 format,
    //                 channels,
    //                 frames as u64,
    //                 data.as_ptr() as *const _,
    //                 None,
    //             );
    //             Ok((builder, None))
    //         }
    //         false => {
    //             let dst_len = SampleBuffer::<F>::required_len(
    //                 frames,
    //                 channels,
    //                 F::VEC_STORE_UNITS_PER_FRAME,
    //             )?;
    //             let mut dst = vec![F::StorageUnit::default(); dst_len];

    //             <F as PcmFormatInternal>::write_to_storage_internal(
    //                 &mut dst,
    //                 data,
    //                 frames,
    //                 channels as usize,
    //             )?;
    //             let builder = Self::init(
    //                 format,
    //                 channels,
    //                 frames as u64,
    //                 dst.as_ptr() as *const _,
    //                 None,
    //             );
    //             Ok((builder, Some(dst)))
    //         }
    //     }
    // }

    /// Should never be called for `S24`.
    ///
    /// S24 needs format conversion and AudioBufferRef reads directly from user provided data.
    fn new_ref<F: PcmFormat>(format: Format, channels: u32, data: &[F::PcmUnit]) -> MaResult<Self> {
        if channels == 0 {
            return Err(crate::MaudioError::from_ma_result(
                sys::ma_result_MA_INVALID_ARGS,
            ));
        }
        let frames = data.len() / channels as usize / F::VEC_PCM_UNITS_PER_FRAME;

        Ok(Self::init(
            format,
            channels,
            frames as u64,
            data.as_ptr() as *const _,
            None,
        ))
    }

    pub fn build_u8(channels: u32, data: &[u8]) -> MaResult<AudioBuffer<u8>> {
        if channels == 0 {
            return Err(crate::MaudioError::from_ma_result(
                sys::ma_result_MA_INVALID_ARGS,
            ));
        }
        let frames = data.len() / channels as usize / <u8 as PcmFormat>::VEC_PCM_UNITS_PER_FRAME;
        let builder = Self::init(
            Format::U8,
            channels,
            frames as u64,
            data.as_ptr() as *const _,
            None,
        );
        AudioBuffer::copy_with_cfg_internal(&builder)
    }

    pub fn build_i16(channels: u32, data: &[i16]) -> MaResult<AudioBuffer<i16>> {
        if channels == 0 {
            return Err(crate::MaudioError::from_ma_result(
                sys::ma_result_MA_INVALID_ARGS,
            ));
        }
        let frames = data.len() / channels as usize / <i16 as PcmFormat>::VEC_PCM_UNITS_PER_FRAME;

        let builder = Self::init(
            Format::S16,
            channels,
            frames as u64,
            data.as_ptr() as *const _,
            None,
        );
        AudioBuffer::copy_with_cfg_internal(&builder)
    }

    pub fn build_i32(channels: u32, data: &[i32]) -> MaResult<AudioBuffer<i32>> {
        if channels == 0 {
            return Err(crate::MaudioError::from_ma_result(
                sys::ma_result_MA_INVALID_ARGS,
            ));
        }
        let frames = data.len() / channels as usize / <i32 as PcmFormat>::VEC_PCM_UNITS_PER_FRAME;

        let builder = Self::init(
            Format::S32,
            channels,
            frames as u64,
            data.as_ptr() as *const _,
            None,
        );
        AudioBuffer::copy_with_cfg_internal(&builder)
    }

    pub fn build_f32(channels: u32, data: &[f32]) -> MaResult<AudioBuffer<f32>> {
        if channels == 0 {
            return Err(crate::MaudioError::from_ma_result(
                sys::ma_result_MA_INVALID_ARGS,
            ));
        }
        let frames = data.len() / channels as usize / <f32 as PcmFormat>::VEC_PCM_UNITS_PER_FRAME;

        let builder = Self::init(
            Format::F32,
            channels,
            frames as u64,
            data.as_ptr() as *const _,
            None,
        );
        AudioBuffer::copy_with_cfg_internal(&builder)
    }

    pub fn build_s24(channels: u32, data: &[i32]) -> MaResult<AudioBuffer<S24>> {
        if channels == 0 {
            return Err(crate::MaudioError::from_ma_result(
                sys::ma_result_MA_INVALID_ARGS,
            ));
        }
        let frames = data.len() / channels as usize / <S24 as PcmFormat>::VEC_PCM_UNITS_PER_FRAME;

        let dst_len = SampleBuffer::<S24>::required_len(
            frames,
            channels,
            <S24 as PcmFormat>::VEC_STORE_UNITS_PER_FRAME,
        )?;
        let mut dst = vec![<S24 as PcmFormat>::StorageUnit::default(); dst_len];

        <S24 as PcmFormatInternal>::write_to_storage_internal(
            &mut dst,
            data,
            frames,
            channels as usize,
        )?;
        let builder = Self::init(
            Format::S24Packed,
            channels,
            frames as u64,
            dst.as_ptr() as *const _,
            None,
        );
        AudioBuffer::copy_with_cfg_internal(&builder)
    }

    pub fn build_s24_packed(channels: u32, data: &[u8]) -> MaResult<AudioBuffer<S24Packed>> {
        if channels == 0 {
            return Err(crate::MaudioError::from_ma_result(
                sys::ma_result_MA_INVALID_ARGS,
            ));
        }
        let frames =
            data.len() / channels as usize / <S24Packed as PcmFormat>::VEC_PCM_UNITS_PER_FRAME;

        let builder = Self::init(
            Format::S24Packed,
            channels,
            frames as u64,
            data.as_ptr() as *const _,
            None,
        );
        AudioBuffer::copy_with_cfg_internal(&builder)
    }

    pub fn build_u8_ref(channels: u32, data: &'a [u8]) -> MaResult<AudioBufferRef<'a, u8>> {
        let builder = Self::new_ref::<u8>(Format::U8, channels, data)?;
        AudioBufferRef::new_with_cfg_internal(&builder)
    }
    pub fn build_i16_ref(channels: u32, data: &'a [i16]) -> MaResult<AudioBufferRef<'a, i16>> {
        let builder = Self::new_ref::<i16>(Format::S16, channels, data)?;
        AudioBufferRef::new_with_cfg_internal(&builder)
    }
    pub fn build_i32_ref(channels: u32, data: &'a [i32]) -> MaResult<AudioBufferRef<'a, i32>> {
        let builder = Self::new_ref::<i32>(Format::S32, channels, data)?;
        AudioBufferRef::new_with_cfg_internal(&builder)
    }
    pub fn build_f32_ref(channels: u32, data: &'a [f32]) -> MaResult<AudioBufferRef<'a, f32>> {
        let builder = Self::new_ref::<f32>(Format::F32, channels, data)?;
        AudioBufferRef::new_with_cfg_internal(&builder)
    }

    pub fn build_s24_packed_ref(
        channels: u32,
        data: &'a [u8],
    ) -> MaResult<AudioBufferRef<'a, S24Packed>> {
        let builder = Self::new_ref::<S24Packed>(Format::S24Packed, channels, data)?;
        AudioBufferRef::new_with_cfg_internal(&builder)
    }

    pub(crate) fn init(
        format: Format,
        channels: u32,
        size_frames: u64,
        data: *const core::ffi::c_void,
        alloc_cb: Option<Arc<AllocationCallbacks>>,
    ) -> Self {
        let alloc: *const sys::ma_allocation_callbacks = alloc_cb
            .clone()
            .map_or(core::ptr::null(), |c| c.as_raw_ptr());

        let ptr = buffer_config_ffi::ma_audio_buffer_config_init(
            format,
            channels,
            size_frames,
            data,
            alloc,
        );

        AudioBufferBuilder {
            inner: ptr,
            alloc_cb: None,
            _marker: PhantomData,
        }
    }
}

pub(crate) mod buffer_config_ffi {
    use maudio_sys::ffi as sys;

    use crate::audio::formats::Format;

    pub fn ma_audio_buffer_config_init(
        format: Format,
        channels: u32,
        size_frames: u64,
        data: *const core::ffi::c_void,
        alloc_cb: *const sys::ma_allocation_callbacks,
    ) -> sys::ma_audio_buffer_config {
        unsafe {
            sys::ma_audio_buffer_config_init(format.into(), channels, size_frames, data, alloc_cb)
        }
    }
}

#[cfg(test)]
mod test {
    use crate::{
        audio::formats::SampleBuffer,
        data_source::sources::buffer::{AudioBufferBuilder, AudioBufferOps},
        pcm_frames::PcmFormat,
    };

    fn ramp_f32_interleaved(channels: u32, frames: u64) -> Vec<f32> {
        let mut data = vec![0.0f32; (channels as usize) * (frames as usize)];
        for f in 0..frames as usize {
            for c in 0..channels as usize {
                // unique value per (frame, channel)
                data[f * channels as usize + c] = (f as f32) * 10.0 + (c as f32);
            }
        }
        data
    }

    fn ramp_u8_interleaved(channels: u32, frames: u64) -> Vec<u8> {
        let mut data = vec![0u8; (channels as usize) * (frames as usize)];
        for f in 0..frames as usize {
            for c in 0..channels as usize {
                // keep it simple + deterministic
                data[f * channels as usize + c] = (f as u8).wrapping_mul(10).wrapping_add(c as u8);
            }
        }
        data
    }

    // Helper that tries to be compatible with your SampleBuffer API.
    // Assumes SampleBuffer<T> exposes `.len()` as total samples (frames * channels).
    fn assert_sample_len<T: PcmFormat>(samples: &SampleBuffer<T>, channels: u32, frames: u64) {
        let expected = (channels as usize) * (frames as usize);
        assert_eq!(samples.len(), expected);
    }

    #[test]
    fn test_audio_buffer_basic_init() {
        let mut data = Vec::new();
        data.resize_with(2 * 100, || 0i16);
        let _buffer = AudioBufferBuilder::build_i16(2, &data).unwrap();
    }

    #[test]
    fn test_audio_buffer_copy_basic_init_invariants() {
        let data = vec![0.0f32; 2 * 100];
        let buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        assert_eq!(buf.cursor_pcm().unwrap(), 0);
        assert_eq!(buf.length_pcm().unwrap(), 100);
        assert_eq!(buf.available_frames().unwrap(), 100);
        assert!(!buf.ended());
    }

    #[test]
    fn test_audio_buffer_ref_basic_init_invariants() {
        let data = vec![0.0f32; 2 * 100];
        let buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        assert_eq!(buf.cursor_pcm().unwrap(), 0);
        assert_eq!(buf.length_pcm().unwrap(), 100);
        assert_eq!(buf.available_frames().unwrap(), 100);
        assert!(!buf.ended());

        // buf is dropped before data due to scope order; should compile.
        drop(buf);
        drop(data);
    }

    #[test]
    fn test_audio_buffer_read_advances_cursor_and_available() {
        let data = vec![0.0f32; 2 * 100];
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        let buffer = buf.read_pcm_frames(10, false).unwrap();
        let frames_read = buffer.frames();
        assert_eq!(frames_read, 10);

        assert_eq!(buf.cursor_pcm().unwrap(), 10);
        assert_eq!(buf.available_frames().unwrap(), 90);
        assert!(!buf.ended());
    }

    #[test]
    fn test_audio_buffer_read_to_end_sets_ended() {
        let data = vec![0.0f32; 2 * 100];
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        let buffer = buf.read_pcm_frames(100, false).unwrap();
        let frames_read = buffer.frames();
        assert_eq!(frames_read, 100);
        assert!(buf.ended());
        assert_eq!(buf.available_frames().unwrap(), 0);

        // Reading past the end should return 0 frames.
        let buffer = buf.read_pcm_frames(10, false).unwrap();
        let frames_read2 = buffer.frames();
        assert_eq!(frames_read2, 0);
        assert!(buf.ended());
    }

    #[test]
    fn test_audio_buffer_read_zero_frames_is_noop() {
        let data = ramp_f32_interleaved(2, 16);
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        let buffer = buf.read_pcm_frames(0, false).unwrap();
        let frames_read = buffer.frames();
        assert_eq!(frames_read, 0);
        assert_sample_len(&buffer, 2, 0);

        assert_eq!(buf.cursor_pcm().unwrap(), 0);
        assert_eq!(buf.available_frames().unwrap(), 16);
        assert!(!buf.ended());
    }

    #[test]
    fn test_audio_buffer_read_past_end_truncates_returned_buffer() {
        // frames=8, read 6, then request 6 again => only 2 available
        let data = ramp_f32_interleaved(2, 8);
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        let buffer = buf.read_pcm_frames(6, false).unwrap();
        let frames_read1 = buffer.frames();
        assert_eq!(frames_read1, 6);
        assert_eq!(buf.cursor_pcm().unwrap(), 6);
        assert_eq!(buf.available_frames().unwrap(), 2);

        let buffer2 = buf.read_pcm_frames(6, false).unwrap();
        let frames_read2 = buffer2.frames();
        assert_eq!(frames_read2, 2);
        assert_sample_len(&buffer2, 2, 2);

        assert_eq!(buf.cursor_pcm().unwrap(), 8);
        assert_eq!(buf.available_frames().unwrap(), 0);
        assert!(buf.ended());
    }

    #[test]
    fn test_audio_buffer_seek_to_middle_updates_cursor_and_available() {
        let data = ramp_f32_interleaved(2, 32);
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        buf.seek_to_pcm(10).unwrap();
        assert_eq!(buf.cursor_pcm().unwrap(), 10);
        assert_eq!(buf.available_frames().unwrap(), 22);
        assert!(!buf.ended());

        let buffer = buf.read_pcm_frames(5, false).unwrap();
        let frames_read = buffer.frames();
        assert_eq!(frames_read, 5);
        assert_eq!(buf.cursor_pcm().unwrap(), 15);
        assert_eq!(buf.available_frames().unwrap(), 17);
    }

    #[test]
    fn test_audio_buffer_seek_to_end_sets_ended_state() {
        let data = ramp_f32_interleaved(2, 12);
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        buf.seek_to_pcm(12).unwrap();
        assert_eq!(buf.cursor_pcm().unwrap(), 12);
        assert_eq!(buf.available_frames().unwrap(), 0);
        assert!(buf.ended());

        // reading at end should return 0 frames
        let buffer = buf.read_pcm_frames(1, false).unwrap();
        let frames_read = buffer.frames();
        assert_eq!(frames_read, 0);
        assert_sample_len(&buffer, 2, 0);
        assert!(buf.ended());
    }

    #[test]
    fn test_audio_buffer_seek_past_end_errors() {
        let data = ramp_f32_interleaved(2, 12);
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        // miniaudio should reject seeking beyond length
        assert!(buf.seek_to_pcm(13).is_err());
    }

    #[test]
    fn test_audio_buffer_read_u8_advances_cursor_and_truncates() {
        let data = ramp_u8_interleaved(2, 8);
        let mut buf = AudioBufferBuilder::build_u8(2, &data).unwrap();

        let samples1 = buf.read_pcm_frames(6, false).unwrap();
        let frames_read1 = samples1.frames();
        assert_eq!(frames_read1, 6);
        assert_sample_len(&samples1, 2, 6);
        assert_eq!(buf.cursor_pcm().unwrap(), 6);
        assert_eq!(buf.available_frames().unwrap(), 2);

        let samples2 = buf.read_pcm_frames(10, false).unwrap();
        let frames_read2 = samples2.frames();
        assert_eq!(frames_read2, 2);
        assert_sample_len(&samples2, 2, 2);
        assert_eq!(buf.cursor_pcm().unwrap(), 8);
        assert_eq!(buf.available_frames().unwrap(), 0);
        assert!(buf.ended());
    }

    #[test]
    fn test_audio_buffer_looping_read_does_not_return_zero_when_past_end() {
        // Conservative looping test:
        // - In non-looping, this would return 0 after consuming the buffer.
        // - With looping=true, requesting more should give >0 frames read.
        let data = ramp_f32_interleaved(2, 4);
        let mut buf = AudioBufferBuilder::build_f32(2, &data).unwrap();

        // Consume all frames.
        let _s0 = buf.read_pcm_frames(4, false).unwrap();
        assert_eq!(_s0.frames(), 4);
        assert!(buf.ended());

        // Looping read should produce some frames (ideally 2).
        let _s1 = buf.read_pcm_frames(2, true).unwrap();
        assert!(_s1.frames() > 0, "looping read should return >0 frames");
    }

    #[test]
    fn test_builder_s24_packed_requires_frames_channels_times_3_bytes() {
        // frames=4, channels=2 => 4*2*3 = 24 bytes
        let ok = vec![0u8; 24];
        assert!(AudioBufferBuilder::build_s24_packed(2, &ok).is_ok());

        // frames = 3
        let bad = vec![0u8; 23];
        let buf = AudioBufferBuilder::build_s24_packed(2, &bad);
        assert!(buf.is_ok());
        let mut buf = buf.unwrap();
        let buffer = buf.read_pcm_frames(4, false).unwrap();
        assert_eq!(buffer.frames(), 3);
        assert_eq!(buffer.len(), 3 * 3 * 2);
    }
}