Adds 3rd clause to CELT license
[opus.git] / celt / bands.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2008-2009 Gregory Maxwell
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /*
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16
17    - Neither the name of Internet Society, IETF or IETF Trust, nor the
18    names of specific contributors, may be used to endorse or promote
19    products derived from this software without specific prior written
20    permission.
21
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
26    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef BANDS_H
36 #define BANDS_H
37
38 #include "arch.h"
39 #include "modes.h"
40 #include "entenc.h"
41 #include "entdec.h"
42 #include "rate.h"
43
44 /** Compute the amplitude (sqrt energy) in each of the bands
45  * @param m Mode data
46  * @param X Spectrum
47  * @param bands Square root of the energy for each band (returned)
48  */
49 void compute_band_energies(const CELTMode *m, const celt_sig *X, celt_ener *bandE, int end, int C, int M);
50
51 /*void compute_noise_energies(const CELTMode *m, const celt_sig *X, const opus_val16 *tonality, celt_ener *bandE);*/
52
53 /** Normalise each band of X such that the energy in each band is
54     equal to 1
55  * @param m Mode data
56  * @param X Spectrum (returned normalised)
57  * @param bands Square root of the energy for each band
58  */
59 void normalise_bands(const CELTMode *m, const celt_sig * restrict freq, celt_norm * restrict X, const celt_ener *bandE, int end, int C, int M);
60
61 /** Denormalise each band of X to restore full amplitude
62  * @param m Mode data
63  * @param X Spectrum (returned de-normalised)
64  * @param bands Square root of the energy for each band
65  */
66 void denormalise_bands(const CELTMode *m, const celt_norm * restrict X, celt_sig * restrict freq, const celt_ener *bandE, int end, int C, int M);
67
68 #define SPREAD_NONE       (0)
69 #define SPREAD_LIGHT      (1)
70 #define SPREAD_NORMAL     (2)
71 #define SPREAD_AGGRESSIVE (3)
72
73 int spreading_decision(const CELTMode *m, celt_norm *X, int *average,
74       int last_decision, int *hf_average, int *tapset_decision, int update_hf,
75       int end, int C, int M);
76
77 #ifdef MEASURE_NORM_MSE
78 void measure_norm_mse(const CELTMode *m, float *X, float *X0, float *bandE, float *bandE0, int M, int N, int C);
79 #endif
80
81 void haar1(celt_norm *X, int N0, int stride);
82
83 /** Quantisation/encoding of the residual spectrum
84  * @param m Mode data
85  * @param X Residual (normalised)
86  * @param total_bits Total number of bits that can be used for the frame (including the ones already spent)
87  * @param enc Entropy encoder
88  */
89 void quant_all_bands(int encode, const CELTMode *m, int start, int end,
90       celt_norm * X, celt_norm * Y, unsigned char *collapse_masks, const celt_ener *bandE, int *pulses,
91       int time_domain, int fold, int dual_stereo, int intensity, int *tf_res,
92       opus_int32 total_bits, opus_int32 balance, ec_ctx *ec, int M, int codedBands, opus_uint32 *seed);
93
94 void anti_collapse(const CELTMode *m, celt_norm *X_, unsigned char *collapse_masks, int LM, int C, int size,
95       int start, int end, opus_val16 *logE, opus_val16 *prev1logE,
96       opus_val16 *prev2logE, int *pulses, opus_uint32 seed);
97
98 opus_uint32 celt_lcg_rand(opus_uint32 seed);
99
100 #endif /* BANDS_H */