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