b4d0b8f1803f77578959828615a34213dad388c8
[opus.git] / libcelt / modes.c
1 /* (C) 2007 Jean-Marc Valin, CSIRO
2 */
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 #include "celt.h"
33 #include "modes.h"
34 #include "rate.h"
35 #include "os_support.h"
36
37 int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value)
38 {
39    switch (request)
40    {
41       case CELT_GET_FRAME_SIZE:
42          *value = mode->mdctSize;
43          break;
44       case CELT_GET_LOOKAHEAD:
45          *value = mode->overlap;
46          break;
47       case CELT_GET_NB_CHANNELS:
48          *value = mode->nbChannels;
49          break;
50       default:
51          return CELT_BAD_ARG;
52    }
53    return CELT_OK;
54 }
55
56 #define PBANDS 8
57 #define MIN_BINS 4
58 /* Defining 25 critical bands for the full 0-20 kHz audio bandwidth
59    Taken from http://ccrma.stanford.edu/~jos/bbt/Bark_Frequency_Scale.html */
60 #define BARK_BANDS 25
61 static const celt_int16_t bark_freq[BARK_BANDS+1] = {
62       0,   100,   200,   300,   400,
63     510,   630,   770,   920,  1080,
64    1270,  1480,  1720,  2000,  2320,
65    2700,  3150,  3700,  4400,  5300,
66    6400,  7700,  9500, 12000, 15500,
67   20000};
68
69 static const celt_int16_t pitch_freq[PBANDS+1] ={0, 345, 689, 1034, 1378, 2067, 3273, 5340, 6374};
70
71 /* This allocation table is per critical band. When creating a mode, the bits get added together 
72    into the codec bands, which are sometimes larger than one critical band at low frequency */
73 #define BITALLOC_SIZE 10
74 static const int band_allocation[BARK_BANDS*BITALLOC_SIZE] = 
75    {  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,
76       2,  2,  2,  1,  2,  2,  2,  2,  2,  1,  2,  2,  5,  5,  7,  7,  7,  5,  4,  0,  0,  0,  0,  0,  0,
77       2,  2,  2,  2,  3,  2,  2,  2,  2,  2,  3,  2,  6,  6,  8,  8,  8,  6,  5,  4,  0,  0,  0,  0,  0,
78       3,  2,  2,  2,  3,  3,  2,  3,  2,  2,  4,  3,  7,  7,  9,  9,  9,  7,  6,  5,  5,  5,  0,  0,  0,
79       3,  3,  2,  2,  3,  3,  3,  3,  3,  2,  4,  4,  9,  9, 10, 10, 10,  9,  6,  5,  5,  5,  5,  0,  0,
80       3,  3,  2,  2,  3,  3,  3,  3,  3,  3,  4,  4, 10, 10, 12, 12, 12, 10, 10, 10, 11, 10, 10,  5,  5,
81       4,  4,  4,  4,  5,  5,  5,  5,  5,  4,  7,  7, 14, 13, 13, 13, 13, 13, 15, 16, 17, 18, 20, 18, 11,
82       7,  7,  6,  6,  9,  8,  8,  8,  8,  8, 11, 11, 20, 18, 19, 19, 25, 22, 25, 30, 30, 35, 35, 35, 35,
83       8,  8,  8,  8, 10, 10, 10, 10,  9,  9, 19, 18, 25, 24, 23, 21, 29, 27, 35, 40, 42, 50, 59, 54, 51,
84      11, 11, 10, 10, 14, 13, 13, 13, 13, 12, 19, 18, 35, 34, 33, 31, 39, 37, 45, 50, 52, 60, 60, 60, 60,
85    };
86
87
88 static int *compute_ebands(int Fs, int frame_size, int *nbEBands)
89 {
90    int *eBands;
91    int i, res, min_width, lin, low, high;
92    res = (Fs+frame_size)/(2*frame_size);
93    min_width = MIN_BINS*res;
94    /*printf ("min_width = %d\n", min_width);*/
95
96    /* Find where the linear part ends (i.e. where the spacing is more than min_width */
97    for (lin=0;lin<BARK_BANDS;lin++)
98       if (bark_freq[lin+1]-bark_freq[lin] >= min_width)
99          break;
100    
101    /*printf ("lin = %d (%d Hz)\n", lin, bark_freq[lin]);*/
102    low = ((bark_freq[lin]/res)+(MIN_BINS-1))/MIN_BINS;
103    high = BARK_BANDS-lin;
104    *nbEBands = low+high;
105    eBands = celt_alloc(sizeof(int)*(*nbEBands+2));
106    
107    /* Linear spacing (min_width) */
108    for (i=0;i<low;i++)
109       eBands[i] = MIN_BINS*i;
110    /* Spacing follows critical bands */
111    for (i=0;i<high;i++)
112       eBands[i+low] = (bark_freq[lin+i]+res/2)/res;
113    /* Enforce the minimum spacing at the boundary */
114    for (i=0;i<*nbEBands;i++)
115       if (eBands[i] < MIN_BINS*i)
116          eBands[i] = MIN_BINS*i;
117    eBands[*nbEBands] = (bark_freq[BARK_BANDS]+res/2)/res;
118    eBands[*nbEBands+1] = frame_size;
119    if (eBands[*nbEBands] > eBands[*nbEBands+1])
120       eBands[*nbEBands] = eBands[*nbEBands+1];
121    
122    /* FIXME: Remove last band if too small */
123    /*for (i=0;i<*nbEBands+2;i++)
124       printf("%d ", eBands[i]);
125    printf ("\n");*/
126    return eBands;
127 }
128
129 static void compute_pbands(CELTMode *mode, int res)
130 {
131    int i;
132    int *pBands;
133    pBands=celt_alloc(sizeof(int)*(PBANDS+2));
134    mode->nbPBands = PBANDS;
135    for (i=0;i<PBANDS+1;i++)
136    {
137       pBands[i] = (pitch_freq[i]+res/2)/res;
138       if (pBands[i] < mode->eBands[i])
139          pBands[i] = mode->eBands[i];
140    }
141    pBands[PBANDS+1] = mode->eBands[mode->nbEBands+1];
142    for (i=1;i<mode->nbPBands+1;i++)
143    {
144       int j;
145       for (j=0;j<mode->nbEBands;j++)
146          if (mode->eBands[j] <= pBands[i] && mode->eBands[j+1] > pBands[i])
147             break;
148       /*printf ("%d %d\n", i, j);*/
149       if (mode->eBands[j] != pBands[i])
150       {
151          if (pBands[i]-mode->eBands[j] < mode->eBands[j+1]-pBands[i] && 
152              mode->eBands[j] != pBands[i-1])
153             pBands[i] = mode->eBands[j];
154          else
155             pBands[i] = mode->eBands[j+1];
156       }
157    }
158    /*for (i=0;i<mode->nbPBands+2;i++)
159       printf("%d ", pBands[i]);
160    printf ("\n");*/
161    mode->pBands = pBands;
162    mode->pitchEnd = pBands[PBANDS];
163 }
164
165 static void compute_allocation_table(CELTMode *mode, int res)
166 {
167    int i, j, eband;
168    int *allocVectors;
169    
170    mode->nbAllocVectors = BITALLOC_SIZE;
171    allocVectors = celt_alloc(sizeof(int)*(BITALLOC_SIZE*mode->nbEBands));
172    for (i=0;i<BITALLOC_SIZE;i++)
173    {
174       eband = 0;
175       for (j=0;j<BARK_BANDS;j++)
176       {
177          int edge, low;
178          edge = mode->eBands[eband+1]*res;
179          if (edge < bark_freq[j+1])
180          {
181             int num, den;
182             num = band_allocation[i*BARK_BANDS+j] * (edge-bark_freq[j]);
183             den = bark_freq[j+1]-bark_freq[j];
184             low = (num+den/2)/den;
185             allocVectors[i*mode->nbEBands+eband] += low;
186             eband++;
187             allocVectors[i*mode->nbEBands+eband] += band_allocation[i*BARK_BANDS+j]-low;
188          } else {
189             allocVectors[i*mode->nbEBands+eband] += band_allocation[i*BARK_BANDS+j];
190          }
191       }
192    }
193    /*for (i=0;i<BITALLOC_SIZE;i++)
194    {
195       for (j=0;j<mode->nbEBands;j++)
196          printf ("%2d ", allocVectors[i*mode->nbEBands+j]);
197       printf ("\n");
198    }*/
199    mode->allocVectors = allocVectors;
200 }
201
202
203
204 CELTMode *celt_mode_create(int Fs, int channels, int frame_size, int lookahead, int *error)
205 {
206    int res;
207    CELTMode *mode;
208    
209    /* The good thing here is that permutation of the arguments will automatically be invalid */
210    
211    if (Fs < 32000 || Fs > 64000)
212    {
213       celt_warning("Sampling rate must be between 32 kHz and 64 kHz");
214       if (error)
215          *error = CELT_BAD_ARG;
216       return NULL;
217    }
218    if (channels < 0 || channels > 2)
219    {
220       celt_warning("Only mono and stereo supported");
221       if (error)
222          *error = CELT_BAD_ARG;
223       return NULL;
224    }
225    if (frame_size < 64 || frame_size > 256 || frame_size%2!=0)
226    {
227       celt_warning("Only even frame sizes between 64 and 256 are supported");
228       if (error)
229          *error = CELT_BAD_ARG;
230       return NULL;
231    }
232    if (lookahead < 32 || lookahead > frame_size)
233    {
234       celt_warning("The overlap must be between 32 and the frame size");
235       if (error)
236          *error = CELT_BAD_ARG;
237       return NULL;
238    }
239    res = (Fs+frame_size)/(2*frame_size);
240    
241    mode = celt_alloc(sizeof(CELTMode));
242    mode->overlap = lookahead;
243    mode->mdctSize = frame_size;
244    mode->nbMdctBlocks = 1;
245    mode->nbChannels = channels;
246    mode->eBands = compute_ebands(Fs, frame_size, &mode->nbEBands);
247    compute_pbands(mode, res);
248    mode->ePredCoef = .8;
249    
250    compute_allocation_table(mode, res);
251    compute_alloc_cache(mode);
252    /*printf ("%d bands\n", mode->nbEBands);*/
253    return mode;
254 }
255
256 void celt_mode_destroy(CELTMode *mode)
257 {
258    int i;
259    const int *prevPtr = NULL;
260    celt_free((int*)mode->eBands);
261    celt_free((int*)mode->pBands);
262    celt_free((int*)mode->allocVectors);
263    
264    for (i=0;i<mode->nbEBands;i++)
265    {
266       if (mode->bits[i] != prevPtr)
267       {
268          prevPtr = mode->bits[i];
269          celt_free((int*)mode->bits[i]);
270       }
271    }
272    celt_free((int**)mode->bits);
273
274    celt_free((CELTMode *)mode);
275
276 }