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