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