Fixing DTX for fixed-point too, updating project files
[opus.git] / test / Encoder.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 /*****************************/\r
30 /* Silk encoder test program */\r
31 /*****************************/\r
32 \r
33 #ifdef _WIN32\r
34 #define _CRT_SECURE_NO_DEPRECATE    1\r
35 #endif\r
36 \r
37 #include <stdio.h>\r
38 #include <stdlib.h>\r
39 #include <string.h>\r
40 #include <math.h>\r
41 \r
42 #ifdef HAVE_CONFIG_H\r
43 #include "config.h"\r
44 #endif \r
45 \r
46 #include "SKP_Silk_SDK_API.h"\r
47 #include "../src_SigProc_FIX/SKP_Silk_SigProc_FIX.h"\r
48 \r
49 /* Define codec specific settings */\r
50 #define MAX_BYTES_PER_FRAME     250 // Equals peak bitrate of 100 kbps \r
51 #define MAX_INPUT_FRAMES        5\r
52 #define MAX_LBRR_DELAY          2\r
53 #define MAX_FRAME_LENGTH        320\r
54 #define MAX_FRAME_LENGTH_MS     20\r
55 #define MAX_API_FS_KHZ          48\r
56 \r
57 #ifdef SKP_MACRO_COUNT\r
58     varDefine /* Define and reset global counters */\r
59 #endif\r
60 \r
61 #ifdef _SYSTEM_IS_BIG_ENDIAN\r
62 /* Function to convert a little endian int16 to a */\r
63 /* big endian int16 or vica verca                 */\r
64 void swap_endian(\r
65     SKP_int16       vec[],              /*  I/O array of */\r
66     SKP_int         len                 /*  I   length      */\r
67 )\r
68 {\r
69     SKP_int i;\r
70     SKP_int16 tmp;\r
71     SKP_uint8 *p1, *p2;\r
72 \r
73     for( i = 0; i < len; i++ ){\r
74         tmp = vec[ i ];\r
75         p1 = (SKP_uint8 *)&vec[ i ]; p2 = (SKP_uint8 *)&tmp;\r
76         p1[ 0 ] = p2[ 1 ]; p1[ 1 ] = p2[ 0 ];\r
77     }\r
78 }\r
79 #endif\r
80 \r
81 static void print_usage( char* argv[] ) {\r
82     printf( "\nusage: %s in.pcm out.bit [settings]\n", argv[ 0 ] );\r
83     printf( "\nin.pcm               : Speech input to encoder" );\r
84     printf( "\nout.bit              : Bitstream output from encoder" );\r
85     printf( "\n   settings:" );\r
86     printf( "\n-Fs_API <Hz>         : API sampling rate in Hz, default: 16000" );\r
87     printf( "\n-Fs_maxInternal <Hz> : Maximum internal sampling rate in Hz, default: 16000" ); \r
88     printf( "\n-packetlength <ms>   : Packet interval in ms, default: 20" );\r
89     printf( "\n-rate <bps>          : Target bitrate; default: 25000" );\r
90     printf( "\n-loss <perc>         : Uplink loss estimate, in percent (0-100); default: 0" );\r
91     printf( "\n-inbandFEC <flag>    : Enable inband FEC usage (0/1); default: 0" );\r
92     printf( "\n-complexity <comp>   : Set complexity, 0: low, 1: medium, 2: high; default: 2" );\r
93     printf( "\n-DTX <flag>          : Enable DTX (0/1); default: 0" );\r
94     printf( "\n-quiet               : Print only some basic values" );\r
95     printf( "\n");\r
96 }\r
97 \r
98 int main( int argc, char* argv[] )\r
99 {\r
100     double    filetime;\r
101     size_t    counter;\r
102     SKP_int32 k, args, totPackets, totActPackets, ret, nBytes;\r
103     double    sumBytes, sumActBytes, avg_rate, act_rate, nrg;\r
104     SKP_int16 in[ MAX_FRAME_LENGTH_MS * MAX_API_FS_KHZ * MAX_INPUT_FRAMES ];\r
105     char      speechInFileName[ 150 ], bitOutFileName[ 150 ];\r
106     FILE      *bitOutFile, *speechInFile;\r
107     SKP_int32 encSizeBytes;\r
108     void      *psEnc;\r
109 #ifdef SKP_MACRO_COUNT\r
110     SKP_int64  Ops, maxOps = 0, totOps = 0;\r
111 #endif\r
112 #ifdef _SYSTEM_IS_BIG_ENDIAN\r
113     SKP_int16 nBytes_LE;\r
114 #endif\r
115     SKP_uint8      range_buf[ MAX_BYTES_PER_FRAME * MAX_INPUT_FRAMES ];\r
116     ec_enc         range_enc_celt_state;\r
117 \r
118     /* default settings */\r
119     SKP_int32 API_fs_Hz = 16000;\r
120     SKP_int32 max_internal_fs_Hz = 16000;\r
121     SKP_int32 min_internal_fs_Hz = 8000;\r
122     SKP_int32 targetRate_bps = 25000;\r
123     SKP_int32 packetSize_ms = 20;\r
124     SKP_int32 frameSizeReadFromFile_ms = 10;\r
125     SKP_int32 packetLoss_perc = 0, complexity_mode = 2, smplsSinceLastPacket;\r
126     SKP_int32 INBandFEC_enabled = 0, DTX_enabled = 0, quiet = 0;\r
127     SKP_SILK_SDK_EncControlStruct encControl; // Struct for input to encoder\r
128 \r
129         \r
130     if( argc < 3 ) {\r
131         print_usage( argv );\r
132         exit( 0 );\r
133     } \r
134     \r
135     /* get arguments */\r
136     args = 1;\r
137     strcpy( speechInFileName, argv[ args ] );\r
138     args++;\r
139     strcpy( bitOutFileName,   argv[ args ] );\r
140     args++;\r
141     while( args < argc ) {\r
142         if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-Fs_API" ) == 0 ) {\r
143             sscanf( argv[ args + 1 ], "%d", &API_fs_Hz );\r
144             args += 2;\r
145         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-Fs_maxInternal" ) == 0 ) {\r
146             sscanf( argv[ args + 1 ], "%d", &max_internal_fs_Hz );\r
147             args += 2;\r
148         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-packetlength" ) == 0 ) {\r
149             sscanf( argv[ args + 1 ], "%d", &packetSize_ms );\r
150             args += 2;\r
151         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-rate" ) == 0 ) {\r
152             sscanf( argv[ args + 1 ], "%d", &targetRate_bps );\r
153             args += 2;\r
154         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-loss" ) == 0 ) {\r
155             sscanf( argv[ args + 1 ], "%d", &packetLoss_perc );\r
156             args += 2;\r
157         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-complexity" ) == 0 ) {\r
158             sscanf( argv[ args + 1 ], "%d", &complexity_mode );\r
159             args += 2;\r
160         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-inbandFEC" ) == 0 ) {\r
161             sscanf( argv[ args + 1 ], "%d", &INBandFEC_enabled );\r
162             args += 2;\r
163         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-DTX") == 0 ) {\r
164             sscanf( argv[ args + 1 ], "%d", &DTX_enabled );\r
165             args += 2;\r
166         } else if( SKP_STR_CASEINSENSITIVE_COMPARE( argv[ args ], "-quiet" ) == 0 ) {\r
167             quiet = 1;\r
168             args++;\r
169         } else {\r
170             printf( "Error: unrecognized setting: %s\n\n", argv[ args ] );\r
171             print_usage( argv );\r
172             exit( 0 );\r
173         }\r
174     }\r
175 \r
176     /* If no max internal set set to API fs */\r
177     if( max_internal_fs_Hz == 0 ) {\r
178         max_internal_fs_Hz = API_fs_Hz;\r
179     }\r
180 \r
181     /* Print options */\r
182     if( !quiet ) {\r
183         printf("******************* Compiled for %d bit cpu ********* \n", (int)sizeof(void*) * 8 );\r
184         printf( "Input:                          %s\n",     speechInFileName );\r
185         printf( "Output:                         %s\n",     bitOutFileName );\r
186         printf( "API sampling rate:              %d Hz\n",  API_fs_Hz );\r
187         printf( "Maximum internal sampling rate: %d Hz\n",  max_internal_fs_Hz );\r
188         printf( "Packet interval:                %d ms\n",  packetSize_ms );\r
189         printf( "Inband FEC used:                %d\n",     INBandFEC_enabled );\r
190         printf( "DTX used:                       %d\n",     DTX_enabled );\r
191         printf( "Complexity:                     %d\n",     complexity_mode );\r
192         printf( "Target bitrate:                 %d bps\n", targetRate_bps );\r
193     }\r
194 \r
195     /* Open files */\r
196     speechInFile = fopen( speechInFileName, "rb" );\r
197     if( speechInFile == NULL ) {\r
198         printf( "Error: could not open input file %s\n", speechInFileName );\r
199         exit( 0 );\r
200     }\r
201     bitOutFile = fopen( bitOutFileName, "wb" );\r
202     if( bitOutFile == NULL ) {\r
203         printf( "Error: could not open output file %s\n", bitOutFileName );\r
204         exit( 0 );\r
205     }\r
206 \r
207     /* Create Encoder */\r
208     ret = SKP_Silk_SDK_Get_Encoder_Size( &encSizeBytes );\r
209     if( ret ) {\r
210         printf( "\nSKP_Silk_create_encoder returned %d", ret );\r
211     }\r
212 \r
213     psEnc = malloc( encSizeBytes );\r
214 \r
215     /* Reset Encoder */\r
216     ret = SKP_Silk_SDK_InitEncoder( psEnc, &encControl );\r
217     if( ret ) {\r
218         printf( "\nSKP_Silk_reset_encoder returned %d", ret );\r
219     }\r
220     \r
221     /* Set Encoder parameters */\r
222     encControl.API_sampleRate        = API_fs_Hz;\r
223     encControl.maxInternalSampleRate = max_internal_fs_Hz;\r
224     encControl.minInternalSampleRate = min_internal_fs_Hz;\r
225     encControl.payloadSize_ms        = packetSize_ms;\r
226     encControl.packetLossPercentage  = packetLoss_perc;\r
227     encControl.useInBandFEC          = INBandFEC_enabled;\r
228     encControl.useDTX                = DTX_enabled;\r
229     encControl.complexity            = complexity_mode;\r
230     encControl.bitRate               = ( targetRate_bps > 0 ? targetRate_bps : 0 );\r
231 \r
232     if( API_fs_Hz > MAX_API_FS_KHZ * 1000 || API_fs_Hz < 0 ) {\r
233         printf( "\nError: API sampling rate = %d out of range, valid range 8000 - 48000 \n \n", API_fs_Hz );\r
234         exit( 0 );\r
235     }\r
236 \r
237     totPackets           = 0;\r
238     totActPackets        = 0;\r
239     smplsSinceLastPacket = 0;\r
240     sumBytes             = 0.0;\r
241     sumActBytes          = 0.0;\r
242     \r
243     while( 1 ) {\r
244         if( smplsSinceLastPacket == 0 ) {\r
245             /* Init range coder */\r
246             ec_enc_init( &range_enc_celt_state, range_buf, MAX_BYTES_PER_FRAME * MAX_INPUT_FRAMES );\r
247         }\r
248 \r
249         /* Read input from file */\r
250         counter = fread( in, sizeof( SKP_int16 ), ( frameSizeReadFromFile_ms * API_fs_Hz ) / 1000, speechInFile );\r
251 #ifdef _SYSTEM_IS_BIG_ENDIAN\r
252         swap_endian( in, counter );\r
253 #endif\r
254         if( (SKP_int)counter < ( ( frameSizeReadFromFile_ms * API_fs_Hz ) / 1000 ) ) {\r
255             break;\r
256         }\r
257 \r
258         /* max payload size */\r
259         nBytes = MAX_BYTES_PER_FRAME * MAX_INPUT_FRAMES;\r
260 \r
261         /* Silk Encoder */\r
262         ret = SKP_Silk_SDK_Encode( psEnc, &encControl, in, (SKP_int16)counter, &range_enc_celt_state, &nBytes, 0 );\r
263         if( ret ) {\r
264             printf( "\nSKP_Silk_Encode returned %d", ret );\r
265             break;\r
266         }\r
267 \r
268 #ifdef SKP_MACRO_COUNT\r
269         Ops = SKP_SaveResetCount();\r
270         if( Ops > maxOps ){ maxOps = Ops; }\r
271         totOps += Ops;\r
272 #endif\r
273 \r
274         /* Get packet size */\r
275         packetSize_ms = encControl.payloadSize_ms;\r
276 \r
277         smplsSinceLastPacket += ( SKP_int )counter;\r
278         \r
279         if( ( ( 1000 * smplsSinceLastPacket ) / API_fs_Hz ) == packetSize_ms ) {\r
280             \r
281             /* Finish up the range coder */\r
282             ec_enc_done( &range_enc_celt_state );\r
283             \r
284             /* Sends a dummy zero size packet in case of DTX period  */\r
285             /* to make it work with the decoder test program.        */\r
286             /* In practice should be handled by RTP sequence numbers */\r
287             totPackets++;\r
288             sumBytes += nBytes;\r
289             nrg = 0.0;\r
290             for( k = 0; k < ( SKP_int )counter; k++ ) {\r
291                 nrg += in[ k ] * (double)in[ k ];\r
292             }\r
293             if( ( nrg / ( SKP_int )counter ) > 1e3 ) {\r
294                 sumActBytes += nBytes;\r
295                 totActPackets++;\r
296             }\r
297 \r
298             /* Write payload size */\r
299 #ifdef _SYSTEM_IS_BIG_ENDIAN\r
300             nBytes_LE = nBytes;\r
301             swap_endian( &nBytes_LE, 1 );\r
302             fwrite( &nBytes_LE, sizeof( SKP_int16 ), 1, bitOutFile );\r
303 #else\r
304             fwrite( &nBytes, sizeof( SKP_int32 ), 1, bitOutFile );\r
305 #endif\r
306 \r
307             /* Write payload */\r
308             fwrite( range_buf, sizeof( SKP_uint8 ), nBytes, bitOutFile );\r
309         \r
310             if( !quiet && totPackets % 100 == 0 ) {\r
311                 fprintf( stderr, "\rPackets encoded:              %d", totPackets );\r
312             }\r
313             smplsSinceLastPacket = 0;\r
314         }\r
315     }\r
316 \r
317     /* Write dummy because it can not end with 0 bytes */\r
318     nBytes = -1;\r
319 \r
320     /* Write payload size */\r
321     fwrite( &nBytes, sizeof( SKP_int32 ), 1, bitOutFile );\r
322 \r
323     /* Free Encoder */\r
324     free( psEnc );\r
325 \r
326     fclose( speechInFile );\r
327     fclose( bitOutFile   );\r
328 \r
329     filetime  = totPackets * 1e-3 * packetSize_ms;\r
330     avg_rate  = 8.0 / packetSize_ms * sumBytes       / totPackets;\r
331     act_rate  = 8.0 / packetSize_ms * sumActBytes    / totActPackets;\r
332     if( !quiet ) {\r
333         printf( "\nFile length:                 %.3f s", filetime );\r
334         printf( "\nAverage bitrate:             %.3f kbps", avg_rate  );\r
335         printf( "\nActive bitrate:              %.3f kbps", act_rate  );\r
336 #ifdef SKP_MACRO_COUNT\r
337         printf( "\n \nWMOPS calculation");\r
338         printf( "\nMean:                        %.3f WMOPS", (float)totOps / ((float)packetSize_ms * (float)totPackets * 1e3));\r
339         printf( "\nMax:                         %.3f WMOPS", (float)maxOps / ((float)packetSize_ms * 1e3));\r
340 #endif\r
341         printf( "\n\n" );\r
342     } else {\r
343         /* print average and active bitrates */\r
344         printf( "%.3f %.3f ", avg_rate, act_rate );\r
345 #ifdef SKP_MACRO_COUNT\r
346         /* print average and max WMOPS */\r
347         printf( "%.3f %.3f \n", (float)totOps / ((float)packetSize_ms * (float)totPackets * 1e3), \r
348             (float)maxOps / ((float)packetSize_ms * 1e3));\r
349 #else\r
350         printf( "%.3f %.3f \n", 0, 0);\r
351 #endif\r
352     }\r
353 \r
354     return 0;\r
355 }\r