Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_encode_parameters_v4.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 parameters to create the payload */\r
32 /*******************************************/\r
33 void SKP_Silk_encode_parameters_v4(\r
34     SKP_Silk_encoder_state          *psEncC,        /* I/O  Encoder state                   */\r
35     SKP_Silk_encoder_control        *psEncCtrlC,    /* I/O  Encoder control                 */\r
36     SKP_Silk_range_coder_state      *psRC           /* I/O  Range encoder state             */\r
37 )\r
38 {\r
39     SKP_int   i, k, typeOffset;\r
40     SKP_int   encode_absolute_lagIndex, delta_lagIndex;\r
41     const SKP_Silk_NLSF_CB_struct *psNLSF_CB;\r
42 \r
43 \r
44     /************************/\r
45     /* Encode sampling rate */\r
46     /************************/\r
47     /* only done for first frame in packet */\r
48     if( psEncC->nFramesInPayloadBuf == 0 ) {\r
49         \r
50         /* Initialize arithmetic coder */\r
51         SKP_Silk_range_enc_init( &psEncC->sRC );\r
52         psEncC->nBytesInPayloadBuf = 0;\r
53 \r
54         /* get sampling rate index */\r
55         for( i = 0; i < 3; i++ ) {\r
56             if( SKP_Silk_SamplingRates_table[ i ] == psEncC->fs_kHz ) {\r
57                 break;\r
58             }\r
59         }\r
60         SKP_Silk_range_encoder( psRC, i, SKP_Silk_SamplingRates_CDF );\r
61     }\r
62 \r
63     /*********************************************/\r
64     /* Encode VAD flag                           */\r
65     /*********************************************/\r
66     SKP_Silk_range_encoder( psRC, psEncC->vadFlag, SKP_Silk_vadflag_CDF );\r
67 \r
68     /*******************************************/\r
69     /* Encode signal type and quantizer offset */\r
70     /*******************************************/\r
71     typeOffset = 2 * psEncCtrlC->sigtype + psEncCtrlC->QuantOffsetType;\r
72     if( psEncC->nFramesInPayloadBuf == 0 ) {\r
73         /* first frame in packet: independent coding */\r
74         SKP_Silk_range_encoder( psRC, typeOffset, SKP_Silk_type_offset_CDF );\r
75     } else {\r
76         /* condidtional coding */\r
77         SKP_Silk_range_encoder( psRC, typeOffset, SKP_Silk_type_offset_joint_CDF[ psEncC->typeOffsetPrev ] );\r
78     }\r
79     psEncC->typeOffsetPrev = typeOffset;\r
80 \r
81     /****************/\r
82     /* Encode gains */\r
83     /****************/\r
84     /* first subframe */\r
85     if( psEncC->nFramesInPayloadBuf == 0 ) {\r
86         /* first frame in packet: independent coding */\r
87         SKP_Silk_range_encoder( psRC, psEncCtrlC->GainsIndices[ 0 ], SKP_Silk_gain_CDF[ psEncCtrlC->sigtype ] );\r
88     } else {\r
89         /* condidtional coding */\r
90         SKP_Silk_range_encoder( psRC, psEncCtrlC->GainsIndices[ 0 ], SKP_Silk_delta_gain_CDF );\r
91     }\r
92 \r
93     /* remaining subframes */\r
94     for( i = 1; i < NB_SUBFR; i++ ) {\r
95         SKP_Silk_range_encoder( psRC, psEncCtrlC->GainsIndices[ i ], SKP_Silk_delta_gain_CDF );\r
96     }\r
97 \r
98 \r
99     /****************/\r
100     /* Encode NLSFs */\r
101     /****************/\r
102     /* Range encoding of the NLSF path */\r
103     psNLSF_CB = psEncC->psNLSF_CB[ psEncCtrlC->sigtype ];\r
104     SKP_Silk_range_encoder_multi( psRC, psEncCtrlC->NLSFIndices, psNLSF_CB->StartPtr, psNLSF_CB->nStages );\r
105 \r
106     /* Encode NLSF interpolation factor */\r
107     SKP_assert( psEncC->useInterpolatedNLSFs == 1 || psEncCtrlC->NLSFInterpCoef_Q2 == ( 1 << 2 ) );\r
108     SKP_Silk_range_encoder( psRC, psEncCtrlC->NLSFInterpCoef_Q2, SKP_Silk_NLSF_interpolation_factor_CDF );\r
109 \r
110 \r
111     if( psEncCtrlC->sigtype == SIG_TYPE_VOICED ) {\r
112         /*********************/\r
113         /* Encode pitch lags */\r
114         /*********************/\r
115 \r
116 \r
117         /* lag index */\r
118         encode_absolute_lagIndex = 1;\r
119         if( psEncC->nFramesInPayloadBuf > 0 && psEncC->prev_sigtype == SIG_TYPE_VOICED ) {\r
120             /* Delta Encoding */\r
121             delta_lagIndex = psEncCtrlC->lagIndex - psEncC->prev_lagIndex;\r
122             if( delta_lagIndex > MAX_DELTA_LAG ) {\r
123                 delta_lagIndex = ( MAX_DELTA_LAG << 1 ) + 1;\r
124             } else if ( delta_lagIndex < -MAX_DELTA_LAG ) {\r
125                 delta_lagIndex = ( MAX_DELTA_LAG << 1 ) + 1;\r
126             } else {\r
127                 delta_lagIndex = delta_lagIndex + MAX_DELTA_LAG;\r
128                 encode_absolute_lagIndex = 0; /* Only use delta */\r
129             }\r
130             SKP_Silk_range_encoder( psRC, delta_lagIndex, SKP_Silk_pitch_delta_CDF );\r
131         }\r
132         if( encode_absolute_lagIndex ) {\r
133             /* Absolute encoding */\r
134             if( psEncC->fs_kHz == 8 ) {\r
135                 SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_NB_CDF );\r
136             } else if( psEncC->fs_kHz == 12 ) {\r
137                 SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_MB_CDF );\r
138             } else if( psEncC->fs_kHz == 16 ) {\r
139                 SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_WB_CDF );\r
140             } else {\r
141                 SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_SWB_CDF );\r
142             }\r
143         }\r
144         psEncC->prev_lagIndex = psEncCtrlC->lagIndex;\r
145 \r
146 \r
147         /* countour index */\r
148         if( psEncC->fs_kHz == 8 ) {\r
149             /* Less codevectors used in 8 khz mode */\r
150             SKP_Silk_range_encoder( psRC, psEncCtrlC->contourIndex, SKP_Silk_pitch_contour_NB_CDF );\r
151         } else {\r
152             /* Joint for 12, 16, 24 khz */\r
153             SKP_Silk_range_encoder( psRC, psEncCtrlC->contourIndex, SKP_Silk_pitch_contour_CDF );\r
154         }\r
155 \r
156         /********************/\r
157         /* Encode LTP gains */\r
158         /********************/\r
159 \r
160         /* PERIndex value */\r
161         SKP_Silk_range_encoder( psRC, psEncCtrlC->PERIndex, SKP_Silk_LTP_per_index_CDF );\r
162 \r
163         /* Codebook Indices */\r
164         for( k = 0; k < NB_SUBFR; k++ ) {\r
165             SKP_Silk_range_encoder( psRC, psEncCtrlC->LTPIndex[ k ], SKP_Silk_LTP_gain_CDF_ptrs[ psEncCtrlC->PERIndex ] );\r
166         }\r
167 \r
168         /**********************/\r
169         /* Encode LTP scaling */\r
170         /**********************/\r
171         SKP_Silk_range_encoder( psRC, psEncCtrlC->LTP_scaleIndex, SKP_Silk_LTPscale_CDF );\r
172     }\r
173 \r
174 \r
175     /***************/\r
176     /* Encode seed */\r
177     /***************/\r
178     SKP_Silk_range_encoder( psRC, psEncCtrlC->Seed, SKP_Silk_Seed_CDF );\r
179 }\r