Initial revision
[flac.git] / src / libFLAC / include / private / fixed.h
1 /* libFLAC - Free Lossless Audio Coder library
2  * Copyright (C) 2000  Josh Coalson
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA  02111-1307, USA.
18  */
19
20 #ifndef FLAC__PRIVATE__FIXED_H
21 #define FLAC__PRIVATE__FIXED_H
22
23 #include "FLAC/format.h"
24
25 /*
26  *      FLAC__fixed_compute_best_predictor()
27  *      --------------------------------------------------------------------
28  *      Compute the best fixed predictor and the expected bits-per-sample
29  *      of the residual signal for each order.
30  *
31  *      IN data[0,data_len-1]
32  *      IN data_len
33  *      OUT residual_bits_per_sample[0,FLAC__MAX_FIXED_ORDER]
34  */
35 unsigned FLAC__fixed_compute_best_predictor(const int32 data[], unsigned data_len, real residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1]);
36
37 /*
38  *      FLAC__fixed_compute_residual()
39  *      --------------------------------------------------------------------
40  *      Compute the residual signal obtained from sutracting the predicted
41  *      signal from the original.
42  *
43  *      IN data[-order,data_len-1]        original signal (NOTE THE INDICES!)
44  *      IN data_len                       length of original signal
45  *      IN order <= FLAC__MAX_FIXED_ORDER fixed-predictor order
46  *      OUT residual[0,data_len-1]        residual signal
47  */
48 void FLAC__fixed_compute_residual(const int32 data[], unsigned data_len, unsigned order, int32 residual[]);
49
50 /*
51  *      FLAC__fixed_restore_signal()
52  *      --------------------------------------------------------------------
53  *      Restore the original signal by summing the residual and the
54  *      predictor.
55  *
56  *      IN residual[0,data_len-1]         residual signal
57  *      IN data_len                       length of original signal
58  *      IN order <= FLAC__MAX_FIXED_ORDER fixed-predictor order
59  *      *** IMPORTANT: the caller must pass in the historical samples:
60  *      IN  data[-order,-1]               previously-reconstructed historical samples
61  *      OUT data[0,data_len-1]            original signal
62  */
63 void FLAC__fixed_restore_signal(const int32 residual[], unsigned data_len, unsigned order, int32 data[]);
64
65 #endif