Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_encode_parameters.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(\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     const SKP_int                   *q              /* I    Quantization indices            */\r
38 )\r
39 {\r
40     SKP_int   i, k, typeOffset;\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 signal type and quantizer offset */\r
65     /*******************************************/\r
66     typeOffset = 2 * psEncCtrlC->sigtype + psEncCtrlC->QuantOffsetType;\r
67     if( psEncC->nFramesInPayloadBuf == 0 ) {\r
68         /* first frame in packet: independent coding */\r
69         SKP_Silk_range_encoder( psRC, typeOffset, SKP_Silk_type_offset_CDF );\r
70     } else {\r
71         /* condidtional coding */\r
72         SKP_Silk_range_encoder( psRC, typeOffset, SKP_Silk_type_offset_joint_CDF[ psEncC->typeOffsetPrev ] );\r
73     }\r
74     psEncC->typeOffsetPrev = typeOffset;\r
75 \r
76     /****************/\r
77     /* Encode gains */\r
78     /****************/\r
79     /* first subframe */\r
80     if( psEncC->nFramesInPayloadBuf == 0 ) {\r
81         /* first frame in packet: independent coding */\r
82         SKP_Silk_range_encoder( psRC, psEncCtrlC->GainsIndices[ 0 ], SKP_Silk_gain_CDF[ psEncCtrlC->sigtype ] );\r
83     } else {\r
84         /* condidtional coding */\r
85         SKP_Silk_range_encoder( psRC, psEncCtrlC->GainsIndices[ 0 ], SKP_Silk_delta_gain_CDF );\r
86     }\r
87 \r
88     /* remaining subframes */\r
89     for( i = 1; i < NB_SUBFR; i++ ) {\r
90         SKP_Silk_range_encoder( psRC, psEncCtrlC->GainsIndices[ i ], SKP_Silk_delta_gain_CDF );\r
91     }\r
92 \r
93 \r
94     /****************/\r
95     /* Encode NLSFs */\r
96     /****************/\r
97     /* Range encoding of the NLSF path */\r
98     psNLSF_CB = psEncC->psNLSF_CB[ psEncCtrlC->sigtype ];\r
99     SKP_Silk_range_encoder_multi( psRC, psEncCtrlC->NLSFIndices, psNLSF_CB->StartPtr, psNLSF_CB->nStages );\r
100 \r
101     /* Encode NLSF interpolation factor */\r
102     SKP_assert( psEncC->useInterpolatedNLSFs == 1 || psEncCtrlC->NLSFInterpCoef_Q2 == ( 1 << 2 ) );\r
103     SKP_Silk_range_encoder( psRC, psEncCtrlC->NLSFInterpCoef_Q2, SKP_Silk_NLSF_interpolation_factor_CDF );\r
104 \r
105 \r
106     if( psEncCtrlC->sigtype == SIG_TYPE_VOICED ) {\r
107         /*********************/\r
108         /* Encode pitch lags */\r
109         /*********************/\r
110 \r
111 \r
112         /* lag index */\r
113         if( psEncC->fs_kHz == 8 ) {\r
114             SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_NB_CDF );\r
115         } else if( psEncC->fs_kHz == 12 ) {\r
116             SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_MB_CDF );\r
117         } else if( psEncC->fs_kHz == 16 ) {\r
118             SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_WB_CDF );\r
119         } else {\r
120             SKP_Silk_range_encoder( psRC, psEncCtrlC->lagIndex, SKP_Silk_pitch_lag_SWB_CDF );\r
121         }\r
122 \r
123 \r
124         /* countour index */\r
125         if( psEncC->fs_kHz == 8 ) {\r
126             /* Less codevectors used in 8 khz mode */\r
127             SKP_Silk_range_encoder( psRC, psEncCtrlC->contourIndex, SKP_Silk_pitch_contour_NB_CDF );\r
128         } else {\r
129             /* Joint for 12, 16, 24 khz */\r
130             SKP_Silk_range_encoder( psRC, psEncCtrlC->contourIndex, SKP_Silk_pitch_contour_CDF );\r
131         }\r
132 \r
133         /********************/\r
134         /* Encode LTP gains */\r
135         /********************/\r
136 \r
137         /* PERIndex value */\r
138         SKP_Silk_range_encoder( psRC, psEncCtrlC->PERIndex, SKP_Silk_LTP_per_index_CDF );\r
139 \r
140         /* Codebook Indices */\r
141         for( k = 0; k < NB_SUBFR; k++ ) {\r
142             SKP_Silk_range_encoder( psRC, psEncCtrlC->LTPIndex[ k ], SKP_Silk_LTP_gain_CDF_ptrs[ psEncCtrlC->PERIndex ] );\r
143         }\r
144 \r
145         /**********************/\r
146         /* Encode LTP scaling */\r
147         /**********************/\r
148         SKP_Silk_range_encoder( psRC, psEncCtrlC->LTP_scaleIndex, SKP_Silk_LTPscale_CDF );\r
149     }\r
150 \r
151 \r
152     /***************/\r
153     /* Encode seed */\r
154     /***************/\r
155     SKP_Silk_range_encoder( psRC, psEncCtrlC->Seed, SKP_Silk_Seed_CDF );\r
156 \r
157     /*********************************************/\r
158     /* Encode quantization indices of excitation */\r
159     /*********************************************/\r
160     SKP_Silk_encode_pulses( psRC, psEncCtrlC->sigtype, psEncCtrlC->QuantOffsetType, q, psEncC->frame_length );\r
161 \r
162 \r
163     /*********************************************/\r
164     /* Encode VAD flag                           */\r
165     /*********************************************/\r
166     SKP_Silk_range_encoder( psRC, psEncC->vadFlag, SKP_Silk_vadflag_CDF );\r
167 }\r