Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_encode_pulses.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.h"\r
29 \r
30 /*********************************************/\r
31 /* Encode quantization indices of excitation */\r
32 /*********************************************/\r
33 \r
34 SKP_INLINE SKP_int combine_and_check(       /* return ok */\r
35     SKP_int         *pulses_comb,           /* O */\r
36     const SKP_int   *pulses_in,             /* I */\r
37     SKP_int         max_pulses,             /* I    max value for sum of pulses */\r
38     SKP_int         len                     /* I    number of output values */\r
39\r
40 {\r
41     SKP_int k, sum;\r
42 \r
43     for( k = 0; k < len; k++ ) {\r
44         sum = pulses_in[ 2 * k ] + pulses_in[ 2 * k + 1 ];\r
45         if( sum > max_pulses ) {\r
46             return 1;\r
47         }\r
48         pulses_comb[ k ] = sum;\r
49     }\r
50 \r
51     return 0;\r
52 }\r
53 \r
54 /* Encode quantization indices of excitation */\r
55 void SKP_Silk_encode_pulses(\r
56     SKP_Silk_range_coder_state      *psRC,          /* I/O  Range coder state               */\r
57     const SKP_int                   sigtype,        /* I    Sigtype                         */\r
58     const SKP_int                   QuantOffsetType,/* I    QuantOffsetType                 */\r
59     const SKP_int                   q[],            /* I    quantization indices            */\r
60     const SKP_int                   frame_length    /* I    Frame length                    */\r
61 )\r
62 {\r
63     SKP_int   i, k, j, iter, bit, nLS, scale_down, RateLevelIndex = 0;\r
64     SKP_int32 abs_q, minSumBits_Q6, sumBits_Q6;\r
65     SKP_int   abs_pulses[ MAX_FRAME_LENGTH ];\r
66     SKP_int   sum_pulses[ MAX_NB_SHELL_BLOCKS ];\r
67         SKP_int   nRshifts[   MAX_NB_SHELL_BLOCKS ]; \r
68     SKP_int   pulses_comb[ 8 ];\r
69     SKP_int   *abs_pulses_ptr;\r
70     const SKP_int *pulses_ptr;\r
71     const SKP_uint16 *cdf_ptr;\r
72     const SKP_int16 *nBits_ptr;\r
73 \r
74     SKP_memset( pulses_comb, 0, 8 * sizeof( SKP_int ) ); // Fixing Valgrind reported problem\r
75 \r
76     /****************************/\r
77     /* Prepare for shell coding */\r
78     /****************************/\r
79     /* Calculate number of shell blocks */\r
80     iter = frame_length / SHELL_CODEC_FRAME_LENGTH;\r
81     \r
82     /* Take the absolute value of the pulses */\r
83     for( i = 0; i < frame_length; i+=4 ) {\r
84         abs_pulses[i+0] = ( SKP_int )SKP_abs( q[ i + 0 ] );\r
85         abs_pulses[i+1] = ( SKP_int )SKP_abs( q[ i + 1 ] );\r
86         abs_pulses[i+2] = ( SKP_int )SKP_abs( q[ i + 2 ] );\r
87         abs_pulses[i+3] = ( SKP_int )SKP_abs( q[ i + 3 ] );\r
88     }\r
89 \r
90     /* Calc sum pulses per shell code frame */\r
91     abs_pulses_ptr = abs_pulses;\r
92     for( i = 0; i < iter; i++ ) {\r
93         nRshifts[ i ] = 0;\r
94 \r
95         while( 1 ) {\r
96             /* 1+1 -> 2 */\r
97             scale_down = combine_and_check( pulses_comb, abs_pulses_ptr, SKP_Silk_max_pulses_table[ 0 ], 8 );\r
98 \r
99             /* 2+2 -> 4 */\r
100             scale_down += combine_and_check( pulses_comb, pulses_comb, SKP_Silk_max_pulses_table[ 1 ], 4 );\r
101 \r
102             /* 4+4 -> 8 */\r
103             scale_down += combine_and_check( pulses_comb, pulses_comb, SKP_Silk_max_pulses_table[ 2 ], 2 );\r
104 \r
105             /* 8+8 -> 16 */\r
106             sum_pulses[ i ] = pulses_comb[ 0 ] + pulses_comb[ 1 ];\r
107             if( sum_pulses[ i ] > SKP_Silk_max_pulses_table[ 3 ] ) {\r
108                 scale_down++;\r
109             }\r
110 \r
111             if( scale_down ) {\r
112                 /* We need to down scale the quantization signal */\r
113                 nRshifts[ i ]++;                \r
114                 for( k = 0; k < SHELL_CODEC_FRAME_LENGTH; k++ ) {\r
115                     abs_pulses_ptr[ k ] = SKP_RSHIFT( abs_pulses_ptr[ k ], 1 );\r
116                 }\r
117             } else {\r
118                 /* Jump out of while(1) loop and go to next shell coding frame */\r
119                 break;\r
120             }\r
121         }\r
122         abs_pulses_ptr += SHELL_CODEC_FRAME_LENGTH;\r
123     }\r
124 \r
125     /**************/\r
126     /* Rate level */\r
127     /**************/\r
128     /* find rate level that leads to fewest bits for coding of pulses per block info */\r
129     minSumBits_Q6 = SKP_int32_MAX;\r
130     for( k = 0; k < N_RATE_LEVELS - 1; k++ ) {\r
131         nBits_ptr  = SKP_Silk_pulses_per_block_BITS_Q6[ k ];\r
132         sumBits_Q6 = SKP_Silk_rate_levels_BITS_Q6[sigtype][ k ];\r
133         for( i = 0; i < iter; i++ ) {\r
134             if( nRshifts[ i ] > 0 ) {\r
135                 sumBits_Q6 += nBits_ptr[ MAX_PULSES + 1 ];\r
136             } else {\r
137                 sumBits_Q6 += nBits_ptr[ sum_pulses[ i ] ];\r
138             }\r
139         }\r
140         if( sumBits_Q6 < minSumBits_Q6 ) {\r
141             minSumBits_Q6 = sumBits_Q6;\r
142             RateLevelIndex = k;\r
143         }\r
144     }\r
145     SKP_Silk_range_encoder( psRC, RateLevelIndex, SKP_Silk_rate_levels_CDF[ sigtype ] );\r
146 \r
147     /***************************************************/\r
148     /* Sum-Weighted-Pulses Encoding                    */\r
149     /***************************************************/\r
150     cdf_ptr = SKP_Silk_pulses_per_block_CDF[ RateLevelIndex ];\r
151     for( i = 0; i < iter; i++ ) {\r
152         if( nRshifts[ i ] == 0 ) {\r
153             SKP_Silk_range_encoder( psRC, sum_pulses[ i ], cdf_ptr );\r
154         } else {\r
155             SKP_Silk_range_encoder( psRC, MAX_PULSES + 1, cdf_ptr );\r
156             for( k = 0; k < nRshifts[ i ] - 1; k++ ) {\r
157                 SKP_Silk_range_encoder( psRC, MAX_PULSES + 1, SKP_Silk_pulses_per_block_CDF[ N_RATE_LEVELS - 1 ] );\r
158             }\r
159             SKP_Silk_range_encoder( psRC, sum_pulses[ i ], SKP_Silk_pulses_per_block_CDF[ N_RATE_LEVELS - 1 ] );\r
160         }\r
161     }\r
162 \r
163     /******************/\r
164     /* Shell Encoding */\r
165     /******************/\r
166     for( i = 0; i < iter; i++ ) {\r
167         if( sum_pulses[ i ] > 0 ) {\r
168             SKP_Silk_shell_encoder( psRC, &abs_pulses[ i * SHELL_CODEC_FRAME_LENGTH ] );\r
169         }\r
170     }\r
171 \r
172     /****************/\r
173     /* LSB Encoding */\r
174     /****************/\r
175     for( i = 0; i < iter; i++ ) {\r
176         if( nRshifts[ i ] > 0 ) {\r
177             pulses_ptr = &q[ i * SHELL_CODEC_FRAME_LENGTH ];\r
178             nLS = nRshifts[ i ] - 1;\r
179             for( k = 0; k < SHELL_CODEC_FRAME_LENGTH; k++ ) {\r
180                 abs_q = SKP_abs( pulses_ptr[ k ] );\r
181                 for( j = nLS; j > 0; j-- ) {\r
182                     bit = SKP_RSHIFT( abs_q, j ) & 1;\r
183                     SKP_Silk_range_encoder( psRC, bit, SKP_Silk_lsb_CDF );\r
184                 }\r
185                 bit = abs_q & 1;\r
186                 SKP_Silk_range_encoder( psRC, bit, SKP_Silk_lsb_CDF );\r
187             }\r
188         }\r
189     }\r
190 \r
191     /****************/\r
192     /* Encode signs */\r
193     /****************/\r
194     SKP_Silk_encode_signs( psRC, q, frame_length, sigtype, QuantOffsetType, RateLevelIndex );\r
195 }\r