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