Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / silk_encode_pulses.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 #include "silk_main.h"
29
30 /*********************************************/
31 /* Encode quantization indices of excitation */
32 /*********************************************/
33
34 SKP_INLINE opus_int combine_and_check(       /* return ok */
35     opus_int         *pulses_comb,           /* O */
36     const opus_int   *pulses_in,             /* I */
37     opus_int         max_pulses,             /* I    max value for sum of pulses */
38     opus_int         len                     /* I    number of output values */
39 )
40 {
41     opus_int k, sum;
42
43     for( k = 0; k < len; k++ ) {
44         sum = pulses_in[ 2 * k ] + pulses_in[ 2 * k + 1 ];
45         if( sum > max_pulses ) {
46             return 1;
47         }
48         pulses_comb[ k ] = sum;
49     }
50
51     return 0;
52 }
53
54 /* Encode quantization indices of excitation */
55 void silk_encode_pulses(
56     ec_enc                      *psRangeEnc,        /* I/O  compressor data structure                   */
57     const opus_int               signalType,         /* I    Sigtype                                     */
58     const opus_int               quantOffsetType,    /* I    quantOffsetType                             */
59     opus_int8                    pulses[],           /* I    quantization indices                        */
60     const opus_int               frame_length        /* I    Frame length                                */
61 )
62 {
63     opus_int   i, k, j, iter, bit, nLS, scale_down, RateLevelIndex = 0;
64     opus_int32 abs_q, minSumBits_Q5, sumBits_Q5;
65     opus_int   abs_pulses[ MAX_FRAME_LENGTH ];
66     opus_int   sum_pulses[ MAX_NB_SHELL_BLOCKS ];
67     opus_int   nRshifts[   MAX_NB_SHELL_BLOCKS ];
68     opus_int   pulses_comb[ 8 ];
69     opus_int   *abs_pulses_ptr;
70     const opus_int8 *pulses_ptr;
71     const opus_uint8 *cdf_ptr;
72     const opus_uint8 *nBits_ptr;
73
74     SKP_memset( pulses_comb, 0, 8 * sizeof( opus_int ) ); // Fixing Valgrind reported problem
75
76     /****************************/
77     /* Prepare for shell coding */
78     /****************************/
79     /* Calculate number of shell blocks */
80     SKP_assert( 1 << LOG2_SHELL_CODEC_FRAME_LENGTH == SHELL_CODEC_FRAME_LENGTH );
81     iter = SKP_RSHIFT( frame_length, LOG2_SHELL_CODEC_FRAME_LENGTH );
82     if( iter * SHELL_CODEC_FRAME_LENGTH < frame_length ){
83         SKP_assert( frame_length == 12 * 10 ); /* Make sure only happens for 10 ms @ 12 kHz */
84         iter++;
85         SKP_memset( &pulses[ frame_length ], 0, SHELL_CODEC_FRAME_LENGTH * sizeof(opus_int8));
86     }
87
88     /* Take the absolute value of the pulses */
89     for( i = 0; i < iter * SHELL_CODEC_FRAME_LENGTH; i+=4 ) {
90         abs_pulses[i+0] = ( opus_int )SKP_abs( pulses[ i + 0 ] );
91         abs_pulses[i+1] = ( opus_int )SKP_abs( pulses[ i + 1 ] );
92         abs_pulses[i+2] = ( opus_int )SKP_abs( pulses[ i + 2 ] );
93         abs_pulses[i+3] = ( opus_int )SKP_abs( pulses[ i + 3 ] );
94     }
95
96     /* Calc sum pulses per shell code frame */
97     abs_pulses_ptr = abs_pulses;
98     for( i = 0; i < iter; i++ ) {
99         nRshifts[ i ] = 0;
100
101         while( 1 ) {
102             /* 1+1 -> 2 */
103             scale_down = combine_and_check( pulses_comb, abs_pulses_ptr, silk_max_pulses_table[ 0 ], 8 );
104             /* 2+2 -> 4 */
105             scale_down += combine_and_check( pulses_comb, pulses_comb, silk_max_pulses_table[ 1 ], 4 );
106             /* 4+4 -> 8 */
107             scale_down += combine_and_check( pulses_comb, pulses_comb, silk_max_pulses_table[ 2 ], 2 );
108             /* 8+8 -> 16 */
109             scale_down += combine_and_check( &sum_pulses[ i ], pulses_comb, silk_max_pulses_table[ 3 ], 1 );
110
111             if( scale_down ) {
112                 /* We need to downscale the quantization signal */
113                 nRshifts[ i ]++;
114                 for( k = 0; k < SHELL_CODEC_FRAME_LENGTH; k++ ) {
115                     abs_pulses_ptr[ k ] = SKP_RSHIFT( abs_pulses_ptr[ k ], 1 );
116                 }
117             } else {
118                 /* Jump out of while(1) loop and go to next shell coding frame */
119                 break;
120             }
121         }
122         abs_pulses_ptr += SHELL_CODEC_FRAME_LENGTH;
123     }
124
125     /**************/
126     /* Rate level */
127     /**************/
128     /* find rate level that leads to fewest bits for coding of pulses per block info */
129     minSumBits_Q5 = SKP_int32_MAX;
130     for( k = 0; k < N_RATE_LEVELS - 1; k++ ) {
131         nBits_ptr  = silk_pulses_per_block_BITS_Q5[ k ];
132         sumBits_Q5 = silk_rate_levels_BITS_Q5[ signalType >> 1 ][ k ];
133         for( i = 0; i < iter; i++ ) {
134             if( nRshifts[ i ] > 0 ) {
135                 sumBits_Q5 += nBits_ptr[ MAX_PULSES + 1 ];
136             } else {
137                 sumBits_Q5 += nBits_ptr[ sum_pulses[ i ] ];
138             }
139         }
140         if( sumBits_Q5 < minSumBits_Q5 ) {
141             minSumBits_Q5 = sumBits_Q5;
142             RateLevelIndex = k;
143         }
144     }
145     ec_enc_icdf( psRangeEnc, RateLevelIndex, silk_rate_levels_iCDF[ signalType >> 1 ], 8 );
146
147     /***************************************************/
148     /* Sum-Weighted-Pulses Encoding                    */
149     /***************************************************/
150     cdf_ptr = silk_pulses_per_block_iCDF[ RateLevelIndex ];
151     for( i = 0; i < iter; i++ ) {
152         if( nRshifts[ i ] == 0 ) {
153             ec_enc_icdf( psRangeEnc, sum_pulses[ i ], cdf_ptr, 8 );
154         } else {
155             ec_enc_icdf( psRangeEnc, MAX_PULSES + 1, cdf_ptr, 8 );
156             for( k = 0; k < nRshifts[ i ] - 1; k++ ) {
157                 ec_enc_icdf( psRangeEnc, MAX_PULSES + 1, silk_pulses_per_block_iCDF[ N_RATE_LEVELS - 1 ], 8 );
158             }
159             ec_enc_icdf( psRangeEnc, sum_pulses[ i ], silk_pulses_per_block_iCDF[ N_RATE_LEVELS - 1 ], 8 );
160         }
161     }
162
163     /******************/
164     /* Shell Encoding */
165     /******************/
166     for( i = 0; i < iter; i++ ) {
167         if( sum_pulses[ i ] > 0 ) {
168             silk_shell_encoder( psRangeEnc, &abs_pulses[ i * SHELL_CODEC_FRAME_LENGTH ] );
169         }
170     }
171
172     /****************/
173     /* LSB Encoding */
174     /****************/
175     for( i = 0; i < iter; i++ ) {
176         if( nRshifts[ i ] > 0 ) {
177             pulses_ptr = &pulses[ i * SHELL_CODEC_FRAME_LENGTH ];
178             nLS = nRshifts[ i ] - 1;
179             for( k = 0; k < SHELL_CODEC_FRAME_LENGTH; k++ ) {
180                 abs_q = (opus_int8)SKP_abs( pulses_ptr[ k ] );
181                 for( j = nLS; j > 0; j-- ) {
182                     bit = SKP_RSHIFT( abs_q, j ) & 1;
183                     ec_enc_icdf( psRangeEnc, bit, silk_lsb_iCDF, 8 );
184                 }
185                 bit = abs_q & 1;
186                 ec_enc_icdf( psRangeEnc, bit, silk_lsb_iCDF, 8 );
187             }
188         }
189     }
190
191     /****************/
192     /* Encode signs */
193     /****************/
194     silk_encode_signs( psRangeEnc, pulses, frame_length, signalType, quantOffsetType, sum_pulses );
195 }