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