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