7ae09117226c3f7f19deecfa4afa9c0ce3d9d39f
[opus.git] / silk / silk_quant_LTP_gains.c
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "silk_main.h"
33
34 void silk_quant_LTP_gains(
35     opus_int16           B_Q14[ MAX_NB_SUBFR * LTP_ORDER ],              /* I/O  (un)quantized LTP gains     */
36     opus_int8            cbk_index[ MAX_NB_SUBFR ],                      /* O    Codebook Index              */
37     opus_int8            *periodicity_index,                             /* O    Periodicity Index           */
38     const opus_int32     W_Q18[ MAX_NB_SUBFR*LTP_ORDER*LTP_ORDER ],      /* I    Error Weights in Q18        */
39     opus_int             mu_Q9,                                          /* I    Mu value (R/D tradeoff)     */
40     opus_int             lowComplexity,                                  /* I    Flag for low complexity     */
41     const opus_int       nb_subfr                                        /* I    number of subframes         */
42 )
43 {
44     opus_int             j, k, cbk_size;
45     opus_int8            temp_idx[ MAX_NB_SUBFR ];
46     const opus_uint8     *cl_ptr_Q5;
47     const opus_int8      *cbk_ptr_Q7;
48     const opus_int16     *b_Q14_ptr;
49     const opus_int32     *W_Q18_ptr;
50     opus_int32           rate_dist_Q14_subfr, rate_dist_Q14, min_rate_dist_Q14;
51
52 TIC(quant_LTP)
53
54     /***************************************************/
55     /* iterate over different codebooks with different */
56     /* rates/distortions, and choose best */
57     /***************************************************/
58     min_rate_dist_Q14 = silk_int32_MAX;
59     for( k = 0; k < 3; k++ ) {
60         cl_ptr_Q5  = silk_LTP_gain_BITS_Q5_ptrs[ k ];
61         cbk_ptr_Q7 = silk_LTP_vq_ptrs_Q7[        k ];
62         cbk_size   = silk_LTP_vq_sizes[          k ];
63
64         /* Setup pointer to first subframe */
65         W_Q18_ptr = W_Q18;
66         b_Q14_ptr = B_Q14;
67
68         rate_dist_Q14 = 0;
69         for( j = 0; j < nb_subfr; j++ ) {
70
71             silk_VQ_WMat_EC(
72                 &temp_idx[ j ],         /* O    index of best codebook vector                           */
73                 &rate_dist_Q14_subfr,   /* O    best weighted quantization error + mu * rate            */
74                 b_Q14_ptr,              /* I    input vector to be quantized                            */
75                 W_Q18_ptr,              /* I    weighting matrix                                        */
76                 cbk_ptr_Q7,             /* I    codebook                                                */
77                 cl_ptr_Q5,              /* I    code length for each codebook vector                    */
78                 mu_Q9,                  /* I    tradeoff between weighted error and rate                */
79                 cbk_size                /* I    number of vectors in codebook                           */
80             );
81
82             rate_dist_Q14 = silk_ADD_POS_SAT32( rate_dist_Q14, rate_dist_Q14_subfr );
83
84             b_Q14_ptr += LTP_ORDER;
85             W_Q18_ptr += LTP_ORDER * LTP_ORDER;
86         }
87
88         /* Avoid never finding a codebook */
89         rate_dist_Q14 = silk_min( silk_int32_MAX - 1, rate_dist_Q14 );
90
91         if( rate_dist_Q14 < min_rate_dist_Q14 ) {
92             min_rate_dist_Q14 = rate_dist_Q14;
93             *periodicity_index = (opus_int8)k;
94             silk_memcpy( cbk_index, temp_idx, nb_subfr * sizeof( opus_int8 ) );
95         }
96
97         /* Break early in low-complexity mode if rate distortion is below threshold */
98         if( lowComplexity && ( rate_dist_Q14 < silk_LTP_gain_middle_avg_RD_Q14 ) ) {
99             break;
100         }
101     }
102
103     cbk_ptr_Q7 = silk_LTP_vq_ptrs_Q7[ *periodicity_index ];
104     for( j = 0; j < nb_subfr; j++ ) {
105         for( k = 0; k < LTP_ORDER; k++ ) {
106             B_Q14[ j * LTP_ORDER + k ] = silk_LSHIFT( cbk_ptr_Q7[ cbk_index[ j ] * LTP_ORDER + k ], 7 );
107         }
108     }
109 TOC(quant_LTP)
110 }
111