1 /* flac - Command-line FLAC encoder/decoder
2 * Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007 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.
33 #if !defined _MSC_VER && !defined __MINGW32__
34 /* unlink is in stdio.h in VC++ */
35 #include <unistd.h> /* for unlink() */
38 #include "share/grabbag.h"
42 #include "local_string_utils.h" /* for flac__strlcat() and flac__strlcpy() */
44 #include "vorbiscomment.h"
46 #if defined _MSC_VER || defined __MINGW32__ || defined __EMX__
47 #define FLAC__STRCASECMP stricmp
49 #define FLAC__STRCASECMP strcasecmp
53 /*[JEC] was:#if HAVE_GETOPT_LONG*/
54 /*[JEC] see flac/include/share/getopt.h as to why the change */
57 # include "share/getopt.h"
60 typedef enum { RAW, WAV, AIF, FLAC, OGGFLAC } FileFormat;
62 static int do_it(void);
64 static FLAC__bool init_options(void);
65 static int parse_options(int argc, char *argv[]);
66 static int parse_option(int short_option, const char *long_option, const char *option_argument);
67 static void free_options(void);
68 static void add_compression_setting_bool(compression_setting_type_t type, FLAC__bool value);
69 static void add_compression_setting_string(compression_setting_type_t type, const char *value);
70 static void add_compression_setting_unsigned(compression_setting_type_t type, unsigned value);
72 static int usage_error(const char *message, ...);
73 static void short_usage(void);
74 static void show_version(void);
75 static void show_help(void);
76 static void show_explain(void);
77 static void format_mistake(const char *infilename, FileFormat wrong, FileFormat right);
79 static int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file);
80 static int decode_file(const char *infilename);
82 static const char *get_encoded_outfilename(const char *infilename);
83 static const char *get_decoded_outfilename(const char *infilename);
84 static const char *get_outfilename(const char *infilename, const char *suffix);
86 static void die(const char *message);
87 static int conditional_fclose(FILE *f);
88 static char *local_strdup(const char *source);
90 /* There's no strtoll() in MSVC6 so we just write a specialized one */
91 static FLAC__int64 local__strtoll(const char *src, char **endptr);
96 * share__getopt format struct; note that for long options with no
97 * short option equivalent we just set the 'val' field to 0.
99 static struct share__option long_options_[] = {
103 { "help" , share__no_argument, 0, 'h' },
104 { "explain" , share__no_argument, 0, 'H' },
105 { "version" , share__no_argument, 0, 'v' },
106 { "decode" , share__no_argument, 0, 'd' },
107 { "analyze" , share__no_argument, 0, 'a' },
108 { "test" , share__no_argument, 0, 't' },
109 { "stdout" , share__no_argument, 0, 'c' },
110 { "silent" , share__no_argument, 0, 's' },
111 { "totally-silent" , share__no_argument, 0, 0 },
112 { "warnings-as-errors", share__no_argument, 0, 'w' },
113 { "force" , share__no_argument, 0, 'f' },
114 { "delete-input-file" , share__no_argument, 0, 0 },
115 { "output-prefix" , share__required_argument, 0, 0 },
116 { "output-name" , share__required_argument, 0, 'o' },
117 { "skip" , share__required_argument, 0, 0 },
118 { "until" , share__required_argument, 0, 0 },
119 { "channel-map" , share__required_argument, 0, 0 }, /* undocumented */
124 { "decode-through-errors", share__no_argument, 0, 'F' },
125 { "cue" , share__required_argument, 0, 0 },
126 { "apply-replaygain-which-is-not-lossless", share__optional_argument, 0, 0 }, /* undocumented */
131 { "cuesheet" , share__required_argument, 0, 0 },
132 { "no-cued-seekpoints" , share__no_argument, 0, 0 },
133 { "picture" , share__required_argument, 0, 0 },
134 { "tag" , share__required_argument, 0, 'T' },
135 { "tag-from-file" , share__required_argument, 0, 0 },
136 { "compression-level-0" , share__no_argument, 0, '0' },
137 { "compression-level-1" , share__no_argument, 0, '1' },
138 { "compression-level-2" , share__no_argument, 0, '2' },
139 { "compression-level-3" , share__no_argument, 0, '3' },
140 { "compression-level-4" , share__no_argument, 0, '4' },
141 { "compression-level-5" , share__no_argument, 0, '5' },
142 { "compression-level-6" , share__no_argument, 0, '6' },
143 { "compression-level-7" , share__no_argument, 0, '7' },
144 { "compression-level-8" , share__no_argument, 0, '8' },
145 { "compression-level-9" , share__no_argument, 0, '9' },
146 { "best" , share__no_argument, 0, '8' },
147 { "fast" , share__no_argument, 0, '0' },
148 { "verify" , share__no_argument, 0, 'V' },
149 { "force-aiff-format" , share__no_argument, 0, 0 },
150 { "force-raw-format" , share__no_argument, 0, 0 },
151 { "lax" , share__no_argument, 0, 0 },
152 { "replay-gain" , share__no_argument, 0, 0 },
153 { "ignore-chunk-sizes" , share__no_argument, 0, 0 },
154 { "sector-align" , share__no_argument, 0, 0 },
155 { "seekpoint" , share__required_argument, 0, 'S' },
156 { "padding" , share__required_argument, 0, 'P' },
158 { "ogg" , share__no_argument, 0, 0 },
159 { "serial-number" , share__required_argument, 0, 0 },
161 { "blocksize" , share__required_argument, 0, 'b' },
162 { "exhaustive-model-search" , share__no_argument, 0, 'e' },
163 { "max-lpc-order" , share__required_argument, 0, 'l' },
164 { "apodization" , share__required_argument, 0, 'A' },
165 { "mid-side" , share__no_argument, 0, 'm' },
166 { "adaptive-mid-side" , share__no_argument, 0, 'M' },
167 { "qlp-coeff-precision-search", share__no_argument, 0, 'p' },
168 { "qlp-coeff-precision" , share__required_argument, 0, 'q' },
169 { "rice-partition-order" , share__required_argument, 0, 'r' },
170 { "endian" , share__required_argument, 0, 0 },
171 { "channels" , share__required_argument, 0, 0 },
172 { "bps" , share__required_argument, 0, 0 },
173 { "sample-rate" , share__required_argument, 0, 0 },
174 { "sign" , share__required_argument, 0, 0 },
175 { "input-size" , share__required_argument, 0, 0 },
180 { "residual-gnuplot", share__no_argument, 0, 0 },
181 { "residual-text", share__no_argument, 0, 0 },
186 { "no-decode-through-errors" , share__no_argument, 0, 0 },
187 { "no-silent" , share__no_argument, 0, 0 },
188 { "no-force" , share__no_argument, 0, 0 },
189 { "no-seektable" , share__no_argument, 0, 0 },
190 { "no-delete-input-file" , share__no_argument, 0, 0 },
191 { "no-replay-gain" , share__no_argument, 0, 0 },
192 { "no-ignore-chunk-sizes" , share__no_argument, 0, 0 },
193 { "no-sector-align" , share__no_argument, 0, 0 },
194 { "no-utf8-convert" , share__no_argument, 0, 0 },
195 { "no-lax" , share__no_argument, 0, 0 },
197 { "no-ogg" , share__no_argument, 0, 0 },
199 { "no-exhaustive-model-search", share__no_argument, 0, 0 },
200 { "no-mid-side" , share__no_argument, 0, 0 },
201 { "no-adaptive-mid-side" , share__no_argument, 0, 0 },
202 { "no-qlp-coeff-prec-search" , share__no_argument, 0, 0 },
203 { "no-padding" , share__no_argument, 0, 0 },
204 { "no-verify" , share__no_argument, 0, 0 },
205 { "no-warnings-as-errors" , share__no_argument, 0, 0 },
206 { "no-residual-gnuplot" , share__no_argument, 0, 0 },
207 { "no-residual-text" , share__no_argument, 0, 0 },
209 * undocumented debugging options for the test suite
211 { "disable-constant-subframes", share__no_argument, 0, 0 },
212 { "disable-fixed-subframes" , share__no_argument, 0, 0 },
213 { "disable-verbatim-subframes", share__no_argument, 0, 0 },
214 { "no-md5-sum" , share__no_argument, 0, 0 },
221 * global to hold command-line option values
225 FLAC__bool show_help;
226 FLAC__bool show_explain;
227 FLAC__bool show_version;
228 FLAC__bool mode_decode;
230 FLAC__bool treat_warnings_as_errors;
231 FLAC__bool force_file_overwrite;
232 FLAC__bool continue_through_decode_errors;
233 replaygain_synthesis_spec_t replaygain_synthesis_spec;
235 FLAC__bool test_only;
238 FLAC__bool has_serial_number; /* true iff --serial-number was used */
239 long serial_number; /* this is the Ogg serial number and is unused for native FLAC */
240 FLAC__bool force_to_stdout;
241 FLAC__bool force_aiff_format;
242 FLAC__bool force_raw_format;
243 FLAC__bool delete_input;
244 FLAC__bool replay_gain;
245 FLAC__bool ignore_chunk_sizes;
246 FLAC__bool sector_align;
247 FLAC__bool utf8_convert; /* true by default, to convert tag strings from locale to utf-8, false if --no-utf8-convert used */
248 const char *cmdline_forced_outfilename;
249 const char *output_prefix;
250 analysis_options aopts;
251 int padding; /* -1 => no -P options were given, 0 => -P- was given, else -P value */
252 size_t num_compression_settings;
253 compression_setting_t compression_settings[64]; /* bad MAGIC NUMBER but buffer overflow is checked */
254 const char *skip_specification;
255 const char *until_specification;
256 const char *cue_specification;
257 int format_is_big_endian;
258 int format_is_unsigned_samples;
261 int format_sample_rate;
262 off_t format_input_size;
263 char requested_seek_points[5000]; /* bad MAGIC NUMBER but buffer overflow is checked */
264 int num_requested_seek_points; /* -1 => no -S options were given, 0 => -S- was given */
265 const char *cuesheet_filename;
266 FLAC__bool cued_seekpoints;
267 FLAC__bool channel_map_none; /* --channel-map=none specified, eventually will expand to take actual channel map */
272 FLAC__StreamMetadata *vorbis_comment;
273 FLAC__StreamMetadata *pictures[64];
274 unsigned num_pictures;
277 FLAC__bool disable_constant_subframes;
278 FLAC__bool disable_fixed_subframes;
279 FLAC__bool disable_verbatim_subframes;
286 * miscellaneous globals
289 static FLAC__int32 align_reservoir_0[588], align_reservoir_1[588]; /* for carrying over samples from --sector-align */
290 static FLAC__int32 *align_reservoir[2] = { align_reservoir_0, align_reservoir_1 };
291 static unsigned align_reservoir_samples = 0; /* 0 .. 587 */
294 int main(int argc, char *argv[])
299 _response(&argc, &argv);
300 _wildcard(&argc, &argv);
303 srand((unsigned)time(0));
304 setlocale(LC_ALL, "");
305 if(!init_options()) {
306 flac__utils_printf(stderr, 1, "ERROR: allocating memory\n");
310 if((retval = parse_options(argc, argv)) == 0)
323 if(option_values.show_version) {
327 else if(option_values.show_explain) {
331 else if(option_values.show_help) {
336 if(option_values.num_files == 0) {
337 if(flac__utils_verbosity_ >= 1)
343 * tweak options; validate the values
345 if(!option_values.mode_decode) {
346 if(0 != option_values.cue_specification)
347 return usage_error("ERROR: --cue is not allowed in test mode\n");
350 if(option_values.test_only) {
351 if(0 != option_values.skip_specification)
352 return usage_error("ERROR: --skip is not allowed in test mode\n");
353 if(0 != option_values.until_specification)
354 return usage_error("ERROR: --until is not allowed in test mode\n");
355 if(0 != option_values.cue_specification)
356 return usage_error("ERROR: --cue is not allowed in test mode\n");
357 if(0 != option_values.analyze)
358 return usage_error("ERROR: analysis mode (-a/--analyze) and test mode (-t/--test) cannot be used together\n");
362 if(0 != option_values.cue_specification && (0 != option_values.skip_specification || 0 != option_values.until_specification))
363 return usage_error("ERROR: --cue may not be combined with --skip or --until\n");
365 if(option_values.format_channels >= 0) {
366 if(option_values.format_channels == 0 || (unsigned)option_values.format_channels > FLAC__MAX_CHANNELS)
367 return usage_error("ERROR: invalid number of channels '%u', must be > 0 and <= %u\n", option_values.format_channels, FLAC__MAX_CHANNELS);
369 if(option_values.format_bps >= 0) {
370 if(option_values.format_bps != 8 && option_values.format_bps != 16 && option_values.format_bps != 24)
371 return usage_error("ERROR: invalid bits per sample '%u' (must be 8/16/24)\n", option_values.format_bps);
373 if(option_values.format_sample_rate >= 0) {
374 if(!FLAC__format_sample_rate_is_valid(option_values.format_sample_rate))
375 return usage_error("ERROR: invalid sample rate '%u', must be > 0 and <= %u\n", option_values.format_sample_rate, FLAC__MAX_SAMPLE_RATE);
377 if(option_values.force_raw_format && option_values.force_aiff_format)
378 return usage_error("ERROR: only one of --force-raw-format and --force-aiff-format allowed\n");
379 if(option_values.mode_decode) {
380 if(!option_values.force_raw_format) {
381 if(option_values.format_is_big_endian >= 0)
382 return usage_error("ERROR: --endian only allowed with --force-raw-format\n");
383 if(option_values.format_is_unsigned_samples >= 0)
384 return usage_error("ERROR: --sign only allowed with --force-raw-format\n");
386 if(option_values.format_channels >= 0)
387 return usage_error("ERROR: --channels not allowed with --decode\n");
388 if(option_values.format_bps >= 0)
389 return usage_error("ERROR: --bps not allowed with --decode\n");
390 if(option_values.format_sample_rate >= 0)
391 return usage_error("ERROR: --sample-rate not allowed with --decode\n");
394 if(option_values.ignore_chunk_sizes) {
395 if(option_values.mode_decode)
396 return usage_error("ERROR: --ignore-chunk-sizes only allowed for encoding\n");
397 if(0 != option_values.sector_align)
398 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --sector-align\n");
399 if(0 != option_values.until_specification)
400 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --until\n");
401 if(0 != option_values.cue_specification)
402 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --cue\n");
403 if(0 != option_values.cuesheet_filename)
404 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --cuesheet\n");
406 if(option_values.sector_align) {
407 if(option_values.mode_decode)
408 return usage_error("ERROR: --sector-align only allowed for encoding\n");
409 if(0 != option_values.skip_specification)
410 return usage_error("ERROR: --sector-align not allowed with --skip\n");
411 if(0 != option_values.until_specification)
412 return usage_error("ERROR: --sector-align not allowed with --until\n");
413 if(0 != option_values.cue_specification)
414 return usage_error("ERROR: --sector-align not allowed with --cue\n");
415 if(option_values.format_channels >= 0 && option_values.format_channels != 2)
416 return usage_error("ERROR: --sector-align can only be done with stereo input\n");
417 if(option_values.format_bps >= 0 && option_values.format_bps != 16)
418 return usage_error("ERROR: --sector-align can only be done with 16-bit samples\n");
419 if(option_values.format_sample_rate >= 0 && option_values.format_sample_rate != 44100)
420 return usage_error("ERROR: --sector-align can only be done with a sample rate of 44100\n");
422 if(option_values.replay_gain) {
423 if(option_values.force_to_stdout)
424 return usage_error("ERROR: --replay-gain not allowed with -c/--stdout\n");
425 if(option_values.mode_decode)
426 return usage_error("ERROR: --replay-gain only allowed for encoding\n");
427 if(option_values.format_channels > 2)
428 return usage_error("ERROR: --replay-gain can only be done with mono/stereo input\n");
429 if(option_values.format_sample_rate >= 0 && !grabbag__replaygain_is_valid_sample_frequency(option_values.format_sample_rate))
430 return usage_error("ERROR: invalid sample rate used with --replay-gain\n");
432 * We want to reserve padding space for the ReplayGain
433 * tags that we will set later, to avoid rewriting the
437 (option_values.padding >= 0 && option_values.padding < GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED) ||
438 (option_values.padding < 0 && FLAC_ENCODE__DEFAULT_PADDING < GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED)
440 flac__utils_printf(stderr, 1, "NOTE: --replay-gain may leave a small PADDING block even with --no-padding\n");
441 option_values.padding = GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
444 option_values.padding += GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
447 if(option_values.num_files > 1 && option_values.cmdline_forced_outfilename) {
448 return usage_error("ERROR: -o/--output-name cannot be used with multiple files\n");
450 if(option_values.cmdline_forced_outfilename && option_values.output_prefix) {
451 return usage_error("ERROR: --output-prefix conflicts with -o/--output-name\n");
453 if(!option_values.mode_decode && 0 != option_values.cuesheet_filename && option_values.num_files > 1) {
454 return usage_error("ERROR: --cuesheet cannot be used when encoding multiple files\n");
458 flac__utils_printf(stderr, 2, "\n");
459 flac__utils_printf(stderr, 2, "flac %s, Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson\n", FLAC__VERSION_STRING);
460 flac__utils_printf(stderr, 2, "flac comes with ABSOLUTELY NO WARRANTY. This is free software, and you are\n");
461 flac__utils_printf(stderr, 2, "welcome to redistribute it under certain conditions. Type `flac' for details.\n\n");
463 if(option_values.mode_decode) {
464 FLAC__bool first = true;
466 if(option_values.num_files == 0) {
467 retval = decode_file("-");
471 if(option_values.num_files > 1)
472 option_values.cmdline_forced_outfilename = 0;
473 for(i = 0, retval = 0; i < option_values.num_files; i++) {
474 if(0 == strcmp(option_values.filenames[i], "-") && !first)
476 retval |= decode_file(option_values.filenames[i]);
482 FLAC__bool first = true;
484 if(option_values.ignore_chunk_sizes)
485 flac__utils_printf(stderr, 1, "INFO: Make sure you know what you're doing when using --ignore-chunk-sizes.\n Improper use can cause flac to encode non-audio data as audio.\n");
487 if(option_values.num_files == 0) {
488 retval = encode_file("-", first, true);
492 if(option_values.num_files > 1)
493 option_values.cmdline_forced_outfilename = 0;
494 for(i = 0, retval = 0; i < option_values.num_files; i++) {
495 if(0 == strcmp(option_values.filenames[i], "-") && !first)
497 retval |= encode_file(option_values.filenames[i], first, i == (option_values.num_files-1));
500 if(option_values.replay_gain && retval == 0) {
501 float album_gain, album_peak;
502 grabbag__replaygain_get_album(&album_gain, &album_peak);
503 for(i = 0; i < option_values.num_files; i++) {
504 const char *error, *outfilename = get_encoded_outfilename(option_values.filenames[i]);
505 if(0 == outfilename) {
506 flac__utils_printf(stderr, 1, "ERROR: filename too long: %s", option_values.filenames[i]);
509 if(0 == strcmp(option_values.filenames[i], "-")) {
511 /* double protection */
512 flac__utils_printf(stderr, 1, "internal error\n");
515 if(0 != (error = grabbag__replaygain_store_to_file_album(outfilename, album_gain, album_peak, /*preserve_modtime=*/true))) {
516 flac__utils_printf(stderr, 1, "%s: ERROR writing ReplayGain album tags (%s)\n", outfilename, error);
527 FLAC__bool init_options(void)
529 option_values.show_help = false;
530 option_values.show_explain = false;
531 option_values.mode_decode = false;
532 option_values.verify = false;
533 option_values.treat_warnings_as_errors = false;
534 option_values.force_file_overwrite = false;
535 option_values.continue_through_decode_errors = false;
536 option_values.replaygain_synthesis_spec.apply = false;
537 option_values.replaygain_synthesis_spec.use_album_gain = true;
538 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__HARD;
539 option_values.replaygain_synthesis_spec.noise_shaping = NOISE_SHAPING_LOW;
540 option_values.replaygain_synthesis_spec.preamp = 0.0;
541 option_values.lax = false;
542 option_values.test_only = false;
543 option_values.analyze = false;
544 option_values.use_ogg = false;
545 option_values.has_serial_number = false;
546 option_values.serial_number = 0;
547 option_values.force_to_stdout = false;
548 option_values.force_aiff_format = false;
549 option_values.force_raw_format = false;
550 option_values.delete_input = false;
551 option_values.replay_gain = false;
552 option_values.ignore_chunk_sizes = false;
553 option_values.sector_align = false;
554 option_values.utf8_convert = true;
555 option_values.cmdline_forced_outfilename = 0;
556 option_values.output_prefix = 0;
557 option_values.aopts.do_residual_text = false;
558 option_values.aopts.do_residual_gnuplot = false;
559 option_values.padding = -1;
560 option_values.num_compression_settings = 1;
561 option_values.compression_settings[0].type = CST_COMPRESSION_LEVEL;
562 option_values.compression_settings[0].value.t_unsigned = 5;
563 option_values.skip_specification = 0;
564 option_values.until_specification = 0;
565 option_values.cue_specification = 0;
566 option_values.format_is_big_endian = -1;
567 option_values.format_is_unsigned_samples = -1;
568 option_values.format_channels = -1;
569 option_values.format_bps = -1;
570 option_values.format_sample_rate = -1;
571 option_values.format_input_size = (off_t)(-1);
572 option_values.requested_seek_points[0] = '\0';
573 option_values.num_requested_seek_points = -1;
574 option_values.cuesheet_filename = 0;
575 option_values.cued_seekpoints = true;
576 option_values.channel_map_none = false;
578 option_values.num_files = 0;
579 option_values.filenames = 0;
581 if(0 == (option_values.vorbis_comment = FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT)))
583 option_values.num_pictures = 0;
585 option_values.debug.disable_constant_subframes = false;
586 option_values.debug.disable_fixed_subframes = false;
587 option_values.debug.disable_verbatim_subframes = false;
588 option_values.debug.do_md5 = true;
593 int parse_options(int argc, char *argv[])
596 int option_index = 1;
597 FLAC__bool had_error = false;
598 const char *short_opts = "0123456789aA:b:cdefFhHl:mMo:pP:q:r:sS:tT:vVw";
600 while ((short_option = share__getopt_long(argc, argv, short_opts, long_options_, &option_index)) != -1) {
601 switch (short_option) {
602 case 0: /* long option with no equivalent short option */
603 had_error |= (parse_option(short_option, long_options_[option_index].name, share__optarg) != 0);
609 default: /* short option */
610 had_error |= (parse_option(short_option, 0, share__optarg) != 0);
619 FLAC__ASSERT(share__optind <= argc);
621 option_values.num_files = argc - share__optind;
623 if(option_values.num_files > 0) {
625 if(0 == (option_values.filenames = (char**)malloc(sizeof(char*) * option_values.num_files)))
626 die("out of memory allocating space for file names list");
627 while(share__optind < argc)
628 option_values.filenames[i++] = local_strdup(argv[share__optind++]);
634 int parse_option(int short_option, const char *long_option, const char *option_argument)
636 const char *violation;
640 if(short_option == 0) {
641 FLAC__ASSERT(0 != long_option);
642 if(0 == strcmp(long_option, "totally-silent")) {
643 flac__utils_verbosity_ = 0;
645 else if(0 == strcmp(long_option, "delete-input-file")) {
646 option_values.delete_input = true;
648 else if(0 == strcmp(long_option, "output-prefix")) {
649 FLAC__ASSERT(0 != option_argument);
650 option_values.output_prefix = option_argument;
652 else if(0 == strcmp(long_option, "skip")) {
653 FLAC__ASSERT(0 != option_argument);
654 option_values.skip_specification = option_argument;
656 else if(0 == strcmp(long_option, "until")) {
657 FLAC__ASSERT(0 != option_argument);
658 option_values.until_specification = option_argument;
660 else if(0 == strcmp(long_option, "input-size")) {
661 FLAC__ASSERT(0 != option_argument);
666 i = local__strtoll(option_argument, &end);
669 i = strtoll(option_argument, &end, 10);
671 if(0 == strlen(option_argument) || *end)
672 return usage_error("ERROR: --%s must be a number\n", long_option);
673 option_values.format_input_size = (off_t)i;
674 if(option_values.format_input_size != i) /* check if off_t is smaller than long long */
675 return usage_error("ERROR: --%s too large; this build of flac does not support filesizes over 2GB\n", long_option);
676 if(option_values.format_input_size <= 0)
677 return usage_error("ERROR: --%s must be > 0\n", long_option);
680 else if(0 == strcmp(long_option, "cue")) {
681 FLAC__ASSERT(0 != option_argument);
682 option_values.cue_specification = option_argument;
684 else if(0 == strcmp(long_option, "apply-replaygain-which-is-not-lossless")) {
685 option_values.replaygain_synthesis_spec.apply = true;
686 if (0 != option_argument) {
688 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__NONE;
689 option_values.replaygain_synthesis_spec.noise_shaping = NOISE_SHAPING_NONE;
690 option_values.replaygain_synthesis_spec.preamp = strtod(option_argument, &p);
693 option_values.replaygain_synthesis_spec.use_album_gain = true;
695 option_values.replaygain_synthesis_spec.use_album_gain = false;
697 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__PEAK;
699 option_values.replaygain_synthesis_spec.limiter = RGSS_LIMIT__HARD;
700 else if (*p == 'n' && p[1] >= '0' && p[1] <= '3') {
701 option_values.replaygain_synthesis_spec.noise_shaping = p[1] - '0';
705 return usage_error("ERROR: bad specification string \"%s\" for --%s\n", option_argument, long_option);
709 else if(0 == strcmp(long_option, "channel-map")) {
710 if (0 == option_argument || strcmp(option_argument, "none"))
711 return usage_error("ERROR: only --channel-map=none currently supported\n");
712 option_values.channel_map_none = true;
714 else if(0 == strcmp(long_option, "cuesheet")) {
715 FLAC__ASSERT(0 != option_argument);
716 option_values.cuesheet_filename = option_argument;
718 else if(0 == strcmp(long_option, "picture")) {
719 const unsigned max_pictures = sizeof(option_values.pictures)/sizeof(option_values.pictures[0]);
720 FLAC__ASSERT(0 != option_argument);
721 if(option_values.num_pictures >= max_pictures)
722 return usage_error("ERROR: too many --picture arguments, only %u allowed\n", max_pictures);
723 if(0 == (option_values.pictures[option_values.num_pictures] = grabbag__picture_parse_specification(option_argument, &violation)))
724 return usage_error("ERROR: (--picture) %s\n", violation);
725 option_values.num_pictures++;
727 else if(0 == strcmp(long_option, "tag-from-file")) {
728 FLAC__ASSERT(0 != option_argument);
729 if(!flac__vorbiscomment_add(option_values.vorbis_comment, option_argument, /*value_from_file=*/true, /*raw=*/!option_values.utf8_convert, &violation))
730 return usage_error("ERROR: (--tag-from-file) %s\n", violation);
732 else if(0 == strcmp(long_option, "no-cued-seekpoints")) {
733 option_values.cued_seekpoints = false;
735 else if(0 == strcmp(long_option, "force-aiff-format")) {
736 option_values.force_aiff_format = true;
738 else if(0 == strcmp(long_option, "force-raw-format")) {
739 option_values.force_raw_format = true;
741 else if(0 == strcmp(long_option, "lax")) {
742 option_values.lax = true;
744 else if(0 == strcmp(long_option, "replay-gain")) {
745 option_values.replay_gain = true;
747 else if(0 == strcmp(long_option, "ignore-chunk-sizes")) {
748 option_values.ignore_chunk_sizes = true;
750 else if(0 == strcmp(long_option, "sector-align")) {
751 option_values.sector_align = true;
754 else if(0 == strcmp(long_option, "ogg")) {
755 option_values.use_ogg = true;
757 else if(0 == strcmp(long_option, "serial-number")) {
758 option_values.has_serial_number = true;
759 option_values.serial_number = atol(option_argument);
762 else if(0 == strcmp(long_option, "endian")) {
763 FLAC__ASSERT(0 != option_argument);
764 if(0 == strncmp(option_argument, "big", strlen(option_argument)))
765 option_values.format_is_big_endian = true;
766 else if(0 == strncmp(option_argument, "little", strlen(option_argument)))
767 option_values.format_is_big_endian = false;
769 return usage_error("ERROR: argument to --endian must be \"big\" or \"little\"\n");
771 else if(0 == strcmp(long_option, "channels")) {
772 FLAC__ASSERT(0 != option_argument);
773 option_values.format_channels = atoi(option_argument);
775 else if(0 == strcmp(long_option, "bps")) {
776 FLAC__ASSERT(0 != option_argument);
777 option_values.format_bps = atoi(option_argument);
779 else if(0 == strcmp(long_option, "sample-rate")) {
780 FLAC__ASSERT(0 != option_argument);
781 option_values.format_sample_rate = atoi(option_argument);
783 else if(0 == strcmp(long_option, "sign")) {
784 FLAC__ASSERT(0 != option_argument);
785 if(0 == strncmp(option_argument, "signed", strlen(option_argument)))
786 option_values.format_is_unsigned_samples = false;
787 else if(0 == strncmp(option_argument, "unsigned", strlen(option_argument)))
788 option_values.format_is_unsigned_samples = true;
790 return usage_error("ERROR: argument to --sign must be \"signed\" or \"unsigned\"\n");
792 else if(0 == strcmp(long_option, "residual-gnuplot")) {
793 option_values.aopts.do_residual_gnuplot = true;
795 else if(0 == strcmp(long_option, "residual-text")) {
796 option_values.aopts.do_residual_text = true;
801 else if(0 == strcmp(long_option, "no-decode-through-errors")) {
802 option_values.continue_through_decode_errors = false;
804 else if(0 == strcmp(long_option, "no-silent")) {
805 flac__utils_verbosity_ = 2;
807 else if(0 == strcmp(long_option, "no-force")) {
808 option_values.force_file_overwrite = false;
810 else if(0 == strcmp(long_option, "no-seektable")) {
811 option_values.num_requested_seek_points = 0;
812 option_values.requested_seek_points[0] = '\0';
814 else if(0 == strcmp(long_option, "no-delete-input-file")) {
815 option_values.delete_input = false;
817 else if(0 == strcmp(long_option, "no-replay-gain")) {
818 option_values.replay_gain = false;
820 else if(0 == strcmp(long_option, "no-ignore-chunk-sizes")) {
821 option_values.ignore_chunk_sizes = false;
823 else if(0 == strcmp(long_option, "no-sector-align")) {
824 option_values.sector_align = false;
826 else if(0 == strcmp(long_option, "no-utf8-convert")) {
827 option_values.utf8_convert = false;
829 else if(0 == strcmp(long_option, "no-lax")) {
830 option_values.lax = false;
833 else if(0 == strcmp(long_option, "no-ogg")) {
834 option_values.use_ogg = false;
837 else if(0 == strcmp(long_option, "no-exhaustive-model-search")) {
838 add_compression_setting_bool(CST_DO_EXHAUSTIVE_MODEL_SEARCH, false);
840 else if(0 == strcmp(long_option, "no-mid-side")) {
841 add_compression_setting_bool(CST_DO_MID_SIDE, false);
842 add_compression_setting_bool(CST_LOOSE_MID_SIDE, false);
844 else if(0 == strcmp(long_option, "no-adaptive-mid-side")) {
845 add_compression_setting_bool(CST_DO_MID_SIDE, false);
846 add_compression_setting_bool(CST_LOOSE_MID_SIDE, false);
848 else if(0 == strcmp(long_option, "no-qlp-coeff-prec-search")) {
849 add_compression_setting_bool(CST_DO_QLP_COEFF_PREC_SEARCH, false);
851 else if(0 == strcmp(long_option, "no-padding")) {
852 option_values.padding = 0;
854 else if(0 == strcmp(long_option, "no-verify")) {
855 option_values.verify = false;
857 else if(0 == strcmp(long_option, "no-warnings-as-errors")) {
858 option_values.treat_warnings_as_errors = false;
860 else if(0 == strcmp(long_option, "no-residual-gnuplot")) {
861 option_values.aopts.do_residual_gnuplot = false;
863 else if(0 == strcmp(long_option, "no-residual-text")) {
864 option_values.aopts.do_residual_text = false;
866 else if(0 == strcmp(long_option, "disable-constant-subframes")) {
867 option_values.debug.disable_constant_subframes = true;
869 else if(0 == strcmp(long_option, "disable-fixed-subframes")) {
870 option_values.debug.disable_fixed_subframes = true;
872 else if(0 == strcmp(long_option, "disable-verbatim-subframes")) {
873 option_values.debug.disable_verbatim_subframes = true;
875 else if(0 == strcmp(long_option, "no-md5-sum")) {
876 option_values.debug.do_md5 = false;
880 switch(short_option) {
882 option_values.show_help = true;
885 option_values.show_explain = true;
888 option_values.show_version = true;
891 option_values.mode_decode = true;
894 option_values.mode_decode = true;
895 option_values.analyze = true;
898 option_values.mode_decode = true;
899 option_values.test_only = true;
902 option_values.force_to_stdout = true;
905 flac__utils_verbosity_ = 1;
908 option_values.force_file_overwrite = true;
911 FLAC__ASSERT(0 != option_argument);
912 option_values.cmdline_forced_outfilename = option_argument;
915 option_values.continue_through_decode_errors = true;
918 FLAC__ASSERT(0 != option_argument);
919 if(!flac__vorbiscomment_add(option_values.vorbis_comment, option_argument, /*value_from_file=*/false, /*raw=*/!option_values.utf8_convert, &violation))
920 return usage_error("ERROR: (-T/--tag) %s\n", violation);
931 add_compression_setting_unsigned(CST_COMPRESSION_LEVEL, short_option-'0');
934 return usage_error("ERROR: compression level '9' is reserved\n");
936 option_values.verify = true;
939 option_values.treat_warnings_as_errors = true;
942 FLAC__ASSERT(0 != option_argument);
943 if(0 == strcmp(option_argument, "-")) {
944 option_values.num_requested_seek_points = 0;
945 option_values.requested_seek_points[0] = '\0';
948 if(option_values.num_requested_seek_points < 0)
949 option_values.num_requested_seek_points = 0;
950 option_values.num_requested_seek_points++;
951 if(strlen(option_values.requested_seek_points)+strlen(option_argument)+2 >= sizeof(option_values.requested_seek_points)) {
952 return usage_error("ERROR: too many seekpoints requested\n");
955 strcat(option_values.requested_seek_points, option_argument);
956 strcat(option_values.requested_seek_points, ";");
961 FLAC__ASSERT(0 != option_argument);
962 option_values.padding = atoi(option_argument);
963 if(option_values.padding < 0)
964 return usage_error("ERROR: argument to -%c must be >= 0; for no padding use -%c-\n", short_option, short_option);
967 FLAC__ASSERT(0 != option_argument);
968 i = atoi(option_argument);
969 if((i < (int)FLAC__MIN_BLOCK_SIZE || i > (int)FLAC__MAX_BLOCK_SIZE))
970 return usage_error("ERROR: invalid blocksize (-%c) '%d', must be >= %u and <= %u\n", short_option, i, FLAC__MIN_BLOCK_SIZE, FLAC__MAX_BLOCK_SIZE);
971 add_compression_setting_unsigned(CST_BLOCKSIZE, (unsigned)i);
974 add_compression_setting_bool(CST_DO_EXHAUSTIVE_MODEL_SEARCH, true);
977 add_compression_setting_bool(CST_DO_ESCAPE_CODING, true);
980 FLAC__ASSERT(0 != option_argument);
981 i = atoi(option_argument);
982 if((i < 0 || i > (int)FLAC__MAX_LPC_ORDER))
983 return usage_error("ERROR: invalid LPC order (-%c) '%d', must be >= %u and <= %u\n", short_option, i, 0, FLAC__MAX_LPC_ORDER);
984 add_compression_setting_unsigned(CST_MAX_LPC_ORDER, (unsigned)i);
987 FLAC__ASSERT(0 != option_argument);
988 add_compression_setting_string(CST_APODIZATION, option_argument);
991 add_compression_setting_bool(CST_DO_MID_SIDE, true);
992 add_compression_setting_bool(CST_LOOSE_MID_SIDE, false);
995 add_compression_setting_bool(CST_DO_MID_SIDE, true);
996 add_compression_setting_bool(CST_LOOSE_MID_SIDE, true);
999 add_compression_setting_bool(CST_DO_QLP_COEFF_PREC_SEARCH, true);
1002 FLAC__ASSERT(0 != option_argument);
1003 i = atoi(option_argument);
1004 if(i < 0 || (i > 0 && (i < (int)FLAC__MIN_QLP_COEFF_PRECISION || i > (int)FLAC__MAX_QLP_COEFF_PRECISION)))
1005 return usage_error("ERROR: invalid value '%d' for qlp coeff precision (-%c), must be 0 or between %u and %u, inclusive\n", i, short_option, FLAC__MIN_QLP_COEFF_PRECISION, FLAC__MAX_QLP_COEFF_PRECISION);
1006 add_compression_setting_unsigned(CST_QLP_COEFF_PRECISION, (unsigned)i);
1009 FLAC__ASSERT(0 != option_argument);
1010 p = strchr(option_argument, ',');
1012 add_compression_setting_unsigned(CST_MIN_RESIDUAL_PARTITION_ORDER, 0);
1013 i = atoi(option_argument);
1015 return usage_error("ERROR: invalid value '%d' for residual partition order (-%c), must be between 0 and %u, inclusive\n", i, short_option, FLAC__MAX_RICE_PARTITION_ORDER);
1016 add_compression_setting_unsigned(CST_MAX_RESIDUAL_PARTITION_ORDER, (unsigned)i);
1019 i = atoi(option_argument);
1021 return usage_error("ERROR: invalid value '%d' for min residual partition order (-%c), must be between 0 and %u, inclusive\n", i, short_option, FLAC__MAX_RICE_PARTITION_ORDER);
1022 add_compression_setting_unsigned(CST_MIN_RESIDUAL_PARTITION_ORDER, (unsigned)i);
1025 return usage_error("ERROR: invalid value '%d' for max residual partition order (-%c), must be between 0 and %u, inclusive\n", i, short_option, FLAC__MAX_RICE_PARTITION_ORDER);
1026 add_compression_setting_unsigned(CST_MAX_RESIDUAL_PARTITION_ORDER, (unsigned)i);
1030 i = atoi(option_argument);
1032 return usage_error("ERROR: invalid value '%d' for Rice parameter search distance (-%c), must be >= 0\n", i, short_option);
1033 add_compression_setting_unsigned(CST_RICE_PARAMETER_SEARCH_DIST, (unsigned)i);
1043 void free_options(void)
1046 if(0 != option_values.filenames) {
1047 for(i = 0; i < option_values.num_files; i++) {
1048 if(0 != option_values.filenames[i])
1049 free(option_values.filenames[i]);
1051 free(option_values.filenames);
1053 if(0 != option_values.vorbis_comment)
1054 FLAC__metadata_object_delete(option_values.vorbis_comment);
1055 for(i = 0; i < option_values.num_pictures; i++)
1056 FLAC__metadata_object_delete(option_values.pictures[i]);
1059 void add_compression_setting_bool(compression_setting_type_t type, FLAC__bool value)
1061 if(option_values.num_compression_settings >= sizeof(option_values.compression_settings)/sizeof(option_values.compression_settings[0]))
1062 die("too many compression settings");
1063 option_values.compression_settings[option_values.num_compression_settings].type = type;
1064 option_values.compression_settings[option_values.num_compression_settings].value.t_bool = value;
1065 option_values.num_compression_settings++;
1068 void add_compression_setting_string(compression_setting_type_t type, const char *value)
1070 if(option_values.num_compression_settings >= sizeof(option_values.compression_settings)/sizeof(option_values.compression_settings[0]))
1071 die("too many compression settings");
1072 option_values.compression_settings[option_values.num_compression_settings].type = type;
1073 option_values.compression_settings[option_values.num_compression_settings].value.t_string = value;
1074 option_values.num_compression_settings++;
1077 void add_compression_setting_unsigned(compression_setting_type_t type, unsigned value)
1079 if(option_values.num_compression_settings >= sizeof(option_values.compression_settings)/sizeof(option_values.compression_settings[0]))
1080 die("too many compression settings");
1081 option_values.compression_settings[option_values.num_compression_settings].type = type;
1082 option_values.compression_settings[option_values.num_compression_settings].value.t_unsigned = value;
1083 option_values.num_compression_settings++;
1086 int usage_error(const char *message, ...)
1088 if(flac__utils_verbosity_ >= 1) {
1091 FLAC__ASSERT(0 != message);
1093 va_start(args, message);
1095 (void) vfprintf(stderr, message, args);
1099 printf("Type \"flac\" for a usage summary or \"flac --help\" for all options\n");
1105 void show_version(void)
1107 printf("flac %s\n", FLAC__VERSION_STRING);
1110 static void usage_header(void)
1112 printf("===============================================================================\n");
1113 printf("flac - Command-line FLAC encoder/decoder version %s\n", FLAC__VERSION_STRING);
1114 printf("Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson\n");
1116 printf("This program is free software; you can redistribute it and/or\n");
1117 printf("modify it under the terms of the GNU General Public License\n");
1118 printf("as published by the Free Software Foundation; either version 2\n");
1119 printf("of the License, or (at your option) any later version.\n");
1121 printf("This program is distributed in the hope that it will be useful,\n");
1122 printf("but WITHOUT ANY WARRANTY; without even the implied warranty of\n");
1123 printf("MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n");
1124 printf("GNU General Public License for more details.\n");
1126 printf("You should have received a copy of the GNU General Public License\n");
1127 printf("along with this program; if not, write to the Free Software\n");
1128 printf("Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\n");
1129 printf("===============================================================================\n");
1132 static void usage_summary(void)
1136 printf(" Encoding: flac [<general-options>] [<encoding/format-options>] [INPUTFILE [...]]\n");
1137 printf(" Decoding: flac -d [<general-options>] [<format-options>] [FLACFILE [...]]\n");
1138 printf(" Testing: flac -t [<general-options>] [FLACFILE [...]]\n");
1139 printf("Analyzing: flac -a [<general-options>] [<analysis-options>] [FLACFILE [...]]\n");
1143 void short_usage(void)
1147 printf("This is the short help; for all options use 'flac --help'; for even more\n");
1148 printf("instructions use 'flac --explain'\n");
1150 printf("To encode:\n");
1151 printf(" flac [-#] [INPUTFILE [...]]\n");
1153 printf(" -# is -0 (fastest compression) to -8 (highest compression); -5 is the default\n");
1155 printf("To decode:\n");
1156 printf(" flac -d [INPUTFILE [...]]\n");
1158 printf("To test:\n");
1159 printf(" flac -t [INPUTFILE [...]]\n");
1162 void show_help(void)
1166 printf("general options:\n");
1167 printf(" -v, --version Show the flac version number\n");
1168 printf(" -h, --help Show this screen\n");
1169 printf(" -H, --explain Show detailed explanation of usage and options\n");
1170 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1171 printf(" -t, --test Same as -d except no decoded file is written\n");
1172 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1173 printf(" -c, --stdout Write output to stdout\n");
1174 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1175 printf(" --totally-silent Do not print anything, including errors\n");
1176 printf(" --no-utf8-convert Do not convert tags from local charset to UTF-8\n");
1177 printf(" -w, --warnings-as-errors Treat all warnings as errors\n");
1178 printf(" -f, --force Force overwriting of output files\n");
1179 printf(" -o, --output-name=FILENAME Force the output file name\n");
1180 printf(" --output-prefix=STRING Prepend STRING to output names\n");
1181 printf(" --delete-input-file Deletes after a successful encode/decode\n");
1182 printf(" --skip={#|mm:ss.ss} Skip the given initial samples for each input\n");
1183 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample for each input file\n");
1185 printf(" --ogg Use Ogg as transport layer\n");
1186 printf(" --serial-number Serial number to use for the FLAC stream\n");
1188 printf("analysis options:\n");
1189 printf(" --residual-text Include residual signal in text output\n");
1190 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1191 printf("decoding options:\n");
1192 printf(" -F, --decode-through-errors Continue decoding through stream errors\n");
1193 printf(" --cue=[#.#][-[#.#]] Set the beginning and ending cuepoints to decode\n");
1194 printf("encoding options:\n");
1195 printf(" -V, --verify Verify a correct encoding\n");
1196 printf(" --lax Allow encoder to generate non-Subset files\n");
1197 #if 0 /*@@@ currently undocumented */
1198 printf(" --ignore-chunk-sizes Ignore data chunk sizes in WAVE/AIFF files\n");
1200 printf(" --sector-align Align multiple files on sector boundaries\n");
1201 printf(" --replay-gain Calculate ReplayGain & store in FLAC tags\n");
1202 printf(" --cuesheet=FILENAME Import cuesheet and store in CUESHEET block\n");
1203 printf(" --picture=SPECIFICATION Import picture and store in PICTURE block\n");
1204 printf(" -T, --tag=FIELD=VALUE Add a FLAC tag; may appear multiple times\n");
1205 printf(" --tag-from-file=FIELD=FILENAME Like --tag but gets value from file\n");
1206 printf(" -S, --seekpoint={#|X|#x|#s} Add seek point(s)\n");
1207 printf(" -P, --padding=# Write a PADDING block of length #\n");
1208 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 3\n");
1209 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 3\n");
1210 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1211 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4096 -r 4\n");
1212 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4096 -M -r 4\n");
1213 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4096 -m -r 5\n");
1214 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4096 -m -r 6\n");
1215 printf(" -7, --compression-level-7 Synonymous with -l 8 -b 4096 -m -e -r 6\n");
1216 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4096 -m -e -r 6\n");
1217 printf(" -b, --blocksize=# Specify blocksize in samples\n");
1218 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1219 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1220 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1221 printf(" -A, --apodization=\"function\" Window audio data with given the function\n");
1222 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n");
1223 printf(" -p, --qlp-coeff-precision-search Exhaustively search LP coeff quantization\n");
1224 printf(" -q, --qlp-coeff-precision=# Specify precision in bits\n");
1225 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1226 printf("format options:\n");
1227 printf(" --endian={big|little} Set byte order for samples\n");
1228 printf(" --channels=# Number of channels\n");
1229 printf(" --bps=# Number of bits per sample\n");
1230 printf(" --sample-rate=# Sample rate in Hz\n");
1231 printf(" --sign={signed|unsigned} Sign of samples\n");
1232 printf(" --input-size=# Size of the raw input in bytes\n");
1233 printf(" --force-aiff-format Force decoding to AIFF format\n");
1234 printf(" --force-raw-format Treat input or output as raw samples\n");
1235 printf("negative options:\n");
1236 printf(" --no-adaptive-mid-side\n");
1237 printf(" --no-decode-through-errors\n");
1238 printf(" --no-delete-input-file\n");
1239 printf(" --no-exhaustive-model-search\n");
1240 printf(" --no-lax\n");
1241 printf(" --no-mid-side\n");
1243 printf(" --no-ogg\n");
1245 printf(" --no-padding\n");
1246 printf(" --no-qlp-coeff-prec-search\n");
1247 printf(" --no-replay-gain\n");
1248 printf(" --no-residual-gnuplot\n");
1249 printf(" --no-residual-text\n");
1250 #if 0 /*@@@ currently undocumented */
1251 printf(" --no-ignore-chunk-sizes\n");
1253 printf(" --no-sector-align\n");
1254 printf(" --no-seektable\n");
1255 printf(" --no-silent\n");
1256 printf(" --no-force\n");
1257 printf(" --no-verify\n");
1258 printf(" --no-warnings-as-errors\n");
1261 void show_explain(void)
1265 printf("For encoding:\n");
1266 printf(" The input file(s) may be a PCM RIFF WAVE file, AIFF (or uncompressed AIFF-C)\n");
1267 printf(" file, or raw samples.\n");
1268 printf(" The output file(s) will be in native FLAC or Ogg FLAC format\n");
1269 printf("For decoding, the reverse is true.\n");
1271 printf("A single INPUTFILE may be - for stdin. No INPUTFILE implies stdin. Use of\n");
1272 printf("stdin implies -c (write to stdout). Normally you should use:\n");
1273 printf(" flac [options] -o outfilename or flac -d [options] -o outfilename\n");
1274 printf("instead of:\n");
1275 printf(" flac [options] > outfilename or flac -d [options] > outfilename\n");
1276 printf("since the former allows flac to seek backwards to write the STREAMINFO or\n");
1277 printf("WAVE/AIFF header contents when necessary.\n");
1279 printf("flac checks for the presence of a AIFF/WAVE header to decide whether or not to\n");
1280 printf("treat an input file as AIFF/WAVE format or raw samples. If any input file is\n");
1281 printf("raw you must specify the format options {-fb|fl} -fc -fp and -fs, which will\n");
1282 printf("apply to all raw files. You can force AIFF/WAVE files to be treated as raw\n");
1283 printf("files using -fr.\n");
1285 printf("general options:\n");
1286 printf(" -v, --version Show the flac version number\n");
1287 printf(" -h, --help Show basic usage a list of all options\n");
1288 printf(" -H, --explain Show this screen\n");
1289 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1290 printf(" -t, --test Same as -d except no decoded file is written\n");
1291 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1292 printf(" -c, --stdout Write output to stdout\n");
1293 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1294 printf(" --totally-silent Do not print anything of any kind, including\n");
1295 printf(" warnings or errors. The exit code will be the\n");
1296 printf(" only way to determine successful completion.\n");
1297 printf(" --no-utf8-convert Do not convert tags from local charset to UTF-8.\n");
1298 printf(" This is useful for scripts, and setting tags in\n");
1299 printf(" situations where the locale is wrong. This\n");
1300 printf(" option must appear before any tag options!\n");
1301 printf(" -w, --warnings-as-errors Treat all warnings as errors\n");
1302 printf(" -f, --force Force overwriting of output files\n");
1303 printf(" -o, --output-name=FILENAME Force the output file name; usually flac just\n");
1304 printf(" changes the extension. May only be used when\n");
1305 printf(" encoding a single file. May not be used in\n");
1306 printf(" conjunction with --output-prefix.\n");
1307 printf(" --output-prefix=STRING Prefix each output file name with the given\n");
1308 printf(" STRING. This can be useful for encoding or\n");
1309 printf(" decoding files to a different directory. Make\n");
1310 printf(" sure if your STRING is a path name that it ends\n");
1311 printf(" with a '/' slash.\n");
1312 printf(" --delete-input-file Automatically delete the input file after a\n");
1313 printf(" successful encode or decode. If there was an\n");
1314 printf(" error (including a verify error) the input file\n");
1315 printf(" is left intact.\n");
1316 printf(" --skip={#|mm:ss.ss} Skip the first # samples of each input file; can\n");
1317 printf(" be used both for encoding and decoding. The\n");
1318 printf(" alternative form mm:ss.ss can be used to specify\n");
1319 printf(" minutes, seconds, and fractions of a second.\n");
1320 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample number for each input\n");
1321 printf(" file. The given sample number is not included\n");
1322 printf(" in the decoded output. The alternative form\n");
1323 printf(" mm:ss.ss can be used to specify minutes,\n");
1324 printf(" seconds, and fractions of a second. If a `+'\n");
1325 printf(" sign is at the beginning, the --until point is\n");
1326 printf(" relative to the --skip point. If a `-' sign is\n");
1327 printf(" at the beginning, the --until point is relative\n");
1328 printf(" to end of the audio.\n");
1330 printf(" --ogg When encoding, generate Ogg FLAC output instead\n");
1331 printf(" of native FLAC. Ogg FLAC streams are FLAC\n");
1332 printf(" streams wrapped in an Ogg transport layer. The\n");
1333 printf(" resulting file should have an '.oga' extension\n");
1334 printf(" and will still be decodable by flac. When\n");
1335 printf(" decoding, force the input to be treated as\n");
1336 printf(" Ogg FLAC. This is useful when piping input\n");
1337 printf(" from stdin or when the filename does not end in\n");
1338 printf(" '.oga' or '.ogg'.\n");
1339 printf(" --serial-number Serial number to use for the FLAC stream. When\n");
1340 printf(" encoding and no serial number is given, flac\n");
1341 printf(" uses a random one. If encoding to multiple files\n");
1342 printf(" the serial number is incremented for each file.\n");
1343 printf(" When decoding and no number is given, flac uses\n");
1344 printf(" the serial number of the first page.\n");
1346 printf("analysis options:\n");
1347 printf(" --residual-text Include residual signal in text output. This\n");
1348 printf(" will make the file very big, much larger than\n");
1349 printf(" even the decoded file.\n");
1350 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1351 printf(" of each subframe\n");
1352 printf("decoding options:\n");
1353 printf(" -F, --decode-through-errors By default flac stops decoding with an error\n");
1354 printf(" and removes the partially decoded file if it\n");
1355 printf(" encounters a bitstream error. With -F, errors\n");
1356 printf(" are still printed but flac will continue\n");
1357 printf(" decoding to completion. Note that errors may\n");
1358 printf(" cause the decoded audio to be missing some\n");
1359 printf(" samples or have silent sections.\n");
1360 printf(" --cue=[#.#][-[#.#]] Set the beginning and ending cuepoints to\n");
1361 printf(" decode. The optional first #.# is the track and\n");
1362 printf(" index point at which decoding will start; the\n");
1363 printf(" default is the beginning of the stream. The\n");
1364 printf(" optional second #.# is the track and index point\n");
1365 printf(" at which decoding will end; the default is the\n");
1366 printf(" end of the stream. If the cuepoint does not\n");
1367 printf(" exist, the closest one before it (for the start\n");
1368 printf(" point) or after it (for the end point) will be\n");
1369 printf(" used. The cuepoints are merely translated into\n");
1370 printf(" sample numbers then used as --skip and --until.\n");
1371 printf(" A CD track can always be cued by, for example,\n");
1372 printf(" --cue=9.1-10.1 for track 9, even if the CD has\n");
1373 printf(" no 10th track.\n");
1374 printf("encoding options:\n");
1375 printf(" -V, --verify Verify a correct encoding by decoding the\n");
1376 printf(" output in parallel and comparing to the\n");
1377 printf(" original\n");
1378 printf(" --lax Allow encoder to generate non-Subset files\n");
1379 #if 0 /*@@@ currently undocumented */
1380 printf(" --ignore-chunk-sizes Ignore data chunk sizes in WAVE/AIFF files;\n");
1381 printf(" useful when piping data from programs which\n");
1382 printf(" generate bogus data chunk sizes.\n");
1384 printf(" --sector-align Align encoding of multiple CD format WAVE files\n");
1385 printf(" on sector boundaries.\n");
1386 printf(" --replay-gain Calculate ReplayGain values and store them as\n");
1387 printf(" FLAC tags. Title gains/peaks will be computed\n");
1388 printf(" for each file, and an album gain/peak will be\n");
1389 printf(" computed for all files. All input files must\n");
1390 printf(" have the same resolution, sample rate, and\n");
1391 printf(" number of channels. The sample rate must be\n");
1392 printf(" one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1,\n");
1393 printf(" or 48 kHz. NOTE: this option may also leave a\n");
1394 printf(" few extra bytes in the PADDING block.\n");
1395 printf(" --cuesheet=FILENAME Import the given cuesheet file and store it in\n");
1396 printf(" a CUESHEET metadata block. This option may only\n");
1397 printf(" be used when encoding a single file. A\n");
1398 printf(" seekpoint will be added for each index point in\n");
1399 printf(" the cuesheet to the SEEKTABLE unless\n");
1400 printf(" --no-cued-seekpoints is specified.\n");
1401 printf(" --picture=SPECIFICATION Import a picture and store it in a PICTURE block.\n");
1402 printf(" More than one --picture command can be specified.\n");
1403 printf(" The SPECIFICATION can either be a simple filename\n");
1404 printf(" for the picture file, or a complete specification\n");
1405 printf(" whose parts are separated by | characters. Some\n");
1406 printf(" parts may be left empty to invoke default values.\n");
1407 printf(" Using a filename is shorthand for \"||||FILE\".\n");
1408 printf(" The SPECIFICATION format is:\n");
1409 printf(" [TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE\n");
1410 printf(" TYPE is optional; it is a number from one of:\n");
1411 printf(" 0: Other\n");
1412 printf(" 1: 32x32 pixels 'file icon' (PNG only)\n");
1413 printf(" 2: Other file icon\n");
1414 printf(" 3: Cover (front)\n");
1415 printf(" 4: Cover (back)\n");
1416 printf(" 5: Leaflet page\n");
1417 printf(" 6: Media (e.g. label side of CD)\n");
1418 printf(" 7: Lead artist/lead performer/soloist\n");
1419 printf(" 8: Artist/performer\n");
1420 printf(" 9: Conductor\n");
1421 printf(" 10: Band/Orchestra\n");
1422 printf(" 11: Composer\n");
1423 printf(" 12: Lyricist/text writer\n");
1424 printf(" 13: Recording Location\n");
1425 printf(" 14: During recording\n");
1426 printf(" 15: During performance\n");
1427 printf(" 16: Movie/video screen capture\n");
1428 printf(" 17: A bright coloured fish\n");
1429 printf(" 18: Illustration\n");
1430 printf(" 19: Band/artist logotype\n");
1431 printf(" 20: Publisher/Studio logotype\n");
1432 printf(" The default is 3 (front cover). There may only be one picture each\n");
1433 printf(" of type 1 and 2 in a file.\n");
1434 printf(" MIME-TYPE is optional; if left blank, it will be detected from the\n");
1435 printf(" file. For best compatibility with players, use pictures with MIME\n");
1436 printf(" type image/jpeg or image/png. The MIME type can also be --> to\n");
1437 printf(" mean that FILE is actually a URL to an image, though this use is\n");
1438 printf(" discouraged.\n");
1439 printf(" DESCRIPTION is optional; the default is an empty string\n");
1440 printf(" The next part specfies the resolution and color information. If\n");
1441 printf(" the MIME-TYPE is image/jpeg, image/png, or image/gif, you can\n");
1442 printf(" usually leave this empty and they can be detected from the file.\n");
1443 printf(" Otherwise, you must specify the width in pixels, height in pixels,\n");
1444 printf(" and color depth in bits-per-pixel. If the image has indexed colors\n");
1445 printf(" you should also specify the number of colors used.\n");
1446 printf(" FILE is the path to the picture file to be imported, or the URL if\n");
1447 printf(" MIME type is -->\n");
1448 printf(" -T, --tag=FIELD=VALUE Add a FLAC tag. Make sure to quote the\n");
1449 printf(" comment if necessary. This option may appear\n");
1450 printf(" more than once to add several comments. NOTE:\n");
1451 printf(" all tags will be added to all encoded files.\n");
1452 printf(" --tag-from-file=FIELD=FILENAME Like --tag, except FILENAME is a file\n");
1453 printf(" whose contents will be read verbatim to set the\n");
1454 printf(" tag value. The contents will be converted to\n");
1455 printf(" UTF-8 from the local charset. This can be used\n");
1456 printf(" to store a cuesheet in a tag (e.g.\n");
1457 printf(" --tag-from-file=\"CUESHEET=image.cue\"). Do not\n");
1458 printf(" try to store binary data in tag fields! Use\n");
1459 printf(" APPLICATION blocks for that.\n");
1460 printf(" -S, --seekpoint={#|X|#x|#s} Include a point or points in a SEEKTABLE\n");
1461 printf(" # : a specific sample number for a seek point\n");
1462 printf(" X : a placeholder point (always goes at the end of the SEEKTABLE)\n");
1463 printf(" #x : # evenly spaced seekpoints, the first being at sample 0\n");
1464 printf(" #s : a seekpoint every # seconds; # does not have to be a whole number\n");
1465 printf(" You may use many -S options; the resulting SEEKTABLE will be the unique-\n");
1466 printf(" ified union of all such values.\n");
1467 printf(" With no -S options, flac defaults to '-S 10s'. Use -S- for no SEEKTABLE.\n");
1468 printf(" Note: -S #x and -S #s will not work if the encoder can't determine the\n");
1469 printf(" input size before starting.\n");
1470 printf(" Note: if you use -S # and # is >= samples in the input, there will be\n");
1471 printf(" either no seek point entered (if the input size is determinable\n");
1472 printf(" before encoding starts) or a placeholder point (if input size is not\n");
1473 printf(" determinable)\n");
1474 printf(" -P, --padding=# Tell the encoder to write a PADDING metadata\n");
1475 printf(" block of the given length (in bytes) after the\n");
1476 printf(" STREAMINFO block. This is useful if you plan\n");
1477 printf(" to tag the file later with an APPLICATION\n");
1478 printf(" block; instead of having to rewrite the entire\n");
1479 printf(" file later just to insert your block, you can\n");
1480 printf(" write directly over the PADDING block. Note\n");
1481 printf(" that the total length of the PADDING block will\n");
1482 printf(" be 4 bytes longer than the length given because\n");
1483 printf(" of the 4 metadata block header bytes. You can\n");
1484 printf(" force no PADDING block at all to be written with\n");
1485 printf(" --no-padding. The encoder writes a PADDING\n");
1486 printf(" block of 8192 bytes by default, or 65536 bytes\n");
1487 printf(" if the input audio is more than 20 minutes long.\n");
1488 printf(" -b, --blocksize=# Specify the blocksize in samples; the default is\n");
1489 printf(" 1152 for -l 0, else 4096; must be one of 192,\n");
1490 printf(" 576, 1152, 2304, 4608, 256, 512, 1024, 2048,\n");
1491 printf(" 4096 (and 8192 or 16384 if the sample rate is\n");
1492 printf(" >48kHz) for Subset streams.\n");
1493 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 3\n");
1494 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 3\n");
1495 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1496 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4096 -r 4\n");
1497 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4096 -M -r 4\n");
1498 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4096 -m -r 5\n");
1499 printf(" -5 is the default setting\n");
1500 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4096 -m -r 6\n");
1501 printf(" -7, --compression-level-7 Synonymous with -l 8 -b 4096 -m -e -r 6\n");
1502 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4096 -m -e -r 6\n");
1503 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1504 printf(" (stereo only)\n");
1505 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1506 printf(" (stereo only)\n");
1507 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1508 printf(" -A, --apodization=\"function\" Window audio data with given the function.\n");
1509 printf(" The functions are: bartlett, bartlett_hann,\n");
1510 printf(" blackman, blackman_harris_4term_92db,\n");
1511 printf(" connes, flattop, gauss(STDDEV), hamming,\n");
1512 printf(" hann, kaiser_bessel, nuttall, rectangle,\n");
1513 printf(" triangle, tukey(P), welch. More than one\n");
1514 printf(" may be specified but encoding time is a\n");
1515 printf(" multiple of the number of functions since\n");
1516 printf(" they are each tried in turn. The encoder\n");
1517 printf(" chooses suitable defaults in the absence\n");
1518 printf(" of any -A options.\n");
1519 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors.\n");
1520 printf(" Must be <= 12 for Subset streams if sample\n");
1521 printf(" rate is <=48kHz.\n");
1522 printf(" -p, --qlp-coeff-precision-search Do exhaustive search of LP coefficient\n");
1523 printf(" quantization (expensive!); overrides -q;\n");
1524 printf(" does nothing if using -l 0\n");
1525 printf(" -q, --qlp-coeff-precision=# Specify precision in bits of quantized\n");
1526 printf(" linear-predictor coefficients; 0 => let\n");
1527 printf(" encoder decide (the minimun is %u, the\n", FLAC__MIN_QLP_COEFF_PRECISION);
1528 printf(" default is -q 0)\n");
1529 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1530 printf(" (# is 0..16; min defaults to 0; the\n");
1531 printf(" default is -r 0; above 4 doesn't usually\n");
1532 printf(" help much)\n");
1533 printf("format options:\n");
1534 printf(" --endian={big|little} Set byte order for samples\n");
1535 printf(" --channels=# Number of channels\n");
1536 printf(" --bps=# Number of bits per sample\n");
1537 printf(" --sample-rate=# Sample rate in Hz\n");
1538 printf(" --sign={signed|unsigned} Sign of samples (the default is signed)\n");
1539 printf(" --input-size=# Size of the raw input in bytes. If you are\n");
1540 printf(" encoding raw samples from stdin, you must set\n");
1541 printf(" this option in order to be able to use --skip,\n");
1542 printf(" --until, --cue-sheet, or other options that need\n");
1543 printf(" to know the size of the input beforehand. If\n");
1544 printf(" the size given is greater than what is found in\n");
1545 printf(" the input stream, the encoder will complain\n");
1546 printf(" about an unexpected end-of-file. If the size\n");
1547 printf(" given is less, samples will be truncated.\n");
1548 printf(" --force-aiff-format Force the decoder to output AIFF format. This\n");
1549 printf(" option is not needed if the output filename (as\n");
1550 printf(" set by -o) ends with .aif or .aiff; this option\n");
1551 printf(" has no effect when encoding since input AIFF is\n");
1552 printf(" auto-detected.\n");
1553 printf(" --force-raw-format Force input (when encoding) or output (when\n");
1554 printf(" decoding) to be treated as raw samples\n");
1555 printf("negative options:\n");
1556 printf(" --no-adaptive-mid-side\n");
1557 printf(" --no-decode-through-errors\n");
1558 printf(" --no-delete-input-file\n");
1559 printf(" --no-exhaustive-model-search\n");
1560 printf(" --no-lax\n");
1561 printf(" --no-mid-side\n");
1563 printf(" --no-ogg\n");
1565 printf(" --no-padding\n");
1566 printf(" --no-qlp-coeff-prec-search\n");
1567 printf(" --no-residual-gnuplot\n");
1568 printf(" --no-residual-text\n");
1569 #if 0 /*@@@ currently undocumented */
1570 printf(" --no-ignore-chunk-sizes\n");
1572 printf(" --no-sector-align\n");
1573 printf(" --no-seektable\n");
1574 printf(" --no-silent\n");
1575 printf(" --no-force\n");
1576 printf(" --no-verify\n");
1577 printf(" --no-warnings-as-errors\n");
1580 void format_mistake(const char *infilename, FileFormat wrong, FileFormat right)
1582 /* WATCHOUT: indexed by FileFormat */
1583 static const char * const ff[] = { "raw", "WAVE", "AIFF", "FLAC", "Ogg FLAC" };
1584 flac__utils_printf(stderr, 1, "WARNING: %s is not a %s file; treating as a %s file\n", infilename, ff[wrong], ff[right]);
1587 int encode_file(const char *infilename, FLAC__bool is_first_file, FLAC__bool is_last_file)
1589 FILE *encode_infile;
1590 FLAC__byte lookahead[12];
1591 unsigned lookahead_length = 0;
1592 FileFormat fmt = RAW;
1593 FLAC__bool is_aifc = false;
1596 encode_options_t common_options;
1597 const char *outfilename = get_encoded_outfilename(infilename); /* the final name of the encoded file */
1598 /* internal_outfilename is the file we will actually write to; it will be a temporary name if infilename==outfilename */
1599 char *internal_outfilename = 0; /* NULL implies 'use outfilename' */
1601 if(0 == outfilename) {
1602 flac__utils_printf(stderr, 1, "ERROR: filename too long: %s", infilename);
1606 if(0 == strcmp(infilename, "-")) {
1607 infilesize = (off_t)(-1);
1608 encode_infile = grabbag__file_get_binary_stdin();
1611 infilesize = grabbag__file_get_filesize(infilename);
1612 if(0 == (encode_infile = fopen(infilename, "rb"))) {
1613 flac__utils_printf(stderr, 1, "ERROR: can't open input file %s: %s\n", infilename, strerror(errno));
1618 if(!option_values.force_raw_format) {
1619 /* first set format based on name */
1620 if(strlen(infilename) >= 4 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-4), ".wav"))
1622 else if(strlen(infilename) >= 4 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-4), ".aif"))
1624 else if(strlen(infilename) >= 5 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-5), ".aiff"))
1626 else if(strlen(infilename) >= 5 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-5), ".flac"))
1628 else if(strlen(infilename) >= 4 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-4), ".oga"))
1630 else if(strlen(infilename) >= 4 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-4), ".ogg"))
1633 /* attempt to guess the file type based on the first 12 bytes */
1634 if((lookahead_length = fread(lookahead, 1, 12, encode_infile)) < 12) {
1636 format_mistake(infilename, fmt, RAW);
1637 if(option_values.treat_warnings_as_errors) {
1638 conditional_fclose(encode_infile);
1645 if(!strncmp((const char *)lookahead, "ID3", 3)) {
1646 flac__utils_printf(stderr, 1, "ERROR: input file %s has an ID3v2 tag\n", infilename);
1649 else if(!strncmp((const char *)lookahead, "RIFF", 4) && !strncmp((const char *)lookahead+8, "WAVE", 4))
1651 else if(!strncmp((const char *)lookahead, "FORM", 4) && !strncmp((const char *)lookahead+8, "AIFF", 4))
1653 else if(!strncmp((const char *)lookahead, "FORM", 4) && !strncmp((const char *)lookahead+8, "AIFC", 4)) {
1657 else if(!memcmp(lookahead, FLAC__STREAM_SYNC_STRING, sizeof(FLAC__STREAM_SYNC_STRING)))
1659 /* this could be made more accurate by looking at the first packet */
1660 else if(!memcmp(lookahead, "OggS", 4))
1664 format_mistake(infilename, fmt, RAW);
1665 if(option_values.treat_warnings_as_errors) {
1666 conditional_fclose(encode_infile);
1676 * Error if output file already exists (and -f not used).
1677 * Use grabbag__file_get_filesize() as a cheap way to check.
1679 if(!option_values.test_only && !option_values.force_file_overwrite && strcmp(outfilename, "-") && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
1681 /* need more detailed error message when re-flac'ing to avoid confusing the user */
1682 flac__utils_printf(stderr, 1,
1683 "ERROR: output file %s already exists.\n\n"
1684 "By default flac encodes files to FLAC format; if you meant to decode this file\n"
1685 "from FLAC to something else, use -d. If you meant to re-encode this file from\n"
1686 "FLAC to FLAC again, use -f to force writing to the same file, or -o to specify\n"
1687 "a different output filename.\n",
1691 else if(fmt == OGGFLAC) {
1692 /* need more detailed error message when re-flac'ing to avoid confusing the user */
1693 flac__utils_printf(stderr, 1,
1694 "ERROR: output file %s already exists.\n\n"
1695 "By default 'flac -ogg' encodes files to Ogg FLAC format; if you meant to decode\n"
1696 "this file from Ogg FLAC to something else, use -d. If you meant to re-encode\n"
1697 "this file from Ogg FLAC to Ogg FLAC again, use -f to force writing to the same\n"
1698 "file, or -o to specify a different output filename.\n",
1703 flac__utils_printf(stderr, 1, "ERROR: output file %s already exists, use -f to override\n", outfilename);
1704 conditional_fclose(encode_infile);
1708 if(option_values.format_input_size >= 0) {
1709 if (fmt != RAW || infilesize >= 0) {
1710 flac__utils_printf(stderr, 1, "ERROR: can only use --input-size when encoding raw samples from stdin\n");
1711 conditional_fclose(encode_infile);
1715 infilesize = option_values.format_input_size;
1719 if(option_values.sector_align && (fmt == FLAC || fmt == OGGFLAC)) {
1720 flac__utils_printf(stderr, 1, "ERROR: can't use --sector-align when the input file is FLAC or Ogg FLAC\n");
1721 conditional_fclose(encode_infile);
1724 if(option_values.sector_align && fmt == RAW && infilesize < 0) {
1725 flac__utils_printf(stderr, 1, "ERROR: can't use --sector-align when the input size is unknown\n");
1726 conditional_fclose(encode_infile);
1731 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) {
1732 conditional_fclose(encode_infile);
1733 return usage_error("ERROR: for encoding a raw file you must specify a value for --endian, --sign, --channels, --bps, and --sample-rate\n");
1737 if(encode_infile == stdin || option_values.force_to_stdout) {
1738 if(option_values.replay_gain) {
1739 conditional_fclose(encode_infile);
1740 return usage_error("ERROR: --replay-gain cannot be used when encoding to stdout\n");
1743 if(option_values.replay_gain && option_values.use_ogg) {
1744 conditional_fclose(encode_infile);
1745 return usage_error("ERROR: --replay-gain cannot be used when encoding to Ogg FLAC yet\n");
1748 if(!flac__utils_parse_skip_until_specification(option_values.skip_specification, &common_options.skip_specification) || common_options.skip_specification.is_relative) {
1749 conditional_fclose(encode_infile);
1750 return usage_error("ERROR: invalid value for --skip\n");
1753 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 */
1754 conditional_fclose(encode_infile);
1755 return usage_error("ERROR: invalid value for --until\n");
1757 /* if there is no "--until" we want to default to "--until=-0" */
1758 if(0 == option_values.until_specification)
1759 common_options.until_specification.is_relative = true;
1761 common_options.verify = option_values.verify;
1762 common_options.treat_warnings_as_errors = option_values.treat_warnings_as_errors;
1764 common_options.use_ogg = option_values.use_ogg;
1765 /* set a random serial number if one has not yet been specified */
1766 if(!option_values.has_serial_number) {
1767 option_values.serial_number = rand();
1768 option_values.has_serial_number = true;
1770 common_options.serial_number = option_values.serial_number++;
1772 common_options.lax = option_values.lax;
1773 common_options.padding = option_values.padding;
1774 common_options.num_compression_settings = option_values.num_compression_settings;
1775 FLAC__ASSERT(sizeof(common_options.compression_settings) >= sizeof(option_values.compression_settings));
1776 memcpy(common_options.compression_settings, option_values.compression_settings, sizeof(option_values.compression_settings));
1777 common_options.requested_seek_points = option_values.requested_seek_points;
1778 common_options.num_requested_seek_points = option_values.num_requested_seek_points;
1779 common_options.cuesheet_filename = option_values.cuesheet_filename;
1780 common_options.continue_through_decode_errors = option_values.continue_through_decode_errors;
1781 common_options.cued_seekpoints = option_values.cued_seekpoints;
1782 common_options.channel_map_none = option_values.channel_map_none;
1783 common_options.is_first_file = is_first_file;
1784 common_options.is_last_file = is_last_file;
1785 common_options.align_reservoir = align_reservoir;
1786 common_options.align_reservoir_samples = &align_reservoir_samples;
1787 common_options.replay_gain = option_values.replay_gain;
1788 common_options.ignore_chunk_sizes = option_values.ignore_chunk_sizes;
1789 common_options.sector_align = option_values.sector_align;
1790 common_options.vorbis_comment = option_values.vorbis_comment;
1791 FLAC__ASSERT(sizeof(common_options.pictures) >= sizeof(option_values.pictures));
1792 memcpy(common_options.pictures, option_values.pictures, sizeof(option_values.pictures));
1793 common_options.num_pictures = option_values.num_pictures;
1794 common_options.debug.disable_constant_subframes = option_values.debug.disable_constant_subframes;
1795 common_options.debug.disable_fixed_subframes = option_values.debug.disable_fixed_subframes;
1796 common_options.debug.disable_verbatim_subframes = option_values.debug.disable_verbatim_subframes;
1797 common_options.debug.do_md5 = option_values.debug.do_md5;
1799 /* if infilename and outfilename point to the same file, we need to write to a temporary file */
1800 if(encode_infile != stdin && grabbag__file_are_same(infilename, outfilename)) {
1801 static const char *tmp_suffix = ".tmp,fl-ac+en'c";
1802 /*@@@@ still a remote possibility that a file with this filename exists */
1803 if(0 == (internal_outfilename = malloc(strlen(outfilename)+strlen(tmp_suffix)+1))) {
1804 flac__utils_printf(stderr, 1, "ERROR allocating memory for tempfile name\n");
1805 conditional_fclose(encode_infile);
1808 strcpy(internal_outfilename, outfilename);
1809 strcat(internal_outfilename, tmp_suffix);
1813 raw_encode_options_t options;
1815 options.common = common_options;
1816 options.is_big_endian = option_values.format_is_big_endian;
1817 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1818 options.channels = option_values.format_channels;
1819 options.bps = option_values.format_bps;
1820 options.sample_rate = option_values.format_sample_rate;
1822 retval = flac__encode_raw(encode_infile, infilesize, infilename, internal_outfilename? internal_outfilename : outfilename, lookahead, lookahead_length, options);
1824 else if(fmt == FLAC || fmt == OGGFLAC) {
1825 flac_encode_options_t options;
1827 options.common = common_options;
1829 retval = flac__encode_flac(encode_infile, infilesize, infilename, internal_outfilename? internal_outfilename : outfilename, lookahead, lookahead_length, options, fmt==OGGFLAC);
1832 wav_encode_options_t options;
1834 options.common = common_options;
1837 retval = flac__encode_aif(encode_infile, infilesize, infilename, internal_outfilename? internal_outfilename : outfilename, lookahead, lookahead_length, options, is_aifc);
1839 retval = flac__encode_wav(encode_infile, infilesize, infilename, internal_outfilename? internal_outfilename : outfilename, lookahead, lookahead_length, options);
1843 if(strcmp(outfilename, "-")) {
1844 if(option_values.replay_gain) {
1845 float title_gain, title_peak;
1847 grabbag__replaygain_get_title(&title_gain, &title_peak);
1849 0 != (error = grabbag__replaygain_store_to_file_reference(internal_outfilename? internal_outfilename : outfilename, /*preserve_modtime=*/true)) ||
1850 0 != (error = grabbag__replaygain_store_to_file_title(internal_outfilename? internal_outfilename : outfilename, title_gain, title_peak, /*preserve_modtime=*/true))
1852 flac__utils_printf(stderr, 1, "%s: ERROR writing ReplayGain reference/title tags (%s)\n", outfilename, error);
1855 if(strcmp(infilename, "-"))
1856 grabbag__file_copy_metadata(infilename, internal_outfilename? internal_outfilename : outfilename);
1860 /* rename temporary file if necessary */
1861 if(retval == 0 && internal_outfilename != 0) {
1862 if(rename(internal_outfilename, outfilename) < 0) {
1863 #if defined _MSC_VER || defined __MINGW32__ || defined __EMX__
1864 /* on some flavors of windows, rename() will fail if the destination already exists, so we unlink and try again */
1865 if(unlink(outfilename) < 0) {
1866 flac__utils_printf(stderr, 1, "ERROR: moving new FLAC file %s back on top of original FLAC file %s, keeping both\n", internal_outfilename, outfilename);
1869 else if(rename(internal_outfilename, outfilename) < 0) {
1870 flac__utils_printf(stderr, 1, "ERROR: moving new FLAC file %s back on top of original FLAC file %s, you must do it\n", internal_outfilename, outfilename);
1874 flac__utils_printf(stderr, 1, "ERROR: moving new FLAC file %s back on top of original FLAC file %s, keeping both\n", internal_outfilename, outfilename);
1880 /* handle --delete-input-file, but don't want to delete if piping from stdin, or if input filename and output filename are the same */
1881 if(retval == 0 && option_values.delete_input && strcmp(infilename, "-") && internal_outfilename == 0)
1884 if(internal_outfilename != 0)
1885 free(internal_outfilename);
1890 int decode_file(const char *infilename)
1893 FLAC__bool treat_as_ogg = false;
1894 decode_options_t common_options;
1895 const char *outfilename = get_decoded_outfilename(infilename);
1897 if(0 == outfilename) {
1898 flac__utils_printf(stderr, 1, "ERROR: filename too long: %s", infilename);
1903 * Error if output file already exists (and -f not used).
1904 * Use grabbag__file_get_filesize() as a cheap way to check.
1906 if(!option_values.test_only && !option_values.force_file_overwrite && strcmp(outfilename, "-") && grabbag__file_get_filesize(outfilename) != (off_t)(-1)) {
1907 flac__utils_printf(stderr, 1, "ERROR: output file %s already exists, use -f to override\n", outfilename);
1911 if(!option_values.test_only && !option_values.analyze) {
1912 if(option_values.force_raw_format && (option_values.format_is_big_endian < 0 || option_values.format_is_unsigned_samples < 0))
1913 return usage_error("ERROR: for decoding to a raw file you must specify a value for --endian and --sign\n");
1916 if(option_values.use_ogg)
1917 treat_as_ogg = true;
1918 else if(strlen(infilename) >= 4 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-4), ".oga"))
1919 treat_as_ogg = true;
1920 else if(strlen(infilename) >= 4 && 0 == FLAC__STRCASECMP(infilename+(strlen(infilename)-4), ".ogg"))
1921 treat_as_ogg = true;
1923 treat_as_ogg = false;
1927 flac__utils_printf(stderr, 1, "%s: Ogg support has not been built into this copy of flac\n", infilename);
1932 if(!flac__utils_parse_skip_until_specification(option_values.skip_specification, &common_options.skip_specification) || common_options.skip_specification.is_relative)
1933 return usage_error("ERROR: invalid value for --skip\n");
1935 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 */
1936 return usage_error("ERROR: invalid value for --until\n");
1937 /* if there is no "--until" we want to default to "--until=-0" */
1938 if(0 == option_values.until_specification)
1939 common_options.until_specification.is_relative = true;
1941 if(option_values.cue_specification) {
1942 if(!flac__utils_parse_cue_specification(option_values.cue_specification, &common_options.cue_specification))
1943 return usage_error("ERROR: invalid value for --cue\n");
1944 common_options.has_cue_specification = true;
1947 common_options.has_cue_specification = false;
1949 common_options.treat_warnings_as_errors = option_values.treat_warnings_as_errors;
1950 common_options.continue_through_decode_errors = option_values.continue_through_decode_errors;
1951 common_options.replaygain_synthesis_spec = option_values.replaygain_synthesis_spec;
1953 common_options.is_ogg = treat_as_ogg;
1954 common_options.use_first_serial_number = !option_values.has_serial_number;
1955 common_options.serial_number = option_values.serial_number;
1957 common_options.channel_map_none = option_values.channel_map_none;
1959 if(!option_values.force_raw_format) {
1960 wav_decode_options_t options;
1962 options.common = common_options;
1965 option_values.force_aiff_format ||
1966 (strlen(outfilename) >= 4 && 0 == FLAC__STRCASECMP(outfilename+(strlen(outfilename)-4), ".aif")) ||
1967 (strlen(outfilename) >= 5 && 0 == FLAC__STRCASECMP(outfilename+(strlen(outfilename)-5), ".aiff"))
1969 retval = flac__decode_aiff(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1971 retval = flac__decode_wav(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1974 raw_decode_options_t options;
1976 options.common = common_options;
1977 options.is_big_endian = option_values.format_is_big_endian;
1978 options.is_unsigned_samples = option_values.format_is_unsigned_samples;
1980 retval = flac__decode_raw(infilename, option_values.test_only? 0 : outfilename, option_values.analyze, option_values.aopts, options);
1983 if(retval == 0 && strcmp(infilename, "-")) {
1984 if(strcmp(outfilename, "-"))
1985 grabbag__file_copy_metadata(infilename, outfilename);
1986 if(option_values.delete_input && !option_values.test_only && !option_values.analyze)
1993 const char *get_encoded_outfilename(const char *infilename)
1995 const char *suffix = (option_values.use_ogg? ".oga" : ".flac");
1996 return get_outfilename(infilename, suffix);
1999 const char *get_decoded_outfilename(const char *infilename)
2002 if(option_values.analyze) {
2005 else if(option_values.force_raw_format) {
2008 else if(option_values.force_aiff_format) {
2014 return get_outfilename(infilename, suffix);
2017 const char *get_outfilename(const char *infilename, const char *suffix)
2019 if(0 == option_values.cmdline_forced_outfilename) {
2020 static char buffer[4096]; /* @@@ bad MAGIC NUMBER */
2022 if(0 == strcmp(infilename, "-") || option_values.force_to_stdout) {
2023 strcpy(buffer, "-");
2027 if (flac__strlcpy(buffer, option_values.output_prefix? option_values.output_prefix : "", sizeof buffer) >= sizeof buffer)
2029 if (flac__strlcat(buffer, infilename, sizeof buffer) >= sizeof buffer)
2031 /* the . must come after any / to avoid problems with, e.g. "some.directory/extensionless-filename" */
2032 if(0 == (p = strrchr(buffer, '.')) || strchr(p, '/')) {
2033 if (flac__strlcat(buffer, suffix, sizeof buffer) >= sizeof buffer)
2038 if (flac__strlcat(buffer, suffix, sizeof buffer) >= sizeof buffer)
2045 return option_values.cmdline_forced_outfilename;
2048 void die(const char *message)
2050 FLAC__ASSERT(0 != message);
2051 flac__utils_printf(stderr, 1, "ERROR: %s\n", message);
2055 int conditional_fclose(FILE *f)
2057 if(f == 0 || f == stdin || f == stdout)
2063 char *local_strdup(const char *source)
2066 FLAC__ASSERT(0 != source);
2067 if(0 == (ret = strdup(source)))
2068 die("out of memory during strdup()");
2073 /* There's no strtoll() in MSVC6 so we just write a specialized one */
2074 FLAC__int64 local__strtoll(const char *src, char **endptr)
2076 FLAC__bool neg = false;
2077 FLAC__int64 ret = 0;
2079 FLAC__ASSERT(0 != src);
2084 while(0 != (c = *src)) {
2086 if(c >= 0 && c <= 9)
2087 ret = (ret * 10) + c;
2093 *endptr = (char*)src;
2094 return neg? -ret : ret;