src/lib/dl/ext/flac/private/fixed.h

   1 /* libFLAC - Free Lossless Audio Codec library
   2  * Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * - Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * - Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  *
  15  * - Neither the name of the Xiph.org Foundation nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef FLAC__PRIVATE__FIXED_H
  33 #define FLAC__PRIVATE__FIXED_H
  34
  35 #ifdef HAVE_CONFIG_H
  36 #include "config.h"
  37 #endif
  38
  39 #include "private/float.h"
  40 #include "flac/format.h"
  41
  42 /*
  43  *      FLAC__fixed_compute_best_predictor()
  44  *      --------------------------------------------------------------------
  45  *      Compute the best fixed predictor and the expected bits-per-sample
  46  *  of the residual signal for each order.  The _wide() version uses
  47  *  64-bit integers which is statistically necessary when bits-per-
  48  *  sample + log2(blocksize) > 30
  49  *
  50  *      IN data[0,data_len-1]
  51  *      IN data_len
  52  *      OUT residual_bits_per_sample[0,FLAC__MAX_FIXED_ORDER]
  53  */
  54 #ifndef FLAC__INTEGER_ONLY_LIBRARY
  55 unsigned FLAC__fixed_compute_best_predictor(const FLAC__int32 data[], unsigned data_len, FLAC__float residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
  56 # ifndef FLAC__NO_ASM
  57 #  ifdef FLAC__CPU_IA32
  58 #   ifdef FLAC__HAS_NASM
  59 unsigned FLAC__fixed_compute_best_predictor_asm_ia32_mmx_cmov(const FLAC__int32 data[], unsigned data_len, FLAC__float residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
  60 #   endif
  61 #  endif
  62 # endif
  63 unsigned FLAC__fixed_compute_best_predictor_wide(const FLAC__int32 data[], unsigned data_len, FLAC__float residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
  64 #else
  65 unsigned FLAC__fixed_compute_best_predictor(const FLAC__int32 data[], unsigned data_len, FLAC__fixedpoint residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
  66 unsigned FLAC__fixed_compute_best_predictor_wide(const FLAC__int32 data[], unsigned data_len, FLAC__fixedpoint residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
  67 #endif
  68
  69 /*
  70  *      FLAC__fixed_compute_residual()
  71  *      --------------------------------------------------------------------
  72  *      Compute the residual signal obtained from sutracting the predicted
  73  *      signal from the original.
  74  *
  75  *      IN data[-order,data_len-1]        original signal (NOTE THE INDICES!)
  76  *      IN data_len                       length of original signal
  77  *      IN order <= FLAC__MAX_FIXED_ORDER fixed-predictor order
  78  *      OUT residual[0,data_len-1]        residual signal
  79  */
  80 void FLAC__fixed_compute_residual(const FLAC__int32 data[], unsigned data_len, unsigned order, FLAC__int32 residual[]);
  81
  82 /*
  83  *      FLAC__fixed_restore_signal()
  84  *      --------------------------------------------------------------------
  85  *      Restore the original signal by summing the residual and the
  86  *      predictor.
  87  *
  88  *      IN residual[0,data_len-1]         residual signal
  89  *      IN data_len                       length of original signal
  90  *      IN order <= FLAC__MAX_FIXED_ORDER fixed-predictor order
  91  *      *** IMPORTANT: the caller must pass in the historical samples:
  92  *      IN  data[-order,-1]               previously-reconstructed historical samples
  93  *      OUT data[0,data_len-1]            original signal
  94  */
  95 void FLAC__fixed_restore_signal(const FLAC__int32 residual[], unsigned data_len, unsigned order, FLAC__int32 data[]);
  96
  97 #endif