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