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