Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_MA.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 /*                                                                      *\r
29  * SKP_Silk_MA.c                                                      *\r
30  *                                                                      *\r
31  * Variable order MA filter                                             *\r
32  *                                                                      *\r
33  * Copyright 2006 (c), Skype Limited                                    *\r
34  * Date: 060221                                                         *\r
35  *                                                                      */\r
36 #include "SKP_Silk_SigProc_FIX.h"\r
37 \r
38 /* Variable order MA filter */\r
39 void SKP_Silk_MA(\r
40     const SKP_int16      *in,            /* I:   input signal                                */\r
41     const SKP_int16      *B,             /* I:   MA coefficients, Q13 [order+1]              */\r
42     SKP_int32            *S,             /* I/O: state vector [order]                        */\r
43     SKP_int16            *out,           /* O:   output signal                               */\r
44     const SKP_int32      len,            /* I:   signal length                               */\r
45     const SKP_int32      order           /* I:   filter order                                */\r
46 )\r
47 {\r
48     SKP_int   k, d, in16;\r
49     SKP_int32 out32;\r
50     \r
51     for( k = 0; k < len; k++ ) {\r
52         in16 = in[ k ];\r
53         out32 = SKP_SMLABB( S[ 0 ], in16, B[ 0 ] );\r
54         out32 = SKP_RSHIFT_ROUND( out32, 13 );\r
55         \r
56         for( d = 1; d < order; d++ ) {\r
57             S[ d - 1 ] = SKP_SMLABB( S[ d ], in16, B[ d ] );\r
58         }\r
59         S[ order - 1 ] = SKP_SMULBB( in16, B[ order ] );\r
60 \r
61         /* Limit */\r
62         out[ k ] = (SKP_int16)SKP_SAT16( out32 );\r
63     }\r
64 }\r
65 /* Variable order MA prediction error filter */\r
66 void SKP_Silk_MA_Prediction(\r
67     const SKP_int16      *in,            /* I:   Input signal                                */\r
68     const SKP_int16      *B,             /* I:   MA prediction coefficients, Q12 [order]     */\r
69     SKP_int32            *S,             /* I/O: State vector [order]                        */\r
70     SKP_int16            *out,           /* O:   Output signal                               */\r
71     const SKP_int32      len,            /* I:   Signal length                               */\r
72     const SKP_int32      order           /* I:   Filter order                                */\r
73 )\r
74 {\r
75     SKP_int   k, d, in16;\r
76     SKP_int32 out32;\r
77     SKP_int32 B32;\r
78 \r
79     if( ( order & 1 ) == 0 && (SKP_int32)( (SKP_int_ptr_size)B & 3 ) == 0 ) {\r
80         /* Even order and 4-byte aligned coefficient array */\r
81 \r
82         /* NOTE: the code below loads two int16 values in an int32, and multiplies each using the    */\r
83         /* SMLABB and SMLABT instructions. On a big-endian CPU the two int16 variables would be      */\r
84         /* loaded in reverse order and the code will give the wrong result. In that case swapping    */\r
85         /* the SMLABB and SMLABT instructions should solve the problem.                              */\r
86         for( k = 0; k < len; k++ ) {\r
87             in16 = in[ k ];\r
88             out32 = SKP_LSHIFT( in16, 12 ) - S[ 0 ];\r
89             out32 = SKP_RSHIFT_ROUND( out32, 12 );\r
90             \r
91             for( d = 0; d < order - 2; d += 2 ) {\r
92                 B32 = *( (SKP_int32*)&B[ d ] );                /* read two coefficients at once */\r
93                 S[ d ]     = SKP_SMLABB_ovflw( S[ d + 1 ], in16, B32 );\r
94                 S[ d + 1 ] = SKP_SMLABT_ovflw( S[ d + 2 ], in16, B32 );\r
95             }\r
96             B32 = *( (SKP_int32*)&B[ d ] );                    /* read two coefficients at once */\r
97             S[ order - 2 ] = SKP_SMLABB_ovflw( S[ order - 1 ], in16, B32 );\r
98             S[ order - 1 ] = SKP_SMULBT( in16, B32 );\r
99 \r
100             /* Limit */\r
101             out[ k ] = (SKP_int16)SKP_SAT16( out32 );\r
102         }\r
103     } else {\r
104         /* Odd order or not 4-byte aligned coefficient array */\r
105         for( k = 0; k < len; k++ ) {\r
106             in16 = in[ k ];\r
107             out32 = SKP_LSHIFT( in16, 12 ) - S[ 0 ];\r
108             out32 = SKP_RSHIFT_ROUND( out32, 12 );\r
109             \r
110             for( d = 0; d < order - 1; d++ ) {\r
111                 S[ d ] = SKP_SMLABB_ovflw( S[ d + 1 ], in16, B[ d ] );\r
112             }\r
113             S[ order - 1 ] = SKP_SMULBB( in16, B[ order - 1 ] );\r
114 \r
115             /* Limit */\r
116             out[ k ] = (SKP_int16)SKP_SAT16( out32 );\r
117         }\r
118     }\r
119 }\r
120 \r
121 void SKP_Silk_MA_Prediction_Q13(\r
122     const SKP_int16      *in,            /* I:   input signal                                */\r
123     const SKP_int16      *B,             /* I:   MA prediction coefficients, Q13 [order]     */\r
124     SKP_int32            *S,             /* I/O: state vector [order]                        */\r
125     SKP_int16            *out,           /* O:   output signal                               */\r
126     SKP_int32            len,            /* I:   signal length                               */\r
127     SKP_int32            order           /* I:   filter order                                */\r
128 )\r
129 {\r
130     SKP_int   k, d, in16;\r
131     SKP_int32 out32, B32;\r
132     \r
133     if( ( order & 1 ) == 0 && (SKP_int32)( (SKP_int_ptr_size)B & 3 ) == 0 ) {\r
134         /* Even order and 4-byte aligned coefficient array */\r
135         \r
136         /* NOTE: the code below loads two int16 values in an int32, and multiplies each using the    */\r
137         /* SMLABB and SMLABT instructions. On a big-endian CPU the two int16 variables would be      */\r
138         /* loaded in reverse order and the code will give the wrong result. In that case swapping    */\r
139         /* the SMLABB and SMLABT instructions should solve the problem.                              */\r
140         for( k = 0; k < len; k++ ) {\r
141             in16 = in[ k ];\r
142             out32 = SKP_LSHIFT( in16, 13 ) - S[ 0 ];\r
143             out32 = SKP_RSHIFT_ROUND( out32, 13 );\r
144             \r
145             for( d = 0; d < order - 2; d += 2 ) {\r
146                 B32 = *( (SKP_int32*)&B[ d ] );                /* read two coefficients at once */\r
147                 S[ d ]     = SKP_SMLABB( S[ d + 1 ], in16, B32 );\r
148                 S[ d + 1 ] = SKP_SMLABT( S[ d + 2 ], in16, B32 );\r
149             }\r
150             B32 = *( (SKP_int32*)&B[ d ] );                    /* read two coefficients at once */\r
151             S[ order - 2 ] = SKP_SMLABB( S[ order - 1 ], in16, B32 );\r
152             S[ order - 1 ] = SKP_SMULBT( in16, B32 );\r
153 \r
154             /* Limit */\r
155             out[ k ] = (SKP_int16)SKP_SAT16( out32 );\r
156         }\r
157     } else {\r
158         /* Odd order or not 4-byte aligned coefficient array */\r
159         for( k = 0; k < len; k++ ) {\r
160             in16 = in[ k ];\r
161             out32 = SKP_LSHIFT( in16, 13 ) - S[ 0 ];\r
162             out32 = SKP_RSHIFT_ROUND( out32, 13 );\r
163             \r
164             for( d = 0; d < order - 1; d++ ) {\r
165                 S[ d ] = SKP_SMLABB( S[ d + 1 ], in16, B[ d ] );\r
166             }\r
167             S[ order - 1 ] = SKP_SMULBB( in16, B[ order - 1 ] );\r
168 \r
169             /* Limit */\r
170             out[ k ] = (SKP_int16)SKP_SAT16( out32 );\r
171         }\r
172     }\r
173 }\r
174 /* Variable order MA prediction error filter. */\r
175 /* Inverse filter of SKP_Silk_LPC_synthesis_filter */\r
176 void SKP_Silk_LPC_analysis_filter(\r
177     const SKP_int16      *in,            /* I:   Input signal                                */\r
178     const SKP_int16      *B,             /* I:   MA prediction coefficients, Q12 [order]     */\r
179     SKP_int16            *S,             /* I/O: State vector [order]                        */\r
180     SKP_int16            *out,           /* O:   Output signal                               */\r
181     const SKP_int32      len,            /* I:   Signal length                               */\r
182     const SKP_int32      Order           /* I:   Filter order                                */\r
183 )\r
184 {\r
185     SKP_int   k, j, idx, Order_half = SKP_RSHIFT( Order, 1 );\r
186     SKP_int32 Btmp, B_align_Q12[ SigProc_MAX_ORDER_LPC >> 1 ], out32_Q12, out32;\r
187     SKP_int16 SA, SB;\r
188     /* Order must be even */\r
189     SKP_assert( 2 * Order_half == Order );\r
190 \r
191     /* Combine two A_Q12 values and ensure 32-bit alignment */\r
192     for( k = 0; k < Order_half; k++ ) {\r
193         idx = SKP_SMULBB( 2, k );\r
194         B_align_Q12[ k ] = ( ( (SKP_int32)B[ idx ] ) & 0x0000ffff ) | SKP_LSHIFT( (SKP_int32)B[ idx + 1 ], 16 );\r
195     }\r
196 \r
197     /* S[] values are in Q0 */\r
198     for( k = 0; k < len; k++ ) {\r
199         SA = S[ 0 ];\r
200         out32_Q12 = 0;\r
201         for( j = 0; j < ( Order_half - 1 ); j++ ) {\r
202             idx = SKP_SMULBB( 2, j ) + 1;\r
203             /* Multiply-add two prediction coefficients for each loop */\r
204             Btmp = B_align_Q12[ j ];\r
205             SB = S[ idx ];\r
206             S[ idx ] = SA;\r
207             out32_Q12 = SKP_SMLABB( out32_Q12, SA, Btmp );\r
208             out32_Q12 = SKP_SMLABT( out32_Q12, SB, Btmp );\r
209             SA = S[ idx + 1 ];\r
210             S[ idx + 1 ] = SB;\r
211         }\r
212 \r
213         /* Unrolled loop: epilog */\r
214         Btmp = B_align_Q12[ Order_half - 1 ];\r
215         SB = S[ Order - 1 ];\r
216         S[ Order - 1 ] = SA;\r
217         out32_Q12 = SKP_SMLABB( out32_Q12, SA, Btmp );\r
218         out32_Q12 = SKP_SMLABT( out32_Q12, SB, Btmp );\r
219 \r
220         /* Subtract prediction */\r
221         out32_Q12 = SKP_SUB_SAT32( SKP_LSHIFT( (SKP_int32)in[ k ], 12 ), out32_Q12 );\r
222 \r
223         /* Scale to Q0 */\r
224         out32 = SKP_RSHIFT_ROUND( out32_Q12, 12 );\r
225 \r
226         /* Saturate output */\r
227         out[ k ] = (SKP_int16)SKP_SAT16( out32 );\r
228 \r
229         /* Move input line */\r
230         S[ 0 ] = in[ k ];\r
231     }\r
232 }\r