soundkit 0.12.2

Audio format optimised for low-latency audio.
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
use byteorder::{BigEndian, ByteOrder, LittleEndian};

pub fn i16le_to_f32(bytes: &[u8]) -> Vec<f32> {
    assert!(bytes.len() % 2 == 0, "Bytes length must be a multiple of 2");
    bytes
        .chunks(2)
        .map(|chunk| {
            let i16_sample = i16::from_le_bytes(chunk.try_into().unwrap());
            i16_sample as f32 / 32768.0
        })
        .collect()
}

pub fn i16_to_i16le(data: &[i16]) -> Vec<u8> {
    let mut bytes = Vec::with_capacity(data.len() * 2); // Each i16 is 2 bytes
    for value in data {
        bytes.extend(&value.to_le_bytes());
    }
    bytes
}

pub fn i16le_to_i16(bytes: &[u8]) -> Vec<i16> {
    assert!(bytes.len() % 2 == 0, "Bytes length must be a multiple of 2");
    bytes
        .chunks(2)
        .map(|chunk| i16::from_le_bytes(chunk.try_into().unwrap()))
        .collect()
}

pub fn s24le_to_i32(data: &[u8]) -> Vec<i32> {
    let sample_count = data.len() / 3;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(3).for_each(|chunk| {
        let unsigned_sample = u32::from_le_bytes([chunk[0], chunk[1], chunk[2], 0]);
        let signed_sample = if unsigned_sample & 0x800000 != 0 {
            (unsigned_sample | 0xFF000000) as i32
        } else {
            unsigned_sample as i32
        };
        result.push(signed_sample);
    });
    result
}

pub fn s24le_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count = data.len() / 3;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(3).for_each(|chunk| {
        let unsigned_sample = u32::from_le_bytes([chunk[0], chunk[1], chunk[2], 0]);
        let signed_sample = if unsigned_sample & 0x800000 != 0 {
            (unsigned_sample | 0xFF000000) as i32
        } else {
            unsigned_sample as i32
        };
        result.push((signed_sample >> 8) as i16);
    });
    result
}

pub fn s24be_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count = data.len() / 3;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(3).for_each(|chunk| {
        let unsigned_sample = u32::from_be_bytes([0, chunk[0], chunk[1], chunk[2]]);
        let signed_sample = if unsigned_sample & 0x800000 != 0 {
            (unsigned_sample | 0xFF000000) as i32
        } else {
            unsigned_sample as i32
        };
        result.push((signed_sample >> 8) as i16);
    });
    result
}

pub fn s32le_to_i32(data: &[u8]) -> Vec<i32> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample = i32::from_le_bytes(chunk.try_into().unwrap());
        result.push(s32_sample);
    });
    result
}

pub fn s32be_to_i32(data: &[u8]) -> Vec<i32> {
    let sample_count: usize = data.len() / 4;
    let mut result: Vec<i32> = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample: i32 = i32::from_be_bytes(chunk.try_into().unwrap());
        result.push(s32_sample);
    });
    result
}

pub fn s32le_to_s24(data: &[u8]) -> Vec<i32> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample = i32::from_le_bytes(chunk.try_into().unwrap());
        let s24_sample = s32_sample & 0x00FFFFFF;
        result.push(s24_sample);
    });
    result
}

pub fn s32be_to_s24(data: &[u8]) -> Vec<i32> {
    let sample_count: usize = data.len() / 4;
    let mut result: Vec<i32> = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample: i32 = i32::from_be_bytes(chunk.try_into().unwrap());
        let s24_sample: i32 = s32_sample & 0x00FFFFFF;
        result.push(s24_sample);
    });
    result
}

pub fn s32le_to_f32(data: &[u8]) -> Vec<f32> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample = i32::from_le_bytes(chunk.try_into().unwrap());
        let f32_sample = (s32_sample as f32) / (2.0f32.powi(31) - 1.0);
        result.push(f32_sample);
    });
    result
}

pub fn s32be_to_f32(data: &[u8]) -> Vec<f32> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample = i32::from_be_bytes(chunk.try_into().unwrap());
        let f32_sample = (s32_sample as f32) / (2.0f32.powi(31) - 1.0);
        result.push(f32_sample);
    });
    result
}

pub fn s32le_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count: usize = data.len() / 4;
    let mut result: Vec<i16> = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample: i32 = i32::from_le_bytes(chunk.try_into().unwrap());
        let i16_sample: i16 = (s32_sample >> 16) as i16;
        result.push(i16_sample);
    });
    result
}

pub fn s32be_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count: usize = data.len() / 4;
    let mut result: Vec<i16> = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let s32_sample: i32 = i32::from_be_bytes(chunk.try_into().unwrap());
        let i16_sample: i16 = (s32_sample >> 16) as i16;
        result.push(i16_sample);
    });
    result
}

