celt_mask_t for masking curves
[opus.git] / libcelt / vq.h
1 /* (C) 2007 Jean-Marc Valin, CSIRO
2 */
3 /**
4    @file vq.h
5    @brief Vector quantisation of the residual
6  */
7 /*
8    Redistribution and use in source and binary forms, with or without
9    modification, are permitted provided that the following conditions
10    are met:
11    
12    - Redistributions of source code must retain the above copyright
13    notice, this list of conditions and the following disclaimer.
14    
15    - Redistributions in binary form must reproduce the above copyright
16    notice, this list of conditions and the following disclaimer in the
17    documentation and/or other materials provided with the distribution.
18    
19    - Neither the name of the Xiph.org Foundation nor the names of its
20    contributors may be used to endorse or promote products derived from
21    this software without specific prior written permission.
22    
23    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
27    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
36 #ifndef VQ_H
37 #define VQ_H
38
39 #include "entenc.h"
40 #include "entdec.h"
41
42
43 /** Algebraic pulse-vector quantiser. The signal x is replaced by the sum of 
44   * the pitch and a combination of pulses such that its norm is still equal 
45   * to 1. This is the function that will typically require the most CPU. 
46  * @param x Residual signal to quantise/encode (returns quantised version)
47  * @param W Perceptual weight to use when optimising (currently unused)
48  * @param N Number of samples to encode
49  * @param K Number of pulses to use
50  * @param p Pitch vector (it is assumed that p+x is a unit vector)
51  * @param alpha compression factor to apply in the pitch direction (magic!)
52  * @param enc Entropy encoder state
53 */
54 void alg_quant(celt_norm_t *X, celt_mask_t *W, int N, int K, celt_norm_t *P, float alpha, ec_enc *enc);
55
56 /** Algebraic pulse decoder
57  * @param x Decoded normalised spectrum (returned)
58  * @param N Number of samples to decode
59  * @param K Number of pulses to use
60  * @param p Pitch vector (automatically added to x)
61  * @param alpha compression factor in the pitch direction (magic!)
62  * @param dec Entropy decoder state
63  */
64 void alg_unquant(celt_norm_t *X, int N, int K, celt_norm_t *P, float alpha, ec_dec *dec);
65
66 /** Intra-frame predictor that matches a section of the current frame (at lower
67  * frequencies) to encode the current band.
68  * @param x Residual signal to quantise/encode (returns quantised version)
69  * @param W Perceptual weight
70  * @param N Number of samples to encode
71  * @param K Number of pulses to use
72  * @param Y Lower frequency spectrum to use, normalised to the same standard deviation
73  * @param P Pitch vector (it is assumed that p+x is a unit vector)
74  * @param B Stride (number of channels multiplied by the number of MDCTs per frame)
75  * @param N0 Number of valid offsets
76  * @param enc Entropy encoder state
77  */
78 void intra_prediction(celt_norm_t *x, celt_mask_t *W, int N, int K, celt_norm_t *Y, celt_norm_t *P, int B, int N0, ec_enc *enc);
79
80 void intra_unquant(celt_norm_t *x, int N, int K, celt_norm_t *Y, celt_norm_t *P, int B, int N0, ec_dec *dec);
81
82 /** Encode the entire band as a "fold" from other parts of the spectrum. No bits required (only use is case of an emergency!) */
83 void intra_fold(celt_norm_t *x, int N, celt_norm_t *Y, celt_norm_t *P, int B, int N0, int Nmax);
84
85 #endif /* VQ_H */