Avoids unnecessary collapse of the HF stereo image in hybrid mode.
[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             toMono,                         /* I    Last frame before a stereo->mono transition */
45     opus_int             fs_kHz,                         /* I    Sample rate (kHz)                           */
46     opus_int             frame_length                    /* I    Number of samples                           */
47 )
48 {
49     opus_int   n, is10msFrame, denom_Q16, delta0_Q13, delta1_Q13;
50     opus_int32 sum, diff, smooth_coef_Q16, pred_Q13[ 2 ], pred0_Q13, pred1_Q13;
51     opus_int32 LP_ratio_Q14, HP_ratio_Q14, frac_Q16, frac_3_Q16, min_mid_rate_bps, width_Q14, w_Q24, deltaw_Q24;
52     opus_int16 side[ MAX_FRAME_LENGTH + 2 ];
53     opus_int16 LP_mid[  MAX_FRAME_LENGTH ], HP_mid[  MAX_FRAME_LENGTH ];
54     opus_int16 LP_side[ MAX_FRAME_LENGTH ], HP_side[ MAX_FRAME_LENGTH ];
55     opus_int16 *mid = &x1[ -2 ];
56     opus_int16 effective_pred=0;
57
58     /* Convert to basic mid/side signals */
59     for( n = 0; n < frame_length + 2; n++ ) {
60         sum  = x1[ n - 2 ] + (opus_int32)x2[ n - 2 ];
61         diff = x1[ n - 2 ] - (opus_int32)x2[ n - 2 ];
62         mid[  n ] = (opus_int16)silk_RSHIFT_ROUND( sum, 1 );
63         side[ n ] = (opus_int16)silk_SAT16( silk_RSHIFT_ROUND( diff, 1 ) );
64     }
65
66     /* Buffering */
67     silk_memcpy( mid,  state->sMid,  2 * sizeof( opus_int16 ) );
68     silk_memcpy( side, state->sSide, 2 * sizeof( opus_int16 ) );
69     silk_memcpy( state->sMid,  &mid[  frame_length ], 2 * sizeof( opus_int16 ) );
70     silk_memcpy( state->sSide, &side[ frame_length ], 2 * sizeof( opus_int16 ) );
71
72     /* LP and HP filter mid signal */
73     for( n = 0; n < frame_length; n++ ) {
74         sum = silk_RSHIFT_ROUND( silk_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 2 );
75         LP_mid[ n ] = sum;
76         HP_mid[ n ] = mid[ n + 1 ] - sum;
77     }
78
79     /* LP and HP filter side signal */
80     for( n = 0; n < frame_length; n++ ) {
81         sum = silk_RSHIFT_ROUND( silk_ADD_LSHIFT( side[ n ] + side[ n + 2 ], side[ n + 1 ], 1 ), 2 );
82         LP_side[ n ] = sum;
83         HP_side[ n ] = side[ n + 1 ] - sum;
84     }
85
86     /* Find energies and predictors */
87     is10msFrame = frame_length == 10 * fs_kHz;
88     smooth_coef_Q16 = is10msFrame ?
89         SILK_FIX_CONST( STEREO_RATIO_SMOOTH_COEF / 2, 16 ) :
90         SILK_FIX_CONST( STEREO_RATIO_SMOOTH_COEF,     16 );
91     smooth_coef_Q16 = silk_SMULWB( silk_SMULBB( prev_speech_act_Q8 , prev_speech_act_Q8 ), smooth_coef_Q16 );
92
93     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 );
94     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 );
95     /* Ratio of the norms of residual and mid signals */
96     frac_Q16 = silk_SMLABB( HP_ratio_Q14, LP_ratio_Q14, 3 );
97     frac_Q16 = silk_min( frac_Q16, SILK_FIX_CONST( 1, 16 ) );
98
99     /* Determine bitrate distribution between mid and side, and possibly reduce stereo width */
100     total_rate_bps -= is10msFrame ? 1200 : 600;      /* Subtract approximate bitrate for coding stereo parameters */
101     if( total_rate_bps < 1 ) {
102         total_rate_bps = 1;
103     }
104     min_mid_rate_bps = silk_SMLABB( 2000, fs_kHz, 900 );
105     silk_assert( min_mid_rate_bps < 32767 );
106     /* Default bitrate distribution: 8 parts for Mid and (5+3*frac) parts for Side. so: mid_rate = ( 8 / ( 13 + 3 * frac ) ) * total_ rate */
107     frac_3_Q16 = silk_MUL( 3, frac_Q16 );
108     mid_side_rates_bps[ 0 ] = silk_DIV32_varQ( total_rate_bps, SILK_FIX_CONST( 8 + 5, 16 ) + frac_3_Q16, 16+3 );
109     /* If Mid bitrate below minimum, reduce stereo width */
110     if( mid_side_rates_bps[ 0 ] < min_mid_rate_bps ) {
111         mid_side_rates_bps[ 0 ] = min_mid_rate_bps;
112         mid_side_rates_bps[ 1 ] = total_rate_bps - mid_side_rates_bps[ 0 ];
113         /* width = 4 * ( 2 * side_rate - min_rate ) / ( ( 1 + 3 * frac ) * min_rate ) */
114         width_Q14 = silk_DIV32_varQ( silk_LSHIFT( mid_side_rates_bps[ 1 ], 1 ) - min_mid_rate_bps,
115             silk_SMULWB( SILK_FIX_CONST( 1, 16 ) + frac_3_Q16, min_mid_rate_bps ), 14+2 );
116         width_Q14 = silk_LIMIT( width_Q14, 0, SILK_FIX_CONST( 1, 14 ) );
117     } else {
118         mid_side_rates_bps[ 1 ] = total_rate_bps - mid_side_rates_bps[ 0 ];
119         width_Q14 = SILK_FIX_CONST( 1, 14 );
120     }
121
122     /* Smoother */
123     state->smth_width_Q14 = (opus_int16)silk_SMLAWB( state->smth_width_Q14, width_Q14 - state->smth_width_Q14, smooth_coef_Q16 );
124
125     /* At very low bitrates or for inputs that are nearly amplitude panned, switch to panned-mono coding */
126     *mid_only_flag = 0;
127     if( toMono ) {
128         /* Last frame before stereo->mono transition; collapse stereo width */
129         width_Q14 = 0;
130         pred_Q13[ 0 ] = 0;
131         pred_Q13[ 1 ] = 0;
132         silk_stereo_quant_pred( pred_Q13, ix );
133     } else if( state->width_prev_Q14 == 0 &&
134         ( 8 * total_rate_bps < 13 * min_mid_rate_bps || silk_SMULWB( frac_Q16, state->smth_width_Q14 ) < SILK_FIX_CONST( 0.05, 14 ) ) )
135     {
136         /* Code as panned-mono; previous frame already had zero width */
137         /* Scale down and quantize predictors */
138         pred_Q13[ 0 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 0 ] ), 14 );
139         pred_Q13[ 1 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 1 ] ), 14 );
140         silk_stereo_quant_pred( pred_Q13, ix );
141         /* Collapse stereo width */
142         width_Q14 = 0;
143         effective_pred = silk_abs( pred_Q13[ 0 ] ) + silk_abs( pred_Q13[ 1 ] );
144         pred_Q13[ 0 ] = 0;
145         pred_Q13[ 1 ] = 0;
146         mid_side_rates_bps[ 0 ] = total_rate_bps;
147         mid_side_rates_bps[ 1 ] = 0;
148         *mid_only_flag = 1;
149     } else if( state->width_prev_Q14 != 0 &&
150         ( 8 * total_rate_bps < 11 * min_mid_rate_bps || silk_SMULWB( frac_Q16, state->smth_width_Q14 ) < SILK_FIX_CONST( 0.02, 14 ) ) )
151     {
152         /* Transition to zero-width stereo */
153         /* Scale down and quantize predictors */
154         pred_Q13[ 0 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 0 ] ), 14 );
155         pred_Q13[ 1 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 1 ] ), 14 );
156         silk_stereo_quant_pred( pred_Q13, ix );
157         /* Collapse stereo width */
158         width_Q14 = 0;
159         effective_pred = silk_abs( pred_Q13[ 0 ] ) + silk_abs( pred_Q13[ 1 ] );
160         pred_Q13[ 0 ] = 0;
161         pred_Q13[ 1 ] = 0;
162     } else if( state->smth_width_Q14 > SILK_FIX_CONST( 0.95, 14 ) ) {
163         /* Full-width stereo coding */
164         silk_stereo_quant_pred( pred_Q13, ix );
165         width_Q14 = SILK_FIX_CONST( 1, 14 );
166     } else {
167         /* Reduced-width stereo coding; scale down and quantize predictors */
168         pred_Q13[ 0 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 0 ] ), 14 );
169         pred_Q13[ 1 ] = silk_RSHIFT( silk_SMULBB( state->smth_width_Q14, pred_Q13[ 1 ] ), 14 );
170         silk_stereo_quant_pred( pred_Q13, ix );
171         width_Q14 = state->smth_width_Q14;
172         effective_pred = silk_abs( pred_Q13[ 0 ] ) + silk_abs( pred_Q13[ 1 ] );
173     }
174
175     if (*mid_only_flag == 0 && mid_side_rates_bps[ 1 ] < 1)
176     {
177         mid_side_rates_bps[ 1 ] = 1;
178         mid_side_rates_bps[ 0 ] = silk_max_int( 1, total_rate_bps - mid_side_rates_bps[ 1 ]);
179     }
180 #if 0
181     DEBUG_STORE_DATA( midside.dat, &mid_side_rates_bps[ 0 ], 8 );
182     DEBUG_STORE_DATA( norms0.pcm, &state->mid_side_amp_Q0[0], 8 );
183     DEBUG_STORE_DATA( norms1.pcm, &state->mid_side_amp_Q0[2], 8 );
184     DEBUG_STORE_DATA( width.pcm, &width_Q14, 4 );
185 #endif
186
187     /* Interpolate predictors and subtract prediction from side channel */
188     pred0_Q13  = -state->pred_prev_Q13[ 0 ];
189     pred1_Q13  = -state->pred_prev_Q13[ 1 ];
190     w_Q24      =  silk_LSHIFT( state->width_prev_Q14, 10 );
191     denom_Q16  = silk_DIV32_16( 1 << 16, STEREO_INTERP_LEN_MS * fs_kHz );
192     delta0_Q13 = -silk_RSHIFT_ROUND( silk_SMULBB( pred_Q13[ 0 ] - state->pred_prev_Q13[ 0 ], denom_Q16 ), 16 );
193     delta1_Q13 = -silk_RSHIFT_ROUND( silk_SMULBB( pred_Q13[ 1 ] - state->pred_prev_Q13[ 1 ], denom_Q16 ), 16 );
194     deltaw_Q24 =  silk_LSHIFT( silk_SMULWB( width_Q14 - state->width_prev_Q14, denom_Q16 ), 10 );
195     for( n = 0; n < STEREO_INTERP_LEN_MS * fs_kHz; n++ ) {
196         pred0_Q13 += delta0_Q13;
197         pred1_Q13 += delta1_Q13;
198         w_Q24   += deltaw_Q24;
199         sum = silk_LSHIFT( silk_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 9 );      /* Q11 */
200         sum = silk_SMLAWB( silk_SMULWB( w_Q24, side[ n + 1 ] ), sum, pred0_Q13 );                 /* Q8  */
201         sum = silk_SMLAWB( sum, silk_LSHIFT( ( opus_int32 )mid[ n + 1 ], 11 ), pred1_Q13 );        /* Q8  */
202         x2[ n - 1 ] = (opus_int16)silk_SAT16( silk_RSHIFT_ROUND( sum, 8 ) );
203     }
204
205     pred0_Q13 = -pred_Q13[ 0 ];
206     pred1_Q13 = -pred_Q13[ 1 ];
207     w_Q24     =  silk_LSHIFT( width_Q14, 10 );
208     for( n = STEREO_INTERP_LEN_MS * fs_kHz; n < frame_length; n++ ) {
209         sum = silk_LSHIFT( silk_ADD_LSHIFT( mid[ n ] + mid[ n + 2 ], mid[ n + 1 ], 1 ), 9 );      /* Q11 */
210         sum = silk_SMLAWB( silk_SMULWB( w_Q24, side[ n + 1 ] ), sum, pred0_Q13 );                 /* Q8  */
211         sum = silk_SMLAWB( sum, silk_LSHIFT( ( opus_int32 )mid[ n + 1 ], 11 ), pred1_Q13 );        /* Q8  */
212         x2[ n - 1 ] = (opus_int16)silk_SAT16( silk_RSHIFT_ROUND( sum, 8 ) );
213     }
214     state->pred_prev_Q13[ 0 ] = (opus_int16)pred_Q13[ 0 ];
215     state->pred_prev_Q13[ 1 ] = (opus_int16)pred_Q13[ 1 ];
216     state->width_prev_Q14     = (opus_int16)width_Q14;
217     {
218        /* Evaluate the effective width of the SILK stereo so we can report it
219           for the CELT layer to partially collapse the image. We need to take
220           into account the prediction otherwise we risk compeltely collapsing
221           the HF image when doing panned mono */
222        opus_int32 effective_width;
223        effective_width = (opus_int32)state->width_prev_Q14 + silk_LSHIFT32( (opus_int32)effective_pred, 1);
224        effective_width += silk_RSHIFT( effective_width, 2 );
225        effective_width = silk_min_32(effective_width, 16384);
226        state->effective_width_prev_Q14 = effective_width;
227     }
228 }