fixed-point: masking curve computation now converted. ***Fixed a bug in the
[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] = Q15ONE*pow(.1f, deriv);
67       /* decay corresponding to -25dB/Bark */
68       decay->decayL[i] = Q15ONE*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, celt_word32_t *psd, celt_mask_t *mask, int len)
80 {
81    int i;
82    celt_word32_t 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] = MULT16_32_Q15(Q15ONE-d->decayR[i],psd[i]) + MULT16_32_Q15(d->decayR[i],mem);
89       if (mask[i]<1)
90          mask[i]=1;
91       mem = mask[i];
92    }
93    /* Compute left slope (-25 dB/Bark) */
94    mem=mask[len-1];
95    for (i=len-1;i>=0;i--)
96    {
97       mask[i] = MULT16_32_Q15(Q15ONE-d->decayL[i],mask[i]) + MULT16_32_Q15(d->decayL[i],mem);
98       if (mask[i]<1)
99          mask[i]=1;
100       mem = mask[i];
101    }
102    /*for (i=0;i<len;i++) printf ("%f ", mask[i]); printf ("\n");*/
103 #if 0 /* Prints signal and mask energy per critical band */
104    for (i=0;i<25;i++)
105    {
106       int start,end;
107       int j;
108       float Esig=0, Emask=0;
109       start = (int)floor(fromBARK((float)i)*(2*len)/Fs);
110       if (start<0)
111          start = 0;
112       end = (int)ceil(fromBARK((float)(i+1))*(2*len)/Fs);
113       if (end<=start)
114          end = start+1;
115       if (end>len-1)
116          end = len-1;
117       for (j=start;j<end;j++)
118       {
119          Esig += psd[j];
120          Emask += mask[j];
121       }
122       printf ("%f %f ", Esig, Emask);
123    }
124    printf ("\n");
125 #endif
126 }
127
128 /* Compute a marking threshold from the spectrum X. */
129 void compute_masking(struct PsyDecay *decay, celt_word32_t *X, celt_mask_t *mask, int len)
130 {
131    int i;
132    VARDECL(celt_word32_t *psd);
133    int N;
134    SAVE_STACK;
135    N=len/2;
136    ALLOC(psd, N, celt_word32_t);
137    psd[0] = MULT16_16(ROUND(X[0],SIG_SHIFT), ROUND(X[0],SIG_SHIFT));
138    for (i=1;i<N;i++)
139       psd[i] = ADD32(MULT16_16(ROUND(X[i*2],SIG_SHIFT), ROUND(X[i*2],SIG_SHIFT)),
140                      MULT16_16(ROUND(X[i*2+1],SIG_SHIFT), ROUND(X[i*2+1],SIG_SHIFT)));
141    /* TODO: Do tone masking */
142    /* Noise masking */
143    spreading_func(decay, psd, mask, N);
144    RESTORE_STACK;  
145 }
146
147 #if 0 /* Not needed for now, but will be useful in the future */
148 void compute_mdct_masking(struct PsyDecay *decay, celt_word32_t *X, celt_mask_t *mask, int len)
149 {
150    int i;
151    VARDECL(float *psd);
152    SAVE_STACK;
153    ALLOC(psd, len, float);
154    for (i=0;i<len;i++)
155       mask[i] = X[i]*X[i];
156    for (i=1;i<len-1;i++)
157       psd[i] = .5*mask[i] + .25*(mask[i-1]+mask[i+1]);
158    /*psd[0] = .5*mask[0]+.25*(mask[1]+mask[2]);*/
159    psd[0] = .5*mask[0]+.5*mask[1];
160    psd[len-1] = .5*(mask[len-1]+mask[len-2]);
161    /* TODO: Do tone masking */
162    /* Noise masking */
163    spreading_func(decay, psd, mask, len);
164    RESTORE_STACK;  
165 }
166 #endif