Rework coarse energy coding.
[opus.git] / libcelt / laplace.c
1 /* Copyright (c) 2007 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 #ifdef HAVE_CONFIG_H
34 #include "config.h"
35 #endif
36
37 #include "laplace.h"
38 #include "mathops.h"
39
40 /* The minimum probability of an energy delta (out of 32768). */
41 #define LAPLACE_LOG_MINP (0)
42 #define LAPLACE_MINP (1<<LAPLACE_LOG_MINP)
43 /* The minimum number of guaranteed representable energy deltas (in one
44     direction). */
45 #define LAPLACE_NMIN (16)
46
47 int ec_laplace_get_start_freq(int decay)
48 {
49    celt_uint32 ft = 32768 - LAPLACE_MINP*(2*LAPLACE_NMIN+1);
50    int fs = (ft*(16384-decay))/(16384+decay);
51    return fs+LAPLACE_MINP;
52 }
53
54 static int ec_laplace_get_freq1(int fs0, int decay)
55 {
56    celt_int32 ft;
57    ft = 32768 - LAPLACE_MINP*(2*LAPLACE_NMIN) - fs0;
58    return ft*(16384-decay)>>15;
59 }
60
61 void ec_laplace_encode_start(ec_enc *enc, int *value, int decay, int fs)
62 {
63    unsigned fl;
64    int val = *value;
65    fl = 0;
66    if (val)
67    {
68       int s;
69       int i;
70       s = -(val<0);
71       val = val+s^s;
72       fl = fs;
73       fs = ec_laplace_get_freq1(fs, decay);
74       /* Search the decaying part of the PDF.*/
75       for (i=1; fs > 0 && i < val; i++)
76       {
77          fs *= 2;
78          fl += fs+2*LAPLACE_MINP;
79          fs = (fs*(celt_int32)decay)>>15;
80       }
81       /* Everything beyond that has probability LAPLACE_MINP. */
82       if (fs <= 0)
83       {
84          int di;
85          int di_max;
86          di_max = (32768-fl+LAPLACE_MINP-1)>>LAPLACE_LOG_MINP;
87          di_max = (di_max-s)>>1;
88          di = IMIN(val - i, di_max);
89          fl += (2*di+1+s)*LAPLACE_MINP;
90          fs = IMIN(LAPLACE_MINP, 32768-fl);
91          *value = i+di+s^s;
92       }
93       else
94       {
95          fs += LAPLACE_MINP;
96          fl += fs&~s;
97       }
98       celt_assert(fl+fs<=32768);
99       celt_assert(fs>0);
100    }
101    ec_encode_bin(enc, fl, fl+fs, 15);
102 }
103
104
105 void ec_laplace_encode(ec_enc *enc, int *value, int decay)
106 {
107    int fs = ec_laplace_get_start_freq(decay);
108    ec_laplace_encode_start(enc, value, decay, fs);
109 }
110
111
112 int ec_laplace_decode_start(ec_dec *dec, int decay, int fs)
113 {
114    int val=0;
115    unsigned fl;
116    int fm;
117    fm = ec_decode_bin(dec, 15);
118    fl = 0;
119    if (fm >= fs)
120    {
121       val++;
122       fl = fs;
123       fs = ec_laplace_get_freq1(fs, decay)+LAPLACE_MINP;
124       /* Search the decaying part of the PDF.*/
125       while(fs > LAPLACE_MINP && fm >= fl+2*fs)
126       {
127          fs *= 2;
128          fl += fs;
129          fs = ((fs-2*LAPLACE_MINP)*(celt_int32)decay)>>15;
130          fs += LAPLACE_MINP;
131          val++;
132       }
133       /* Everything beyond that has probability LAPLACE_MINP. */
134       if (fs <= LAPLACE_MINP)
135       {
136          int di;
137          di = (fm-fl)>>(LAPLACE_LOG_MINP+1);
138          val += di;
139          fl += 2*di*LAPLACE_MINP;
140       }
141       if (fm < fl+fs)
142          val = -val;
143       else
144          fl += fs;
145    }
146    celt_assert(fl<32768);
147    celt_assert(fs>0);
148    celt_assert(fl<=fm);
149    celt_assert(fm<IMIN(fl+fs,32768));
150    ec_dec_update(dec, fl, IMIN(fl+fs,32768), 32768);
151    return val;
152 }
153
154 int ec_laplace_decode(ec_dec *dec, int decay)
155 {
156    int fs = ec_laplace_get_start_freq(decay);
157    return ec_laplace_decode_start(dec, decay, fs);
158 }