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