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