SSE2 implementation of the PVQ search
[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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
24    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef VQ_H
34 #define VQ_H
35
36 #include "entenc.h"
37 #include "entdec.h"
38 #include "modes.h"
39
40 #if (defined(OPUS_X86_MAY_HAVE_SSE2) && !defined(FIXED_POINT))
41 #include "x86/vq_sse.h"
42 #endif
43
44 #if defined(MIPSr1_ASM)
45 #include "mips/vq_mipsr1.h"
46 #endif
47
48 opus_val16 op_pvq_search_c(celt_norm *X, int *iy, int K, int N, int arch);
49
50 #if !defined(OVERRIDE_OP_PVQ_SEARCH)
51 #define op_pvq_search(x, iy, K, N, arch) \
52     (op_pvq_search_c(x, iy, K, N, arch))
53 #endif
54
55 /** Algebraic pulse-vector quantiser. The signal x is replaced by the sum of
56   * the pitch and a combination of pulses such that its norm is still equal
57   * to 1. This is the function that will typically require the most CPU.
58  * @param X Residual signal to quantise/encode (returns quantised version)
59  * @param N Number of samples to encode
60  * @param K Number of pulses to use
61  * @param enc Entropy encoder state
62  * @ret A mask indicating which blocks in the band received pulses
63 */
64 unsigned alg_quant(celt_norm *X, int N, int K, int spread, int B, ec_enc *enc,
65       opus_val16 gain, int resynth, int arch);
66
67 /** Algebraic pulse decoder
68  * @param X Decoded normalised spectrum (returned)
69  * @param N Number of samples to decode
70  * @param K Number of pulses to use
71  * @param dec Entropy decoder state
72  * @ret A mask indicating which blocks in the band received pulses
73  */
74 unsigned alg_unquant(celt_norm *X, int N, int K, int spread, int B,
75       ec_dec *dec, opus_val16 gain);
76
77 void renormalise_vector(celt_norm *X, int N, opus_val16 gain, int arch);
78
79 int stereo_itheta(const celt_norm *X, const celt_norm *Y, int stereo, int N, int arch);
80
81 #endif /* VQ_H */