removed useless comments
[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 #include "stack_alloc.h"
41 #include "mathops.h"
42
43 /* The Vorbis freq<->Bark mapping */
44 #define toBARK(n)   (13.1f*atan(.00074f*(n))+2.24f*atan((n)*(n)*1.85e-8f)+1e-4f*(n))
45 #define fromBARK(z) (102.f*(z)-2.f*pow(z,2.f)+.4f*pow(z,3.f)+pow(1.46f,z)-1.f)
46
47 #ifndef STATIC_MODES
48 /* Psychoacoustic spreading function. The idea here is compute a first order 
49    recursive filter. The filter coefficient is frequency dependent and 
50    chosen such that we have a -10dB/Bark slope on the right side and a -25dB/Bark
51    slope on the left side. */
52 void psydecay_init(struct PsyDecay *decay, int len, celt_int32_t Fs)
53 {
54    int i;
55    celt_word16_t *decayR = (celt_word16_t*)celt_alloc(sizeof(celt_word16_t)*len);
56    decay->decayR = decayR;
57    if (decayR==NULL)
58      return;
59    for (i=0;i<len;i++)
60    {
61       float f;
62       float deriv;
63       /* Real frequency (in Hz) */
64       f = Fs*i*(1/(2.f*len));
65       /* This is the derivative of the Vorbis freq->Bark function (see above) */
66       deriv = (8.288e-8 * f)/(3.4225e-16 *f*f*f*f + 1) +  .009694/(5.476e-7 *f*f + 1) + 1e-4;
67       /* Back to FFT bin units */
68       deriv *= Fs*(1/(2.f*len));
69       /* decay corresponding to -10dB/Bark */
70       decayR[i] = Q15ONE*pow(.1f, deriv);
71       /* decay corresponding to -25dB/Bark */
72       /*decay->decayL[i] = Q15ONE*pow(0.0031623f, deriv);*/
73       /*printf ("%f %f\n", decayL[i], decayR[i]);*/
74    }
75 }
76
77 void psydecay_clear(struct PsyDecay *decay)
78 {
79    celt_free((celt_word16_t *)decay->decayR);
80    /*celt_free(decay->decayL);*/
81 }
82 #endif
83
84 static void spreading_func(const struct PsyDecay *d, celt_word32_t * restrict psd, int len)
85 {
86    int i;
87    celt_word32_t mem;
88    /* Compute right slope (-10 dB/Bark) */
89    mem=psd[0];
90    for (i=0;i<len;i++)
91    {
92       /* psd = (1-decay)*psd + decay*mem */
93       psd[i] = EPSILON + psd[i] + MULT16_32_Q15(d->decayR[i],mem-psd[i]);
94       mem = psd[i];
95    }
96    /* Compute left slope (-25 dB/Bark) */
97    mem=psd[len-1];
98    for (i=len-1;i>=0;i--)
99    {
100       /* Left side has around twice the slope as the right side, so we just
101          square the coef instead of storing two sets of decay coefs */
102       celt_word16_t decayL = MULT16_16_Q15(d->decayR[i], d->decayR[i]);
103       /* psd = (1-decay)*psd + decay*mem */
104       psd[i] = EPSILON + psd[i] + MULT16_32_Q15(decayL,mem-psd[i]);
105       mem = psd[i];
106    }
107 #if 0 /* Prints signal and mask energy per critical band */
108    for (i=0;i<25;i++)
109    {
110       int start,end;
111       int j;
112       celt_word32_t Esig=0, Emask=0;
113       start = (int)floor(fromBARK((float)i)*(2*len)/Fs);
114       if (start<0)
115          start = 0;
116       end = (int)ceil(fromBARK((float)(i+1))*(2*len)/Fs);
117       if (end<=start)
118          end = start+1;
119       if (end>len-1)
120          end = len-1;
121       for (j=start;j<end;j++)
122       {
123          Esig += psd[j];
124          Emask += mask[j];
125       }
126       printf ("%f %f ", Esig, Emask);
127    }
128    printf ("\n");
129 #endif
130 }
131
132 /* Compute a marking threshold from the spectrum X. */
133 void compute_masking(const struct PsyDecay *decay, celt_word16_t *X, celt_mask_t * restrict mask, int len)
134 {
135    int i;
136    int N;
137    N=len>>1;
138    mask[0] = MULT16_16(X[0], X[0]);
139    for (i=1;i<N;i++)
140       mask[i] = ADD32(MULT16_16(X[i*2], X[i*2]), MULT16_16(X[i*2+1], X[i*2+1]));
141    /* TODO: Do tone masking */
142    /* Noise masking */
143    spreading_func(decay, mask, N);
144 }
145
146 #ifdef EXP_PSY /* Not needed for now, but will be useful in the future */
147 void compute_mdct_masking(const struct PsyDecay *decay, celt_word32_t *X, celt_word16_t *tonality, celt_word16_t *long_window, celt_mask_t *mask, int len)
148 {
149    int i;
150    VARDECL(float, psd);
151    SAVE_STACK;
152    ALLOC(psd, len, float);
153    for (i=0;i<len;i++)
154       psd[i] = X[i]*X[i]*tonality[i];
155    for (i=1;i<len-1;i++)
156       mask[i] = .5*psd[i] + .25*(psd[i-1]+psd[i+1]);
157    /*psd[0] = .5*mask[0]+.25*(mask[1]+mask[2]);*/
158    mask[0] = .5*psd[0]+.5*psd[1];
159    mask[len-1] = .5*(psd[len-1]+psd[len-2]);
160    /* TODO: Do tone masking */
161    /* Noise masking */
162    spreading_func(decay, mask, len);
163    RESTORE_STACK;  
164 }
165
166 void compute_tonality(const CELTMode *m, celt_word16_t * restrict X, celt_word16_t * mem, int len, celt_word16_t *tonality, int mdct_size)
167 {
168    int i;
169    celt_word16_t norm_1;
170    celt_word16_t *mem2;
171    int N = len>>2;
172
173    mem2 = mem+2*N;
174    X[0] = 0;
175    X[1] = 0;
176    tonality[0] = 1;
177    for (i=1;i<N;i++)
178    {
179       celt_word16_t re, im, re2, im2;
180       re = X[2*i];
181       im = X[2*i+1];
182       /* Normalise spectrum */
183       norm_1 = celt_rsqrt(.01+MAC16_16(MULT16_16(re,re), im,im));
184       re = MULT16_16(re, norm_1);
185       im = MULT16_16(im, norm_1);
186       /* Phase derivative */
187       re2 = re*mem[2*i] + im*mem[2*i+1];
188       im2 = im*mem[2*i] - re*mem[2*i+1];
189       mem[2*i] = re;
190       mem[2*i+1] = im;
191       /* Phase second derivative */
192       re = re2*mem2[2*i] + im2*mem2[2*i+1];
193       im = im2*mem2[2*i] - re2*mem2[2*i+1];
194       mem2[2*i] = re2;
195       mem2[2*i+1] = im2;
196       /*printf ("%f ", re);*/
197       X[2*i] = re;
198       X[2*i+1] = im;
199    }
200    /*printf ("\n");*/
201    for (i=0;i<mdct_size;i++)
202    {
203       tonality[i] = 1.0-X[2*i]*X[2*i]*X[2*i];
204       if (tonality[i]>1)
205          tonality[i] = 1;
206       if (tonality[i]<.02)
207          tonality[i]=.02;
208    }
209 }
210 #endif