1 /* flac - Command-line FLAC encoder/decoder
2 * Copyright (C) 2000,2001,2002,2003,2004 Josh Coalson
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
31 #if !defined _MSC_VER && !defined __MINGW32__
32 /* unlink is in stdio.h in VC++ */
33 #include <unistd.h> /* for unlink() */
35 #define strcasecmp stricmp
38 #include "share/grabbag.h"
42 #include "local_string_utils.h" /* for flac__strlcat() and flac__strlcpy() */
44 #include "vorbiscomment.h"
47 /*[JEC] was:#if HAVE_GETOPT_LONG*/
48 /*[JEC] see flac/include/share/getopt.h as to why the change */
51 # include "share/getopt.h"
54 typedef enum { RAW, WAV, AIF } FileFormat;
58 static FLAC__bool init_options();
59 static int parse_options(int argc, char *argv[]);
60 static int parse_option(int short_option, const char *long_option, const char *option_argument);
61 static void free_options();
63 static int usage_error(const char *message, ...);
64 static void short_usage();
65 static void show_version();
66 static void show_help();
67 static void show_explain();
68 static void format_mistake(const char *infilename, const char *wrong, const char *right);
70 static int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file);
71 static int decode_file(const char *infilename);
73 static const char *get_encoded_outfilename(const char *infilename);
74 static const char *get_decoded_outfilename(const char *infilename);
75 static const char *get_outfilename(const char *infilename, const char *suffix);
77 static void die(const char *message);
78 static char *local_strdup(const char *source);
82 * share__getopt format struct; note that for long options with no
83 * short option equivalent we just set the 'val' field to 0.
85 static struct share__option long_options_[] = {
89 { "help" , share__no_argument, 0, 'h' },
90 { "explain" , share__no_argument, 0, 'H' },
91 { "version" , share__no_argument, 0, 'v' },
92 { "decode" , share__no_argument, 0, 'd' },
93 { "analyze" , share__no_argument, 0, 'a' },
94 { "test" , share__no_argument, 0, 't' },
95 { "stdout" , share__no_argument, 0, 'c' },
96 { "silent" , share__no_argument, 0, 's' },
97 { "force" , share__no_argument, 0, 'f' },
98 { "delete-input-file", share__no_argument, 0, 0 },
99 { "output-prefix" , share__required_argument, 0, 0 },
100 { "output-name" , share__required_argument, 0, 'o' },
101 { "skip" , share__required_argument, 0, 0 },
102 { "until" , share__required_argument, 0, 0 },
107 { "decode-through-errors", share__no_argument, 0, 'F' },
108 { "apply-replaygain-which-is-not-lossless", share__optional_argument, 0, 0 }, /* undocumented */
113 { "cuesheet" , share__required_argument, 0, 0 },
114 { "no-cued-seekpoints" , share__no_argument, 0, 0 },
115 { "tag" , share__required_argument, 0, 'T' },
116 { "compression-level-0" , share__no_argument, 0, '0' },
117 { "compression-level-1" , share__no_argument, 0, '1' },
118 { "compression-level-2" , share__no_argument, 0, '2' },
119 { "compression-level-3" , share__no_argument, 0, '3' },
120 { "compression-level-4" , share__no_argument, 0, '4' },
121 { "compression-level-5" , share__no_argument, 0, '5' },
122 { "compression-level-6" , share__no_argument, 0, '6' },
123 { "compression-level-7" , share__no_argument, 0, '7' },
124 { "compression-level-8" , share__no_argument, 0, '8' },
125 { "compression-level-9" , share__no_argument, 0, '9' },
126 { "best" , share__no_argument, 0, '8' },
127 { "fast" , share__no_argument, 0, '0' },
128 { "super-secret-totally-impractical-compression-level", share__no_argument, 0, 0 },
129 { "verify" , share__no_argument, 0, 'V' },
130 { "force-aiff-format" , share__no_argument, 0, 0 },
131 { "force-raw-format" , share__no_argument, 0, 0 },
132 { "lax" , share__no_argument, 0, 0 },
133 { "replay-gain" , share__no_argument, 0, 0 },
134 { "sector-align" , share__no_argument, 0, 0 },
135 { "seekpoint" , share__required_argument, 0, 'S' },
136 { "padding" , share__required_argument, 0, 'P' },
138 { "ogg" , share__no_argument, 0, 0 },
139 { "serial-number" , share__required_argument, 0, 0 },
141 { "blocksize" , share__required_argument, 0, 'b' },
142 { "exhaustive-model-search" , share__no_argument, 0, 'e' },
143 { "max-lpc-order" , share__required_argument, 0, 'l' },
144 { "mid-side" , share__no_argument, 0, 'm' },
145 { "adaptive-mid-side" , share__no_argument, 0, 'M' },
146 { "qlp-coeff-precision-search", share__no_argument, 0, 'p' },
147 { "qlp-coeff-precision" , share__required_argument, 0, 'q' },
148 { "rice-partition-order" , share__required_argument, 0, 'r' },
149 { "endian" , share__required_argument, 0, 0 },
150 { "channels" , share__required_argument, 0, 0 },
151 { "bps" , share__required_argument, 0, 0 },
152 { "sample-rate" , share__required_argument, 0, 0 },
153 { "sign" , share__required_argument, 0, 0 },
158 { "residual-gnu-plot", share__no_argument, 0, 0 },
159 { "residual-text", share__no_argument, 0, 0 },
164 { "no-decode-through-errors" , share__no_argument, 0, 0 },
165 { "no-silent" , share__no_argument, 0, 0 },
166 { "no-force" , share__no_argument, 0, 0 },
167 { "no-seektable" , share__no_argument, 0, 0 },
168 { "no-delete-input-file" , share__no_argument, 0, 0 },
169 { "no-replay-gain" , share__no_argument, 0, 0 },
170 { "no-sector-align" , share__no_argument, 0, 0 },
171 { "no-lax" , share__no_argument, 0, 0 },
173 { "no-ogg" , share__no_argument, 0, 0 },
175 { "no-exhaustive-model-search", share__no_argument, 0, 0 },
176 { "no-mid-side" , share__no_argument, 0, 0 },
177 { "no-adaptive-mid-side" , share__no_argument, 0, 0 },
178 { "no-qlp-coeff-prec-search" , share__no_argument, 0, 0 },
179 { "no-padding" , share__no_argument, 0, 0 },
180 { "no-verify" , share__no_argument, 0, 0 },
181 { "no-residual-gnuplot" , share__no_argument, 0, 0 },
182 { "no-residual-text" , share__no_argument, 0, 0 },
184 * undocumented debugging options for the test suite
186 { "disable-constant-subframes", share__no_argument, 0, 0 },
187 { "disable-fixed-subframes" , share__no_argument, 0, 0 },
188 { "disable-verbatim-subframes", share__no_argument, 0, 0 },
195 * global to hold command-line option values
199 FLAC__bool show_help;
200 FLAC__bool show_explain;
201 FLAC__bool show_version;
202 FLAC__bool mode_decode;
205 FLAC__bool force_file_overwrite;
206 FLAC__bool continue_through_decode_errors;
207 replaygain_synthesis_spec_t replaygain_synthesis_spec;
209 FLAC__bool test_only;
212 FLAC__bool has_serial_number; /* true iff --serial-number was used */
213 long serial_number; /* this is the Ogg serial number and is unused for native FLAC */
214 FLAC__bool do_mid_side;
215 FLAC__bool loose_mid_side;
216 FLAC__bool do_exhaustive_model_search;
217 FLAC__bool do_escape_coding;
218 FLAC__bool do_qlp_coeff_prec_search;
219 FLAC__bool force_to_stdout;
220 FLAC__bool force_aiff_format;
221 FLAC__bool force_raw_format;
222 FLAC__bool delete_input;
223 FLAC__bool replay_gain;
224 FLAC__bool sector_align;
225 const char *cmdline_forced_outfilename;
226 const char *output_prefix;
227 analysis_options aopts;
229 unsigned max_lpc_order;
230 unsigned qlp_coeff_precision;
231 const char *skip_specification;
232 const char *until_specification;
233 int format_is_big_endian;
234 int format_is_unsigned_samples;
237 int format_sample_rate;
239 int min_residual_partition_order;
240 int max_residual_partition_order;
241 int rice_parameter_search_dist;
242 char requested_seek_points[50000]; /* bad MAGIC NUMBER but buffer overflow is checked */
243 int num_requested_seek_points; /* -1 => no -S options were given, 0 => -S- was given */
244 const char *cuesheet_filename;
245 FLAC__bool cued_seekpoints;
250 FLAC__StreamMetadata *vorbis_comment;
253 FLAC__bool disable_constant_subframes;
254 FLAC__bool disable_fixed_subframes;
255 FLAC__bool disable_verbatim_subframes;
261 * miscellaneous globals
264 static FLAC__int32 align_reservoir_0[588], align_reservoir_1[588]; /* for carrying over samples from --sector-align */
265 static FLAC__int32 *align_reservoir[2] = { align_reservoir_0, align_reservoir_1 };
266 static unsigned align_reservoir_samples = 0; /* 0 .. 587 */
269 int main(int argc, char *argv[])
273 setlocale(LC_ALL, "");
274 if(!init_options()) {
275 fprintf(stderr, "ERROR: allocating memory\n");
279 if((retval = parse_options(argc, argv)) == 0)
292 if(option_values.show_version) {
296 else if(option_values.show_explain) {
300 else if(option_values.show_help) {
305 if(option_values.num_files == 0) {
311 * tweak options; validate the values
313 if(!option_values.mode_decode) {
314 if(option_values.blocksize < 0) {
315 if(option_values.max_lpc_order == 0)
316 option_values.blocksize = 1152;
318 option_values.blocksize = 4608;
320 if(option_values.max_residual_partition_order < 0) {
321 if(option_values.blocksize <= 1152)
322 option_values.max_residual_partition_order = 2;
323 else if(option_values.blocksize <= 2304)
324 option_values.max_residual_partition_order = 3;
325 else if(option_values.blocksize <= 4608)
326 option_values.max_residual_partition_order = 3;
328 option_values.max_residual_partition_order = 4;
329 option_values.min_residual_partition_order = option_values.max_residual_partition_order;
331 if(option_values.rice_parameter_search_dist < 0) {
332 option_values.rice_parameter_search_dist = 0;
336 if(option_values.test_only) {
337 if(0 != option_values.skip_specification)
338 return usage_error("ERROR: --skip is not allowed in test mode\n");
339 if(0 != option_values.until_specification)
340 return usage_error("ERROR: --until is not allowed in test mode\n");
344 FLAC__ASSERT(option_values.blocksize >= 0 || option_values.mode_decode);
346 if(option_values.format_channels >= 0) {
347 if(option_values.format_channels == 0 || (unsigned)option_values.format_channels > FLAC__MAX_CHANNELS)
348 return usage_error("ERROR: invalid number of channels '%u', must be > 0 and <= %u\n", option_values.format_channels, FLAC__MAX_CHANNELS);
350 if(option_values.format_bps >= 0) {
351 if(option_values.format_bps != 8 && option_values.format_bps != 16 && option_values.format_bps != 24)
352 return usage_error("ERROR: invalid bits per sample '%u' (must be 8/16/24)\n", option_values.format_bps);
354 if(option_values.format_sample_rate >= 0) {
355 if(!FLAC__format_sample_rate_is_valid(option_values.format_sample_rate))
356 return usage_error("ERROR: invalid sample rate '%u', must be > 0 and <= %u\n", option_values.format_sample_rate, FLAC__MAX_SAMPLE_RATE);
358 if(option_values.force_raw_format && option_values.force_aiff_format)
359 return usage_error("ERROR: only one of --force-raw-format and --force-aiff-format allowed\n");
360 if(option_values.mode_decode) {
361 if(!option_values.force_raw_format) {
362 if(option_values.format_is_big_endian >= 0)
363 return usage_error("ERROR: --endian only allowed with --force-raw-format\n");
364 if(option_values.format_is_unsigned_samples >= 0)
365 return usage_error("ERROR: --sign only allowed with --force-raw-format\n");
367 if(option_values.format_channels >= 0)
368 return usage_error("ERROR: --channels not allowed with --decode\n");
369 if(option_values.format_bps >= 0)
370 return usage_error("ERROR: --bps not allowed with --decode\n");
371 if(option_values.format_sample_rate >= 0)
372 return usage_error("ERROR: --sample-rate not allowed with --decode\n");
374 if(!option_values.mode_decode && ((unsigned)option_values.blocksize < FLAC__MIN_BLOCK_SIZE || (unsigned)option_values.blocksize > FLAC__MAX_BLOCK_SIZE)) {
375 return usage_error("ERROR: invalid blocksize '%u', must be >= %u and <= %u\n", (unsigned)option_values.blocksize, FLAC__MIN_BLOCK_SIZE, FLAC__MAX_BLOCK_SIZE);
377 if(option_values.qlp_coeff_precision > 0 && option_values.qlp_coeff_precision < FLAC__MIN_QLP_COEFF_PRECISION) {
378 return usage_error("ERROR: invalid value '%u' for qlp coeff precision, must be 0 or >= %u\n", option_values.qlp_coeff_precision, FLAC__MIN_QLP_COEFF_PRECISION);
381 if(option_values.sector_align) {
382 if(option_values.mode_decode)
383 return usage_error("ERROR: --sector-align only allowed for encoding\n");
384 if(0 != option_values.skip_specification)
385 return usage_error("ERROR: --sector-align not allowed with --skip\n");
386 if(0 != option_values.until_specification)
387 return usage_error("ERROR: --sector-align not allowed with --until\n");
388 if(option_values.format_channels >= 0 && option_values.format_channels != 2)
389 return usage_error("ERROR: --sector-align can only be done with stereo input\n");
390 if(option_values.format_bps >= 0 && option_values.format_bps != 16)
391 return usage_error("ERROR: --sector-align can only be done with 16-bit samples\n");
392 if(option_values.format_sample_rate >= 0 && option_values.format_sample_rate != 44100)
393 return usage_error("ERROR: --sector-align can only be done with a sample rate of 44100\n");
395 if(option_values.replay_gain) {
396 if(option_values.force_to_stdout)
397 return usage_error("ERROR: --replay-gain not allowed with -c/--stdout\n");
398 if(option_values.mode_decode)
399 return usage_error("ERROR: --replay-gain only allowed for encoding\n");
400 if(option_values.format_channels > 2)
401 return usage_error("ERROR: --replay-gain can only be done with mono/stereo input\n");
402 if(option_values.format_sample_rate >= 0 && !grabbag__replaygain_is_valid_sample_frequency(option_values.format_sample_rate))
403 return usage_error("ERROR: invalid sample rate used with --replay-gain\n");
405 * We want to reserve padding space for the ReplayGain
406 * tags that we will set later, to avoid rewriting the
409 if(option_values.padding < 0) {
410 fprintf(stderr, "NOTE: --replay-gain may leave a small PADDING block even with --no-padding\n");
411 option_values.padding = GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
414 option_values.padding += GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
417 if(option_values.num_files > 1 && option_values.cmdline_forced_outfilename) {
418 return usage_error("ERROR: -o/--output-name cannot be used with multiple files\n");
420 if(option_values.cmdline_forced_outfilename && option_values.output_prefix) {
421 return usage_error("ERROR: --output-prefix conflicts with -o/--output-name\n");
423 if(!option_values.mode_decode && 0 != option_values.cuesheet_filename && option_values.num_files > 1) {
424 return usage_error("ERROR: --cuesheet cannot be used when encoding multiple files\n");
427 if(option_values.verbose) {
428 fprintf(stderr, "\n");
429 fprintf(stderr, "flac %s, Copyright (C) 2000,2001,2002,2003,2004 Josh Coalson\n", FLAC__VERSION_STRING);
430 fprintf(stderr, "flac comes with ABSOLUTELY NO WARRANTY. This is free software, and you are\n");
431 fprintf(stderr, "welcome to redistribute it under certain conditions. Type `flac' for details.\n\n");
433 if(!option_values.mode_decode) {
435 if(option_values.padding < 0)
438 sprintf(padopt, " %d", option_values.padding);
440 "options:%s%s%s%s -P%s -b %u%s -l %u%s%s%s -q %u -r %u,%u%s\n",
441 option_values.delete_input?" --delete-input-file":"",
442 option_values.sector_align?" --sector-align":"",
443 option_values.use_ogg?" --ogg":"",
444 option_values.lax?" --lax":"",
446 (unsigned)option_values.blocksize,
447 option_values.loose_mid_side?" -M":option_values.do_mid_side?" -m":"",
448 option_values.max_lpc_order,
449 option_values.do_exhaustive_model_search?" -e":"",
450 option_values.do_escape_coding?" -E":"",
451 option_values.do_qlp_coeff_prec_search?" -p":"",
452 option_values.qlp_coeff_precision,
453 (unsigned)option_values.min_residual_partition_order,
454 (unsigned)option_values.max_residual_partition_order,
455 option_values.verify? " -V":""
460 if(option_values.mode_decode) {
461 FLAC__bool first = true;
463 if(option_values.num_files == 0) {
464 retval = decode_file("-");
468 if(option_values.num_files > 1)
469 option_values.cmdline_forced_outfilename = 0;
470 for(i = 0, retval = 0; i < option_values.num_files; i++) {
471 if(0 == strcmp(option_values.filenames[i], "-") && !first)
473 retval |= decode_file(option_values.filenames[i]);
479 FLAC__bool first = true;
481 if(option_values.num_files == 0) {
482 retval = encode_file("-", first, true);
486 if(option_values.num_files > 1)
487 option_values.cmdline_forced_outfilename = 0;
488 for(i = 0, retval = 0; i < option_values.num_files; i++) {
489 if(0 == strcmp(option_values.filenames[i], "-") && !first)
491 retval |= encode_file(option_values.filenames[i], first, i == (option_values.num_files-1));
494 if(option_values.replay_gain && retval == 0) {
495 float album_gain, album_peak;
496 grabbag__replaygain_get_album(&album_gain, &album_peak);
497 for(i = 0; i < option_values.num_files; i++) {
498 const char *error, *outfilename = get_encoded_outfilename(option_values.filenames[i]);
499 if(0 == outfilename) {
500 fprintf(stderr, "ERROR: filename too long: %s", option_values.filenames[i]);
503 if(0 == strcmp(option_values.filenames[i], "-")) {
505 /* double protection */
506 fprintf(stderr, "internal error\n");
509 if(0 != (error = grabbag__replaygain_store_to_file_album(outfilename, album_gain, album_peak, /*preserve_modtime=*/true))) {
510 fprintf(stderr, "%s: ERROR writing ReplayGain album tags\n", outfilename);
521 FLAC__bool init_options()
523 option_values.show_help = false;
524 option_values.show_explain = false;
525 option_values.mode_decode = false;
526 option_values.verify = false;
527 option_values.verbose = true;
528 option_values.force_file_overwrite = false;
529 option_values.continue_through_decode_errors = false;
530 option_values.replaygain_synthesis_spec.apply = false;
531 option_values.replaygain_synthesis_spec.use_album_gain = true;
532 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__HARD;
533 option_values.replaygain_synthesis_spec.noise_shaping = NOISE_SHAPING_LOW;
534 option_values.replaygain_synthesis_spec.preamp = 0.0;
535 option_values.lax = false;
536 option_values.test_only = false;
537 option_values.analyze = false;
538 option_values.use_ogg = false;
539 option_values.has_serial_number = false;
540 option_values.serial_number = 0;
541 option_values.do_mid_side = true;
542 option_values.loose_mid_side = false;
543 option_values.do_exhaustive_model_search = false;
544 option_values.do_escape_coding = false;
545 option_values.do_qlp_coeff_prec_search = false;
546 option_values.force_to_stdout = false;
547 option_values.force_aiff_format = false;
548 option_values.force_raw_format = false;
549 option_values.delete_input = false;
550 option_values.replay_gain = false;
551 option_values.sector_align = false;
552 option_values.cmdline_forced_outfilename = 0;
553 option_values.output_prefix = 0;
554 option_values.aopts.do_residual_text = false;
555 option_values.aopts.do_residual_gnuplot = false;
556 option_values.padding = 4096;
557 option_values.max_lpc_order = 8;
558 option_values.qlp_coeff_precision = 0;
559 option_values.skip_specification = 0;
560 option_values.until_specification = 0;
561 option_values.format_is_big_endian = -1;
562 option_values.format_is_unsigned_samples = -1;
563 option_values.format_channels = -1;
564 option_values.format_bps = -1;
565 option_values.format_sample_rate = -1;
566 option_values.blocksize = -1;
567 option_values.min_residual_partition_order = -1;
568 option_values.max_residual_partition_order = -1;
569 option_values.rice_parameter_search_dist = -1;
570 option_values.requested_seek_points[0] = '\0';
571 option_values.num_requested_seek_points = -1;
572 option_values.cuesheet_filename = 0;
573 option_values.cued_seekpoints = true;
575 option_values.num_files = 0;
576 option_values.filenames = 0;
578 if(0 == (option_values.vorbis_comment = FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT)))
581 option_values.debug.disable_constant_subframes = false;
582 option_values.debug.disable_fixed_subframes = false;
583 option_values.debug.disable_verbatim_subframes = false;
588 int parse_options(int argc, char *argv[])
591 int option_index = 1;
592 FLAC__bool had_error = false;
593 const char *short_opts = "0123456789ab:cdefFhHl:mMo:pP:q:r:sS:tT:vV";
595 while ((short_option = share__getopt_long(argc, argv, short_opts, long_options_, &option_index)) != -1) {
596 switch (short_option) {
597 case 0: /* long option with no equivalent short option */
598 had_error |= (parse_option(short_option, long_options_[option_index].name, share__optarg) != 0);
604 default: /* short option */
605 had_error |= (parse_option(short_option, 0, share__optarg) != 0);
614 FLAC__ASSERT(share__optind <= argc);
616 option_values.num_files = argc - share__optind;
618 if(option_values.num_files > 0) {
620 if(0 == (option_values.filenames = malloc(sizeof(char *) * option_values.num_files)))
621 die("out of memory allocating space for file names list");
622 while(share__optind < argc)
623 option_values.filenames[i++] = local_strdup(argv[share__optind++]);
629 int parse_option(int short_option, const char *long_option, const char *option_argument)
633 if(short_option == 0) {
634 FLAC__ASSERT(0 != long_option);
635 if(0 == strcmp(long_option, "delete-input-file")) {
636 option_values.delete_input = true;
638 else if(0 == strcmp(long_option, "output-prefix")) {
639 FLAC__ASSERT(0 != option_argument);
640 option_values.output_prefix = option_argument;
642 else if(0 == strcmp(long_option, "skip")) {
643 FLAC__ASSERT(0 != option_argument);
644 option_values.skip_specification = option_argument;
646 else if(0 == strcmp(long_option, "until")) {
647 FLAC__ASSERT(0 != option_argument);
648 option_values.until_specification = option_argument;
650 else if(0 == strcmp(long_option, "apply-replaygain-which-is-not-lossless")) {
651 option_values.replaygain_synthesis_spec.apply = true;
652 if (0 != option_argument) {
654 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__NONE;
655 option_values.replaygain_synthesis_spec.noise_shaping = NOISE_SHAPING_NONE;
656 option_values.replaygain_synthesis_spec.preamp = strtod(option_argument, &p);
659 option_values.replaygain_synthesis_spec.use_album_gain = true;
661 option_values.replaygain_synthesis_spec.use_album_gain = false;
663 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__PEAK;
665 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__HARD;
666 else if (*p == 'n' && p[1] >= '0' && p[1] <= '3') {
667 option_values.replaygain_synthesis_spec.noise_shaping = p[1] - '0';
671 return usage_error("ERROR: bad specification string \"%s\" for --%s\n", option_argument, long_option);
675 else if(0 == strcmp(long_option, "cuesheet")) {
676 FLAC__ASSERT(0 != option_argument);
677 option_values.cuesheet_filename = option_argument;
679 else if(0 == strcmp(long_option, "no-cued-seekpoints")) {
680 option_values.cued_seekpoints = false;
682 else if(0 == strcmp(long_option, "super-secret-totally-impractical-compression-level")) {
683 option_values.lax = true;
684 option_values.do_exhaustive_model_search = true;
685 option_values.do_escape_coding = true;
686 option_values.do_mid_side = true;
687 option_values.loose_mid_side = false;
688 option_values.do_qlp_coeff_prec_search = true;
689 option_values.min_residual_partition_order = 0;
690 option_values.max_residual_partition_order = 16;
691 option_values.rice_parameter_search_dist = 0;
692 option_values.max_lpc_order = 32;
694 else if(0 == strcmp(long_option, "force-aiff-format")) {
695 option_values.force_aiff_format = true;
697 else if(0 == strcmp(long_option, "force-raw-format")) {
698 option_values.force_raw_format = true;
700 else if(0 == strcmp(long_option, "lax")) {
701 option_values.lax = true;
703 else if(0 == strcmp(long_option, "replay-gain")) {
704 option_values.replay_gain = true;
706 else if(0 == strcmp(long_option, "sector-align")) {
707 option_values.sector_align = true;
710 else if(0 == strcmp(long_option, "ogg")) {
711 option_values.use_ogg = true;
713 else if(0 == strcmp(long_option, "serial-number")) {
714 option_values.has_serial_number = true;
715 option_values.serial_number = atol(option_argument);
718 else if(0 == strcmp(long_option, "endian")) {
719 FLAC__ASSERT(0 != option_argument);
720 if(0 == strncmp(option_argument, "big", strlen(option_argument)))
721 option_values.format_is_big_endian = true;
722 else if(0 == strncmp(option_argument, "little", strlen(option_argument)))
723 option_values.format_is_big_endian = false;
725 return usage_error("ERROR: argument to --endian must be \"big\" or \"little\"\n");
727 else if(0 == strcmp(long_option, "channels")) {
728 FLAC__ASSERT(0 != option_argument);
729 option_values.format_channels = atoi(option_argument);
731 else if(0 == strcmp(long_option, "bps")) {
732 FLAC__ASSERT(0 != option_argument);
733 option_values.format_bps = atoi(option_argument);
735 else if(0 == strcmp(long_option, "sample-rate")) {
736 FLAC__ASSERT(0 != option_argument);
737 option_values.format_sample_rate = atoi(option_argument);
739 else if(0 == strcmp(long_option, "sign")) {
740 FLAC__ASSERT(0 != option_argument);
741 if(0 == strncmp(option_argument, "signed", strlen(option_argument)))
742 option_values.format_is_unsigned_samples = false;
743 else if(0 == strncmp(option_argument, "unsigned", strlen(option_argument)))
744 option_values.format_is_unsigned_samples = true;
746 return usage_error("ERROR: argument to --sign must be \"signed\" or \"unsigned\"\n");
748 else if(0 == strcmp(long_option, "residual-gnu-plot")) {
749 option_values.aopts.do_residual_gnuplot = true;
751 else if(0 == strcmp(long_option, "residual-text")) {
752 option_values.aopts.do_residual_text = true;
757 else if(0 == strcmp(long_option, "no-decode-through-errors")) {
758 option_values.continue_through_decode_errors = false;
760 else if(0 == strcmp(long_option, "no-silent")) {
761 option_values.verbose = true;
763 else if(0 == strcmp(long_option, "no-force")) {
764 option_values.force_file_overwrite = false;
766 else if(0 == strcmp(long_option, "no-seektable")) {
767 option_values.num_requested_seek_points = 0;
768 option_values.requested_seek_points[0] = '\0';
770 else if(0 == strcmp(long_option, "no-delete-input-file")) {
771 option_values.delete_input = false;
773 else if(0 == strcmp(long_option, "no-replay-gain")) {
774 option_values.replay_gain = false;
776 else if(0 == strcmp(long_option, "no-sector-align")) {
777 option_values.sector_align = false;
779 else if(0 == strcmp(long_option, "no-lax")) {
780 option_values.lax = false;
783 else if(0 == strcmp(long_option, "no-ogg")) {
784 option_values.use_ogg = false;
787 else if(0 == strcmp(long_option, "no-exhaustive-model-search")) {
788 option_values.do_exhaustive_model_search = false;
790 else if(0 == strcmp(long_option, "no-mid-side")) {
791 option_values.do_mid_side = option_values.loose_mid_side = false;
793 else if(0 == strcmp(long_option, "no-adaptive-mid-side")) {
794 option_values.loose_mid_side = option_values.do_mid_side = false;
796 else if(0 == strcmp(long_option, "no-qlp-coeff-prec-search")) {
797 option_values.do_qlp_coeff_prec_search = false;
799 else if(0 == strcmp(long_option, "no-padding")) {
800 option_values.padding = -1;
802 else if(0 == strcmp(long_option, "no-verify")) {
803 option_values.verify = false;
805 else if(0 == strcmp(long_option, "no-residual-gnuplot")) {
806 option_values.aopts.do_residual_gnuplot = false;
808 else if(0 == strcmp(long_option, "no-residual-text")) {
809 option_values.aopts.do_residual_text = false;
811 else if(0 == strcmp(long_option, "disable-constant-subframes")) {
812 option_values.debug.disable_constant_subframes = true;
814 else if(0 == strcmp(long_option, "disable-fixed-subframes")) {
815 option_values.debug.disable_fixed_subframes = true;
817 else if(0 == strcmp(long_option, "disable-verbatim-subframes")) {
818 option_values.debug.disable_verbatim_subframes = true;
822 const char *violation;
823 switch(short_option) {
825 option_values.show_help = true;
828 option_values.show_explain = true;
831 option_values.show_version = true;
834 option_values.mode_decode = true;
837 option_values.mode_decode = true;
838 option_values.analyze = true;
841 option_values.mode_decode = true;
842 option_values.test_only = true;
845 option_values.force_to_stdout = true;
848 option_values.verbose = false;
851 option_values.force_file_overwrite = true;
854 FLAC__ASSERT(0 != option_argument);
855 option_values.cmdline_forced_outfilename = option_argument;
858 option_values.continue_through_decode_errors = true;
861 FLAC__ASSERT(0 != option_argument);
862 if(!flac__vorbiscomment_add(option_values.vorbis_comment, option_argument, &violation))
863 return usage_error("ERROR: (-T/--tag) %s\n", violation);
866 option_values.do_exhaustive_model_search = false;
867 option_values.do_escape_coding = false;
868 option_values.do_mid_side = false;
869 option_values.loose_mid_side = false;
870 option_values.qlp_coeff_precision = 0;
871 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 2;
872 option_values.rice_parameter_search_dist = 0;
873 option_values.max_lpc_order = 0;
876 option_values.do_exhaustive_model_search = false;
877 option_values.do_escape_coding = false;
878 option_values.do_mid_side = true;
879 option_values.loose_mid_side = true;
880 option_values.qlp_coeff_precision = 0;
881 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 2;
882 option_values.rice_parameter_search_dist = 0;
883 option_values.max_lpc_order = 0;
886 option_values.do_exhaustive_model_search = false;
887 option_values.do_escape_coding = false;
888 option_values.do_mid_side = true;
889 option_values.loose_mid_side = false;
890 option_values.qlp_coeff_precision = 0;
891 option_values.min_residual_partition_order = 0;
892 option_values.max_residual_partition_order = 3;
893 option_values.rice_parameter_search_dist = 0;
894 option_values.max_lpc_order = 0;
897 option_values.do_exhaustive_model_search = false;
898 option_values.do_escape_coding = false;
899 option_values.do_mid_side = false;
900 option_values.loose_mid_side = false;
901 option_values.qlp_coeff_precision = 0;
902 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
903 option_values.rice_parameter_search_dist = 0;
904 option_values.max_lpc_order = 6;
907 option_values.do_exhaustive_model_search = false;
908 option_values.do_escape_coding = false;
909 option_values.do_mid_side = true;
910 option_values.loose_mid_side = true;
911 option_values.qlp_coeff_precision = 0;
912 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
913 option_values.rice_parameter_search_dist = 0;
914 option_values.max_lpc_order = 8;
917 option_values.do_exhaustive_model_search = false;
918 option_values.do_escape_coding = false;
919 option_values.do_mid_side = true;
920 option_values.loose_mid_side = false;
921 option_values.qlp_coeff_precision = 0;
922 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
923 option_values.rice_parameter_search_dist = 0;
924 option_values.max_lpc_order = 8;
927 option_values.do_exhaustive_model_search = false;
928 option_values.do_escape_coding = false;
929 option_values.do_mid_side = true;
930 option_values.loose_mid_side = false;
931 option_values.qlp_coeff_precision = 0;
932 option_values.min_residual_partition_order = 0;
933 option_values.max_residual_partition_order = 4;
934 option_values.rice_parameter_search_dist = 0;
935 option_values.max_lpc_order = 8;
938 option_values.do_exhaustive_model_search = true;
939 option_values.do_escape_coding = false;
940 option_values.do_mid_side = true;
941 option_values.loose_mid_side = false;
942 option_values.qlp_coeff_precision = 0;
943 option_values.min_residual_partition_order = 0;
944 option_values.max_residual_partition_order = 6;
945 option_values.rice_parameter_search_dist = 0;
946 option_values.max_lpc_order = 8;
949 option_values.do_exhaustive_model_search = true;
950 option_values.do_escape_coding = false;
951 option_values.do_mid_side = true;
952 option_values.loose_mid_side = false;
953 option_values.qlp_coeff_precision = 0;
954 option_values.min_residual_partition_order = 0;
955 option_values.max_residual_partition_order = 6;
956 option_values.rice_parameter_search_dist = 0;
957 option_values.max_lpc_order = 12;
960 return usage_error("ERROR: compression level '9' is reserved\n");
962 option_values.verify = true;
965 FLAC__ASSERT(0 != option_argument);
966 if(option_values.num_requested_seek_points < 0)
967 option_values.num_requested_seek_points = 0;
968 option_values.num_requested_seek_points++;
969 if(strlen(option_values.requested_seek_points)+strlen(option_argument)+2 >= sizeof(option_values.requested_seek_points)) {
970 return usage_error("ERROR: too many seekpoints requested\n");
973 strcat(option_values.requested_seek_points, option_argument);
974 strcat(option_values.requested_seek_points, ";");
978 FLAC__ASSERT(0 != option_argument);
979 option_values.padding = atoi(option_argument);
980 if(option_values.padding < 0)
981 return usage_error("ERROR: argument to -P must be >= 0\n");
984 FLAC__ASSERT(0 != option_argument);
985 option_values.blocksize = atoi(option_argument);
988 option_values.do_exhaustive_model_search = true;
991 option_values.do_escape_coding = true;
994 FLAC__ASSERT(0 != option_argument);
995 option_values.max_lpc_order = atoi(option_argument);
998 option_values.do_mid_side = true;
999 option_values.loose_mid_side = false;
1002 option_values.loose_mid_side = option_values.do_mid_side = true;
1005 option_values.do_qlp_coeff_prec_search = true;
1008 FLAC__ASSERT(0 != option_argument);
1009 option_values.qlp_coeff_precision = atoi(option_argument);
1012 FLAC__ASSERT(0 != option_argument);
1013 p = strchr(option_argument, ',');
1015 option_values.min_residual_partition_order = 0;
1016 option_values.max_residual_partition_order = atoi(option_argument);
1019 option_values.min_residual_partition_order = atoi(option_argument);
1020 option_values.max_residual_partition_order = atoi(++p);
1024 FLAC__ASSERT(0 != option_argument);
1025 option_values.rice_parameter_search_dist = atoi(option_argument);
1038 if(0 != option_values.filenames) {
1039 for(i = 0; i < option_values.num_files; i++) {
1040 if(0 != option_values.filenames[i])
1041 free(option_values.filenames[i]);
1043 free(option_values.filenames);
1045 if(0 != option_values.vorbis_comment)
1046 FLAC__metadata_object_delete(option_values.vorbis_comment);
1049 int usage_error(const char *message, ...)
1053 FLAC__ASSERT(0 != message);
1055 va_start(args, message);
1057 (void) vfprintf(stderr, message, args);
1061 printf("Type \"flac\" for a usage summary or \"flac --help\" for all options\n");
1068 printf("flac %s\n", FLAC__VERSION_STRING);
1071 static void usage_header()
1073 printf("===============================================================================\n");
1074 printf("flac - Command-line FLAC encoder/decoder version %s\n", FLAC__VERSION_STRING);
1075 printf("Copyright (C) 2000,2001,2002,2003,2004 Josh Coalson\n");
1077 printf("This program is free software; you can redistribute it and/or\n");
1078 printf("modify it under the terms of the GNU General Public License\n");
1079 printf("as published by the Free Software Foundation; either version 2\n");
1080 printf("of the License, or (at your option) any later version.\n");
1082 printf("This program is distributed in the hope that it will be useful,\n");
1083 printf("but WITHOUT ANY WARRANTY; without even the implied warranty of\n");
1084 printf("MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n");
1085 printf("GNU General Public License for more details.\n");
1087 printf("You should have received a copy of the GNU General Public License\n");
1088 printf("along with this program; if not, write to the Free Software\n");
1089 printf("Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\n");
1090 printf("===============================================================================\n");
1093 static void usage_summary()
1097 printf(" Encoding: flac [<general-options>] [<encoding/format-options>] [INPUTFILE [...]]\n");
1098 printf(" Decoding: flac -d [<general-options>] [<format-options>] [FLACFILE [...]]\n");
1099 printf(" Testing: flac -t [<general-options>] [FLACFILE [...]]\n");
1100 printf("Analyzing: flac -a [<general-options>] [<analysis-options>] [FLACFILE [...]]\n");
1108 printf("This is the short help; for all options use 'flac --help'; for even more\n");
1109 printf("instructions use 'flac --explain'\n");
1111 printf("To encode:\n");
1112 printf(" flac [-#] [INPUTFILE [...]]\n");
1114 printf(" -# is -0 (fastest compression) to -8 (highest compression); -5 is the default\n");
1116 printf("To decode:\n");
1117 printf(" flac -d [INPUTFILE [...]]\n");
1119 printf("To test:\n");
1120 printf(" flac -t [INPUTFILE [...]]\n");
1127 printf("general options:\n");
1128 printf(" -v, --version Show the flac version number\n");
1129 printf(" -h, --help Show this screen\n");
1130 printf(" -H, --explain Show detailed explanation of usage and options\n");
1131 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1132 printf(" -t, --test Same as -d except no decoded file is written\n");
1133 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1134 printf(" -c, --stdout Write output to stdout\n");
1135 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1136 printf(" -f, --force Force overwriting of output files\n");
1137 printf(" -o, --output-name=FILENAME Force the output file name\n");
1138 printf(" --output-prefix=STRING Prepend STRING to output names\n");
1139 printf(" --delete-input-file Deletes after a successful encode/decode\n");
1140 printf(" --skip={#|mm:ss.ss} Skip the given initial samples for each input\n");
1141 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample for each input file\n");
1142 #ifdef FLAC__HAS_OGG
1143 printf(" --ogg Use Ogg as transport layer\n");
1144 printf(" --serial-number Serial number to use for the FLAC stream\n");
1146 printf("analysis options:\n");
1147 printf(" --residual-text Include residual signal in text output\n");
1148 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1149 printf("decoding options:\n");
1150 printf(" -F, --decode-through-errors Continue decoding through stream errors\n");
1151 printf("encoding options:\n");
1152 printf(" -V, --verify Verify a correct encoding\n");
1153 printf(" --lax Allow encoder to generate non-Subset files\n");
1154 printf(" --sector-align Align multiple files on sector boundaries\n");
1155 printf(" --replay-gain Calculate ReplayGain & store in Vorbis comments\n");
1156 printf(" --cuesheet=FILENAME Import cuesheet and store in CUESHEET block\n");
1157 printf(" -T, --tag=FIELD=VALUE Add a Vorbis comment; may appear multiple times\n");
1158 printf(" -S, --seekpoint={#|X|#x|#s} Add seek point(s)\n");
1159 printf(" -P, --padding=# Write a PADDING block of length #\n");
1160 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 2,2\n");
1161 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 2,2\n");
1162 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1163 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4608 -r 3,3\n");
1164 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4608 -M -r 3,3\n");
1165 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4608 -m -r 3,3\n");
1166 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4608 -m -r 4\n");
1167 printf(" -7, --compression-level-7 Synonymous with -l 8 -b 4608 -m -e -r 6\n");
1168 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4608 -m -e -r 6\n");
1169 printf(" -b, --blocksize=# Specify blocksize in samples\n");
1170 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1171 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1172 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1173 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n");
1174 printf(" -p, --qlp-coeff-precision-search Exhaustively search LP coeff quantization\n");
1175 printf(" -q, --qlp-coeff-precision=# Specify precision in bits\n");
1176 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1177 printf("format options:\n");
1178 printf(" --endian={big|little} Set byte order for samples\n");
1179 printf(" --channels=# Number of channels\n");
1180 printf(" --bps=# Number of bits per sample\n");
1181 printf(" --sample-rate=# Sample rate in Hz\n");
1182 printf(" --sign={signed|unsigned} Sign of samples\n");
1183 printf(" --force-aiff-format Force decoding to AIFF format\n");
1184 printf(" --force-raw-format Treat input or output as raw samples\n");
1185 printf("negative options:\n");
1186 printf(" --no-adaptive-mid-side\n");
1187 printf(" --no-decode-through-errors\n");
1188 printf(" --no-delete-input-file\n");
1189 printf(" --no-exhaustive-model-search\n");
1190 printf(" --no-lax\n");
1191 printf(" --no-mid-side\n");
1192 #ifdef FLAC__HAS_OGG
1193 printf(" --no-ogg\n");
1195 printf(" --no-padding\n");
1196 printf(" --no-qlp-coeff-prec-search\n");
1197 printf(" --no-replay-gain\n");
1198 printf(" --no-residual-gnuplot\n");
1199 printf(" --no-residual-text\n");
1200 printf(" --no-sector-align\n");
1201 printf(" --no-seektable\n");
1202 printf(" --no-silent\n");
1203 printf(" --no-force\n");
1204 printf(" --no-verify\n");
1211 printf("For encoding:\n");
1212 printf(" The input file(s) may be a PCM RIFF WAVE file, AIFF file, or raw samples.\n");
1213 printf(" The output file(s) will be in native FLAC or Ogg FLAC format\n");
1214 printf("For decoding, the reverse is true.\n");
1216 printf("A single INPUTFILE may be - for stdin. No INPUTFILE implies stdin. Use of\n");
1217 printf("stdin implies -c (write to stdout). Normally you should use:\n");
1218 printf(" flac [options] -o outfilename or flac -d [options] -o outfilename\n");
1219 printf("instead of:\n");
1220 printf(" flac [options] > outfilename or flac -d [options] > outfilename\n");
1221 printf("since the former allows flac to seek backwards to write the STREAMINFO or\n");
1222 printf("WAVE/AIFF header contents when necessary.\n");
1224 printf("flac checks for the presence of a AIFF/WAVE header to decide whether or not to\n");
1225 printf("treat an input file as AIFF/WAVE format or raw samples. If any input file is\n");
1226 printf("raw you must specify the format options {-fb|fl} -fc -fp and -fs, which will\n");
1227 printf("apply to all raw files. You can force AIFF/WAVE files to be treated as raw\n");
1228 printf("files using -fr.\n");
1230 printf("general options:\n");
1231 printf(" -v, --version Show the flac version number\n");
1232 printf(" -h, --help Show basic usage a list of all options\n");
1233 printf(" -H, --explain Show this screen\n");
1234 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1235 printf(" -t, --test Same as -d except no decoded file is written\n");
1236 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1237 printf(" -c, --stdout Write output to stdout\n");
1238 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1239 printf(" -f, --force Force overwriting of output files\n");
1240 printf(" -o, --output-name=FILENAME Force the output file name; usually flac just\n");
1241 printf(" changes the extension. May only be used when\n");
1242 printf(" encoding a single file. May not be used in\n");
1243 printf(" conjunction with --output-prefix.\n");
1244 printf(" --output-prefix=STRING Prefix each output file name with the given\n");
1245 printf(" STRING. This can be useful for encoding or\n");
1246 printf(" decoding files to a different directory. Make\n");
1247 printf(" sure if your STRING is a path name that it ends\n");
1248 printf(" with a '/' slash.\n");
1249 printf(" --delete-input-file Automatically delete the input file after a\n");
1250 printf(" successful encode or decode. If there was an\n");
1251 printf(" error (including a verify error) the input file\n");
1252 printf(" is left intact.\n");
1253 printf(" --skip={#|mm:ss.ss} Skip the first # samples of each input file; can\n");
1254 printf(" be used both for encoding and decoding. The\n");
1255 printf(" alternative form mm:ss.ss can be used to specify\n");
1256 printf(" minutes, seconds, and fractions of a second.\n");
1257 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample number for each input\n");
1258 printf(" file. The given sample number is not included\n");
1259 printf(" in the decoded output. The alternative form\n");
1260 printf(" mm:ss.ss can be used to specify minutes,\n");
1261 printf(" seconds, and fractions of a second. If a `+'\n");
1262 printf(" sign is at the beginning, the --until point is\n");
1263 printf(" relative to the --skip point. If a `-' sign is\n");
1264 printf(" at the beginning, the --until point is relative\n");
1265 printf(" to end of the audio.\n");
1266 #ifdef FLAC__HAS_OGG
1267 printf(" --ogg When encoding, generate Ogg-FLAC output instead\n");
1268 printf(" of native-FLAC. Ogg-FLAC streams are FLAC\n");
1269 printf(" streams wrapped in an Ogg transport layer. The\n");
1270 printf(" resulting file should have an '.ogg' extension\n");
1271 printf(" and will still be decodable by flac. When\n");
1272 printf(" decoding, force the input to be treated as\n");
1273 printf(" Ogg-FLAC. This is useful when piping input\n");
1274 printf(" from stdin or when the filename does not end in\n");
1275 printf(" '.ogg'.\n");
1276 printf(" --serial-number Serial number to use for the FLAC stream. When\n");
1277 printf(" encoding and no serial number is given, flac\n");
1278 printf(" uses '0'. When decoding and no number is\n");
1279 printf(" given, flac uses the serial number of the first\n");
1282 printf("analysis options:\n");
1283 printf(" --residual-text Include residual signal in text output. This\n");
1284 printf(" will make the file very big, much larger than\n");
1285 printf(" even the decoded file.\n");
1286 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1287 printf(" of each subframe\n");
1288 printf("decoding options:\n");
1289 printf(" -F, --decode-through-errors By default flac stops decoding with an error\n");
1290 printf(" and removes the partially decoded file if it\n");
1291 printf(" encounters a bitstream error. With -F, errors\n");
1292 printf(" are still printed but flac will continue\n");
1293 printf(" decoding to completion. Note that errors may\n");
1294 printf(" cause the decoded audio to be missing some\n");
1295 printf(" samples or have silent sections.\n");
1296 printf("encoding options:\n");
1297 printf(" -V, --verify Verify a correct encoding by decoding the\n");
1298 printf(" output in parallel and comparing to the\n");
1299 printf(" original\n");
1300 printf(" --lax Allow encoder to generate non-Subset files\n");
1301 printf(" --sector-align Align encoding of multiple CD format WAVE files\n");
1302 printf(" on sector boundaries.\n");
1303 printf(" --replay-gain Calculate ReplayGain values and store in Vorbis\n");
1304 printf(" comments. Title gains/peaks will be computed\n");
1305 printf(" for each file, and an album gain/peak will be\n");
1306 printf(" computed for all files. All input files must\n");
1307 printf(" have the same resolution, sample rate, and\n");
1308 printf(" number of channels. The sample rate must be\n");
1309 printf(" one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1,\n");
1310 printf(" or 48 kHz. NOTE: this option may also leave a\n");
1311 printf(" few extra bytes in the PADDING block.\n");
1312 printf(" --cuesheet=FILENAME Import the given cuesheet file and store it in\n");
1313 printf(" a CUESHEET metadata block. This option may only\n");
1314 printf(" be used when encoding a single file. A\n");
1315 printf(" seekpoint will be added for each index point in\n");
1316 printf(" the cuesheet to the SEEKTABLE unless\n");
1317 printf(" --no-cued-seekpoints is specified.\n");
1318 printf(" -T, --tag=FIELD=VALUE Add a Vorbis comment. Make sure to quote the\n");
1319 printf(" comment if necessary. This option may appear\n");
1320 printf(" more than once to add several comments. NOTE:\n");
1321 printf(" all tags will be added to all encoded files.\n");
1322 printf(" -S, --seekpoint={#|X|#x|#s} Include a point or points in a SEEKTABLE\n");
1323 printf(" # : a specific sample number for a seek point\n");
1324 printf(" X : a placeholder point (always goes at the end of the SEEKTABLE)\n");
1325 printf(" #x : # evenly spaced seekpoints, the first being at sample 0\n");
1326 printf(" #s : a seekpoint every # seconds; # does not have to be a whole number\n");
1327 printf(" You may use many -S options; the resulting SEEKTABLE will be the unique-\n");
1328 printf(" ified union of all such values.\n");
1329 printf(" With no -S options, flac defaults to '-S 10s'. Use -S- for no SEEKTABLE.\n");
1330 printf(" Note: -S #x and -S #s will not work if the encoder can't determine the\n");
1331 printf(" input size before starting.\n");
1332 printf(" Note: if you use -S # and # is >= samples in the input, there will be\n");
1333 printf(" either no seek point entered (if the input size is determinable\n");
1334 printf(" before encoding starts) or a placeholder point (if input size is not\n");
1335 printf(" determinable)\n");
1336 printf(" -P, --padding=# Tell the encoder to write a PADDING metadata\n");
1337 printf(" block of the given length (in bytes) after the\n");
1338 printf(" STREAMINFO block. This is useful if you plan\n");
1339 printf(" to tag the file later with an APPLICATION\n");
1340 printf(" block; instead of having to rewrite the entire\n");
1341 printf(" file later just to insert your block, you can\n");
1342 printf(" write directly over the PADDING block. Note\n");
1343 printf(" that the total length of the PADDING block will\n");
1344 printf(" be 4 bytes longer than the length given because\n");
1345 printf(" of the 4 metadata block header bytes. You can\n");
1346 printf(" force no PADDING block at all to be written with\n");
1347 printf(" --no-padding. The encoder writes a PADDING\n");
1348 printf(" block of 4096 bytes by default.\n");
1349 printf(" -b, --blocksize=# Specify the blocksize in samples; the default is\n");
1350 printf(" 1152 for -l 0, else 4608; must be one of 192,\n");
1351 printf(" 576, 1152, 2304, 4608, 256, 512, 1024, 2048,\n");
1352 printf(" 4096, 8192, 16384, or 32768 (unless --lax is\n");
1354 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 2,2\n");
1355 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 2,2\n");
1356 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1357 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4608 -r 3,3\n");
1358 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4608 -M -r 3,3\n");
1359 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4608 -m -r 3,3\n");
1360 printf(" -5 is the default setting\n");
1361 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4608 -m -r 4\n");
1362 printf(" -7, --compression-level-7 Synonymous with -l 8 -b 4608 -m -e -r 6\n");
1363 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4608 -m -e -r 6\n");
1364 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1365 printf(" (stereo only)\n");
1366 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1367 printf(" (stereo only)\n");
1368 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1369 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n");
1370 printf(" -p, --qlp-coeff-precision-search Do exhaustive search of LP coefficient\n");
1371 printf(" quantization (expensive!); overrides -q;\n");
1372 printf(" does nothing if using -l 0\n");
1373 printf(" -q, --qlp-coeff-precision=# Specify precision in bits of quantized\n");
1374 printf(" linear-predictor coefficients; 0 => let\n");
1375 printf(" encoder decide (the minimun is %u, the\n", FLAC__MIN_QLP_COEFF_PRECISION);
1376 printf(" default is -q 0)\n");
1377 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1378 printf(" (# is 0..16; min defaults to 0; the\n");
1379 printf(" default is -r 0; above 4 doesn't usually\n");
1380 printf(" help much)\n");
1381 printf("format options:\n");
1382 printf(" --endian={big|little} Set byte order for samples\n");
1383 printf(" --channels=# Number of channels\n");
1384 printf(" --bps=# Number of bits per sample\n");
1385 printf(" --sample-rate=# Sample rate in Hz\n");
1386 printf(" --sign={signed|unsigned} Sign of samples (the default is signed)\n");
1387 printf(" --force-aiff-format Force the decoder to output AIFF format. This\n");
1388 printf(" option is not needed if the output filename (as\n");
1389 printf(" set by -o) ends with .aif or .aiff; this option\n");
1390 printf(" has no effect when encoding since input AIFF is\n");
1391 printf(" auto-detected.\n");
1392 printf(" --force-raw-format Force input (when encoding) or output (when\n");
1393 printf(" decoding) to be treated as raw samples\n");
1394 printf("negative options:\n");
1395 printf(" --no-adaptive-mid-side\n");
1396 printf(" --no-decode-through-errors\n");
1397 printf(" --no-delete-input-file\n");
1398 printf(" --no-exhaustive-model-search\n");
1399 printf(" --no-lax\n");
1400 printf(" --no-mid-side\n");
1401 #ifdef FLAC__HAS_OGG
1402 printf(" --no-ogg\n");
1404 printf(" --no-padding\n");
1405 printf(" --no-qlp-coeff-prec-search\n");
1406 printf(" --no-residual-gnuplot\n");
1407 printf(" --no-residual-text\n");
1408 printf(" --no-sector-align\n");
1409 printf(" --no-seektable\n");
1410 printf(" --no-silent\n");
1411 printf(" --no-force\n");
1412 printf(" --no-verify\n");
1416 format_mistake(const char *infilename, const char *wrong, const char *right)
1418 fprintf(stderr, "WARNING: %s is not a %s file; treating as a %s file\n", infilename, wrong, right);
1421 int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file)
1423 FILE *encode_infile;
1424 FLAC__byte lookahead[12];
1425 unsigned lookahead_length = 0;
1426 FileFormat fmt= RAW;
1429 encode_options_t common_options;
1430 const char *outfilename = get_encoded_outfilename(infilename);
1432 if(0 == outfilename) {
1433 fprintf(stderr, "ERROR: filename too long: %s", infilename);
1438 * Error if output file already exists (and -f not used).
1439 * Use grabbag__file_get_filesize() as a cheap way to check.
1441 if(!option_values.test_only && !option_values.force_file_overwrite && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
1442 fprintf(stderr, "ERROR: output file %s already exists, use -f to override\n", outfilename);
1446 if(0 == strcmp(infilename, "-")) {
1448 encode_infile = grabbag__file_get_binary_stdin();
1451 infilesize = grabbag__file_get_filesize(infilename);
1452 if(0 == (encode_infile = fopen(infilename, "rb"))) {
1453 fprintf(stderr, "ERROR: can't open input file %s\n", infilename);
1458 if(!option_values.force_raw_format) {
1459 /* first set format based on name */
1460 if(strlen(infilename) >= 4 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".wav"))
1462 else if(strlen(infilename) >= 4 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".aif"))
1464 else if(strlen(infilename) >= 5 && 0 == strcasecmp(infilename+(strlen(infilename)-5), ".aiff"))
1467 /* attempt to guess the file type based on the first 12 bytes */
1468 if((lookahead_length = fread(lookahead, 1, 12, encode_infile)) < 12) {
1470 format_mistake(infilename, fmt == AIF ? "AIFF" : "WAVE", "raw");
1474 if(!strncmp((const char *)lookahead, "RIFF", 4) && !strncmp((const char *)lookahead+8, "WAVE", 4))
1476 else if(!strncmp((const char *)lookahead, "FORM", 4) && !strncmp((const char *)lookahead+8, "AIFF", 4))
1480 format_mistake(infilename, fmt == AIF ? "AIFF" : "WAVE", "raw");
1486 if(option_values.sector_align && fmt == RAW && infilesize < 0) {
1487 fprintf(stderr, "ERROR: can't --sector-align when the input size is unknown\n");
1492 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)
1493 return usage_error("ERROR: for encoding a raw file you must specify a value for --endian, --sign, --channels, --bps, and --sample-rate\n");
1496 if(encode_infile == stdin || option_values.force_to_stdout) {
1497 if(option_values.replay_gain)
1498 return usage_error("ERROR: --replay-gain cannot be used when encoding to stdout\n");
1501 if(!flac__utils_parse_skip_until_specification(option_values.skip_specification, &common_options.skip_specification) || common_options.skip_specification.is_relative)
1502 return usage_error("ERROR: invalid value for --skip\n");
1504 if(!flac__utils_parse_skip_until_specification(option_values.until_specification, &common_options.until_specification)) /*@@@ more checks: no + without --skip, no - unless known total_samples_to_{en,de}code */
1505 return usage_error("ERROR: invalid value for --until\n");
1506 /* if there is no "--until" we want to default to "--until=-0" */
1507 if(0 == option_values.until_specification)
1508 common_options.until_specification.is_relative = true;
1510 common_options.verbose = option_values.verbose;
1511 common_options.verify = option_values.verify;
1512 #ifdef FLAC__HAS_OGG
1513 common_options.use_ogg = option_values.use_ogg;
1514 /* set a random serial number if one has not yet been specified */
1515 if(!option_values.has_serial_number) {
1517 option_values.serial_number = rand();
1518 option_values.has_serial_number = true;
1520 common_options.serial_number = option_values.serial_number++;
1522 common_options.lax = option_values.lax;
1523 common_options.do_mid_side = option_values.do_mid_side;
1524 common_options.loose_mid_side = option_values.loose_mid_side;
1525 common_options.do_exhaustive_model_search = option_values.do_exhaustive_model_search;
1526 common_options.do_escape_coding = option_values.do_escape_coding;
1527 common_options.do_qlp_coeff_prec_search = option_values.do_qlp_coeff_prec_search;
1528 common_options.min_residual_partition_order = option_values.min_residual_partition_order;
1529 common_options.max_residual_partition_order = option_values.max_residual_partition_order;
1530 common_options.rice_parameter_search_dist = option_values.rice_parameter_search_dist;
1531 common_options.max_lpc_order = option_values.max_lpc_order;
1532 common_options.blocksize = (unsigned)option_values.blocksize;
1533 common_options.qlp_coeff_precision = option_values.qlp_coeff_precision;
1534 common_options.padding = option_values.padding;
1535 common_options.requested_seek_points = option_values.requested_seek_points;
1536 common_options.num_requested_seek_points = option_values.num_requested_seek_points;
1537 common_options.cuesheet_filename = option_values.cuesheet_filename;
1538 common_options.cued_seekpoints = option_values.cued_seekpoints;
1539 common_options.is_first_file = is_first_file;
1540 common_options.is_last_file = is_last_file;
1541 common_options.align_reservoir = align_reservoir;
1542 common_options.align_reservoir_samples = &align_reservoir_samples;
1543 common_options.replay_gain = option_values.replay_gain;
1544 common_options.sector_align = option_values.sector_align;
1545 common_options.vorbis_comment = option_values.vorbis_comment;
1546 common_options.debug.disable_constant_subframes = option_values.debug.disable_constant_subframes;
1547 common_options.debug.disable_fixed_subframes = option_values.debug.disable_fixed_subframes;
1548 common_options.debug.disable_verbatim_subframes = option_values.debug.disable_verbatim_subframes;
1551 raw_encode_options_t options;
1553 options.common = common_options;
1554 options.is_big_endian = option_values.format_is_big_endian;
1555 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1556 options.channels = option_values.format_channels;
1557 options.bps = option_values.format_bps;
1558 options.sample_rate = option_values.format_sample_rate;
1560 retval = flac__encode_raw(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1563 wav_encode_options_t options;
1565 options.common = common_options;
1568 retval = flac__encode_aif(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1570 retval = flac__encode_wav(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1573 if(retval == 0 && strcmp(infilename, "-")) {
1574 if(strcmp(outfilename, "-")) {
1575 if(option_values.replay_gain) {
1576 float title_gain, title_peak;
1578 grabbag__replaygain_get_title(&title_gain, &title_peak);
1579 if(0 != (error = grabbag__replaygain_store_to_file_title(outfilename, title_gain, title_peak, /*preserve_modtime=*/true))) {
1580 fprintf(stderr, "%s: ERROR writing ReplayGain title tags\n", outfilename);
1583 grabbag__file_copy_metadata(infilename, outfilename);
1585 if(option_values.delete_input)
1592 int decode_file(const char *infilename)
1595 FLAC__bool treat_as_ogg = false;
1596 decode_options_t common_options;
1597 const char *outfilename = get_decoded_outfilename(infilename);
1599 if(0 == outfilename) {
1600 fprintf(stderr, "ERROR: filename too long: %s", infilename);
1605 * Error if output file already exists (and -f not used).
1606 * Use grabbag__file_get_filesize() as a cheap way to check.
1608 if(!option_values.test_only && !option_values.force_file_overwrite && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
1609 fprintf(stderr, "ERROR: output file %s already exists, use -f to override\n", outfilename);
1613 if(!option_values.test_only && !option_values.analyze) {
1614 if(option_values.force_raw_format && (option_values.format_is_big_endian < 0 || option_values.format_is_unsigned_samples < 0))
1615 return usage_error("ERROR: for decoding to a raw file you must specify a value for --endian and --sign\n");
1618 if(option_values.use_ogg)
1619 treat_as_ogg = true;
1620 else if(strlen(infilename) >= 4 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".ogg"))
1621 treat_as_ogg = true;
1623 treat_as_ogg = false;
1625 #ifndef FLAC__HAS_OGG
1627 fprintf(stderr, "%s: Ogg support has not been built into this copy of flac\n", infilename);
1632 if(!flac__utils_parse_skip_until_specification(option_values.skip_specification, &common_options.skip_specification) || common_options.skip_specification.is_relative)
1633 return usage_error("ERROR: invalid value for --skip\n");
1635 if(!flac__utils_parse_skip_until_specification(option_values.until_specification, &common_options.until_specification)) /*@@@ more checks: no + without --skip, no - unless known total_samples_to_{en,de}code */
1636 return usage_error("ERROR: invalid value for --until\n");
1637 /* if there is no "--until" we want to default to "--until=-0" */
1638 if(0 == option_values.until_specification)
1639 common_options.until_specification.is_relative = true;
1641 common_options.verbose = option_values.verbose;
1642 common_options.continue_through_decode_errors = option_values.continue_through_decode_errors;
1643 common_options.replaygain_synthesis_spec = option_values.replaygain_synthesis_spec;
1644 #ifdef FLAC__HAS_OGG
1645 common_options.is_ogg = treat_as_ogg;
1646 common_options.use_first_serial_number = !option_values.has_serial_number;
1647 common_options.serial_number = option_values.serial_number;
1650 if(!option_values.force_raw_format) {
1651 wav_decode_options_t options;
1653 options.common = common_options;
1656 option_values.force_aiff_format ||
1657 (strlen(outfilename) >= 4 && 0 == strcasecmp(outfilename+(strlen(outfilename)-4), ".aif")) ||
1658 (strlen(outfilename) >= 5 && 0 == strcasecmp(outfilename+(strlen(outfilename)-5), ".aiff"))
1660 retval = flac__decode_aiff(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1662 retval = flac__decode_wav(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1665 raw_decode_options_t options;
1667 options.common = common_options;
1668 options.is_big_endian = option_values.format_is_big_endian;
1669 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1671 retval = flac__decode_raw(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1674 if(retval == 0 && strcmp(infilename, "-")) {
1675 if(strcmp(outfilename, "-"))
1676 grabbag__file_copy_metadata(infilename, outfilename);
1677 if(option_values.delete_input && !option_values.test_only && !option_values.analyze)
1684 const char *get_encoded_outfilename(const char *infilename)
1686 const char *suffix = (option_values.use_ogg? ".ogg" : ".flac");
1687 return get_outfilename(infilename, suffix);
1690 const char *get_decoded_outfilename(const char *infilename)
1693 if(option_values.analyze) {
1696 else if(option_values.force_raw_format) {
1699 else if(option_values.force_aiff_format) {
1705 return get_outfilename(infilename, suffix);
1708 const char *get_outfilename(const char *infilename, const char *suffix)
1710 if(0 == option_values.cmdline_forced_outfilename) {
1711 static char buffer[4096]; /* @@@ bad MAGIC NUMBER */
1713 if(0 == strcmp(infilename, "-") || option_values.force_to_stdout) {
1714 strcpy(buffer, "-");
1718 if (flac__strlcpy(buffer, option_values.output_prefix? option_values.output_prefix : "", sizeof buffer) >= sizeof buffer)
1720 if (flac__strlcat(buffer, infilename, sizeof buffer) >= sizeof buffer)
1722 if(0 == (p = strrchr(buffer, '.'))) {
1723 if (flac__strlcat(buffer, suffix, sizeof buffer) >= sizeof buffer)
1727 if(0 == strcmp(p, suffix)) {
1729 if (flac__strlcat(buffer, "_new", sizeof buffer) >= sizeof buffer)
1735 if (flac__strlcat(buffer, suffix, sizeof buffer) >= sizeof buffer)
1742 return option_values.cmdline_forced_outfilename;
1745 void die(const char *message)
1747 FLAC__ASSERT(0 != message);
1748 fprintf(stderr, "ERROR: %s\n", message);
1752 char *local_strdup(const char *source)
1755 FLAC__ASSERT(0 != source);
1756 if(0 == (ret = strdup(source)))
1757 die("out of memory during strdup()");