opus-rs 0.1.16

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

use opus_rs::range_coder::RangeCoder;
use opus_rs::silk::define::*;
use opus_rs::silk::encode_indices::silk_encode_indices;
use opus_rs::silk::structs::SilkEncoderState;
use opus_rs::silk::tables_nlsf::{SILK_NLSF_CB_NB_MB, SILK_NLSF_CB_WB};

use proptest::prelude::*;

fn max_lag_index(fs_khz: i32) -> i16 {
    ((PE_MAX_LAG_MS - PE_MIN_LAG_MS) as i32 * fs_khz) as i16
}

fn make_enc(fs_khz: i32, nb_subfr: i32, lag_index: i16, prev_lag_index: i16) -> SilkEncoderState {
    let mut enc = SilkEncoderState::default();
    enc.s_cmn.fs_khz = fs_khz;
    enc.s_cmn.nb_subfr = nb_subfr;
    enc.s_cmn.ec_prev_signal_type = TYPE_NO_VOICE_ACTIVITY;
    enc.s_cmn.ec_prev_lag_index = prev_lag_index;
    enc.ps_nlsf_cb = Some(if fs_khz == 16 {
        &SILK_NLSF_CB_WB
    } else {
        &SILK_NLSF_CB_NB_MB
    });
    enc.s_cmn.indices.signal_type = TYPE_VOICED as i8;
    enc.s_cmn.indices.quant_offset_type = 0;
    enc.s_cmn.indices.lag_index = lag_index;
    enc.s_cmn.indices.contour_index = 0;
    enc.s_cmn.indices.per_index = 0;
    enc.s_cmn.indices.nlsf_interp_coef_q2 = 4;
    enc.s_cmn.indices.gains_indices[0] = 0;
    enc.s_cmn.indices.seed = 0;
    enc
}

fn fs_khz_strategy() -> impl Strategy<Value = i32> {
    prop_oneof![Just(8), Just(12), Just(16)]
}

fn nb_subfr_strategy() -> impl Strategy<Value = i32> {
    prop_oneof![Just(2), Just(4)]
}

proptest! {
    #[test]
    fn prop_lag_index_full_range_no_panic(
        fs_khz in fs_khz_strategy(),
        nb_subfr in nb_subfr_strategy(),
        lag_index in 0i16..=288i16,
    ) {
        let lag_index = lag_index.min(max_lag_index(fs_khz));
        let mut enc = make_enc(fs_khz, nb_subfr, lag_index, 0);
        let mut rc = RangeCoder::new_encoder(1024);
        silk_encode_indices(&mut enc, &mut rc, 0, false, CODE_INDEPENDENTLY);
        prop_assert!(
            rc.error == 0,
            "error set for fs_khz={} lag_index={}", fs_khz, lag_index
        );
    }

    #[test]
    fn prop_lag_index_conditional_coding(
        fs_khz in fs_khz_strategy(),
        nb_subfr in nb_subfr_strategy(),
        lag_index in 0i16..=288i16,
        prev_lag_index in 0i16..=288i16,
    ) {
        let max_idx = max_lag_index(fs_khz);
        let lag_index = lag_index.min(max_idx);
        let prev_lag_index = prev_lag_index.min(max_idx);
        let mut enc = make_enc(fs_khz, nb_subfr, lag_index, prev_lag_index);
        enc.s_cmn.ec_prev_signal_type = TYPE_VOICED;
        let mut rc = RangeCoder::new_encoder(1024);
        silk_encode_indices(&mut enc, &mut rc, 0, false, CODE_CONDITIONALLY);
        prop_assert!(
            rc.error == 0,
            "error set for fs_khz={} lag_index={} prev={}", fs_khz, lag_index, prev_lag_index
        );
    }

    #[test]
    fn prop_lag_index_beyond_max_is_clamped(
        fs_khz in fs_khz_strategy(),
        nb_subfr in nb_subfr_strategy(),
        lag_index in 0i16..=i16::MAX,
    ) {
        let mut enc = make_enc(fs_khz, nb_subfr, lag_index, 0);
        let mut rc = RangeCoder::new_encoder(1024);
        silk_encode_indices(&mut enc, &mut rc, 0, false, CODE_INDEPENDENTLY);
        prop_assert!(
            rc.error == 0,
            "error set for fs_khz={} lag_index={}", fs_khz, lag_index
        );
    }
}

#[test]
fn exhaustive_lag_index_all_sample_rates() {
    for fs_khz in [8i32, 12, 16] {
        let max_idx = max_lag_index(fs_khz);
        for lag_index in 0i16..=max_idx {
            for nb_subfr in [2i32, 4] {
                let mut enc = make_enc(fs_khz, nb_subfr, lag_index, 0);
                let mut rc = RangeCoder::new_encoder(1024);
                silk_encode_indices(&mut enc, &mut rc, 0, false, CODE_INDEPENDENTLY);
                assert_eq!(
                    rc.error, 0,
                    "fs_khz={fs_khz} nb_subfr={nb_subfr} lag_index={lag_index}"
                );
            }
        }
    }
}

#[test]
fn exhaustive_lag_index_conditional_all_sample_rates() {
    for fs_khz in [8i32, 12, 16] {
        let max_idx = max_lag_index(fs_khz);
        for lag_index in (0i16..=max_idx).step_by(4) {
            for prev_lag_index in (0i16..=max_idx).step_by(8) {
                let mut enc = make_enc(fs_khz, 4, lag_index, prev_lag_index);
                enc.s_cmn.ec_prev_signal_type = TYPE_VOICED;
                let mut rc = RangeCoder::new_encoder(1024);
                silk_encode_indices(&mut enc, &mut rc, 0, false, CODE_CONDITIONALLY);
                assert_eq!(
                    rc.error, 0,
                    "fs_khz={fs_khz} lag_index={lag_index} prev={prev_lag_index}"
                );
            }
        }
    }
}