Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src_common / SKP_Silk_shell_coder.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 /* shell coder; pulse-subframe length is hardcoded */\r
31 \r
32 SKP_INLINE void combine_pulses(\r
33     SKP_int         *out,   /* O:   combined pulses vector [len] */\r
34     const SKP_int   *in,    /* I:   input vector       [2 * len] */\r
35     const SKP_int   len     /* I:   number of OUTPUT samples     */\r
36 )\r
37 {\r
38     SKP_int k;\r
39     for( k = 0; k < len; k++ ) {\r
40         out[ k ] = in[ 2 * k ] + in[ 2 * k + 1 ];\r
41     }\r
42 }\r
43 \r
44 SKP_INLINE void encode_split(\r
45     SKP_Silk_range_coder_state  *sRC,           /* I/O: compressor data structure                   */\r
46     const SKP_int               p_child1,       /* I:   pulse amplitude of first child subframe     */\r
47     const SKP_int               p,              /* I:   pulse amplitude of current subframe         */\r
48     const SKP_uint16            *shell_table    /* I:   table of shell cdfs                         */\r
49 )\r
50 {\r
51     const SKP_uint16 *cdf;\r
52 \r
53     if( p > 0 ) {\r
54         cdf = &shell_table[ SKP_Silk_shell_code_table_offsets[ p ] ];\r
55         SKP_Silk_range_encoder( sRC, p_child1, cdf );\r
56     }\r
57 }\r
58 \r
59 SKP_INLINE void decode_split(\r
60     SKP_int                     *p_child1,      /* O:   pulse amplitude of first child subframe     */\r
61     SKP_int                     *p_child2,      /* O:   pulse amplitude of second child subframe    */\r
62     SKP_Silk_range_coder_state  *sRC,           /* I/O: compressor data structure                   */\r
63     const SKP_int               p,              /* I:   pulse amplitude of current subframe         */\r
64     const SKP_uint16            *shell_table    /* I:   table of shell cdfs                         */\r
65 )\r
66 {\r
67     SKP_int cdf_middle;\r
68     const SKP_uint16 *cdf;\r
69 \r
70     if( p > 0 ) {\r
71         cdf_middle = SKP_RSHIFT( p, 1 );\r
72         cdf = &shell_table[ SKP_Silk_shell_code_table_offsets[ p ] ];\r
73         SKP_Silk_range_decoder( p_child1, sRC, cdf, cdf_middle );\r
74         p_child2[ 0 ] = p - p_child1[ 0 ];\r
75     } else {\r
76         p_child1[ 0 ] = 0;\r
77         p_child2[ 0 ] = 0;\r
78     }\r
79 }\r
80 \r
81 /* Shell encoder, operates on one shell code frame of 16 pulses */\r
82 void SKP_Silk_shell_encoder(\r
83     SKP_Silk_range_coder_state      *sRC,               /* I/O  compressor data structure                   */\r
84     const SKP_int                   *pulses0            /* I    data: nonnegative pulse amplitudes          */\r
85 )\r
86 {\r
87     SKP_int pulses1[ 8 ], pulses2[ 4 ], pulses3[ 2 ], pulses4[ 1 ];\r
88 \r
89     /* this function operates on one shell code frame of 16 pulses */\r
90     SKP_assert( SHELL_CODEC_FRAME_LENGTH == 16 );\r
91 \r
92     /* tree representation per pulse-subframe */\r
93     combine_pulses( pulses1, pulses0, 8 );\r
94     combine_pulses( pulses2, pulses1, 4 );\r
95     combine_pulses( pulses3, pulses2, 2 );\r
96     combine_pulses( pulses4, pulses3, 1 );\r
97 \r
98     encode_split( sRC, pulses3[  0 ], pulses4[ 0 ], SKP_Silk_shell_code_table3 );\r
99 \r
100     encode_split( sRC, pulses2[  0 ], pulses3[ 0 ], SKP_Silk_shell_code_table2 );\r
101 \r
102     encode_split( sRC, pulses1[  0 ], pulses2[ 0 ], SKP_Silk_shell_code_table1 );\r
103     encode_split( sRC, pulses0[  0 ], pulses1[ 0 ], SKP_Silk_shell_code_table0 );\r
104     encode_split( sRC, pulses0[  2 ], pulses1[ 1 ], SKP_Silk_shell_code_table0 );\r
105 \r
106     encode_split( sRC, pulses1[  2 ], pulses2[ 1 ], SKP_Silk_shell_code_table1 );\r
107     encode_split( sRC, pulses0[  4 ], pulses1[ 2 ], SKP_Silk_shell_code_table0 );\r
108     encode_split( sRC, pulses0[  6 ], pulses1[ 3 ], SKP_Silk_shell_code_table0 );\r
109 \r
110     encode_split( sRC, pulses2[  2 ], pulses3[ 1 ], SKP_Silk_shell_code_table2 );\r
111 \r
112     encode_split( sRC, pulses1[  4 ], pulses2[ 2 ], SKP_Silk_shell_code_table1 );\r
113     encode_split( sRC, pulses0[  8 ], pulses1[ 4 ], SKP_Silk_shell_code_table0 );\r
114     encode_split( sRC, pulses0[ 10 ], pulses1[ 5 ], SKP_Silk_shell_code_table0 );\r
115 \r
116     encode_split( sRC, pulses1[  6 ], pulses2[ 3 ], SKP_Silk_shell_code_table1 );\r
117     encode_split( sRC, pulses0[ 12 ], pulses1[ 6 ], SKP_Silk_shell_code_table0 );\r
118     encode_split( sRC, pulses0[ 14 ], pulses1[ 7 ], SKP_Silk_shell_code_table0 );\r
119 }\r
120 \r
121 \r
122 /* Shell decoder, operates on one shell code frame of 16 pulses */\r
123 void SKP_Silk_shell_decoder(\r
124     SKP_int                         *pulses0,           /* O    data: nonnegative pulse amplitudes          */\r
125     SKP_Silk_range_coder_state      *sRC,               /* I/O  compressor data structure                   */\r
126     const SKP_int                   pulses4             /* I    number of pulses per pulse-subframe         */\r
127 )\r
128 {\r
129     SKP_int pulses3[ 2 ], pulses2[ 4 ], pulses1[ 8 ];\r
130 \r
131     /* this function operates on one shell code frame of 16 pulses */\r
132     SKP_assert( SHELL_CODEC_FRAME_LENGTH == 16 );\r
133 \r
134     decode_split( &pulses3[  0 ], &pulses3[  1 ], sRC, pulses4,      SKP_Silk_shell_code_table3 );\r
135 \r
136     decode_split( &pulses2[  0 ], &pulses2[  1 ], sRC, pulses3[ 0 ], SKP_Silk_shell_code_table2 );\r
137 \r
138     decode_split( &pulses1[  0 ], &pulses1[  1 ], sRC, pulses2[ 0 ], SKP_Silk_shell_code_table1 );\r
139     decode_split( &pulses0[  0 ], &pulses0[  1 ], sRC, pulses1[ 0 ], SKP_Silk_shell_code_table0 );\r
140     decode_split( &pulses0[  2 ], &pulses0[  3 ], sRC, pulses1[ 1 ], SKP_Silk_shell_code_table0 );\r
141 \r
142     decode_split( &pulses1[  2 ], &pulses1[  3 ], sRC, pulses2[ 1 ], SKP_Silk_shell_code_table1 );\r
143     decode_split( &pulses0[  4 ], &pulses0[  5 ], sRC, pulses1[ 2 ], SKP_Silk_shell_code_table0 );\r
144     decode_split( &pulses0[  6 ], &pulses0[  7 ], sRC, pulses1[ 3 ], SKP_Silk_shell_code_table0 );\r
145 \r
146     decode_split( &pulses2[  2 ], &pulses2[  3 ], sRC, pulses3[ 1 ], SKP_Silk_shell_code_table2 );\r
147 \r
148     decode_split( &pulses1[  4 ], &pulses1[  5 ], sRC, pulses2[ 2 ], SKP_Silk_shell_code_table1 );\r
149     decode_split( &pulses0[  8 ], &pulses0[  9 ], sRC, pulses1[ 4 ], SKP_Silk_shell_code_table0 );\r
150     decode_split( &pulses0[ 10 ], &pulses0[ 11 ], sRC, pulses1[ 5 ], SKP_Silk_shell_code_table0 );\r
151 \r
152     decode_split( &pulses1[  6 ], &pulses1[  7 ], sRC, pulses2[ 3 ], SKP_Silk_shell_code_table1 );\r
153     decode_split( &pulses0[ 12 ], &pulses0[ 13 ], sRC, pulses1[ 6 ], SKP_Silk_shell_code_table0 );\r
154     decode_split( &pulses0[ 14 ], &pulses0[ 15 ], sRC, pulses1[ 7 ], SKP_Silk_shell_code_table0 );\r
155 }\r