add printing of seek points in verbose mode
[flac.git] / src / flac / analyze.c
1 /* flac - Command-line FLAC encoder/decoder
2  * Copyright (C) 2000,2001  Josh Coalson
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program 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
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17  */
18
19 #include <assert.h>
20 #include <math.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include "FLAC/all.h"
25 #include "analyze.h"
26
27 typedef struct {
28         int32 residual;
29         unsigned count;
30 } pair_t;
31
32 typedef struct {
33         pair_t buckets[FLAC__MAX_BLOCK_SIZE];
34         int peak_index;
35         unsigned nbuckets;
36         unsigned nsamples;
37         double sum, sos;
38         double variance;
39         double mean;
40         double stddev;
41 } subframe_stats_t;
42
43 static subframe_stats_t all_;
44
45 static void init_stats(subframe_stats_t *stats);
46 static void update_stats(subframe_stats_t *stats, int32 residual, unsigned incr);
47 static void compute_stats(subframe_stats_t *stats);
48 static bool dump_stats(const subframe_stats_t *stats, const char *filename);
49
50 void analyze_init(analysis_options aopts)
51 {
52         if(aopts.do_residual_gnuplot) {
53                 init_stats(&all_);
54         }
55 }
56
57 void analyze_frame(const FLAC__Frame *frame, unsigned frame_number, analysis_options aopts, FILE *fout)
58 {
59         const unsigned channels = frame->header.channels;
60         char outfilename[1024];
61         subframe_stats_t stats;
62         unsigned i, channel;
63
64         /* do the human-readable part first */
65         fprintf(fout, "frame=%u\tblocksize=%u\tsample_rate=%u\tchannels=%u\tchannel_assignment=%s\n", frame_number, frame->header.blocksize, frame->header.sample_rate, channels, FLAC__ChannelAssignmentString[frame->header.channel_assignment]);
66         for(channel = 0; channel < channels; channel++) {
67                 const FLAC__Subframe *subframe = frame->subframes+channel;
68                 fprintf(fout, "\tsubframe=%u\twasted_bits=%u\ttype=%s", channel, subframe->wasted_bits, FLAC__SubframeTypeString[subframe->type]);
69                 switch(subframe->type) {
70                         case FLAC__SUBFRAME_TYPE_CONSTANT:
71                                 fprintf(fout, "\tvalue=%d\n", subframe->data.constant.value);
72                                 break;
73                         case FLAC__SUBFRAME_TYPE_FIXED:
74                                 fprintf(fout, "\torder=%u\tpartition_order=%u\n", subframe->data.fixed.order, subframe->data.fixed.entropy_coding_method.data.partitioned_rice.order); /*@@@ assumes method is partitioned-rice */
75                                 for(i = 0; i < subframe->data.fixed.order; i++)
76                                         fprintf(fout, "\t\twarmup[%u]=%d\n", i, subframe->data.fixed.warmup[i]);
77                                 if(aopts.do_residual_text) {
78                                         for(i = 0; i < frame->header.blocksize-subframe->data.fixed.order; i++)
79                                                 fprintf(fout, "\t\tresidual[%u]=%d\n", i, subframe->data.fixed.residual[i]);
80                                 }
81                                 break;
82                         case FLAC__SUBFRAME_TYPE_LPC:
83                                 fprintf(fout, "\torder=%u\tpartition_order=%u\tqlp_coeff_precision=%u\tquantization_level=%d\n", subframe->data.lpc.order, subframe->data.lpc.entropy_coding_method.data.partitioned_rice.order, subframe->data.lpc.qlp_coeff_precision, subframe->data.lpc.quantization_level); /*@@@ assumes method is partitioned-rice */
84                                 for(i = 0; i < subframe->data.lpc.order; i++)
85                                         fprintf(fout, "\t\twarmup[%u]=%d\n", i, subframe->data.lpc.warmup[i]);
86                                 if(aopts.do_residual_text) {
87                                         for(i = 0; i < frame->header.blocksize-subframe->data.lpc.order; i++)
88                                                 fprintf(fout, "\t\tresidual[%u]=%d\n", i, subframe->data.lpc.residual[i]);
89                                 }
90                                 break;
91                         case FLAC__SUBFRAME_TYPE_VERBATIM:
92                                 fprintf(fout, "\n");
93                                 break;
94                 }
95         }
96
97         /* now do the residual distributions if requested */
98         if(aopts.do_residual_gnuplot) {
99                 for(channel = 0; channel < channels; channel++) {
100                         const FLAC__Subframe *subframe = frame->subframes+channel;
101                         unsigned residual_samples;
102
103                         init_stats(&stats);
104
105                         switch(subframe->type) {
106                                 case FLAC__SUBFRAME_TYPE_FIXED:
107                                         residual_samples = frame->header.blocksize - subframe->data.fixed.order;
108                                         for(i = 0; i < residual_samples; i++)
109                                                 update_stats(&stats, subframe->data.fixed.residual[i], 1);
110                                         break;
111                                 case FLAC__SUBFRAME_TYPE_LPC:
112                                         residual_samples = frame->header.blocksize - subframe->data.lpc.order;
113                                         for(i = 0; i < residual_samples; i++)
114                                                 update_stats(&stats, subframe->data.lpc.residual[i], 1);
115                                         break;
116                                 default:
117                                         break;
118                         }
119
120                         /* update all_ */
121                         for(i = 0; i < stats.nbuckets; i++) {
122                                 update_stats(&all_, stats.buckets[i].residual, stats.buckets[i].count);
123                         }
124
125                         /* write the subframe */
126                         sprintf(outfilename, "f%06u.s%u.gp", frame_number, channel);
127                         compute_stats(&stats);
128
129                         (void)dump_stats(&stats, outfilename);
130                 }
131         }
132 }
133
134 void analyze_finish(analysis_options aopts)
135 {
136         if(aopts.do_residual_gnuplot) {
137                 compute_stats(&all_);
138                 (void)dump_stats(&all_, "all");
139         }
140 }
141
142 void init_stats(subframe_stats_t *stats)
143 {
144         stats->peak_index = -1;
145         stats->nbuckets = 0;
146         stats->nsamples = 0;
147         stats->sum = 0.0;
148         stats->sos = 0.0;
149 }
150
151 void update_stats(subframe_stats_t *stats, int32 residual, unsigned incr)
152 {
153         unsigned i;
154         const double r = (double)residual, a = r*incr;
155
156         stats->nsamples += incr;
157         stats->sum += a;
158         stats->sos += (a*r);
159
160         for(i = 0; i < stats->nbuckets; i++) {
161                 if(stats->buckets[i].residual == residual) {
162                         stats->buckets[i].count += incr;
163                         goto find_peak;
164                 }
165         }
166         /* not found, make a new bucket */
167         i = stats->nbuckets;
168         stats->buckets[i].residual = residual;
169         stats->buckets[i].count = incr;
170         stats->nbuckets++;
171 find_peak:
172         if(stats->peak_index < 0 || stats->buckets[i].count > stats->buckets[stats->peak_index].count)
173                 stats->peak_index = i;
174 }
175
176 void compute_stats(subframe_stats_t *stats)
177 {
178         stats->mean = stats->sum / (double)stats->nsamples;
179         stats->variance = (stats->sos - (stats->sum * stats->sum / stats->nsamples)) / stats->nsamples;
180         stats->stddev = sqrt(stats->variance);
181 }
182
183 bool dump_stats(const subframe_stats_t *stats, const char *filename)
184 {
185         FILE *outfile;
186         unsigned i;
187         const double m = stats->mean;
188         const double s1 = stats->stddev, s2 = s1*2, s3 = s1*3, s4 = s1*4, s5 = s1*5, s6 = s1*6;
189         const double p = stats->buckets[stats->peak_index].count;
190
191         outfile = fopen(filename, "w");
192
193         if(0 == outfile) {
194                 fprintf(stderr, "ERROR opening %s\n", filename);
195                 return false;
196         }
197
198         fprintf(outfile, "plot '-' title 'PDF', '-' title 'mean' with impulses, '-' title '1-stddev' with histeps, '-' title '2-stddev' with histeps, '-' title '3-stddev' with histeps, '-' title '4-stddev' with histeps, '-' title '5-stddev' with histeps, '-' title '6-stddev' with histeps\n");
199
200         for(i = 0; i < stats->nbuckets; i++) {
201                 fprintf(outfile, "%d %u\n", stats->buckets[i].residual, stats->buckets[i].count);
202         }
203         fprintf(outfile, "e\n");
204
205         fprintf(outfile, "%f %f\ne\n", stats->mean, p);
206         fprintf(outfile, "%f %f\n%f %f\ne\n", m-s1, p*0.8, m+s1, p*0.8);
207         fprintf(outfile, "%f %f\n%f %f\ne\n", m-s2, p*0.7, m+s2, p*0.7);
208         fprintf(outfile, "%f %f\n%f %f\ne\n", m-s3, p*0.6, m+s3, p*0.6);
209         fprintf(outfile, "%f %f\n%f %f\ne\n", m-s4, p*0.5, m+s4, p*0.5);
210         fprintf(outfile, "%f %f\n%f %f\ne\n", m-s5, p*0.4, m+s5, p*0.4);
211         fprintf(outfile, "%f %f\n%f %f\ne\n", m-s6, p*0.3, m+s6, p*0.3);
212
213         fprintf(outfile, "pause -1 'waiting...'\n");
214
215         fclose(outfile);
216         return true;
217 }