mousiki 0.2.1

Pure Rust 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

//! Port of `silk/stereo_MS_to_LR.c`.
//!
//! Converts an adaptive mid/side representation back to left/right stereo
//! samples while updating the decoder's stereo prediction state.

/// Number of milliseconds over which predictor interpolation occurs.
const STEREO_INTERP_LEN_MS: i32 = 8;

/// Decoder-side state that buffers the previous stereo predictors and the
/// two-sample overlap used when reconstructing left/right channels.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub struct StereoDecState {
    pub pred_prev_q13: [i16; 2],
    pub s_mid: [i16; 2],
    pub s_side: [i16; 2],
}

impl StereoDecState {
    /// Convert adaptive mid/side samples back to left/right stereo.
    ///
    /// Mirrors the behaviour of `silk_stereo_MS_to_LR` by first restoring the
    /// decoder's two-sample overlap history, then interpolating the predictor
    /// coefficients for the first `STEREO_INTERP_LEN_MS` milliseconds before
    /// applying the steady-state predictors. The updated side channel is finally
    /// combined with the mid channel to yield left and right PCM samples.
    pub fn ms_to_lr(
        &mut self,
        mid: &mut [i16],
        side: &mut [i16],
        pred_q13: &[i32; 2],
        fs_khz: i32,
        frame_length: usize,
    ) {
        debug_assert!(frame_length + 2 <= mid.len());
        debug_assert!(frame_length + 2 <= side.len());

        // Restore the two-sample history for the predictor filters.
        mid[..2].copy_from_slice(&self.s_mid);
        side[..2].copy_from_slice(&self.s_side);

        // Persist the final two samples for the next call.
        self.s_mid
            .copy_from_slice(&mid[frame_length..frame_length + 2]);
        self.s_side
            .copy_from_slice(&side[frame_length..frame_length + 2]);

        let mut pred0_q13 = i32::from(self.pred_prev_q13[0]);
        let mut pred1_q13 = i32::from(self.pred_prev_q13[1]);

        let interp_samples = (STEREO_INTERP_LEN_MS * fs_khz) as usize;
        let denom_q16 = div32_16(1 << 16, STEREO_INTERP_LEN_MS * fs_khz);
        let delta0_q13 = rshift_round(smulbb(pred_q13[0].wrapping_sub(pred0_q13), denom_q16), 16);
        let delta1_q13 = rshift_round(smulbb(pred_q13[1].wrapping_sub(pred1_q13), denom_q16), 16);

        for n in 0..interp_samples.min(frame_length) {
            pred0_q13 = pred0_q13.wrapping_add(delta0_q13);
            pred1_q13 = pred1_q13.wrapping_add(delta1_q13);

            let sum = lshift(
                add_lshift32(
                    i32::from(mid[n]).wrapping_add(i32::from(mid[n + 2])),
                    i32::from(mid[n + 1]),
                    1,
                ),
                9,
            );
            let sum = smlawb(lshift(i32::from(side[n + 1]), 8), sum, pred0_q13);
            let sum = smlawb(sum, lshift(i32::from(mid[n + 1]), 11), pred1_q13);
            side[n + 1] = sat16(rshift_round(sum, 8));
        }

        pred0_q13 = pred_q13[0];
        pred1_q13 = pred_q13[1];

        for n in interp_samples.min(frame_length)..frame_length {
            let sum = lshift(
                add_lshift32(
                    i32::from(mid[n]).wrapping_add(i32::from(mid[n + 2])),
                    i32::from(mid[n + 1]),
                    1,
                ),
                9,
            );
            let sum = smlawb(lshift(i32::from(side[n + 1]), 8), sum, pred0_q13);
            let sum = smlawb(sum, lshift(i32::from(mid[n + 1]), 11), pred1_q13);
            side[n + 1] = sat16(rshift_round(sum, 8));
        }

        self.pred_prev_q13[0] = sat16(pred_q13[0]);
        self.pred_prev_q13[1] = sat16(pred_q13[1]);

        for n in 0..frame_length {
            let mid_val = i32::from(mid[n + 1]);
            let side_val = i32::from(side[n + 1]);
            let sum = mid_val.wrapping_add(side_val);
            let diff = mid_val.wrapping_sub(side_val);
            mid[n + 1] = sat16(sum);
            side[n + 1] = sat16(diff);
        }
    }
}

fn div32_16(a: i32, b: i32) -> i32 {
    a / b
}

fn add_lshift32(a: i32, b: i32, shift: i32) -> i32 {
    a.wrapping_add(b.wrapping_shl(shift as u32))
}

fn lshift(value: i32, shift: i32) -> i32 {
    value.wrapping_shl(shift as u32)
}

fn smulbb(a: i32, b: i32) -> i32 {
    i32::from(a as i16).wrapping_mul(i32::from(b as i16))
}

fn smlawb(a: i32, b: i32, c: i32) -> i32 {
    let c16 = i64::from(c as i16);
    let prod = (i64::from(b) * c16) >> 16;
    a.wrapping_add(prod as i32)
}

fn rshift_round(value: i32, shift: u32) -> i32 {
    if shift == 0 {
        value
    } else if shift == 1 {
        (value >> 1).wrapping_add(value & 1)
    } else {
        ((value >> (shift - 1)) + 1) >> 1
    }
}

