opus-rs 0.1.21

pure Rust implementation of Opus codec
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
use opus_rs::{Application, OpusDecoder, OpusEncoder};

fn make_sine(freq: f64, sample_rate: i32, frame_size: usize, channels: usize, seed: usize) -> Vec<f32> {
    (0..frame_size * channels)
        .map(|i| {
            let t = (seed * frame_size + i / channels) as f64 / sample_rate as f64;
            let sample = (freq * t * 2.0 * std::f64::consts::PI).sin() as f32;
            sample * 0.3
        })
        .collect()
}

fn rms(samples: &[f32]) -> f32 {
    if samples.is_empty() {
        return 0.0;
    }
    let sum: f32 = samples.iter().map(|&x| x * x).sum();
    (sum / samples.len() as f32).sqrt()
}

/// Encode one frame, return full packet bytes
fn encode_full(encoder: &mut OpusEncoder, pcm: &[f32], frame_size: usize, buf_size: usize) -> Vec<u8> {
    let mut packet = vec![0u8; buf_size];
    let n = encoder.encode(pcm, frame_size, &mut packet).unwrap();
    packet.truncate(n);
    packet
}

/// Build baseline: decode two single-frame packets sequentially through one decoder.
/// Returns RMS of each frame's output.
fn baseline_two(
    decoder: &mut OpusDecoder,
    pkt0: &[u8],
    pkt1: &[u8],
    frame_size: usize,
    channels: usize,
) -> (f32, f32) {
    let mut out0 = vec![0.0f32; frame_size * channels];
    decoder.decode(pkt0, frame_size, &mut out0).unwrap();
    let rms0 = rms(&out0);
    let mut out1 = vec![0.0f32; frame_size * channels];
    decoder.decode(pkt1, frame_size, &mut out1).unwrap();
    let rms1 = rms(&out1);
    (rms0, rms1)
}

#[test]
fn test_celt_multi_frame_code_0_and_1() {
    let sr = 48000;
    let ch = 1;
    let fs = 960;

    let mut enc = OpusEncoder::new(sr, ch, Application::RestrictedLowDelay).unwrap();
    enc.bitrate_bps = 64000;

    let pcm0 = make_sine(440.0, sr, fs, ch, 0);
    let pcm1 = make_sine(440.0, sr, fs, ch, 1);

    let pkt0 = encode_full(&mut enc, &pcm0, fs, 400);
    let pkt1 = encode_full(&mut enc, &pcm1, fs, 400);
    assert_eq!(pkt0[0] & 0x03, 0, "expected code 0");
    assert_eq!(pkt1[0] & 0x03, 0, "expected code 0");

    // Baseline: decode sequentially through one decoder
    let mut dec = OpusDecoder::new(sr, ch).unwrap();
    let (bl_rms0, bl_rms1) = baseline_two(&mut dec, &pkt0, &pkt1, fs, ch);
    assert!(bl_rms0 > 0.01);
    assert!(bl_rms1 > 0.01);

    // Code 1 packet from the two payloads
    let payload0 = &pkt0[1..];
    let payload1 = &pkt1[1..];
    let toc1 = (pkt0[0] & 0xFC) | 0x01;
    let mut c1 = vec![toc1];
    c1.extend_from_slice(payload0);
    c1.extend_from_slice(payload1);

    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2];
    dec_mf.decode(&c1, fs * 2, &mut out).unwrap();
    let r0 = rms(&out[..fs]);
    let r1 = rms(&out[fs..]);
    assert!((r0 / bl_rms0 - 1.0).abs() < 0.02, "frame 0: {:.6} vs {:.6}", r0, bl_rms0);
    assert!((r1 / bl_rms1 - 1.0).abs() < 0.02, "frame 1: {:.6} vs {:.6}", r1, bl_rms1);
}

