annotate src/opus-1.3/celt/vq.h @ 83:ae30d91d2ffe

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