flesh out --replay-gain implementation, make the encoder add a 4k padding block by...
[flac.git] / src / flac / main.c
1 /* flac - Command-line FLAC encoder/decoder
2  * Copyright (C) 2000,2001,2002  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 <ctype.h>
20 #include <locale.h>
21 #include <stdarg.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25
26 #ifdef HAVE_CONFIG_H
27 #include <config.h>
28 #endif
29
30 #if !defined _MSC_VER && !defined __MINGW32__
31 /* unlink is in stdio.h in VC++ */
32 #include <unistd.h> /* for unlink() */
33 #else
34 #define strcasecmp stricmp
35 #endif
36 #include "FLAC/all.h"
37 #include "share/file_utils.h"
38 #include "share/replaygain.h"
39 #include "analyze.h"
40 #include "decode.h"
41 #include "encode.h"
42 #include "vorbiscomment.h"
43
44 #if 0
45 /*[JEC] was:#if HAVE_GETOPT_LONG*/
46 /*[JEC] see flac/include/share/getopt.h as to why the change */
47 #  include <getopt.h>
48 #else
49 #  include "share/getopt.h"
50 #endif
51
52 typedef enum { RAW, WAV, AIF } FileFormat;
53
54 static int do_it();
55
56 static FLAC__bool init_options();
57 static int parse_options(int argc, char *argv[]);
58 static int parse_option(int short_option, const char *long_option, const char *option_argument);
59 static void free_options();
60
61 static int usage_error(const char *message, ...);
62 static void short_usage();
63 static void show_version();
64 static void show_help();
65 static void show_explain();
66 static void format_mistake(const char *infilename, const char *wrong, const char *right);
67
68 static int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file);
69 static int decode_file(const char *infilename);
70
71 static const char *get_encoded_outfilename(const char *infilename);
72 static const char *get_decoded_outfilename(const char *infilename);
73
74 static void die(const char *message);
75 static char *local_strdup(const char *source);
76
77
78 /*
79  * FLAC__share__getopt format struct; note that for long options with no
80  * short option equivalent we just set the 'val' field to 0.
81  */
82 static struct FLAC__share__option long_options_[] = {
83         /*
84          * general options
85          */
86         { "help", 0, 0, 'h' },
87         { "explain", 0, 0, 'H' },
88         { "version", 0, 0, 'v' },
89         { "decode", 0, 0, 'd' },
90         { "analyze", 0, 0, 'a' },
91         { "test", 0, 0, 't' },
92         { "stdout", 0, 0, 'c' },
93         { "silent", 0, 0, 's' },
94         { "delete-input-file", 0, 0, 0 },
95         { "output-prefix", 1, 0, 0 },
96         { "output-name", 1, 0, 'o' },
97         { "skip", 1, 0, 0 },
98
99         /*
100          * decoding options
101          */
102         { "decode-through-errors", 0, 0, 'F' },
103
104         /*
105          * encoding options
106          */
107         { "tag", 1, 0, 'T' },
108         { "compression-level-0", 0, 0, '0' },
109         { "compression-level-1", 0, 0, '1' },
110         { "compression-level-2", 0, 0, '2' },
111         { "compression-level-3", 0, 0, '3' },
112         { "compression-level-4", 0, 0, '4' },
113         { "compression-level-5", 0, 0, '5' },
114         { "compression-level-6", 0, 0, '6' },
115         { "compression-level-7", 0, 0, '7' },
116         { "compression-level-8", 0, 0, '8' },
117         { "compression-level-9", 0, 0, '9' },
118         { "best", 0, 0, '8' },
119         { "fast", 0, 0, '0' },
120         { "super-secret-impractical-compression-level", 0, 0, 0 },
121         { "verify", 0, 0, 'V' },
122         { "force-raw-format", 0, 0, 0 },
123         { "lax", 0, 0, 0 },
124         { "replay-gain", 0, 0, 0 },
125         { "sector-align", 0, 0, 0 },
126         { "seekpoint", 1, 0, 'S' },
127         { "padding", 1, 0, 'P' },
128 #ifdef FLAC__HAS_OGG
129         { "ogg", 0, 0, 0 },
130         { "serial-number", 1, 0, 0 },
131 #endif
132         { "blocksize", 1, 0, 'b' },
133         { "exhaustive-model-search", 0, 0, 'e' },
134 #if 0
135         /* @@@ deprecated: */
136         { "escape-coding", 0, 0, 'E' },
137 #endif
138         { "max-lpc-order", 1, 0, 'l' },
139         { "mid-side", 0, 0, 'm' },
140         { "adaptive-mid-side", 0, 0, 'M' },
141         { "qlp-coeff-precision-search", 0, 0, 'p' },
142         { "qlp-coeff-precision", 1, 0, 'q' },
143         { "rice-partition-order", 1, 0, 'r' },
144 #if 0
145         /* @@@ deprecated: */
146         { "rice-parameter-search-distance", 1, 0, 'R' },
147 #endif
148         { "endian", 1, 0, 0 },
149         { "channels", 1, 0, 0 },
150         { "bps", 1, 0, 0 },
151         { "sample-rate", 1, 0, 0 },
152         { "sign", 1, 0, 0 },
153
154         /*
155          * analysis options
156          */
157         { "residual-gnu-plot", 0, 0, 0 },
158         { "residual-text", 0, 0, 0 },
159
160         /*
161          * negatives
162          */
163         { "no-decode-through-errors", 0, 0, 0 },
164         { "no-silent", 0, 0, 0 },
165         { "no-seektable", 0, 0, 0 },
166         { "no-delete-input-file", 0, 0, 0 },
167         { "no-replay-gain", 0, 0, 0 },
168         { "no-sector-align", 0, 0, 0 },
169         { "no-lax", 0, 0, 0 },
170 #ifdef FLAC__HAS_OGG
171         { "no-ogg", 0, 0, 0 },
172 #endif
173         { "no-exhaustive-model-search", 0, 0, 0 },
174 #if 0
175         /* @@@ deprecated: */
176         { "no-escape-coding", 0, 0, 0 },
177 #endif
178         { "no-mid-side", 0, 0, 0 },
179         { "no-adaptive-mid-side", 0, 0, 0 },
180         { "no-qlp-coeff-prec-search", 0, 0, 0 },
181         { "no-padding", 0, 0, 0 },
182         { "no-verify", 0, 0, 0 },
183         { "no-residual-gnuplot", 0, 0, 0 },
184         { "no-residual-text", 0, 0, 0 },
185         /*
186          * undocumented debugging options for the test suite
187          */
188         { "disable-constant-subframes", 0, 0, 0 },
189         { "disable-fixed-subframes", 0, 0, 0 },
190         { "disable-verbatim-subframes", 0, 0, 0 },
191
192         {0, 0, 0, 0}
193 };
194
195
196 /*
197  * global to hold command-line option values
198  */
199
200 static struct {
201         FLAC__bool show_help;
202         FLAC__bool show_explain;
203         FLAC__bool show_version;
204         FLAC__bool mode_decode;
205         FLAC__bool verify;
206         FLAC__bool verbose;
207         FLAC__bool continue_through_decode_errors;
208         FLAC__bool lax;
209         FLAC__bool test_only;
210         FLAC__bool analyze;
211         FLAC__bool use_ogg;
212         FLAC__bool has_serial_number; /* true iff --serial-number was used */
213         long serial_number; /* this is the Ogg serial number and is unused for native FLAC */
214         FLAC__bool do_mid_side;
215         FLAC__bool loose_mid_side;
216         FLAC__bool do_exhaustive_model_search;
217         FLAC__bool do_escape_coding;
218         FLAC__bool do_qlp_coeff_prec_search;
219         FLAC__bool force_to_stdout;
220         FLAC__bool force_raw_format;
221         FLAC__bool delete_input;
222         FLAC__bool replay_gain;
223         FLAC__bool sector_align;
224         const char *cmdline_forced_outfilename;
225         const char *output_prefix;
226         analysis_options aopts;
227         int padding;
228         unsigned max_lpc_order;
229         unsigned qlp_coeff_precision;
230         FLAC__uint64 skip;
231         int format_is_big_endian;
232         int format_is_unsigned_samples;
233         int format_channels;
234         int format_bps;
235         int format_sample_rate;
236         int blocksize;
237         int min_residual_partition_order;
238         int max_residual_partition_order;
239         int rice_parameter_search_dist;
240         char requested_seek_points[50000]; /* @@@ bad MAGIC NUMBER */
241         int num_requested_seek_points; /* -1 => no -S options were given, 0 => -S- was given */
242
243         unsigned num_files;
244         char **filenames;
245
246         FLAC__StreamMetadata *vorbis_comment;
247
248         struct {
249                 FLAC__bool disable_constant_subframes;
250                 FLAC__bool disable_fixed_subframes;
251                 FLAC__bool disable_verbatim_subframes;
252         } debug;
253 } option_values;
254
255
256 /*
257  * miscellaneous globals
258  */
259
260 static FLAC__int32 align_reservoir_0[588], align_reservoir_1[588]; /* for carrying over samples from --sector-align */
261 static FLAC__int32 *align_reservoir[2] = { align_reservoir_0, align_reservoir_1 };
262 static unsigned align_reservoir_samples = 0; /* 0 .. 587 */
263
264
265 int main(int argc, char *argv[])
266 {
267         int retval = 0;
268
269         setlocale(LC_ALL, "");
270         if(!init_options()) {
271                 fprintf(stderr, "ERROR: allocating memory\n");
272                 retval = 1;
273         }
274         else {
275                 if((retval = parse_options(argc, argv)) == 0)
276                         retval = do_it();
277         }
278
279         free_options();
280
281         return retval;
282 }
283
284 int do_it()
285 {
286         int retval = 0;
287
288         if(option_values.show_version) {
289                 show_version();
290                 return 0;
291         }
292         else if(option_values.show_explain) {
293                 show_explain();
294                 return 0;
295         }
296         else if(option_values.show_help) {
297                 show_help();
298                 return 0;
299         }
300         else {
301                 if(option_values.num_files == 0) {
302                         short_usage();
303                         return 0;
304                 }
305
306                 /*
307                  * tweak options; validate the values
308                  */
309                 if(!option_values.mode_decode) {
310                         if(option_values.blocksize < 0) {
311                                 if(option_values.max_lpc_order == 0)
312                                         option_values.blocksize = 1152;
313                                 else
314                                         option_values.blocksize = 4608;
315                         }
316                         if(option_values.max_residual_partition_order < 0) {
317                                 if(option_values.blocksize <= 1152)
318                                         option_values.max_residual_partition_order = 2;
319                                 else if(option_values.blocksize <= 2304)
320                                         option_values.max_residual_partition_order = 3;
321                                 else if(option_values.blocksize <= 4608)
322                                         option_values.max_residual_partition_order = 3;
323                                 else
324                                         option_values.max_residual_partition_order = 4;
325                                 option_values.min_residual_partition_order = option_values.max_residual_partition_order;
326                         }
327                         if(option_values.rice_parameter_search_dist < 0) {
328                                 option_values.rice_parameter_search_dist = 0;
329                         }
330                 }
331                 else {
332                         if(option_values.test_only) {
333                                 if(option_values.skip > 0)
334                                         return usage_error("ERROR: --skip is not allowed in test mode\n");
335                         }
336                 }
337
338                 FLAC__ASSERT(option_values.blocksize >= 0 || option_values.mode_decode);
339
340                 if(option_values.format_channels >= 0) {
341                         if(option_values.format_channels == 0 || (unsigned)option_values.format_channels > FLAC__MAX_CHANNELS)
342                                 return usage_error("ERROR: invalid number of channels '%u', must be > 0 and <= %u\n", option_values.format_channels, FLAC__MAX_CHANNELS);
343                 }
344                 if(option_values.format_bps >= 0) {
345                         if(option_values.format_bps != 8 && option_values.format_bps != 16 && option_values.format_bps != 24)
346                                 return usage_error("ERROR: invalid bits per sample '%u' (must be 8/16/24)\n", option_values.format_bps);
347                 }
348                 if(option_values.format_sample_rate >= 0) {
349                         if(!FLAC__format_sample_rate_is_valid(option_values.format_sample_rate))
350                                 return usage_error("ERROR: invalid sample rate '%u', must be > 0 and <= %u\n", option_values.format_sample_rate, FLAC__MAX_SAMPLE_RATE);
351                 }
352                 if(option_values.mode_decode) {
353                         if(!option_values.force_raw_format) {
354                                 if(option_values.format_is_big_endian >= 0)
355                                         return usage_error("ERROR: --endian only allowed with --force-raw-format\n");
356                                 if(option_values.format_is_unsigned_samples >= 0)
357                                         return usage_error("ERROR: --sign only allowed with --force-raw-format\n");
358                         }
359                         if(option_values.format_channels >= 0)
360                                 return usage_error("ERROR: --channels not allowed with --decode\n");
361                         if(option_values.format_bps >= 0)
362                                 return usage_error("ERROR: --bps not allowed with --decode\n");
363                         if(option_values.format_sample_rate >= 0)
364                                 return usage_error("ERROR: --sample-rate not allowed with --decode\n");
365                 }
366                 if(!option_values.mode_decode && ((unsigned)option_values.blocksize < FLAC__MIN_BLOCK_SIZE || (unsigned)option_values.blocksize > FLAC__MAX_BLOCK_SIZE)) {
367                         return usage_error("ERROR: invalid blocksize '%u', must be >= %u and <= %u\n", (unsigned)option_values.blocksize, FLAC__MIN_BLOCK_SIZE, FLAC__MAX_BLOCK_SIZE);
368                 }
369                 if(option_values.qlp_coeff_precision > 0 && option_values.qlp_coeff_precision < FLAC__MIN_QLP_COEFF_PRECISION) {
370                         return usage_error("ERROR: invalid value '%u' for qlp coeff precision, must be 0 or >= %u\n", option_values.qlp_coeff_precision, FLAC__MIN_QLP_COEFF_PRECISION);
371                 }
372
373                 if(option_values.sector_align) {
374                         if(option_values.mode_decode)
375                                 return usage_error("ERROR: --sector-align only allowed for encoding\n");
376                         if(option_values.skip > 0)
377                                 return usage_error("ERROR: --sector-align not allowed with --skip\n");
378                         if(option_values.format_channels >= 0 && option_values.format_channels != 2)
379                                 return usage_error("ERROR: --sector-align can only be done with stereo input\n");
380                         if(option_values.format_bps >= 0 && option_values.format_bps != 16)
381                                 return usage_error("ERROR: --sector-align can only be done with 16-bit samples\n");
382                         if(option_values.format_sample_rate >= 0 && option_values.format_sample_rate != 44100)
383                                 return usage_error("ERROR: --sector-align can only be done with a sample rate of 44100\n");
384                 }
385                 if(option_values.replay_gain) {
386                         if(option_values.force_to_stdout)
387                                 return usage_error("ERROR: --replay-gain not allowed with -c/--stdout\n");
388                         if(option_values.mode_decode)
389                                 return usage_error("ERROR: --replay-gain only allowed for encoding\n");
390                         if(option_values.skip > 0)
391                                 return usage_error("ERROR: --replay-gain not allowed with --skip\n");
392                         if(option_values.format_channels > 2)
393                                 return usage_error("ERROR: --replay-gain can only be done with mono/stereo input\n");
394                         if(option_values.format_sample_rate >= 0 && !FLAC__replaygain_is_valid_sample_frequency(option_values.format_sample_rate))
395                                 return usage_error("ERROR: invalid sample rate used with --replay-gain\n");
396                         /*
397                          * We want to reserve padding space for the ReplayGain
398                          * tags that we will set later, to avoid rewriting the
399                          * whole file.
400                          */
401                         if(option_values.padding < 0) {
402                                 fprintf(stderr, "NOTE: --replay-gain may leave a small PADDING block even with --no-padding\n");
403                                 option_values.padding = FLAC__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
404                         }
405                         else {
406                                 option_values.padding += FLAC__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
407                         }
408                 }
409                 if(option_values.num_files > 1 && option_values.cmdline_forced_outfilename) {
410                         return usage_error("ERROR: -o/--output-name cannot be used with multiple files\n");
411                 }
412                 if(option_values.cmdline_forced_outfilename && option_values.output_prefix) {
413                         return usage_error("ERROR: --output-prefix conflicts with -o/--output-name\n");
414                 }
415         }
416         if(option_values.verbose) {
417                 fprintf(stderr, "\n");
418                 fprintf(stderr, "flac %s, Copyright (C) 2000,2001,2002 Josh Coalson\n", FLAC__VERSION_STRING);
419                 fprintf(stderr, "flac comes with ABSOLUTELY NO WARRANTY.  This is free software, and you are\n");
420                 fprintf(stderr, "welcome to redistribute it under certain conditions.  Type `flac' for details.\n\n");
421
422                 if(!option_values.mode_decode) {
423                         char padopt[16];
424                         if(option_values.padding < 0)
425                                 strcpy(padopt, "-");
426                         else
427                                 sprintf(padopt, " %d", option_values.padding);
428                         fprintf(stderr,
429                                 "options:%s%s%s%s -P%s -b %u%s -l %u%s%s%s -q %u -r %u,%u%s\n",
430                                 option_values.delete_input?" --delete-input-file":"",
431                                 option_values.sector_align?" --sector-align":"",
432                                 option_values.use_ogg?" --ogg":"",
433                                 option_values.lax?" --lax":"",
434                                 padopt,
435                                 (unsigned)option_values.blocksize,
436                                 option_values.loose_mid_side?" -M":option_values.do_mid_side?" -m":"",
437                                 option_values.max_lpc_order,
438                                 option_values.do_exhaustive_model_search?" -e":"",
439                                 option_values.do_escape_coding?" -E":"",
440                                 option_values.do_qlp_coeff_prec_search?" -p":"",
441                                 option_values.qlp_coeff_precision,
442                                 (unsigned)option_values.min_residual_partition_order,
443                                 (unsigned)option_values.max_residual_partition_order,
444                                 option_values.verify? " -V":""
445                         );
446                 }
447         }
448
449         if(option_values.mode_decode) {
450                 FLAC__bool first = true;
451
452                 if(option_values.num_files == 0) {
453                         retval = decode_file("-");
454                 }
455                 else {
456                         unsigned i;
457                         if(option_values.num_files > 1)
458                                 option_values.cmdline_forced_outfilename = 0;
459                         for(i = 0, retval = 0; i < option_values.num_files; i++) {
460                                 if(0 == strcmp(option_values.filenames[i], "-") && !first)
461                                         continue;
462                                 retval |= decode_file(option_values.filenames[i]);
463                                 first = false;
464                         }
465                 }
466         }
467         else { /* encode */
468                 FLAC__bool first = true;
469
470                 if(option_values.num_files == 0) {
471                         retval = encode_file("-", first, true);
472                 }
473                 else {
474                         unsigned i;
475                         if(option_values.num_files > 1)
476                                 option_values.cmdline_forced_outfilename = 0;
477                         for(i = 0, retval = 0; i < option_values.num_files; i++) {
478                                 if(0 == strcmp(option_values.filenames[i], "-") && !first)
479                                         continue;
480                                 retval |= encode_file(option_values.filenames[i], first, i == (option_values.num_files-1));
481                                 first = false;
482                         }
483                         if(option_values.replay_gain && retval == 0) {
484                                 float album_gain, album_peak;
485                                 FLAC__replaygain_get_album(&album_gain, &album_peak);
486                                 for(i = 0; i < option_values.num_files; i++) {
487                                         const char *error, *outfilename = get_encoded_outfilename(option_values.filenames[i]);
488                                         if(0 == strcmp(option_values.filenames[i], "-"))
489                                                 FLAC__ASSERT(0);
490                                         if(0 != (error = FLAC__replaygain_store_to_file_album(outfilename, album_gain, album_peak, /*preserve_modtime=*/true))) {
491                                                 fprintf(stderr, "%s: ERROR writing ReplayGain album tags\n", outfilename);
492                                                 retval = 1;
493                                         }
494                                 }
495                         }
496                 }
497         }
498
499         return retval;
500 }
501
502 FLAC__bool init_options()
503 {
504         option_values.show_help = false;
505         option_values.show_explain = false;
506         option_values.mode_decode = false;
507         option_values.verify = false;
508         option_values.verbose = true;
509         option_values.continue_through_decode_errors = false;
510         option_values.lax = false;
511         option_values.test_only = false;
512         option_values.analyze = false;
513         option_values.use_ogg = false;
514         option_values.has_serial_number = false;
515         option_values.serial_number = 0;
516         option_values.do_mid_side = true;
517         option_values.loose_mid_side = false;
518         option_values.do_exhaustive_model_search = false;
519         option_values.do_escape_coding = false;
520         option_values.do_qlp_coeff_prec_search = false;
521         option_values.force_to_stdout = false;
522         option_values.force_raw_format = false;
523         option_values.delete_input = false;
524         option_values.replay_gain = false;
525         option_values.sector_align = false;
526         option_values.cmdline_forced_outfilename = 0;
527         option_values.output_prefix = 0;
528         option_values.aopts.do_residual_text = false;
529         option_values.aopts.do_residual_gnuplot = false;
530         option_values.padding = 4096;
531         option_values.max_lpc_order = 8;
532         option_values.qlp_coeff_precision = 0;
533         option_values.skip = 0;
534         option_values.format_is_big_endian = -1;
535         option_values.format_is_unsigned_samples = -1;
536         option_values.format_channels = -1;
537         option_values.format_bps = -1;
538         option_values.format_sample_rate = -1;
539         option_values.blocksize = -1;
540         option_values.min_residual_partition_order = -1;
541         option_values.max_residual_partition_order = -1;
542         option_values.rice_parameter_search_dist = -1;
543         option_values.requested_seek_points[0] = '\0';
544         option_values.num_requested_seek_points = -1;
545
546         option_values.num_files = 0;
547         option_values.filenames = 0;
548
549         if(0 == (option_values.vorbis_comment = FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT)))
550                 return false;
551
552         option_values.debug.disable_constant_subframes = false;
553         option_values.debug.disable_fixed_subframes = false;
554         option_values.debug.disable_verbatim_subframes = false;
555
556         return true;
557 }
558
559 int parse_options(int argc, char *argv[])
560 {
561         int short_option;
562         int option_index = 1;
563         FLAC__bool had_error = false;
564         /*@@@ E and R: are deprecated */
565         const char *short_opts = "0123456789ab:cdeFhHl:mMo:pP:q:r:sS:tT:vV";
566
567         while ((short_option = FLAC__share__getopt_long(argc, argv, short_opts, long_options_, &option_index)) != -1) {
568                 switch (short_option) {
569                         case 0: /* long option with no equivalent short option */
570                                 had_error |= (parse_option(short_option, long_options_[option_index].name, FLAC__share__optarg) != 0);
571                                 break;
572                         case '?':
573                         case ':':
574                                 had_error = true;
575                                 break;
576                         default: /* short option */
577                                 had_error |= (parse_option(short_option, 0, FLAC__share__optarg) != 0);
578                                 break;
579                 }
580         }
581
582         if(had_error) {
583                 return 1;
584         }
585
586         FLAC__ASSERT(FLAC__share__optind <= argc);
587
588         option_values.num_files = argc - FLAC__share__optind;
589
590         if(option_values.num_files > 0) {
591                 unsigned i = 0;
592                 if(0 == (option_values.filenames = malloc(sizeof(char *) * option_values.num_files)))
593                         die("out of memory allocating space for file names list");
594                 while(FLAC__share__optind < argc)
595                         option_values.filenames[i++] = local_strdup(argv[FLAC__share__optind++]);
596         }
597
598         return 0;
599 }
600
601 int parse_option(int short_option, const char *long_option, const char *option_argument)
602 {
603         char *p;
604
605         if(short_option == 0) {
606                 FLAC__ASSERT(0 != long_option);
607                 if(0 == strcmp(long_option, "delete-input-file")) {
608                         option_values.delete_input = true;
609                 }
610                 else if(0 == strcmp(long_option, "output-prefix")) {
611                         FLAC__ASSERT(0 != option_argument);
612                         option_values.output_prefix = option_argument;
613                 }
614                 else if(0 == strcmp(long_option, "skip")) {
615                         FLAC__ASSERT(0 != option_argument);
616                         option_values.skip = (FLAC__uint64)atoi(option_argument); /* @@@ takes a pretty damn big file to overflow atoi() here, but it could happen */
617                 }
618                 else if(0 == strcmp(long_option, "super-secret-impractical-compression-level")) {
619                         option_values.do_exhaustive_model_search = true;
620                         option_values.do_escape_coding = true;
621                         option_values.do_mid_side = true;
622                         option_values.loose_mid_side = false;
623                         option_values.do_qlp_coeff_prec_search = true;
624                         option_values.min_residual_partition_order = 0;
625                         option_values.max_residual_partition_order = 16;
626                         option_values.rice_parameter_search_dist = 0;
627                         option_values.max_lpc_order = 32;
628                 }
629                 else if(0 == strcmp(long_option, "force-raw-format")) {
630                         option_values.force_raw_format = true;
631                 }
632                 else if(0 == strcmp(long_option, "lax")) {
633                         option_values.lax = true;
634                 }
635                 else if(0 == strcmp(long_option, "replay-gain")) {
636                         option_values.replay_gain = true;
637                 }
638                 else if(0 == strcmp(long_option, "sector-align")) {
639                         option_values.sector_align = true;
640                 }
641 #ifdef FLAC__HAS_OGG
642                 else if(0 == strcmp(long_option, "ogg")) {
643                         option_values.use_ogg = true;
644                 }
645                 else if(0 == strcmp(long_option, "serial-number")) {
646                         option_values.has_serial_number = true;
647                         option_values.serial_number = atol(option_argument);
648                 }
649 #endif
650                 else if(0 == strcmp(long_option, "endian")) {
651                         FLAC__ASSERT(0 != option_argument);
652                         if(0 == strncmp(option_argument, "big", strlen(option_argument)))
653                                 option_values.format_is_big_endian = true;
654                         else if(0 == strncmp(option_argument, "little", strlen(option_argument)))
655                                 option_values.format_is_big_endian = false;
656                         else
657                                 return usage_error("ERROR: argument to --endian must be \"big\" or \"little\"\n");
658                 }
659                 else if(0 == strcmp(long_option, "channels")) {
660                         FLAC__ASSERT(0 != option_argument);
661                         option_values.format_channels = atoi(option_argument);
662                 }
663                 else if(0 == strcmp(long_option, "bps")) {
664                         FLAC__ASSERT(0 != option_argument);
665                         option_values.format_bps = atoi(option_argument);
666                 }
667                 else if(0 == strcmp(long_option, "sample-rate")) {
668                         FLAC__ASSERT(0 != option_argument);
669                         option_values.format_sample_rate = atoi(option_argument);
670                 }
671                 else if(0 == strcmp(long_option, "sign")) {
672                         FLAC__ASSERT(0 != option_argument);
673                         if(0 == strncmp(option_argument, "signed", strlen(option_argument)))
674                                 option_values.format_is_unsigned_samples = false;
675                         else if(0 == strncmp(option_argument, "unsigned", strlen(option_argument)))
676                                 option_values.format_is_unsigned_samples = true;
677                         else
678                                 return usage_error("ERROR: argument to --sign must be \"signed\" or \"unsigned\"\n");
679                 }
680                 else if(0 == strcmp(long_option, "residual-gnu-plot")) {
681                         option_values.aopts.do_residual_gnuplot = true;
682                 }
683                 else if(0 == strcmp(long_option, "residual-text")) {
684                         option_values.aopts.do_residual_text = true;
685                 }
686                 /*
687                  * negatives
688                  */
689                 else if(0 == strcmp(long_option, "no-decode-through-errors")) {
690                         option_values.continue_through_decode_errors = false;
691                 }
692                 else if(0 == strcmp(long_option, "no-silent")) {
693                         option_values.verbose = true;
694                 }
695                 else if(0 == strcmp(long_option, "no-seektable")) {
696                         option_values.num_requested_seek_points = 0;
697                         option_values.requested_seek_points[0] = '\0';
698                 }
699                 else if(0 == strcmp(long_option, "no-delete-input-file")) {
700                         option_values.delete_input = false;
701                 }
702                 else if(0 == strcmp(long_option, "no-replay-gain")) {
703                         option_values.replay_gain = false;
704                 }
705                 else if(0 == strcmp(long_option, "no-sector-align")) {
706                         option_values.sector_align = false;
707                 }
708                 else if(0 == strcmp(long_option, "no-lax")) {
709                         option_values.lax = false;
710                 }
711 #ifdef FLAC__HAS_OGG
712                 else if(0 == strcmp(long_option, "no-ogg")) {
713                         option_values.use_ogg = false;
714                 }
715 #endif
716                 else if(0 == strcmp(long_option, "no-exhaustive-model-search")) {
717                         option_values.do_exhaustive_model_search = false;
718                 }
719 #if 0
720                 /* @@@ deprecated: */
721                 else if(0 == strcmp(long_option, "no-escape-coding")) {
722                         option_values.do_escape_coding = false;
723                 }
724 #endif
725                 else if(0 == strcmp(long_option, "no-mid-side")) {
726                         option_values.do_mid_side = option_values.loose_mid_side = false;
727                 }
728                 else if(0 == strcmp(long_option, "no-adaptive-mid-side")) {
729                         option_values.loose_mid_side = option_values.do_mid_side = false;
730                 }
731                 else if(0 == strcmp(long_option, "no-qlp-coeff-prec-search")) {
732                         option_values.do_qlp_coeff_prec_search = false;
733                 }
734                 else if(0 == strcmp(long_option, "no-padding")) {
735                         option_values.padding = -1;
736                 }
737                 else if(0 == strcmp(long_option, "no-verify")) {
738                         option_values.verify = false;
739                 }
740                 else if(0 == strcmp(long_option, "no-residual-gnuplot")) {
741                         option_values.aopts.do_residual_gnuplot = false;
742                 }
743                 else if(0 == strcmp(long_option, "no-residual-text")) {
744                         option_values.aopts.do_residual_text = false;
745                 }
746                 else if(0 == strcmp(long_option, "disable-constant-subframes")) {
747                         option_values.debug.disable_constant_subframes = true;
748                 }
749                 else if(0 == strcmp(long_option, "disable-fixed-subframes")) {
750                         option_values.debug.disable_fixed_subframes = true;
751                 }
752                 else if(0 == strcmp(long_option, "disable-verbatim-subframes")) {
753                         option_values.debug.disable_verbatim_subframes = true;
754                 }
755         }
756         else {
757                 const char *violation;
758                 switch(short_option) {
759                         case 'h':
760                                 option_values.show_help = true;
761                                 break;
762                         case 'H':
763                                 option_values.show_explain = true;
764                                 break;
765                         case 'v':
766                                 option_values.show_version = true;
767                                 break;
768                         case 'd':
769                                 option_values.mode_decode = true;
770                                 break;
771                         case 'a':
772                                 option_values.mode_decode = true;
773                                 option_values.analyze = true;
774                                 break;
775                         case 't':
776                                 option_values.mode_decode = true;
777                                 option_values.test_only = true;
778                                 break;
779                         case 'c':
780                                 option_values.force_to_stdout = true;
781                                 break;
782                         case 's':
783                                 option_values.verbose = false;
784                                 break;
785                         case 'o':
786                                 FLAC__ASSERT(0 != option_argument);
787                                 option_values.cmdline_forced_outfilename = option_argument;
788                                 break;
789                         case 'F':
790                                 option_values.continue_through_decode_errors = true;
791                                 break;
792                         case 'T':
793                                 FLAC__ASSERT(0 != option_argument);
794                                 if(!flac__vorbiscomment_add(option_values.vorbis_comment, option_argument, &violation))
795                                         return usage_error("ERROR: (-T/--tag) %s\n", violation);
796                                 break;
797                         case '0':
798                                 option_values.do_exhaustive_model_search = false;
799                                 option_values.do_escape_coding = false;
800                                 option_values.do_mid_side = false;
801                                 option_values.loose_mid_side = false;
802                                 option_values.qlp_coeff_precision = 0;
803                                 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 2;
804                                 option_values.rice_parameter_search_dist = 0;
805                                 option_values.max_lpc_order = 0;
806                                 break;
807                         case '1':
808                                 option_values.do_exhaustive_model_search = false;
809                                 option_values.do_escape_coding = false;
810                                 option_values.do_mid_side = true;
811                                 option_values.loose_mid_side = true;
812                                 option_values.qlp_coeff_precision = 0;
813                                 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 2;
814                                 option_values.rice_parameter_search_dist = 0;
815                                 option_values.max_lpc_order = 0;
816                                 break;
817                         case '2':
818                                 option_values.do_exhaustive_model_search = false;
819                                 option_values.do_escape_coding = false;
820                                 option_values.do_mid_side = true;
821                                 option_values.loose_mid_side = false;
822                                 option_values.qlp_coeff_precision = 0;
823                                 option_values.min_residual_partition_order = 0;
824                                 option_values.max_residual_partition_order = 3;
825                                 option_values.rice_parameter_search_dist = 0;
826                                 option_values.max_lpc_order = 0;
827                                 break;
828                         case '3':
829                                 option_values.do_exhaustive_model_search = false;
830                                 option_values.do_escape_coding = false;
831                                 option_values.do_mid_side = false;
832                                 option_values.loose_mid_side = false;
833                                 option_values.qlp_coeff_precision = 0;
834                                 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
835                                 option_values.rice_parameter_search_dist = 0;
836                                 option_values.max_lpc_order = 6;
837                                 break;
838                         case '4':
839                                 option_values.do_exhaustive_model_search = false;
840                                 option_values.do_escape_coding = false;
841                                 option_values.do_mid_side = true;
842                                 option_values.loose_mid_side = true;
843                                 option_values.qlp_coeff_precision = 0;
844                                 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
845                                 option_values.rice_parameter_search_dist = 0;
846                                 option_values.max_lpc_order = 8;
847                                 break;
848                         case '5':
849                                 option_values.do_exhaustive_model_search = false;
850                                 option_values.do_escape_coding = false;
851                                 option_values.do_mid_side = true;
852                                 option_values.loose_mid_side = false;
853                                 option_values.qlp_coeff_precision = 0;
854                                 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
855                                 option_values.rice_parameter_search_dist = 0;
856                                 option_values.max_lpc_order = 8;
857                                 break;
858                         case '6':
859                                 option_values.do_exhaustive_model_search = false;
860                                 option_values.do_escape_coding = false;
861                                 option_values.do_mid_side = true;
862                                 option_values.loose_mid_side = false;
863                                 option_values.qlp_coeff_precision = 0;
864                                 option_values.min_residual_partition_order = 0;
865                                 option_values.max_residual_partition_order = 4;
866                                 option_values.rice_parameter_search_dist = 0;
867                                 option_values.max_lpc_order = 8;
868                                 break;
869                         case '7':
870                                 option_values.do_exhaustive_model_search = true;
871                                 option_values.do_escape_coding = false;
872                                 option_values.do_mid_side = true;
873                                 option_values.loose_mid_side = false;
874                                 option_values.qlp_coeff_precision = 0;
875                                 option_values.min_residual_partition_order = 0;
876                                 option_values.max_residual_partition_order = 6;
877                                 option_values.rice_parameter_search_dist = 0;
878                                 option_values.max_lpc_order = 8;
879                                 break;
880                         case '8':
881                                 option_values.do_exhaustive_model_search = true;
882                                 option_values.do_escape_coding = false;
883                                 option_values.do_mid_side = true;
884                                 option_values.loose_mid_side = false;
885                                 option_values.qlp_coeff_precision = 0;
886                                 option_values.min_residual_partition_order = 0;
887                                 option_values.max_residual_partition_order = 6;
888                                 option_values.rice_parameter_search_dist = 0;
889                                 option_values.max_lpc_order = 12;
890                                 break;
891                         case '9':
892                                 return usage_error("ERROR: compression level '9' is reserved\n");
893                         case 'V':
894                                 option_values.verify = true;
895                                 break;
896                         case 'S':
897                                 FLAC__ASSERT(0 != option_argument);
898                                 if(option_values.num_requested_seek_points < 0)
899                                         option_values.num_requested_seek_points = 0;
900                                 option_values.num_requested_seek_points++;
901                                 strcat(option_values.requested_seek_points, option_argument);
902                                 strcat(option_values.requested_seek_points, "<");
903                                 break;
904                         case 'P':
905                                 FLAC__ASSERT(0 != option_argument);
906                                 option_values.padding = atoi(option_argument);
907                                 if(option_values.padding < 0)
908                                         return usage_error("ERROR: argument to -P must be >= 0\n");
909                                 break;
910                         case 'b':
911                                 FLAC__ASSERT(0 != option_argument);
912                                 option_values.blocksize = atoi(option_argument);
913                                 break;
914                         case 'e':
915                                 option_values.do_exhaustive_model_search = true;
916                                 break;
917                         case 'E':
918                                 option_values.do_escape_coding = true;
919                                 break;
920                         case 'l':
921                                 FLAC__ASSERT(0 != option_argument);
922                                 option_values.max_lpc_order = atoi(option_argument);
923                                 break;
924                         case 'm':
925                                 option_values.do_mid_side = true;
926                                 option_values.loose_mid_side = false;
927                                 break;
928                         case 'M':
929                                 option_values.loose_mid_side = option_values.do_mid_side = true;
930                                 break;
931                         case 'p':
932                                 option_values.do_qlp_coeff_prec_search = true;
933                                 break;
934                         case 'q':
935                                 FLAC__ASSERT(0 != option_argument);
936                                 option_values.qlp_coeff_precision = atoi(option_argument);
937                                 break;
938                         case 'r':
939                                 FLAC__ASSERT(0 != option_argument);
940                                 p = strchr(option_argument, ',');
941                                 if(0 == p) {
942                                         option_values.min_residual_partition_order = 0;
943                                         option_values.max_residual_partition_order = atoi(option_argument);
944                                 }
945                                 else {
946                                         option_values.min_residual_partition_order = atoi(option_argument);
947                                         option_values.max_residual_partition_order = atoi(++p);
948                                 }
949                                 break;
950                         case 'R':
951                                 FLAC__ASSERT(0 != option_argument);
952                                 option_values.rice_parameter_search_dist = atoi(option_argument);
953                                 break;
954                         default:
955                                 FLAC__ASSERT(0);
956                 }
957         }
958
959         return 0;
960 }
961
962 void free_options()
963 {
964         if(0 != option_values.filenames)
965                 free(option_values.filenames);
966         if(0 != option_values.vorbis_comment)
967                 FLAC__metadata_object_delete(option_values.vorbis_comment);
968 }
969
970 int usage_error(const char *message, ...)
971 {
972         va_list args;
973
974         FLAC__ASSERT(0 != message);
975
976         va_start(args, message);
977
978         (void) vfprintf(stderr, message, args);
979
980         va_end(args);
981
982         printf("Type \"flac\" for a usage summary or \"flac --help\" for all options\n");
983
984         return 1;
985 }
986
987 void show_version()
988 {
989         printf("flac %s\n", FLAC__VERSION_STRING);
990 }
991
992 static void usage_header()
993 {
994         printf("===============================================================================\n");
995         printf("flac - Command-line FLAC encoder/decoder version %s\n", FLAC__VERSION_STRING);
996         printf("Copyright (C) 2000,2001,2002  Josh Coalson\n");
997         printf("\n");
998         printf("This program is free software; you can redistribute it and/or\n");
999         printf("modify it under the terms of the GNU General Public License\n");
1000         printf("as published by the Free Software Foundation; either version 2\n");
1001         printf("of the License, or (at your option) any later version.\n");
1002         printf("\n");
1003         printf("This program is distributed in the hope that it will be useful,\n");
1004         printf("but WITHOUT ANY WARRANTY; without even the implied warranty of\n");
1005         printf("MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n");
1006         printf("GNU General Public License for more details.\n");
1007         printf("\n");
1008         printf("You should have received a copy of the GNU General Public License\n");
1009         printf("along with this program; if not, write to the Free Software\n");
1010         printf("Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.\n");
1011         printf("===============================================================================\n");
1012 }
1013
1014 static void usage_summary()
1015 {
1016         printf("Usage:\n");
1017         printf("\n");
1018         printf(" Encoding: flac [-s] [--skip #] [<encoding/format-options>] [INPUTFILE [...]]\n");
1019         printf(" Decoding: flac -d [-s] [--skip #] [-F] [<format-options>] [INPUTFILE [...]]\n");
1020         printf("  Testing: flac -t [-s] [INPUTFILE [...]]\n");
1021         printf("Analyzing: flac -a [-s] [--skip #] [<analysis-options>] [INPUTFILE [...]]\n");
1022         printf("\n");
1023 }
1024
1025 void short_usage()
1026 {
1027         usage_header();
1028         printf("\n");
1029         printf("This is the short help; for all options use 'flac --help'; for even more\n");
1030         printf("instructions use 'flac --explain'\n");
1031         printf("\n");
1032         printf("To encode:\n");
1033         printf("  flac [-#] [INPUTFILE [...]]\n");
1034         printf("\n");
1035         printf("  -# is -0 (fastest compression) to -8 (highest compression); -5 is the default\n");
1036         printf("\n");
1037         printf("To decode:\n");
1038         printf("  flac -d [INPUTFILE [...]]\n");
1039         printf("\n");
1040         printf("To test:\n");
1041         printf("  flac -t [INPUTFILE [...]]\n");
1042 }
1043
1044 void show_help()
1045 {
1046         usage_header();
1047         usage_summary();
1048         printf("generic options:\n");
1049         printf("  -v, --version                Show the flac version number\n");
1050         printf("  -h, --help                   Show this screen\n");
1051         printf("  -H, --explain                Show detailed explanation of usage and options\n");
1052         printf("  -d, --decode                 Decode (the default behavior is to encode)\n");
1053         printf("  -t, --test                   Same as -d except no decoded file is written\n");
1054         printf("  -a, --analyze                Same as -d except an analysis file is written\n");
1055         printf("  -c, --stdout                 Write output to stdout\n");
1056         printf("  -s, --silent                 Do not write runtime encode/decode statistics\n");
1057         printf("  -o, --output-name=FILENAME   Force the output file name\n");
1058         printf("      --output-prefix=STRING   Prepend STRING to output names\n");
1059         printf("      --delete-input-file      Deletes after a successful encode/decode\n");
1060         printf("      --skip=#                 Skip the first # samples of each input file\n");
1061         printf("analysis options:\n");
1062         printf("      --residual-text          Include residual signal in text output\n");
1063         printf("      --residual-gnuplot       Generate gnuplot files of residual distribution\n");
1064         printf("decoding options:\n");
1065         printf("  -F, --decode-through-errors  Continue decoding through stream errors\n");
1066         printf("encoding options:\n");
1067         printf("  -V, --verify                 Verify a correct encoding\n");
1068 #ifdef FLAC__HAS_OGG
1069         printf("      --ogg                    Use Ogg as transport layer\n");
1070         printf("      --serial-number          Serial number to use for the FLAC stream\n");
1071 #endif
1072         printf("      --lax                    Allow encoder to generate non-Subset files\n");
1073         printf("      --sector-align           Align multiple files on sector boundaries\n");
1074         printf("      --replay-gain            Calculate ReplayGain & store in Vorbis comments\n");
1075         printf("  -S, --seekpoint={#|X|#x}     Add seek point(s)\n");
1076         printf("  -P, --padding=#              Write a PADDING block of length #\n");
1077         printf("  -T, --tag=FIELD=VALUE        Add a Vorbis comment; may appear multiple times\n");
1078         printf("  -0, --compression-level-0, --fast  Synonymous with -l 0 -b 1152 -r 2,2\n");
1079         printf("  -1, --compression-level-1          Synonymous with -l 0 -b 1152 -M -r 2,2\n");
1080         printf("  -2, --compression-level-2          Synonymous with -l 0 -b 1152 -m -r 3\n");
1081         printf("  -3, --compression-level-3          Synonymous with -l 6 -b 4608 -r 3,3\n");
1082         printf("  -4, --compression-level-4          Synonymous with -l 8 -b 4608 -M -r 3,3\n");
1083         printf("  -5, --compression-level-5          Synonymous with -l 8 -b 4608 -m -r 3,3\n");
1084         printf("  -6, --compression-level-6          Synonymous with -l 8 -b 4608 -m -r 4\n");
1085         printf("  -7, --compression-level-7          Synonymous with -l 8 -b 4608 -m -e -r 6\n");
1086         printf("  -8, --compression-level-8, --best  Synonymous with -l 12 -b 4608 -m -e -r 6\n");
1087         printf("  -b, --blocksize=#                  Specify blocksize in samples\n");
1088         printf("  -m, --mid-side                     Try mid-side coding for each frame\n");
1089         printf("  -M, --adaptive-mid-side            Adaptive mid-side coding for all frames\n");
1090         printf("  -e, --exhaustive-model-search      Do exhaustive model search (expensive!)\n");
1091 #if 0
1092         /*@@@ deprecated: */
1093         printf("  -E, --escape-coding                Do escape coding in the entropy coder\n");
1094 #endif
1095         printf("  -l, --max-lpc-order=#              Max LPC order; 0 => only fixed predictors\n");
1096         printf("  -p, --qlp-coeff-precision-search   Exhaustively search LP coeff quantization\n");
1097         printf("  -q, --qlp-coeff-precision=#        Specify precision in bits\n");
1098         printf("  -r, --rice-partition-order=[#,]#   Set [min,]max residual partition order\n");
1099 #if 0
1100         /*@@@ deprecated: */
1101         printf("  -R, -rice-parameter-search-distance=#   Rice parameter search distance\n");
1102 #endif
1103         printf("format options:\n");
1104         printf("      --endian={big|little}    Set byte order for samples\n");
1105         printf("      --channels=#             Number of channels\n");
1106         printf("      --bps=#                  Number of bits per sample\n");
1107         printf("      --sample-rate=#          Sample rate in Hz\n");
1108         printf("      --sign={signed|unsigned} Sign of samples\n");
1109         printf("      --force-raw-format       Treat input or output as raw samples\n");
1110         printf("negative options:\n");
1111         printf("      --no-adaptive-mid-side\n");
1112         printf("      --no-decode-through-errors\n");
1113         printf("      --no-delete-input-file\n");
1114 #if 0
1115 /* @@@ deprecated: */
1116         printf("      --no-escape-coding\n");
1117 #endif
1118         printf("      --no-exhaustive-model-search\n");
1119         printf("      --no-lax\n");
1120         printf("      --no-mid-side\n");
1121 #ifdef FLAC__HAS_OGG
1122         printf("      --no-ogg\n");
1123 #endif
1124         printf("      --no-padding\n");
1125         printf("      --no-qlp-coeff-prec-search\n");
1126         printf("      --no-replay-gain\n");
1127         printf("      --no-residual-gnuplot\n");
1128         printf("      --no-residual-text\n");
1129         printf("      --no-sector-align\n");
1130         printf("      --no-seektable\n");
1131         printf("      --no-silent\n");
1132         printf("      --no-verify\n");
1133 }
1134
1135 void show_explain()
1136 {
1137         usage_header();
1138         usage_summary();
1139         printf("For encoding:\n");
1140         printf("  The input file(s) may be a PCM RIFF WAVE file, AIFF file, or raw samples.\n");
1141         printf("  The output file(s) will be in native FLAC or Ogg FLAC format\n");
1142         printf("For decoding, the reverse is true.\n");
1143         printf("\n");
1144         printf("A single INPUTFILE may be - for stdin.  No INPUTFILE implies stdin.  Use of\n");
1145         printf("stdin implies -c (write to stdout).  Normally you should use:\n");
1146         printf("   flac [options] -o outfilename  or  flac -d [options] -o outfilename\n");
1147         printf("instead of:\n");
1148         printf("   flac [options] > outfilename   or  flac -d [options] > outfilename\n");
1149         printf("since the former allows flac to seek backwards to write the STREAMINFO or\n");
1150         printf("WAVE/AIFF header contents when necessary.\n");
1151         printf("\n");
1152         printf("flac checks for the presence of a AIFF/WAVE header to decide whether or not to\n");
1153         printf("treat an input file as AIFF/WAVE format or raw samples.  If any input file is\n");
1154         printf("raw you must specify the format options {-fb|fl} -fc -fp and -fs, which will\n");
1155         printf("apply to all raw files.  You can force AIFF/WAVE files to be treated as raw\n");
1156         printf("files using -fr.\n");
1157         printf("\n");
1158         printf("generic options:\n");
1159         printf("  -v, --version                Show the flac version number\n");
1160         printf("  -h, --help                   Show basic usage a list of all options\n");
1161         printf("  -H, --explain                Show this screen\n");
1162         printf("  -d, --decode                 Decode (the default behavior is to encode)\n");
1163         printf("  -t, --test                   Same as -d except no decoded file is written\n");
1164         printf("  -a, --analyze                Same as -d except an analysis file is written\n");
1165         printf("  -c, --stdout                 Write output to stdout\n");
1166         printf("  -s, --silent                 Do not write runtime encode/decode statistics\n");
1167         printf("  -o, --output-name=FILENAME   Force the output file name; usually flac just\n");
1168         printf("                               changes the extension.  May only be used when\n");
1169         printf("                               encoding a single file.  May not be used in\n");
1170         printf("                               conjunction with --output-prefix.\n");
1171         printf("      --output-prefix=STRING   Prefix each output file name with the given\n");
1172         printf("                               STRING.  This can be useful for encoding or\n");
1173         printf("                               decoding files to a different directory.  Make\n");
1174         printf("                               sure if your STRING is a path name that it ends\n");
1175         printf("                               with a '/' slash.\n");
1176         printf("      --delete-input-file      Automatically delete the input file after a\n");
1177         printf("                               successful encode or decode.  If there was an\n");
1178         printf("                               error (including a verify error) the input file\n");
1179         printf("                               is left intact.\n");
1180         printf("      --skip=#                 Skip the first # samples of each input file; can\n");
1181         printf("                               be used both for encoding and decoding\n");
1182         printf("analysis options:\n");
1183         printf("      --residual-text          Include residual signal in text output.  This\n");
1184         printf("                               will make the file very big, much larger than\n");
1185         printf("                               even the decoded file.\n");
1186         printf("      --residual-gnuplot       Generate gnuplot files of residual distribution\n");
1187         printf("                               of each subframe\n");
1188         printf("decoding options:\n");
1189         printf("  -F, --decode-through-errors  By default flac stops decoding with an error\n");
1190         printf("                               and removes the partially decoded file if it\n");
1191         printf("                               encounters a bitstream error.  With -F, errors\n");
1192         printf("                               are still printed but flac will continue\n");
1193         printf("                               decoding to completion.  Note that errors may\n");
1194         printf("                               cause the decoded audio to be missing some\n");
1195         printf("                               samples or have silent sections.\n");
1196         printf("encoding options:\n");
1197         printf("  -V, --verify                 Verify a correct encoding by decoding the\n");
1198         printf("                               output in parallel and comparing to the\n");
1199         printf("                               original\n");
1200 #ifdef FLAC__HAS_OGG
1201         printf("      --ogg                    When encoding, generate Ogg-FLAC output instead\n");
1202         printf("                               of native-FLAC.  Ogg-FLAC streams are FLAC\n");
1203         printf("                               streams wrapped in an Ogg transport layer.  The\n");
1204         printf("                               resulting file should have an '.ogg' extension\n");
1205         printf("                               and will still be decodable by flac.  When\n");
1206         printf("                               decoding, force the input to be treated as\n");
1207         printf("                               Ogg-FLAC.  This is useful when piping input\n");
1208         printf("                               from stdin or when the filename does not end in\n");
1209         printf("                               '.ogg'.\n");
1210         printf("      --serial-number          Serial number to use for the FLAC stream.  When\n");
1211         printf("                               encoding and no serial number is given, flac\n");
1212         printf("                               uses '0'.  When decoding and no number is\n");
1213         printf("                               given, flac uses the serial number of the first\n");
1214         printf("                               page.\n");
1215 #endif
1216         printf("      --lax                    Allow encoder to generate non-Subset files\n");
1217         printf("      --sector-align           Align encoding of multiple CD format WAVE files\n");
1218         printf("                               on sector boundaries.\n");
1219         printf("      --replay-gain            Calculate ReplayGain values and store in Vorbis\n");
1220         printf("                               comments.  Title gains/peaks will be computed\n");
1221         printf("                               for each file, and an album gain/peak will be\n");
1222         printf("                               computed for all files.  All input files must\n");
1223         printf("                               have the same resolution, sample rate, and\n");
1224         printf("                               number of channels.  The sample rate must be\n");
1225         printf("                               one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1,\n");
1226         printf("                               or 48 kHz.  NOTE: this option may also leave a\n");
1227         printf("                               few extra bytes in the PADDING block.\n");
1228         printf("  -S, --seekpoint={#|X|#x}     Include a point or points in a SEEKTABLE\n");
1229         printf("       #  : a specific sample number for a seek point\n");
1230         printf("       X  : a placeholder point (always goes at the end of the SEEKTABLE)\n");
1231         printf("       #x : # evenly spaced seekpoints, the first being at sample 0\n");
1232         printf("     You may use many -S options; the resulting SEEKTABLE will be the unique-\n");
1233         printf("           ified union of all such values.\n");
1234         printf("     With no -S options, flac defaults to '-S 100x'.  Use -S- for no SEEKTABLE.\n");
1235         printf("     Note: -S #x will not work if the encoder can't determine the input size\n");
1236         printf("           before starting.\n");
1237         printf("     Note: if you use -S # and # is >= samples in the input, there will be\n");
1238         printf("           either no seek point entered (if the input size is determinable\n");
1239         printf("           before encoding starts) or a placeholder point (if input size is not\n");
1240         printf("           determinable)\n");
1241         printf("  -P, --padding=#              Tell the encoder to write a PADDING metadata\n");
1242         printf("                               block of the given length (in bytes) after the\n");
1243         printf("                               STREAMINFO block.  This is useful if you plan\n");
1244         printf("                               to tag the file later with an APPLICATION\n");
1245         printf("                               block; instead of having to rewrite the entire\n");
1246         printf("                               file later just to insert your block, you can\n");
1247         printf("                               write directly over the PADDING block.  Note\n");
1248         printf("                               that the total length of the PADDING block will\n");
1249         printf("                               be 4 bytes longer than the length given because\n");
1250         printf("                               of the 4 metadata block header bytes.  You can\n");
1251         printf("                               force no PADDING block at all to be written with\n");
1252         printf("                               --no-padding, which is the default.\n");
1253         printf("  -b, --blocksize=#            Specify the blocksize in samples; the default is\n");
1254         printf("                               1152 for -l 0, else 4608; must be one of 192,\n");
1255         printf("                               576, 1152, 2304, 4608, 256, 512, 1024, 2048,\n");
1256         printf("                               4096, 8192, 16384, or 32768 (unless --lax is\n");
1257         printf("                               used)\n");
1258         printf("  -T, --tag=FIELD=VALUE        Add a Vorbis comment.  Make sure to quote the\n");
1259         printf("                               comment if necessary.  This option may appear\n");
1260         printf("                               more than once to add several comments.  NOTE:\n");
1261         printf("                               all tags will be added to all encoded files.\n");
1262         printf("  -0, --compression-level-0, --fast  Synonymous with -l 0 -b 1152 -r 2,2\n");
1263         printf("  -1, --compression-level-1          Synonymous with -l 0 -b 1152 -M -r 2,2\n");
1264         printf("  -2, --compression-level-2          Synonymous with -l 0 -b 1152 -m -r 3\n");
1265         printf("  -3, --compression-level-3          Synonymous with -l 6 -b 4608 -r 3,3\n");
1266         printf("  -4, --compression-level-4          Synonymous with -l 8 -b 4608 -M -r 3,3\n");
1267         printf("  -5, --compression-level-5          Synonymous with -l 8 -b 4608 -m -r 3,3\n");
1268         printf("                                     -5 is the default setting\n");
1269         printf("  -6, --compression-level-6          Synonymous with -l 8 -b 4608 -m -r 4\n");
1270         printf("  -7, --compression-level-7          Synonymous with -l 8 -b 4608 -m -e -r 6\n");
1271         printf("  -8, --compression-level-8, --best  Synonymous with -l 12 -b 4608 -m -e -r 6\n");
1272         printf("  -m, --mid-side                     Try mid-side coding for each frame\n");
1273         printf("                                     (stereo only)\n");
1274         printf("  -M, --adaptive-mid-side            Adaptive mid-side coding for all frames\n");
1275         printf("                                     (stereo only)\n");
1276         printf("  -e, --exhaustive-model-search      Do exhaustive model search (expensive!)\n");
1277 #if 0
1278         /*@@@ deprecated: */
1279         printf("  -E, --escape-coding                Do escape coding in the entropy coder.\n");
1280         printf("                                     This causes the encoder to use an\n");
1281         printf("                                     unencoded representation of the residual\n");
1282         printf("                                     in a partition if it is smaller.  It\n");
1283         printf("                                     increases the runtime and usually results\n");
1284         printf("                                     in an improvement of less than 1%.\n");
1285 #endif
1286         printf("  -l, --max-lpc-order=#              Max LPC order; 0 => only fixed predictors\n");
1287         printf("  -p, --qlp-coeff-precision-search   Do exhaustive search of LP coefficient\n");
1288         printf("                                     quantization (expensive!); overrides -q;\n");
1289         printf("                                     does nothing if using -l 0\n");
1290         printf("  -q, --qlp-coeff-precision=#        Specify precision in bits of quantized\n");
1291         printf("                                     linear-predictor coefficients; 0 => let\n");
1292         printf("                                     encoder decide (the minimun is %u, the\n", FLAC__MIN_QLP_COEFF_PRECISION);
1293         printf("                                     default is -q 0)\n");
1294         printf("  -r, --rice-partition-order=[#,]#   Set [min,]max residual partition order\n");
1295         printf("                                     (# is 0..16; min defaults to 0; the\n");
1296         printf("                                     default is -r 0; above 4 doesn't usually\n");
1297         printf("                                     help much)\n");
1298 #if 0
1299         /*@@@ deprecated: */
1300         printf("  -R, -rice-parameter-search-distance=#   Rice parameter search distance\n");
1301 #endif
1302         printf("format options:\n");
1303         printf("      --endian={big|little}    Set byte order for samples\n");
1304         printf("      --channels=#             Number of channels\n");
1305         printf("      --bps=#                  Number of bits per sample\n");
1306         printf("      --sample-rate=#          Sample rate in Hz\n");
1307         printf("      --sign={signed|unsigned} Sign of samples (the default is signed)\n");
1308         printf("      --force-raw-format       Force input (when encoding) or output (when\n");
1309         printf("                               decoding) to be treated as raw samples\n");
1310         printf("negative options:\n");
1311         printf("      --no-adaptive-mid-side\n");
1312         printf("      --no-decode-through-errors\n");
1313         printf("      --no-delete-input-file\n");
1314 #if 0
1315 /* @@@ deprecated: */
1316         printf("      --no-escape-coding\n");
1317 #endif
1318         printf("      --no-exhaustive-model-search\n");
1319         printf("      --no-lax\n");
1320         printf("      --no-mid-side\n");
1321 #ifdef FLAC__HAS_OGG
1322         printf("      --no-ogg\n");
1323 #endif
1324         printf("      --no-padding\n");
1325         printf("      --no-qlp-coeff-prec-search\n");
1326         printf("      --no-residual-gnuplot\n");
1327         printf("      --no-residual-text\n");
1328         printf("      --no-sector-align\n");
1329         printf("      --no-seektable\n");
1330         printf("      --no-silent\n");
1331         printf("      --no-verify\n");
1332 }
1333
1334 void
1335 format_mistake(const char *infilename, const char *wrong, const char *right)
1336 {
1337         fprintf(stderr, "WARNING: %s is not a %s file; treating as a %s file\n", infilename, wrong, right);
1338 }
1339
1340 int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file)
1341 {
1342         FILE *encode_infile;
1343         FLAC__byte lookahead[12];
1344         unsigned lookahead_length = 0;
1345         FileFormat fmt= RAW;
1346         int retval;
1347         long infilesize;
1348         encode_options_t common_options;
1349         const char *outfilename = get_encoded_outfilename(infilename);
1350
1351         if(0 == strcmp(infilename, "-")) {
1352                 infilesize = -1;
1353                 encode_infile = FLAC__file_utils_get_binary_stdin();
1354         }
1355         else {
1356                 infilesize = FLAC__file_utils_get_filesize(infilename);
1357                 if(0 == (encode_infile = fopen(infilename, "rb"))) {
1358                         fprintf(stderr, "ERROR: can't open input file %s\n", infilename);
1359                         return 1;
1360                 }
1361         }
1362
1363         if(!option_values.force_raw_format) {
1364                 /* first set format based on name */
1365                 if(strlen(infilename) > 3 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".wav"))
1366                         fmt= WAV;
1367                 else if(strlen(infilename) > 3 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".aif"))
1368                         fmt= AIF;
1369                 else if(strlen(infilename) > 4 && 0 == strcasecmp(infilename+(strlen(infilename)-5), ".aiff"))
1370                         fmt= AIF;
1371
1372                 /* attempt to guess the file type based on the first 12 bytes */
1373                 if((lookahead_length = fread(lookahead, 1, 12, encode_infile)) < 12) {
1374                         if(fmt != RAW)
1375                                 format_mistake(infilename, fmt == AIF ? "AIFF" : "WAVE", "raw");
1376                         fmt= RAW;
1377                 }
1378                 else {
1379                         if(!strncmp(lookahead, "RIFF", 4) && !strncmp(lookahead+8, "WAVE", 4))
1380                                 fmt= WAV;
1381                         else if(!strncmp(lookahead, "FORM", 4) && !strncmp(lookahead+8, "AIFF", 4))
1382                                 fmt= AIF;
1383                         else {
1384                                 if(fmt != RAW)
1385                                         format_mistake(infilename, fmt == AIF ? "AIFF" : "WAVE", "raw");
1386                                 fmt= RAW;
1387                         }
1388                 }
1389         }
1390
1391         if(option_values.sector_align && fmt == RAW && infilesize < 0) {
1392                 fprintf(stderr, "ERROR: can't --sector-align when the input size is unknown\n");
1393                 return 1;
1394         }
1395
1396         if(fmt == RAW) {
1397                 if(option_values.format_is_big_endian < 0 || option_values.format_is_unsigned_samples < 0 || option_values.format_channels < 0 || option_values.format_bps < 0 || option_values.format_sample_rate < 0)
1398                         return usage_error("ERROR: for encoding a raw file you must specify a value for --endian, --sign, --channels, --bps, and --sample-rate\n");
1399         }
1400
1401         if(encode_infile == stdin || option_values.force_to_stdout) {
1402                 if(option_values.replay_gain)
1403                         return usage_error("ERROR: --replay-gain cannot be used when encoding to stdout\n");
1404         }
1405
1406         common_options.verbose = option_values.verbose;
1407         common_options.skip = option_values.skip;
1408         common_options.verify = option_values.verify;
1409 #ifdef FLAC__HAS_OGG
1410         common_options.use_ogg = option_values.use_ogg;
1411         common_options.has_serial_number = option_values.has_serial_number;
1412         common_options.serial_number = option_values.serial_number;
1413 #endif
1414         common_options.lax = option_values.lax;
1415         common_options.do_mid_side = option_values.do_mid_side;
1416         common_options.loose_mid_side = option_values.loose_mid_side;
1417         common_options.do_exhaustive_model_search = option_values.do_exhaustive_model_search;
1418         common_options.do_escape_coding = option_values.do_escape_coding;
1419         common_options.do_qlp_coeff_prec_search = option_values.do_qlp_coeff_prec_search;
1420         common_options.min_residual_partition_order = option_values.min_residual_partition_order;
1421         common_options.max_residual_partition_order = option_values.max_residual_partition_order;
1422         common_options.rice_parameter_search_dist = option_values.rice_parameter_search_dist;
1423         common_options.max_lpc_order = option_values.max_lpc_order;
1424         common_options.blocksize = (unsigned)option_values.blocksize;
1425         common_options.qlp_coeff_precision = option_values.qlp_coeff_precision;
1426         common_options.padding = option_values.padding;
1427         common_options.requested_seek_points = option_values.requested_seek_points;
1428         common_options.num_requested_seek_points = option_values.num_requested_seek_points;
1429         common_options.is_first_file = is_first_file;
1430         common_options.is_last_file = is_last_file;
1431         common_options.align_reservoir = align_reservoir;
1432         common_options.align_reservoir_samples = &align_reservoir_samples;
1433         common_options.replay_gain = option_values.replay_gain;
1434         common_options.sector_align = option_values.sector_align;
1435         common_options.vorbis_comment = option_values.vorbis_comment;
1436         common_options.debug.disable_constant_subframes = option_values.debug.disable_constant_subframes;
1437         common_options.debug.disable_fixed_subframes = option_values.debug.disable_fixed_subframes;
1438         common_options.debug.disable_verbatim_subframes = option_values.debug.disable_verbatim_subframes;
1439
1440         if(fmt == RAW) {
1441                 raw_encode_options_t options;
1442
1443                 options.common = common_options;
1444                 options.is_big_endian = option_values.format_is_big_endian;
1445                 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1446                 options.channels = option_values.format_channels;
1447                 options.bps = option_values.format_bps;
1448                 options.sample_rate = option_values.format_sample_rate;
1449
1450                 retval = flac__encode_raw(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1451         }
1452         else {
1453                 wav_encode_options_t options;
1454
1455                 options.common = common_options;
1456
1457                 if(fmt == AIF)
1458                         retval = flac__encode_aif(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1459                 else
1460                         retval = flac__encode_wav(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1461         }
1462
1463         if(retval == 0 && strcmp(infilename, "-")) {
1464                 if(strcmp(outfilename, "-")) {
1465                         if(option_values.replay_gain) {
1466                                 float title_gain, title_peak;
1467                                 const char *error;
1468                                 FLAC__replaygain_get_title(&title_gain, &title_peak);
1469                                 if(0 != (error = FLAC__replaygain_store_to_file_title(outfilename, title_gain, title_peak, /*preserve_modtime=*/true))) {
1470                                         fprintf(stderr, "%s: ERROR writing ReplayGain title tags\n", outfilename);
1471                                 }
1472                         }
1473                         FLAC__file_utils_copy_metadata(infilename, outfilename);
1474                 }
1475                 if(option_values.delete_input)
1476                         unlink(infilename);
1477         }
1478
1479         return retval;
1480 }
1481
1482 int decode_file(const char *infilename)
1483 {
1484         int retval;
1485         FLAC__bool treat_as_ogg = false;
1486         decode_options_t common_options;
1487         const char *outfilename = get_decoded_outfilename(infilename);
1488
1489         if(!option_values.test_only && !option_values.analyze) {
1490                 if(option_values.force_raw_format && (option_values.format_is_big_endian < 0 || option_values.format_is_unsigned_samples < 0))
1491                         return usage_error("ERROR: for decoding to a raw file you must specify a value for --endian and --sign\n");
1492         }
1493
1494         if(option_values.use_ogg)
1495                 treat_as_ogg = true;
1496         else if(0 == strcasecmp(infilename+(strlen(infilename)-4), ".ogg"))
1497                 treat_as_ogg = true;
1498         else
1499                 treat_as_ogg = false;
1500
1501 #ifndef FLAC__HAS_OGG
1502         if(treat_as_ogg) {
1503                 fprintf(stderr, "%s: Ogg support has not been built into this copy of flac\n", infilename);
1504                 return 1;
1505         }
1506 #endif
1507
1508         common_options.verbose = option_values.verbose;
1509         common_options.continue_through_decode_errors = option_values.continue_through_decode_errors;
1510 #ifdef FLAC__HAS_OGG
1511         common_options.is_ogg = treat_as_ogg;
1512         common_options.use_first_serial_number = !option_values.has_serial_number;
1513         common_options.serial_number = option_values.serial_number;
1514 #endif
1515         common_options.skip = option_values.skip;
1516
1517         if(!option_values.force_raw_format) {
1518                 wav_decode_options_t options;
1519
1520                 options.common = common_options;
1521
1522                 retval = flac__decode_wav(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1523         }
1524         else {
1525                 raw_decode_options_t options;
1526
1527                 options.common = common_options;
1528                 options.is_big_endian = option_values.format_is_big_endian;
1529                 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1530
1531                 retval = flac__decode_raw(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1532         }
1533
1534         if(retval == 0 && strcmp(infilename, "-")) {
1535                 if(strcmp(outfilename, "-"))
1536                         FLAC__file_utils_copy_metadata(infilename, outfilename);
1537                 if(option_values.delete_input && !option_values.test_only && !option_values.analyze)
1538                         unlink(infilename);
1539         }
1540
1541         return retval;
1542 }
1543
1544 const char *get_encoded_outfilename(const char *infilename)
1545 {
1546         if(0 == option_values.cmdline_forced_outfilename) {
1547                 static char buffer[4096]; /* @@@ bad MAGIC NUMBER */
1548
1549                 if(0 == strcmp(infilename, "-") || option_values.force_to_stdout) {
1550                         strcpy(buffer, "-");
1551                 }
1552                 else {
1553                         const char *suffix = (option_values.use_ogg? ".ogg" : ".flac");
1554                         char *p;
1555                         strcpy(buffer, option_values.output_prefix? option_values.output_prefix : "");
1556                         strcat(buffer, infilename);
1557                         if(0 == (p = strrchr(buffer, '.')))
1558                                 strcat(buffer, suffix);
1559                         else {
1560                                 if(0 == strcmp(p, suffix)) {
1561                                         strcpy(p, "_new");
1562                                         strcat(p, suffix);
1563                                 }
1564                                 else
1565                                         strcpy(p, suffix);
1566                         }
1567                 }
1568                 return buffer;
1569         }
1570         else
1571                 return option_values.cmdline_forced_outfilename;
1572 }
1573
1574 const char *get_decoded_outfilename(const char *infilename)
1575 {
1576         if(0 == option_values.cmdline_forced_outfilename) {
1577                 static char buffer[4096]; /* @@@ bad MAGIC NUMBER */
1578
1579                 if(0 == strcmp(infilename, "-") || option_values.force_to_stdout) {
1580                         strcpy(buffer, "-");
1581                 }
1582                 else {
1583                         static const char *suffixes[] = { ".wav", ".raw", ".ana" };
1584                         const char *suffix = suffixes[option_values.analyze? 2 : option_values.force_raw_format? 1 : 0];
1585                         char *p;
1586                         strcpy(buffer, option_values.output_prefix? option_values.output_prefix : "");
1587                         strcat(buffer, infilename);
1588                         if(0 == (p = strrchr(buffer, '.')))
1589                                 strcat(buffer, suffix);
1590                         else {
1591                                 if(0 == strcmp(p, suffix)) {
1592                                         strcpy(p, "_new");
1593                                         strcat(p, suffix);
1594                                 }
1595                                 else
1596                                         strcpy(p, suffix);
1597                         }
1598                 }
1599                 return buffer;
1600         }
1601         else
1602                 return option_values.cmdline_forced_outfilename;
1603 }
1604
1605 void die(const char *message)
1606 {
1607         FLAC__ASSERT(0 != message);
1608         fprintf(stderr, "ERROR: %s\n", message);
1609         exit(1);
1610 }
1611
1612 char *local_strdup(const char *source)
1613 {
1614         char *ret;
1615         FLAC__ASSERT(0 != source);
1616         if(0 == (ret = strdup(source)))
1617                 die("out of memory during strdup()");
1618         return ret;
1619 }