Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_VQ_nearest_neighbor_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 \r
30 /* Entropy constrained MATRIX-weighted VQ, hard-coded to 5-element vectors, for a single input data vector */\r
31 void SKP_Silk_VQ_WMat_EC_FIX(\r
32     SKP_int                         *ind,               /* O    index of best codebook vector               */\r
33     SKP_int32                       *rate_dist_Q14,     /* O    best weighted quantization error + mu * rate*/\r
34     const SKP_int16                 *in_Q14,            /* I    input vector to be quantized                */\r
35     const SKP_int32                 *W_Q18,             /* I    weighting matrix                            */\r
36     const SKP_int16                 *cb_Q14,            /* I    codebook                                    */\r
37     const SKP_int16                 *cl_Q6,             /* I    code length for each codebook vector        */\r
38     const SKP_int                   mu_Q8,              /* I    tradeoff between weighted error and rate    */\r
39     SKP_int                         L                   /* I    number of vectors in codebook               */\r
40 )\r
41 {\r
42     SKP_int   k;\r
43     const SKP_int16 *cb_row_Q14;\r
44     SKP_int32 sum1_Q14, sum2_Q16, diff_Q14_01, diff_Q14_23, diff_Q14_4;\r
45 \r
46     /* Loop over codebook */\r
47     *rate_dist_Q14 = SKP_int32_MAX;\r
48     cb_row_Q14 = cb_Q14;\r
49     for( k = 0; k < L; k++ ) {\r
50         /* Pack pairs of int16 values per int32 */\r
51         diff_Q14_01 = (SKP_uint16)( in_Q14[ 0 ] - cb_row_Q14[ 0 ] ) | SKP_LSHIFT( ( SKP_int32 )in_Q14[ 1 ] - cb_row_Q14[ 1 ], 16 );\r
52         diff_Q14_23 = (SKP_uint16)( in_Q14[ 2 ] - cb_row_Q14[ 2 ] ) | SKP_LSHIFT( ( SKP_int32 )in_Q14[ 3 ] - cb_row_Q14[ 3 ], 16 );\r
53         diff_Q14_4  = in_Q14[ 4 ] - cb_row_Q14[ 4 ];\r
54 \r
55         /* Weighted rate */\r
56         sum1_Q14 = SKP_SMULBB( mu_Q8, cl_Q6[ k ] );\r
57 \r
58         SKP_assert( sum1_Q14 >= 0 );\r
59 \r
60         /* Add weighted quantization error, assuming W_Q18 is symmetric */\r
61         /* NOTE: the code below loads two int16 values as one int32, and multiplies each using the  */\r
62         /* SMLAWB and SMLAWT instructions. On a big-endian CPU the two int16 variables would be     */\r
63         /* loaded in reverse order and the code will give the wrong result. In that case swapping   */\r
64         /* the SMLAWB and SMLAWT instructions should solve the problem.                             */\r
65         /* first row of W_Q18 */\r
66         sum2_Q16 = SKP_SMULWT(           W_Q18[ 1 ], diff_Q14_01 );\r
67         sum2_Q16 = SKP_SMLAWB( sum2_Q16, W_Q18[ 2 ], diff_Q14_23 );\r
68         sum2_Q16 = SKP_SMLAWT( sum2_Q16, W_Q18[ 3 ], diff_Q14_23 );\r
69         sum2_Q16 = SKP_SMLAWB( sum2_Q16, W_Q18[ 4 ], diff_Q14_4  );\r
70         sum2_Q16 = SKP_LSHIFT( sum2_Q16, 1 );\r
71         sum2_Q16 = SKP_SMLAWB( sum2_Q16, W_Q18[ 0 ], diff_Q14_01 );\r
72         sum1_Q14 = SKP_SMLAWB( sum1_Q14, sum2_Q16,   diff_Q14_01 );\r
73 \r
74         /* second row of W_Q18 */\r
75         sum2_Q16 = SKP_SMULWB(           W_Q18[ 7 ], diff_Q14_23 );\r
76         sum2_Q16 = SKP_SMLAWT( sum2_Q16, W_Q18[ 8 ], diff_Q14_23 );\r
77         sum2_Q16 = SKP_SMLAWB( sum2_Q16, W_Q18[ 9 ], diff_Q14_4  );\r
78         sum2_Q16 = SKP_LSHIFT( sum2_Q16, 1 );\r
79         sum2_Q16 = SKP_SMLAWT( sum2_Q16, W_Q18[ 6 ], diff_Q14_01 );\r
80         sum1_Q14 = SKP_SMLAWT( sum1_Q14, sum2_Q16,   diff_Q14_01 );\r
81 \r
82         /* third row of W_Q18 */\r
83         sum2_Q16 = SKP_SMULWT(           W_Q18[ 13 ], diff_Q14_23 );\r
84         sum2_Q16 = SKP_SMLAWB( sum2_Q16, W_Q18[ 14 ], diff_Q14_4  );\r
85         sum2_Q16 = SKP_LSHIFT( sum2_Q16, 1 );\r
86         sum2_Q16 = SKP_SMLAWB( sum2_Q16, W_Q18[ 12 ], diff_Q14_23 );\r
87         sum1_Q14 = SKP_SMLAWB( sum1_Q14, sum2_Q16,    diff_Q14_23 );\r
88 \r
89         /* fourth row of W_Q18 */\r
90         sum2_Q16 = SKP_SMULWB(           W_Q18[ 19 ], diff_Q14_4  );\r
91         sum2_Q16 = SKP_LSHIFT( sum2_Q16, 1 );\r
92         sum2_Q16 = SKP_SMLAWT( sum2_Q16, W_Q18[ 18 ], diff_Q14_23 );\r
93         sum1_Q14 = SKP_SMLAWT( sum1_Q14, sum2_Q16,    diff_Q14_23 );\r
94 \r
95         /* last row of W_Q18 */\r
96         sum2_Q16 = SKP_SMULWB(           W_Q18[ 24 ], diff_Q14_4  );\r
97         sum1_Q14 = SKP_SMLAWB( sum1_Q14, sum2_Q16,    diff_Q14_4  );\r
98 \r
99         SKP_assert( sum1_Q14 >= 0 );\r
100 \r
101         /* find best */\r
102         if( sum1_Q14 < *rate_dist_Q14 ) {\r
103             *rate_dist_Q14 = sum1_Q14;\r
104             *ind = k;\r
105         }\r
106 \r
107         /* Go to next cbk vector */\r
108         cb_row_Q14 += LTP_ORDER;\r
109     }\r
110 }\r