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