pub fn f32le_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let f32_sample = LittleEndian::read_f32(chunk);
        let i16_sample = (f32_sample.max(-1.0).min(1.0) * 32767.0) as i16;
        result.push(i16_sample);
    });
    result
}

pub fn f32be_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let f32_sample = BigEndian::read_f32(chunk);
        let i16_sample = (f32_sample.max(-1.0).min(1.0) * 32767.0) as i16;
        result.push(i16_sample);
    });
    result
}

pub fn f32le_to_i32(data: &[u8]) -> Vec<i32> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let f32_sample = LittleEndian::read_f32(chunk);
        let clamped = f32_sample.max(-1.0).min(1.0);
        let sample = if clamped >= 0.0 {
            (clamped * i32::MAX as f32) as i32
        } else {
            (clamped * -(i32::MIN as f32)) as i32
        };
        result.push(sample);
    });
    result
}

pub fn f32le_to_s24(data: &[u8]) -> Vec<i32> {
    let sample_count = data.len() / 4;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(4).for_each(|chunk| {
        let f32_sample = f32::from_le_bytes(chunk.try_into().unwrap());
        let clamped = f32_sample.max(-1.0).min(1.0);
        let s24_max = 8388607; // 2^23 - 1
        let sample = if clamped >= 0.0 {
            (clamped * s24_max as f32) as i32
        } else {
            (clamped * (s24_max + 1) as f32) as i32
        };
        result.push(sample);
    });
    result
}

pub fn s16be_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count = data.len() / 2;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(2).for_each(|chunk| {
        result.push(BigEndian::read_i16(chunk));
    });
    result
}

pub fn s16le_to_i16(data: &[u8]) -> Vec<i16> {
    let sample_count = data.len() / 2;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(2).for_each(|chunk| {
        result.push(LittleEndian::read_i16(chunk));
    });
    result
}

pub fn s16le_to_i32(data: &[u8]) -> Vec<i32> {
    let sample_count = data.len() / 2;
    let mut result = Vec::with_capacity(sample_count);
    data.chunks_exact(2).for_each(|chunk| {
        let sample = LittleEndian::read_i16(chunk) as i32;
        result.push(sample);
    });
    result
}

pub fn interleave_vecs_i16(channels: &[Vec<i16>]) -> Vec<u8> {
    let channel_count = channels.len();
    let sample_count = channels[0].len();
    let mut result = Vec::with_capacity(channel_count * sample_count * 2);

    for i in 0..sample_count {
        for channel in channels {
            result.extend_from_slice(&channel[i].to_le_bytes());
        }
    }

    result
}

pub fn deinterleave_vecs_i16(input: &[u8], channel_count: usize) -> Vec<Vec<i16>> {
    let sample_count = input.len() / (channel_count * 2);
    let mut result = vec![Vec::with_capacity(sample_count); channel_count];

    input.chunks_exact(channel_count * 2).for_each(|chunk| {
        chunk
            .chunks_exact(2)
            .enumerate()
            .for_each(|(channel, bytes)| {
                result[channel].push(i16::from_le_bytes([bytes[0], bytes[1]]));
            });
    });

    result
}

pub fn deinterleave_vecs_s24(input: &[u8], channel_count: usize) -> Vec<Vec<i32>> {
    let sample_count = input.len() / (channel_count * 3);
    let mut result = vec![Vec::with_capacity(sample_count); channel_count];

    input.chunks_exact(channel_count * 3).for_each(|chunk| {
        chunk
            .chunks_exact(3)
            .enumerate()
            .for_each(|(channel, bytes)| {
                result[channel].push(s24le_to_i32_sample([bytes[0], bytes[1], bytes[2]]));
            });
    });

    result
}

pub fn deinterleave_vecs_f32(input: &[u8], channel_count: usize) -> Vec<Vec<f32>> {
    let sample_count = input.len() / (channel_count * 4);
    let mut result = vec![Vec::with_capacity(sample_count); channel_count];

    input.chunks_exact(channel_count * 4).for_each(|chunk| {
        chunk
            .chunks_exact(4)
            .enumerate()
            .for_each(|(channel, bytes)| {
                result[channel].push(f32::from_le_bytes(bytes.try_into().unwrap()));
            });
    });

    result
}

pub fn s24le_to_i32_sample(sample_bytes: [u8; 3]) -> i32 {
    let sample = i32::from_le_bytes([sample_bytes[0], sample_bytes[1], sample_bytes[2], 0]);
    (sample << 8) >> 8 // sign extend
}

pub fn stereo_to_mono_take_left(input: &[i16]) -> Vec<i16> {
    assert!(
        input.len() % 2 == 0,
        "Stereo buffer must contain an even number of samples"
    );

    let frames = input.len() / 2;
    let mut out = Vec::with_capacity(frames);
    for i in 0..frames {
        out.push(input[2 * i]);
    }
    out
}

