SILK stereo fix
[opus.git] / 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 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "main.h"
33
34 /* Convert Left/Right stereo signal to adaptive Mid/Side representation */
35 void silk_stereo_LR_to_MS(
36     stereo_enc_state    *state,                         /* I/O  State                                       */
37     opus_int16           x1[],                           /* I/O  Left input signal, becomes mid signal       */
38     opus_int16           x2[],                           /* I/O  Right input signal, becomes side signal     */
39     opus_int8            ix[ 2 ][ 3 ],                   /* O    Quantization indices                        */
40     opus_int8            *mid_only_flag,                 /* O    Flag: only mid signal coded                 */
41     opus_int32           mid_side_rates_bps[],           /* O    Bitrates for mid and side signals           */
42     opus_int32           total_rate_bps,                 /* I    Total bitrate                               */
43     opus_int             prev_speech_act_Q8,             /* I    Speech activity level in previous frame     */
44     opus_int             fs_kHz,                         /* I    Sample rate (kHz)                           */
45     opus_int             frame_length                    /* I    Number of samples                           */
46 )
47 {
48     opus_int   n, is10msFrame, denom_Q16, delta0_Q13, delta1_Q13;
49     opus_int32 sum, diff, smooth_coef_Q16, pred_Q13[ 2 ], pred0_Q13, pred1_Q13;
50     opus_int32 LP_ratio_Q14, HP_ratio_Q14, frac_Q16, frac_3_Q16, min_mid_rate_bps, width_Q14, w_Q24, deltaw_Q24;
51     opus_int16 side[ MAX_FRAME_LENGTH + 2 ];
52     opus_int16 LP_mid[  MAX_FRAME_LENGTH ], HP_mid[  MAX_FRAME_LENGTH ];
53     opus_int16 LP_side[ MAX_FRAME_LENGTH ], HP_side[ MAX_FRAME_LENGTH ];
54     opus_int16 *mid = &x1[ -2 ];
55
56     /* Convert to basic mid/side signals */
57     for( n = 0; n < frame_length + 2; n++ ) {
58         sum  = x1[ n - 2 ] + (opus_int32)x2[ n - 2 ];
59         diff = x1[ n - 2 ] - (opus_int32)x2[ n - 2 ];
60         mid[  n ] = (opus_int16)silk_RSHIFT_ROUND( sum, 1 );
61         side[ n ] = (opus_int16)silk_SAT16( silk_RSHIFT_ROUND( diff, 1 ) );
62     }
63
64     /* Buffering */
65     silk_memcpy( mid,  state->sMid,  2 * sizeof( opus_int16 ) );
66     silk_memcpy( side, state->sSide, 2 * sizeof( opus_int16 ) );
67     silk_memcpy( state->sMid,  &mid[  frame_length ], 2 * sizeof( opus_int16 ) );
68     silk_memcpy( state->sSide, &side[ frame_length ], 2 * sizeof( opus_int16 ) );
69
70     /* LP and HP filter mid signal */
71     for( n = 0; n < frame_length; n++ ) {
72         sum = silk_RSHIFT_ROUND( silk_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 2 );
73         LP_mid[ n ] = sum;
74         HP_mid[ n ] = mid[ n + 1 ] - sum;
75     }
76
77     /* LP and HP filter side signal */
78     for( n = 0; n < frame_length; n++ ) {
79         sum = silk_RSHIFT_ROUND( silk_ADD_LSHIFT( side[ n ] + side[ n + 2 ], side[ n + 1 ], 1 ), 2 );
80         LP_side[ n ] = sum;
81         HP_side[ n ] = side[ n + 1 ] - sum;
82     }
83
84     /* Find energies and predictors */
85     is10msFrame = frame_length == 10 * fs_kHz;
86     smooth_coef_Q16 = is10msFrame ?
87         SILK_FIX_CONST( STEREO_RATIO_SMOOTH_COEF / 2, 16 ) :
88         SILK_FIX_CONST( STEREO_RATIO_SMOOTH_COEF,     16 );
89     smooth_coef_Q16 = silk_SMULWB( silk_SMULBB( prev_speech_act_Q8 , prev_speech_act_Q8 ), smooth_coef_Q16 );
90
91     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 );
92     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 );
93     /* Ratio of the norms of residual and mid signals */
94     frac_Q16 = silk_SMLABB( HP_ratio_Q14, LP_ratio_Q14, 3 );
95     frac_Q16 = silk_min( frac_Q16, SILK_FIX_CONST( 1, 16 ) );
96
97     /* Determine bitrate distribution between mid and side, and possibly reduce stereo width */
98     total_rate_bps -= is10msFrame ? 1200 : 600;      /* Subtract approximate bitrate for coding stereo parameters */
99     if (total_rate_bps < 1 ) {
100         total_rate_bps = 1;
101     }
102     min_mid_rate_bps = silk_SMLABB( 2000, fs_kHz, 900 );
103     silk_assert( min_mid_rate_bps < 32767 );
104     /* Default bitrate distribution: 8 parts for Mid and (5+3*frac) parts for Side. so: mid_rate = ( 8 / ( 13 + 3 * frac ) ) * total_ rate */
105     frac_3_Q16 = silk_MUL( 3, frac_Q16 );
106     mid_side_rates_bps[ 0 ] = silk_DIV32_varQ( total_rate_bps, SILK_FIX_CONST( 8 + 5, 16 ) + frac_3_Q16, 16+3 );
107     /* If Mid bitrate below minimum, reduce stereo width */
108     if( mid_side_rates_bps[ 0 ] < min_mid_rate_bps ) {
109         mid_side_rates_bps[ 0 ] = min_mid_rate_bps;
110         mid_side_rates_bps[ 1 ] = total_rate_bps - mid_side_rates_bps[ 0 ];
111         /* width = 4 * ( 2 * side_rate - min_rate ) / ( ( 1 + 3 * frac ) * min_rate ) */
112         width_Q14 = silk_DIV32_varQ( silk_LSHIFT( mid_side_rates_bps[ 1 ], 1 ) - min_mid_rate_bps,
113             silk_SMULWB( SILK_FIX_CONST( 1, 16 ) + frac_3_Q16, min_mid_rate_bps ), 14+2 );
114         width_Q14 = silk_LIMIT( width_Q14, 0, SILK_FIX_CONST( 1, 14 ) );
115     } else {
116         mid_side_rates_bps[ 1 ] = total_rate_bps - mid_side_rates_bps[ 0 ];
117         width_Q14 = SILK_FIX_CONST( 1, 14 );
118     }
119
120     /* Smoother */
121     state->smth_width_Q14 = (opus_int16)silk_SMLAWB( state->smth_width_Q14, width_Q14 - state->smth_width_Q14, smooth_coef_Q16 );
122
123     /* At very low bitrates or for inputs that are nearly amplitude panned, switch to panned-mono coding */
124     *mid_only_flag = 0;
125     if( state->width_prev_Q14 == 0 &&
126         ( 8 * total_rate_bps < 13 * min_mid_rate_bps || silk_SMULWB( frac_Q16, state->smth_width_Q14 ) < SILK_FIX_CONST( 0.05, 14 ) ) )
127     {
128         /* Code as panned-mono; previous frame already had zero width */
129         /* Scale down and quantize predictors */
130         pred_Q13[ 0 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 0 ] ), 14 );
131         pred_Q13[ 1 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 1 ] ), 14 );
132         silk_stereo_quant_pred( pred_Q13, ix );
133         /* Collapse stereo width */
134         width_Q14 = 0;
135         pred_Q13[ 0 ] = 0;
136         pred_Q13[ 1 ] = 0;
137         mid_side_rates_bps[ 0 ] = total_rate_bps;
138         mid_side_rates_bps[ 1 ] = 0;
139         *mid_only_flag = 1;
140     } else if( state->width_prev_Q14 != 0 &&
141         ( 8 * total_rate_bps < 11 * min_mid_rate_bps || silk_SMULWB( frac_Q16, state->smth_width_Q14 ) < SILK_FIX_CONST( 0.02, 14 ) ) )
142     {
143         /* Transition to zero-width stereo */
144         /* Scale down and quantize predictors */
145         pred_Q13[ 0 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 0 ] ), 14 );
146         pred_Q13[ 1 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 1 ] ), 14 );
147         silk_stereo_quant_pred( pred_Q13, ix );
148         /* Collapse stereo width */
149         width_Q14 = 0;
150         pred_Q13[ 0 ] = 0;
151         pred_Q13[ 1 ] = 0;
152     } else if( state->smth_width_Q14 > SILK_FIX_CONST( 0.95, 14 ) ) {
153         /* Full-width stereo coding */
154         silk_stereo_quant_pred( pred_Q13, ix );
155         width_Q14 = SILK_FIX_CONST( 1, 14 );
156     } else {
157         /* Reduced-width stereo coding; scale down and quantize predictors */
158         pred_Q13[ 0 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 0 ] ), 14 );
159         pred_Q13[ 1 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 1 ] ), 14 );
160         silk_stereo_quant_pred( pred_Q13, ix );
161         width_Q14 = state->smth_width_Q14;
162     }
163
164 #if 0
165     DEBUG_STORE_DATA( midside.dat, &mid_side_rates_bps[ 0 ], 8 );
166     DEBUG_STORE_DATA( norms0.pcm, &state->mid_side_amp_Q0[0], 8 );
167     DEBUG_STORE_DATA( norms1.pcm, &state->mid_side_amp_Q0[2], 8 );
168     DEBUG_STORE_DATA( width.pcm, &width_Q14, 4 );
169 #endif
170
171     /* Interpolate predictors and subtract prediction from side channel */
172     pred0_Q13  = -state->pred_prev_Q13[ 0 ];
173     pred1_Q13  = -state->pred_prev_Q13[ 1 ];
174     w_Q24      =  silk_LSHIFT( state->width_prev_Q14, 10 );
175     denom_Q16  = silk_DIV32_16( 1 << 16, STEREO_INTERP_LEN_MS * fs_kHz );
176     delta0_Q13 = -silk_RSHIFT_ROUND( silk_SMULBB( pred_Q13[ 0 ] - state->pred_prev_Q13[ 0 ], denom_Q16 ), 16 );
177     delta1_Q13 = -silk_RSHIFT_ROUND( silk_SMULBB( pred_Q13[ 1 ] - state->pred_prev_Q13[ 1 ], denom_Q16 ), 16 );
178     deltaw_Q24 =  silk_LSHIFT( silk_SMULWB( width_Q14 - state->width_prev_Q14, denom_Q16 ), 10 );
179     for( n = 0; n < STEREO_INTERP_LEN_MS * fs_kHz; n++ ) {
180         pred0_Q13 += delta0_Q13;
181         pred1_Q13 += delta1_Q13;
182         w_Q24   += deltaw_Q24;
183         sum = silk_LSHIFT( silk_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 9 );      /* Q11 */
184         sum = silk_SMLAWB( silk_SMULWB( w_Q24, side[ n + 1 ] ), sum, pred0_Q13 );                 /* Q8  */
185         sum = silk_SMLAWB( sum, silk_LSHIFT( ( opus_int32 )mid[ n + 1 ], 11 ), pred1_Q13 );        /* Q8  */
186         x2[ n - 1 ] = (opus_int16)silk_SAT16( silk_RSHIFT_ROUND( sum, 8 ) );
187     }
188
189     pred0_Q13 = -pred_Q13[ 0 ];
190     pred1_Q13 = -pred_Q13[ 1 ];
191     w_Q24     =  silk_LSHIFT( width_Q14, 10 );
192     for( n = STEREO_INTERP_LEN_MS * fs_kHz; n < frame_length; n++ ) {
193         sum = silk_LSHIFT( silk_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 9 );      /* Q11 */
194         sum = silk_SMLAWB( silk_SMULWB( w_Q24, side[ n + 1 ] ), sum, pred0_Q13 );                 /* Q8  */
195         sum = silk_SMLAWB( sum, silk_LSHIFT( ( opus_int32 )mid[ n + 1 ], 11 ), pred1_Q13 );        /* Q8  */
196         x2[ n - 1 ] = (opus_int16)silk_SAT16( silk_RSHIFT_ROUND( sum, 8 ) );
197     }
198     state->pred_prev_Q13[ 0 ] = (opus_int16)pred_Q13[ 0 ];
199     state->pred_prev_Q13[ 1 ] = (opus_int16)pred_Q13[ 1 ];
200     state->width_prev_Q14     = (opus_int16)width_Q14;
201 }