#[test]
fn test_celt_multi_frame_code_2() {
    let sr = 48000;
    let ch = 1;
    let fs = 960;

    let mut enc = OpusEncoder::new(sr, ch, Application::RestrictedLowDelay).unwrap();
    enc.bitrate_bps = 64000;

    let pcm0 = make_sine(440.0, sr, fs, ch, 0);
    let pcm1 = make_sine(880.0, sr, fs, ch, 1);
    let pkt0 = encode_full(&mut enc, &pcm0, fs, 400);
    let pkt1 = encode_full(&mut enc, &pcm1, fs, 400);

    let mut dec = OpusDecoder::new(sr, ch).unwrap();
    let (bl_rms0, bl_rms1) = baseline_two(&mut dec, &pkt0, &pkt1, fs, ch);

    // Code 2: two unequal frames
    let payload0 = &pkt0[1..];
    let payload1 = &pkt1[1..];
    let toc2 = (pkt0[0] & 0xFC) | 0x02;
    let first_len = payload0.len();
    let mut c2 = vec![toc2];
    if first_len < 128 {
        c2.push(first_len as u8);
    } else {
        c2.push(0x80 | (first_len >> 8) as u8);
        c2.push(first_len as u8);
    }
    c2.extend_from_slice(payload0);
    c2.extend_from_slice(payload1);

    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2];
    dec_mf.decode(&c2, fs * 2, &mut out).unwrap();
    let r0 = rms(&out[..fs]);
    let r1 = rms(&out[fs..]);
    assert!((r0 / bl_rms0 - 1.0).abs() < 0.02, "frame 0: {:.6} vs {:.6}", r0, bl_rms0);
    assert!((r1 / bl_rms1 - 1.0).abs() < 0.02, "frame 1: {:.6} vs {:.6}", r1, bl_rms1);
}

#[test]
fn test_celt_multi_frame_code_3_with_padding() {
    let sr = 48000;
    let ch = 1;
    let fs = 960;

    let mut enc = OpusEncoder::new(sr, ch, Application::RestrictedLowDelay).unwrap();
    enc.bitrate_bps = 64000;

    let pcm0 = make_sine(440.0, sr, fs, ch, 0);
    let pcm1 = make_sine(660.0, sr, fs, ch, 1);
    let pkt0 = encode_full(&mut enc, &pcm0, fs, 400);
    let pkt1 = encode_full(&mut enc, &pcm1, fs, 400);

    let mut dec = OpusDecoder::new(sr, ch).unwrap();
    let (bl_rms0, bl_rms1) = baseline_two(&mut dec, &pkt0, &pkt1, fs, ch);

    // Code 3 with padding: 2 equal-sized frames
    let payload0 = &pkt0[1..];
    let payload1 = &pkt1[1..];
    let toc3 = (pkt0[0] & 0xFC) | 0x03;
    let max_len = payload0.len().max(payload1.len());
    let mut p0 = payload0.to_vec();
    let mut p1 = payload1.to_vec();
    p0.resize(max_len, 0);
    p1.resize(max_len, 0);

    let mut c3 = vec![toc3];
    c3.push(0x42);
    c3.push(0x00);
    c3.extend_from_slice(&p0);
    c3.extend_from_slice(&p1);

    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2];
    dec_mf.decode(&c3, fs * 2, &mut out).unwrap();
    let r0 = rms(&out[..fs]);
    let r1 = rms(&out[fs..]);
    assert!((r0 / bl_rms0 - 1.0).abs() < 0.05, "frame 0: {:.6} vs {:.6}", r0, bl_rms0);
    assert!((r1 / bl_rms1 - 1.0).abs() < 0.05, "frame 1: {:.6} vs {:.6}", r1, bl_rms1);
}

#[test]
fn test_celt_multi_frame_code_3_self_delimiting() {
    let sr = 48000;
    let ch = 1;
    let fs = 960;

    let mut enc = OpusEncoder::new(sr, ch, Application::RestrictedLowDelay).unwrap();
    enc.bitrate_bps = 64000;

    let pcm0 = make_sine(440.0, sr, fs, ch, 0);
    let pcm1 = make_sine(880.0, sr, fs, ch, 1);
    let pkt0 = encode_full(&mut enc, &pcm0, fs, 400);
    let pkt1 = encode_full(&mut enc, &pcm1, fs, 400);

    let mut dec = OpusDecoder::new(sr, ch).unwrap();
    let (bl_rms0, bl_rms1) = baseline_two(&mut dec, &pkt0, &pkt1, fs, ch);

    let payload0 = &pkt0[1..];
    let payload1 = &pkt1[1..];
    let toc3 = (pkt0[0] & 0xFC) | 0x03;
    let len0 = payload0.len();
    let mut c3 = vec![toc3];
    c3.push(0x02);
    if len0 < 128 {
        c3.push(len0 as u8);
    } else {
        c3.push(0x80 | (len0 >> 8) as u8);
        c3.push(len0 as u8);
    }
    c3.extend_from_slice(payload0);
    c3.extend_from_slice(payload1);

    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2];
    dec_mf.decode(&c3, fs * 2, &mut out).unwrap();
    let r0 = rms(&out[..fs]);
    let r1 = rms(&out[fs..]);
    assert!((r0 / bl_rms0 - 1.0).abs() < 0.02, "frame 0: {:.6} vs {:.6}", r0, bl_rms0);
    assert!((r1 / bl_rms1 - 1.0).abs() < 0.02, "frame 1: {:.6} vs {:.6}", r1, bl_rms1);
}

