Chris@69: /* Copyright (c) 2007-2008 CSIRO
Chris@69:    Copyright (c) 2007-2009 Xiph.Org Foundation
Chris@69:    Written by Jean-Marc Valin */
Chris@69: /**
Chris@69:    @file vq.h
Chris@69:    @brief Vector quantisation of the residual
Chris@69:  */
Chris@69: /*
Chris@69:    Redistribution and use in source and binary forms, with or without
Chris@69:    modification, are permitted provided that the following conditions
Chris@69:    are met:
Chris@69: 
Chris@69:    - Redistributions of source code must retain the above copyright
Chris@69:    notice, this list of conditions and the following disclaimer.
Chris@69: 
Chris@69:    - Redistributions in binary form must reproduce the above copyright
Chris@69:    notice, this list of conditions and the following disclaimer in the
Chris@69:    documentation and/or other materials provided with the distribution.
Chris@69: 
Chris@69:    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@69:    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@69:    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@69:    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
Chris@69:    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
Chris@69:    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
Chris@69:    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
Chris@69:    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
Chris@69:    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
Chris@69:    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Chris@69:    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@69: */
Chris@69: 
Chris@69: #ifndef VQ_H
Chris@69: #define VQ_H
Chris@69: 
Chris@69: #include "entenc.h"
Chris@69: #include "entdec.h"
Chris@69: #include "modes.h"
Chris@69: 
Chris@69: #if (defined(OPUS_X86_MAY_HAVE_SSE2) && !defined(FIXED_POINT))
Chris@69: #include "x86/vq_sse.h"
Chris@69: #endif
Chris@69: 
Chris@69: #if defined(MIPSr1_ASM)
Chris@69: #include "mips/vq_mipsr1.h"
Chris@69: #endif
Chris@69: 
Chris@69: void exp_rotation(celt_norm *X, int len, int dir, int stride, int K, int spread);
Chris@69: 
Chris@69: opus_val16 op_pvq_search_c(celt_norm *X, int *iy, int K, int N, int arch);
Chris@69: 
Chris@69: #if !defined(OVERRIDE_OP_PVQ_SEARCH)
Chris@69: #define op_pvq_search(x, iy, K, N, arch) \
Chris@69:     (op_pvq_search_c(x, iy, K, N, arch))
Chris@69: #endif
Chris@69: 
Chris@69: /** Algebraic pulse-vector quantiser. The signal x is replaced by the sum of
Chris@69:   * the pitch and a combination of pulses such that its norm is still equal
Chris@69:   * to 1. This is the function that will typically require the most CPU.
Chris@69:  * @param X Residual signal to quantise/encode (returns quantised version)
Chris@69:  * @param N Number of samples to encode
Chris@69:  * @param K Number of pulses to use
Chris@69:  * @param enc Entropy encoder state
Chris@69:  * @ret A mask indicating which blocks in the band received pulses
Chris@69: */
Chris@69: unsigned alg_quant(celt_norm *X, int N, int K, int spread, int B, ec_enc *enc,
Chris@69:       opus_val16 gain, int resynth, int arch);
Chris@69: 
Chris@69: /** Algebraic pulse decoder
Chris@69:  * @param X Decoded normalised spectrum (returned)
Chris@69:  * @param N Number of samples to decode
Chris@69:  * @param K Number of pulses to use
Chris@69:  * @param dec Entropy decoder state
Chris@69:  * @ret A mask indicating which blocks in the band received pulses
Chris@69:  */
Chris@69: unsigned alg_unquant(celt_norm *X, int N, int K, int spread, int B,
Chris@69:       ec_dec *dec, opus_val16 gain);
Chris@69: 
Chris@69: void renormalise_vector(celt_norm *X, int N, opus_val16 gain, int arch);
Chris@69: 
Chris@69: int stereo_itheta(const celt_norm *X, const celt_norm *Y, int stereo, int N, int arch);
Chris@69: 
Chris@69: #endif /* VQ_H */