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