Unifying scaling of fixed-point and float FFT
[opus.git] / celt / dump_modes / dump_modes.c
1 /* Copyright (c) 2008 CSIRO
2    Copyright (c) 2008-2009 Xiph.Org Foundation
3    Written by Jean-Marc Valin */
4 /*
5    Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions
7    are met:
8
9    - Redistributions of source code must retain the above copyright
10    notice, this list of conditions and the following disclaimer.
11
12    - Redistributions in binary form must reproduce the above copyright
13    notice, this list of conditions and the following disclaimer in the
14    documentation and/or other materials provided with the distribution.
15
16    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
20    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include "modes.h"
36 #include "celt.h"
37 #include "rate.h"
38
39 #define INT16 "%d"
40 #define INT32 "%d"
41 #define FLOAT "%#0.8gf"
42
43 #ifdef FIXED_POINT
44 #define WORD16 INT16
45 #define WORD32 INT32
46 #else
47 #define WORD16 FLOAT
48 #define WORD32 FLOAT
49 #endif
50
51 void dump_modes(FILE *file, CELTMode **modes, int nb_modes)
52 {
53    int i, j, k;
54    int mdct_twiddles_size;
55    fprintf(file, "/* The contents of this file was automatically generated by dump_modes.c\n");
56    fprintf(file, "   with arguments:");
57    for (i=0;i<nb_modes;i++)
58    {
59       CELTMode *mode = modes[i];
60       fprintf(file, " %d %d",mode->Fs,mode->shortMdctSize*mode->nbShortMdcts);
61    }
62    fprintf(file, "\n   It contains static definitions for some pre-defined modes. */\n");
63    fprintf(file, "#include \"modes.h\"\n");
64    fprintf(file, "#include \"rate.h\"\n");
65
66    fprintf(file, "\n");
67
68    for (i=0;i<nb_modes;i++)
69    {
70       CELTMode *mode = modes[i];
71       int mdctSize;
72       int standard, framerate;
73
74       mdctSize = mode->shortMdctSize*mode->nbShortMdcts;
75       standard = (mode->Fs == 400*(opus_int32)mode->shortMdctSize);
76       framerate = mode->Fs/mode->shortMdctSize;
77
78       if (!standard)
79       {
80          fprintf(file, "#ifndef DEF_EBANDS%d_%d\n", mode->Fs, mdctSize);
81          fprintf(file, "#define DEF_EBANDS%d_%d\n", mode->Fs, mdctSize);
82          fprintf (file, "static const opus_int16 eBands%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands+2);
83          for (j=0;j<mode->nbEBands+2;j++)
84             fprintf (file, "%d, ", mode->eBands[j]);
85          fprintf (file, "};\n");
86          fprintf(file, "#endif\n");
87          fprintf(file, "\n");
88       }
89
90       fprintf(file, "#ifndef DEF_WINDOW%d\n", mode->overlap);
91       fprintf(file, "#define DEF_WINDOW%d\n", mode->overlap);
92       fprintf (file, "static const opus_val16 window%d[%d] = {\n", mode->overlap, mode->overlap);
93       for (j=0;j<mode->overlap;j++)
94          fprintf (file, WORD16 ",%c", mode->window[j],(j+6)%5==0?'\n':' ');
95       fprintf (file, "};\n");
96       fprintf(file, "#endif\n");
97       fprintf(file, "\n");
98
99       if (!standard)
100       {
101          fprintf(file, "#ifndef DEF_ALLOC_VECTORS%d_%d\n", mode->Fs, mdctSize);
102          fprintf(file, "#define DEF_ALLOC_VECTORS%d_%d\n", mode->Fs, mdctSize);
103          fprintf (file, "static const unsigned char allocVectors%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands*mode->nbAllocVectors);
104          for (j=0;j<mode->nbAllocVectors;j++)
105          {
106             for (k=0;k<mode->nbEBands;k++)
107                fprintf (file, "%2d, ", mode->allocVectors[j*mode->nbEBands+k]);
108             fprintf (file, "\n");
109          }
110          fprintf (file, "};\n");
111          fprintf(file, "#endif\n");
112          fprintf(file, "\n");
113       }
114
115       fprintf(file, "#ifndef DEF_LOGN%d\n", framerate);
116       fprintf(file, "#define DEF_LOGN%d\n", framerate);
117       fprintf (file, "static const opus_int16 logN%d[%d] = {\n", framerate, mode->nbEBands);
118       for (j=0;j<mode->nbEBands;j++)
119          fprintf (file, "%d, ", mode->logN[j]);
120       fprintf (file, "};\n");
121       fprintf(file, "#endif\n");
122       fprintf(file, "\n");
123
124       /* Pulse cache */
125       fprintf(file, "#ifndef DEF_PULSE_CACHE%d\n", mode->Fs/mdctSize);
126       fprintf(file, "#define DEF_PULSE_CACHE%d\n", mode->Fs/mdctSize);
127       fprintf (file, "static const opus_int16 cache_index%d[%d] = {\n", mode->Fs/mdctSize, (mode->maxLM+2)*mode->nbEBands);
128       for (j=0;j<mode->nbEBands*(mode->maxLM+2);j++)
129          fprintf (file, "%d,%c", mode->cache.index[j],(j+16)%15==0?'\n':' ');
130       fprintf (file, "};\n");
131       fprintf (file, "static const unsigned char cache_bits%d[%d] = {\n", mode->Fs/mdctSize, mode->cache.size);
132       for (j=0;j<mode->cache.size;j++)
133          fprintf (file, "%d,%c", mode->cache.bits[j],(j+16)%15==0?'\n':' ');
134       fprintf (file, "};\n");
135       fprintf (file, "static const unsigned char cache_caps%d[%d] = {\n", mode->Fs/mdctSize, (mode->maxLM+1)*2*mode->nbEBands);
136       for (j=0;j<(mode->maxLM+1)*2*mode->nbEBands;j++)
137          fprintf (file, "%d,%c", mode->cache.caps[j],(j+16)%15==0?'\n':' ');
138       fprintf (file, "};\n");
139
140       fprintf(file, "#endif\n");
141       fprintf(file, "\n");
142
143       /* FFT twiddles */
144       fprintf(file, "#ifndef FFT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
145       fprintf(file, "#define FFT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
146       fprintf (file, "static const kiss_twiddle_cpx fft_twiddles%d_%d[%d] = {\n",
147             mode->Fs, mdctSize, mode->mdct.kfft[0]->nfft);
148       for (j=0;j<mode->mdct.kfft[0]->nfft;j++)
149          fprintf (file, "{" WORD16 ", " WORD16 "},%c", mode->mdct.kfft[0]->twiddles[j].r, mode->mdct.kfft[0]->twiddles[j].i,(j+3)%2==0?'\n':' ');
150       fprintf (file, "};\n");
151
152       /* FFT Bitrev tables */
153       for (k=0;k<=mode->mdct.maxshift;k++)
154       {
155          fprintf(file, "#ifndef FFT_BITREV%d\n", mode->mdct.kfft[k]->nfft);
156          fprintf(file, "#define FFT_BITREV%d\n", mode->mdct.kfft[k]->nfft);
157          fprintf (file, "static const opus_int16 fft_bitrev%d[%d] = {\n",
158                mode->mdct.kfft[k]->nfft, mode->mdct.kfft[k]->nfft);
159          for (j=0;j<mode->mdct.kfft[k]->nfft;j++)
160             fprintf (file, "%d,%c", mode->mdct.kfft[k]->bitrev[j],(j+16)%15==0?'\n':' ');
161          fprintf (file, "};\n");
162
163          fprintf(file, "#endif\n");
164          fprintf(file, "\n");
165       }
166
167       /* FFT States */
168       for (k=0;k<=mode->mdct.maxshift;k++)
169       {
170          fprintf(file, "#ifndef FFT_STATE%d_%d_%d\n", mode->Fs, mdctSize, k);
171          fprintf(file, "#define FFT_STATE%d_%d_%d\n", mode->Fs, mdctSize, k);
172          fprintf (file, "static const kiss_fft_state fft_state%d_%d_%d = {\n",
173                mode->Fs, mdctSize, k);
174          fprintf (file, "%d,\t/* nfft */\n", mode->mdct.kfft[k]->nfft);
175          fprintf (file, WORD16 ",\t/* scale */\n", mode->mdct.kfft[k]->scale);
176 #ifdef FIXED_POINT
177          fprintf (file, "%d,\t/* scale_shift */\n", mode->mdct.kfft[k]->scale_shift);
178 #endif
179          fprintf (file, "%d,\t/* shift */\n", mode->mdct.kfft[k]->shift);
180          fprintf (file, "{");
181          for (j=0;j<2*MAXFACTORS;j++)
182             fprintf (file, "%d, ", mode->mdct.kfft[k]->factors[j]);
183          fprintf (file, "},\t/* factors */\n");
184          fprintf (file, "fft_bitrev%d,\t/* bitrev */\n", mode->mdct.kfft[k]->nfft);
185          fprintf (file, "fft_twiddles%d_%d,\t/* bitrev */\n", mode->Fs, mdctSize);
186          fprintf (file, "};\n");
187
188          fprintf(file, "#endif\n");
189          fprintf(file, "\n");
190       }
191
192       fprintf(file, "#endif\n");
193       fprintf(file, "\n");
194
195       /* MDCT twiddles */
196       mdct_twiddles_size = mode->mdct.n-(mode->mdct.n/2>>mode->mdct.maxshift);
197       fprintf(file, "#ifndef MDCT_TWIDDLES%d\n", mdctSize);
198       fprintf(file, "#define MDCT_TWIDDLES%d\n", mdctSize);
199       fprintf (file, "static const opus_val16 mdct_twiddles%d[%d] = {\n",
200             mdctSize, mdct_twiddles_size);
201       for (j=0;j<mdct_twiddles_size;j++)
202          fprintf (file, WORD16 ",%c", mode->mdct.trig[j],(j+6)%5==0?'\n':' ');
203       fprintf (file, "};\n");
204
205       fprintf(file, "#endif\n");
206       fprintf(file, "\n");
207
208
209       /* Print the actual mode data */
210       fprintf(file, "static const CELTMode mode%d_%d_%d = {\n", mode->Fs, mdctSize, mode->overlap);
211       fprintf(file, INT32 ",\t/* Fs */\n", mode->Fs);
212       fprintf(file, "%d,\t/* overlap */\n", mode->overlap);
213       fprintf(file, "%d,\t/* nbEBands */\n", mode->nbEBands);
214       fprintf(file, "%d,\t/* effEBands */\n", mode->effEBands);
215       fprintf(file, "{");
216       for (j=0;j<4;j++)
217          fprintf(file, WORD16 ", ", mode->preemph[j]);
218       fprintf(file, "},\t/* preemph */\n");
219       if (standard)
220          fprintf(file, "eband5ms,\t/* eBands */\n");
221       else
222          fprintf(file, "eBands%d_%d,\t/* eBands */\n", mode->Fs, mdctSize);
223
224       fprintf(file, "%d,\t/* maxLM */\n", mode->maxLM);
225       fprintf(file, "%d,\t/* nbShortMdcts */\n", mode->nbShortMdcts);
226       fprintf(file, "%d,\t/* shortMdctSize */\n", mode->shortMdctSize);
227
228       fprintf(file, "%d,\t/* nbAllocVectors */\n", mode->nbAllocVectors);
229       if (standard)
230          fprintf(file, "band_allocation,\t/* allocVectors */\n");
231       else
232          fprintf(file, "allocVectors%d_%d,\t/* allocVectors */\n", mode->Fs, mdctSize);
233
234       fprintf(file, "logN%d,\t/* logN */\n", framerate);
235       fprintf(file, "window%d,\t/* window */\n", mode->overlap);
236       fprintf(file, "{%d, %d, {", mode->mdct.n, mode->mdct.maxshift);
237       for (k=0;k<=mode->mdct.maxshift;k++)
238          fprintf(file, "&fft_state%d_%d_%d, ", mode->Fs, mdctSize, k);
239       fprintf (file, "}, mdct_twiddles%d},\t/* mdct */\n", mdctSize);
240
241       fprintf(file, "{%d, cache_index%d, cache_bits%d, cache_caps%d},\t/* cache */\n",
242             mode->cache.size, mode->Fs/mdctSize, mode->Fs/mdctSize, mode->Fs/mdctSize);
243       fprintf(file, "};\n");
244    }
245    fprintf(file, "\n");
246    fprintf(file, "/* List of all the available modes */\n");
247    fprintf(file, "#define TOTAL_MODES %d\n", nb_modes);
248    fprintf(file, "static const CELTMode * const static_mode_list[TOTAL_MODES] = {\n");
249    for (i=0;i<nb_modes;i++)
250    {
251       CELTMode *mode = modes[i];
252       int mdctSize;
253       mdctSize = mode->shortMdctSize*mode->nbShortMdcts;
254       fprintf(file, "&mode%d_%d_%d,\n", mode->Fs, mdctSize, mode->overlap);
255    }
256    fprintf(file, "};\n");
257 }
258
259 void dump_header(FILE *file, CELTMode **modes, int nb_modes)
260 {
261    int i;
262    int channels = 0;
263    int frame_size = 0;
264    int overlap = 0;
265    fprintf (file, "/* This header file is generated automatically*/\n");
266    for (i=0;i<nb_modes;i++)
267    {
268       CELTMode *mode = modes[i];
269       if (frame_size==0)
270          frame_size = mode->shortMdctSize*mode->nbShortMdcts;
271       else if (frame_size != mode->shortMdctSize*mode->nbShortMdcts)
272          frame_size = -1;
273       if (overlap==0)
274          overlap = mode->overlap;
275       else if (overlap != mode->overlap)
276          overlap = -1;
277    }
278    if (channels>0)
279    {
280       fprintf (file, "#define CHANNELS(mode) %d\n", channels);
281       if (channels==1)
282          fprintf (file, "#define DISABLE_STEREO\n");
283    }
284    if (frame_size>0)
285    {
286       fprintf (file, "#define FRAMESIZE(mode) %d\n", frame_size);
287    }
288    if (overlap>0)
289    {
290       fprintf (file, "#define OVERLAP(mode) %d\n", overlap);
291    }
292 }
293
294 #ifdef FIXED_POINT
295 #define BASENAME "static_modes_fixed"
296 #else
297 #define BASENAME "static_modes_float"
298 #endif
299
300 int main(int argc, char **argv)
301 {
302    int i, nb;
303    FILE *file;
304    CELTMode **m;
305    if (argc%2 != 1 || argc<3)
306    {
307       fprintf (stderr, "Usage: %s rate frame_size [rate frame_size] [rate frame_size]...\n",argv[0]);
308       return 1;
309    }
310    nb = (argc-1)/2;
311    m = malloc(nb*sizeof(CELTMode*));
312    for (i=0;i<nb;i++)
313    {
314       int Fs, frame;
315       Fs      = atoi(argv[2*i+1]);
316       frame   = atoi(argv[2*i+2]);
317       m[i] = opus_custom_mode_create(Fs, frame, NULL);
318       if (m[i]==NULL)
319       {
320          fprintf(stderr,"Error creating mode with Fs=%s, frame_size=%s\n",
321                argv[2*i+1],argv[2*i+2]);
322          return EXIT_FAILURE;
323       }
324    }
325    file = fopen(BASENAME ".h", "w");
326    dump_modes(file, m, nb);
327    fclose(file);
328    for (i=0;i<nb;i++)
329       opus_custom_mode_destroy(m[i]);
330    free(m);
331    return 0;
332 }