fixed-point: unquant_energy_mono() has received the fixed-point code from
[opus.git] / libcelt / psy.c
1 /* (C) 2007 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 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35
36 #include "psy.h"
37 #include <math.h>
38 #include "os_support.h"
39 #include "arch.h"
40
41 /* The Vorbis freq<->Bark mapping */
42 #define toBARK(n)   (13.1f*atan(.00074f*(n))+2.24f*atan((n)*(n)*1.85e-8f)+1e-4f*(n))
43 #define fromBARK(z) (102.f*(z)-2.f*pow(z,2.f)+.4f*pow(z,3.f)+pow(1.46f,z)-1.f)
44
45
46 /* Psychoacoustic spreading function. The idea here is compute a first order 
47    recursive filter. The filter coefficient is frequency dependent and 
48    chosen such that we have a -10dB/Bark slope on the right side and a -25dB/Bark
49    slope on the left side. */
50 void psydecay_init(struct PsyDecay *decay, int len, celt_int32_t Fs)
51 {
52    int i;
53    decay->decayR = celt_alloc(sizeof(float)*len);
54    decay->decayL = celt_alloc(sizeof(float)*len);
55    for (i=0;i<len;i++)
56    {
57       float f;
58       float deriv;
59       /* Real frequency (in Hz) */
60       f = Fs*i*(1/(2.f*len));
61       /* This is the derivative of the Vorbis freq->Bark function (see above) */
62       deriv = (8.288e-8 * f)/(3.4225e-16 *f*f*f*f + 1) +  .009694/(5.476e-7 *f*f + 1) + 1e-4;
63       /* Back to FFT bin units */
64       deriv *= Fs*(1/(2.f*len));
65       /* decay corresponding to -10dB/Bark */
66       decay->decayR[i] = pow(.1f, deriv);
67       /* decay corresponding to -25dB/Bark */
68       decay->decayL[i] = pow(0.0031623f, deriv);
69       /*printf ("%f %f\n", decayL[i], decayR[i]);*/
70    }
71 }
72
73 void psydecay_clear(struct PsyDecay *decay)
74 {
75    celt_free(decay->decayR);
76    celt_free(decay->decayL);
77 }
78
79 static void spreading_func(struct PsyDecay *d, float *psd, celt_mask_t *mask, int len)
80 {
81    int i;
82    float mem;
83    /*for (i=0;i<len;i++) printf ("%f ", psd[i]);*/
84    /* Compute right slope (-10 dB/Bark) */
85    mem=psd[0];
86    for (i=0;i<len;i++)
87    {
88       mask[i] = (1-d->decayR[i])*psd[i] + d->decayR[i]*mem;
89       mem = mask[i];
90    }
91    /* Compute left slope (-25 dB/Bark) */
92    mem=mask[len-1];
93    for (i=len-1;i>=0;i--)
94    {
95       mask[i] = (1-d->decayR[i])*mask[i] + d->decayL[i]*mem;
96       mem = mask[i];
97    }
98    /*for (i=0;i<len;i++) printf ("%f ", mask[i]); printf ("\n");*/
99 #if 0 /* Prints signal and mask energy per critical band */
100    for (i=0;i<25;i++)
101    {
102       int start,end;
103       int j;
104       float Esig=0, Emask=0;
105       start = (int)floor(fromBARK((float)i)*(2*len)/Fs);
106       if (start<0)
107          start = 0;
108       end = (int)ceil(fromBARK((float)(i+1))*(2*len)/Fs);
109       if (end<=start)
110          end = start+1;
111       if (end>len-1)
112          end = len-1;
113       for (j=start;j<end;j++)
114       {
115          Esig += psd[j];
116          Emask += mask[j];
117       }
118       printf ("%f %f ", Esig, Emask);
119    }
120    printf ("\n");
121 #endif
122 }
123
124 /* Compute a marking threshold from the spectrum X. */
125 void compute_masking(struct PsyDecay *decay, celt_word32_t *X, celt_mask_t *mask, int len)
126 {
127    int i;
128    VARDECL(float *psd);
129    int N=len/2;
130    ALLOC(psd, N, float);
131    psd[0] = X[0]*1.f*X[0];
132    for (i=1;i<N;i++)
133       psd[i] = X[i*2]*1.f*X[i*2] + X[i*2+1]*1.f*X[i*2+1];
134    /* TODO: Do tone masking */
135    /* Noise masking */
136    spreading_func(decay, psd, mask, N);
137    
138 }
139
140 void compute_mdct_masking(struct PsyDecay *decay, celt_word32_t *X, celt_mask_t *mask, int len)
141 {
142    int i;
143    VARDECL(float *psd);
144    ALLOC(psd, len, float);
145    for (i=0;i<len;i++)
146       mask[i] = X[i]*X[i];
147    for (i=1;i<len-1;i++)
148       psd[i] = .5*mask[i] + .25*(mask[i-1]+mask[i+1]);
149    /*psd[0] = .5*mask[0]+.25*(mask[1]+mask[2]);*/
150    psd[0] = .5*mask[0]+.5*mask[1];
151    psd[len-1] = .5*(mask[len-1]+mask[len-2]);
152    /* TODO: Do tone masking */
153    /* Noise masking */
154    spreading_func(decay, psd, mask, len);
155    
156 }