#[test]
fn test_silk_multi_frame_code_3_padding_roundtrip() {
    let sr = 16000;
    let ch = 1;
    let fs = 320;
    let target_size = 100usize;

    let mut enc = OpusEncoder::new(sr, ch, Application::Voip).unwrap();
    enc.bitrate_bps = 24000;
    enc.use_cbr = true;

    let mut dec = OpusDecoder::new(sr, ch).unwrap();

    for frame_idx in 0..3 {
        let pcm = make_sine(440.0, sr, fs, ch, frame_idx);
        let mut packet = vec![0u8; target_size];
        let n = enc.encode(&pcm, fs, &mut packet).unwrap();
        packet.truncate(n);

        let code = packet[0] & 0x03;
        assert!(code == 0 || code == 3, "expected code 0 or 3, got {}", code);

        let mut out = vec![0.0f32; fs];
        let decoded = dec.decode(&packet, fs, &mut out).unwrap();
        assert_eq!(decoded, fs);
        assert!(rms(&out) > 0.01, "frame {} should have non-zero output", frame_idx);
    }
}

#[test]
fn test_hybrid_multi_frame_roundtrip() {
    let sr = 48000;
    let ch = 1;
    let fs = 960;

    let mut enc = OpusEncoder::new(sr, ch, Application::Audio).unwrap();
    enc.bitrate_bps = 64000;

    let pcm0 = make_sine(440.0, sr, fs, ch, 0);
    let pcm1 = make_sine(660.0, sr, fs, ch, 1);
    let pkt0 = encode_full(&mut enc, &pcm0, fs, 1000);
    let pkt1 = encode_full(&mut enc, &pcm1, fs, 1000);

    let mut dec = OpusDecoder::new(sr, ch).unwrap();
    let (bl_rms0, bl_rms1) = baseline_two(&mut dec, &pkt0, &pkt1, fs, ch);

    let payload0 = &pkt0[1..];
    let payload1 = &pkt1[1..];
    let toc1 = (pkt0[0] & 0xFC) | 0x01;
    let mut c1 = vec![toc1];
    c1.extend_from_slice(payload0);
    c1.extend_from_slice(payload1);

    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2];
    dec_mf.decode(&c1, fs * 2, &mut out).unwrap();

    let r0 = rms(&out[..fs * ch]);
    let r1 = rms(&out[fs * ch..]);
    assert!((r0 / bl_rms0 - 1.0).abs() < 0.1, "frame 0: {:.6} vs {:.6}", r0, bl_rms0);
    assert!((r1 / bl_rms1 - 1.0).abs() < 0.1, "frame 1: {:.6} vs {:.6}", r1, bl_rms1);
}

#[test]
fn test_multi_frame_code_2_unequal_payloads() {
    let sr = 48000;
    let ch = 1;
    let fs = 960;

    let mut enc = OpusEncoder::new(sr, ch, Application::RestrictedLowDelay).unwrap();
    enc.bitrate_bps = 64000;

    let pcm_silence = vec![0.0f32; fs];
    let pcm_tone = make_sine(440.0, sr, fs, ch, 0);
    let pkt_sil = encode_full(&mut enc, &pcm_silence, fs, 400);
    // fresh encoder for tone to avoid state interference
    let mut enc2 = OpusEncoder::new(sr, ch, Application::RestrictedLowDelay).unwrap();
    enc2.bitrate_bps = 64000;
    let pkt_tone = encode_full(&mut enc2, &pcm_tone, fs, 400);

    // Baseline: both frames through same decoder
    let mut dec = OpusDecoder::new(sr, ch).unwrap();
    let (_, bl_tone) = baseline_two(&mut dec, &pkt_sil, &pkt_tone, fs, ch);

    // Code 2: silence first (smaller), tone second
    let payload_sil = &pkt_sil[1..];
    let payload_tone = &pkt_tone[1..];
    let toc2 = (pkt_sil[0] & 0xFC) | 0x02;
    let first_len = payload_sil.len();
    let mut c2 = vec![toc2];
    if first_len < 128 {
        c2.push(first_len as u8);
    } else {
        c2.push(0x80 | (first_len >> 8) as u8);
        c2.push(first_len as u8);
    }
    c2.extend_from_slice(payload_sil);
    c2.extend_from_slice(payload_tone);

    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2];
    dec_mf.decode(&c2, fs * 2, &mut out).unwrap();

    let r_sil = rms(&out[..fs]);
    let r_tone = rms(&out[fs..]);
    assert!(r_sil < 0.001, "silence frame should be near zero, got {:.6}", r_sil);
    assert!((r_tone / bl_tone - 1.0).abs() < 0.02, "tone frame: {:.6} vs {:.6}", r_tone, bl_tone);
}

