Enabling "plain folding" in case we don't even have enough bits for intra-frame
[opus.git] / libcelt / vq.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 VQ_H
33 #define VQ_H
34
35 #include "entenc.h"
36 #include "entdec.h"
37
38
39 /** Algebraic pulse-based quantiser. The signal x is replaced by the sum of the
40  * pitch a combination of pulses such that its norm is still equal to 1. The
41  * only difference with the quantiser above is that the search is more complete. 
42  * @param x Residual signal to quantise/encode (returns quantised version)
43  * @param W Perceptual weight
44  * @param N Number of samples to encode
45  * @param K Number of pulses to use
46  * @param p Pitch vector (it is assumed that p+x is a unit vector)
47  * @param alpha compression factor in the pitch direction (magic!)
48  * @param enc Entropy encoder state
49 */
50 void alg_quant(float *x, float *W, int N, int K, float *p, float alpha, ec_enc *enc);
51
52 /** Algebraic pulse decoder
53  * @param x Decoded normalised spectrum (returned)
54  * @param N Number of samples to decode
55  * @param K Number of pulses to use
56  * @param p Pitch vector (automatically added to x)
57  * @param alpha compression factor in the pitch direction (magic!)
58  * @param dec Entropy decoder state
59  */
60 void alg_unquant(float *x, int N, int K, float *p, float alpha, ec_dec *dec);
61
62 /** Intra-frame predictor that matches a section of the current frame (at lower
63  * frequencies) to encode the current band.
64  * @param x Residual signal to quantise/encode (returns quantised version)
65  * @param W Perceptual weight
66  * @param N Number of samples to encode
67  * @param K Number of pulses to use
68  * @param Y Lower frequency spectrum to use, normalised to the same standard deviation
69  * @param p Pitch vector (it is assumed that p+x is a unit vector)
70  * @param B Stride (number of channels multiplied by the number of MDCTs per frame)
71  * @param N0 Number of valid offsets
72  * @param enc Entropy encoder state
73  */
74 void intra_prediction(float *x, float *W, int N, int K, float *Y, float *P, int B, int N0, ec_enc *enc);
75
76 void intra_unquant(float *x, int N, int K, float *Y, float *P, int B, int N0, ec_dec *dec);
77
78 void intra_fold(float *x, int N, int K, float *Y, float *P, int B, int N0);
79
80 #endif /* VQ_H */