fix bug where overflow of total_error caused it to go negative
[platform/upstream/flac.git] / src / libFLAC / fixed.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001  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 #include <assert.h>
21 #include <math.h>
22 #include "private/fixed.h"
23
24 #ifndef M_LN2
25 /* math.h in VC++ doesn't seem to have this (how Microsoft is that?) */
26 #define M_LN2 0.69314718055994530942
27 #endif
28
29 #ifdef min
30 #undef min
31 #endif
32 #define min(x,y) ((x) < (y)? (x) : (y))
33
34 #ifdef local_abs
35 #undef local_abs
36 #endif
37 #define local_abs(x) ((unsigned)((x)<0? -(x) : (x)))
38
39 unsigned FLAC__fixed_compute_best_predictor(const int32 data[], unsigned data_len, real residual_bits_per_sample[FLAC__MAX_FIXED_ORDER+1])
40 {
41         int32 last_error_0 = data[-1];
42         int32 last_error_1 = data[-1] - data[-2];
43         int32 last_error_2 = last_error_1 - (data[-2] - data[-3]);
44         int32 last_error_3 = last_error_2 - (data[-2] - 2*data[-3] + data[-4]);
45         int32 error_0, error_1, error_2, error_3, error_4;
46         uint32 total_error_0 = 0, total_error_1 = 0, total_error_2 = 0, total_error_3 = 0, total_error_4 = 0;
47         unsigned i, order;
48
49         for(i = 0; i < data_len; i++) {
50                 error_0 = data[i]               ; total_error_0 += local_abs(error_0);
51                 error_1 = error_0 - last_error_0; total_error_1 += local_abs(error_1);
52                 error_2 = error_1 - last_error_1; total_error_2 += local_abs(error_2);
53                 error_3 = error_2 - last_error_2; total_error_3 += local_abs(error_3);
54                 error_4 = error_3 - last_error_3; total_error_4 += local_abs(error_4);
55
56                 /* WATCHOUT - total_error_* has been know to overflow when encoding
57                  * erratic signals when the bits-per-sample is large.  We avoid the
58                  * speed penalty of watching for overflow, and instead rely on the
59                  * encoder's evaluation of the subframe to catch these cases.
60                  */
61
62                 last_error_0 = error_0;
63                 last_error_1 = error_1;
64                 last_error_2 = error_2;
65                 last_error_3 = error_3;
66         }
67
68         if(total_error_0 < min(min(min(total_error_1, total_error_2), total_error_3), total_error_4))
69                 order = 0;
70         else if(total_error_1 < min(min(total_error_2, total_error_3), total_error_4))
71                 order = 1;
72         else if(total_error_2 < min(total_error_3, total_error_4))
73                 order = 2;
74         else if(total_error_3 < total_error_4)
75                 order = 3;
76         else
77                 order = 4;
78
79         /* Estimate the expected number of bits per residual signal sample. */
80         /* 'total_error*' is linearly related to the variance of the residual */
81         /* signal, so we use it directly to compute E(|x|) */
82         residual_bits_per_sample[0] = (real)((data_len > 0) ? log(M_LN2 * (real)total_error_0  / (real) data_len) / M_LN2 : 0.0);
83         residual_bits_per_sample[1] = (real)((data_len > 0) ? log(M_LN2 * (real)total_error_1  / (real) data_len) / M_LN2 : 0.0);
84         residual_bits_per_sample[2] = (real)((data_len > 0) ? log(M_LN2 * (real)total_error_2  / (real) data_len) / M_LN2 : 0.0);
85         residual_bits_per_sample[3] = (real)((data_len > 0) ? log(M_LN2 * (real)total_error_3  / (real) data_len) / M_LN2 : 0.0);
86         residual_bits_per_sample[4] = (real)((data_len > 0) ? log(M_LN2 * (real)total_error_4  / (real) data_len) / M_LN2 : 0.0);
87
88         return order;
89 }
90
91 void FLAC__fixed_compute_residual(const int32 data[], unsigned data_len, unsigned order, int32 residual[])
92 {
93         unsigned i;
94
95         switch(order) {
96                 case 0:
97                         for(i = 0; i < data_len; i++) {
98                                 residual[i] = data[i];
99                         }
100                         break;
101                 case 1:
102                         for(i = 0; i < data_len; i++) {
103                                 residual[i] = data[i] - data[i-1];
104                         }
105                         break;
106                 case 2:
107                         for(i = 0; i < data_len; i++) {
108                                 /* == data[i] - 2*data[i-1] + data[i-2] */
109                                 residual[i] = data[i] - (data[i-1] << 1) + data[i-2];
110                         }
111                         break;
112                 case 3:
113                         for(i = 0; i < data_len; i++) {
114                                 /* == data[i] - 3*data[i-1] + 3*data[i-2] - data[i-3] */
115                                 residual[i] = data[i] - (((data[i-1]-data[i-2])<<1) + (data[i-1]-data[i-2])) - data[i-3];
116                         }
117                         break;
118                 case 4:
119                         for(i = 0; i < data_len; i++) {
120                                 /* == data[i] - 4*data[i-1] + 6*data[i-2] - 4*data[i-3] + data[i-4] */
121                                 residual[i] = data[i] - ((data[i-1]+data[i-3])<<2) + ((data[i-2]<<2) + (data[i-2]<<1)) + data[i-4];
122                         }
123                         break;
124                 default:
125                         assert(0);
126         }
127 }
128
129 void FLAC__fixed_restore_signal(const int32 residual[], unsigned data_len, unsigned order, int32 data[])
130 {
131         unsigned i;
132
133         switch(order) {
134                 case 0:
135                         for(i = 0; i < data_len; i++) {
136                                 data[i] = residual[i];
137                         }
138                         break;
139                 case 1:
140                         for(i = 0; i < data_len; i++) {
141                                 data[i] = residual[i] + data[i-1];
142                         }
143                         break;
144                 case 2:
145                         for(i = 0; i < data_len; i++) {
146                                 /* == residual[i] + 2*data[i-1] - data[i-2] */
147                                 data[i] = residual[i] + (data[i-1]<<1) - data[i-2];
148                         }
149                         break;
150                 case 3:
151                         for(i = 0; i < data_len; i++) {
152                                 /* residual[i] + 3*data[i-1] - 3*data[i-2]) + data[i-3] */
153                                 data[i] = residual[i] + (((data[i-1]-data[i-2])<<1) + (data[i-1]-data[i-2])) + data[i-3];
154                         }
155                         break;
156                 case 4:
157                         for(i = 0; i < data_len; i++) {
158                                 /* == residual[i] + 4*data[i-1] - 6*data[i-2] + 4*data[i-3] - data[i-4] */
159                                 data[i] = residual[i] + ((data[i-1]+data[i-3])<<2) - ((data[i-2]<<2) + (data[i-2]<<1)) - data[i-4];
160                         }
161                         break;
162                 default:
163                         assert(0);
164         }
165 }