Miscellaneous comment, copyright notice, readme updates.
[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 /** Compute the amplitude (sqrt energy) in each of the bands 
42  * @param m Mode data 
43  * @param X Spectrum
44  * @param bands Square root of the energy for each band (returned)
45  */
46 void compute_band_energies(const CELTMode *m, const celt_sig_t *X, celt_ener_t *bands);
47
48 void compute_noise_energies(const CELTMode *m, const celt_sig_t *X, const celt_word16_t *tonality, celt_ener_t *bank);
49
50 /** Normalise each band of X such that the energy in each band is 
51     equal to 1
52  * @param m Mode data 
53  * @param X Spectrum (returned normalised)
54  * @param bands Square root of the energy for each band
55  */
56 void normalise_bands(const CELTMode *m, const celt_sig_t * restrict freq, celt_norm_t * restrict X, const celt_ener_t *bands);
57
58 void renormalise_bands(const CELTMode *m, celt_norm_t * restrict X);
59
60 /** Denormalise each band of X to restore full amplitude
61  * @param m Mode data 
62  * @param X Spectrum (returned de-normalised)
63  * @param bands Square root of the energy for each band
64  */
65 void denormalise_bands(const CELTMode *m, const celt_norm_t * restrict X, celt_sig_t * restrict freq, const celt_ener_t *bands);
66
67 /** Compute the pitch predictor gain for each pitch band
68  * @param m Mode data 
69  * @param X Spectrum to predict
70  * @param P Pitch vector (normalised)
71  * @param gains Gain computed for each pitch band (returned)
72  * @param bank Square root of the energy for each band
73  */
74 int compute_pitch_gain(const CELTMode *m, const celt_norm_t *X, const celt_norm_t *P, celt_pgain_t *gains);
75
76 /** Quantisation/encoding of the residual spectrum
77  * @param m Mode data 
78  * @param X Residual (normalised)
79  * @param P Pitch vector (normalised)
80  * @param W Perceptual weighting
81  * @param total_bits Total number of bits that can be used for the frame (including the ones already spent)
82  * @param enc Entropy encoder
83  */
84 void quant_bands(const CELTMode *m, celt_norm_t * restrict X, celt_norm_t *P, celt_mask_t *W, int pitch_used, celt_pgain_t *pgains, const celt_ener_t *bandE, const int *stereo_mode, int *pulses, int time_domain, int fold, int total_bits, ec_enc *enc);
85
86 /** Decoding of the residual spectrum
87  * @param m Mode data 
88  * @param X Residual (normalised)
89  * @param P Pitch vector (normalised)
90  * @param total_bits Total number of bits that can be used for the frame (including the ones already spent)
91  * @param dec Entropy decoder
92 */
93 void unquant_bands(const CELTMode *m, celt_norm_t * restrict X, celt_norm_t *P, int pitch_used, celt_pgain_t *pgains, const celt_ener_t *bandE, const int *stereo_mode, int *pulses, int time_domain, int fold, int total_bits, ec_dec *dec);
94
95 void stereo_decision(const CELTMode *m, celt_norm_t * restrict X, int *stereo_mode, int len);
96
97 #endif /* BANDS_H */