Pre-emphasis coefficients now part of the mode and has a numerator as well
[opus.git] / libcelt / modes.c
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2008 Gregory Maxwell 
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /*
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9    
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12    
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16    
17    - Neither the name of the Xiph.org Foundation nor the names of its
18    contributors may be used to endorse or promote products derived from
19    this software without specific prior written permission.
20    
21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
25    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifdef HAVE_CONFIG_H
35 #include "config.h"
36 #endif
37
38 #include "celt.h"
39 #include "modes.h"
40 #include "rate.h"
41 #include "os_support.h"
42 #include "stack_alloc.h"
43 #include "quant_bands.h"
44
45 #ifdef STATIC_MODES
46 #include "static_modes.c"
47 #endif
48
49 #define MODEVALID   0xa110ca7e
50 #define MODEPARTIAL 0x7eca10a1
51 #define MODEFREED   0xb10cf8ee
52
53 #ifndef M_PI
54 #define M_PI 3.141592653
55 #endif
56
57
58 int celt_mode_info(const CELTMode *mode, int request, celt_int32 *value)
59 {
60    if (check_mode(mode) != CELT_OK)
61       return CELT_INVALID_MODE;
62    switch (request)
63    {
64       case CELT_GET_LOOKAHEAD:
65          *value = mode->overlap;
66          break;
67       case CELT_GET_BITSTREAM_VERSION:
68          *value = CELT_BITSTREAM_VERSION;
69          break;
70       case CELT_GET_SAMPLE_RATE:
71          *value = mode->Fs;
72          break;
73       default:
74          return CELT_UNIMPLEMENTED;
75    }
76    return CELT_OK;
77 }
78
79 #ifndef STATIC_MODES
80
81 /* Defining 25 critical bands for the full 0-20 kHz audio bandwidth
82    Taken from http://ccrma.stanford.edu/~jos/bbt/Bark_Frequency_Scale.html */
83 #define BARK_BANDS 25
84 static const celt_int16 bark_freq[BARK_BANDS+1] = {
85       0,   100,   200,   300,   400,
86     510,   630,   770,   920,  1080,
87    1270,  1480,  1720,  2000,  2320,
88    2700,  3150,  3700,  4400,  5300,
89    6400,  7700,  9500, 12000, 15500,
90   20000};
91
92 /* This allocation table is per critical band. When creating a mode, the bits get added together 
93    into the codec bands, which are sometimes larger than one critical band at low frequency */
94
95 #define BITALLOC_SIZE 12
96
97 static const celt_int16 eband5ms[] = {
98        0,  1,  2,  3,  4,  5,  6,  7,  8, 10, 12, 14, 16, 20, 24, 28, 34, 40, 48, 60, 78, 100
99 };
100
101 static const unsigned char band_allocation[] = {
102     /* 0 200 400 600 800  1k 1.2 1.4 1.6  2k 2.4 2.8 3.2  4k 4.8 5.6 6.8  8k 9.6 12k 15.6 */
103       10,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
104       10,  3,  8,  2,  0,  0,  0,  0,  1,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
105       10,  6,  8,  6,  5,  4,  3,  2,  7, 10, 11,  9,  7,  3,  1,  0,  0,  0,  0,  0,  0,
106       10, 10, 14, 11, 10,  8,  6,  5, 10, 12, 13, 11,  8,  4,  2,  1,  0,  0,  0,  0,  0,
107       13, 10, 17, 16, 14, 12, 10,  8, 12, 14, 14, 12,  9,  5,  3,  2,  2,  1,  0,  0,  0,
108       17, 21, 23, 26, 24, 20, 17, 16, 17, 18, 16, 14, 11,  6,  3,  2,  2,  1,  1,  0,  0,
109       21, 21, 36, 32, 28, 24, 23, 23, 22, 18, 18, 14, 11,  7,  5,  5,  5,  3,  3,  0,  0,
110       31, 35, 40, 32, 30, 28, 26, 26, 25, 24, 19, 15, 15, 13,  9,  9,  8,  7,  5,  2,  0,
111       42, 46, 46, 37, 35, 34, 33, 32, 34, 35, 32, 31, 27, 24, 23, 23, 18, 14, 11,  7,  0,
112       46, 49, 46, 46, 42, 43, 44, 47, 50, 52, 51, 48, 39, 32, 27, 24, 22, 19, 17, 11,  5,
113       53, 53, 49, 48, 55, 66, 71, 71, 71, 65, 64, 64, 56, 47, 41, 37, 31, 24, 20, 16, 10,
114       60, 64, 74, 74, 87,103,106,102,101,100,101, 95, 80, 69, 63, 55, 47, 36, 26, 21, 15,
115 };
116
117 static celt_int16 *compute_ebands(celt_int32 Fs, int frame_size, int res, int *nbEBands)
118 {
119    celt_int16 *eBands;
120    int i, lin, low, high, nBark, offset=0;
121
122    if (Fs == 400*(celt_int32)frame_size && Fs >= 40000)
123    {
124       *nbEBands = sizeof(eband5ms)/sizeof(eband5ms[0])-1;
125       eBands = celt_alloc(sizeof(celt_int16)*(*nbEBands+2));
126       for (i=0;i<*nbEBands+2;i++)
127          eBands[i] = eband5ms[i];
128       eBands[*nbEBands+1] = frame_size;
129       return eBands;
130    }
131    /* Find the number of critical bands supported by our sampling rate */
132    for (nBark=1;nBark<BARK_BANDS;nBark++)
133     if (bark_freq[nBark+1]*2 >= Fs)
134        break;
135
136    /* Find where the linear part ends (i.e. where the spacing is more than min_width */
137    for (lin=0;lin<nBark;lin++)
138       if (bark_freq[lin+1]-bark_freq[lin] >= res)
139          break;
140
141    low = (bark_freq[lin]+res/2)/res;
142    high = nBark-lin;
143    *nbEBands = low+high;
144    eBands = celt_alloc(sizeof(celt_int16)*(*nbEBands+2));
145    
146    if (eBands==NULL)
147       return NULL;
148    
149    /* Linear spacing (min_width) */
150    for (i=0;i<low;i++)
151       eBands[i] = i;
152    if (low>0)
153       offset = eBands[low-1]*res - bark_freq[lin-1];
154    /* Spacing follows critical bands */
155    for (i=0;i<high;i++)
156    {
157       int target = bark_freq[lin+i];
158       eBands[i+low] = (target+(offset+res)/2)/res;
159       offset = eBands[i+low]*res - target;
160    }
161    /* Enforce the minimum spacing at the boundary */
162    for (i=0;i<*nbEBands;i++)
163       if (eBands[i] < i)
164          eBands[i] = i;
165    eBands[*nbEBands] = (bark_freq[nBark]+res/2)/res;
166    eBands[*nbEBands+1] = frame_size;
167    if (eBands[*nbEBands] > eBands[*nbEBands+1])
168       eBands[*nbEBands] = eBands[*nbEBands+1];
169    for (i=1;i<*nbEBands-1;i++)
170    {
171       if (eBands[i+1]-eBands[i] < eBands[i]-eBands[i-1])
172       {
173          eBands[i] -= (2*eBands[i]-eBands[i-1]-eBands[i+1])/2;
174       }
175    }
176    /*for (i=0;i<=*nbEBands+1;i++)
177       printf ("%d ", eBands[i]);
178    printf ("\n");
179    exit(1);*/
180    /* FIXME: Remove last band if too small */
181    return eBands;
182 }
183
184 static void compute_allocation_table(CELTMode *mode, int res)
185 {
186    int i, j;
187    unsigned char *allocVectors;
188    int maxBands = sizeof(eband5ms)/sizeof(eband5ms[0])-1;
189
190    mode->nbAllocVectors = BITALLOC_SIZE;
191    allocVectors = celt_alloc(sizeof(unsigned char)*(BITALLOC_SIZE*mode->nbEBands));
192    if (allocVectors==NULL)
193       return;
194
195    /* Check for standard mode */
196    if (mode->Fs == 400*(celt_int32)mode->shortMdctSize && mode->Fs >= 40000)
197    {
198       for (i=0;i<BITALLOC_SIZE*mode->nbEBands;i++)
199          allocVectors[i] = band_allocation[i];
200       mode->allocVectors = allocVectors;
201       return;
202    }
203    /* If not the standard mode, interpolate */
204
205    /* Compute per-codec-band allocation from per-critical-band matrix */
206    for (i=0;i<BITALLOC_SIZE;i++)
207    {
208       celt_int32 current = 0;
209       int eband = 0;
210       /* We may be looping over too many bands, but eband will stop being
211          incremented once we reach the last band */
212       for (j=0;j<maxBands;j++)
213       {
214          int edge, low, high;
215          celt_int32 alloc;
216          alloc = band_allocation[i*maxBands + j]*(mode->eBands[eband+1]-mode->eBands[eband])<<4;
217          low = eband5ms[j]*200;
218          high = eband5ms[j+1]*200;
219          edge = mode->eBands[eband+1]*res;
220          while (edge <= high && eband < mode->nbEBands)
221          {
222             celt_int32 num;
223             int den, bits;
224             int N = (mode->eBands[eband+1]-mode->eBands[eband]);
225             num = alloc * (edge-low);
226             den = high-low;
227             /* Divide with rounding */
228             bits = (2*num+den)/(2*den);
229             allocVectors[i*mode->nbEBands+eband] = (2*(current+bits)+(N<<4))/(2*N<<4);
230             /* Remove the part of the band we just allocated */
231             low = edge;
232             alloc -= bits;
233
234             /* Move to next eband */
235             current = 0;
236             eband++;
237             edge = mode->eBands[eband+1]*res;
238          }
239          current += alloc;
240       }
241       if (eband < mode->nbEBands)
242       {
243          int N = (mode->eBands[eband+1]-mode->eBands[eband]);
244          allocVectors[i*mode->nbEBands+eband] = (2*current+(N<<4))/(2*N<<4);
245       }
246    }
247    /*printf ("\n");
248    for (i=0;i<BITALLOC_SIZE;i++)
249    {
250       for (j=0;j<mode->nbEBands;j++)
251          printf ("%d ", allocVectors[i*mode->nbEBands+j]);
252       printf ("\n");
253    }
254    exit(0);*/
255
256    mode->allocVectors = allocVectors;
257 }
258
259 #endif /* STATIC_MODES */
260
261 CELTMode *celt_mode_create(celt_int32 Fs, int frame_size, int *error)
262 {
263    int i;
264    int LM;
265 #ifdef STDIN_TUNING
266    scanf("%d ", &MIN_BINS);
267    scanf("%d ", &BITALLOC_SIZE);
268    band_allocation = celt_alloc(sizeof(int)*BARK_BANDS*BITALLOC_SIZE);
269    for (i=0;i<BARK_BANDS*BITALLOC_SIZE;i++)
270    {
271       scanf("%d ", band_allocation+i);
272    }
273 #endif
274 #ifdef STATIC_MODES
275    const CELTMode *m = NULL;
276    CELTMode *mode=NULL;
277    ALLOC_STACK;
278 #if !defined(VAR_ARRAYS) && !defined(USE_ALLOCA)
279    if (global_stack==NULL)
280       goto failure;
281 #endif 
282    for (i=0;i<TOTAL_MODES;i++)
283    {
284       if (Fs == static_mode_list[i]->Fs &&
285           frame_size == static_mode_list[i]->shortMdctSize*static_mode_list[i]->nbShortMdcts)
286       {
287          m = static_mode_list[i];
288          break;
289       }
290    }
291    if (m == NULL)
292    {
293       celt_warning("Mode not included as part of the static modes");
294       if (error)
295          *error = CELT_BAD_ARG;
296       return NULL;
297    }
298    mode = (CELTMode*)celt_alloc(sizeof(CELTMode));
299    if (mode==NULL)
300       goto failure;
301    CELT_COPY(mode, m, 1);
302    mode->bits = mode->_bits+1;
303    mode->marker_start = MODEPARTIAL;
304 #else
305    int res;
306    CELTMode *mode=NULL;
307    celt_word16 *window;
308    celt_int16 *logN;
309    ALLOC_STACK;
310 #if !defined(VAR_ARRAYS) && !defined(USE_ALLOCA)
311    if (global_stack==NULL)
312       goto failure;
313 #endif 
314
315    /* The good thing here is that permutation of the arguments will automatically be invalid */
316    
317    if (Fs < 32000 || Fs > 96000)
318    {
319       celt_warning("Sampling rate must be between 32 kHz and 96 kHz");
320       if (error)
321          *error = CELT_BAD_ARG;
322       return NULL;
323    }
324    if (frame_size < 64 || frame_size > 1024 || frame_size%2!=0)
325    {
326       celt_warning("Only even frame sizes from 64 to 1024 are supported");
327       if (error)
328          *error = CELT_BAD_ARG;
329       return NULL;
330    }
331    
332    mode = celt_alloc(sizeof(CELTMode));
333    if (mode==NULL)
334       goto failure;
335    mode->marker_start = MODEPARTIAL;
336    mode->Fs = Fs;
337    mode->ePredCoef = QCONST16(.8f,15);
338
339    mode->preemph[0] = QCONST16(.8, 15);
340    mode->preemph[1] = QCONST16(.0, 15);
341    mode->preemph[2] = QCONST16(1., SIG_SHIFT);
342    mode->preemph[3] = QCONST16(1., 14);
343    if (frame_size >= 640 && (frame_size%16)==0)
344    {
345      LM = 3;
346    } else if (frame_size >= 320 && (frame_size%8)==0)
347    {
348      LM = 2;
349    } else if (frame_size >= 160 && (frame_size%4)==0)
350    {
351      LM = 1;
352    } else
353    {
354      LM = 0;
355    }
356
357    mode->maxLM = LM;
358    mode->nbShortMdcts = 1<<LM;
359    mode->shortMdctSize = frame_size/mode->nbShortMdcts;
360    res = (mode->Fs+mode->shortMdctSize)/(2*mode->shortMdctSize);
361
362    mode->eBands = compute_ebands(Fs, mode->shortMdctSize, res, &mode->nbEBands);
363    if (mode->eBands==NULL)
364       goto failure;
365
366    mode->pitchEnd = 4000*(celt_int32)mode->shortMdctSize/Fs;
367    
368    /* Overlap must be divisible by 4 */
369    if (mode->nbShortMdcts > 1)
370       mode->overlap = (mode->shortMdctSize>>2)<<2;
371    else
372       mode->overlap = (frame_size>>3)<<2;
373
374
375    compute_allocation_table(mode, res);
376    if (mode->allocVectors==NULL)
377       goto failure;
378    
379    window = (celt_word16*)celt_alloc(mode->overlap*sizeof(celt_word16));
380    if (window==NULL)
381       goto failure;
382
383 #ifndef FIXED_POINT
384    for (i=0;i<mode->overlap;i++)
385       window[i] = Q15ONE*sin(.5*M_PI* sin(.5*M_PI*(i+.5)/mode->overlap) * sin(.5*M_PI*(i+.5)/mode->overlap));
386 #else
387    for (i=0;i<mode->overlap;i++)
388       window[i] = MIN32(32767,floor(.5+32768.*sin(.5*M_PI* sin(.5*M_PI*(i+.5)/mode->overlap) * sin(.5*M_PI*(i+.5)/mode->overlap))));
389 #endif
390    mode->window = window;
391
392    mode->bits = mode->_bits+1;
393    for (i=0;(1<<i)<=mode->nbShortMdcts;i++)
394    {
395       mode->bits[i] = (const celt_int16 **)compute_alloc_cache(mode, 1<<i);
396       if (mode->bits[i]==NULL)
397          goto failure;
398    }
399    mode->bits[-1] = (const celt_int16 **)compute_alloc_cache(mode, 0);
400    if (mode->bits[-1]==NULL)
401       goto failure;
402
403    logN = (celt_int16*)celt_alloc(mode->nbEBands*sizeof(celt_int16));
404    if (logN==NULL)
405       goto failure;
406
407    for (i=0;i<mode->nbEBands;i++)
408       logN[i] = log2_frac(mode->eBands[i+1]-mode->eBands[i], BITRES);
409    mode->logN = logN;
410 #endif /* !STATIC_MODES */
411
412    clt_mdct_init(&mode->mdct, 2*mode->shortMdctSize*mode->nbShortMdcts, LM);
413    if ((mode->mdct.trig==NULL)
414 #ifndef ENABLE_TI_DSPLIB55
415          || (mode->mdct.kfft==NULL)
416 #endif
417    )
418       goto failure;
419
420    mode->prob = quant_prob_alloc(mode);
421    if (mode->prob==NULL)
422      goto failure;
423
424    mode->marker_start = MODEVALID;
425    mode->marker_end   = MODEVALID;
426    if (error)
427       *error = CELT_OK;
428    return mode;
429 failure: 
430    if (error)
431       *error = CELT_INVALID_MODE;
432    if (mode!=NULL)
433       celt_mode_destroy(mode);
434    return NULL;
435 }
436
437 void celt_mode_destroy(CELTMode *mode)
438 {
439    int i, m;
440    const celt_int16 *prevPtr = NULL;
441    if (mode == NULL)
442    {
443       celt_warning("NULL passed to celt_mode_destroy");
444       return;
445    }
446
447    if (mode->marker_start == MODEFREED || mode->marker_end == MODEFREED)
448    {
449       celt_warning("Freeing a mode which has already been freed"); 
450       return;
451    }
452
453    if (mode->marker_start != MODEVALID && mode->marker_start != MODEPARTIAL)
454    {
455       celt_warning("This is not a valid CELT mode structure");
456       return;  
457    }
458    mode->marker_start = MODEFREED;
459 #ifndef STATIC_MODES
460    for (m=0;(1<<m)<=mode->nbShortMdcts;m++)
461    {
462       if (mode->bits[m]!=NULL)
463       {
464          for (i=0;i<mode->nbEBands;i++)
465          {
466             if (mode->bits[m][i] != prevPtr)
467             {
468                prevPtr = mode->bits[m][i];
469                celt_free((int*)mode->bits[m][i]);
470             }
471          }
472       }
473       celt_free((celt_int16**)mode->bits[m]);
474    }
475    if (mode->bits[-1]!=NULL)
476    {
477       for (i=0;i<mode->nbEBands;i++)
478       {
479          if (mode->bits[-1][i] != prevPtr)
480          {
481             prevPtr = mode->bits[-1][i];
482             celt_free((int*)mode->bits[-1][i]);
483          }
484       }
485    }
486    celt_free((celt_int16**)mode->bits[-1]);
487
488    celt_free((celt_int16*)mode->eBands);
489    celt_free((celt_int16*)mode->allocVectors);
490    
491    celt_free((celt_word16*)mode->window);
492    celt_free((celt_int16*)mode->logN);
493
494 #endif
495    clt_mdct_clear(&mode->mdct);
496
497    quant_prob_free(mode->prob);
498    mode->marker_end = MODEFREED;
499    celt_free((CELTMode *)mode);
500 }
501
502 int check_mode(const CELTMode *mode)
503 {
504    if (mode==NULL)
505       return CELT_INVALID_MODE;
506    if (mode->marker_start == MODEVALID && mode->marker_end == MODEVALID)
507       return CELT_OK;
508    if (mode->marker_start == MODEFREED || mode->marker_end == MODEFREED)
509       celt_warning("Using a mode that has already been freed");
510    else
511       celt_warning("This is not a valid CELT mode");
512    return CELT_INVALID_MODE;
513 }