add more informative error info for some common errors; also, no not exit with error...
[flac.git] / src / flac / main.c
index 81418ae..4380506 100644 (file)
@@ -22,6 +22,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <time.h>
 
 #ifdef HAVE_CONFIG_H
 #include <config.h>
@@ -93,6 +94,8 @@ static struct share__option long_options_[] = {
        { "test"             , share__no_argument, 0, 't' },
        { "stdout"           , share__no_argument, 0, 'c' },
        { "silent"           , share__no_argument, 0, 's' },
+       { "totally-silent"   , share__no_argument, 0, 0 },
+       { "force"            , share__no_argument, 0, 'f' },
        { "delete-input-file", share__no_argument, 0, 0 },
        { "output-prefix"    , share__required_argument, 0, 0 },
        { "output-name"      , share__required_argument, 0, 'o' },
@@ -103,6 +106,7 @@ static struct share__option long_options_[] = {
         * decoding options
         */
        { "decode-through-errors", share__no_argument, 0, 'F' },
+       { "cue"                  , share__required_argument, 0, 0 },
        { "apply-replaygain-which-is-not-lossless", share__optional_argument, 0, 0 }, /* undocumented */
 
        /*
@@ -153,7 +157,7 @@ static struct share__option long_options_[] = {
        /*
         * analysis options
         */
-       { "residual-gnu-plot", share__no_argument, 0, 0 },
+       { "residual-gnuplot", share__no_argument, 0, 0 },
        { "residual-text", share__no_argument, 0, 0 },
 
        /*
@@ -161,6 +165,7 @@ static struct share__option long_options_[] = {
         */
        { "no-decode-through-errors"  , share__no_argument, 0, 0 },
        { "no-silent"                 , share__no_argument, 0, 0 },
+       { "no-force"                  , share__no_argument, 0, 0 },
        { "no-seektable"              , share__no_argument, 0, 0 },
        { "no-delete-input-file"      , share__no_argument, 0, 0 },
        { "no-replay-gain"            , share__no_argument, 0, 0 },
@@ -198,7 +203,7 @@ static struct {
        FLAC__bool show_version;
        FLAC__bool mode_decode;
        FLAC__bool verify;
-       FLAC__bool verbose;
+       FLAC__bool force_file_overwrite;
        FLAC__bool continue_through_decode_errors;
        replaygain_synthesis_spec_t replaygain_synthesis_spec;
        FLAC__bool lax;
@@ -226,6 +231,7 @@ static struct {
        unsigned qlp_coeff_precision;
        const char *skip_specification;
        const char *until_specification;
+       const char *cue_specification;
        int format_is_big_endian;
        int format_is_unsigned_samples;
        int format_channels;
@@ -268,7 +274,7 @@ int main(int argc, char *argv[])
 
        setlocale(LC_ALL, "");
        if(!init_options()) {
-               fprintf(stderr, "ERROR: allocating memory\n");
+               flac__utils_printf(stderr, 1, "ERROR: allocating memory\n");
                retval = 1;
        }
        else {
@@ -299,7 +305,8 @@ int do_it()
        }
        else {
                if(option_values.num_files == 0) {
-                       short_usage();
+                       if(flac__utils_verbosity_ >= 1)
+                               short_usage();
                        return 0;
                }
 
@@ -327,6 +334,8 @@ int do_it()
                        if(option_values.rice_parameter_search_dist < 0) {
                                option_values.rice_parameter_search_dist = 0;
                        }
+                       if(0 != option_values.cue_specification)
+                               return usage_error("ERROR: --cue is not allowed in test mode\n");
                }
                else {
                        if(option_values.test_only) {
@@ -334,9 +343,14 @@ int do_it()
                                        return usage_error("ERROR: --skip is not allowed in test mode\n");
                                if(0 != option_values.until_specification)
                                        return usage_error("ERROR: --until is not allowed in test mode\n");
+                               if(0 != option_values.cue_specification)
+                                       return usage_error("ERROR: --cue is not allowed in test mode\n");
                        }
                }
 
+               if(0 != option_values.cue_specification && (0 != option_values.skip_specification || 0 != option_values.until_specification))
+                       return usage_error("ERROR: --cue may not be combined with --skip or --until\n");
+
                FLAC__ASSERT(option_values.blocksize >= 0 || option_values.mode_decode);
 
                if(option_values.format_channels >= 0) {
@@ -381,6 +395,8 @@ int do_it()
                                return usage_error("ERROR: --sector-align not allowed with --skip\n");
                        if(0 != option_values.until_specification)
                                return usage_error("ERROR: --sector-align not allowed with --until\n");
+                       if(0 != option_values.cue_specification)
+                               return usage_error("ERROR: --sector-align not allowed with --cue\n");
                        if(option_values.format_channels >= 0 && option_values.format_channels != 2)
                                return usage_error("ERROR: --sector-align can only be done with stereo input\n");
                        if(option_values.format_bps >= 0 && option_values.format_bps != 16)
@@ -403,7 +419,7 @@ int do_it()
                         * whole file.
                         */
                        if(option_values.padding < 0) {
-                               fprintf(stderr, "NOTE: --replay-gain may leave a small PADDING block even with --no-padding\n");
+                               flac__utils_printf(stderr, 1, "NOTE: --replay-gain may leave a small PADDING block even with --no-padding\n");
                                option_values.padding = GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
                        }
                        else {
@@ -420,37 +436,36 @@ int do_it()
                        return usage_error("ERROR: --cuesheet cannot be used when encoding multiple files\n");
                }
        }
-       if(option_values.verbose) {
-               fprintf(stderr, "\n");
-               fprintf(stderr, "flac %s, Copyright (C) 2000,2001,2002,2003,2004 Josh Coalson\n", FLAC__VERSION_STRING);
-               fprintf(stderr, "flac comes with ABSOLUTELY NO WARRANTY.  This is free software, and you are\n");
-               fprintf(stderr, "welcome to redistribute it under certain conditions.  Type `flac' for details.\n\n");
 
-               if(!option_values.mode_decode) {
-                       char padopt[16];
-                       if(option_values.padding < 0)
-                               strcpy(padopt, "-");
-                       else
-                               sprintf(padopt, " %d", option_values.padding);
-                       fprintf(stderr,
-                               "options:%s%s%s%s -P%s -b %u%s -l %u%s%s%s -q %u -r %u,%u%s\n",
-                               option_values.delete_input?" --delete-input-file":"",
-                               option_values.sector_align?" --sector-align":"",
-                               option_values.use_ogg?" --ogg":"",
-                               option_values.lax?" --lax":"",
-                               padopt,
-                               (unsigned)option_values.blocksize,
-                               option_values.loose_mid_side?" -M":option_values.do_mid_side?" -m":"",
-                               option_values.max_lpc_order,
-                               option_values.do_exhaustive_model_search?" -e":"",
-                               option_values.do_escape_coding?" -E":"",
-                               option_values.do_qlp_coeff_prec_search?" -p":"",
-                               option_values.qlp_coeff_precision,
-                               (unsigned)option_values.min_residual_partition_order,
-                               (unsigned)option_values.max_residual_partition_order,
-                               option_values.verify? " -V":""
-                       );
-               }
+       flac__utils_printf(stderr, 2, "\n");
+       flac__utils_printf(stderr, 2, "flac %s, Copyright (C) 2000,2001,2002,2003,2004 Josh Coalson\n", FLAC__VERSION_STRING);
+       flac__utils_printf(stderr, 2, "flac comes with ABSOLUTELY NO WARRANTY.  This is free software, and you are\n");
+       flac__utils_printf(stderr, 2, "welcome to redistribute it under certain conditions.  Type `flac' for details.\n\n");
+
+       if(!option_values.mode_decode) {
+               char padopt[16];
+               if(option_values.padding < 0)
+                       strcpy(padopt, "-");
+               else
+                       sprintf(padopt, " %d", option_values.padding);
+               flac__utils_printf(stderr, 2,
+                       "options:%s%s%s%s -P%s -b %u%s -l %u%s%s%s -q %u -r %u,%u%s\n",
+                       option_values.delete_input?" --delete-input-file":"",
+                       option_values.sector_align?" --sector-align":"",
+                       option_values.use_ogg?" --ogg":"",
+                       option_values.lax?" --lax":"",
+                       padopt,
+                       (unsigned)option_values.blocksize,
+                       option_values.loose_mid_side?" -M":option_values.do_mid_side?" -m":"",
+                       option_values.max_lpc_order,
+                       option_values.do_exhaustive_model_search?" -e":"",
+                       option_values.do_escape_coding?" -E":"",
+                       option_values.do_qlp_coeff_prec_search?" -p":"",
+                       option_values.qlp_coeff_precision,
+                       (unsigned)option_values.min_residual_partition_order,
+                       (unsigned)option_values.max_residual_partition_order,
+                       option_values.verify? " -V":""
+               );
        }
 
        if(option_values.mode_decode) {
@@ -493,17 +508,17 @@ int do_it()
                                for(i = 0; i < option_values.num_files; i++) {
                                        const char *error, *outfilename = get_encoded_outfilename(option_values.filenames[i]);
                                        if(0 == outfilename) {
-                                               fprintf(stderr, "ERROR: filename too long: %s", option_values.filenames[i]);
+                                               flac__utils_printf(stderr, 1, "ERROR: filename too long: %s", option_values.filenames[i]);
                                                return 1;
                                        }
                                        if(0 == strcmp(option_values.filenames[i], "-")) {
                                                FLAC__ASSERT(0);
                                                /* double protection */
-                                               fprintf(stderr, "internal error\n");
+                                               flac__utils_printf(stderr, 1, "internal error\n");
                                                return 2;
                                        }
                                        if(0 != (error = grabbag__replaygain_store_to_file_album(outfilename, album_gain, album_peak, /*preserve_modtime=*/true))) {
-                                               fprintf(stderr, "%s: ERROR writing ReplayGain album tags\n", outfilename);
+                                               flac__utils_printf(stderr, 1, "%s: ERROR writing ReplayGain album tags\n", outfilename);
                                                retval = 1;
                                        }
                                }
@@ -520,7 +535,7 @@ FLAC__bool init_options()
        option_values.show_explain = false;
        option_values.mode_decode = false;
        option_values.verify = false;
-       option_values.verbose = true;
+       option_values.force_file_overwrite = false;
        option_values.continue_through_decode_errors = false;
        option_values.replaygain_synthesis_spec.apply = false;
        option_values.replaygain_synthesis_spec.use_album_gain = true;
@@ -553,6 +568,7 @@ FLAC__bool init_options()
        option_values.qlp_coeff_precision = 0;
        option_values.skip_specification = 0;
        option_values.until_specification = 0;
+       option_values.cue_specification = 0;
        option_values.format_is_big_endian = -1;
        option_values.format_is_unsigned_samples = -1;
        option_values.format_channels = -1;
@@ -585,7 +601,7 @@ int parse_options(int argc, char *argv[])
        int short_option;
        int option_index = 1;
        FLAC__bool had_error = false;
-       const char *short_opts = "0123456789ab:cdeFhHl:mMo:pP:q:r:sS:tT:vV";
+       const char *short_opts = "0123456789ab:cdefFhHl:mMo:pP:q:r:sS:tT:vV";
 
        while ((short_option = share__getopt_long(argc, argv, short_opts, long_options_, &option_index)) != -1) {
                switch (short_option) {
@@ -627,7 +643,10 @@ int parse_option(int short_option, const char *long_option, const char *option_a
 
        if(short_option == 0) {
                FLAC__ASSERT(0 != long_option);
-               if(0 == strcmp(long_option, "delete-input-file")) {
+               if(0 == strcmp(long_option, "totally-silent")) {
+                       flac__utils_verbosity_ = 0;
+               }
+               else if(0 == strcmp(long_option, "delete-input-file")) {
                        option_values.delete_input = true;
                }
                else if(0 == strcmp(long_option, "output-prefix")) {
@@ -642,6 +661,10 @@ int parse_option(int short_option, const char *long_option, const char *option_a
                        FLAC__ASSERT(0 != option_argument);
                        option_values.until_specification = option_argument;
                }
+               else if(0 == strcmp(long_option, "cue")) {
+                       FLAC__ASSERT(0 != option_argument);
+                       option_values.cue_specification = option_argument;
+               }
                else if(0 == strcmp(long_option, "apply-replaygain-which-is-not-lossless")) {
                        option_values.replaygain_synthesis_spec.apply = true;
                        if (0 != option_argument) {
@@ -740,7 +763,7 @@ int parse_option(int short_option, const char *long_option, const char *option_a
                        else
                                return usage_error("ERROR: argument to --sign must be \"signed\" or \"unsigned\"\n");
                }
-               else if(0 == strcmp(long_option, "residual-gnu-plot")) {
+               else if(0 == strcmp(long_option, "residual-gnuplot")) {
                        option_values.aopts.do_residual_gnuplot = true;
                }
                else if(0 == strcmp(long_option, "residual-text")) {
@@ -753,7 +776,10 @@ int parse_option(int short_option, const char *long_option, const char *option_a
                        option_values.continue_through_decode_errors = false;
                }
                else if(0 == strcmp(long_option, "no-silent")) {
-                       option_values.verbose = true;
+                       flac__utils_verbosity_ = 2;
+               }
+               else if(0 == strcmp(long_option, "no-force")) {
+                       option_values.force_file_overwrite = false;
                }
                else if(0 == strcmp(long_option, "no-seektable")) {
                        option_values.num_requested_seek_points = 0;
@@ -837,7 +863,10 @@ int parse_option(int short_option, const char *long_option, const char *option_a
                                option_values.force_to_stdout = true;
                                break;
                        case 's':
-                               option_values.verbose = false;
+                               flac__utils_verbosity_ = 1;
+                               break;
+                       case 'f':
+                               option_values.force_file_overwrite = true;
                                break;
                        case 'o':
                                FLAC__ASSERT(0 != option_argument);
@@ -1037,17 +1066,19 @@ void free_options()
 
 int usage_error(const char *message, ...)
 {
-       va_list args;
+       if(flac__utils_verbosity_ >= 1) {
+               va_list args;
 
-       FLAC__ASSERT(0 != message);
+               FLAC__ASSERT(0 != message);
 
-       va_start(args, message);
+               va_start(args, message);
 
-       (void) vfprintf(stderr, message, args);
+               (void) vfprintf(stderr, message, args);
 
-       va_end(args);
+               va_end(args);
 
-       printf("Type \"flac\" for a usage summary or \"flac --help\" for all options\n");
+               printf("Type \"flac\" for a usage summary or \"flac --help\" for all options\n");
+       }
 
        return 1;
 }
@@ -1122,6 +1153,8 @@ void show_help()
        printf("  -a, --analyze                Same as -d except an analysis file is written\n");
        printf("  -c, --stdout                 Write output to stdout\n");
        printf("  -s, --silent                 Do not write runtime encode/decode statistics\n");
+       printf("      --totally-silent         Do not print anything, including errors\n");
+       printf("  -f, --force                  Force overwriting of output files\n");
        printf("  -o, --output-name=FILENAME   Force the output file name\n");
        printf("      --output-prefix=STRING   Prepend STRING to output names\n");
        printf("      --delete-input-file      Deletes after a successful encode/decode\n");
@@ -1136,6 +1169,7 @@ void show_help()
        printf("      --residual-gnuplot       Generate gnuplot files of residual distribution\n");
        printf("decoding options:\n");
        printf("  -F, --decode-through-errors  Continue decoding through stream errors\n");
+       printf("      --cue=[#.#][-[#.#]]      Set the beginning and ending cuepoints to decode\n");
        printf("encoding options:\n");
        printf("  -V, --verify                 Verify a correct encoding\n");
        printf("      --lax                    Allow encoder to generate non-Subset files\n");
@@ -1188,6 +1222,7 @@ void show_help()
        printf("      --no-sector-align\n");
        printf("      --no-seektable\n");
        printf("      --no-silent\n");
+       printf("      --no-force\n");
        printf("      --no-verify\n");
 }
 
@@ -1223,6 +1258,10 @@ void show_explain()
        printf("  -a, --analyze                Same as -d except an analysis file is written\n");
        printf("  -c, --stdout                 Write output to stdout\n");
        printf("  -s, --silent                 Do not write runtime encode/decode statistics\n");
+       printf("      --totally-silent         Do not print anything of any kind, including\n");
+       printf("                               warnings or errors.  The exit code will be the\n");
+       printf("                               only way to determine successful completion.\n");
+       printf("  -f, --force                  Force overwriting of output files\n");
        printf("  -o, --output-name=FILENAME   Force the output file name; usually flac just\n");
        printf("                               changes the extension.  May only be used when\n");
        printf("                               encoding a single file.  May not be used in\n");
@@ -1279,6 +1318,17 @@ void show_explain()
        printf("                               decoding to completion.  Note that errors may\n");
        printf("                               cause the decoded audio to be missing some\n");
        printf("                               samples or have silent sections.\n");
+       printf("      --cue=[#.#][-[#.#]]      Set the beginning and ending cuepoints to\n");
+       printf("                               decode.  The optional first #.# is the track and\n");
+       printf("                               index point at which decoding will start; the\n");
+       printf("                               default is the beginning of the stream.  The\n");
+       printf("                               optional second #.# is the track and index point\n");
+       printf("                               at which decoding will end; the default is the\n");
+       printf("                               end of the stream.  If the seekpoint does not\n");
+       printf("                               exist, the closest one before it (for the start\n");
+       printf("                               point) or after it (for the end point) will be\n");
+       printf("                               used.  The cuepoints are merely translated into\n");
+       printf("                               sample numbers then used as --skip and --until.\n");
        printf("encoding options:\n");
        printf("  -V, --verify                 Verify a correct encoding by decoding the\n");
        printf("                               output in parallel and comparing to the\n");
@@ -1394,13 +1444,13 @@ void show_explain()
        printf("      --no-sector-align\n");
        printf("      --no-seektable\n");
        printf("      --no-silent\n");
+       printf("      --no-force\n");
        printf("      --no-verify\n");
 }
 
-void
-format_mistake(const char *infilename, const char *wrong, const char *right)
+void format_mistake(const char *infilename, const char *wrong, const char *right)
 {
-       fprintf(stderr, "WARNING: %s is not a %s file; treating as a %s file\n", infilename, wrong, right);
+       flac__utils_printf(stderr, 1, "WARNING: %s is not a %s file; treating as a %s file\n", infilename, wrong, right);
 }
 
 int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file)
@@ -1415,7 +1465,16 @@ int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_
        const char *outfilename = get_encoded_outfilename(infilename);
 
        if(0 == outfilename) {
-               fprintf(stderr, "ERROR: filename too long: %s", infilename);
+               flac__utils_printf(stderr, 1, "ERROR: filename too long: %s", infilename);
+               return 1;
+       }
+
+       /*
+        * Error if output file already exists (and -f not used).
+        * Use grabbag__file_get_filesize() as a cheap way to check.
+        */
+       if(!option_values.test_only && !option_values.force_file_overwrite && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
+               flac__utils_printf(stderr, 1, "ERROR: output file %s already exists, use -f to override\n", outfilename);
                return 1;
        }
 
@@ -1426,7 +1485,7 @@ int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_
        else {
                infilesize = grabbag__file_get_filesize(infilename);
                if(0 == (encode_infile = fopen(infilename, "rb"))) {
-                       fprintf(stderr, "ERROR: can't open input file %s\n", infilename);
+                       flac__utils_printf(stderr, 1, "ERROR: can't open input file %s\n", infilename);
                        return 1;
                }
        }
@@ -1460,7 +1519,7 @@ int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_
        }
 
        if(option_values.sector_align && fmt == RAW && infilesize < 0) {
-               fprintf(stderr, "ERROR: can't --sector-align when the input size is unknown\n");
+               flac__utils_printf(stderr, 1, "ERROR: can't --sector-align when the input size is unknown\n");
                return 1;
        }
 
@@ -1483,12 +1542,16 @@ int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_
        if(0 == option_values.until_specification)
                common_options.until_specification.is_relative = true;
 
-       common_options.verbose = option_values.verbose;
        common_options.verify = option_values.verify;
 #ifdef FLAC__HAS_OGG
        common_options.use_ogg = option_values.use_ogg;
-       common_options.has_serial_number = option_values.has_serial_number;
-       common_options.serial_number = option_values.serial_number;
+       /* set a random serial number if one has not yet been specified */
+       if(!option_values.has_serial_number) {
+               srand(time(0));
+               option_values.serial_number = rand();
+               option_values.has_serial_number = true;
+       }
+       common_options.serial_number = option_values.serial_number++;
 #endif
        common_options.lax = option_values.lax;
        common_options.do_mid_side = option_values.do_mid_side;
@@ -1548,7 +1611,7 @@ int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_
                                const char *error;
                                grabbag__replaygain_get_title(&title_gain, &title_peak);
                                if(0 != (error = grabbag__replaygain_store_to_file_title(outfilename, title_gain, title_peak, /*preserve_modtime=*/true))) {
-                                       fprintf(stderr, "%s: ERROR writing ReplayGain title tags\n", outfilename);
+                                       flac__utils_printf(stderr, 1, "%s: ERROR writing ReplayGain title tags\n", outfilename);
                                }
                        }
                        grabbag__file_copy_metadata(infilename, outfilename);
@@ -1568,7 +1631,16 @@ int decode_file(const char *infilename)
        const char *outfilename = get_decoded_outfilename(infilename);
 
        if(0 == outfilename) {
-               fprintf(stderr, "ERROR: filename too long: %s", infilename);
+               flac__utils_printf(stderr, 1, "ERROR: filename too long: %s", infilename);
+               return 1;
+       }
+
+       /*
+        * Error if output file already exists (and -f not used).
+        * Use grabbag__file_get_filesize() as a cheap way to check.
+        */
+       if(!option_values.test_only && !option_values.force_file_overwrite && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
+               flac__utils_printf(stderr, 1, "ERROR: output file %s already exists, use -f to override\n", outfilename);
                return 1;
        }
 
@@ -1586,7 +1658,7 @@ int decode_file(const char *infilename)
 
 #ifndef FLAC__HAS_OGG
        if(treat_as_ogg) {
-               fprintf(stderr, "%s: Ogg support has not been built into this copy of flac\n", infilename);
+               flac__utils_printf(stderr, 1, "%s: Ogg support has not been built into this copy of flac\n", infilename);
                return 1;
        }
 #endif
@@ -1600,7 +1672,14 @@ int decode_file(const char *infilename)
        if(0 == option_values.until_specification)
                common_options.until_specification.is_relative = true;
 
-       common_options.verbose = option_values.verbose;
+       if(option_values.cue_specification) {
+               if(!flac__utils_parse_cue_specification(option_values.cue_specification, &common_options.cue_specification))
+                       return usage_error("ERROR: invalid value for --cue\n");
+               common_options.has_cue_specification = true;
+       }
+       else
+               common_options.has_cue_specification = false;
+
        common_options.continue_through_decode_errors = option_values.continue_through_decode_errors;
        common_options.replaygain_synthesis_spec = option_values.replaygain_synthesis_spec;
 #ifdef FLAC__HAS_OGG
@@ -1707,7 +1786,7 @@ const char *get_outfilename(const char *infilename, const char *suffix)
 void die(const char *message)
 {
        FLAC__ASSERT(0 != message);
-       fprintf(stderr, "ERROR: %s\n", message);
+       flac__utils_printf(stderr, 1, "ERROR: %s\n", message);
        exit(1);
 }