Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_LPC_stabilize.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_typedef.h"\r
29 #include "SKP_Silk_SigProc_FIX.h"\r
30 \r
31 #define LPC_STABILIZE_LPC_MAX_ABS_VALUE_Q16     ( ( (SKP_int32)SKP_int16_MAX ) << 4 )\r
32 \r
33 /* LPC stabilizer, for a single input data vector */\r
34 void SKP_Silk_LPC_stabilize(\r
35     SKP_int16       *a_Q12,         /* O    stabilized LPC vector [L]                       */\r
36     SKP_int32       *a_Q16,         /* I    LPC vector [L]                                  */\r
37     const SKP_int32  bwe_Q16,       /* I    Bandwidth expansion factor                      */\r
38     const SKP_int    L              /* I    Number of LPC parameters in the input vector    */\r
39 )\r
40 {\r
41     SKP_int32   maxabs, absval, sc_Q16;\r
42     SKP_int     i, idx = 0;\r
43     SKP_int32   invGain_Q30;\r
44 \r
45     SKP_Silk_bwexpander_32( a_Q16, L, bwe_Q16 );\r
46 \r
47     /***************************/\r
48     /* Limit range of the LPCs */\r
49     /***************************/\r
50     /* Limit the maximum absolute value of the prediction coefficients */\r
51     while( SKP_TRUE ) {\r
52         /* Find maximum absolute value and its index */\r
53         maxabs = SKP_int32_MIN;\r
54         for( i = 0; i < L; i++ ) {\r
55             absval = SKP_abs( a_Q16[ i ] );\r
56             if( absval > maxabs ) {\r
57                 maxabs = absval;\r
58                 idx    = i;\r
59             }\r
60         }\r
61     \r
62         if( maxabs >= LPC_STABILIZE_LPC_MAX_ABS_VALUE_Q16 ) {\r
63             /* Reduce magnitude of prediction coefficients */\r
64             sc_Q16 = SKP_DIV32( SKP_int32_MAX, SKP_RSHIFT( maxabs, 4 ) );\r
65             sc_Q16 = 65536 - sc_Q16;\r
66             sc_Q16 = SKP_DIV32( sc_Q16, idx + 1 );\r
67             sc_Q16 = 65536 - sc_Q16;\r
68             sc_Q16 = SKP_LSHIFT( SKP_SMULWB( sc_Q16, 32604 ), 1 ); // 0.995 in Q16\r
69             SKP_Silk_bwexpander_32( a_Q16, L, sc_Q16 );\r
70         } else {\r
71             break;\r
72         }\r
73     }\r
74 \r
75     /* Convert to 16 bit Q12 */\r
76     for( i = 0; i < L; i++ ) {\r
77         a_Q12[ i ] = (SKP_int16)SKP_RSHIFT_ROUND( a_Q16[ i ], 4 );\r
78     }\r
79 \r
80     /**********************/\r
81     /* Ensure stable LPCs */\r
82     /**********************/\r
83     while( SKP_Silk_LPC_inverse_pred_gain( &invGain_Q30, a_Q12, L ) == 1 ) {\r
84         SKP_Silk_bwexpander( a_Q12, L, 65339 ); // 0.997 in Q16\r
85     }\r
86 }\r
87 \r
88 void SKP_Silk_LPC_fit(\r
89     SKP_int16       *a_QQ,          /* O    Stabilized LPC vector, Q(24-rshift) [L]         */\r
90     SKP_int32       *a_Q24,         /* I    LPC vector [L]                                  */\r
91     const SKP_int    QQ,            /* I    Q domain of output LPC vector                   */\r
92     const SKP_int    L              /* I    Number of LPC parameters in the input vector    */\r
93 )\r
94 {\r
95     SKP_int     i, rshift, idx = 0;\r
96     SKP_int32   maxabs, absval, sc_Q16;\r
97 \r
98     rshift = 24 - QQ;\r
99 \r
100     /***************************/\r
101     /* Limit range of the LPCs */\r
102     /***************************/\r
103     /* Limit the maximum absolute value of the prediction coefficients */\r
104     while( SKP_TRUE ) {\r
105         /* Find maximum absolute value and its index */\r
106         maxabs = SKP_int32_MIN;\r
107         for( i = 0; i < L; i++ ) {\r
108             absval = SKP_abs( a_Q24[ i ] );\r
109             if( absval > maxabs ) {\r
110                 maxabs = absval;\r
111                 idx    = i;\r
112             }\r
113         }\r
114     \r
115         maxabs = SKP_RSHIFT( maxabs, rshift );\r
116         if( maxabs >= SKP_int16_MAX ) {\r
117             /* Reduce magnitude of prediction coefficients */\r
118             sc_Q16 = 65470 - SKP_DIV32( SKP_MUL( 65470 >> 2, maxabs - SKP_int16_MAX ), \r
119                                         SKP_RSHIFT32( SKP_MUL( maxabs, idx + 1), 2 ) );\r
120             SKP_Silk_bwexpander_32( a_Q24, L, sc_Q16 );\r
121         } else {\r
122             break;\r
123         }\r
124     }\r
125 \r
126     /* Convert to 16 bit Q(24-rshift) */\r
127     SKP_assert( rshift > 0  );\r
128     SKP_assert( rshift < 31 );\r
129     for( i = 0; i < L; i++ ) {\r
130         a_QQ[ i ] = (SKP_int16)SKP_RSHIFT_ROUND( a_Q24[ i ], rshift );\r
131     }\r
132 }\r