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 { "cue" , share__required_argument, 0, 0 },
109 { "apply-replaygain-which-is-not-lossless", share__optional_argument, 0, 0 }, /* undocumented */
114 { "cuesheet" , share__required_argument, 0, 0 },
115 { "no-cued-seekpoints" , share__no_argument, 0, 0 },
116 { "tag" , share__required_argument, 0, 'T' },
117 { "compression-level-0" , share__no_argument, 0, '0' },
118 { "compression-level-1" , share__no_argument, 0, '1' },
119 { "compression-level-2" , share__no_argument, 0, '2' },
120 { "compression-level-3" , share__no_argument, 0, '3' },
121 { "compression-level-4" , share__no_argument, 0, '4' },
122 { "compression-level-5" , share__no_argument, 0, '5' },
123 { "compression-level-6" , share__no_argument, 0, '6' },
124 { "compression-level-7" , share__no_argument, 0, '7' },
125 { "compression-level-8" , share__no_argument, 0, '8' },
126 { "compression-level-9" , share__no_argument, 0, '9' },
127 { "best" , share__no_argument, 0, '8' },
128 { "fast" , share__no_argument, 0, '0' },
129 { "super-secret-totally-impractical-compression-level", share__no_argument, 0, 0 },
130 { "verify" , share__no_argument, 0, 'V' },
131 { "force-aiff-format" , share__no_argument, 0, 0 },
132 { "force-raw-format" , share__no_argument, 0, 0 },
133 { "lax" , share__no_argument, 0, 0 },
134 { "replay-gain" , share__no_argument, 0, 0 },
135 { "sector-align" , share__no_argument, 0, 0 },
136 { "seekpoint" , share__required_argument, 0, 'S' },
137 { "padding" , share__required_argument, 0, 'P' },
139 { "ogg" , share__no_argument, 0, 0 },
140 { "serial-number" , share__required_argument, 0, 0 },
142 { "blocksize" , share__required_argument, 0, 'b' },
143 { "exhaustive-model-search" , share__no_argument, 0, 'e' },
144 { "max-lpc-order" , share__required_argument, 0, 'l' },
145 { "mid-side" , share__no_argument, 0, 'm' },
146 { "adaptive-mid-side" , share__no_argument, 0, 'M' },
147 { "qlp-coeff-precision-search", share__no_argument, 0, 'p' },
148 { "qlp-coeff-precision" , share__required_argument, 0, 'q' },
149 { "rice-partition-order" , share__required_argument, 0, 'r' },
150 { "endian" , share__required_argument, 0, 0 },
151 { "channels" , share__required_argument, 0, 0 },
152 { "bps" , share__required_argument, 0, 0 },
153 { "sample-rate" , share__required_argument, 0, 0 },
154 { "sign" , share__required_argument, 0, 0 },
159 { "residual-gnu-plot", share__no_argument, 0, 0 },
160 { "residual-text", share__no_argument, 0, 0 },
165 { "no-decode-through-errors" , share__no_argument, 0, 0 },
166 { "no-silent" , share__no_argument, 0, 0 },
167 { "no-force" , share__no_argument, 0, 0 },
168 { "no-seektable" , share__no_argument, 0, 0 },
169 { "no-delete-input-file" , share__no_argument, 0, 0 },
170 { "no-replay-gain" , share__no_argument, 0, 0 },
171 { "no-sector-align" , share__no_argument, 0, 0 },
172 { "no-lax" , share__no_argument, 0, 0 },
174 { "no-ogg" , share__no_argument, 0, 0 },
176 { "no-exhaustive-model-search", share__no_argument, 0, 0 },
177 { "no-mid-side" , share__no_argument, 0, 0 },
178 { "no-adaptive-mid-side" , share__no_argument, 0, 0 },
179 { "no-qlp-coeff-prec-search" , share__no_argument, 0, 0 },
180 { "no-padding" , share__no_argument, 0, 0 },
181 { "no-verify" , share__no_argument, 0, 0 },
182 { "no-residual-gnuplot" , share__no_argument, 0, 0 },
183 { "no-residual-text" , share__no_argument, 0, 0 },
185 * undocumented debugging options for the test suite
187 { "disable-constant-subframes", share__no_argument, 0, 0 },
188 { "disable-fixed-subframes" , share__no_argument, 0, 0 },
189 { "disable-verbatim-subframes", share__no_argument, 0, 0 },
196 * global to hold command-line option values
200 FLAC__bool show_help;
201 FLAC__bool show_explain;
202 FLAC__bool show_version;
203 FLAC__bool mode_decode;
206 FLAC__bool force_file_overwrite;
207 FLAC__bool continue_through_decode_errors;
208 replaygain_synthesis_spec_t replaygain_synthesis_spec;
210 FLAC__bool test_only;
213 FLAC__bool has_serial_number; /* true iff --serial-number was used */
214 long serial_number; /* this is the Ogg serial number and is unused for native FLAC */
215 FLAC__bool do_mid_side;
216 FLAC__bool loose_mid_side;
217 FLAC__bool do_exhaustive_model_search;
218 FLAC__bool do_escape_coding;
219 FLAC__bool do_qlp_coeff_prec_search;
220 FLAC__bool force_to_stdout;
221 FLAC__bool force_aiff_format;
222 FLAC__bool force_raw_format;
223 FLAC__bool delete_input;
224 FLAC__bool replay_gain;
225 FLAC__bool sector_align;
226 const char *cmdline_forced_outfilename;
227 const char *output_prefix;
228 analysis_options aopts;
230 unsigned max_lpc_order;
231 unsigned qlp_coeff_precision;
232 const char *skip_specification;
233 const char *until_specification;
234 const char *cue_specification;
235 int format_is_big_endian;
236 int format_is_unsigned_samples;
239 int format_sample_rate;
241 int min_residual_partition_order;
242 int max_residual_partition_order;
243 int rice_parameter_search_dist;
244 char requested_seek_points[50000]; /* bad MAGIC NUMBER but buffer overflow is checked */
245 int num_requested_seek_points; /* -1 => no -S options were given, 0 => -S- was given */
246 const char *cuesheet_filename;
247 FLAC__bool cued_seekpoints;
252 FLAC__StreamMetadata *vorbis_comment;
255 FLAC__bool disable_constant_subframes;
256 FLAC__bool disable_fixed_subframes;
257 FLAC__bool disable_verbatim_subframes;
263 * miscellaneous globals
266 static FLAC__int32 align_reservoir_0[588], align_reservoir_1[588]; /* for carrying over samples from --sector-align */
267 static FLAC__int32 *align_reservoir[2] = { align_reservoir_0, align_reservoir_1 };
268 static unsigned align_reservoir_samples = 0; /* 0 .. 587 */
271 int main(int argc, char *argv[])
275 setlocale(LC_ALL, "");
276 if(!init_options()) {
277 fprintf(stderr, "ERROR: allocating memory\n");
281 if((retval = parse_options(argc, argv)) == 0)
294 if(option_values.show_version) {
298 else if(option_values.show_explain) {
302 else if(option_values.show_help) {
307 if(option_values.num_files == 0) {
313 * tweak options; validate the values
315 if(!option_values.mode_decode) {
316 if(option_values.blocksize < 0) {
317 if(option_values.max_lpc_order == 0)
318 option_values.blocksize = 1152;
320 option_values.blocksize = 4608;
322 if(option_values.max_residual_partition_order < 0) {
323 if(option_values.blocksize <= 1152)
324 option_values.max_residual_partition_order = 2;
325 else if(option_values.blocksize <= 2304)
326 option_values.max_residual_partition_order = 3;
327 else if(option_values.blocksize <= 4608)
328 option_values.max_residual_partition_order = 3;
330 option_values.max_residual_partition_order = 4;
331 option_values.min_residual_partition_order = option_values.max_residual_partition_order;
333 if(option_values.rice_parameter_search_dist < 0) {
334 option_values.rice_parameter_search_dist = 0;
336 if(0 != option_values.cue_specification)
337 return usage_error("ERROR: --cue is not allowed in test mode\n");
340 if(option_values.test_only) {
341 if(0 != option_values.skip_specification)
342 return usage_error("ERROR: --skip is not allowed in test mode\n");
343 if(0 != option_values.until_specification)
344 return usage_error("ERROR: --until is not allowed in test mode\n");
345 if(0 != option_values.cue_specification)
346 return usage_error("ERROR: --cue is not allowed in test mode\n");
350 if(0 != option_values.cue_specification && (0 != option_values.skip_specification || 0 != option_values.until_specification))
351 return usage_error("ERROR: --cue may not be combined with --skip or --until\n");
353 FLAC__ASSERT(option_values.blocksize >= 0 || option_values.mode_decode);
355 if(option_values.format_channels >= 0) {
356 if(option_values.format_channels == 0 || (unsigned)option_values.format_channels > FLAC__MAX_CHANNELS)
357 return usage_error("ERROR: invalid number of channels '%u', must be > 0 and <= %u\n", option_values.format_channels, FLAC__MAX_CHANNELS);
359 if(option_values.format_bps >= 0) {
360 if(option_values.format_bps != 8 && option_values.format_bps != 16 && option_values.format_bps != 24)
361 return usage_error("ERROR: invalid bits per sample '%u' (must be 8/16/24)\n", option_values.format_bps);
363 if(option_values.format_sample_rate >= 0) {
364 if(!FLAC__format_sample_rate_is_valid(option_values.format_sample_rate))
365 return usage_error("ERROR: invalid sample rate '%u', must be > 0 and <= %u\n", option_values.format_sample_rate, FLAC__MAX_SAMPLE_RATE);
367 if(option_values.force_raw_format && option_values.force_aiff_format)
368 return usage_error("ERROR: only one of --force-raw-format and --force-aiff-format allowed\n");
369 if(option_values.mode_decode) {
370 if(!option_values.force_raw_format) {
371 if(option_values.format_is_big_endian >= 0)
372 return usage_error("ERROR: --endian only allowed with --force-raw-format\n");
373 if(option_values.format_is_unsigned_samples >= 0)
374 return usage_error("ERROR: --sign only allowed with --force-raw-format\n");
376 if(option_values.format_channels >= 0)
377 return usage_error("ERROR: --channels not allowed with --decode\n");
378 if(option_values.format_bps >= 0)
379 return usage_error("ERROR: --bps not allowed with --decode\n");
380 if(option_values.format_sample_rate >= 0)
381 return usage_error("ERROR: --sample-rate not allowed with --decode\n");
383 if(!option_values.mode_decode && ((unsigned)option_values.blocksize < FLAC__MIN_BLOCK_SIZE || (unsigned)option_values.blocksize > FLAC__MAX_BLOCK_SIZE)) {
384 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);
386 if(option_values.qlp_coeff_precision > 0 && option_values.qlp_coeff_precision < FLAC__MIN_QLP_COEFF_PRECISION) {
387 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);
390 if(option_values.sector_align) {
391 if(option_values.mode_decode)
392 return usage_error("ERROR: --sector-align only allowed for encoding\n");
393 if(0 != option_values.skip_specification)
394 return usage_error("ERROR: --sector-align not allowed with --skip\n");
395 if(0 != option_values.until_specification)
396 return usage_error("ERROR: --sector-align not allowed with --until\n");
397 if(0 != option_values.cue_specification)
398 return usage_error("ERROR: --sector-align not allowed with --cue\n");
399 if(option_values.format_channels >= 0 && option_values.format_channels != 2)
400 return usage_error("ERROR: --sector-align can only be done with stereo input\n");
401 if(option_values.format_bps >= 0 && option_values.format_bps != 16)
402 return usage_error("ERROR: --sector-align can only be done with 16-bit samples\n");
403 if(option_values.format_sample_rate >= 0 && option_values.format_sample_rate != 44100)
404 return usage_error("ERROR: --sector-align can only be done with a sample rate of 44100\n");
406 if(option_values.replay_gain) {
407 if(option_values.force_to_stdout)
408 return usage_error("ERROR: --replay-gain not allowed with -c/--stdout\n");
409 if(option_values.mode_decode)
410 return usage_error("ERROR: --replay-gain only allowed for encoding\n");
411 if(option_values.format_channels > 2)
412 return usage_error("ERROR: --replay-gain can only be done with mono/stereo input\n");
413 if(option_values.format_sample_rate >= 0 && !grabbag__replaygain_is_valid_sample_frequency(option_values.format_sample_rate))
414 return usage_error("ERROR: invalid sample rate used with --replay-gain\n");
416 * We want to reserve padding space for the ReplayGain
417 * tags that we will set later, to avoid rewriting the
420 if(option_values.padding < 0) {
421 fprintf(stderr, "NOTE: --replay-gain may leave a small PADDING block even with --no-padding\n");
422 option_values.padding = GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
425 option_values.padding += GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
428 if(option_values.num_files > 1 && option_values.cmdline_forced_outfilename) {
429 return usage_error("ERROR: -o/--output-name cannot be used with multiple files\n");
431 if(option_values.cmdline_forced_outfilename && option_values.output_prefix) {
432 return usage_error("ERROR: --output-prefix conflicts with -o/--output-name\n");
434 if(!option_values.mode_decode && 0 != option_values.cuesheet_filename && option_values.num_files > 1) {
435 return usage_error("ERROR: --cuesheet cannot be used when encoding multiple files\n");
438 if(option_values.verbose) {
439 fprintf(stderr, "\n");
440 fprintf(stderr, "flac %s, Copyright (C) 2000,2001,2002,2003,2004 Josh Coalson\n", FLAC__VERSION_STRING);
441 fprintf(stderr, "flac comes with ABSOLUTELY NO WARRANTY. This is free software, and you are\n");
442 fprintf(stderr, "welcome to redistribute it under certain conditions. Type `flac' for details.\n\n");
444 if(!option_values.mode_decode) {
446 if(option_values.padding < 0)
449 sprintf(padopt, " %d", option_values.padding);
451 "options:%s%s%s%s -P%s -b %u%s -l %u%s%s%s -q %u -r %u,%u%s\n",
452 option_values.delete_input?" --delete-input-file":"",
453 option_values.sector_align?" --sector-align":"",
454 option_values.use_ogg?" --ogg":"",
455 option_values.lax?" --lax":"",
457 (unsigned)option_values.blocksize,
458 option_values.loose_mid_side?" -M":option_values.do_mid_side?" -m":"",
459 option_values.max_lpc_order,
460 option_values.do_exhaustive_model_search?" -e":"",
461 option_values.do_escape_coding?" -E":"",
462 option_values.do_qlp_coeff_prec_search?" -p":"",
463 option_values.qlp_coeff_precision,
464 (unsigned)option_values.min_residual_partition_order,
465 (unsigned)option_values.max_residual_partition_order,
466 option_values.verify? " -V":""
471 if(option_values.mode_decode) {
472 FLAC__bool first = true;
474 if(option_values.num_files == 0) {
475 retval = decode_file("-");
479 if(option_values.num_files > 1)
480 option_values.cmdline_forced_outfilename = 0;
481 for(i = 0, retval = 0; i < option_values.num_files; i++) {
482 if(0 == strcmp(option_values.filenames[i], "-") && !first)
484 retval |= decode_file(option_values.filenames[i]);
490 FLAC__bool first = true;
492 if(option_values.num_files == 0) {
493 retval = encode_file("-", first, true);
497 if(option_values.num_files > 1)
498 option_values.cmdline_forced_outfilename = 0;
499 for(i = 0, retval = 0; i < option_values.num_files; i++) {
500 if(0 == strcmp(option_values.filenames[i], "-") && !first)
502 retval |= encode_file(option_values.filenames[i], first, i == (option_values.num_files-1));
505 if(option_values.replay_gain && retval == 0) {
506 float album_gain, album_peak;
507 grabbag__replaygain_get_album(&album_gain, &album_peak);
508 for(i = 0; i < option_values.num_files; i++) {
509 const char *error, *outfilename = get_encoded_outfilename(option_values.filenames[i]);
510 if(0 == outfilename) {
511 fprintf(stderr, "ERROR: filename too long: %s", option_values.filenames[i]);
514 if(0 == strcmp(option_values.filenames[i], "-")) {
516 /* double protection */
517 fprintf(stderr, "internal error\n");
520 if(0 != (error = grabbag__replaygain_store_to_file_album(outfilename, album_gain, album_peak, /*preserve_modtime=*/true))) {
521 fprintf(stderr, "%s: ERROR writing ReplayGain album tags\n", outfilename);
532 FLAC__bool init_options()
534 option_values.show_help = false;
535 option_values.show_explain = false;
536 option_values.mode_decode = false;
537 option_values.verify = false;
538 option_values.verbose = true;
539 option_values.force_file_overwrite = false;
540 option_values.continue_through_decode_errors = false;
541 option_values.replaygain_synthesis_spec.apply = false;
542 option_values.replaygain_synthesis_spec.use_album_gain = true;
543 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__HARD;
544 option_values.replaygain_synthesis_spec.noise_shaping = NOISE_SHAPING_LOW;
545 option_values.replaygain_synthesis_spec.preamp = 0.0;
546 option_values.lax = false;
547 option_values.test_only = false;
548 option_values.analyze = false;
549 option_values.use_ogg = false;
550 option_values.has_serial_number = false;
551 option_values.serial_number = 0;
552 option_values.do_mid_side = true;
553 option_values.loose_mid_side = false;
554 option_values.do_exhaustive_model_search = false;
555 option_values.do_escape_coding = false;
556 option_values.do_qlp_coeff_prec_search = false;
557 option_values.force_to_stdout = false;
558 option_values.force_aiff_format = false;
559 option_values.force_raw_format = false;
560 option_values.delete_input = false;
561 option_values.replay_gain = false;
562 option_values.sector_align = false;
563 option_values.cmdline_forced_outfilename = 0;
564 option_values.output_prefix = 0;
565 option_values.aopts.do_residual_text = false;
566 option_values.aopts.do_residual_gnuplot = false;
567 option_values.padding = 4096;
568 option_values.max_lpc_order = 8;
569 option_values.qlp_coeff_precision = 0;
570 option_values.skip_specification = 0;
571 option_values.until_specification = 0;
572 option_values.cue_specification = 0;
573 option_values.format_is_big_endian = -1;
574 option_values.format_is_unsigned_samples = -1;
575 option_values.format_channels = -1;
576 option_values.format_bps = -1;
577 option_values.format_sample_rate = -1;
578 option_values.blocksize = -1;
579 option_values.min_residual_partition_order = -1;
580 option_values.max_residual_partition_order = -1;
581 option_values.rice_parameter_search_dist = -1;
582 option_values.requested_seek_points[0] = '\0';
583 option_values.num_requested_seek_points = -1;
584 option_values.cuesheet_filename = 0;
585 option_values.cued_seekpoints = true;
587 option_values.num_files = 0;
588 option_values.filenames = 0;
590 if(0 == (option_values.vorbis_comment = FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT)))
593 option_values.debug.disable_constant_subframes = false;
594 option_values.debug.disable_fixed_subframes = false;
595 option_values.debug.disable_verbatim_subframes = false;
600 int parse_options(int argc, char *argv[])
603 int option_index = 1;
604 FLAC__bool had_error = false;
605 const char *short_opts = "0123456789ab:cdefFhHl:mMo:pP:q:r:sS:tT:vV";
607 while ((short_option = share__getopt_long(argc, argv, short_opts, long_options_, &option_index)) != -1) {
608 switch (short_option) {
609 case 0: /* long option with no equivalent short option */
610 had_error |= (parse_option(short_option, long_options_[option_index].name, share__optarg) != 0);
616 default: /* short option */
617 had_error |= (parse_option(short_option, 0, share__optarg) != 0);
626 FLAC__ASSERT(share__optind <= argc);
628 option_values.num_files = argc - share__optind;
630 if(option_values.num_files > 0) {
632 if(0 == (option_values.filenames = malloc(sizeof(char *) * option_values.num_files)))
633 die("out of memory allocating space for file names list");
634 while(share__optind < argc)
635 option_values.filenames[i++] = local_strdup(argv[share__optind++]);
641 int parse_option(int short_option, const char *long_option, const char *option_argument)
645 if(short_option == 0) {
646 FLAC__ASSERT(0 != long_option);
647 if(0 == strcmp(long_option, "delete-input-file")) {
648 option_values.delete_input = true;
650 else if(0 == strcmp(long_option, "output-prefix")) {
651 FLAC__ASSERT(0 != option_argument);
652 option_values.output_prefix = option_argument;
654 else if(0 == strcmp(long_option, "skip")) {
655 FLAC__ASSERT(0 != option_argument);
656 option_values.skip_specification = option_argument;
658 else if(0 == strcmp(long_option, "until")) {
659 FLAC__ASSERT(0 != option_argument);
660 option_values.until_specification = option_argument;
662 else if(0 == strcmp(long_option, "cue")) {
663 FLAC__ASSERT(0 != option_argument);
664 option_values.cue_specification = option_argument;
666 else if(0 == strcmp(long_option, "apply-replaygain-which-is-not-lossless")) {
667 option_values.replaygain_synthesis_spec.apply = true;
668 if (0 != option_argument) {
670 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__NONE;
671 option_values.replaygain_synthesis_spec.noise_shaping = NOISE_SHAPING_NONE;
672 option_values.replaygain_synthesis_spec.preamp = strtod(option_argument, &p);
675 option_values.replaygain_synthesis_spec.use_album_gain = true;
677 option_values.replaygain_synthesis_spec.use_album_gain = false;
679 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__PEAK;
681 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__HARD;
682 else if (*p == 'n' && p[1] >= '0' && p[1] <= '3') {
683 option_values.replaygain_synthesis_spec.noise_shaping = p[1] - '0';
687 return usage_error("ERROR: bad specification string \"%s\" for --%s\n", option_argument, long_option);
691 else if(0 == strcmp(long_option, "cuesheet")) {
692 FLAC__ASSERT(0 != option_argument);
693 option_values.cuesheet_filename = option_argument;
695 else if(0 == strcmp(long_option, "no-cued-seekpoints")) {
696 option_values.cued_seekpoints = false;
698 else if(0 == strcmp(long_option, "super-secret-totally-impractical-compression-level")) {
699 option_values.lax = true;
700 option_values.do_exhaustive_model_search = true;
701 option_values.do_escape_coding = true;
702 option_values.do_mid_side = true;
703 option_values.loose_mid_side = false;
704 option_values.do_qlp_coeff_prec_search = true;
705 option_values.min_residual_partition_order = 0;
706 option_values.max_residual_partition_order = 16;
707 option_values.rice_parameter_search_dist = 0;
708 option_values.max_lpc_order = 32;
710 else if(0 == strcmp(long_option, "force-aiff-format")) {
711 option_values.force_aiff_format = true;
713 else if(0 == strcmp(long_option, "force-raw-format")) {
714 option_values.force_raw_format = true;
716 else if(0 == strcmp(long_option, "lax")) {
717 option_values.lax = true;
719 else if(0 == strcmp(long_option, "replay-gain")) {
720 option_values.replay_gain = true;
722 else if(0 == strcmp(long_option, "sector-align")) {
723 option_values.sector_align = true;
726 else if(0 == strcmp(long_option, "ogg")) {
727 option_values.use_ogg = true;
729 else if(0 == strcmp(long_option, "serial-number")) {
730 option_values.has_serial_number = true;
731 option_values.serial_number = atol(option_argument);
734 else if(0 == strcmp(long_option, "endian")) {
735 FLAC__ASSERT(0 != option_argument);
736 if(0 == strncmp(option_argument, "big", strlen(option_argument)))
737 option_values.format_is_big_endian = true;
738 else if(0 == strncmp(option_argument, "little", strlen(option_argument)))
739 option_values.format_is_big_endian = false;
741 return usage_error("ERROR: argument to --endian must be \"big\" or \"little\"\n");
743 else if(0 == strcmp(long_option, "channels")) {
744 FLAC__ASSERT(0 != option_argument);
745 option_values.format_channels = atoi(option_argument);
747 else if(0 == strcmp(long_option, "bps")) {
748 FLAC__ASSERT(0 != option_argument);
749 option_values.format_bps = atoi(option_argument);
751 else if(0 == strcmp(long_option, "sample-rate")) {
752 FLAC__ASSERT(0 != option_argument);
753 option_values.format_sample_rate = atoi(option_argument);
755 else if(0 == strcmp(long_option, "sign")) {
756 FLAC__ASSERT(0 != option_argument);
757 if(0 == strncmp(option_argument, "signed", strlen(option_argument)))
758 option_values.format_is_unsigned_samples = false;
759 else if(0 == strncmp(option_argument, "unsigned", strlen(option_argument)))
760 option_values.format_is_unsigned_samples = true;
762 return usage_error("ERROR: argument to --sign must be \"signed\" or \"unsigned\"\n");
764 else if(0 == strcmp(long_option, "residual-gnu-plot")) {
765 option_values.aopts.do_residual_gnuplot = true;
767 else if(0 == strcmp(long_option, "residual-text")) {
768 option_values.aopts.do_residual_text = true;
773 else if(0 == strcmp(long_option, "no-decode-through-errors")) {
774 option_values.continue_through_decode_errors = false;
776 else if(0 == strcmp(long_option, "no-silent")) {
777 option_values.verbose = true;
779 else if(0 == strcmp(long_option, "no-force")) {
780 option_values.force_file_overwrite = false;
782 else if(0 == strcmp(long_option, "no-seektable")) {
783 option_values.num_requested_seek_points = 0;
784 option_values.requested_seek_points[0] = '\0';
786 else if(0 == strcmp(long_option, "no-delete-input-file")) {
787 option_values.delete_input = false;
789 else if(0 == strcmp(long_option, "no-replay-gain")) {
790 option_values.replay_gain = false;
792 else if(0 == strcmp(long_option, "no-sector-align")) {
793 option_values.sector_align = false;
795 else if(0 == strcmp(long_option, "no-lax")) {
796 option_values.lax = false;
799 else if(0 == strcmp(long_option, "no-ogg")) {
800 option_values.use_ogg = false;
803 else if(0 == strcmp(long_option, "no-exhaustive-model-search")) {
804 option_values.do_exhaustive_model_search = false;
806 else if(0 == strcmp(long_option, "no-mid-side")) {
807 option_values.do_mid_side = option_values.loose_mid_side = false;
809 else if(0 == strcmp(long_option, "no-adaptive-mid-side")) {
810 option_values.loose_mid_side = option_values.do_mid_side = false;
812 else if(0 == strcmp(long_option, "no-qlp-coeff-prec-search")) {
813 option_values.do_qlp_coeff_prec_search = false;
815 else if(0 == strcmp(long_option, "no-padding")) {
816 option_values.padding = -1;
818 else if(0 == strcmp(long_option, "no-verify")) {
819 option_values.verify = false;
821 else if(0 == strcmp(long_option, "no-residual-gnuplot")) {
822 option_values.aopts.do_residual_gnuplot = false;
824 else if(0 == strcmp(long_option, "no-residual-text")) {
825 option_values.aopts.do_residual_text = false;
827 else if(0 == strcmp(long_option, "disable-constant-subframes")) {
828 option_values.debug.disable_constant_subframes = true;
830 else if(0 == strcmp(long_option, "disable-fixed-subframes")) {
831 option_values.debug.disable_fixed_subframes = true;
833 else if(0 == strcmp(long_option, "disable-verbatim-subframes")) {
834 option_values.debug.disable_verbatim_subframes = true;
838 const char *violation;
839 switch(short_option) {
841 option_values.show_help = true;
844 option_values.show_explain = true;
847 option_values.show_version = true;
850 option_values.mode_decode = true;
853 option_values.mode_decode = true;
854 option_values.analyze = true;
857 option_values.mode_decode = true;
858 option_values.test_only = true;
861 option_values.force_to_stdout = true;
864 option_values.verbose = false;
867 option_values.force_file_overwrite = true;
870 FLAC__ASSERT(0 != option_argument);
871 option_values.cmdline_forced_outfilename = option_argument;
874 option_values.continue_through_decode_errors = true;
877 FLAC__ASSERT(0 != option_argument);
878 if(!flac__vorbiscomment_add(option_values.vorbis_comment, option_argument, &violation))
879 return usage_error("ERROR: (-T/--tag) %s\n", violation);
882 option_values.do_exhaustive_model_search = false;
883 option_values.do_escape_coding = false;
884 option_values.do_mid_side = false;
885 option_values.loose_mid_side = false;
886 option_values.qlp_coeff_precision = 0;
887 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 2;
888 option_values.rice_parameter_search_dist = 0;
889 option_values.max_lpc_order = 0;
892 option_values.do_exhaustive_model_search = false;
893 option_values.do_escape_coding = false;
894 option_values.do_mid_side = true;
895 option_values.loose_mid_side = true;
896 option_values.qlp_coeff_precision = 0;
897 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 2;
898 option_values.rice_parameter_search_dist = 0;
899 option_values.max_lpc_order = 0;
902 option_values.do_exhaustive_model_search = false;
903 option_values.do_escape_coding = false;
904 option_values.do_mid_side = true;
905 option_values.loose_mid_side = false;
906 option_values.qlp_coeff_precision = 0;
907 option_values.min_residual_partition_order = 0;
908 option_values.max_residual_partition_order = 3;
909 option_values.rice_parameter_search_dist = 0;
910 option_values.max_lpc_order = 0;
913 option_values.do_exhaustive_model_search = false;
914 option_values.do_escape_coding = false;
915 option_values.do_mid_side = false;
916 option_values.loose_mid_side = false;
917 option_values.qlp_coeff_precision = 0;
918 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
919 option_values.rice_parameter_search_dist = 0;
920 option_values.max_lpc_order = 6;
923 option_values.do_exhaustive_model_search = false;
924 option_values.do_escape_coding = false;
925 option_values.do_mid_side = true;
926 option_values.loose_mid_side = true;
927 option_values.qlp_coeff_precision = 0;
928 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
929 option_values.rice_parameter_search_dist = 0;
930 option_values.max_lpc_order = 8;
933 option_values.do_exhaustive_model_search = false;
934 option_values.do_escape_coding = false;
935 option_values.do_mid_side = true;
936 option_values.loose_mid_side = false;
937 option_values.qlp_coeff_precision = 0;
938 option_values.min_residual_partition_order = option_values.max_residual_partition_order = 3;
939 option_values.rice_parameter_search_dist = 0;
940 option_values.max_lpc_order = 8;
943 option_values.do_exhaustive_model_search = false;
944 option_values.do_escape_coding = false;
945 option_values.do_mid_side = true;
946 option_values.loose_mid_side = false;
947 option_values.qlp_coeff_precision = 0;
948 option_values.min_residual_partition_order = 0;
949 option_values.max_residual_partition_order = 4;
950 option_values.rice_parameter_search_dist = 0;
951 option_values.max_lpc_order = 8;
954 option_values.do_exhaustive_model_search = true;
955 option_values.do_escape_coding = false;
956 option_values.do_mid_side = true;
957 option_values.loose_mid_side = false;
958 option_values.qlp_coeff_precision = 0;
959 option_values.min_residual_partition_order = 0;
960 option_values.max_residual_partition_order = 6;
961 option_values.rice_parameter_search_dist = 0;
962 option_values.max_lpc_order = 8;
965 option_values.do_exhaustive_model_search = true;
966 option_values.do_escape_coding = false;
967 option_values.do_mid_side = true;
968 option_values.loose_mid_side = false;
969 option_values.qlp_coeff_precision = 0;
970 option_values.min_residual_partition_order = 0;
971 option_values.max_residual_partition_order = 6;
972 option_values.rice_parameter_search_dist = 0;
973 option_values.max_lpc_order = 12;
976 return usage_error("ERROR: compression level '9' is reserved\n");
978 option_values.verify = true;
981 FLAC__ASSERT(0 != option_argument);
982 if(option_values.num_requested_seek_points < 0)
983 option_values.num_requested_seek_points = 0;
984 option_values.num_requested_seek_points++;
985 if(strlen(option_values.requested_seek_points)+strlen(option_argument)+2 >= sizeof(option_values.requested_seek_points)) {
986 return usage_error("ERROR: too many seekpoints requested\n");
989 strcat(option_values.requested_seek_points, option_argument);
990 strcat(option_values.requested_seek_points, ";");
994 FLAC__ASSERT(0 != option_argument);
995 option_values.padding = atoi(option_argument);
996 if(option_values.padding < 0)
997 return usage_error("ERROR: argument to -P must be >= 0\n");
1000 FLAC__ASSERT(0 != option_argument);
1001 option_values.blocksize = atoi(option_argument);
1004 option_values.do_exhaustive_model_search = true;
1007 option_values.do_escape_coding = true;
1010 FLAC__ASSERT(0 != option_argument);
1011 option_values.max_lpc_order = atoi(option_argument);
1014 option_values.do_mid_side = true;
1015 option_values.loose_mid_side = false;
1018 option_values.loose_mid_side = option_values.do_mid_side = true;
1021 option_values.do_qlp_coeff_prec_search = true;
1024 FLAC__ASSERT(0 != option_argument);
1025 option_values.qlp_coeff_precision = atoi(option_argument);
1028 FLAC__ASSERT(0 != option_argument);
1029 p = strchr(option_argument, ',');
1031 option_values.min_residual_partition_order = 0;
1032 option_values.max_residual_partition_order = atoi(option_argument);
1035 option_values.min_residual_partition_order = atoi(option_argument);
1036 option_values.max_residual_partition_order = atoi(++p);
1040 FLAC__ASSERT(0 != option_argument);
1041 option_values.rice_parameter_search_dist = atoi(option_argument);
1054 if(0 != option_values.filenames) {
1055 for(i = 0; i < option_values.num_files; i++) {
1056 if(0 != option_values.filenames[i])
1057 free(option_values.filenames[i]);
1059 free(option_values.filenames);
1061 if(0 != option_values.vorbis_comment)
1062 FLAC__metadata_object_delete(option_values.vorbis_comment);
1065 int usage_error(const char *message, ...)
1069 FLAC__ASSERT(0 != message);
1071 va_start(args, message);
1073 (void) vfprintf(stderr, message, args);
1077 printf("Type \"flac\" for a usage summary or \"flac --help\" for all options\n");
1084 printf("flac %s\n", FLAC__VERSION_STRING);
1087 static void usage_header()
1089 printf("===============================================================================\n");
1090 printf("flac - Command-line FLAC encoder/decoder version %s\n", FLAC__VERSION_STRING);
1091 printf("Copyright (C) 2000,2001,2002,2003,2004 Josh Coalson\n");
1093 printf("This program is free software; you can redistribute it and/or\n");
1094 printf("modify it under the terms of the GNU General Public License\n");
1095 printf("as published by the Free Software Foundation; either version 2\n");
1096 printf("of the License, or (at your option) any later version.\n");
1098 printf("This program is distributed in the hope that it will be useful,\n");
1099 printf("but WITHOUT ANY WARRANTY; without even the implied warranty of\n");
1100 printf("MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n");
1101 printf("GNU General Public License for more details.\n");
1103 printf("You should have received a copy of the GNU General Public License\n");
1104 printf("along with this program; if not, write to the Free Software\n");
1105 printf("Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\n");
1106 printf("===============================================================================\n");
1109 static void usage_summary()
1113 printf(" Encoding: flac [<general-options>] [<encoding/format-options>] [INPUTFILE [...]]\n");
1114 printf(" Decoding: flac -d [<general-options>] [<format-options>] [FLACFILE [...]]\n");
1115 printf(" Testing: flac -t [<general-options>] [FLACFILE [...]]\n");
1116 printf("Analyzing: flac -a [<general-options>] [<analysis-options>] [FLACFILE [...]]\n");
1124 printf("This is the short help; for all options use 'flac --help'; for even more\n");
1125 printf("instructions use 'flac --explain'\n");
1127 printf("To encode:\n");
1128 printf(" flac [-#] [INPUTFILE [...]]\n");
1130 printf(" -# is -0 (fastest compression) to -8 (highest compression); -5 is the default\n");
1132 printf("To decode:\n");
1133 printf(" flac -d [INPUTFILE [...]]\n");
1135 printf("To test:\n");
1136 printf(" flac -t [INPUTFILE [...]]\n");
1143 printf("general options:\n");
1144 printf(" -v, --version Show the flac version number\n");
1145 printf(" -h, --help Show this screen\n");
1146 printf(" -H, --explain Show detailed explanation of usage and options\n");
1147 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1148 printf(" -t, --test Same as -d except no decoded file is written\n");
1149 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1150 printf(" -c, --stdout Write output to stdout\n");
1151 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1152 printf(" -f, --force Force overwriting of output files\n");
1153 printf(" -o, --output-name=FILENAME Force the output file name\n");
1154 printf(" --output-prefix=STRING Prepend STRING to output names\n");
1155 printf(" --delete-input-file Deletes after a successful encode/decode\n");
1156 printf(" --skip={#|mm:ss.ss} Skip the given initial samples for each input\n");
1157 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample for each input file\n");
1158 #ifdef FLAC__HAS_OGG
1159 printf(" --ogg Use Ogg as transport layer\n");
1160 printf(" --serial-number Serial number to use for the FLAC stream\n");
1162 printf("analysis options:\n");
1163 printf(" --residual-text Include residual signal in text output\n");
1164 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1165 printf("decoding options:\n");
1166 printf(" -F, --decode-through-errors Continue decoding through stream errors\n");
1167 printf(" --cue=[#.#][-[#.#]] Set the beginning and ending cuepoints to decode\n");
1168 printf("encoding options:\n");
1169 printf(" -V, --verify Verify a correct encoding\n");
1170 printf(" --lax Allow encoder to generate non-Subset files\n");
1171 printf(" --sector-align Align multiple files on sector boundaries\n");
1172 printf(" --replay-gain Calculate ReplayGain & store in Vorbis comments\n");
1173 printf(" --cuesheet=FILENAME Import cuesheet and store in CUESHEET block\n");
1174 printf(" -T, --tag=FIELD=VALUE Add a Vorbis comment; may appear multiple times\n");
1175 printf(" -S, --seekpoint={#|X|#x|#s} Add seek point(s)\n");
1176 printf(" -P, --padding=# Write a PADDING block of length #\n");
1177 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 2,2\n");
1178 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 2,2\n");
1179 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1180 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4608 -r 3,3\n");
1181 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4608 -M -r 3,3\n");
1182 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4608 -m -r 3,3\n");
1183 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4608 -m -r 4\n");
1184 printf(" -7, --compression-level-7 Synonymous with -l 8 -b 4608 -m -e -r 6\n");
1185 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4608 -m -e -r 6\n");
1186 printf(" -b, --blocksize=# Specify blocksize in samples\n");
1187 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1188 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1189 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1190 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n");
1191 printf(" -p, --qlp-coeff-precision-search Exhaustively search LP coeff quantization\n");
1192 printf(" -q, --qlp-coeff-precision=# Specify precision in bits\n");
1193 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1194 printf("format options:\n");
1195 printf(" --endian={big|little} Set byte order for samples\n");
1196 printf(" --channels=# Number of channels\n");
1197 printf(" --bps=# Number of bits per sample\n");
1198 printf(" --sample-rate=# Sample rate in Hz\n");
1199 printf(" --sign={signed|unsigned} Sign of samples\n");
1200 printf(" --force-aiff-format Force decoding to AIFF format\n");
1201 printf(" --force-raw-format Treat input or output as raw samples\n");
1202 printf("negative options:\n");
1203 printf(" --no-adaptive-mid-side\n");
1204 printf(" --no-decode-through-errors\n");
1205 printf(" --no-delete-input-file\n");
1206 printf(" --no-exhaustive-model-search\n");
1207 printf(" --no-lax\n");
1208 printf(" --no-mid-side\n");
1209 #ifdef FLAC__HAS_OGG
1210 printf(" --no-ogg\n");
1212 printf(" --no-padding\n");
1213 printf(" --no-qlp-coeff-prec-search\n");
1214 printf(" --no-replay-gain\n");
1215 printf(" --no-residual-gnuplot\n");
1216 printf(" --no-residual-text\n");
1217 printf(" --no-sector-align\n");
1218 printf(" --no-seektable\n");
1219 printf(" --no-silent\n");
1220 printf(" --no-force\n");
1221 printf(" --no-verify\n");
1228 printf("For encoding:\n");
1229 printf(" The input file(s) may be a PCM RIFF WAVE file, AIFF file, or raw samples.\n");
1230 printf(" The output file(s) will be in native FLAC or Ogg FLAC format\n");
1231 printf("For decoding, the reverse is true.\n");
1233 printf("A single INPUTFILE may be - for stdin. No INPUTFILE implies stdin. Use of\n");
1234 printf("stdin implies -c (write to stdout). Normally you should use:\n");
1235 printf(" flac [options] -o outfilename or flac -d [options] -o outfilename\n");
1236 printf("instead of:\n");
1237 printf(" flac [options] > outfilename or flac -d [options] > outfilename\n");
1238 printf("since the former allows flac to seek backwards to write the STREAMINFO or\n");
1239 printf("WAVE/AIFF header contents when necessary.\n");
1241 printf("flac checks for the presence of a AIFF/WAVE header to decide whether or not to\n");
1242 printf("treat an input file as AIFF/WAVE format or raw samples. If any input file is\n");
1243 printf("raw you must specify the format options {-fb|fl} -fc -fp and -fs, which will\n");
1244 printf("apply to all raw files. You can force AIFF/WAVE files to be treated as raw\n");
1245 printf("files using -fr.\n");
1247 printf("general options:\n");
1248 printf(" -v, --version Show the flac version number\n");
1249 printf(" -h, --help Show basic usage a list of all options\n");
1250 printf(" -H, --explain Show this screen\n");
1251 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1252 printf(" -t, --test Same as -d except no decoded file is written\n");
1253 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1254 printf(" -c, --stdout Write output to stdout\n");
1255 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1256 printf(" -f, --force Force overwriting of output files\n");
1257 printf(" -o, --output-name=FILENAME Force the output file name; usually flac just\n");
1258 printf(" changes the extension. May only be used when\n");
1259 printf(" encoding a single file. May not be used in\n");
1260 printf(" conjunction with --output-prefix.\n");
1261 printf(" --output-prefix=STRING Prefix each output file name with the given\n");
1262 printf(" STRING. This can be useful for encoding or\n");
1263 printf(" decoding files to a different directory. Make\n");
1264 printf(" sure if your STRING is a path name that it ends\n");
1265 printf(" with a '/' slash.\n");
1266 printf(" --delete-input-file Automatically delete the input file after a\n");
1267 printf(" successful encode or decode. If there was an\n");
1268 printf(" error (including a verify error) the input file\n");
1269 printf(" is left intact.\n");
1270 printf(" --skip={#|mm:ss.ss} Skip the first # samples of each input file; can\n");
1271 printf(" be used both for encoding and decoding. The\n");
1272 printf(" alternative form mm:ss.ss can be used to specify\n");
1273 printf(" minutes, seconds, and fractions of a second.\n");
1274 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample number for each input\n");
1275 printf(" file. The given sample number is not included\n");
1276 printf(" in the decoded output. The alternative form\n");
1277 printf(" mm:ss.ss can be used to specify minutes,\n");
1278 printf(" seconds, and fractions of a second. If a `+'\n");
1279 printf(" sign is at the beginning, the --until point is\n");
1280 printf(" relative to the --skip point. If a `-' sign is\n");
1281 printf(" at the beginning, the --until point is relative\n");
1282 printf(" to end of the audio.\n");
1283 #ifdef FLAC__HAS_OGG
1284 printf(" --ogg When encoding, generate Ogg-FLAC output instead\n");
1285 printf(" of native-FLAC. Ogg-FLAC streams are FLAC\n");
1286 printf(" streams wrapped in an Ogg transport layer. The\n");
1287 printf(" resulting file should have an '.ogg' extension\n");
1288 printf(" and will still be decodable by flac. When\n");
1289 printf(" decoding, force the input to be treated as\n");
1290 printf(" Ogg-FLAC. This is useful when piping input\n");
1291 printf(" from stdin or when the filename does not end in\n");
1292 printf(" '.ogg'.\n");
1293 printf(" --serial-number Serial number to use for the FLAC stream. When\n");
1294 printf(" encoding and no serial number is given, flac\n");
1295 printf(" uses '0'. When decoding and no number is\n");
1296 printf(" given, flac uses the serial number of the first\n");
1299 printf("analysis options:\n");
1300 printf(" --residual-text Include residual signal in text output. This\n");
1301 printf(" will make the file very big, much larger than\n");
1302 printf(" even the decoded file.\n");
1303 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1304 printf(" of each subframe\n");
1305 printf("decoding options:\n");
1306 printf(" -F, --decode-through-errors By default flac stops decoding with an error\n");
1307 printf(" and removes the partially decoded file if it\n");
1308 printf(" encounters a bitstream error. With -F, errors\n");
1309 printf(" are still printed but flac will continue\n");
1310 printf(" decoding to completion. Note that errors may\n");
1311 printf(" cause the decoded audio to be missing some\n");
1312 printf(" samples or have silent sections.\n");
1313 printf(" --cue=[#.#][-[#.#]] Set the beginning and ending cuepoints to\n");
1314 printf(" decode. The optional first #.# is the track and\n");
1315 printf(" index point at which decoding will start; the\n");
1316 printf(" default is the beginning of the stream. The\n");
1317 printf(" optional second #.# is the track and index point\n");
1318 printf(" at which decoding will end; the default is the\n");
1319 printf(" end of the stream. If the seekpoint does not\n");
1320 printf(" exist, the closest one before it (for the start\n");
1321 printf(" point) or after it (for the end point) will be\n");
1322 printf(" used. The cuepoints are merely translated into\n");
1323 printf(" sample numbers then used as --skip and --until.\n");
1324 printf("encoding options:\n");
1325 printf(" -V, --verify Verify a correct encoding by decoding the\n");
1326 printf(" output in parallel and comparing to the\n");
1327 printf(" original\n");
1328 printf(" --lax Allow encoder to generate non-Subset files\n");
1329 printf(" --sector-align Align encoding of multiple CD format WAVE files\n");
1330 printf(" on sector boundaries.\n");
1331 printf(" --replay-gain Calculate ReplayGain values and store in Vorbis\n");
1332 printf(" comments. Title gains/peaks will be computed\n");
1333 printf(" for each file, and an album gain/peak will be\n");
1334 printf(" computed for all files. All input files must\n");
1335 printf(" have the same resolution, sample rate, and\n");
1336 printf(" number of channels. The sample rate must be\n");
1337 printf(" one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1,\n");
1338 printf(" or 48 kHz. NOTE: this option may also leave a\n");
1339 printf(" few extra bytes in the PADDING block.\n");
1340 printf(" --cuesheet=FILENAME Import the given cuesheet file and store it in\n");
1341 printf(" a CUESHEET metadata block. This option may only\n");
1342 printf(" be used when encoding a single file. A\n");
1343 printf(" seekpoint will be added for each index point in\n");
1344 printf(" the cuesheet to the SEEKTABLE unless\n");
1345 printf(" --no-cued-seekpoints is specified.\n");
1346 printf(" -T, --tag=FIELD=VALUE Add a Vorbis comment. Make sure to quote the\n");
1347 printf(" comment if necessary. This option may appear\n");
1348 printf(" more than once to add several comments. NOTE:\n");
1349 printf(" all tags will be added to all encoded files.\n");
1350 printf(" -S, --seekpoint={#|X|#x|#s} Include a point or points in a SEEKTABLE\n");
1351 printf(" # : a specific sample number for a seek point\n");
1352 printf(" X : a placeholder point (always goes at the end of the SEEKTABLE)\n");
1353 printf(" #x : # evenly spaced seekpoints, the first being at sample 0\n");
1354 printf(" #s : a seekpoint every # seconds; # does not have to be a whole number\n");
1355 printf(" You may use many -S options; the resulting SEEKTABLE will be the unique-\n");
1356 printf(" ified union of all such values.\n");
1357 printf(" With no -S options, flac defaults to '-S 10s'. Use -S- for no SEEKTABLE.\n");
1358 printf(" Note: -S #x and -S #s will not work if the encoder can't determine the\n");
1359 printf(" input size before starting.\n");
1360 printf(" Note: if you use -S # and # is >= samples in the input, there will be\n");
1361 printf(" either no seek point entered (if the input size is determinable\n");
1362 printf(" before encoding starts) or a placeholder point (if input size is not\n");
1363 printf(" determinable)\n");
1364 printf(" -P, --padding=# Tell the encoder to write a PADDING metadata\n");
1365 printf(" block of the given length (in bytes) after the\n");
1366 printf(" STREAMINFO block. This is useful if you plan\n");
1367 printf(" to tag the file later with an APPLICATION\n");
1368 printf(" block; instead of having to rewrite the entire\n");
1369 printf(" file later just to insert your block, you can\n");
1370 printf(" write directly over the PADDING block. Note\n");
1371 printf(" that the total length of the PADDING block will\n");
1372 printf(" be 4 bytes longer than the length given because\n");
1373 printf(" of the 4 metadata block header bytes. You can\n");
1374 printf(" force no PADDING block at all to be written with\n");
1375 printf(" --no-padding. The encoder writes a PADDING\n");
1376 printf(" block of 4096 bytes by default.\n");
1377 printf(" -b, --blocksize=# Specify the blocksize in samples; the default is\n");
1378 printf(" 1152 for -l 0, else 4608; must be one of 192,\n");
1379 printf(" 576, 1152, 2304, 4608, 256, 512, 1024, 2048,\n");
1380 printf(" 4096, 8192, 16384, or 32768 (unless --lax is\n");
1382 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 2,2\n");
1383 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 2,2\n");
1384 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1385 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4608 -r 3,3\n");
1386 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4608 -M -r 3,3\n");
1387 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4608 -m -r 3,3\n");
1388 printf(" -5 is the default setting\n");
1389 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4608 -m -r 4\n");
1390 printf(" -7, --compression-level-7 Synonymous with -l 8 -b 4608 -m -e -r 6\n");
1391 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4608 -m -e -r 6\n");
1392 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1393 printf(" (stereo only)\n");
1394 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1395 printf(" (stereo only)\n");
1396 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1397 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n");
1398 printf(" -p, --qlp-coeff-precision-search Do exhaustive search of LP coefficient\n");
1399 printf(" quantization (expensive!); overrides -q;\n");
1400 printf(" does nothing if using -l 0\n");
1401 printf(" -q, --qlp-coeff-precision=# Specify precision in bits of quantized\n");
1402 printf(" linear-predictor coefficients; 0 => let\n");
1403 printf(" encoder decide (the minimun is %u, the\n", FLAC__MIN_QLP_COEFF_PRECISION);
1404 printf(" default is -q 0)\n");
1405 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1406 printf(" (# is 0..16; min defaults to 0; the\n");
1407 printf(" default is -r 0; above 4 doesn't usually\n");
1408 printf(" help much)\n");
1409 printf("format options:\n");
1410 printf(" --endian={big|little} Set byte order for samples\n");
1411 printf(" --channels=# Number of channels\n");
1412 printf(" --bps=# Number of bits per sample\n");
1413 printf(" --sample-rate=# Sample rate in Hz\n");
1414 printf(" --sign={signed|unsigned} Sign of samples (the default is signed)\n");
1415 printf(" --force-aiff-format Force the decoder to output AIFF format. This\n");
1416 printf(" option is not needed if the output filename (as\n");
1417 printf(" set by -o) ends with .aif or .aiff; this option\n");
1418 printf(" has no effect when encoding since input AIFF is\n");
1419 printf(" auto-detected.\n");
1420 printf(" --force-raw-format Force input (when encoding) or output (when\n");
1421 printf(" decoding) to be treated as raw samples\n");
1422 printf("negative options:\n");
1423 printf(" --no-adaptive-mid-side\n");
1424 printf(" --no-decode-through-errors\n");
1425 printf(" --no-delete-input-file\n");
1426 printf(" --no-exhaustive-model-search\n");
1427 printf(" --no-lax\n");
1428 printf(" --no-mid-side\n");
1429 #ifdef FLAC__HAS_OGG
1430 printf(" --no-ogg\n");
1432 printf(" --no-padding\n");
1433 printf(" --no-qlp-coeff-prec-search\n");
1434 printf(" --no-residual-gnuplot\n");
1435 printf(" --no-residual-text\n");
1436 printf(" --no-sector-align\n");
1437 printf(" --no-seektable\n");
1438 printf(" --no-silent\n");
1439 printf(" --no-force\n");
1440 printf(" --no-verify\n");
1444 format_mistake(const char *infilename, const char *wrong, const char *right)
1446 fprintf(stderr, "WARNING: %s is not a %s file; treating as a %s file\n", infilename, wrong, right);
1449 int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file)
1451 FILE *encode_infile;
1452 FLAC__byte lookahead[12];
1453 unsigned lookahead_length = 0;
1454 FileFormat fmt= RAW;
1457 encode_options_t common_options;
1458 const char *outfilename = get_encoded_outfilename(infilename);
1460 if(0 == outfilename) {
1461 fprintf(stderr, "ERROR: filename too long: %s", infilename);
1466 * Error if output file already exists (and -f not used).
1467 * Use grabbag__file_get_filesize() as a cheap way to check.
1469 if(!option_values.test_only && !option_values.force_file_overwrite && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
1470 fprintf(stderr, "ERROR: output file %s already exists, use -f to override\n", outfilename);
1474 if(0 == strcmp(infilename, "-")) {
1476 encode_infile = grabbag__file_get_binary_stdin();
1479 infilesize = grabbag__file_get_filesize(infilename);
1480 if(0 == (encode_infile = fopen(infilename, "rb"))) {
1481 fprintf(stderr, "ERROR: can't open input file %s\n", infilename);
1486 if(!option_values.force_raw_format) {
1487 /* first set format based on name */
1488 if(strlen(infilename) >= 4 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".wav"))
1490 else if(strlen(infilename) >= 4 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".aif"))
1492 else if(strlen(infilename) >= 5 && 0 == strcasecmp(infilename+(strlen(infilename)-5), ".aiff"))
1495 /* attempt to guess the file type based on the first 12 bytes */
1496 if((lookahead_length = fread(lookahead, 1, 12, encode_infile)) < 12) {
1498 format_mistake(infilename, fmt == AIF ? "AIFF" : "WAVE", "raw");
1502 if(!strncmp((const char *)lookahead, "RIFF", 4) && !strncmp((const char *)lookahead+8, "WAVE", 4))
1504 else if(!strncmp((const char *)lookahead, "FORM", 4) && !strncmp((const char *)lookahead+8, "AIFF", 4))
1508 format_mistake(infilename, fmt == AIF ? "AIFF" : "WAVE", "raw");
1514 if(option_values.sector_align && fmt == RAW && infilesize < 0) {
1515 fprintf(stderr, "ERROR: can't --sector-align when the input size is unknown\n");
1520 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)
1521 return usage_error("ERROR: for encoding a raw file you must specify a value for --endian, --sign, --channels, --bps, and --sample-rate\n");
1524 if(encode_infile == stdin || option_values.force_to_stdout) {
1525 if(option_values.replay_gain)
1526 return usage_error("ERROR: --replay-gain cannot be used when encoding to stdout\n");
1529 if(!flac__utils_parse_skip_until_specification(option_values.skip_specification, &common_options.skip_specification) || common_options.skip_specification.is_relative)
1530 return usage_error("ERROR: invalid value for --skip\n");
1532 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 */
1533 return usage_error("ERROR: invalid value for --until\n");
1534 /* if there is no "--until" we want to default to "--until=-0" */
1535 if(0 == option_values.until_specification)
1536 common_options.until_specification.is_relative = true;
1538 common_options.verbose = option_values.verbose;
1539 common_options.verify = option_values.verify;
1540 #ifdef FLAC__HAS_OGG
1541 common_options.use_ogg = option_values.use_ogg;
1542 /* set a random serial number if one has not yet been specified */
1543 if(!option_values.has_serial_number) {
1545 option_values.serial_number = rand();
1546 option_values.has_serial_number = true;
1548 common_options.serial_number = option_values.serial_number++;
1550 common_options.lax = option_values.lax;
1551 common_options.do_mid_side = option_values.do_mid_side;
1552 common_options.loose_mid_side = option_values.loose_mid_side;
1553 common_options.do_exhaustive_model_search = option_values.do_exhaustive_model_search;
1554 common_options.do_escape_coding = option_values.do_escape_coding;
1555 common_options.do_qlp_coeff_prec_search = option_values.do_qlp_coeff_prec_search;
1556 common_options.min_residual_partition_order = option_values.min_residual_partition_order;
1557 common_options.max_residual_partition_order = option_values.max_residual_partition_order;
1558 common_options.rice_parameter_search_dist = option_values.rice_parameter_search_dist;
1559 common_options.max_lpc_order = option_values.max_lpc_order;
1560 common_options.blocksize = (unsigned)option_values.blocksize;
1561 common_options.qlp_coeff_precision = option_values.qlp_coeff_precision;
1562 common_options.padding = option_values.padding;
1563 common_options.requested_seek_points = option_values.requested_seek_points;
1564 common_options.num_requested_seek_points = option_values.num_requested_seek_points;
1565 common_options.cuesheet_filename = option_values.cuesheet_filename;
1566 common_options.cued_seekpoints = option_values.cued_seekpoints;
1567 common_options.is_first_file = is_first_file;
1568 common_options.is_last_file = is_last_file;
1569 common_options.align_reservoir = align_reservoir;
1570 common_options.align_reservoir_samples = &align_reservoir_samples;
1571 common_options.replay_gain = option_values.replay_gain;
1572 common_options.sector_align = option_values.sector_align;
1573 common_options.vorbis_comment = option_values.vorbis_comment;
1574 common_options.debug.disable_constant_subframes = option_values.debug.disable_constant_subframes;
1575 common_options.debug.disable_fixed_subframes = option_values.debug.disable_fixed_subframes;
1576 common_options.debug.disable_verbatim_subframes = option_values.debug.disable_verbatim_subframes;
1579 raw_encode_options_t options;
1581 options.common = common_options;
1582 options.is_big_endian = option_values.format_is_big_endian;
1583 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1584 options.channels = option_values.format_channels;
1585 options.bps = option_values.format_bps;
1586 options.sample_rate = option_values.format_sample_rate;
1588 retval = flac__encode_raw(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1591 wav_encode_options_t options;
1593 options.common = common_options;
1596 retval = flac__encode_aif(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1598 retval = flac__encode_wav(encode_infile, infilesize, infilename, outfilename, lookahead, lookahead_length, options);
1601 if(retval == 0 && strcmp(infilename, "-")) {
1602 if(strcmp(outfilename, "-")) {
1603 if(option_values.replay_gain) {
1604 float title_gain, title_peak;
1606 grabbag__replaygain_get_title(&title_gain, &title_peak);
1607 if(0 != (error = grabbag__replaygain_store_to_file_title(outfilename, title_gain, title_peak, /*preserve_modtime=*/true))) {
1608 fprintf(stderr, "%s: ERROR writing ReplayGain title tags\n", outfilename);
1611 grabbag__file_copy_metadata(infilename, outfilename);
1613 if(option_values.delete_input)
1620 int decode_file(const char *infilename)
1623 FLAC__bool treat_as_ogg = false;
1624 decode_options_t common_options;
1625 const char *outfilename = get_decoded_outfilename(infilename);
1627 if(0 == outfilename) {
1628 fprintf(stderr, "ERROR: filename too long: %s", infilename);
1633 * Error if output file already exists (and -f not used).
1634 * Use grabbag__file_get_filesize() as a cheap way to check.
1636 if(!option_values.test_only && !option_values.force_file_overwrite && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
1637 fprintf(stderr, "ERROR: output file %s already exists, use -f to override\n", outfilename);
1641 if(!option_values.test_only && !option_values.analyze) {
1642 if(option_values.force_raw_format && (option_values.format_is_big_endian < 0 || option_values.format_is_unsigned_samples < 0))
1643 return usage_error("ERROR: for decoding to a raw file you must specify a value for --endian and --sign\n");
1646 if(option_values.use_ogg)
1647 treat_as_ogg = true;
1648 else if(strlen(infilename) >= 4 && 0 == strcasecmp(infilename+(strlen(infilename)-4), ".ogg"))
1649 treat_as_ogg = true;
1651 treat_as_ogg = false;
1653 #ifndef FLAC__HAS_OGG
1655 fprintf(stderr, "%s: Ogg support has not been built into this copy of flac\n", infilename);
1660 if(!flac__utils_parse_skip_until_specification(option_values.skip_specification, &common_options.skip_specification) || common_options.skip_specification.is_relative)
1661 return usage_error("ERROR: invalid value for --skip\n");
1663 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 */
1664 return usage_error("ERROR: invalid value for --until\n");
1665 /* if there is no "--until" we want to default to "--until=-0" */
1666 if(0 == option_values.until_specification)
1667 common_options.until_specification.is_relative = true;
1669 if(option_values.cue_specification) {
1670 if(!flac__utils_parse_cue_specification(option_values.cue_specification, &common_options.cue_specification))
1671 return usage_error("ERROR: invalid value for --cue\n");
1672 common_options.has_cue_specification = true;
1675 common_options.has_cue_specification = false;
1677 common_options.verbose = option_values.verbose;
1678 common_options.continue_through_decode_errors = option_values.continue_through_decode_errors;
1679 common_options.replaygain_synthesis_spec = option_values.replaygain_synthesis_spec;
1680 #ifdef FLAC__HAS_OGG
1681 common_options.is_ogg = treat_as_ogg;
1682 common_options.use_first_serial_number = !option_values.has_serial_number;
1683 common_options.serial_number = option_values.serial_number;
1686 if(!option_values.force_raw_format) {
1687 wav_decode_options_t options;
1689 options.common = common_options;
1692 option_values.force_aiff_format ||
1693 (strlen(outfilename) >= 4 && 0 == strcasecmp(outfilename+(strlen(outfilename)-4), ".aif")) ||
1694 (strlen(outfilename) >= 5 && 0 == strcasecmp(outfilename+(strlen(outfilename)-5), ".aiff"))
1696 retval = flac__decode_aiff(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1698 retval = flac__decode_wav(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1701 raw_decode_options_t options;
1703 options.common = common_options;
1704 options.is_big_endian = option_values.format_is_big_endian;
1705 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1707 retval = flac__decode_raw(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1710 if(retval == 0 && strcmp(infilename, "-")) {
1711 if(strcmp(outfilename, "-"))
1712 grabbag__file_copy_metadata(infilename, outfilename);
1713 if(option_values.delete_input && !option_values.test_only && !option_values.analyze)
1720 const char *get_encoded_outfilename(const char *infilename)
1722 const char *suffix = (option_values.use_ogg? ".ogg" : ".flac");
1723 return get_outfilename(infilename, suffix);
1726 const char *get_decoded_outfilename(const char *infilename)
1729 if(option_values.analyze) {
1732 else if(option_values.force_raw_format) {
1735 else if(option_values.force_aiff_format) {
1741 return get_outfilename(infilename, suffix);
1744 const char *get_outfilename(const char *infilename, const char *suffix)
1746 if(0 == option_values.cmdline_forced_outfilename) {
1747 static char buffer[4096]; /* @@@ bad MAGIC NUMBER */
1749 if(0 == strcmp(infilename, "-") || option_values.force_to_stdout) {
1750 strcpy(buffer, "-");
1754 if (flac__strlcpy(buffer, option_values.output_prefix? option_values.output_prefix : "", sizeof buffer) >= sizeof buffer)
1756 if (flac__strlcat(buffer, infilename, sizeof buffer) >= sizeof buffer)
1758 if(0 == (p = strrchr(buffer, '.'))) {
1759 if (flac__strlcat(buffer, suffix, sizeof buffer) >= sizeof buffer)
1763 if(0 == strcmp(p, suffix)) {
1765 if (flac__strlcat(buffer, "_new", sizeof buffer) >= sizeof buffer)
1771 if (flac__strlcat(buffer, suffix, sizeof buffer) >= sizeof buffer)
1778 return option_values.cmdline_forced_outfilename;
1781 void die(const char *message)
1783 FLAC__ASSERT(0 != message);
1784 fprintf(stderr, "ERROR: %s\n", message);
1788 char *local_strdup(const char *source)
1791 FLAC__ASSERT(0 != source);
1792 if(0 == (ret = strdup(source)))
1793 die("out of memory during strdup()");