pub fn stereo_to_mono_inplace_take_left(samples: &mut [i16]) -> &mut [i16] {
    assert!(
        samples.len() % 2 == 0,
        "Stereo buffer must contain an even number of samples"
    );

    let frames = samples.len() / 2;
    for i in 0..frames {
        samples[i] = samples[2 * i];
    }
    &mut samples[..frames]
}

pub fn stereo_to_mono_avg(input: &[i16]) -> Vec<i16> {
    assert!(
        input.len() % 2 == 0,
        "Stereo buffer must contain an even number of samples"
    );

    let frames = input.len() / 2;
    let mut out = Vec::with_capacity(frames);
    for i in 0..frames {
        let l = input[2 * i] as i32;
        let r = input[2 * i + 1] as i32;
        out.push(((l + r) / 2) as i16);
    }
    out
}

pub fn stereo_to_mono_inplace_avg(samples: &mut [i16]) -> &mut [i16] {
    assert!(
        samples.len() % 2 == 0,
        "Stereo buffer must contain an even number of samples"
    );

    let frames = samples.len() / 2;
    for i in 0..frames {
        let l = samples[2 * i] as i32;
        let r = samples[2 * i + 1] as i32;
        samples[i] = ((l + r) / 2) as i16;
    }
    &mut samples[..frames]
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_deinterleave_vecs_i16() {
        let input = vec![1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0]; // Little Endian u16 values [1, 2, 3, 4, 5, 6]
        let result = deinterleave_vecs_i16(&input, 2);
        assert_eq!(result, vec![vec![1, 3, 5], vec![2, 4, 6]]);
    }

    #[test]
    fn test_interleave_vecs_i16() {
        let input = vec![vec![1, 3, 5], vec![2, 4, 6]];
        let result = interleave_vecs_i16(&input);
        assert_eq!(result, vec![1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0]);
    }

    #[test]
    fn test_deinterleave_vecs_s24() {
        let input = vec![1, 0, 0, 2, 0, 0, 3, 0, 0, 4, 0, 0, 5, 0, 0, 6, 0, 0]; // Little Endian u24 values [1, 2, 3, 4, 5, 6]
        let result = deinterleave_vecs_s24(&input, 2);
        assert_eq!(result, vec![vec![1, 3, 5], vec![2, 4, 6]]);
    }

    #[test]
    fn test_deinterleave_vecs_f32() {
        let input = vec![
            0, 0, 128, 63, 0, 0, 0, 64, // f32: 1.0, 2.0
            0, 0, 64, 64, 0, 0, 128, 64, // f32: 3.0, 4.0
            0, 0, 160, 64, 0, 0, 192, 64, // f32: 5.0, 6.0
        ];
        let result = deinterleave_vecs_f32(&input, 2);
        assert_eq!(
            result,
            vec![
                vec![1.0, 3.0, 5.0], // channel 1
                vec![2.0, 4.0, 6.0], // channel 2
            ]
        );
    }

    #[test]
    fn test_i16le_to_f32() {
        // Little-endian bytes for i16 values: 0, 16384, 32767, -16384, -32768
        let input = vec![
            0, 0, // 0
            0, 64, // 16384
            255, 127, // 32767
            0, 192, // -16384
            0, 128, // -32768
        ];
        let expected = vec![0.0, 0.5, 0.9999694, -0.5, -1.0];
        let result = i16le_to_f32(&input);

        assert_eq!(result.len(), expected.len());
        for (i, (&expected, &actual)) in expected.iter().zip(result.iter()).enumerate() {
            assert!(
                (expected - actual).abs() < 0.0001,
                "Sample {} mismatch: expected {}, got {}",
                i,
                expected,
                actual
            );
        }
    }

    #[test]
    fn test_stereo_to_mono_take_left() {
        let input = vec![10, 20, -30, -40, 50, 60];
        let result = stereo_to_mono_take_left(&input);
        assert_eq!(result, vec![10, -30, 50]);
    }

    #[test]
    fn test_stereo_to_mono_inplace_take_left() {
        let mut samples = vec![10, 20, -30, -40, 50, 60];
        let mono = stereo_to_mono_inplace_take_left(&mut samples);
        assert_eq!(mono, &[10, -30, 50]);
    }

    #[test]
    fn test_stereo_to_mono_avg() {
        let input = vec![100, -100, 50, 150, -200, 200];
        let result = stereo_to_mono_avg(&input);
        assert_eq!(result, vec![0, 100, 0]);
    }

    #[test]
    fn test_stereo_to_mono_inplace_avg() {
        let mut samples = vec![100, -100, 50, 150, -200, 200];
        let mono = stereo_to_mono_inplace_avg(&mut samples);
        assert_eq!(mono, &[0, 100, 0]);
    }
}