src/flac/main.c

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