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