Adds 3rd clause to CELT license
[opus.git] / celt / 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 Internet Society, IETF or IETF Trust, nor the
17    names of specific contributors, may be used to endorse or promote
18    products derived from this software without specific prior written
19    permission.
20
21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
25    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef RATE_H
35 #define RATE_H
36
37 #define MAX_PSEUDO 40
38 #define LOG_MAX_PSEUDO 6
39
40 #define MAX_PULSES 128
41
42 #define MAX_FINE_BITS 8
43
44 #define FINE_OFFSET 21
45 #define QTHETA_OFFSET 4
46 #define QTHETA_OFFSET_TWOPHASE 16
47
48 #include "cwrs.h"
49 #include "modes.h"
50
51 void compute_pulse_cache(CELTMode *m, int LM);
52
53 static inline int get_pulses(int i)
54 {
55    return i<8 ? i : (8 + (i&7)) << ((i>>3)-1);
56 }
57
58 static inline int bits2pulses(const CELTMode *m, int band, int LM, int bits)
59 {
60    int i;
61    int lo, hi;
62    const unsigned char *cache;
63
64    LM++;
65    cache = m->cache.bits + m->cache.index[LM*m->nbEBands+band];
66
67    lo = 0;
68    hi = cache[0];
69    bits--;
70    for (i=0;i<LOG_MAX_PSEUDO;i++)
71    {
72       int mid = (lo+hi+1)>>1;
73       /* OPT: Make sure this is implemented with a conditional move */
74       if (cache[mid] >= bits)
75          hi = mid;
76       else
77          lo = mid;
78    }
79    if (bits- (lo == 0 ? -1 : cache[lo]) <= cache[hi]-bits)
80       return lo;
81    else
82       return hi;
83 }
84
85 static inline int pulses2bits(const CELTMode *m, int band, int LM, int pulses)
86 {
87    const unsigned char *cache;
88
89    LM++;
90    cache = m->cache.bits + m->cache.index[LM*m->nbEBands+band];
91    return pulses == 0 ? 0 : cache[pulses]+1;
92 }
93
94 /** Compute the pulse allocation, i.e. how many pulses will go in each
95   * band.
96  @param m mode
97  @param offsets Requested increase or decrease in the number of bits for
98                 each band
99  @param total Number of bands
100  @param pulses Number of pulses per band (returned)
101  @return Total number of bits allocated
102 */
103 int compute_allocation(const CELTMode *m, int start, int end, const int *offsets, const int *cap, int alloc_trim, int *intensity, int *dual_stero,
104       opus_int32 total, opus_int32 *balance, int *pulses, int *ebits, int *fine_priority, int C, int LM, ec_ctx *ec, int encode, int prev);
105
106 #endif