SILK update with LBRR and some bugfixes
[opus.git] / src_common / SKP_Silk_enc_API.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, 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->minInternalSampleRate = SKP_SMULBB( psEnc->sCmn.minInternal_fs_kHz, 1000 );\r
80     encStatus->payloadSize_ms        = psEnc->sCmn.PacketSize_ms;\r
81     encStatus->bitRate               = psEnc->sCmn.TargetRate_bps;\r
82     encStatus->packetLossPercentage  = psEnc->sCmn.PacketLoss_perc;\r
83     encStatus->complexity            = psEnc->sCmn.Complexity;\r
84     encStatus->useInBandFEC          = psEnc->sCmn.useInBandFEC;\r
85     encStatus->useDTX                = psEnc->sCmn.useDTX;\r
86     encStatus->useCBR                = psEnc->sCmn.useCBR;\r
87     encStatus->internalSampleRate    = SKP_SMULBB( psEnc->sCmn.fs_kHz, 1000 );\r
88     return ret;\r
89 }\r
90 \r
91 /*************************/\r
92 /* Init or Reset encoder */\r
93 /*************************/\r
94 SKP_int SKP_Silk_SDK_InitEncoder(\r
95     void                            *encState,          /* I/O: State                                           */\r
96     SKP_Silk_EncodeControlStruct    *encStatus          /* O:   Control structure                               */\r
97 )\r
98 {\r
99     SKP_Silk_encoder_state_Fxx *psEnc;\r
100     SKP_int ret = SKP_SILK_NO_ERROR;\r
101 \r
102         \r
103     psEnc = ( SKP_Silk_encoder_state_Fxx* )encState;\r
104 \r
105     /* Reset Encoder */\r
106     if( ret += SKP_Silk_init_encoder_Fxx( psEnc ) ) {\r
107         SKP_assert( 0 );\r
108     }\r
109 \r
110     /* Read control structure */\r
111     if( ret += SKP_Silk_SDK_QueryEncoder( encState, encStatus ) ) {\r
112         SKP_assert( 0 );\r
113     }\r
114 \r
115 \r
116     return ret;\r
117 }\r
118 \r
119 /**************************/\r
120 /* Encode frame with Silk */\r
121 /**************************/\r
122 SKP_int SKP_Silk_SDK_Encode( \r
123     void                                *encState,      /* I/O: State                                           */\r
124     SKP_Silk_EncodeControlStruct        *encControl,    /* I:   Control structure                               */\r
125     const SKP_int16                     *samplesIn,     /* I:   Speech sample input vector                      */\r
126     SKP_int                             nSamplesIn,     /* I:   Number of samples in input vector               */\r
127     ec_enc                              *psRangeEnc,    /* I/O  Compressor data structure                       */\r
128     SKP_int32                           *nBytesOut      /* I/O: Number of bytes in payload (input: Max bytes)   */\r
129 )\r
130 {\r
131     SKP_int   max_internal_fs_kHz, min_internal_fs_kHz, PacketSize_ms, PacketLoss_perc, UseInBandFEC, ret = SKP_SILK_NO_ERROR;\r
132     SKP_int   nSamplesToBuffer, Complexity, input_10ms, nSamplesFromInput = 0;\r
133     SKP_int32 TargetRate_bps, API_fs_Hz;\r
134     SKP_Silk_encoder_state_Fxx *psEnc = ( SKP_Silk_encoder_state_Fxx* )encState;\r
135 \r
136     SKP_assert( encControl != NULL );\r
137 \r
138     /* Check sampling frequency first, to avoid divide by zero later */\r
139     if( ( ( encControl->API_sampleRate        !=  8000 ) &&\r
140           ( encControl->API_sampleRate        != 12000 ) &&\r
141           ( encControl->API_sampleRate        != 16000 ) &&\r
142           ( encControl->API_sampleRate        != 24000 ) && \r
143           ( encControl->API_sampleRate        != 32000 ) &&\r
144           ( encControl->API_sampleRate        != 44100 ) &&\r
145           ( encControl->API_sampleRate        != 48000 ) ) ||\r
146         ( ( encControl->maxInternalSampleRate !=  8000 ) &&\r
147           ( encControl->maxInternalSampleRate != 12000 ) &&\r
148           ( encControl->maxInternalSampleRate != 16000 ) ) ||\r
149         ( ( encControl->minInternalSampleRate !=  8000 ) &&\r
150           ( encControl->minInternalSampleRate != 12000 ) &&\r
151           ( encControl->minInternalSampleRate != 16000 ) ) ||\r
152           ( encControl->minInternalSampleRate > encControl->maxInternalSampleRate ) ) {\r
153         ret = SKP_SILK_ENC_FS_NOT_SUPPORTED;\r
154         SKP_assert( 0 );\r
155         return( ret );\r
156     }\r
157     if( encControl->useDTX < 0 || encControl->useDTX > 1 ) {\r
158         ret = SKP_SILK_ENC_INVALID_DTX_SETTING;\r
159     }\r
160         if( encControl->useCBR < 0 || encControl->useCBR > 1 ) {\r
161         ret = SKP_SILK_ENC_INVALID_DTX_SETTING;\r
162     }\r
163 \r
164 \r
165     /* Set encoder parameters from control structure */\r
166     API_fs_Hz           =            encControl->API_sampleRate;\r
167     max_internal_fs_kHz = (SKP_int)( encControl->maxInternalSampleRate >> 10 ) + 1;   /* convert Hz -> kHz */\r
168     min_internal_fs_kHz = (SKP_int)( encControl->minInternalSampleRate >> 10 ) + 1;   /* convert Hz -> kHz */\r
169     PacketSize_ms       =            encControl->payloadSize_ms;\r
170     TargetRate_bps      =            encControl->bitRate;\r
171     PacketLoss_perc     =            encControl->packetLossPercentage;\r
172     UseInBandFEC        =            encControl->useInBandFEC;\r
173     Complexity          =            encControl->complexity;\r
174     psEnc->sCmn.useDTX  =            encControl->useDTX;\r
175         psEnc->sCmn.useCBR  =                    encControl->useCBR;\r
176 \r
177     /* Save values in state */\r
178     psEnc->sCmn.API_fs_Hz          = API_fs_Hz;\r
179     psEnc->sCmn.maxInternal_fs_kHz = max_internal_fs_kHz;\r
180     psEnc->sCmn.minInternal_fs_kHz = min_internal_fs_kHz;\r
181     psEnc->sCmn.useInBandFEC       = UseInBandFEC;\r
182 \r
183     /* Only accept input lengths that are a multiple of 10 ms */\r
184     input_10ms = SKP_DIV32( 100 * nSamplesIn, API_fs_Hz );\r
185     if( input_10ms * API_fs_Hz != 100 * nSamplesIn || nSamplesIn < 0 ) {\r
186         ret = SKP_SILK_ENC_INPUT_INVALID_NO_OF_SAMPLES;\r
187         SKP_assert( 0 );\r
188         return( ret );\r
189     }\r
190 \r
191     TargetRate_bps = SKP_LIMIT( TargetRate_bps, MIN_TARGET_RATE_BPS, MAX_TARGET_RATE_BPS );\r
192     if( ( ret = SKP_Silk_control_encoder_Fxx( psEnc, PacketSize_ms, TargetRate_bps, \r
193                         PacketLoss_perc, Complexity) ) != 0 ) {\r
194         SKP_assert( 0 );\r
195         return( ret );\r
196     }\r
197 \r
198     encControl->internalSampleRate = SKP_SMULBB( psEnc->sCmn.fs_kHz, 1000 );\r
199     \r
200     /* Make sure no more than one packet can be produced */\r
201     if( 1000 * (SKP_int32)nSamplesIn > psEnc->sCmn.PacketSize_ms * API_fs_Hz ) {\r
202         ret = SKP_SILK_ENC_INPUT_INVALID_NO_OF_SAMPLES;\r
203         SKP_assert( 0 );\r
204         return( ret );\r
205     }\r
206 \r
207     /* Input buffering/resampling and encoding */\r
208     while( 1 ) {\r
209         nSamplesToBuffer = psEnc->sCmn.frame_length - psEnc->sCmn.inputBufIx;\r
210         if( API_fs_Hz == SKP_SMULBB( 1000, psEnc->sCmn.fs_kHz ) ) { \r
211             nSamplesToBuffer  = SKP_min_int( nSamplesToBuffer, nSamplesIn );\r
212             nSamplesFromInput = nSamplesToBuffer;\r
213             /* Copy to buffer */\r
214             SKP_memcpy( &psEnc->sCmn.inputBuf[ psEnc->sCmn.inputBufIx ], samplesIn, nSamplesFromInput * sizeof( SKP_int16 ) );\r
215         } else {  \r
216             nSamplesToBuffer  = SKP_min( nSamplesToBuffer, 10 * input_10ms * psEnc->sCmn.fs_kHz );\r
217             nSamplesFromInput = SKP_DIV32_16( nSamplesToBuffer * API_fs_Hz, psEnc->sCmn.fs_kHz * 1000 );\r
218             /* Resample and write to buffer */\r
219             ret += SKP_Silk_resampler( &psEnc->sCmn.resampler_state, &psEnc->sCmn.inputBuf[ psEnc->sCmn.inputBufIx ], samplesIn, nSamplesFromInput );\r
220         } \r
221         samplesIn              += nSamplesFromInput;\r
222         nSamplesIn             -= nSamplesFromInput;\r
223         psEnc->sCmn.inputBufIx += nSamplesToBuffer;\r
224 \r
225         /* Silk encoder */\r
226         if( psEnc->sCmn.inputBufIx >= psEnc->sCmn.frame_length ) {\r
227             SKP_assert( psEnc->sCmn.inputBufIx == psEnc->sCmn.frame_length );\r
228 \r
229             /* Enough data in input buffer, so encode */\r
230             if( ( ret = SKP_Silk_encode_frame_Fxx( psEnc, nBytesOut, psRangeEnc ) ) != 0 ) {\r
231                 SKP_assert( 0 );\r
232             }\r
233             psEnc->sCmn.inputBufIx = 0;\r
234             psEnc->sCmn.controlled_since_last_payload = 0;\r
235 \r
236             if( nSamplesIn == 0 ) {\r
237                 break;\r
238             }\r
239         } else {\r
240             break;\r
241         }\r
242     }\r
243 \r
244     if( psEnc->sCmn.useDTX && psEnc->sCmn.inDTX ) {\r
245         /* DTX */\r
246         *nBytesOut = 0;\r
247     }\r
248 \r
249     return ret;\r
250 }\r
251 \r