fn sat16(value: i32) -> i16 {
    if value > i32::from(i16::MAX) {
        i16::MAX
    } else if value < i32::from(i16::MIN) {
        i16::MIN
    } else {
        value as i16
    }
}

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

    #[test]
    fn converts_mid_side_to_left_right_with_zero_predictor() {
        let mut state = StereoDecState::default();
        state.s_mid = [10, -11];
        state.s_side = [7, -6];

        let frame_length = 16;
        let mut mid = vec![0i16; frame_length + 2];
        let mut side = vec![0i16; frame_length + 2];

        for (idx, sample) in (2..frame_length + 2).enumerate() {
            mid[sample] = (idx as i16).wrapping_mul(3);
            side[sample] = -(idx as i16).wrapping_mul(2);
        }

        let mut expected_mid = mid.clone();
        let mut expected_side = side.clone();
        let mut expected_state = state;

        expected_mid[..2].copy_from_slice(&expected_state.s_mid);
        expected_side[..2].copy_from_slice(&expected_state.s_side);

        expected_state.s_mid = [expected_mid[frame_length], expected_mid[frame_length + 1]];
        expected_state.s_side = [expected_side[frame_length], expected_side[frame_length + 1]];

        for n in 0..frame_length {
            let mid_val = i32::from(expected_mid[n + 1]);
            let side_val = i32::from(expected_side[n + 1]);
            expected_mid[n + 1] = sat16(mid_val + side_val);
            expected_side[n + 1] = sat16(mid_val - side_val);
        }

        state.ms_to_lr(&mut mid, &mut side, &[0; 2], 16, frame_length);

        assert_eq!(state, expected_state);
        assert_eq!(mid, expected_mid);
        assert_eq!(side, expected_side);
    }

    #[test]
    fn updates_state_and_applies_predictors() {
        let mut state = StereoDecState {
            pred_prev_q13: [500, -300],
            s_mid: [2, -3],
            s_side: [-4, 5],
        };

        let frame_length = 20;
        let mut mid = vec![0i16; frame_length + 2];
        let mut side = vec![0i16; frame_length + 2];

        for n in 2..frame_length + 2 {
            mid[n] = (100 - n as i32) as i16;
            side[n] = (n as i32 - 50) as i16;
        }

        let pred_q13 = [1200, -900];

        let mut expected_state = state;
        let mut expected_mid = mid.clone();
        let mut expected_side = side.clone();

        expected_mid[..2].copy_from_slice(&expected_state.s_mid);
        expected_side[..2].copy_from_slice(&expected_state.s_side);
        expected_state
            .s_mid
            .copy_from_slice(&expected_mid[frame_length..frame_length + 2]);
        expected_state
            .s_side
            .copy_from_slice(&expected_side[frame_length..frame_length + 2]);

        let interp_samples = (STEREO_INTERP_LEN_MS * 8) as usize;
        let denom_q16 = div32_16(1 << 16, STEREO_INTERP_LEN_MS * 8);
        let mut pred0_q13 = i32::from(expected_state.pred_prev_q13[0]);
        let mut pred1_q13 = i32::from(expected_state.pred_prev_q13[1]);
        let delta0_q13 = rshift_round(smulbb(pred_q13[0] - pred0_q13, denom_q16), 16);
        let delta1_q13 = rshift_round(smulbb(pred_q13[1] - pred1_q13, denom_q16), 16);

        for n in 0..interp_samples.min(frame_length) {
            pred0_q13 = pred0_q13.wrapping_add(delta0_q13);
            pred1_q13 = pred1_q13.wrapping_add(delta1_q13);

            let sum = lshift(
                add_lshift32(
                    i32::from(expected_mid[n]).wrapping_add(i32::from(expected_mid[n + 2])),
                    i32::from(expected_mid[n + 1]),
                    1,
                ),
                9,
            );
            let sum = smlawb(lshift(i32::from(expected_side[n + 1]), 8), sum, pred0_q13);
            let sum = smlawb(sum, lshift(i32::from(expected_mid[n + 1]), 11), pred1_q13);
            expected_side[n + 1] = sat16(rshift_round(sum, 8));
        }

        pred0_q13 = pred_q13[0];
        pred1_q13 = pred_q13[1];

        for n in interp_samples.min(frame_length)..frame_length {
            let sum = lshift(
                add_lshift32(
                    i32::from(expected_mid[n]).wrapping_add(i32::from(expected_mid[n + 2])),
                    i32::from(expected_mid[n + 1]),
                    1,
                ),
                9,
            );
            let sum = smlawb(lshift(i32::from(expected_side[n + 1]), 8), sum, pred0_q13);
            let sum = smlawb(sum, lshift(i32::from(expected_mid[n + 1]), 11), pred1_q13);
            expected_side[n + 1] = sat16(rshift_round(sum, 8));
        }

        expected_state.pred_prev_q13[0] = pred_q13[0] as i16;
        expected_state.pred_prev_q13[1] = pred_q13[1] as i16;

        for n in 0..frame_length {
            let mid_val = i32::from(expected_mid[n + 1]);
            let side_val = i32::from(expected_side[n + 1]);
            expected_mid[n + 1] = sat16(mid_val + side_val);
            expected_side[n + 1] = sat16(mid_val - side_val);
        }

        state.ms_to_lr(&mut mid, &mut side, &pred_q13, 8, frame_length);

        assert_eq!(state, expected_state);
        assert_eq!(mid, expected_mid);
        assert_eq!(side, expected_side);
    }
}