Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_tables.h
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 #ifndef SKP_SILK_TABLES_H\r
29 #define SKP_SILK_TABLES_H\r
30 \r
31 #include "SKP_Silk_define.h"\r
32 #include "SKP_Silk_structs.h"\r
33 \r
34 #define PITCH_EST_MAX_LAG_MS                18          /* 18 ms -> 56 Hz */\r
35 #define PITCH_EST_MIN_LAG_MS                2           /* 2 ms -> 500 Hz */\r
36 \r
37 #ifdef __cplusplus\r
38 extern "C"\r
39 {\r
40 #endif\r
41 \r
42 /* entropy coding tables */\r
43 extern const SKP_uint16 SKP_Silk_type_offset_CDF[ 5 ];                                              /*   5 */\r
44 extern const SKP_uint16 SKP_Silk_type_offset_joint_CDF[ 4 ][ 5 ];                                   /*  20 */\r
45 extern const SKP_int    SKP_Silk_type_offset_CDF_offset;\r
46 \r
47 extern const SKP_uint16 SKP_Silk_gain_CDF[ 2 ][ N_LEVELS_QGAIN + 1 ];                               /* 130 */\r
48 extern const SKP_int    SKP_Silk_gain_CDF_offset;\r
49 extern const SKP_uint16 SKP_Silk_delta_gain_CDF[ MAX_DELTA_GAIN_QUANT - MIN_DELTA_GAIN_QUANT + 2 ]; /*  46 */\r
50 extern const SKP_int    SKP_Silk_delta_gain_CDF_offset;\r
51 \r
52 extern const SKP_uint16 SKP_Silk_pitch_lag_NB_CDF[ 8 * ( PITCH_EST_MAX_LAG_MS - PITCH_EST_MIN_LAG_MS ) + 2 ];   /* 130 */\r
53 extern const SKP_int    SKP_Silk_pitch_lag_NB_CDF_offset;\r
54 extern const SKP_uint16 SKP_Silk_pitch_lag_MB_CDF[ 12 * ( PITCH_EST_MAX_LAG_MS - PITCH_EST_MIN_LAG_MS ) + 2 ];  /* 194 */\r
55 extern const SKP_int    SKP_Silk_pitch_lag_MB_CDF_offset;\r
56 extern const SKP_uint16 SKP_Silk_pitch_lag_WB_CDF[ 16 * ( PITCH_EST_MAX_LAG_MS - PITCH_EST_MIN_LAG_MS ) + 2 ];  /* 258 */\r
57 extern const SKP_int    SKP_Silk_pitch_lag_WB_CDF_offset;\r
58 extern const SKP_uint16 SKP_Silk_pitch_lag_SWB_CDF[ 24 * ( PITCH_EST_MAX_LAG_MS - PITCH_EST_MIN_LAG_MS ) + 2 ]; /* 386 */\r
59 extern const SKP_int    SKP_Silk_pitch_lag_SWB_CDF_offset;\r
60 \r
61 extern const SKP_uint16 SKP_Silk_pitch_contour_CDF[ 35 ];                                           /*  35 */\r
62 extern const SKP_int    SKP_Silk_pitch_contour_CDF_offset;\r
63 extern const SKP_uint16 SKP_Silk_pitch_contour_NB_CDF[ 12 ];                                        /*  12 */\r
64 extern const SKP_int    SKP_Silk_pitch_contour_NB_CDF_offset;\r
65 extern const SKP_uint16 SKP_Silk_pitch_delta_CDF[23];                                               /* 23 */\r
66 extern const SKP_int    SKP_Silk_pitch_delta_CDF_offset;\r
67 \r
68 extern const SKP_uint16 SKP_Silk_pulses_per_block_CDF[ N_RATE_LEVELS ][ MAX_PULSES + 3 ];           /* 210 */\r
69 extern const SKP_int    SKP_Silk_pulses_per_block_CDF_offset;\r
70 extern const SKP_int16  SKP_Silk_pulses_per_block_BITS_Q6[ N_RATE_LEVELS - 1 ][ MAX_PULSES + 2 ];   /* 180 */\r
71 \r
72 extern const SKP_uint16 SKP_Silk_rate_levels_CDF[ 2 ][ N_RATE_LEVELS ];                             /*  20 */\r
73 extern const SKP_int    SKP_Silk_rate_levels_CDF_offset;\r
74 extern const SKP_int16  SKP_Silk_rate_levels_BITS_Q6[ 2 ][ N_RATE_LEVELS - 1 ];                     /*  18 */\r
75 \r
76 extern const SKP_int    SKP_Silk_max_pulses_table[ 4 ];                                             /*   4 */\r
77 \r
78 extern const SKP_uint16 SKP_Silk_shell_code_table0[  33 ];                                          /*  33 */\r
79 extern const SKP_uint16 SKP_Silk_shell_code_table1[  52 ];                                          /*  52 */\r
80 extern const SKP_uint16 SKP_Silk_shell_code_table2[ 102 ];                                          /* 102 */\r
81 extern const SKP_uint16 SKP_Silk_shell_code_table3[ 207 ];                                          /* 207 */\r
82 extern const SKP_uint16 SKP_Silk_shell_code_table_offsets[ 19 ];                                    /*  19 */\r
83 \r
84 extern const SKP_uint16 SKP_Silk_lsb_CDF[ 3 ];                                                      /*   3 */\r
85 \r
86 extern const SKP_uint16 SKP_Silk_sign_CDF[ 36 ][ 3 ];                                               /* 108 */\r
87 \r
88 extern const SKP_uint16 SKP_Silk_LTP_per_index_CDF[ 4 ];                                            /*   4 */\r
89 extern const SKP_int    SKP_Silk_LTP_per_index_CDF_offset;\r
90 extern const SKP_int16  * const SKP_Silk_LTP_gain_BITS_Q6_ptrs[ NB_LTP_CBKS ];                      /*   3 */\r
91 extern const SKP_uint16 * const SKP_Silk_LTP_gain_CDF_ptrs[ NB_LTP_CBKS ];                          /*   3 */\r
92 extern const SKP_int    SKP_Silk_LTP_gain_CDF_offsets[ NB_LTP_CBKS ];                               /*   3 */\r
93 extern const SKP_int32  SKP_Silk_LTP_gain_middle_avg_RD_Q14;\r
94 extern const SKP_uint16 SKP_Silk_LTPscale_CDF[ 4 ];                                                 /*   4 */\r
95 extern const SKP_int    SKP_Silk_LTPscale_offset;\r
96 \r
97 /* Tables for LTPScale */\r
98 extern const SKP_int16  SKP_Silk_LTPScales_table_Q14[ 3 ];\r
99 \r
100 extern const SKP_uint16 SKP_Silk_vadflag_CDF[ 3 ];                                                  /*   3 */\r
101 extern const SKP_int    SKP_Silk_vadflag_offset;\r
102 \r
103 extern const SKP_int    SKP_Silk_SamplingRates_table[ 4 ];                                          /*   4 */\r
104 extern const SKP_uint16 SKP_Silk_SamplingRates_CDF[ 5 ];                                            /*   5 */\r
105 extern const SKP_int    SKP_Silk_SamplingRates_offset;\r
106 \r
107 extern const SKP_uint16 SKP_Silk_NLSF_interpolation_factor_CDF[ 6 ];\r
108 extern const SKP_int    SKP_Silk_NLSF_interpolation_factor_offset;\r
109 \r
110 /* NLSF codebooks */\r
111 extern const SKP_Silk_NLSF_CB_struct SKP_Silk_NLSF_CB0_16, SKP_Silk_NLSF_CB1_16;\r
112 extern const SKP_Silk_NLSF_CB_struct SKP_Silk_NLSF_CB0_10, SKP_Silk_NLSF_CB1_10;\r
113 \r
114 /* quantization tables */\r
115 extern const SKP_int16 * const SKP_Silk_LTP_vq_ptrs_Q14[ NB_LTP_CBKS ];                             /* 168 */\r
116 extern const SKP_int    SKP_Silk_LTP_vq_sizes[ NB_LTP_CBKS ];                                       /*   3 */\r
117 \r
118 /* Piece-wise linear mapping from bitrate in kbps to coding quality in dB SNR */\r
119 extern const SKP_int32  TargetRate_table_NB[  TARGET_RATE_TAB_SZ ];\r
120 extern const SKP_int32  TargetRate_table_MB[  TARGET_RATE_TAB_SZ ];\r
121 extern const SKP_int32  TargetRate_table_WB[  TARGET_RATE_TAB_SZ ];\r
122 extern const SKP_int32  TargetRate_table_SWB[ TARGET_RATE_TAB_SZ ];\r
123 extern const SKP_int32  SNR_table_Q1[         TARGET_RATE_TAB_SZ ];\r
124 \r
125 extern const SKP_int32  SNR_table_one_bit_per_sample_Q7[ 4 ];\r
126 \r
127 /* Filter coeficicnts for HP filter: 4. Order filter implementad as two biquad filters  */\r
128 extern const SKP_int16  SKP_Silk_SWB_detect_B_HP_Q13[ NB_SOS ][ 3 ];\r
129 extern const SKP_int16  SKP_Silk_SWB_detect_A_HP_Q13[ NB_SOS ][ 2 ];\r
130 \r
131 /* Decoder high-pass filter coefficients for 24 kHz sampling */\r
132 extern const SKP_int16  SKP_Silk_Dec_A_HP_24[ DEC_HP_ORDER ];                                       /*   2 */\r
133 extern const SKP_int16  SKP_Silk_Dec_B_HP_24[ DEC_HP_ORDER + 1 ];                                   /*   3 */\r
134 \r
135 /* Decoder high-pass filter coefficients for 16 kHz sampling */\r
136 extern const SKP_int16  SKP_Silk_Dec_A_HP_16[ DEC_HP_ORDER ];                                       /*   2 */\r
137 extern const SKP_int16  SKP_Silk_Dec_B_HP_16[ DEC_HP_ORDER + 1 ];                                   /*   3 */\r
138 \r
139 /* Decoder high-pass filter coefficients for 12 kHz sampling */\r
140 extern const SKP_int16  SKP_Silk_Dec_A_HP_12[ DEC_HP_ORDER ];                                       /*   2 */\r
141 extern const SKP_int16  SKP_Silk_Dec_B_HP_12[ DEC_HP_ORDER + 1 ];                                   /*   3 */\r
142 \r
143 /* Decoder high-pass filter coefficients for 8 kHz sampling */\r
144 extern const SKP_int16  SKP_Silk_Dec_A_HP_8[ DEC_HP_ORDER ];                                        /*   2 */\r
145 extern const SKP_int16  SKP_Silk_Dec_B_HP_8[ DEC_HP_ORDER + 1 ];                                    /*   3 */\r
146 \r
147 /* Table for frame termination indication */\r
148 extern const SKP_uint16 SKP_Silk_FrameTermination_CDF[ 5 ];\r
149 extern const SKP_int    SKP_Silk_FrameTermination_offset;\r
150 \r
151 extern const SKP_uint16 SKP_Silk_FrameTermination_v4_CDF[ 6 ];\r
152 extern const SKP_int    SKP_Silk_FrameTermination_v4_offset;\r
153 \r
154 /* Table for random seed */\r
155 extern const SKP_uint16 SKP_Silk_Seed_CDF[ 5 ];\r
156 extern const SKP_int    SKP_Silk_Seed_offset;\r
157 \r
158 /* Quantization offsets */\r
159 extern const SKP_int16  SKP_Silk_Quantization_Offsets_Q10[ 2 ][ 2 ];\r
160 \r
161 #if SWITCH_TRANSITION_FILTERING\r
162 /* Interpolation points for filter coefficients used in the bandwidth transition smoother */\r
163 extern const SKP_int32 SKP_Silk_Transition_LP_B_Q28[ TRANSITION_INT_NUM ][ TRANSITION_NB ];\r
164 extern const SKP_int32 SKP_Silk_Transition_LP_A_Q28[ TRANSITION_INT_NUM ][ TRANSITION_NA ];\r
165 #endif\r
166 \r
167 #ifdef __cplusplus\r
168 }\r
169 #endif\r
170 \r
171 #endif\r