Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / silk / silk_decode_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 /* Decode quantization indices of excitation */
32 /*********************************************/
33 void silk_decode_pulses(
34     ec_dec                          *psRangeDec,        /* I/O  Compressor data structure                   */
35     opus_int                         pulses[],           /* O    Excitation signal                           */
36     const opus_int                   signalType,         /* I    Sigtype                                     */
37     const opus_int                   quantOffsetType,    /* I    quantOffsetType                             */
38     const opus_int                   frame_length        /* I    Frame length                                */
39 )
40 {
41     opus_int   i, j, k, iter, abs_q, nLS, RateLevelIndex;
42     opus_int   sum_pulses[ MAX_NB_SHELL_BLOCKS ], nLshifts[ MAX_NB_SHELL_BLOCKS ];
43     opus_int   *pulses_ptr;
44     const opus_uint8 *cdf_ptr;
45
46     /*********************/
47     /* Decode rate level */
48     /*********************/
49     RateLevelIndex = ec_dec_icdf( psRangeDec, silk_rate_levels_iCDF[ signalType >> 1 ], 8 );
50
51     /* Calculate number of shell blocks */
52     SKP_assert( 1 << LOG2_SHELL_CODEC_FRAME_LENGTH == SHELL_CODEC_FRAME_LENGTH );
53     iter = SKP_RSHIFT( frame_length, LOG2_SHELL_CODEC_FRAME_LENGTH );
54     if( iter * SHELL_CODEC_FRAME_LENGTH < frame_length ){
55         SKP_assert( frame_length == 12 * 10 ); /* Make sure only happens for 10 ms @ 12 kHz */
56         iter++;
57     }
58
59     /***************************************************/
60     /* Sum-Weighted-Pulses Decoding                    */
61     /***************************************************/
62     cdf_ptr = silk_pulses_per_block_iCDF[ RateLevelIndex ];
63     for( i = 0; i < iter; i++ ) {
64         nLshifts[ i ] = 0;
65         sum_pulses[ i ] = ec_dec_icdf( psRangeDec, cdf_ptr, 8 );
66
67         /* LSB indication */
68         while( sum_pulses[ i ] == MAX_PULSES + 1 ) {
69             nLshifts[ i ]++;
70             /* When we've already got 10 LSBs, we shift the table to not allow (MAX_PULSES + 1) */
71             sum_pulses[ i ] = ec_dec_icdf( psRangeDec,
72                     silk_pulses_per_block_iCDF[ N_RATE_LEVELS - 1] + (nLshifts[ i ]==10), 8 );
73         }
74     }
75
76     /***************************************************/
77     /* Shell decoding                                  */
78     /***************************************************/
79     for( i = 0; i < iter; i++ ) {
80         if( sum_pulses[ i ] > 0 ) {
81             silk_shell_decoder( &pulses[ SKP_SMULBB( i, SHELL_CODEC_FRAME_LENGTH ) ], psRangeDec, sum_pulses[ i ] );
82         } else {
83             SKP_memset( &pulses[ SKP_SMULBB( i, SHELL_CODEC_FRAME_LENGTH ) ], 0, SHELL_CODEC_FRAME_LENGTH * sizeof( opus_int ) );
84         }
85     }
86
87     /***************************************************/
88     /* LSB Decoding                                    */
89     /***************************************************/
90     for( i = 0; i < iter; i++ ) {
91         if( nLshifts[ i ] > 0 ) {
92             nLS = nLshifts[ i ];
93             pulses_ptr = &pulses[ SKP_SMULBB( i, SHELL_CODEC_FRAME_LENGTH ) ];
94             for( k = 0; k < SHELL_CODEC_FRAME_LENGTH; k++ ) {
95                 abs_q = pulses_ptr[ k ];
96                 for( j = 0; j < nLS; j++ ) {
97                     abs_q = SKP_LSHIFT( abs_q, 1 );
98                     abs_q += ec_dec_icdf( psRangeDec, silk_lsb_iCDF, 8 );
99                 }
100                 pulses_ptr[ k ] = abs_q;
101             }
102         }
103     }
104
105     /****************************************/
106     /* Decode and add signs to pulse signal */
107     /****************************************/
108     silk_decode_signs( psRangeDec, pulses, frame_length, signalType, quantOffsetType, sum_pulses );
109 }