Initial revision
[flac.git] / src / libFLAC / lpc.c
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 #include <assert.h>
21 #include <math.h>
22 #include <stdio.h>
23 #include "FLAC/format.h"
24 #include "private/lpc.h"
25
26 #ifndef M_LN2
27 /* math.h in VC++ doesn't seem to have this (how Microsoft is that?) */
28 #define M_LN2 0.69314718055994530942
29 #endif
30
31 void FLAC__lpc_compute_autocorrelation(const real data[], unsigned data_len, unsigned lag, real autoc[])
32 {
33         real d;
34         unsigned i;
35
36         assert(lag > 0);
37         assert(lag <= data_len);
38
39         while(lag--) {
40                 for(i = lag, d = 0.0; i < data_len; i++)
41                         d += data[i] * data[i - lag];
42                 autoc[lag] = d;
43         }
44 }
45
46 void FLAC__lpc_compute_lp_coefficients(const real autoc[], unsigned max_order, real lp_coeff[][FLAC__MAX_LPC_ORDER], real error[])
47 {
48         unsigned i, j;
49         real r, err, ref[FLAC__MAX_LPC_ORDER], lpc[FLAC__MAX_LPC_ORDER];
50
51         assert(0 < max_order);
52         assert(max_order <= FLAC__MAX_LPC_ORDER);
53         assert(autoc[0] != 0.0);
54
55         err = autoc[0];
56
57         for(i = 0; i < max_order; i++) {
58                 /* Sum up this iteration's reflection coefficient. */
59                 r =- autoc[i+1];
60                 for(j = 0; j < i; j++)
61                         r -= lpc[j] * autoc[i-j];
62                 ref[i] = (r/=err);
63
64                 /* Update LPC coefficients and total error. */
65                 lpc[i]=r;
66                 for(j = 0; j < (i>>1); j++) {
67                         real tmp = lpc[j];
68                         lpc[j] += r * lpc[i-1-j];
69                         lpc[i-1-j] += r * tmp;
70                 }
71                 if(i & 1)
72                         lpc[j] += lpc[j] * r;
73
74                 err *= (1.0 - r * r);
75
76                 /* save this order */
77                 for(j = 0; j <= i; j++)
78                         lp_coeff[i][j] = -lpc[j]; /* N.B. why do we have to negate here? */
79                 error[i] = err;
80         }
81 }
82
83 int FLAC__lpc_quantize_coefficients(const real lp_coeff[], unsigned order, unsigned precision, unsigned bits_per_sample, int32 qlp_coeff[], int *bits)
84 {
85         unsigned i;
86         real d, rprecision = (real)precision, maxlog = -1e99, minlog = 1e99;
87
88         assert(bits_per_sample > 0);
89         assert(bits_per_sample <= sizeof(int32)*8);
90         assert(precision >= FLAC__MIN_QLP_COEFF_PRECISION);
91         assert(precision + bits_per_sample < sizeof(int32)*8);
92 #ifdef NDEBUG
93         (void)bits_per_sample; /* silence compiler warning about unused parameter */
94 #endif
95
96         for(i = 0; i < order; i++) {
97                 if(lp_coeff[i] == 0.0)
98                         continue;
99                 d = log(fabs(lp_coeff[i])) / M_LN2;
100                 if(d > maxlog)
101                         maxlog = d;
102                 if(d < minlog)
103                         minlog = d;
104         }
105         if(maxlog < minlog)
106                 return 2;
107         else if(maxlog - minlog >= (real)(precision+1))
108                 return 1;
109         else if((rprecision-1.0) - maxlog >= (real)(precision+1))
110                 rprecision = (real)precision + maxlog + 1.0;
111
112         *bits = (int)floor((rprecision-1.0) - maxlog); /* '-1' because bits can be negative and the sign bit costs 1 bit */
113         if(*bits > (int)precision || *bits <= -(int)precision) {
114                 fprintf(stderr, "@@@ FLAC__lpc_quantize_coefficients(): ERROR: *bits=%d, maxlog=%f, minlog=%f, precision=%u, rprecision=%f\n", *bits, maxlog, minlog, precision, rprecision);
115                 return 1;
116         }
117
118         if(*bits != 0) { /* just to avoid wasting time... */
119                 for(i = 0; i < order; i++)
120                         qlp_coeff[i] = (int32)floor(lp_coeff[i] * (real)(1 << *bits));
121         }
122         return 0;
123 }
124
125 void FLAC__lpc_compute_residual_from_qlp_coefficients(const int32 data[], unsigned data_len, const int32 qlp_coeff[], unsigned order, int lp_quantization, int32 residual[])
126 {
127 #ifdef FLAC_OVERFLOW_DETECT
128         int64 sumo;
129 #endif
130         unsigned i, j;
131         int32 sum;
132         const int32 *history;
133
134 #ifdef FLAC_OVERFLOW_DETECT_VERBOSE
135         fprintf(stderr,"FLAC__lpc_compute_residual_from_qlp_coefficients: data_len=%d, order=%u, lpq=%d",data_len,order,lp_quantization);
136         for(i=0;i<order;i++)
137                 fprintf(stderr,", q[%u]=%d",i,qlp_coeff[i]);
138         fprintf(stderr,"\n");
139 #endif
140         assert(order > 0);
141
142         for(i = 0; i < data_len; i++) {
143 #ifdef FLAC_OVERFLOW_DETECT
144                 sumo = 0;
145 #endif
146                 sum = 0;
147                 history = data;
148                 for(j = 0; j < order; j++) {
149                         sum += qlp_coeff[j] * (*(--history));
150 #ifdef FLAC_OVERFLOW_DETECT
151                         sumo += (int64)qlp_coeff[j] * (int64)(*history);
152                         if(sumo > 2147483647ll || sumo < -2147483648ll)
153                                 fprintf(stderr,"FLAC__lpc_compute_residual_from_qlp_coefficients: OVERFLOW, sumo=%lld\n",sumo);
154 #endif
155                 }
156                 *(residual++) = *(data++) - (sum >> lp_quantization);
157         }
158
159         /* Here's a slightly slower but clearer version:
160         for(i = 0; i < data_len; i++) {
161                 sum = 0;
162                 history = &(data[i]);
163                 for(j = 0; j < order; j++)
164                         sum += qlp_coeff[j] * (*(--history));
165                 residual[i] = data[i] - (sum >> lp_quantization);
166         }
167         */
168 }
169
170 void FLAC__lpc_restore_signal(const int32 residual[], unsigned data_len, const int32 qlp_coeff[], unsigned order, int lp_quantization, int32 data[])
171 {
172 #ifdef FLAC_OVERFLOW_DETECT
173         int64 sumo;
174 #endif
175         unsigned i, j;
176         int32 sum, *history;
177
178 #ifdef FLAC_OVERFLOW_DETECT_VERBOSE
179         fprintf(stderr,"FLAC__lpc_restore_signal: data_len=%d, order=%u, lpq=%d",data_len,order,lp_quantization);
180         for(i=0;i<order;i++)
181                 fprintf(stderr,", q[%u]=%d",i,qlp_coeff[i]);
182         fprintf(stderr,"\n");
183 #endif
184         assert(order > 0);
185
186         for(i = 0; i < data_len; i++) {
187 #ifdef FLAC_OVERFLOW_DETECT
188                 sumo = 0;
189 #endif
190                 sum = 0;
191                 history = data+i;
192                 for(j = 0; j < order; j++) {
193                         sum += qlp_coeff[j] * (*(--history));
194 #ifdef FLAC_OVERFLOW_DETECT
195                         sumo += (int64)qlp_coeff[j] * (int64)(*history);
196                         if(sumo > 2147483647ll || sumo < -2147483648ll)
197                                 fprintf(stderr,"FLAC__lpc_restore_signal: OVERFLOW, sumo=%lld\n",sumo);
198 #endif
199                 }
200                 data[i] = residual[i] + (sum >> lp_quantization);
201         }
202 }
203
204 real FLAC__lpc_compute_expected_bits_per_residual_sample(real lpc_error, unsigned total_samples)
205 {
206         real escale;
207
208         assert(lpc_error >= 0.0); /* the error can never be negative */
209         assert(total_samples > 0);
210
211         escale = 0.5 * M_LN2 * M_LN2 / (real)total_samples;
212
213         if(lpc_error > 0.0)
214                 return 0.5 * log(escale * lpc_error) / M_LN2;
215         else
216                 return 0.0;
217 }
218
219 unsigned FLAC__lpc_compute_best_order(const real lpc_error[], unsigned max_order, unsigned total_samples, unsigned bits_per_signal_sample)
220 {
221         unsigned order, best_order;
222         real best_bits, tmp_bits;
223
224         assert(max_order > 0);
225
226         best_order = 0;
227         best_bits = FLAC__lpc_compute_expected_bits_per_residual_sample(lpc_error[0], total_samples) * (real)total_samples;
228
229         for(order = 1; order < max_order; order++) {
230                 tmp_bits = FLAC__lpc_compute_expected_bits_per_residual_sample(lpc_error[order], total_samples) * (real)(total_samples - order) + (real)(order * bits_per_signal_sample);
231                 if(tmp_bits < best_bits) {
232                         best_order = order;
233                         best_bits = tmp_bits;
234                 }
235         }
236
237         return best_order+1; /* +1 since index of lpc_error[] is order-1 */
238 }