SILK update with LBRR and some bugfixes
[opus.git] / src_FLP / SKP_Silk_control_codec_FLP.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 #include "SKP_Silk_main_FLP.h"\r
29 #include "SKP_Silk_setup.h"\r
30 \r
31 SKP_INLINE SKP_int SKP_Silk_setup_resamplers(\r
32     SKP_Silk_encoder_state_FLP      *psEnc,             /* I/O  Pointer to Silk encoder state FLP       */\r
33     SKP_int                         fs_kHz              /* I    Internal sampling rate (kHz)            */\r
34 );\r
35 \r
36 SKP_INLINE SKP_int SKP_Silk_setup_fs(\r
37     SKP_Silk_encoder_state_FLP      *psEnc,             /* I/O                      */\r
38     SKP_int                         fs_kHz,             /* I                        */\r
39     SKP_int                         PacketSize_ms       /* I                        */\r
40 );\r
41 \r
42 SKP_INLINE SKP_int SKP_Silk_setup_rate(\r
43     SKP_Silk_encoder_state_FLP      *psEnc,             /* I/O  Pointer to Silk encoder state FLP       */\r
44     SKP_int32                       TargetRate_bps      /* I    Target max bitrate                      */\r
45 );\r
46 \r
47 /* Control encoder */\r
48 SKP_int SKP_Silk_control_encoder_FLP( \r
49     SKP_Silk_encoder_state_FLP  *psEnc,                 /* I/O  Pointer to Silk encoder state FLP       */\r
50     const SKP_int               PacketSize_ms,          /* I    Packet length (ms)                      */\r
51     const SKP_int32             TargetRate_bps,         /* I    Target max bitrate (bps)                */\r
52     const SKP_int               PacketLoss_perc,        /* I    Packet loss rate (in percent)           */\r
53     const SKP_int               Complexity              /* I    Complexity (0-10)                       */\r
54 )\r
55 {\r
56     SKP_int   fs_kHz, ret = 0;\r
57 \r
58     if( psEnc->sCmn.controlled_since_last_payload != 0 ) {\r
59         if( psEnc->sCmn.API_fs_Hz != psEnc->sCmn.prev_API_fs_Hz && psEnc->sCmn.fs_kHz > 0 ) {\r
60             /* Change in API sampling rate in the middle of encoding a packet */\r
61             ret += SKP_Silk_setup_resamplers( psEnc, psEnc->sCmn.fs_kHz );\r
62         }\r
63         return ret;\r
64     }\r
65 \r
66     /* Beyond this point we know that there are no previously coded frames in the payload buffer */\r
67 \r
68     /********************************************/\r
69     /* Determine internal sampling rate         */\r
70     /********************************************/\r
71     fs_kHz = SKP_Silk_control_audio_bandwidth( &psEnc->sCmn, TargetRate_bps );\r
72 \r
73     /********************************************/\r
74     /* Prepare resampler and buffered data      */\r
75     /********************************************/\r
76     ret += SKP_Silk_setup_resamplers( psEnc, fs_kHz );\r
77 \r
78     /********************************************/\r
79     /* Set internal sampling frequency          */\r
80     /********************************************/\r
81     ret += SKP_Silk_setup_fs( psEnc, fs_kHz, PacketSize_ms );\r
82 \r
83     /********************************************/\r
84     /* Set encoding complexity                  */\r
85     /********************************************/\r
86     ret += SKP_Silk_setup_complexity( &psEnc->sCmn, Complexity );\r
87 \r
88     /********************************************/\r
89     /* Set bitrate/coding quality               */\r
90     /********************************************/\r
91     ret += SKP_Silk_setup_rate( psEnc, TargetRate_bps );\r
92 \r
93     /********************************************/\r
94     /* Set packet loss rate measured by farend  */\r
95     /********************************************/\r
96     if( ( PacketLoss_perc < 0 ) || ( PacketLoss_perc > 100 ) ) {\r
97         ret = SKP_SILK_ENC_INVALID_LOSS_RATE;\r
98     }\r
99     psEnc->sCmn.PacketLoss_perc = PacketLoss_perc;\r
100 \r
101     /********************************************/\r
102     /* Set LBRR usage                           */\r
103     /********************************************/\r
104     ret += SKP_Silk_setup_LBRR( &psEnc->sCmn );\r
105 \r
106     psEnc->sCmn.controlled_since_last_payload = 1;\r
107 \r
108     return ret;\r
109 }\r
110 \r
111 SKP_INLINE SKP_int SKP_Silk_setup_resamplers(\r
112     SKP_Silk_encoder_state_FLP      *psEnc,             /* I/O  Pointer to Silk encoder state FLP       */\r
113     SKP_int                         fs_kHz              /* I    External (API) sampling rate (Hz)       */\r
114 )\r
115 {\r
116     SKP_int ret = SKP_SILK_NO_ERROR;\r
117     \r
118     if( psEnc->sCmn.fs_kHz != fs_kHz || psEnc->sCmn.prev_API_fs_Hz != psEnc->sCmn.API_fs_Hz ) {\r
119 \r
120         if( psEnc->sCmn.fs_kHz == 0 ) {\r
121             /* Initialize the resampler for enc_API.c preparing resampling from API_fs_Hz to fs_kHz */\r
122             ret += SKP_Silk_resampler_init( &psEnc->sCmn.resampler_state, psEnc->sCmn.API_fs_Hz, fs_kHz * 1000 );\r
123         } else {\r
124             /* Allocate space for worst case temporary upsampling, 8 to 48 kHz, so a factor 6 */\r
125             SKP_int16 x_buf_API_fs_Hz[ ( 2 * MAX_FRAME_LENGTH + LA_SHAPE_MAX ) * ( MAX_API_FS_KHZ / 8 ) ];\r
126             SKP_int16 x_bufFIX[          2 * MAX_FRAME_LENGTH + LA_SHAPE_MAX ]; \r
127 \r
128             SKP_int32 nSamples_temp = 2 * psEnc->sCmn.frame_length + LA_SHAPE_MS * psEnc->sCmn.fs_kHz;\r
129 \r
130             SKP_float2short_array( x_bufFIX, psEnc->x_buf, nSamples_temp );\r
131 \r
132             if( fs_kHz * 1000 < psEnc->sCmn.API_fs_Hz && psEnc->sCmn.fs_kHz != 0 ) {\r
133                 /* Resample buffered data in x_buf to API_fs_Hz */\r
134 \r
135                 SKP_Silk_resampler_state_struct  temp_resampler_state;\r
136 \r
137                 /* Initialize resampler for temporary resampling of x_buf data to API_fs_Hz */\r
138                 ret += SKP_Silk_resampler_init( &temp_resampler_state, psEnc->sCmn.fs_kHz * 1000, psEnc->sCmn.API_fs_Hz );\r
139 \r
140                 /* Temporary resampling of x_buf data to API_fs_Hz */\r
141                 ret += SKP_Silk_resampler( &temp_resampler_state, x_buf_API_fs_Hz, x_bufFIX, nSamples_temp );\r
142 \r
143                 /* Calculate number of samples that has been temporarily upsampled */\r
144                 nSamples_temp = SKP_DIV32_16( nSamples_temp * psEnc->sCmn.API_fs_Hz, psEnc->sCmn.fs_kHz * 1000 );\r
145 \r
146                 /* Initialize the resampler for enc_API.c preparing resampling from API_fs_Hz to fs_kHz */\r
147                 ret += SKP_Silk_resampler_init( &psEnc->sCmn.resampler_state, psEnc->sCmn.API_fs_Hz, fs_kHz * 1000 );\r
148 \r
149             } else {\r
150                 /* Copy data */\r
151                 SKP_memcpy( x_buf_API_fs_Hz, x_bufFIX, nSamples_temp * sizeof( SKP_int16 ) );\r
152             }\r
153 \r
154             if( 1000 * fs_kHz != psEnc->sCmn.API_fs_Hz ) {\r
155                 /* Correct resampler state (unless resampling by a factor 1) by resampling buffered data from API_fs_Hz to fs_kHz */\r
156                 ret += SKP_Silk_resampler( &psEnc->sCmn.resampler_state, x_bufFIX, x_buf_API_fs_Hz, nSamples_temp );\r
157             }\r
158             SKP_short2float_array( psEnc->x_buf, x_bufFIX, ( 2 * MAX_FRAME_LENGTH_MS + LA_SHAPE_MS ) * fs_kHz );\r
159         }\r
160     }\r
161 \r
162     psEnc->sCmn.prev_API_fs_Hz = psEnc->sCmn.API_fs_Hz;\r
163 \r
164     return(ret);\r
165 }\r
166 \r
167 SKP_INLINE SKP_int SKP_Silk_setup_fs(\r
168     SKP_Silk_encoder_state_FLP      *psEnc,             /* I/O                      */\r
169     SKP_int                         fs_kHz,             /* I                        */\r
170     SKP_int                         PacketSize_ms       /* I                        */\r
171 )\r
172 {\r
173     SKP_int ret = SKP_SILK_NO_ERROR;\r
174 \r
175     /* Set packet size */\r
176     if( PacketSize_ms != psEnc->sCmn.PacketSize_ms ) {\r
177         if( ( PacketSize_ms !=  10 ) &&\r
178             ( PacketSize_ms !=  20 ) &&\r
179             ( PacketSize_ms !=  40 ) && \r
180             ( PacketSize_ms !=  60 ) ) {\r
181             ret = SKP_SILK_ENC_PACKET_SIZE_NOT_SUPPORTED;\r
182         }\r
183         if( PacketSize_ms == 10 ) {\r
184             /* Only allowed when the payload buffer is empty */\r
185             psEnc->sCmn.nFramesPerPacket = 1;\r
186             psEnc->sCmn.nb_subfr = MAX_NB_SUBFR >> 1;\r
187             psEnc->sPred.pitch_LPC_win_length = SKP_SMULBB( FIND_PITCH_LPC_WIN_MS_2_SF, fs_kHz );\r
188             if( psEnc->sCmn.fs_kHz == 8 ) {\r
189                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_10_ms_NB_iCDF;\r
190             } else {\r
191                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_10_ms_iCDF;\r
192             }\r
193         } else {\r
194             psEnc->sCmn.nFramesPerPacket = SKP_DIV32_16( PacketSize_ms, MAX_FRAME_LENGTH_MS );\r
195             psEnc->sCmn.nb_subfr = MAX_NB_SUBFR;\r
196             psEnc->sPred.pitch_LPC_win_length = SKP_SMULBB( FIND_PITCH_LPC_WIN_MS, fs_kHz );\r
197             if( psEnc->sCmn.fs_kHz == 8 ) {\r
198                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_NB_iCDF;\r
199             } else {\r
200                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_iCDF; \r
201             }\r
202         }\r
203         psEnc->sCmn.PacketSize_ms = PacketSize_ms;\r
204     }\r
205 \r
206     /* Set internal sampling frequency */\r
207     if( psEnc->sCmn.fs_kHz != fs_kHz ) {\r
208         /* reset part of the state */\r
209         SKP_memset( &psEnc->sShape,          0, sizeof( SKP_Silk_shape_state_FLP ) );\r
210         SKP_memset( &psEnc->sPrefilt,        0, sizeof( SKP_Silk_prefilter_state_FLP ) );\r
211         SKP_memset( &psEnc->sCmn.sNSQ,       0, sizeof( SKP_Silk_nsq_state ) );\r
212         SKP_memset( &psEnc->sPred,           0, sizeof( SKP_Silk_predict_state_FLP ) );\r
213         SKP_memset( psEnc->sPred.prev_NLSFq, 0, sizeof( psEnc->sPred.prev_NLSFq ) );\r
214 #if SWITCH_TRANSITION_FILTERING\r
215         SKP_memset( psEnc->sCmn.sLP.In_LP_State, 0, sizeof( psEnc->sCmn.sLP.In_LP_State ) );\r
216         if( psEnc->sCmn.sLP.mode == 1 ) {\r
217             /* Begin transition phase */\r
218             psEnc->sCmn.sLP.transition_frame_no = 1;\r
219         } else {\r
220             /* End transition phase */\r
221             psEnc->sCmn.sLP.transition_frame_no = 0;\r
222         }\r
223 #endif\r
224         psEnc->sCmn.inputBufIx          = 0;\r
225         psEnc->sCmn.nFramesAnalyzed     = 0;\r
226         psEnc->sCmn.TargetRate_bps      = 0; /* Ensures that psEnc->SNR_dB is recomputed */\r
227 \r
228         /* Initialize non-zero parameters */\r
229         psEnc->sCmn.prevLag                     = 100;\r
230         psEnc->sCmn.first_frame_after_reset     = 1;\r
231         psEnc->sPrefilt.lagPrev                 = 100;\r
232         psEnc->sShape.LastGainIndex             = 10;\r
233         psEnc->sCmn.sNSQ.lagPrev                = 100;\r
234         psEnc->sCmn.sNSQ.prev_inv_gain_Q16      = 65536;\r
235 \r
236         psEnc->sCmn.fs_kHz = fs_kHz;\r
237         if( psEnc->sCmn.fs_kHz == 8 ) {\r
238             psEnc->sCmn.predictLPCOrder = MIN_LPC_ORDER;\r
239             psEnc->sCmn.psNLSF_CB[ 0 ]  = &SKP_Silk_NLSF_CB0_10;\r
240             psEnc->sCmn.psNLSF_CB[ 1 ]  = &SKP_Silk_NLSF_CB1_10;\r
241             if( psEnc->sCmn.nb_subfr == MAX_NB_SUBFR ){\r
242                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_NB_iCDF; \r
243             } else if( psEnc->sCmn.nb_subfr == MAX_NB_SUBFR / 2 ){\r
244                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_10_ms_NB_iCDF;\r
245             } else {\r
246                 /* Unsupported number of frames */\r
247                 SKP_assert( 0 );\r
248             }\r
249         } else {\r
250             psEnc->sCmn.predictLPCOrder = MAX_LPC_ORDER;\r
251             psEnc->sCmn.psNLSF_CB[ 0 ]  = &SKP_Silk_NLSF_CB0_16;\r
252             psEnc->sCmn.psNLSF_CB[ 1 ]  = &SKP_Silk_NLSF_CB1_16;\r
253             if( psEnc->sCmn.nb_subfr == MAX_NB_SUBFR ){\r
254                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_iCDF; \r
255             } else if( psEnc->sCmn.nb_subfr == MAX_NB_SUBFR / 2 ){\r
256                 psEnc->sCmn.pitch_contour_iCDF = SKP_Silk_pitch_contour_10_ms_iCDF;\r
257             } else {\r
258                 /* Unsupported number of frames */\r
259                 SKP_assert( 0 );\r
260             }\r
261         }\r
262         psEnc->sCmn.subfr_length   = SUB_FRAME_LENGTH_MS * fs_kHz;\r
263         psEnc->sCmn.frame_length   = psEnc->sCmn.subfr_length * psEnc->sCmn.nb_subfr;\r
264         psEnc->sCmn.ltp_mem_length = LTP_MEM_LENGTH_MS * fs_kHz; \r
265         psEnc->sCmn.la_pitch       = LA_PITCH_MS * fs_kHz;\r
266         psEnc->sPred.min_pitch_lag =  3 * fs_kHz;\r
267         psEnc->sPred.max_pitch_lag = 18 * fs_kHz;\r
268         if( psEnc->sCmn.nb_subfr == MAX_NB_SUBFR ){\r
269             psEnc->sPred.pitch_LPC_win_length = SKP_SMULBB( FIND_PITCH_LPC_WIN_MS, fs_kHz );\r
270         } else if( psEnc->sCmn.nb_subfr == MAX_NB_SUBFR / 2 ){\r
271             psEnc->sPred.pitch_LPC_win_length = SKP_SMULBB( FIND_PITCH_LPC_WIN_MS_2_SF, fs_kHz );\r
272         } else {\r
273             /* Unsupported number of frames */\r
274             SKP_assert( 0 );\r
275         }\r
276         if( psEnc->sCmn.fs_kHz == 16 ) {\r
277             psEnc->sCmn.mu_LTP_Q9 = SKP_FIX_CONST( MU_LTP_QUANT_WB, 9 );\r
278             psEnc->sCmn.bitrate_threshold_up    = SKP_int32_MAX;\r
279             psEnc->sCmn.bitrate_threshold_down  = WB2MB_BITRATE_BPS; \r
280             psEnc->sCmn.pitch_lag_low_bits_iCDF = SKP_Silk_uniform8_iCDF;\r
281         } else if( psEnc->sCmn.fs_kHz == 12 ) {\r
282             psEnc->sCmn.mu_LTP_Q9 = SKP_FIX_CONST( MU_LTP_QUANT_MB, 9 );\r
283             psEnc->sCmn.bitrate_threshold_up    = MB2WB_BITRATE_BPS;\r
284             psEnc->sCmn.bitrate_threshold_down  = MB2NB_BITRATE_BPS;\r
285             psEnc->sCmn.pitch_lag_low_bits_iCDF = SKP_Silk_uniform6_iCDF;\r
286         } else if( psEnc->sCmn.fs_kHz == 8 ) {\r
287             psEnc->sCmn.mu_LTP_Q9 = SKP_FIX_CONST( MU_LTP_QUANT_NB, 9 );\r
288             psEnc->sCmn.bitrate_threshold_up    = NB2MB_BITRATE_BPS;\r
289             psEnc->sCmn.bitrate_threshold_down  = 0;\r
290             psEnc->sCmn.pitch_lag_low_bits_iCDF = SKP_Silk_uniform4_iCDF;\r
291         } else {\r
292             /* unsupported sampling rate */\r
293             SKP_assert( 0 );\r
294         }\r
295     }\r
296 \r
297     /* Check that settings are valid */\r
298     SKP_assert( ( psEnc->sCmn.subfr_length * psEnc->sCmn.nb_subfr ) == psEnc->sCmn.frame_length );\r
299  \r
300     return( ret );\r
301 }\r
302 \r
303 SKP_INLINE SKP_int SKP_Silk_setup_rate(\r
304     SKP_Silk_encoder_state_FLP      *psEnc,             /* I/O  Pointer to Silk encoder state FLP       */\r
305     SKP_int32                       TargetRate_bps      /* I    Target max bitrate                      */\r
306 )\r
307 {\r
308     SKP_int k, ret = SKP_SILK_NO_ERROR;\r
309     SKP_float frac;\r
310     const SKP_int32 *rateTable;\r
311 \r
312     /* Set bitrate/coding quality */\r
313     if( TargetRate_bps != psEnc->sCmn.TargetRate_bps ) {\r
314         psEnc->sCmn.TargetRate_bps = TargetRate_bps;\r
315 \r
316         /* If new TargetRate_bps, translate to SNR_dB value */\r
317         if( psEnc->sCmn.fs_kHz == 8 ) {\r
318             rateTable = TargetRate_table_NB;\r
319         } else if( psEnc->sCmn.fs_kHz == 12 ) {\r
320             rateTable = TargetRate_table_MB;\r
321         } else if( psEnc->sCmn.fs_kHz == 16 ) {\r
322             rateTable = TargetRate_table_WB;\r
323         } else {\r
324             SKP_assert( 0 );\r
325         }\r
326         /* Reduce bitrate for 10 ms modes in these calculations */\r
327         if( psEnc->sCmn.nb_subfr == 2 ) {\r
328             TargetRate_bps -= REDUCE_BITRATE_10_MS_BPS;\r
329         }\r
330         for( k = 1; k < TARGET_RATE_TAB_SZ; k++ ) {\r
331             /* Find bitrate interval in table and interpolate */\r
332             if( TargetRate_bps <= rateTable[ k ] ) {\r
333                 frac = (SKP_float)( TargetRate_bps - rateTable[ k - 1 ] ) / \r
334                        (SKP_float)( rateTable[ k ] - rateTable[ k - 1 ] );\r
335                 psEnc->SNR_dB = 0.5f * ( SNR_table_Q1[ k - 1 ] + frac * ( SNR_table_Q1[ k ] - SNR_table_Q1[ k - 1 ] ) );\r
336                 break;\r
337             }\r
338         }\r
339     }\r
340     return( ret );\r
341 }\r