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