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