Update SILK code using the CELT range coder
[opus.git] / src_common / SKP_Silk_enc_API.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 \r
29 #include "SKP_Silk_define.h"\r
30 #include "SKP_Silk_SDK_API.h"\r
31 #include "SKP_Silk_control.h"\r
32 #include "SKP_Silk_typedef.h"\r
33 #include "SKP_Silk_structs.h"\r
34 #if FIXED_POINT\r
35 #include "SKP_Silk_main_FIX.h"\r
36 #define SKP_Silk_encoder_state_Fxx      SKP_Silk_encoder_state_FIX\r
37 #define SKP_Silk_init_encoder_Fxx       SKP_Silk_init_encoder_FIX\r
38 #define SKP_Silk_control_encoder_Fxx    SKP_Silk_control_encoder_FIX\r
39 #define SKP_Silk_encode_frame_Fxx       SKP_Silk_encode_frame_FIX\r
40 #else\r
41 #include "SKP_Silk_main_FLP.h"\r
42 #define SKP_Silk_encoder_state_Fxx      SKP_Silk_encoder_state_FLP\r
43 #define SKP_Silk_init_encoder_Fxx       SKP_Silk_init_encoder_FLP\r
44 #define SKP_Silk_control_encoder_Fxx    SKP_Silk_control_encoder_FLP\r
45 #define SKP_Silk_encode_frame_Fxx       SKP_Silk_encode_frame_FLP\r
46 #endif\r
47 #define SKP_Silk_EncodeControlStruct SKP_SILK_SDK_EncControlStruct\r
48 \r
49 \r
50 /****************************************/\r
51 /* Encoder functions                    */\r
52 /****************************************/\r
53 \r
54 SKP_int SKP_Silk_SDK_Get_Encoder_Size( SKP_int32 *encSizeBytes )\r
55 {\r
56     SKP_int ret = SKP_SILK_NO_ERROR;\r
57     \r
58     *encSizeBytes = sizeof( SKP_Silk_encoder_state_Fxx );\r
59     \r
60     return ret;\r
61 }\r
62 \r
63 \r
64 /***************************************/\r
65 /* Read control structure from encoder */\r
66 /***************************************/\r
67 SKP_int SKP_Silk_SDK_QueryEncoder(\r
68     const void *encState,                       /* I:   State Vector                                    */\r
69     SKP_Silk_EncodeControlStruct *encStatus     /* O:   Control Structure                               */\r
70 )\r
71 {\r
72     SKP_Silk_encoder_state_Fxx *psEnc;\r
73     SKP_int ret = SKP_SILK_NO_ERROR;    \r
74 \r
75     psEnc = ( SKP_Silk_encoder_state_Fxx* )encState;\r
76 \r
77     encStatus->API_sampleRate        = psEnc->sCmn.API_fs_Hz;\r
78     encStatus->maxInternalSampleRate = SKP_SMULBB( psEnc->sCmn.maxInternal_fs_kHz, 1000 );\r
79     encStatus->packetSize            = ( SKP_int )SKP_DIV32_16( psEnc->sCmn.API_fs_Hz * psEnc->sCmn.PacketSize_ms, 1000 );  /* convert samples -> ms */\r
80     encStatus->bitRate               = psEnc->sCmn.TargetRate_bps;\r
81     encStatus->packetLossPercentage  = psEnc->sCmn.PacketLoss_perc;\r
82     encStatus->complexity            = psEnc->sCmn.Complexity;\r
83     encStatus->useInBandFEC          = psEnc->sCmn.useInBandFEC;\r
84     encStatus->useDTX                = psEnc->sCmn.useDTX;\r
85     return ret;\r
86 }\r
87 \r
88 /*************************/\r
89 /* Init or Reset encoder */\r
90 /*************************/\r
91 SKP_int SKP_Silk_SDK_InitEncoder(\r
92     void                            *encState,          /* I/O: State                                           */\r
93     SKP_Silk_EncodeControlStruct    *encStatus          /* O:   Control structure                               */\r
94 )\r
95 {\r
96     SKP_Silk_encoder_state_Fxx *psEnc;\r
97     SKP_int ret = SKP_SILK_NO_ERROR;\r
98 \r
99         \r
100     psEnc = ( SKP_Silk_encoder_state_Fxx* )encState;\r
101 \r
102     /* Reset Encoder */\r
103     if( ret += SKP_Silk_init_encoder_Fxx( psEnc ) ) {\r
104         SKP_assert( 0 );\r
105     }\r
106 \r
107     /* Read control structure */\r
108     if( ret += SKP_Silk_SDK_QueryEncoder( encState, encStatus ) ) {\r
109         SKP_assert( 0 );\r
110     }\r
111 \r
112 \r
113     return ret;\r
114 }\r
115 \r
116 /**************************/\r
117 /* Encode frame with Silk */\r
118 /**************************/\r
119 SKP_int SKP_Silk_SDK_Encode( \r
120     void                                *encState,      /* I/O: State                                           */\r
121     const SKP_Silk_EncodeControlStruct  *encControl,    /* I:   Control structure                               */\r
122     const SKP_int16                     *samplesIn,     /* I:   Speech sample input vector                      */\r
123     SKP_int                             nSamplesIn,     /* I:   Number of samples in input vector               */\r
124     SKP_uint8                           *outData,       /* O:   Encoded output vector                           */\r
125     SKP_int16                           *nBytesOut      /* I/O: Number of bytes in outData (input: Max bytes)   */\r
126 )\r
127 {\r
128     SKP_int   max_internal_fs_kHz, PacketSize_ms, PacketLoss_perc, UseInBandFEC, UseDTX, ret = SKP_SILK_NO_ERROR;\r
129     SKP_int   nSamplesToBuffer, Complexity, input_ms, nSamplesFromInput = 0;\r
130     SKP_int32 TargetRate_bps, API_fs_Hz;\r
131     SKP_int16 MaxBytesOut;\r
132     SKP_Silk_encoder_state_Fxx *psEnc = ( SKP_Silk_encoder_state_Fxx* )encState;\r
133 \r
134     SKP_assert( encControl != NULL );\r
135 \r
136     /* Check sampling frequency first, to avoid divide by zero later */\r
137     if( ( ( encControl->API_sampleRate        !=  8000 ) &&\r
138           ( encControl->API_sampleRate        != 12000 ) &&\r
139           ( encControl->API_sampleRate        != 16000 ) &&\r
140           ( encControl->API_sampleRate        != 24000 ) && \r
141           ( encControl->API_sampleRate        != 32000 ) &&\r
142           ( encControl->API_sampleRate        != 44100 ) &&\r
143           ( encControl->API_sampleRate        != 48000 ) ) ||\r
144         ( ( encControl->maxInternalSampleRate !=  8000 ) &&\r
145           ( encControl->maxInternalSampleRate != 12000 ) &&\r
146           ( encControl->maxInternalSampleRate != 16000 ) &&\r
147           ( encControl->maxInternalSampleRate != 24000 ) ) ) {\r
148         ret = SKP_SILK_ENC_FS_NOT_SUPPORTED;\r
149         SKP_assert( 0 );\r
150         return( ret );\r
151     }\r
152 \r
153     /* Set encoder parameters from control structure */\r
154     API_fs_Hz           =                              encControl->API_sampleRate;\r
155     max_internal_fs_kHz = SKP_DIV32_16(     ( SKP_int )encControl->maxInternalSampleRate, 1000 );   /* convert Hz -> kHz */\r
156     PacketSize_ms       = SKP_DIV32( 1000 * ( SKP_int )encControl->packetSize, API_fs_Hz );\r
157     TargetRate_bps      =                 ( SKP_int32 )encControl->bitRate;\r
158     PacketLoss_perc     =                   ( SKP_int )encControl->packetLossPercentage;\r
159     UseInBandFEC        =                   ( SKP_int )encControl->useInBandFEC;\r
160     Complexity          =                   ( SKP_int )encControl->complexity;\r
161     UseDTX              =                   ( SKP_int )encControl->useDTX;\r
162     /* Save values in state */\r
163     psEnc->sCmn.API_fs_Hz          = API_fs_Hz;\r
164     psEnc->sCmn.maxInternal_fs_kHz = max_internal_fs_kHz;\r
165     psEnc->sCmn.useInBandFEC       = UseInBandFEC;\r
166 \r
167     /* Only accept input lengths that are a multiplum of 10 ms */\r
168     input_ms = SKP_DIV32( 1000 * nSamplesIn, API_fs_Hz );\r
169     if( ( input_ms % 10) != 0 || nSamplesIn < 0 ) {\r
170         ret = SKP_SILK_ENC_INPUT_INVALID_NO_OF_SAMPLES;\r
171         SKP_assert( 0 );\r
172         return( ret );\r
173     }\r
174 \r
175     /* Make sure no more than one packet can be produced */\r
176     if( nSamplesIn > SKP_DIV32_16( psEnc->sCmn.PacketSize_ms * API_fs_Hz, 1000 ) ) {\r
177         ret = SKP_SILK_ENC_INPUT_INVALID_NO_OF_SAMPLES;\r
178         SKP_assert( 0 );\r
179         return( ret );\r
180     }\r
181     if( ( ret = SKP_Silk_control_encoder_Fxx( psEnc, API_fs_Hz, max_internal_fs_kHz, PacketSize_ms, TargetRate_bps, \r
182                     PacketLoss_perc, UseInBandFEC, UseDTX, input_ms, Complexity) ) != 0 ) {\r
183         SKP_assert( 0 );\r
184         return( ret );\r
185     }\r
186 \r
187     /* Detect energy above 8 kHz */\r
188     if( SKP_min( API_fs_Hz, 1000 * max_internal_fs_kHz ) == 24000 && psEnc->sCmn.sSWBdetect.SWB_detected == 0 && psEnc->sCmn.sSWBdetect.WB_detected == 0 ) {\r
189         SKP_Silk_detect_SWB_input( &psEnc->sCmn.sSWBdetect, samplesIn, ( SKP_int )nSamplesIn );\r
190     }\r
191 \r
192     /* Input buffering/resampling and encoding */\r
193     MaxBytesOut = 0;                    /* return 0 output bytes if no encoder called */\r
194     while( 1 ) {\r
195         nSamplesToBuffer = psEnc->sCmn.frame_length - psEnc->sCmn.inputBufIx;\r
196         if( API_fs_Hz == SKP_SMULBB( 1000, psEnc->sCmn.fs_kHz ) ) { \r
197             nSamplesToBuffer  = SKP_min_int( nSamplesToBuffer, nSamplesIn );\r
198             nSamplesFromInput = nSamplesToBuffer;\r
199             /* Copy to buffer */\r
200             SKP_memcpy( &psEnc->sCmn.inputBuf[ psEnc->sCmn.inputBufIx ], samplesIn, nSamplesFromInput * sizeof( SKP_int16 ) );\r
201         } else {  \r
202             nSamplesToBuffer  = SKP_min( nSamplesToBuffer, SKP_DIV32( ( SKP_int32 )nSamplesIn * psEnc->sCmn.fs_kHz * 1000, API_fs_Hz ) );\r
203             nSamplesFromInput = SKP_DIV32_16( nSamplesToBuffer * API_fs_Hz, psEnc->sCmn.fs_kHz * 1000 );\r
204             /* Resample and write to buffer */\r
205             ret += SKP_Silk_resampler( &psEnc->sCmn.resampler_state, &psEnc->sCmn.inputBuf[ psEnc->sCmn.inputBufIx ], samplesIn, nSamplesFromInput );\r
206         } \r
207         samplesIn              += nSamplesFromInput;\r
208         nSamplesIn             -= nSamplesFromInput;\r
209         psEnc->sCmn.inputBufIx += nSamplesToBuffer;\r
210 \r
211         /* Silk encoder */\r
212         if( psEnc->sCmn.inputBufIx >= psEnc->sCmn.frame_length ) {\r
213             /* Enough data in input buffer, so encode */\r
214             if( MaxBytesOut == 0 ) {\r
215                 /* No payload obtained so far */\r
216                 MaxBytesOut = *nBytesOut;\r
217                 if( ( ret = SKP_Silk_encode_frame_Fxx( psEnc, outData, &MaxBytesOut, psEnc->sCmn.inputBuf ) ) != 0 ) {\r
218                     SKP_assert( 0 );\r
219                 }\r
220             } else {\r
221                 /* outData already contains a payload */\r
222                 if( ( ret = SKP_Silk_encode_frame_Fxx( psEnc, outData, nBytesOut, psEnc->sCmn.inputBuf ) ) != 0 ) {\r
223                     SKP_assert( 0 );\r
224                 }\r
225                 /* Check that no second payload was created */\r
226                 SKP_assert( *nBytesOut == 0 );\r
227             }\r
228             psEnc->sCmn.inputBufIx = 0;\r
229         } else {\r
230             break;\r
231         }\r
232     }\r
233 \r
234     *nBytesOut = MaxBytesOut;\r
235     if( psEnc->sCmn.useDTX && psEnc->sCmn.inDTX ) {\r
236         /* DTX simulation */\r
237         *nBytesOut = 0;\r
238     }\r
239 \r
240     return ret;\r
241 }\r
242 \r