More work on variable frame size (getting rid of FRAMESIZE() )
[opus.git] / libcelt / rate.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-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 #ifndef RATE_H
34 #define RATE_H
35
36 #define MAX_PSEUDO 40
37 #define LOG_MAX_PSEUDO 6
38
39 #define MAX_PULSES 128
40 #define LOG_MAX_PULSES 7
41
42 #define BITRES 4
43 #define FINE_OFFSET 50
44 #define QTHETA_OFFSET 40
45
46 #define BITOVERFLOW 30000
47
48 #include "cwrs.h"
49
50 static inline int get_pulses(int i)
51 {
52    return i<8 ? i : (8 + (i&7)) << ((i>>3)-1);
53 }
54
55 static inline int bits2pulses(const CELTMode *m, const celt_int16 *cache, int N, int bits)
56 {
57    int i;
58    int lo, hi;
59    
60    lo = 0;
61    hi = MAX_PSEUDO-1;
62    for (i=0;i<LOG_MAX_PSEUDO;i++)
63    {
64       int mid = (lo+hi)>>1;
65       /* OPT: Make sure this is implemented with a conditional move */
66       if (cache[mid] >= bits)
67          hi = mid;
68       else
69          lo = mid;
70    }
71    if (bits-cache[lo] <= cache[hi]-bits)
72       return lo;
73    else
74       return hi;
75    
76    lo = 0;
77    hi = MAX_PULSES-1;
78    
79 #if 0 /* Disabled until we can make that useful */
80    /* Use of more than MAX_PULSES is disabled until we are able to cwrs that decently */
81    if (bits > cache[MAX_PULSES-1] && N<=4)
82    {
83       /*int pulses;
84       pulses = 127;
85       while (16 + log2_frac(2*(pulses+1)*(pulses+1) + 1, 4) <= bits && pulses < 32767)
86          pulses++;*/
87       lo = 127;
88       switch (N)
89       {
90          case 3:
91             hi = 1024;
92             for (i=0;i<10;i++)
93             {
94                int pulses = (lo+hi)>>1;
95                if (log2_frac(((UMUL16_16(pulses,pulses)>>1)+1)>>1, 4) > bits)
96                   hi = pulses;
97                else
98                   lo = pulses;
99             }
100             break;
101          case 4:
102             hi = 1024;
103             for (i=0;i<10;i++)
104             {
105                int pulses = (lo+hi)>>1;
106                if (log2_frac((UMUL32(UMUL16_16(pulses,pulses)+2,pulses))/3<<3, 4) > bits)
107                   hi = pulses;
108                else
109                   lo = pulses;
110             }
111             break;
112       }
113       return lo;
114    }
115 #endif
116    /* Instead of using the "bisection condition" we use a fixed number of 
117    iterations because it should be faster */
118    /*while (hi-lo != 1)*/
119    for (i=0;i<LOG_MAX_PULSES;i++)
120    {
121       int mid = (lo+hi)>>1;
122       /* OPT: Make sure this is implemented with a conditional move */
123       if (cache[mid] >= bits)
124          hi = mid;
125       else
126          lo = mid;
127    }
128    if (bits-cache[lo] <= cache[hi]-bits)
129       return lo;
130    else
131       return hi;
132 }
133
134
135 static inline int pulses2bits(const celt_int16 *cache, int N, int pulses)
136 {
137 #if 0 /* Use of more than MAX_PULSES is disabled until we are able to cwrs that decently */
138    if (pulses > 127)
139    {
140       int bits;
141       switch (N)
142       {
143          case 3:
144             bits = log2_frac(((UMUL16_16(pulses,pulses)>>1)+1)>>1, 4);
145             break;
146          case 4:
147             bits = log2_frac((UMUL32(UMUL16_16(pulses,pulses)+2,pulses))/3<<3, 4);
148             break;
149       }
150       /*printf ("%d <- %d\n", bits, pulses);*/
151       return bits;
152    }
153 #endif
154    return cache[pulses];
155 }
156
157 /** Computes a cache of the pulses->bits mapping in each band */
158 celt_int16 **compute_alloc_cache(CELTMode *m, int C, int M);
159
160 /** Compute the pulse allocation, i.e. how many pulses will go in each
161   * band. 
162  @param m mode
163  @param offsets Requested increase or decrease in the number of bits for
164                 each band
165  @param total Number of bands
166  @param pulses Number of pulses per band (returned)
167  @return Total number of bits allocated
168 */
169 void compute_allocation(const CELTMode *m, int start, int *offsets, int total, int *pulses, int *ebits, int *fine_priority, int _C, int M);
170
171
172 #endif