Error handling in _create() functions
[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
41 #define MAX_FINE_BITS 8
42
43 #define BITRES 3
44 #define FINE_OFFSET 21
45 #define QTHETA_OFFSET 4
46 #define QTHETA_OFFSET_STEREO 4
47
48 #define BITOVERFLOW 30000
49
50 #include "cwrs.h"
51 #include "modes.h"
52
53 void compute_pulse_cache(CELTMode *m, int LM);
54
55 static inline int get_pulses(int i)
56 {
57    return i<8 ? i : (8 + (i&7)) << ((i>>3)-1);
58 }
59
60 static inline int bits2pulses(const CELTMode *m, int band, int LM, int bits)
61 {
62    int i;
63    int lo, hi;
64    const unsigned char *cache;
65
66    LM++;
67    cache = m->cache.bits + m->cache.index[LM*m->nbEBands+band];
68
69    lo = 0;
70    hi = cache[0];
71    bits--;
72    for (i=0;i<LOG_MAX_PSEUDO;i++)
73    {
74       int mid = (lo+hi+1)>>1;
75       /* OPT: Make sure this is implemented with a conditional move */
76       if (cache[mid] >= bits)
77          hi = mid;
78       else
79          lo = mid;
80    }
81    if (bits- (lo == 0 ? -1 : cache[lo]) <= cache[hi]-bits)
82       return lo;
83    else
84       return hi;
85 }
86
87 static inline int pulses2bits(const CELTMode *m, int band, int LM, int pulses)
88 {
89    const unsigned char *cache;
90
91    LM++;
92    cache = m->cache.bits + m->cache.index[LM*m->nbEBands+band];
93    return pulses == 0 ? 0 : cache[pulses]+1;
94 }
95
96 /** Computes a cache of the pulses->bits mapping in each band */
97 celt_int16 **compute_alloc_cache(CELTMode *m, int M);
98
99 /** Compute the pulse allocation, i.e. how many pulses will go in each
100   * band. 
101  @param m mode
102  @param offsets Requested increase or decrease in the number of bits for
103                 each band
104  @param total Number of bands
105  @param pulses Number of pulses per band (returned)
106  @return Total number of bits allocated
107 */
108 int compute_allocation(const CELTMode *m, int start, int end, const int *offsets, int alloc_trim, int *intensity, int *dual_stero,
109       int total, int *pulses, int *ebits, int *fine_priority, int _C, int LM, void *ec, int encode, int prev);
110
111
112 #endif