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