encoder pre-emphasis now in 16-bits
[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 #ifndef STATIC_MODES
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    celt_word16_t *decayR = (celt_word16_t*)celt_alloc(sizeof(celt_word16_t)*len);
54    /*decay->decayL = celt_alloc(sizeof(celt_word16_t)*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       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    decay->decayR = decayR;
72 }
73
74 void psydecay_clear(struct PsyDecay *decay)
75 {
76    celt_free((celt_word16_t *)decay->decayR);
77    /*celt_free(decay->decayL);*/
78 }
79 #endif
80
81 static void spreading_func(const struct PsyDecay *d, celt_word32_t * restrict psd, int len)
82 {
83    int i;
84    celt_word32_t mem;
85    /*for (i=0;i<len;i++) printf ("%f ", psd[i]);*/
86    /* Compute right slope (-10 dB/Bark) */
87    mem=psd[0];
88    for (i=0;i<len;i++)
89    {
90       /* psd = (1-decay)*psd + decay*mem */
91       psd[i] = EPSILON + psd[i] + MULT16_32_Q15(d->decayR[i],mem-psd[i]);
92       mem = psd[i];
93    }
94    /* Compute left slope (-25 dB/Bark) */
95    mem=psd[len-1];
96    for (i=len-1;i>=0;i--)
97    {
98       /* Left side has around twice the slope as the right side, so we just
99          square the coef instead of storing two sets of decay coefs */
100       celt_word16_t decayL = MULT16_16_Q15(d->decayR[i], d->decayR[i]);
101       /* psd = (1-decay)*psd + decay*mem */
102       psd[i] = EPSILON + psd[i] + MULT16_32_Q15(decayL,mem-psd[i]);
103       mem = psd[i];
104    }
105    /*for (i=0;i<len;i++) printf ("%f ", mask[i]); printf ("\n");*/
106 #if 0 /* Prints signal and mask energy per critical band */
107    for (i=0;i<25;i++)
108    {
109       int start,end;
110       int j;
111       celt_word32_t Esig=0, Emask=0;
112       start = (int)floor(fromBARK((float)i)*(2*len)/Fs);
113       if (start<0)
114          start = 0;
115       end = (int)ceil(fromBARK((float)(i+1))*(2*len)/Fs);
116       if (end<=start)
117          end = start+1;
118       if (end>len-1)
119          end = len-1;
120       for (j=start;j<end;j++)
121       {
122          Esig += psd[j];
123          Emask += mask[j];
124       }
125       printf ("%f %f ", Esig, Emask);
126    }
127    printf ("\n");
128 #endif
129 }
130
131 /* Compute a marking threshold from the spectrum X. */
132 void compute_masking(const struct PsyDecay *decay, celt_word16_t *X, celt_mask_t * restrict mask, int len)
133 {
134    int i;
135    int N;
136    N=len>>1;
137    mask[0] = MULT16_16(X[0], X[0]);
138    for (i=1;i<N;i++)
139       mask[i] = ADD32(MULT16_16(X[i*2], X[i*2]), MULT16_16(X[i*2+1], X[i*2+1]));
140    /* TODO: Do tone masking */
141    /* Noise masking */
142    spreading_func(decay, mask, N);
143 }
144
145 #if 0 /* Not needed for now, but will be useful in the future */
146 void compute_mdct_masking(const struct PsyDecay *decay, celt_word32_t *X, celt_mask_t *mask, int len)
147 {
148    int i;
149    VARDECL(float *psd);
150    SAVE_STACK;
151    ALLOC(psd, len, float);
152    for (i=0;i<len;i++)
153       mask[i] = X[i]*X[i];
154    for (i=1;i<len-1;i++)
155       psd[i] = .5*mask[i] + .25*(mask[i-1]+mask[i+1]);
156    /*psd[0] = .5*mask[0]+.25*(mask[1]+mask[2]);*/
157    psd[0] = .5*mask[0]+.5*mask[1];
158    psd[len-1] = .5*(mask[len-1]+mask[len-2]);
159    /* TODO: Do tone masking */
160    /* Noise masking */
161    spreading_func(decay, psd, mask, len);
162    RESTORE_STACK;  
163 }
164 #endif