Changed the pulse spreading rotations so that the number of iterations is
[opus.git] / libcelt / bands.h
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 #ifndef BANDS_H
33 #define BANDS_H
34
35 #include "arch.h"
36 #include "modes.h"
37 #include "entenc.h"
38 #include "entdec.h"
39 #include "rate.h"
40
41 /** Applies a series of rotations so that pulses are spread like a two-sided
42 exponential. The effect of this is to reduce the tonal noise created by the
43 sparse spectrum resulting from the pulse codebook */
44 void exp_rotation(celt_norm_t *X, int len, int dir, int stride, int iter);
45
46 /** Normalise each band of X such that the energy in each band is 
47     equal to 1
48  * @param m Mode data 
49  * @param X Spectrum (returned normalised)
50  * @param bands Square root of the energy for each band
51  */
52 void normalise_bands(const CELTMode *m, const celt_sig_t *freq, celt_norm_t *X, celt_ener_t *bands);
53
54 void renormalise_bands(const CELTMode *m, celt_norm_t *X);
55
56 /** Denormalise each band of X to restore full amplitude
57  * @param m Mode data 
58  * @param X Spectrum (returned de-normalised)
59  * @param bands Square root of the energy for each band
60  */
61 void denormalise_bands(const CELTMode *m, const celt_norm_t *X, celt_sig_t *freq, const celt_ener_t *bands);
62
63 /** Compute the pitch predictor gain for each pitch band
64  * @param m Mode data 
65  * @param X Spectrum to predict
66  * @param P Pitch vector (normalised)
67  * @param gains Gain computed for each pitch band (returned)
68  * @param bank Square root of the energy for each band
69  */
70 void compute_pitch_gain(const CELTMode *m, const celt_norm_t *X, const celt_norm_t *P, celt_pgain_t *gains);
71
72 void pitch_quant_bands(const CELTMode *m, celt_norm_t *P, const celt_pgain_t *gains);
73
74 /** Quantisation/encoding of the residual spectrum
75  * @param m Mode data 
76  * @param X Residual (normalised)
77  * @param P Pitch vector (normalised)
78  * @param W Perceptual weighting
79  * @param total_bits Total number of bits that can be used for the frame (including the ones already spent)
80  * @param enc Entropy encoder
81  */
82 void quant_bands(const CELTMode *m, celt_norm_t *X, celt_norm_t *P, celt_mask_t *W, int total_bits, ec_enc *enc);
83
84 /** Decoding of the residual spectrum
85  * @param m Mode data 
86  * @param X Residual (normalised)
87  * @param P Pitch vector (normalised)
88  * @param total_bits Total number of bits that can be used for the frame (including the ones already spent)
89  * @param dec Entropy decoder
90 */
91 void unquant_bands(const CELTMode *m, celt_norm_t *X, celt_norm_t *P, int total_bits, ec_dec *dec);
92
93 void stereo_mix(const CELTMode *m, celt_norm_t *X, const celt_ener_t *bank, int dir);
94
95 #endif /* BANDS_H */