#[test]
fn test_multi_frame_all_codes_stereo() {
    let sr = 48000;
    let ch = 2;
    let fs = 960;

    let mut enc = OpusEncoder::new(sr, ch, Application::Audio).unwrap();
    enc.bitrate_bps = 96000;

    let pcm0 = make_sine(440.0, sr, fs, ch, 0);
    let pcm1 = make_sine(660.0, sr, fs, ch, 1);
    let pkt0 = encode_full(&mut enc, &pcm0, fs, 1000);
    let pkt1 = encode_full(&mut enc, &pcm1, fs, 1000);

    let mut dec = OpusDecoder::new(sr, ch).unwrap();
    let (bl_rms0, bl_rms1) = baseline_two(&mut dec, &pkt0, &pkt1, fs, ch);

    let payload0 = &pkt0[1..];
    let payload1 = &pkt1[1..];
    let base_toc = pkt0[0] & 0xFC;

    // Code 1
    let mut c1 = vec![base_toc | 0x01];
    c1.extend_from_slice(payload0);
    c1.extend_from_slice(payload1);
    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2 * ch];
    dec_mf.decode(&c1, fs * 2, &mut out).unwrap();
    let r0 = rms(&out[..fs * ch]);
    let r1 = rms(&out[fs * ch..]);
    assert!((r0 / bl_rms0 - 1.0).abs() < 0.05, "C1 f0: {:.6} vs {:.6}", r0, bl_rms0);
    assert!((r1 / bl_rms1 - 1.0).abs() < 0.05, "C1 f1: {:.6} vs {:.6}", r1, bl_rms1);

    // Code 2
    let first_len = payload0.len();
    let mut c2 = vec![base_toc | 0x02];
    if first_len < 128 {
        c2.push(first_len as u8);
    } else {
        c2.push(0x80 | (first_len >> 8) as u8);
        c2.push(first_len as u8);
    }
    c2.extend_from_slice(payload0);
    c2.extend_from_slice(payload1);
    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2 * ch];
    dec_mf.decode(&c2, fs * 2, &mut out).unwrap();
    assert!((rms(&out[..fs * ch]) / bl_rms0 - 1.0).abs() < 0.05, "C2 f0 mismatch");
    assert!((rms(&out[fs * ch..]) / bl_rms1 - 1.0).abs() < 0.05, "C2 f1 mismatch");

    // Code 3 with padding
    let max_len = payload0.len().max(payload1.len());
    let mut p0 = payload0.to_vec();
    let mut p1 = payload1.to_vec();
    p0.resize(max_len, 0);
    p1.resize(max_len, 0);
    let mut c3 = vec![base_toc | 0x03];
    c3.push(0x42);
    c3.push(0x00);
    c3.extend_from_slice(&p0);
    c3.extend_from_slice(&p1);
    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2 * ch];
    dec_mf.decode(&c3, fs * 2, &mut out).unwrap();
    assert!((rms(&out[..fs * ch]) / bl_rms0 - 1.0).abs() < 0.05, "C3p f0 mismatch");
    assert!((rms(&out[fs * ch..]) / bl_rms1 - 1.0).abs() < 0.05, "C3p f1 mismatch");

    // Code 3 self-delimiting
    let len0 = payload0.len();
    let mut c3s = vec![base_toc | 0x03];
    c3s.push(0x02);
    if len0 < 128 {
        c3s.push(len0 as u8);
    } else {
        c3s.push(0x80 | (len0 >> 8) as u8);
        c3s.push(len0 as u8);
    }
    c3s.extend_from_slice(payload0);
    c3s.extend_from_slice(payload1);
    let mut dec_mf = OpusDecoder::new(sr, ch).unwrap();
    let mut out = vec![0.0f32; fs * 2 * ch];
    dec_mf.decode(&c3s, fs * 2, &mut out).unwrap();
    assert!((rms(&out[..fs * ch]) / bl_rms0 - 1.0).abs() < 0.05, "C3s f0 mismatch");
    assert!((rms(&out[fs * ch..]) / bl_rms1 - 1.0).abs() < 0.05, "C3s f1 mismatch");
}