Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_prefilter_FIX.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, 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_FIX.h"\r
29 #include "SKP_Silk_perceptual_parameters_FIX.h"\r
30 \r
31 /* SKP_Silk_prefilter. Prefilter for finding Quantizer input signal */\r
32 SKP_INLINE void SKP_Silk_prefilt_FIX(\r
33     SKP_Silk_prefilter_state_FIX *P,                    /* I/O state                          */\r
34     SKP_int32   st_res_Q12[],                           /* I short term residual signal       */\r
35     SKP_int16   xw[],                                   /* O prefiltered signal               */\r
36     SKP_int32   HarmShapeFIRPacked_Q12,                 /* I Harmonic shaping coeficients     */\r
37     SKP_int     Tilt_Q14,                               /* I Tilt shaping coeficient          */\r
38     SKP_int32   LF_shp_Q14,                             /* I Low-frequancy shaping coeficients*/\r
39     SKP_int     lag,                                    /* I Lag for harmonic shaping         */\r
40     SKP_int     length                                  /* I Length of signals                */\r
41 );\r
42 \r
43 void SKP_Silk_prefilter_FIX(\r
44     SKP_Silk_encoder_state_FIX          *psEnc,         /* I/O  Encoder state FIX                           */\r
45     const SKP_Silk_encoder_control_FIX  *psEncCtrl,     /* I    Encoder control FIX                         */\r
46     SKP_int16                           xw[],           /* O    Weighted signal                             */\r
47     const SKP_int16                     x[]             /* I    Speech signal                               */\r
48 )\r
49 {\r
50     SKP_Silk_prefilter_state_FIX *P = &psEnc->sPrefilt;\r
51     SKP_int   j, k, lag;\r
52     SKP_int32 tmp_32, B_Q12;\r
53     const SKP_int16 *AR1_shp_Q13;\r
54     const SKP_int16 *px;\r
55     SKP_int16 *pxw, *pst_res;\r
56     SKP_int   HarmShapeGain_Q12, Tilt_Q14, LF_shp_Q14;\r
57     SKP_int32 HarmShapeFIRPacked_Q12;\r
58     SKP_int32 x_filt_Q12[ MAX_FRAME_LENGTH / NB_SUBFR ], filterState[ MAX_LPC_ORDER ];\r
59     SKP_int16 st_res[ ( MAX_FRAME_LENGTH / NB_SUBFR ) + MAX_LPC_ORDER ];\r
60 \r
61     /* Setup pointers */\r
62     px  = x;\r
63     pxw = xw;\r
64     lag = P->lagPrev;\r
65     for( k = 0; k < NB_SUBFR; k++ ) {\r
66         /* Update Variables that change per sub frame */\r
67         if( psEncCtrl->sCmn.sigtype == SIG_TYPE_VOICED ) {\r
68             lag = psEncCtrl->sCmn.pitchL[ k ];\r
69         }\r
70 \r
71         /* Noise shape parameters */\r
72         HarmShapeGain_Q12 = SKP_SMULWB( psEncCtrl->HarmShapeGain_Q14[ k ], 16384 - psEncCtrl->HarmBoost_Q14[ k ] );\r
73         SKP_assert( HarmShapeGain_Q12 >= 0 );\r
74         HarmShapeFIRPacked_Q12  =                        SKP_RSHIFT( HarmShapeGain_Q12, 2 );\r
75         HarmShapeFIRPacked_Q12 |= SKP_LSHIFT( ( SKP_int32 )SKP_RSHIFT( HarmShapeGain_Q12, 1 ), 16 );\r
76         Tilt_Q14    = psEncCtrl->Tilt_Q14[   k ];\r
77         LF_shp_Q14  = psEncCtrl->LF_shp_Q14[ k ];\r
78         AR1_shp_Q13 = &psEncCtrl->AR1_Q13[   k * SHAPE_LPC_ORDER_MAX ];\r
79 \r
80         /* Short term FIR filtering*/\r
81         SKP_memset( filterState, 0, psEnc->sCmn.shapingLPCOrder * sizeof( SKP_int32 ) );\r
82         SKP_Silk_MA_Prediction_Q13( px - psEnc->sCmn.shapingLPCOrder, AR1_shp_Q13, filterState, \r
83             st_res, psEnc->sCmn.subfr_length + psEnc->sCmn.shapingLPCOrder, psEnc->sCmn.shapingLPCOrder );\r
84 \r
85         pst_res = st_res + psEnc->sCmn.shapingLPCOrder; /* Point to first sample */\r
86 \r
87         /* reduce (mainly) low frequencies during harmonic emphasis */\r
88         B_Q12 = SKP_RSHIFT_ROUND( psEncCtrl->GainsPre_Q14[ k ], 2 );\r
89         tmp_32 = SKP_SMLABB( INPUT_TILT_Q26, psEncCtrl->HarmBoost_Q14[ k ], HarmShapeGain_Q12 ); /* Q26 */\r
90         tmp_32 = SKP_SMLABB( tmp_32, psEncCtrl->coding_quality_Q14, HIGH_RATE_INPUT_TILT_Q12 );  /* Q26 */\r
91         tmp_32 = SKP_SMULWB( tmp_32, -psEncCtrl->GainsPre_Q14[ k ] );                            /* Q24 */\r
92         tmp_32 = SKP_RSHIFT_ROUND( tmp_32, 12 );                                                 /* Q12 */\r
93         B_Q12 |= SKP_LSHIFT( SKP_SAT16( tmp_32 ), 16 );\r
94 \r
95         /* NOTE: the code below loads two int16 values in an int32, and multiplies each using the   */\r
96         /* SMLABB and SMLABT instructions. On a big-endian CPU the two int16 variables would be     */\r
97         /* loaded in reverse order and the code will give the wrong result. In that case swapping   */\r
98         /* the SMLABB and SMLABT instructions should solve the problem.                             */\r
99         x_filt_Q12[ 0 ] = SKP_SMLABT( SKP_SMULBB( pst_res[ 0 ], B_Q12 ), P->sHarmHP, B_Q12 );\r
100         for( j = 1; j < psEnc->sCmn.subfr_length; j++ ) {\r
101             x_filt_Q12[ j ] = SKP_SMLABT( SKP_SMULBB( pst_res[ j ], B_Q12 ), pst_res[ j - 1 ], B_Q12 );\r
102         }\r
103         P->sHarmHP = pst_res[ psEnc->sCmn.subfr_length - 1 ];\r
104 \r
105         SKP_Silk_prefilt_FIX( P, x_filt_Q12, pxw, HarmShapeFIRPacked_Q12, Tilt_Q14, \r
106             LF_shp_Q14, lag, psEnc->sCmn.subfr_length );\r
107 \r
108         px  += psEnc->sCmn.subfr_length;\r
109         pxw += psEnc->sCmn.subfr_length;\r
110     }\r
111 \r
112     P->lagPrev = psEncCtrl->sCmn.pitchL[ NB_SUBFR - 1 ];\r
113 }\r
114 \r
115 /* SKP_Silk_prefilter. Prefilter for finding Quantizer input signal                           */\r
116 SKP_INLINE void SKP_Silk_prefilt_FIX(\r
117     SKP_Silk_prefilter_state_FIX *P,                    /* I/O state                          */\r
118     SKP_int32   st_res_Q12[],                           /* I short term residual signal       */\r
119     SKP_int16   xw[],                                   /* O prefiltered signal               */\r
120     SKP_int32   HarmShapeFIRPacked_Q12,                 /* I Harmonic shaping coeficients     */\r
121     SKP_int     Tilt_Q14,                               /* I Tilt shaping coeficient          */\r
122     SKP_int32   LF_shp_Q14,                             /* I Low-frequancy shaping coeficients*/\r
123     SKP_int     lag,                                    /* I Lag for harmonic shaping         */\r
124     SKP_int     length                                  /* I Length of signals                */\r
125 )\r
126 {\r
127     SKP_int   i, idx, LTP_shp_buf_idx;\r
128     SKP_int32 n_LTP_Q12, n_Tilt_Q10, n_LF_Q10;\r
129     SKP_int32 sLF_MA_shp_Q12, sLF_AR_shp_Q12;\r
130     SKP_int16 *LTP_shp_buf;\r
131 \r
132     /* To speed up use temp variables instead of using the struct */\r
133     LTP_shp_buf     = P->sLTP_shp1;\r
134     LTP_shp_buf_idx = P->sLTP_shp_buf_idx1;\r
135     sLF_AR_shp_Q12  = P->sLF_AR_shp1_Q12;\r
136     sLF_MA_shp_Q12  = P->sLF_MA_shp1_Q12;\r
137 \r
138     for( i = 0; i < length; i++ ) {\r
139         if( lag > 0 ) {\r
140             /* unrolled loop */\r
141             SKP_assert( HARM_SHAPE_FIR_TAPS == 3 );\r
142             idx = lag + LTP_shp_buf_idx;\r
143             n_LTP_Q12 = SKP_SMULBB(            LTP_shp_buf[ ( idx - HARM_SHAPE_FIR_TAPS / 2 - 1) & LTP_MASK ], HarmShapeFIRPacked_Q12 );\r
144             n_LTP_Q12 = SKP_SMLABT( n_LTP_Q12, LTP_shp_buf[ ( idx - HARM_SHAPE_FIR_TAPS / 2    ) & LTP_MASK ], HarmShapeFIRPacked_Q12 );\r
145             n_LTP_Q12 = SKP_SMLABB( n_LTP_Q12, LTP_shp_buf[ ( idx - HARM_SHAPE_FIR_TAPS / 2 + 1) & LTP_MASK ], HarmShapeFIRPacked_Q12 );\r
146         } else {\r
147             n_LTP_Q12 = 0;\r
148         }\r
149 \r
150         n_LF_Q10   = SKP_SMLAWB( SKP_SMULWT( sLF_AR_shp_Q12, LF_shp_Q14 ), sLF_MA_shp_Q12, LF_shp_Q14 );\r
151         n_Tilt_Q10 = SKP_SMULWB( sLF_AR_shp_Q12, Tilt_Q14 );\r
152 \r
153         sLF_AR_shp_Q12 = SKP_SUB32( st_res_Q12[ i ], SKP_LSHIFT( n_Tilt_Q10, 2 ) );\r
154         sLF_MA_shp_Q12 = SKP_SUB32( sLF_AR_shp_Q12,  SKP_LSHIFT( n_LF_Q10,   2 ) );\r
155 \r
156         LTP_shp_buf_idx                = ( LTP_shp_buf_idx - 1 ) & LTP_MASK;\r
157         LTP_shp_buf[ LTP_shp_buf_idx ] = ( SKP_int16 )SKP_SAT16( SKP_RSHIFT_ROUND( sLF_MA_shp_Q12, 12 ) );\r
158 \r
159         xw[i] = ( SKP_int16 )SKP_SAT16( SKP_RSHIFT_ROUND( SKP_SUB32( sLF_MA_shp_Q12, n_LTP_Q12 ), 12 ) );\r
160     }\r
161 \r
162     /* Copy temp variable back to state */\r
163     P->sLF_AR_shp1_Q12   = sLF_AR_shp_Q12;\r
164     P->sLF_MA_shp1_Q12   = sLF_MA_shp_Q12;\r
165     P->sLTP_shp_buf_idx1 = LTP_shp_buf_idx;\r
166 }\r