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