src/flac/main.c

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