Adds 3rd clause to CELT license
[opus.git] / celt / vq.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Written by Jean-Marc Valin */
4 /**
5    @file vq.h
6    @brief Vector quantisation of the residual
7  */
8 /*
9    Redistribution and use in source and binary forms, with or without
10    modification, are permitted provided that the following conditions
11    are met:
12
13    - Redistributions of source code must retain the above copyright
14    notice, this list of conditions and the following disclaimer.
15
16    - Redistributions in binary form must reproduce the above copyright
17    notice, this list of conditions and the following disclaimer in the
18    documentation and/or other materials provided with the distribution.
19
20    - Neither the name of Internet Society, IETF or IETF Trust, nor the
21    names of specific contributors, may be used to endorse or promote
22    products derived from this software without specific prior written
23    permission.
24
25    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
29    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 #ifndef VQ_H
39 #define VQ_H
40
41 #include "entenc.h"
42 #include "entdec.h"
43 #include "modes.h"
44
45 /** Algebraic pulse-vector quantiser. The signal x is replaced by the sum of
46   * the pitch and a combination of pulses such that its norm is still equal
47   * to 1. This is the function that will typically require the most CPU.
48  * @param x Residual signal to quantise/encode (returns quantised version)
49  * @param W Perceptual weight to use when optimising (currently unused)
50  * @param N Number of samples to encode
51  * @param K Number of pulses to use
52  * @param p Pitch vector (it is assumed that p+x is a unit vector)
53  * @param enc Entropy encoder state
54  * @ret A mask indicating which blocks in the band received pulses
55 */
56 unsigned alg_quant(celt_norm *X, int N, int K, int spread, int B,
57       ec_enc *enc
58 #ifdef RESYNTH
59       , opus_val16 gain
60 #endif
61       );
62
63 /** Algebraic pulse decoder
64  * @param x Decoded normalised spectrum (returned)
65  * @param N Number of samples to decode
66  * @param K Number of pulses to use
67  * @param p Pitch vector (automatically added to x)
68  * @param dec Entropy decoder state
69  * @ret A mask indicating which blocks in the band received pulses
70  */
71 unsigned alg_unquant(celt_norm *X, int N, int K, int spread, int B,
72       ec_dec *dec, opus_val16 gain);
73
74 void renormalise_vector(celt_norm *X, int N, opus_val16 gain);
75
76 int stereo_itheta(celt_norm *X, celt_norm *Y, int stereo, int N);
77
78 #endif /* VQ_H */