Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / silk_stereo_LR_to_MS.c
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #include "silk_main.h"
29
30 /* Convert Left/Right stereo signal to adaptive Mid/Side representation */
31 void silk_stereo_LR_to_MS(
32     stereo_enc_state    *state,                         /* I/O  State                                       */
33     opus_int16           x1[],                           /* I/O  Left input signal, becomes mid signal       */
34     opus_int16           x2[],                           /* I/O  Right input signal, becomes side signal     */
35     opus_int8            ix[ 2 ][ 4 ],                   /* O    Quantization indices                        */
36     opus_int32           mid_side_rates_bps[],           /* O    Bitrates for mid and side signals           */
37     opus_int32           total_rate_bps,                 /* I    Total bitrate                               */
38     opus_int             prev_speech_act_Q8,             /* I    Speech activity level in previous frame     */
39     opus_int             fs_kHz,                         /* I    Sample rate (kHz)                           */
40     opus_int             frame_length                    /* I    Number of samples                           */
41 )
42 {
43     opus_int   n, is10msFrame, denom_Q16, delta0_Q13, delta1_Q13;
44     opus_int32 sum, diff, smooth_coef_Q16, pred_Q13[ 2 ], pred0_Q13, pred1_Q13;
45     opus_int32 LP_ratio_Q14, HP_ratio_Q14, frac_Q16, frac_3_Q16, min_mid_rate_bps, width_Q14, w_Q24, deltaw_Q24;
46     opus_int16 side[ MAX_FRAME_LENGTH + 2 ];
47     opus_int16 LP_mid[  MAX_FRAME_LENGTH ], HP_mid[  MAX_FRAME_LENGTH ];
48     opus_int16 LP_side[ MAX_FRAME_LENGTH ], HP_side[ MAX_FRAME_LENGTH ];
49     opus_int16 *mid = &x1[ -2 ];
50
51     /* Convert to basic mid/side signals */
52     for( n = 0; n < frame_length + 2; n++ ) {
53         sum  = x1[ n - 2 ] + (opus_int32)x2[ n - 2 ];
54         diff = x1[ n - 2 ] - (opus_int32)x2[ n - 2 ];
55         mid[  n ] = (opus_int16)SKP_RSHIFT_ROUND( sum, 1 );
56         side[ n ] = (opus_int16)SKP_SAT16( SKP_RSHIFT_ROUND( diff, 1 ) );
57     }
58
59     /* Buffering */
60     SKP_memcpy( mid,  state->sMid,  2 * sizeof( opus_int16 ) );
61     SKP_memcpy( side, state->sSide, 2 * sizeof( opus_int16 ) );
62     SKP_memcpy( state->sMid,  &mid[  frame_length ], 2 * sizeof( opus_int16 ) );
63     SKP_memcpy( state->sSide, &side[ frame_length ], 2 * sizeof( opus_int16 ) );
64
65     /* LP and HP filter mid signal */
66     for( n = 0; n < frame_length; n++ ) {
67         sum = SKP_RSHIFT_ROUND( SKP_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 2 );
68         LP_mid[ n ] = sum;
69         HP_mid[ n ] = mid[ n + 1 ] - sum;
70     }
71
72     /* LP and HP filter side signal */
73     for( n = 0; n < frame_length; n++ ) {
74         sum = SKP_RSHIFT_ROUND( SKP_ADD_LSHIFT( side[ n ] + side[ n + 2 ], side[ n + 1 ], 1 ), 2 );
75         LP_side[ n ] = sum;
76         HP_side[ n ] = side[ n + 1 ] - sum;
77     }
78
79     /* Find energies and predictors */
80     is10msFrame = frame_length == 10 * fs_kHz;
81     smooth_coef_Q16 = is10msFrame ?
82         SILK_FIX_CONST( STEREO_RATIO_SMOOTH_COEF / 2, 16 ) :
83         SILK_FIX_CONST( STEREO_RATIO_SMOOTH_COEF,     16 );
84     smooth_coef_Q16 = SKP_SMULWB( SKP_SMULBB( prev_speech_act_Q8 , prev_speech_act_Q8 ), smooth_coef_Q16 );
85
86     pred_Q13[ 0 ] = silk_stereo_find_predictor( &LP_ratio_Q14, LP_mid, LP_side, &state->mid_side_amp_Q0[ 0 ], frame_length, smooth_coef_Q16 );
87     pred_Q13[ 1 ] = silk_stereo_find_predictor( &HP_ratio_Q14, HP_mid, HP_side, &state->mid_side_amp_Q0[ 2 ], frame_length, smooth_coef_Q16 );
88     /* Ratio of the norms of residual and mid signals */
89     frac_Q16 = SKP_SMLABB( HP_ratio_Q14, LP_ratio_Q14, 3 );
90     frac_Q16 = SKP_min( frac_Q16, SILK_FIX_CONST( 1, 16 ) );
91
92     /* Determine bitrate distribution between mid and side, and possibly reduce stereo width */
93     total_rate_bps -= is10msFrame ? 1200 : 600;      /* Subtract approximate bitrate for coding stereo parameters */
94     min_mid_rate_bps = SKP_SMLABB( 2000, fs_kHz, 900 );
95     SKP_assert( min_mid_rate_bps < 32767 );
96     /* Default bitrate distribution: 8 parts for Mid and (5+3*frac) parts for Side. so: mid_rate = ( 8 / ( 13 + 3 * frac ) ) * total_ rate */
97     frac_3_Q16 = SKP_MUL( 3, frac_Q16 );
98     mid_side_rates_bps[ 0 ] = silk_DIV32_varQ( total_rate_bps, SILK_FIX_CONST( 8 + 5, 16 ) + frac_3_Q16, 16+3 );
99     /* If Mid bitrate below minimum, reduce stereo width */
100     if( mid_side_rates_bps[ 0 ] < min_mid_rate_bps ) {
101         mid_side_rates_bps[ 0 ] = min_mid_rate_bps;
102         mid_side_rates_bps[ 1 ] = total_rate_bps - mid_side_rates_bps[ 0 ];
103         /* width = 4 * ( 2 * side_rate - min_rate ) / ( ( 1 + 3 * frac ) * min_rate ) */
104         width_Q14 = silk_DIV32_varQ( SKP_LSHIFT( mid_side_rates_bps[ 1 ], 1 ) - min_mid_rate_bps,
105             SKP_SMULWB( SILK_FIX_CONST( 1, 16 ) + frac_3_Q16, min_mid_rate_bps ), 14+2 );
106         width_Q14 = SKP_LIMIT( width_Q14, 0, SILK_FIX_CONST( 1, 14 ) );
107     } else {
108         mid_side_rates_bps[ 1 ] = total_rate_bps - mid_side_rates_bps[ 0 ];
109         width_Q14 = SILK_FIX_CONST( 1, 14 );
110     }
111
112     /* Smoother */
113     state->smth_width_Q14 = (opus_int16)SKP_SMLAWB( state->smth_width_Q14, width_Q14 - state->smth_width_Q14, smooth_coef_Q16 );
114
115     /* Reduce predictors */
116     pred_Q13[ 0 ] = SKP_RSHIFT( SKP_SMULBB( state->smth_width_Q14, pred_Q13[ 0 ] ), 14 );
117     pred_Q13[ 1 ] = SKP_RSHIFT( SKP_SMULBB( state->smth_width_Q14, pred_Q13[ 1 ] ), 14 );
118
119     ix[ 0 ][ 3 ] = 0;
120     if( state->width_prev_Q14 == 0 &&
121         ( 8 * total_rate_bps < 13 * min_mid_rate_bps || SKP_SMULWB( frac_Q16, state->smth_width_Q14 ) < SILK_FIX_CONST( 0.05, 14 ) ) )
122     {
123         width_Q14 = 0;
124         /* Only encode mid channel */
125         mid_side_rates_bps[ 0 ] = total_rate_bps;
126         mid_side_rates_bps[ 1 ] = 0;
127         ix[ 0 ][ 3 ] = 1;
128     } else if( state->width_prev_Q14 != 0 &&
129         ( 8 * total_rate_bps < 11 * min_mid_rate_bps || SKP_SMULWB( frac_Q16, state->smth_width_Q14 ) < SILK_FIX_CONST( 0.02, 14 ) ) )
130     {
131         width_Q14 = 0;
132     } else if( state->smth_width_Q14 > SILK_FIX_CONST( 0.95, 14 ) ) {
133         width_Q14 = SILK_FIX_CONST( 1, 14 );
134     } else {
135         width_Q14 = state->smth_width_Q14;
136     }
137
138 #if 0
139     DEBUG_STORE_DATA( midside.dat, &mid_side_rates_bps[ 0 ], 8 );
140     DEBUG_STORE_DATA( norms0.pcm, &state->mid_side_amp_Q0[0], 8 );
141     DEBUG_STORE_DATA( norms1.pcm, &state->mid_side_amp_Q0[2], 8 );
142     DEBUG_STORE_DATA( width.pcm, &width_Q14, 4 );
143 #endif
144
145     /* Quantize predictors */
146     silk_stereo_quant_pred( state, pred_Q13, ix );
147
148     /* Interpolate predictors and subtract prediction from side channel */
149     pred0_Q13  = -state->pred_prev_Q13[ 0 ];
150     pred1_Q13  = -state->pred_prev_Q13[ 1 ];
151     w_Q24      =  SKP_LSHIFT( state->width_prev_Q14, 10 );
152     denom_Q16  = SKP_DIV32_16( 1 << 16, STEREO_INTERP_LEN_MS * fs_kHz );
153     delta0_Q13 = -SKP_RSHIFT_ROUND( SKP_SMULBB( pred_Q13[ 0 ] - state->pred_prev_Q13[ 0 ], denom_Q16 ), 16 );
154     delta1_Q13 = -SKP_RSHIFT_ROUND( SKP_SMULBB( pred_Q13[ 1 ] - state->pred_prev_Q13[ 1 ], denom_Q16 ), 16 );
155     deltaw_Q24 =  SKP_LSHIFT( SKP_SMULWB( width_Q14 - state->width_prev_Q14, denom_Q16 ), 10 );
156     for( n = 0; n < STEREO_INTERP_LEN_MS * fs_kHz; n++ ) {
157         pred0_Q13 += delta0_Q13;
158         pred1_Q13 += delta1_Q13;
159         w_Q24   += deltaw_Q24;
160         sum = SKP_LSHIFT( SKP_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 9 );      /* Q11 */
161         sum = SKP_SMLAWB( SKP_SMULWB( w_Q24, side[ n + 1 ] ), sum, pred0_Q13 );                 /* Q8  */
162         sum = SKP_SMLAWB( sum, SKP_LSHIFT( ( opus_int32 )mid[ n + 1 ], 11 ), pred1_Q13 );        /* Q8  */
163         x2[ n - 1 ] = (opus_int16)SKP_SAT16( SKP_RSHIFT_ROUND( sum, 8 ) );
164     }
165     pred0_Q13 = -pred_Q13[ 0 ];
166     pred1_Q13 = -pred_Q13[ 1 ];
167     w_Q24     =  SKP_LSHIFT( width_Q14, 10 );
168     for( n = STEREO_INTERP_LEN_MS * fs_kHz; n < frame_length; n++ ) {
169         sum = SKP_LSHIFT( SKP_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 9 );      /* Q11 */
170         sum = SKP_SMLAWB( SKP_SMULWB( w_Q24, side[ n + 1 ] ), sum, pred0_Q13 );                 /* Q8  */
171         sum = SKP_SMLAWB( sum, SKP_LSHIFT( ( opus_int32 )mid[ n + 1 ], 11 ), pred1_Q13 );        /* Q8  */
172         x2[ n - 1 ] = (opus_int16)SKP_SAT16( SKP_RSHIFT_ROUND( sum, 8 ) );
173     }
174     state->pred_prev_Q13[ 0 ] = (opus_int16)pred_Q13[ 0 ];
175     state->pred_prev_Q13[ 1 ] = (opus_int16)pred_Q13[ 1 ];
176     state->width_prev_Q14     = (opus_int16)width_Q14;
177 }