static modes simplifications for std mode
[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       int standard;
70
71       mdctSize = mode->shortMdctSize*mode->nbShortMdcts;
72       standard = (mode->Fs == 400*(celt_int32)mode->shortMdctSize);
73
74       if (!standard)
75       {
76          fprintf(file, "#ifndef DEF_EBANDS%d_%d\n", mode->Fs, mdctSize);
77          fprintf(file, "#define DEF_EBANDS%d_%d\n", mode->Fs, mdctSize);
78          fprintf (file, "static const celt_int16 eBands%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands+2);
79          for (j=0;j<mode->nbEBands+2;j++)
80             fprintf (file, "%d, ", mode->eBands[j]);
81          fprintf (file, "};\n");
82          fprintf(file, "#endif\n");
83          fprintf(file, "\n");
84       }
85       
86       fprintf(file, "#ifndef DEF_WINDOW%d\n", mode->overlap);
87       fprintf(file, "#define DEF_WINDOW%d\n", mode->overlap);
88       fprintf (file, "static const celt_word16 window%d[%d] = {\n", mode->overlap, mode->overlap);
89       for (j=0;j<mode->overlap;j++)
90          fprintf (file, WORD16 ", ", mode->window[j]);
91       fprintf (file, "};\n");
92       fprintf(file, "#endif\n");
93       fprintf(file, "\n");
94       
95       if (!standard)
96       {
97          fprintf(file, "#ifndef DEF_ALLOC_VECTORS%d_%d\n", mode->Fs, mdctSize);
98          fprintf(file, "#define DEF_ALLOC_VECTORS%d_%d\n", mode->Fs, mdctSize);
99          fprintf (file, "static const unsigned char allocVectors%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands*mode->nbAllocVectors);
100          for (j=0;j<mode->nbAllocVectors;j++)
101          {
102             for (k=0;k<mode->nbEBands;k++)
103                fprintf (file, "%2d, ", mode->allocVectors[j*mode->nbEBands+k]);
104             fprintf (file, "\n");
105          }
106          fprintf (file, "};\n");
107          fprintf(file, "#endif\n");
108          fprintf(file, "\n");
109       }
110
111       fprintf(file, "#ifndef DEF_PROB%d\n", mode->nbEBands);
112       fprintf(file, "#define DEF_PROB%d\n", mode->nbEBands);
113       fprintf (file, "static const celt_int16 prob%d[%d] = {\n", mode->nbEBands, 4*mode->nbEBands);
114       for (j=0;j<4*mode->nbEBands;j++)
115          fprintf (file, "%d, ", mode->prob[j]);
116       fprintf (file, "};\n");
117       fprintf(file, "#endif\n");
118       fprintf(file, "\n");
119
120       fprintf(file, "#ifndef DEF_LOGN%d_%d\n", mode->Fs, mdctSize);
121       fprintf(file, "#define DEF_LOGN%d_%d\n", mode->Fs, mdctSize);
122       fprintf (file, "static const celt_int16 logN%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->nbEBands);
123       for (j=0;j<mode->nbEBands;j++)
124          fprintf (file, "%d, ", mode->logN[j]);
125       fprintf (file, "};\n");
126       fprintf(file, "#endif\n");
127       fprintf(file, "\n");
128
129       /* Pulse cache */
130       fprintf(file, "#ifndef DEF_PULSE_CACHE%d_%d\n", mode->Fs, mdctSize);
131       fprintf(file, "#define DEF_PULSE_CACHE%d_%d\n", mode->Fs, mdctSize);
132       fprintf (file, "static const celt_int16 cache_index%d_%d[%d] = {\n", mode->Fs, mdctSize, (mode->maxLM+2)*mode->nbEBands);
133       for (j=0;j<mode->nbEBands*(mode->maxLM+2);j++)
134          fprintf (file, "%d, ", mode->cache.index[j]);
135       fprintf (file, "};\n");
136       fprintf (file, "static const unsigned char cache_bits%d_%d[%d] = {\n", mode->Fs, mdctSize, mode->cache.size);
137       for (j=0;j<mode->cache.size;j++)
138          fprintf (file, "%d, ", mode->cache.bits[j]);
139       fprintf (file, "};\n");
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 "}, ", mode->mdct.kfft[0]->twiddles[j].r, mode->mdct.kfft[0]->twiddles[j].i);
150       fprintf (file, "};\n");
151
152       /* FFT Bitrev tables */
153       for (i=0;i<=mode->mdct.maxshift;i++)
154       {
155          fprintf(file, "#ifndef FFT_BITREV%d\n", mode->mdct.kfft[i]->nfft);
156          fprintf(file, "#define FFT_BITREV%d\n", mode->mdct.kfft[i]->nfft);
157          fprintf (file, "static const celt_int16 fft_bitrev%d[%d] = {\n",
158                mode->mdct.kfft[i]->nfft, mode->mdct.kfft[i]->nfft);
159          for (j=0;j<mode->mdct.kfft[i]->nfft;j++)
160             fprintf (file, "%d, ", mode->mdct.kfft[i]->bitrev[j]);
161          fprintf (file, "};\n");
162
163          fprintf(file, "#endif\n");
164          fprintf(file, "\n");
165       }
166
167       /* FFT States */
168       for (i=0;i<=mode->mdct.maxshift;i++)
169       {
170          fprintf(file, "#ifndef FFT_STATE%d_%d\n", mode->Fs, mdctSize>>i);
171          fprintf(file, "#define FFT_STATE%d_%d\n", mode->Fs, mdctSize>>i);
172          fprintf (file, "static const kiss_fft_state fft_state%d_%d = {\n",
173                mode->Fs, mdctSize>>i);
174          fprintf (file, "%d,\t/* nfft */\n", mode->mdct.kfft[i]->nfft);
175 #ifndef FIXED_POINT
176          fprintf (file, "%f,\t/* scale */\n", mode->mdct.kfft[i]->scale);
177 #endif
178          fprintf (file, "%d,\t/* shift */\n", mode->mdct.kfft[i]->shift);
179          fprintf (file, "{");
180          for (j=0;j<2*MAXFACTORS;j++)
181             fprintf (file, "%d, ", mode->mdct.kfft[i]->factors[j]);
182          fprintf (file, "},\t/* factors */\n");
183          fprintf (file, "fft_bitrev%d,\t/* bitrev */\n", mode->mdct.kfft[i]->nfft);
184          fprintf (file, "fft_twiddles%d_%d,\t/* bitrev */\n", mode->Fs, mdctSize);
185          fprintf (file, "};\n");
186
187          fprintf(file, "#endif\n");
188          fprintf(file, "\n");
189       }
190
191       fprintf(file, "#endif\n");
192       fprintf(file, "\n");
193
194       /* MDCT twiddles */
195       fprintf(file, "#ifndef MDCT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
196       fprintf(file, "#define MDCT_TWIDDLES%d_%d\n", mode->Fs, mdctSize);
197       fprintf (file, "static const celt_word16 mdct_twiddles%d_%d[%d] = {\n",
198             mode->Fs, mdctSize, mode->mdct.n/4+1);
199       for (j=0;j<=mode->mdct.n/4;j++)
200          fprintf (file, WORD16 ", ", mode->mdct.trig[j]);
201       fprintf (file, "};\n");
202
203       fprintf(file, "#endif\n");
204       fprintf(file, "\n");
205
206
207       /* Print the actual mode data */
208       fprintf(file, "static const CELTMode mode%d_%d_%d = {\n", mode->Fs, mdctSize, mode->overlap);
209       fprintf(file, INT32 ",\t/* Fs */\n", mode->Fs);
210       fprintf(file, "%d,\t/* overlap */\n", mode->overlap);
211       fprintf(file, "%d,\t/* nbEBands */\n", mode->nbEBands);
212       fprintf(file, "%d,\t/* effEBands */\n", mode->effEBands);
213       fprintf(file, "{");
214       for (j=0;j<4;j++)
215          fprintf(file, WORD16 ", ", mode->preemph[j]);
216       fprintf(file, "},\t/* preemph */\n");
217       if (standard)
218          fprintf(file, "eband5ms,\t/* eBands */\n");
219       else
220          fprintf(file, "eBands%d_%d,\t/* eBands */\n", mode->Fs, mdctSize);
221       fprintf(file, "%d,\t/* nbAllocVectors */\n", mode->nbAllocVectors);
222       if (standard)
223          fprintf(file, "band_allocation,\t/* allocVectors */\n");
224       else
225          fprintf(file, "allocVectors%d_%d,\t/* allocVectors */\n", mode->Fs, mdctSize);
226
227       fprintf(file, "{%d, %d, {", mode->mdct.n, mode->mdct.maxshift);
228       for (i=0;i<=mode->mdct.maxshift;i++)
229          fprintf(file, "&fft_state%d_%d, ", mode->Fs, mdctSize>>i);
230       fprintf (file, "}, mdct_twiddles%d_%d},\t/* mdct */\n", mode->Fs, mdctSize);
231
232       fprintf(file, "window%d,\t/* window */\n", mode->overlap);
233       fprintf(file, "%d,\t/* maxLM */\n", mode->maxLM);
234       fprintf(file, "%d,\t/* nbShortMdcts */\n", mode->nbShortMdcts);
235       fprintf(file, "%d,\t/* shortMdctSize */\n", mode->shortMdctSize);
236       fprintf(file, "prob%d,\t/* prob */\n", mode->nbEBands);
237       fprintf(file, "logN%d_%d,\t/* logN */\n", mode->Fs, mdctSize);
238       fprintf(file, "{%d, cache_index%d_%d, cache_bits%d_%d},\t/* cache */\n",
239             mode->cache.size, mode->Fs, mdctSize, mode->Fs, mdctSize);
240       fprintf(file, "};\n");
241    }
242    fprintf(file, "\n");
243    fprintf(file, "/* List of all the available modes */\n");
244    fprintf(file, "#define TOTAL_MODES %d\n", nb_modes);
245    fprintf(file, "static const CELTMode * const static_mode_list[TOTAL_MODES] = {\n");
246    for (i=0;i<nb_modes;i++)
247    {
248       CELTMode *mode = modes[i];
249       int mdctSize;
250       mdctSize = mode->shortMdctSize*mode->nbShortMdcts;
251       fprintf(file, "&mode%d_%d_%d,\n", mode->Fs, mdctSize, mode->overlap);
252    }
253    fprintf(file, "};\n");
254 }
255
256 void dump_header(FILE *file, CELTMode **modes, int nb_modes)
257 {
258    int i;
259    int channels = 0;
260    int frame_size = 0;
261    int overlap = 0;
262    fprintf (file, "/* This header file is generated automatically*/\n");
263    for (i=0;i<nb_modes;i++)
264    {
265       CELTMode *mode = modes[i];
266       if (frame_size==0)
267          frame_size = mode->shortMdctSize*mode->nbShortMdcts;
268       else if (frame_size != mode->shortMdctSize*mode->nbShortMdcts)
269          frame_size = -1;
270       if (overlap==0)
271          overlap = mode->overlap;
272       else if (overlap != mode->overlap)
273          overlap = -1;
274    }
275    if (channels>0)
276    {
277       fprintf (file, "#define CHANNELS(mode) %d\n", channels);
278       if (channels==1)
279          fprintf (file, "#define DISABLE_STEREO\n");
280    }
281    if (frame_size>0)
282    {
283       fprintf (file, "#define FRAMESIZE(mode) %d\n", frame_size);
284    }
285    if (overlap>0)
286    {
287       fprintf (file, "#define OVERLAP(mode) %d\n", overlap);
288    }
289 }
290
291 int main(int argc, char **argv)
292 {
293    int i, nb;
294    FILE *file;
295    CELTMode **m;
296    if (argc%2 != 1)
297    {
298       fprintf (stderr, "must have a multiple of 2 arguments\n");
299       return 1;
300    }
301    nb = (argc-1)/2;
302    m = malloc(nb*sizeof(CELTMode*));
303    for (i=0;i<nb;i++)
304    {
305       int Fs, frame;
306       Fs      = atoi(argv[2*i+1]);
307       frame   = atoi(argv[2*i+2]);
308       m[i] = celt_mode_create(Fs, frame, NULL);
309    }
310    file = fopen("static_modes.c", "w");
311    dump_modes(file, m, nb);
312    fclose(file);
313    file = fopen("static_modes.h", "w");
314    dump_header(file, m, nb);
315    fclose(file);
316    for (i=0;i<nb;i++)
317       celt_mode_destroy(m[i]);
318    free(m);
319    return 0;
320 }