Updating dump_modes to include the MDCT and FFT. More work needed.
[opus.git] / libcelt / 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    - Neither the name of the Xiph.org Foundation nor the names of its
17    contributors may be used to endorse or promote products derived from
18    this software without specific prior written permission.
19    
20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
24    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifdef HAVE_CONFIG_H
34 #include "config.h"
35 #endif
36
37 #include <stdio.h>
38 #include "modes.h"
39 #include "celt.h"
40 #include "rate.h"
41
42 #define INT16 "%d"
43 #define INT32 "%d"
44 #define FLOAT "%f"
45
46 #ifdef FIXED_POINT
47 #define WORD16 INT16
48 #define WORD32 INT32
49 #else
50 #define WORD16 FLOAT
51 #define WORD32 FLOAT
52 #endif
53
54
55 void dump_modes(FILE *file, CELTMode **modes, int nb_modes)
56 {
57    int i, j, k;
58    fprintf(file, "/* The contents of this file is automatically generated and contains static\n");
59    fprintf(file, "   definitions for some pre-defined modes */\n");
60    fprintf(file, "#include \"modes.h\"\n");
61    fprintf(file, "#include \"rate.h\"\n");
62
63    fprintf(file, "\n");
64
65    for (i=0;i<nb_modes;i++)
66    {
67       CELTMode *mode = modes[i];
68       int mdctSize;
69       mdctSize = mode->shortMdctSize*mode->nbShortMdcts;
70       fprintf(file, "#ifndef DEF_EBANDS%d_%d\n", mode->Fs, mdctSize);
71       fprintf(file, "#define DEF_EBANDS%d_%d\n", mode->Fs, mdctSize);
72       fprintf (file, "static const celt_int16 eBands%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands+2);
73       for (j=0;j<mode->nbEBands+2;j++)
74          fprintf (file, "%d, ", mode->eBands[j]);
75       fprintf (file, "};\n");
76       fprintf(file, "#endif\n");
77       fprintf(file, "\n");
78       
79       
80       fprintf(file, "#ifndef DEF_WINDOW%d\n", mode->overlap);
81       fprintf(file, "#define DEF_WINDOW%d\n", mode->overlap);
82       fprintf (file, "static const celt_word16 window%d[%d] = {\n", mode->overlap, mode->overlap);
83       for (j=0;j<mode->overlap;j++)
84          fprintf (file, WORD16 ", ", mode->window[j]);
85       fprintf (file, "};\n");
86       fprintf(file, "#endif\n");
87       fprintf(file, "\n");
88       
89       fprintf(file, "#ifndef DEF_ALLOC_VECTORS%d_%d\n", mode->Fs, mdctSize);
90       fprintf(file, "#define DEF_ALLOC_VECTORS%d_%d\n", mode->Fs, mdctSize);
91       fprintf (file, "static const unsigned char allocVectors%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands*mode->nbAllocVectors);
92       for (j=0;j<mode->nbAllocVectors;j++)
93       {
94          for (k=0;k<mode->nbEBands;k++)
95             fprintf (file, "%2d, ", mode->allocVectors[j*mode->nbEBands+k]);
96          fprintf (file, "\n");
97       }
98       fprintf (file, "};\n");
99       fprintf(file, "#endif\n");
100       fprintf(file, "\n");
101
102       fprintf(file, "#ifndef DEF_LOGN%d_%d\n", mode->Fs, mdctSize);
103       fprintf(file, "#define DEF_LOGN%d_%d\n", mode->Fs, mdctSize);
104       fprintf (file, "static const celt_int16 logN%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands);
105       for (j=0;j<mode->nbEBands;j++)
106          fprintf (file, "%d, ", mode->logN[j]);
107       fprintf (file, "};\n");
108       fprintf(file, "#endif\n");
109       fprintf(file, "\n");
110
111       /* Pulse cache */
112       fprintf(file, "#ifndef DEF_PULSE_CACHE%d_%d\n", mode->Fs, mdctSize);
113       fprintf(file, "#define DEF_PULSE_CACHE%d_%d\n", mode->Fs, mdctSize);
114       fprintf (file, "static const celt_int16 cache_index%d_%d[%d] = {\n", mode->Fs, mdctSize, (mode->maxLM+2)*mode->nbEBands);
115       for (j=0;j<mode->nbEBands*(mode->maxLM+2);j++)
116          fprintf (file, "%d, ", mode->cache.index[j]);
117       fprintf (file, "};\n");
118       fprintf (file, "static const unsigned char cache_bits%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->cache.size);
119       for (j=0;j<mode->cache.size;j++)
120          fprintf (file, "%d, ", mode->cache.bits[j]);
121       fprintf (file, "};\n");
122       fprintf(file, "#endif\n");
123       fprintf(file, "\n");
124
125       /* FFT twiddles */
126       fprintf(file, "#ifndef FFT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
127       fprintf(file, "#define FFT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
128       fprintf (file, "static const kiss_twiddle_cpx fft_twiddles%d_%d[%d] = {\n",
129             mode->Fs, mdctSize, mode->mdct.kfft[0]->nfft);
130       for (j=0;j<mode->mdct.kfft[0]->nfft;j++)
131          fprintf (file, "{" WORD16 ", " WORD16 "}, ", mode->mdct.kfft[0]->twiddles[j].r, mode->mdct.kfft[0]->twiddles[j].i);
132       fprintf (file, "};\n");
133
134       /* FFT Bitrev tables */
135       for (i=0;i<=mode->mdct.maxshift;i++)
136       {
137          fprintf(file, "#ifndef FFT_BITREV%d_%d\n", mode->Fs, mdctSize>>i);
138          fprintf(file, "#define FFT_BITREV%d_%d\n", mode->Fs, mdctSize>>i);
139          fprintf (file, "static const celt_int16 fft_bitrev%d_%d[%d] = {\n",
140                mode->Fs, mdctSize>>i, mode->mdct.kfft[i]->nfft);
141          for (j=0;j<mode->mdct.kfft[i]->nfft;j++)
142             fprintf (file, "%d, ", mode->mdct.kfft[i]->bitrev[j]);
143          fprintf (file, "};\n");
144
145          fprintf(file, "#endif\n");
146          fprintf(file, "\n");
147       }
148
149       /* FFT States */
150       for (i=0;i<=mode->mdct.maxshift;i++)
151       {
152          fprintf(file, "#ifndef FFT_STATE%d_%d\n", mode->Fs, mdctSize>>i);
153          fprintf(file, "#define FFT_STATE%d_%d\n", mode->Fs, mdctSize>>i);
154          fprintf (file, "static const kiss_fft_state fft_state%d_%d = {\n",
155                mode->Fs, mdctSize>>i);
156          fprintf (file, "%d,\t/* nfft */\n", mode->mdct.kfft[i]->nfft);
157 #ifndef FIXED_POINT
158          fprintf (file, "%f,\t/* scale */\n", mode->mdct.kfft[i]->scale);
159 #endif
160          fprintf (file, "%d,\t/* shift */\n", mode->mdct.kfft[i]->shift);
161          fprintf (file, "{");
162          for (j=0;j<2*MAXFACTORS;j++)
163             fprintf (file, "%d, ", mode->mdct.kfft[i]->factors[j]);
164          fprintf (file, "},\t/* factors */\n");
165          fprintf (file, "fft_bitrev%d_%d,\t/* bitrev */\n", mode->Fs, mdctSize>>i);
166          fprintf (file, "fft_twiddles%d_%d,\t/* bitrev */\n", mode->Fs, mdctSize);
167          fprintf (file, "};\n");
168
169          fprintf(file, "#endif\n");
170          fprintf(file, "\n");
171       }
172
173       fprintf(file, "#endif\n");
174       fprintf(file, "\n");
175
176       /* MDCT twiddles */
177       fprintf(file, "#ifndef MDCT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
178       fprintf(file, "#define MDCT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
179       fprintf (file, "static const celt_word16 mdct_twiddles%d_%d[%d] = {\n",
180             mode->Fs, mdctSize, mode->mdct.n/4);
181       for (j=0;j<mode->mdct.n/4;j++)
182          fprintf (file, WORD16 ", ", mode->mdct.trig[j]);
183       fprintf (file, "};\n");
184
185       fprintf(file, "#endif\n");
186       fprintf(file, "\n");
187
188
189       /* Print the actual mode data */
190       fprintf(file, "static const CELTMode mode%d_%d_%d = {\n", mode->Fs, mdctSize, mode->overlap);
191       fprintf(file, "0x%x,\t/* marker */\n", 0xa110ca7e);
192       fprintf(file, INT32 ",\t/* Fs */\n", mode->Fs);
193       fprintf(file, "%d,\t/* overlap */\n", mode->overlap);
194       fprintf(file, "%d,\t/* nbEBands */\n", mode->nbEBands);
195       fprintf(file, "%d,\t/* effEBands */\n", mode->effEBands);
196       fprintf(file, "{");
197       for (j=0;j<4;j++)
198          fprintf(file, WORD16 ", ", mode->preemph[j]);
199       fprintf(file, "},\t/* preemph */\n");
200       fprintf(file, "eBands%d_%d,\t/* eBands */\n", mode->Fs, mdctSize);
201       fprintf(file, "%d,\t/* nbAllocVectors */\n", mode->nbAllocVectors);
202       fprintf(file, "allocVectors%d_%d,\t/* allocVectors */\n", mode->Fs, mdctSize);
203
204       fprintf(file, "{%d, %d, {", mode->mdct.n, mode->mdct.maxshift);
205       for (i=0;i<=mode->mdct.maxshift;i++)
206          fprintf(file, "fft_state%d_%d, ", mode->Fs, mdctSize>>i);
207       fprintf (file, "}, mdct_twiddles%d_%d},\t/* mdct */\n", mode->Fs, mdctSize);
208
209       fprintf(file, "window%d,\t/* window */\n", mode->overlap);
210       fprintf(file, "%d,\t/* maxLM */\n", mode->maxLM);
211       fprintf(file, "%d,\t/* nbShortMdcts */\n", mode->nbShortMdcts);
212       fprintf(file, "%d,\t/* shortMdctSize */\n", mode->shortMdctSize);
213       fprintf(file, "0,\t/* prob */\n");
214       fprintf(file, "logN%d_%d,\t/* logN */\n", mode->Fs, mdctSize);
215       fprintf(file, "{%d, cache_index%d_%d, cache_bits%d_%d},\t/* cache */\n",
216             mode->cache.size, mode->Fs, mdctSize, mode->Fs, mdctSize);
217       fprintf(file, "0x%x,\t/* marker */\n", 0xa110ca7e);
218       fprintf(file, "};\n");
219    }
220    fprintf(file, "\n");
221    fprintf(file, "/* List of all the available modes */\n");
222    fprintf(file, "#define TOTAL_MODES %d\n", nb_modes);
223    fprintf(file, "static const CELTMode * const static_mode_list[TOTAL_MODES] = {\n");
224    for (i=0;i<nb_modes;i++)
225    {
226       CELTMode *mode = modes[i];
227       int mdctSize;
228       mdctSize = mode->shortMdctSize*mode->nbShortMdcts;
229       fprintf(file, "&mode%d_%d_%d,\n", mode->Fs, mdctSize, mode->overlap);
230    }
231    fprintf(file, "};\n");
232 }
233
234 void dump_header(FILE *file, CELTMode **modes, int nb_modes)
235 {
236    int i;
237    int channels = 0;
238    int frame_size = 0;
239    int overlap = 0;
240    fprintf (file, "/* This header file is generated automatically*/\n");
241    for (i=0;i<nb_modes;i++)
242    {
243       CELTMode *mode = modes[i];
244       if (frame_size==0)
245          frame_size = mode->shortMdctSize*mode->nbShortMdcts;
246       else if (frame_size != mode->shortMdctSize*mode->nbShortMdcts)
247          frame_size = -1;
248       if (overlap==0)
249          overlap = mode->overlap;
250       else if (overlap != mode->overlap)
251          overlap = -1;
252    }
253    if (channels>0)
254    {
255       fprintf (file, "#define CHANNELS(mode) %d\n", channels);
256       if (channels==1)
257          fprintf (file, "#define DISABLE_STEREO\n");
258    }
259    if (frame_size>0)
260    {
261       fprintf (file, "#define FRAMESIZE(mode) %d\n", frame_size);
262    }
263    if (overlap>0)
264    {
265       fprintf (file, "#define OVERLAP(mode) %d\n", overlap);
266    }
267 }
268
269 int main(int argc, char **argv)
270 {
271    int i, nb;
272    FILE *file;
273    CELTMode **m;
274    if (argc%2 != 1)
275    {
276       fprintf (stderr, "must have a multiple of 2 arguments\n");
277       return 1;
278    }
279    nb = (argc-1)/2;
280    m = malloc(nb*sizeof(CELTMode*));
281    for (i=0;i<nb;i++)
282    {
283       int Fs, frame;
284       Fs      = atoi(argv[2*i+1]);
285       frame   = atoi(argv[2*i+2]);
286       m[i] = celt_mode_create(Fs, frame, NULL);
287    }
288    file = fopen("static_modes.c", "w");
289    dump_modes(file, m, nb);
290    fclose(file);
291    file = fopen("static_modes.h", "w");
292    dump_header(file, m, nb);
293    fclose(file);
294    for (i=0;i<nb;i++)
295       celt_mode_destroy(m[i]);
296    free(m);
297    return 0;
298 }