xref: /aosp_15_r20/external/libopus/celt/vq.h (revision a58d3d2adb790c104798cd88c8a3aff4fa8b82cc)
1*a58d3d2aSXin Li /* Copyright (c) 2007-2008 CSIRO
2*a58d3d2aSXin Li    Copyright (c) 2007-2009 Xiph.Org Foundation
3*a58d3d2aSXin Li    Written by Jean-Marc Valin */
4*a58d3d2aSXin Li /**
5*a58d3d2aSXin Li    @file vq.h
6*a58d3d2aSXin Li    @brief Vector quantisation of the residual
7*a58d3d2aSXin Li  */
8*a58d3d2aSXin Li /*
9*a58d3d2aSXin Li    Redistribution and use in source and binary forms, with or without
10*a58d3d2aSXin Li    modification, are permitted provided that the following conditions
11*a58d3d2aSXin Li    are met:
12*a58d3d2aSXin Li 
13*a58d3d2aSXin Li    - Redistributions of source code must retain the above copyright
14*a58d3d2aSXin Li    notice, this list of conditions and the following disclaimer.
15*a58d3d2aSXin Li 
16*a58d3d2aSXin Li    - Redistributions in binary form must reproduce the above copyright
17*a58d3d2aSXin Li    notice, this list of conditions and the following disclaimer in the
18*a58d3d2aSXin Li    documentation and/or other materials provided with the distribution.
19*a58d3d2aSXin Li 
20*a58d3d2aSXin Li    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21*a58d3d2aSXin Li    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22*a58d3d2aSXin Li    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23*a58d3d2aSXin Li    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
24*a58d3d2aSXin Li    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25*a58d3d2aSXin Li    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26*a58d3d2aSXin Li    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27*a58d3d2aSXin Li    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28*a58d3d2aSXin Li    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29*a58d3d2aSXin Li    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30*a58d3d2aSXin Li    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31*a58d3d2aSXin Li */
32*a58d3d2aSXin Li 
33*a58d3d2aSXin Li #ifndef VQ_H
34*a58d3d2aSXin Li #define VQ_H
35*a58d3d2aSXin Li 
36*a58d3d2aSXin Li #include "entenc.h"
37*a58d3d2aSXin Li #include "entdec.h"
38*a58d3d2aSXin Li #include "modes.h"
39*a58d3d2aSXin Li 
40*a58d3d2aSXin Li #if (defined(OPUS_X86_MAY_HAVE_SSE2) && !defined(FIXED_POINT))
41*a58d3d2aSXin Li #include "x86/vq_sse.h"
42*a58d3d2aSXin Li #endif
43*a58d3d2aSXin Li 
44*a58d3d2aSXin Li void exp_rotation(celt_norm *X, int len, int dir, int stride, int K, int spread);
45*a58d3d2aSXin Li 
46*a58d3d2aSXin Li opus_val16 op_pvq_search_c(celt_norm *X, int *iy, int K, int N, int arch);
47*a58d3d2aSXin Li 
48*a58d3d2aSXin Li #if !defined(OVERRIDE_OP_PVQ_SEARCH)
49*a58d3d2aSXin Li #define op_pvq_search(x, iy, K, N, arch) \
50*a58d3d2aSXin Li     (op_pvq_search_c(x, iy, K, N, arch))
51*a58d3d2aSXin Li #endif
52*a58d3d2aSXin Li 
53*a58d3d2aSXin Li /** Algebraic pulse-vector quantiser. The signal x is replaced by the sum of
54*a58d3d2aSXin Li   * the pitch and a combination of pulses such that its norm is still equal
55*a58d3d2aSXin Li   * to 1. This is the function that will typically require the most CPU.
56*a58d3d2aSXin Li  * @param X Residual signal to quantise/encode (returns quantised version)
57*a58d3d2aSXin Li  * @param N Number of samples to encode
58*a58d3d2aSXin Li  * @param K Number of pulses to use
59*a58d3d2aSXin Li  * @param enc Entropy encoder state
60*a58d3d2aSXin Li  * @ret A mask indicating which blocks in the band received pulses
61*a58d3d2aSXin Li */
62*a58d3d2aSXin Li unsigned alg_quant(celt_norm *X, int N, int K, int spread, int B, ec_enc *enc,
63*a58d3d2aSXin Li       opus_val16 gain, int resynth, int arch);
64*a58d3d2aSXin Li 
65*a58d3d2aSXin Li /** Algebraic pulse decoder
66*a58d3d2aSXin Li  * @param X Decoded normalised spectrum (returned)
67*a58d3d2aSXin Li  * @param N Number of samples to decode
68*a58d3d2aSXin Li  * @param K Number of pulses to use
69*a58d3d2aSXin Li  * @param dec Entropy decoder state
70*a58d3d2aSXin Li  * @ret A mask indicating which blocks in the band received pulses
71*a58d3d2aSXin Li  */
72*a58d3d2aSXin Li unsigned alg_unquant(celt_norm *X, int N, int K, int spread, int B,
73*a58d3d2aSXin Li       ec_dec *dec, opus_val16 gain);
74*a58d3d2aSXin Li 
75*a58d3d2aSXin Li void renormalise_vector(celt_norm *X, int N, opus_val16 gain, int arch);
76*a58d3d2aSXin Li 
77*a58d3d2aSXin Li int stereo_itheta(const celt_norm *X, const celt_norm *Y, int stereo, int N, int arch);
78*a58d3d2aSXin Li 
79*a58d3d2aSXin Li #endif /* VQ_H */
80