Comments/cleanup, no code change
[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
36 #include "modes.h"
37 #include "entenc.h"
38 #include "entdec.h"
39
40 /** Compute the amplitude (sqrt energy) in each of the bands 
41  * @param m Mode data 
42  * @param X Spectrum
43  * @param bands Square root of the energy for each band (returned)
44  */
45 void compute_band_energies(const CELTMode *m, float *X, float *bands);
46
47 /** Normalise each band of X such that the energy in each band is 
48     equal to 1
49  * @param m Mode data 
50  * @param X Spectrum (returned normalised)
51  * @param bands Square root of the energy for each band
52  */
53 void normalise_bands(const CELTMode *m, float *X, float *bands);
54
55 /** Denormalise each band of X to restore full amplitude
56  * @param m Mode data 
57  * @param X Spectrum (returned de-normalised)
58  * @param bands Square root of the energy for each band
59  */
60 void denormalise_bands(const CELTMode *m, float *X, float *bands);
61
62 /** Compute the pitch predictor gain for each pitch band
63  * @param m Mode data 
64  * @param X Spectrum to predict
65  * @param P Pitch vector (normalised)
66  * @param gains Gain computed for each pitch band (returned)
67  * @param bank Square root of the energy for each band
68  */
69 void compute_pitch_gain(const CELTMode *m, float *X, float *P, float *gains, float *bank);
70
71 void pitch_quant_bands(const CELTMode *m, float *X, float *P, float *gains);
72
73 /** Quantisation/encoding of the residual spectrum
74  * @param m Mode data 
75  * @param X Residual (normalised)
76  * @param P Pitch vector (normalised)
77  * @param W Perceptual weighting
78  * @param enc Entropy encoder
79  */
80 void quant_bands(const CELTMode *m, float *X, float *P, float *W, ec_enc *enc);
81
82 /** Decoding of the residual spectrum
83  * @param m Mode data 
84  * @param X Residual (normalised)
85  * @param P Pitch vector (normalised)
86  * @param dec Entropy decoder
87 */
88 void unquant_bands(const CELTMode *m, float *X, float *P, ec_dec *dec);
89
90 #endif /* BANDS_H */