1 /* flac - Command-line FLAC encoder/decoder
2 * Copyright (C) 2000-2009 Josh Coalson
3 * Copyright (C) 2011-2016 Xiph.Org Foundation
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
33 #if !defined _MSC_VER && !defined __MINGW32__
34 /* unlink is in stdio.h in VC++ */
35 #include <unistd.h> /* for unlink() */
38 #include "share/alloc.h"
39 #include "share/grabbag.h"
40 #include "share/compat.h"
41 #include "share/safe_str.h"
45 #include "local_string_utils.h" /* for flac__strlcat() and flac__strlcpy() */
47 #include "vorbiscomment.h"
50 /*[JEC] was:#if HAVE_GETOPT_LONG*/
51 /*[JEC] see flac/include/share/getopt.h as to why the change */
54 # include "share/getopt.h"
57 static int do_it(void);
59 static FLAC__bool
init_options(void);
60 static int parse_options(int argc
, char *argv
[]);
61 static int parse_option(int short_option
, const char *long_option
, const char *option_argument
);
62 static void free_options(void);
63 static void add_compression_setting_bool(compression_setting_type_t type
, FLAC__bool value
);
64 static void add_compression_setting_string(compression_setting_type_t type
, const char *value
);
65 static void add_compression_setting_uint32_t(compression_setting_type_t type
, uint32_t value
);
67 static int usage_error(const char *message
, ...);
68 static void short_usage(void);
69 static void show_version(void);
70 static void show_help(void);
71 static void show_explain(void);
72 static void format_mistake(const char *infilename
, FileFormat wrong
, FileFormat right
);
74 static int encode_file(const char *infilename
, FLAC__bool is_first_file
, FLAC__bool is_last_file
);
75 static int decode_file(const char *infilename
);
77 static const char *get_encoded_outfilename(const char *infilename
);
78 static const char *get_decoded_outfilename(const char *infilename
);
79 static const char *get_outfilename(const char *infilename
, const char *suffix
);
81 static void die(const char *message
);
82 static int conditional_fclose(FILE *f
);
83 static char *local_strdup(const char *source
);
86 * share__getopt format struct; note that for long options with no
87 * short option equivalent we just set the 'val' field to 0.
89 static struct share__option long_options_
[] = {
93 { "help" , share__no_argument
, 0, 'h' },
94 { "explain" , share__no_argument
, 0, 'H' },
95 { "version" , share__no_argument
, 0, 'v' },
96 { "decode" , share__no_argument
, 0, 'd' },
97 { "analyze" , share__no_argument
, 0, 'a' },
98 { "test" , share__no_argument
, 0, 't' },
99 { "stdout" , share__no_argument
, 0, 'c' },
100 { "silent" , share__no_argument
, 0, 's' },
101 { "totally-silent" , share__no_argument
, 0, 0 },
102 { "warnings-as-errors" , share__no_argument
, 0, 'w' },
103 { "force" , share__no_argument
, 0, 'f' },
104 { "delete-input-file" , share__no_argument
, 0, 0 },
105 { "preserve-modtime" , share__no_argument
, 0, 0 },
106 { "keep-foreign-metadata" , share__no_argument
, 0, 0 },
107 { "output-prefix" , share__required_argument
, 0, 0 },
108 { "output-name" , share__required_argument
, 0, 'o' },
109 { "skip" , share__required_argument
, 0, 0 },
110 { "until" , share__required_argument
, 0, 0 },
111 { "channel-map" , share__required_argument
, 0, 0 }, /* undocumented */
116 { "decode-through-errors", share__no_argument
, 0, 'F' },
117 { "cue" , share__required_argument
, 0, 0 },
118 { "apply-replaygain-which-is-not-lossless", share__optional_argument
, 0, 0 }, /* undocumented */
123 { "cuesheet" , share__required_argument
, 0, 0 },
124 { "no-cued-seekpoints" , share__no_argument
, 0, 0 },
125 { "picture" , share__required_argument
, 0, 0 },
126 { "tag" , share__required_argument
, 0, 'T' },
127 { "tag-from-file" , share__required_argument
, 0, 0 },
128 { "compression-level-0" , share__no_argument
, 0, '0' },
129 { "compression-level-1" , share__no_argument
, 0, '1' },
130 { "compression-level-2" , share__no_argument
, 0, '2' },
131 { "compression-level-3" , share__no_argument
, 0, '3' },
132 { "compression-level-4" , share__no_argument
, 0, '4' },
133 { "compression-level-5" , share__no_argument
, 0, '5' },
134 { "compression-level-6" , share__no_argument
, 0, '6' },
135 { "compression-level-7" , share__no_argument
, 0, '7' },
136 { "compression-level-8" , share__no_argument
, 0, '8' },
137 { "compression-level-9" , share__no_argument
, 0, '9' },
138 { "best" , share__no_argument
, 0, '8' },
139 { "fast" , share__no_argument
, 0, '0' },
140 { "verify" , share__no_argument
, 0, 'V' },
141 { "force-raw-format" , share__no_argument
, 0, 0 },
142 { "force-aiff-format" , share__no_argument
, 0, 0 },
143 { "force-rf64-format" , share__no_argument
, 0, 0 },
144 { "force-wave64-format" , share__no_argument
, 0, 0 },
145 { "lax" , share__no_argument
, 0, 0 },
146 { "replay-gain" , share__no_argument
, 0, 0 },
147 { "ignore-chunk-sizes" , share__no_argument
, 0, 0 },
148 { "sector-align" , share__no_argument
, 0, 0 }, /* DEPRECATED */
149 { "seekpoint" , share__required_argument
, 0, 'S' },
150 { "padding" , share__required_argument
, 0, 'P' },
152 { "ogg" , share__no_argument
, 0, 0 },
153 { "serial-number" , share__required_argument
, 0, 0 },
155 { "blocksize" , share__required_argument
, 0, 'b' },
156 { "exhaustive-model-search" , share__no_argument
, 0, 'e' },
157 { "max-lpc-order" , share__required_argument
, 0, 'l' },
158 { "apodization" , share__required_argument
, 0, 'A' },
159 { "mid-side" , share__no_argument
, 0, 'm' },
160 { "adaptive-mid-side" , share__no_argument
, 0, 'M' },
161 { "qlp-coeff-precision-search", share__no_argument
, 0, 'p' },
162 { "qlp-coeff-precision" , share__required_argument
, 0, 'q' },
163 { "rice-partition-order" , share__required_argument
, 0, 'r' },
164 { "endian" , share__required_argument
, 0, 0 },
165 { "channels" , share__required_argument
, 0, 0 },
166 { "bps" , share__required_argument
, 0, 0 },
167 { "sample-rate" , share__required_argument
, 0, 0 },
168 { "sign" , share__required_argument
, 0, 0 },
169 { "input-size" , share__required_argument
, 0, 0 },
170 { "error-on-compression-fail" , share__no_argument
, 0, 0 },
175 { "residual-gnuplot", share__no_argument
, 0, 0 },
176 { "residual-text", share__no_argument
, 0, 0 },
181 { "no-preserve-modtime" , share__no_argument
, 0, 0 },
182 { "no-decode-through-errors" , share__no_argument
, 0, 0 },
183 { "no-silent" , share__no_argument
, 0, 0 },
184 { "no-force" , share__no_argument
, 0, 0 },
185 { "no-seektable" , share__no_argument
, 0, 0 },
186 { "no-delete-input-file" , share__no_argument
, 0, 0 },
187 { "no-keep-foreign-metadata" , share__no_argument
, 0, 0 },
188 { "no-replay-gain" , share__no_argument
, 0, 0 },
189 { "no-ignore-chunk-sizes" , share__no_argument
, 0, 0 },
190 { "no-sector-align" , share__no_argument
, 0, 0 }, /* DEPRECATED */
191 { "no-utf8-convert" , share__no_argument
, 0, 0 },
192 { "no-lax" , share__no_argument
, 0, 0 },
194 { "no-ogg" , share__no_argument
, 0, 0 },
196 { "no-exhaustive-model-search", share__no_argument
, 0, 0 },
197 { "no-mid-side" , share__no_argument
, 0, 0 },
198 { "no-adaptive-mid-side" , share__no_argument
, 0, 0 },
199 { "no-qlp-coeff-prec-search" , share__no_argument
, 0, 0 },
200 { "no-padding" , share__no_argument
, 0, 0 },
201 { "no-verify" , share__no_argument
, 0, 0 },
202 { "no-warnings-as-errors" , share__no_argument
, 0, 0 },
203 { "no-residual-gnuplot" , share__no_argument
, 0, 0 },
204 { "no-residual-text" , share__no_argument
, 0, 0 },
205 { "no-error-on-compression-fail", share__no_argument
, 0, 0 },
207 * undocumented debugging options for the test suite
209 { "disable-constant-subframes", share__no_argument
, 0, 0 },
210 { "disable-fixed-subframes" , share__no_argument
, 0, 0 },
211 { "disable-verbatim-subframes", share__no_argument
, 0, 0 },
212 { "no-md5-sum" , share__no_argument
, 0, 0 },
219 * global to hold command-line option values
223 FLAC__bool show_help
;
224 FLAC__bool show_explain
;
225 FLAC__bool show_version
;
226 FLAC__bool mode_decode
;
228 FLAC__bool treat_warnings_as_errors
;
229 FLAC__bool force_file_overwrite
;
230 FLAC__bool continue_through_decode_errors
;
231 replaygain_synthesis_spec_t replaygain_synthesis_spec
;
233 FLAC__bool test_only
;
236 FLAC__bool has_serial_number
; /* true iff --serial-number was used */
237 long serial_number
; /* this is the Ogg serial number and is unused for native FLAC */
238 FLAC__bool force_to_stdout
;
239 FLAC__bool force_raw_format
;
240 FLAC__bool force_aiff_format
;
241 FLAC__bool force_rf64_format
;
242 FLAC__bool force_wave64_format
;
243 FLAC__bool delete_input
;
244 FLAC__bool preserve_modtime
;
245 FLAC__bool keep_foreign_metadata
;
246 FLAC__bool replay_gain
;
247 FLAC__bool ignore_chunk_sizes
;
248 FLAC__bool sector_align
;
249 FLAC__bool utf8_convert
; /* true by default, to convert tag strings from locale to utf-8, false if --no-utf8-convert used */
250 const char *cmdline_forced_outfilename
;
251 const char *output_prefix
;
252 analysis_options aopts
;
253 int padding
; /* -1 => no -P options were given, 0 => -P- was given, else -P value */
254 size_t num_compression_settings
;
255 compression_setting_t compression_settings
[64]; /* bad MAGIC NUMBER but buffer overflow is checked */
256 const char *skip_specification
;
257 const char *until_specification
;
258 const char *cue_specification
;
259 int format_is_big_endian
;
260 int format_is_unsigned_samples
;
263 int format_sample_rate
;
264 FLAC__off_t format_input_size
;
265 char requested_seek_points
[5000]; /* bad MAGIC NUMBER but buffer overflow is checked */
266 int num_requested_seek_points
; /* -1 => no -S options were given, 0 => -S- was given */
267 const char *cuesheet_filename
;
268 FLAC__bool cued_seekpoints
;
269 FLAC__bool channel_map_none
; /* --channel-map=none specified, eventually will expand to take actual channel map */
270 FLAC__bool error_on_compression_fail
;
275 FLAC__StreamMetadata
*vorbis_comment
;
276 FLAC__StreamMetadata
*pictures
[64];
277 uint32_t num_pictures
;
280 FLAC__bool disable_constant_subframes
;
281 FLAC__bool disable_fixed_subframes
;
282 FLAC__bool disable_verbatim_subframes
;
289 * miscellaneous globals
292 static FLAC__int32 align_reservoir_0
[588], align_reservoir_1
[588]; /* for carrying over samples from --sector-align */ /* DEPRECATED */
293 static FLAC__int32
*align_reservoir
[2] = { align_reservoir_0
, align_reservoir_1
};
294 static uint32_t align_reservoir_samples
= 0; /* 0 .. 587 */
297 int main(int argc
, char *argv
[])
302 _response(&argc
, &argv
);
303 _wildcard(&argc
, &argv
);
306 if (get_utf8_argv(&argc
, &argv
) != 0) {
307 fprintf(stderr
, "ERROR: failed to convert command line parameters to UTF-8\n");
312 srand((uint32_t)time(0));
316 var
= getenv("LC_ALL");
318 var
= getenv("LC_NUMERIC");
320 var
= getenv("LANG");
321 if (!var
|| strcmp(var
, "C") != 0)
322 setlocale(LC_ALL
, "");
325 setlocale(LC_ALL
, "");
327 if(!init_options()) {
328 flac__utils_printf(stderr
, 1, "ERROR: allocating memory\n");
332 if((retval
= parse_options(argc
, argv
)) == 0)
345 if(option_values
.show_version
) {
349 else if(option_values
.show_explain
) {
353 else if(option_values
.show_help
) {
358 if(option_values
.num_files
== 0) {
359 if(flac__utils_verbosity_
>= 1)
365 * tweak options; validate the values
367 if(!option_values
.mode_decode
) {
368 if(0 != option_values
.cue_specification
)
369 return usage_error("ERROR: --cue is not allowed in test mode\n");
372 if(option_values
.test_only
) {
373 if(0 != option_values
.skip_specification
)
374 return usage_error("ERROR: --skip is not allowed in test mode\n");
375 if(0 != option_values
.until_specification
)
376 return usage_error("ERROR: --until is not allowed in test mode\n");
377 if(0 != option_values
.cue_specification
)
378 return usage_error("ERROR: --cue is not allowed in test mode\n");
379 if(0 != option_values
.analyze
)
380 return usage_error("ERROR: analysis mode (-a/--analyze) and test mode (-t/--test) cannot be used together\n");
384 if(0 != option_values
.cue_specification
&& (0 != option_values
.skip_specification
|| 0 != option_values
.until_specification
))
385 return usage_error("ERROR: --cue may not be combined with --skip or --until\n");
387 if(option_values
.format_channels
>= 0) {
388 if(option_values
.format_channels
== 0 || (uint32_t)option_values
.format_channels
> FLAC__MAX_CHANNELS
)
389 return usage_error("ERROR: invalid number of channels '%u', must be > 0 and <= %u\n", option_values
.format_channels
, FLAC__MAX_CHANNELS
);
391 if(option_values
.format_bps
>= 0) {
392 if(option_values
.format_bps
!= 8 && option_values
.format_bps
!= 16 && option_values
.format_bps
!= 24)
393 return usage_error("ERROR: invalid bits per sample '%u' (must be 8/16/24)\n", option_values
.format_bps
);
395 if(option_values
.format_sample_rate
>= 0) {
396 if(!FLAC__format_sample_rate_is_valid(option_values
.format_sample_rate
))
397 return usage_error("ERROR: invalid sample rate '%u', must be > 0 and <= %u\n", option_values
.format_sample_rate
, FLAC__MAX_SAMPLE_RATE
);
399 if((option_values
.force_raw_format
?1:0) + (option_values
.force_aiff_format
?1:0) + (option_values
.force_rf64_format
?1:0) + (option_values
.force_wave64_format
?1:0) > 1)
400 return usage_error("ERROR: only one of --force-raw-format/--force-aiff-format/--force-rf64-format/--force-wave64-format allowed\n");
401 if(option_values
.mode_decode
) {
402 if(!option_values
.force_raw_format
) {
403 if(option_values
.format_is_big_endian
>= 0)
404 return usage_error("ERROR: --endian only allowed with --force-raw-format\n");
405 if(option_values
.format_is_unsigned_samples
>= 0)
406 return usage_error("ERROR: --sign only allowed with --force-raw-format\n");
408 if(option_values
.format_channels
>= 0)
409 return usage_error("ERROR: --channels not allowed with --decode\n");
410 if(option_values
.format_bps
>= 0)
411 return usage_error("ERROR: --bps not allowed with --decode\n");
412 if(option_values
.format_sample_rate
>= 0)
413 return usage_error("ERROR: --sample-rate not allowed with --decode\n");
416 if(option_values
.ignore_chunk_sizes
) {
417 if(option_values
.mode_decode
)
418 return usage_error("ERROR: --ignore-chunk-sizes only allowed for encoding\n");
419 if(0 != option_values
.sector_align
)
420 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --sector-align\n");
421 if(0 != option_values
.until_specification
)
422 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --until\n");
423 if(0 != option_values
.cue_specification
)
424 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --cue\n");
425 if(0 != option_values
.cuesheet_filename
)
426 return usage_error("ERROR: --ignore-chunk-sizes not allowed with --cuesheet\n");
428 if(option_values
.sector_align
) {
429 if(option_values
.mode_decode
)
430 return usage_error("ERROR: --sector-align only allowed for encoding\n");
431 if(0 != option_values
.skip_specification
)
432 return usage_error("ERROR: --sector-align not allowed with --skip\n");
433 if(0 != option_values
.until_specification
)
434 return usage_error("ERROR: --sector-align not allowed with --until\n");
435 if(0 != option_values
.cue_specification
)
436 return usage_error("ERROR: --sector-align not allowed with --cue\n");
437 if(option_values
.format_channels
>= 0 && option_values
.format_channels
!= 2)
438 return usage_error("ERROR: --sector-align can only be done with stereo input\n");
439 if(option_values
.format_bps
>= 0 && option_values
.format_bps
!= 16)
440 return usage_error("ERROR: --sector-align can only be done with 16-bit samples\n");
441 if(option_values
.format_sample_rate
>= 0 && option_values
.format_sample_rate
!= 44100)
442 return usage_error("ERROR: --sector-align can only be done with a sample rate of 44100\n");
444 if(option_values
.replay_gain
) {
445 if(option_values
.force_to_stdout
)
446 return usage_error("ERROR: --replay-gain not allowed with -c/--stdout\n");
447 if(option_values
.mode_decode
)
448 return usage_error("ERROR: --replay-gain only allowed for encoding\n");
449 if(option_values
.format_channels
> 2)
450 return usage_error("ERROR: --replay-gain can only be done with mono/stereo input\n");
451 if(option_values
.format_sample_rate
>= 0 && !grabbag__replaygain_is_valid_sample_frequency(option_values
.format_sample_rate
))
452 return usage_error("ERROR: invalid sample rate used with --replay-gain\n");
454 (option_values
.padding
>= 0 && option_values
.padding
< (int)GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED
) ||
455 (option_values
.padding
< 0 && FLAC_ENCODE__DEFAULT_PADDING
< (int)GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED
)
457 flac__utils_printf(stderr
, 1, "NOTE: --replay-gain may leave a small PADDING block even with --no-padding\n");
460 if(option_values
.num_files
> 1 && option_values
.cmdline_forced_outfilename
) {
461 return usage_error("ERROR: -o/--output-name cannot be used with multiple files\n");
463 if(option_values
.cmdline_forced_outfilename
&& option_values
.output_prefix
) {
464 return usage_error("ERROR: --output-prefix conflicts with -o/--output-name\n");
466 if(!option_values
.mode_decode
&& 0 != option_values
.cuesheet_filename
&& option_values
.num_files
> 1) {
467 return usage_error("ERROR: --cuesheet cannot be used when encoding multiple files\n");
469 if(option_values
.keep_foreign_metadata
) {
470 /* we're not going to try and support the re-creation of broken WAVE files */
471 if(option_values
.ignore_chunk_sizes
)
472 return usage_error("ERROR: using --keep-foreign-metadata cannot be used with --ignore-chunk-sizes\n");
473 if(option_values
.test_only
)
474 return usage_error("ERROR: --keep-foreign-metadata is not allowed in test mode\n");
475 if(option_values
.analyze
)
476 return usage_error("ERROR: --keep-foreign-metadata is not allowed in analyis mode\n");
477 flac__utils_printf(stderr
, 1, "NOTE: --keep-foreign-metadata is a new feature; make sure to test the output file before deleting the original.\n");
481 flac__utils_printf(stderr
, 2, "\n");
482 flac__utils_printf(stderr
, 2, "flac %s\n", FLAC__VERSION_STRING
);
483 flac__utils_printf(stderr
, 2, "Copyright (C) 2000-2009 Josh Coalson, 2011-2016 Xiph.Org Foundation\n");
484 flac__utils_printf(stderr
, 2, "flac comes with ABSOLUTELY NO WARRANTY. This is free software, and you are\n");
485 flac__utils_printf(stderr
, 2, "welcome to redistribute it under certain conditions. Type `flac' for details.\n\n");
487 if(option_values
.mode_decode
) {
488 FLAC__bool first
= true;
490 if(option_values
.num_files
== 0) {
491 retval
= decode_file("-");
495 if(option_values
.num_files
> 1)
496 option_values
.cmdline_forced_outfilename
= 0;
497 for(i
= 0, retval
= 0; i
< option_values
.num_files
; i
++) {
498 if(0 == strcmp(option_values
.filenames
[i
], "-") && !first
)
500 retval
|= decode_file(option_values
.filenames
[i
]);
506 FLAC__bool first
= true;
508 if(option_values
.ignore_chunk_sizes
)
509 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");
511 if(option_values
.num_files
== 0) {
512 retval
= encode_file("-", first
, true);
516 if(option_values
.num_files
> 1)
517 option_values
.cmdline_forced_outfilename
= 0;
518 for(i
= 0, retval
= 0; i
< option_values
.num_files
; i
++) {
519 if(0 == strcmp(option_values
.filenames
[i
], "-") && !first
)
521 retval
|= encode_file(option_values
.filenames
[i
], first
, i
== (option_values
.num_files
-1));
524 if(option_values
.replay_gain
&& retval
== 0) {
525 float album_gain
, album_peak
;
526 grabbag__replaygain_get_album(&album_gain
, &album_peak
);
527 for(i
= 0; i
< option_values
.num_files
; i
++) {
528 const char *error
, *outfilename
= get_encoded_outfilename(option_values
.filenames
[i
]);
529 if(0 == outfilename
) {
530 flac__utils_printf(stderr
, 1, "ERROR: filename too long: %s", option_values
.filenames
[i
]);
533 if(0 != (error
= grabbag__replaygain_store_to_file_album(outfilename
, album_gain
, album_peak
, option_values
.preserve_modtime
))) {
534 flac__utils_printf(stderr
, 1, "%s: ERROR writing ReplayGain album tags (%s)\n", outfilename
, error
);
545 FLAC__bool
init_options(void)
547 option_values
.show_help
= false;
548 option_values
.show_explain
= false;
549 option_values
.mode_decode
= false;
550 option_values
.verify
= false;
551 option_values
.treat_warnings_as_errors
= false;
552 option_values
.force_file_overwrite
= false;
553 option_values
.continue_through_decode_errors
= false;
554 option_values
.replaygain_synthesis_spec
.apply
= false;
555 option_values
.replaygain_synthesis_spec
.use_album_gain
= true;
556 option_values
.replaygain_synthesis_spec
.limiter
= RGSS_LIMIT__HARD
;
557 option_values
.replaygain_synthesis_spec
.noise_shaping
= NOISE_SHAPING_LOW
;
558 option_values
.replaygain_synthesis_spec
.preamp
= 0.0;
559 option_values
.lax
= false;
560 option_values
.test_only
= false;
561 option_values
.analyze
= false;
562 option_values
.use_ogg
= false;
563 option_values
.has_serial_number
= false;
564 option_values
.serial_number
= 0;
565 option_values
.force_to_stdout
= false;
566 option_values
.force_raw_format
= false;
567 option_values
.force_aiff_format
= false;
568 option_values
.force_rf64_format
= false;
569 option_values
.force_wave64_format
= false;
570 option_values
.delete_input
= false;
571 option_values
.preserve_modtime
= true;
572 option_values
.keep_foreign_metadata
= false;
573 option_values
.replay_gain
= false;
574 option_values
.ignore_chunk_sizes
= false;
575 option_values
.sector_align
= false;
576 option_values
.utf8_convert
= true;
577 option_values
.cmdline_forced_outfilename
= 0;
578 option_values
.output_prefix
= 0;
579 option_values
.aopts
.do_residual_text
= false;
580 option_values
.aopts
.do_residual_gnuplot
= false;
581 option_values
.padding
= -1;
582 option_values
.num_compression_settings
= 1;
583 option_values
.compression_settings
[0].type
= CST_COMPRESSION_LEVEL
;
584 option_values
.compression_settings
[0].value
.t_unsigned
= 5;
585 option_values
.skip_specification
= 0;
586 option_values
.until_specification
= 0;
587 option_values
.cue_specification
= 0;
588 option_values
.format_is_big_endian
= -1;
589 option_values
.format_is_unsigned_samples
= -1;
590 option_values
.format_channels
= -1;
591 option_values
.format_bps
= -1;
592 option_values
.format_sample_rate
= -1;
593 option_values
.format_input_size
= (FLAC__off_t
)(-1);
594 option_values
.requested_seek_points
[0] = '\0';
595 option_values
.num_requested_seek_points
= -1;
596 option_values
.cuesheet_filename
= 0;
597 option_values
.cued_seekpoints
= true;
598 option_values
.channel_map_none
= false;
599 option_values
.error_on_compression_fail
= false;
601 option_values
.num_files
= 0;
602 option_values
.filenames
= 0;
604 if(0 == (option_values
.vorbis_comment
= FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT
)))
606 option_values
.num_pictures
= 0;
608 option_values
.debug
.disable_constant_subframes
= false;
609 option_values
.debug
.disable_fixed_subframes
= false;
610 option_values
.debug
.disable_verbatim_subframes
= false;
611 option_values
.debug
.do_md5
= true;
616 int parse_options(int argc
, char *argv
[])
619 int option_index
= 1;
620 FLAC__bool had_error
= false;
621 const char *short_opts
= "0123456789aA:b:cdefFhHl:mMo:pP:q:r:sS:tT:vVw";
623 while ((short_option
= share__getopt_long(argc
, argv
, short_opts
, long_options_
, &option_index
)) != -1) {
624 switch (short_option
) {
625 case 0: /* long option with no equivalent short option */
626 had_error
|= (parse_option(short_option
, long_options_
[option_index
].name
, share__optarg
) != 0);
632 default: /* short option */
633 had_error
|= (parse_option(short_option
, 0, share__optarg
) != 0);
642 FLAC__ASSERT(share__optind
<= argc
);
644 option_values
.num_files
= argc
- share__optind
;
646 if(option_values
.num_files
> 0) {
648 if(0 == (option_values
.filenames
= malloc(sizeof(char*) * option_values
.num_files
)))
649 die("out of memory allocating space for file names list");
650 while(share__optind
< argc
)
651 option_values
.filenames
[i
++] = local_strdup(argv
[share__optind
++]);
657 int parse_option(int short_option
, const char *long_option
, const char *option_argument
)
659 const char *violation
;
661 if(short_option
== 0) {
662 FLAC__ASSERT(0 != long_option
);
663 if(0 == strcmp(long_option
, "totally-silent")) {
664 flac__utils_verbosity_
= 0;
666 else if(0 == strcmp(long_option
, "delete-input-file")) {
667 option_values
.delete_input
= true;
669 else if(0 == strcmp(long_option
, "preserve-modtime")) {
670 option_values
.preserve_modtime
= true;
672 else if(0 == strcmp(long_option
, "keep-foreign-metadata")) {
673 option_values
.keep_foreign_metadata
= true;
675 else if(0 == strcmp(long_option
, "output-prefix")) {
676 FLAC__ASSERT(0 != option_argument
);
677 option_values
.output_prefix
= option_argument
;
679 else if(0 == strcmp(long_option
, "skip")) {
680 FLAC__ASSERT(0 != option_argument
);
681 option_values
.skip_specification
= option_argument
;
683 else if(0 == strcmp(long_option
, "until")) {
684 FLAC__ASSERT(0 != option_argument
);
685 option_values
.until_specification
= option_argument
;
687 else if(0 == strcmp(long_option
, "input-size")) {
688 FLAC__ASSERT(0 != option_argument
);
692 ix
= strtoll(option_argument
, &end
, 10);
693 if(0 == strlen(option_argument
) || *end
)
694 return usage_error("ERROR: --%s must be a number\n", long_option
);
695 option_values
.format_input_size
= (FLAC__off_t
)ix
;
696 if(option_values
.format_input_size
!= ix
) /* check if FLAC__off_t is smaller than long long */
697 return usage_error("ERROR: --%s too large; this build of flac does not support filesizes over 2GB\n", long_option
);
698 if(option_values
.format_input_size
<= 0)
699 return usage_error("ERROR: --%s must be > 0\n", long_option
);
702 else if(0 == strcmp(long_option
, "cue")) {
703 FLAC__ASSERT(0 != option_argument
);
704 option_values
.cue_specification
= option_argument
;
706 else if(0 == strcmp(long_option
, "apply-replaygain-which-is-not-lossless")) {
707 option_values
.replaygain_synthesis_spec
.apply
= true;
708 if (0 != option_argument
) {
710 option_values
.replaygain_synthesis_spec
.limiter
= RGSS_LIMIT__NONE
;
711 option_values
.replaygain_synthesis_spec
.noise_shaping
= NOISE_SHAPING_NONE
;
712 option_values
.replaygain_synthesis_spec
.preamp
= strtod(option_argument
, &p
);
715 option_values
.replaygain_synthesis_spec
.use_album_gain
= true;
717 option_values
.replaygain_synthesis_spec
.use_album_gain
= false;
719 option_values
.replaygain_synthesis_spec
.limiter
= RGSS_LIMIT__PEAK
;
721 option_values
.replaygain_synthesis_spec
.limiter
= RGSS_LIMIT__HARD
;
722 else if (*p
== 'n' && p
[1] >= '0' && p
[1] <= '3') {
723 option_values
.replaygain_synthesis_spec
.noise_shaping
= p
[1] - '0';
727 return usage_error("ERROR: bad specification string \"%s\" for --%s\n", option_argument
, long_option
);
731 else if(0 == strcmp(long_option
, "channel-map")) {
732 if (0 == option_argument
|| strcmp(option_argument
, "none"))
733 return usage_error("ERROR: only --channel-map=none currently supported\n");
734 option_values
.channel_map_none
= true;
736 else if(0 == strcmp(long_option
, "cuesheet")) {
737 FLAC__ASSERT(0 != option_argument
);
738 option_values
.cuesheet_filename
= option_argument
;
740 else if(0 == strcmp(long_option
, "picture")) {
741 const uint32_t max_pictures
= sizeof(option_values
.pictures
)/sizeof(option_values
.pictures
[0]);
742 FLAC__ASSERT(0 != option_argument
);
743 if(option_values
.num_pictures
>= max_pictures
)
744 return usage_error("ERROR: too many --picture arguments, only %u allowed\n", max_pictures
);
745 if(0 == (option_values
.pictures
[option_values
.num_pictures
] = grabbag__picture_parse_specification(option_argument
, &violation
)))
746 return usage_error("ERROR: (--picture) %s\n", violation
);
747 option_values
.num_pictures
++;
749 else if(0 == strcmp(long_option
, "tag-from-file")) {
750 FLAC__ASSERT(0 != option_argument
);
751 if(!flac__vorbiscomment_add(option_values
.vorbis_comment
, option_argument
, /*value_from_file=*/true, /*raw=*/!option_values
.utf8_convert
, &violation
))
752 return usage_error("ERROR: (--tag-from-file) %s\n", violation
);
754 else if(0 == strcmp(long_option
, "no-cued-seekpoints")) {
755 option_values
.cued_seekpoints
= false;
757 else if(0 == strcmp(long_option
, "force-raw-format")) {
758 option_values
.force_raw_format
= true;
760 else if(0 == strcmp(long_option
, "force-aiff-format")) {
761 option_values
.force_aiff_format
= true;
763 else if(0 == strcmp(long_option
, "force-rf64-format")) {
764 option_values
.force_rf64_format
= true;
766 else if(0 == strcmp(long_option
, "force-wave64-format")) {
767 option_values
.force_wave64_format
= true;
769 else if(0 == strcmp(long_option
, "lax")) {
770 option_values
.lax
= true;
772 else if(0 == strcmp(long_option
, "replay-gain")) {
773 option_values
.replay_gain
= true;
775 else if(0 == strcmp(long_option
, "ignore-chunk-sizes")) {
776 option_values
.ignore_chunk_sizes
= true;
778 else if(0 == strcmp(long_option
, "sector-align")) {
779 flac__utils_printf(stderr
, 1, "WARNING: --sector-align is DEPRECATED and may not exist in future versions of flac.\n");
780 flac__utils_printf(stderr
, 1, " shntool provides similar functionality\n");
781 option_values
.sector_align
= true;
784 else if(0 == strcmp(long_option
, "ogg")) {
785 option_values
.use_ogg
= true;
787 else if(0 == strcmp(long_option
, "serial-number")) {
788 option_values
.has_serial_number
= true;
789 option_values
.serial_number
= atol(option_argument
);
792 else if(0 == strcmp(long_option
, "endian")) {
793 FLAC__ASSERT(0 != option_argument
);
794 if(0 == strncmp(option_argument
, "big", strlen(option_argument
)))
795 option_values
.format_is_big_endian
= true;
796 else if(0 == strncmp(option_argument
, "little", strlen(option_argument
)))
797 option_values
.format_is_big_endian
= false;
799 return usage_error("ERROR: argument to --endian must be \"big\" or \"little\"\n");
801 else if(0 == strcmp(long_option
, "channels")) {
802 FLAC__ASSERT(0 != option_argument
);
803 option_values
.format_channels
= atoi(option_argument
);
805 else if(0 == strcmp(long_option
, "bps")) {
806 FLAC__ASSERT(0 != option_argument
);
807 option_values
.format_bps
= atoi(option_argument
);
809 else if(0 == strcmp(long_option
, "sample-rate")) {
810 FLAC__ASSERT(0 != option_argument
);
811 option_values
.format_sample_rate
= atoi(option_argument
);
813 else if(0 == strcmp(long_option
, "sign")) {
814 FLAC__ASSERT(0 != option_argument
);
815 if(0 == strncmp(option_argument
, "signed", strlen(option_argument
)))
816 option_values
.format_is_unsigned_samples
= false;
817 else if(0 == strncmp(option_argument
, "unsigned", strlen(option_argument
)))
818 option_values
.format_is_unsigned_samples
= true;
820 return usage_error("ERROR: argument to --sign must be \"signed\" or \"unsigned\"\n");
822 else if(0 == strcmp(long_option
, "residual-gnuplot")) {
823 option_values
.aopts
.do_residual_gnuplot
= true;
825 else if(0 == strcmp(long_option
, "residual-text")) {
826 option_values
.aopts
.do_residual_text
= true;
831 else if(0 == strcmp(long_option
, "no-preserve-modtime")) {
832 option_values
.preserve_modtime
= false;
834 else if(0 == strcmp(long_option
, "no-decode-through-errors")) {
835 option_values
.continue_through_decode_errors
= false;
837 else if(0 == strcmp(long_option
, "no-silent")) {
838 flac__utils_verbosity_
= 2;
840 else if(0 == strcmp(long_option
, "no-force")) {
841 option_values
.force_file_overwrite
= false;
843 else if(0 == strcmp(long_option
, "no-seektable")) {
844 option_values
.num_requested_seek_points
= 0;
845 option_values
.requested_seek_points
[0] = '\0';
847 else if(0 == strcmp(long_option
, "no-delete-input-file")) {
848 option_values
.delete_input
= false;
850 else if(0 == strcmp(long_option
, "no-keep-foreign-metadata")) {
851 option_values
.keep_foreign_metadata
= false;
853 else if(0 == strcmp(long_option
, "no-replay-gain")) {
854 option_values
.replay_gain
= false;
856 else if(0 == strcmp(long_option
, "no-ignore-chunk-sizes")) {
857 option_values
.ignore_chunk_sizes
= false;
859 else if(0 == strcmp(long_option
, "no-sector-align")) {
860 option_values
.sector_align
= false;
862 else if(0 == strcmp(long_option
, "no-utf8-convert")) {
863 option_values
.utf8_convert
= false;
865 else if(0 == strcmp(long_option
, "no-lax")) {
866 option_values
.lax
= false;
869 else if(0 == strcmp(long_option
, "no-ogg")) {
870 option_values
.use_ogg
= false;
873 else if(0 == strcmp(long_option
, "no-exhaustive-model-search")) {
874 add_compression_setting_bool(CST_DO_EXHAUSTIVE_MODEL_SEARCH
, false);
876 else if(0 == strcmp(long_option
, "no-mid-side")) {
877 add_compression_setting_bool(CST_DO_MID_SIDE
, false);
878 add_compression_setting_bool(CST_LOOSE_MID_SIDE
, false);
880 else if(0 == strcmp(long_option
, "no-adaptive-mid-side")) {
881 add_compression_setting_bool(CST_DO_MID_SIDE
, false);
882 add_compression_setting_bool(CST_LOOSE_MID_SIDE
, false);
884 else if(0 == strcmp(long_option
, "no-qlp-coeff-prec-search")) {
885 add_compression_setting_bool(CST_DO_QLP_COEFF_PREC_SEARCH
, false);
887 else if(0 == strcmp(long_option
, "no-padding")) {
888 option_values
.padding
= 0;
890 else if(0 == strcmp(long_option
, "no-verify")) {
891 option_values
.verify
= false;
893 else if(0 == strcmp(long_option
, "no-warnings-as-errors")) {
894 option_values
.treat_warnings_as_errors
= false;
896 else if(0 == strcmp(long_option
, "no-residual-gnuplot")) {
897 option_values
.aopts
.do_residual_gnuplot
= false;
899 else if(0 == strcmp(long_option
, "no-residual-text")) {
900 option_values
.aopts
.do_residual_text
= false;
902 else if(0 == strcmp(long_option
, "disable-constant-subframes")) {
903 option_values
.debug
.disable_constant_subframes
= true;
905 else if(0 == strcmp(long_option
, "disable-fixed-subframes")) {
906 option_values
.debug
.disable_fixed_subframes
= true;
908 else if(0 == strcmp(long_option
, "disable-verbatim-subframes")) {
909 option_values
.debug
.disable_verbatim_subframes
= true;
911 else if(0 == strcmp(long_option
, "no-md5-sum")) {
912 option_values
.debug
.do_md5
= false;
914 else if(0 == strcmp(long_option
, "no-error-on-compression-fail")) {
915 option_values
.error_on_compression_fail
= false;
917 else if(0 == strcmp(long_option
, "error-on-compression-fail")) {
918 option_values
.error_on_compression_fail
= true;
922 switch(short_option
) {
924 option_values
.show_help
= true;
927 option_values
.show_explain
= true;
930 option_values
.show_version
= true;
933 option_values
.mode_decode
= true;
936 option_values
.mode_decode
= true;
937 option_values
.analyze
= true;
940 option_values
.mode_decode
= true;
941 option_values
.test_only
= true;
944 option_values
.force_to_stdout
= true;
947 flac__utils_verbosity_
= 1;
950 option_values
.force_file_overwrite
= true;
953 FLAC__ASSERT(0 != option_argument
);
954 option_values
.cmdline_forced_outfilename
= option_argument
;
957 option_values
.continue_through_decode_errors
= true;
960 FLAC__ASSERT(0 != option_argument
);
961 if(!flac__vorbiscomment_add(option_values
.vorbis_comment
, option_argument
, /*value_from_file=*/false, /*raw=*/!option_values
.utf8_convert
, &violation
))
962 return usage_error("ERROR: (-T/--tag) %s\n", violation
);
973 add_compression_setting_uint32_t(CST_COMPRESSION_LEVEL
, short_option
-'0');
976 return usage_error("ERROR: compression level '9' is reserved\n");
978 option_values
.verify
= true;
981 option_values
.treat_warnings_as_errors
= true;
984 FLAC__ASSERT(0 != option_argument
);
985 if(0 == strcmp(option_argument
, "-")) {
986 option_values
.num_requested_seek_points
= 0;
987 option_values
.requested_seek_points
[0] = '\0';
990 if(option_values
.num_requested_seek_points
< 0)
991 option_values
.num_requested_seek_points
= 0;
992 option_values
.num_requested_seek_points
++;
993 if(strlen(option_values
.requested_seek_points
)+strlen(option_argument
)+2 >= sizeof(option_values
.requested_seek_points
)) {
994 return usage_error("ERROR: too many seekpoints requested\n");
997 size_t len
= strlen(option_values
.requested_seek_points
);
998 flac_snprintf(option_values
.requested_seek_points
+len
, sizeof(option_values
.requested_seek_points
) - len
, "%s;", option_argument
);
1003 FLAC__ASSERT(0 != option_argument
);
1004 option_values
.padding
= atoi(option_argument
);
1005 if(option_values
.padding
< 0)
1006 return usage_error("ERROR: argument to -%c must be >= 0; for no padding use -%c-\n", short_option
, short_option
);
1011 FLAC__ASSERT(0 != option_argument
);
1012 i
= atoi(option_argument
);
1013 if((i
< (int)FLAC__MIN_BLOCK_SIZE
|| i
> (int)FLAC__MAX_BLOCK_SIZE
))
1014 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
);
1015 add_compression_setting_uint32_t(CST_BLOCKSIZE
, (uint32_t)i
);
1019 add_compression_setting_bool(CST_DO_EXHAUSTIVE_MODEL_SEARCH
, true);
1022 add_compression_setting_bool(CST_DO_ESCAPE_CODING
, true);
1027 FLAC__ASSERT(0 != option_argument
);
1028 i
= atoi(option_argument
);
1029 if(i
> FLAC__MAX_LPC_ORDER
)
1030 return usage_error("ERROR: invalid LPC order (-%c) '%d', must be >= %u and <= %u\n", short_option
, i
, 0, FLAC__MAX_LPC_ORDER
);
1031 add_compression_setting_uint32_t(CST_MAX_LPC_ORDER
, i
);
1035 FLAC__ASSERT(0 != option_argument
);
1036 add_compression_setting_string(CST_APODIZATION
, option_argument
);
1039 add_compression_setting_bool(CST_DO_MID_SIDE
, true);
1040 add_compression_setting_bool(CST_LOOSE_MID_SIDE
, false);
1043 add_compression_setting_bool(CST_DO_MID_SIDE
, true);
1044 add_compression_setting_bool(CST_LOOSE_MID_SIDE
, true);
1047 add_compression_setting_bool(CST_DO_QLP_COEFF_PREC_SEARCH
, true);
1052 FLAC__ASSERT(0 != option_argument
);
1053 i
= atoi(option_argument
);
1054 if((i
> 0 && (i
< FLAC__MIN_QLP_COEFF_PRECISION
|| i
> FLAC__MAX_QLP_COEFF_PRECISION
)))
1055 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
);
1056 add_compression_setting_uint32_t(CST_QLP_COEFF_PRECISION
, i
);
1063 FLAC__ASSERT(0 != option_argument
);
1064 p
= strchr(option_argument
, ',');
1066 add_compression_setting_uint32_t(CST_MIN_RESIDUAL_PARTITION_ORDER
, 0);
1067 i
= atoi(option_argument
);
1068 if(i
> FLAC__MAX_RICE_PARTITION_ORDER
)
1069 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
);
1070 add_compression_setting_uint32_t(CST_MAX_RESIDUAL_PARTITION_ORDER
, i
);
1073 i
= atoi(option_argument
);
1074 if(i
> FLAC__MAX_RICE_PARTITION_ORDER
)
1075 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
);
1076 add_compression_setting_uint32_t(CST_MIN_RESIDUAL_PARTITION_ORDER
, i
);
1078 if(i
> FLAC__MAX_RICE_PARTITION_ORDER
)
1079 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
);
1080 add_compression_setting_uint32_t(CST_MAX_RESIDUAL_PARTITION_ORDER
, i
);
1087 i
= atoi(option_argument
);
1088 add_compression_setting_uint32_t(CST_RICE_PARAMETER_SEARCH_DIST
, i
);
1099 void free_options(void)
1102 if(0 != option_values
.filenames
) {
1103 for(i
= 0; i
< option_values
.num_files
; i
++) {
1104 if(0 != option_values
.filenames
[i
])
1105 free(option_values
.filenames
[i
]);
1107 free(option_values
.filenames
);
1109 if(0 != option_values
.vorbis_comment
)
1110 FLAC__metadata_object_delete(option_values
.vorbis_comment
);
1111 for(i
= 0; i
< option_values
.num_pictures
; i
++)
1112 FLAC__metadata_object_delete(option_values
.pictures
[i
]);
1115 void add_compression_setting_bool(compression_setting_type_t type
, FLAC__bool value
)
1117 if(option_values
.num_compression_settings
>= sizeof(option_values
.compression_settings
)/sizeof(option_values
.compression_settings
[0]))
1118 die("too many compression settings");
1119 option_values
.compression_settings
[option_values
.num_compression_settings
].type
= type
;
1120 option_values
.compression_settings
[option_values
.num_compression_settings
].value
.t_bool
= value
;
1121 option_values
.num_compression_settings
++;
1124 void add_compression_setting_string(compression_setting_type_t type
, const char *value
)
1126 if(option_values
.num_compression_settings
>= sizeof(option_values
.compression_settings
)/sizeof(option_values
.compression_settings
[0]))
1127 die("too many compression settings");
1128 option_values
.compression_settings
[option_values
.num_compression_settings
].type
= type
;
1129 option_values
.compression_settings
[option_values
.num_compression_settings
].value
.t_string
= value
;
1130 option_values
.num_compression_settings
++;
1133 void add_compression_setting_uint32_t(compression_setting_type_t type
, uint32_t value
)
1135 if(option_values
.num_compression_settings
>= sizeof(option_values
.compression_settings
)/sizeof(option_values
.compression_settings
[0]))
1136 die("too many compression settings");
1137 option_values
.compression_settings
[option_values
.num_compression_settings
].type
= type
;
1138 option_values
.compression_settings
[option_values
.num_compression_settings
].value
.t_unsigned
= value
;
1139 option_values
.num_compression_settings
++;
1142 int usage_error(const char *message
, ...)
1144 if(flac__utils_verbosity_
>= 1) {
1147 FLAC__ASSERT(0 != message
);
1149 va_start(args
, message
);
1151 (void) vfprintf(stderr
, message
, args
);
1155 printf("Type \"flac\" for a usage summary or \"flac --help\" for all options\n");
1161 void show_version(void)
1163 printf("flac %s\n", FLAC__VERSION_STRING
);
1166 static void usage_header(void)
1168 printf("===============================================================================\n");
1169 printf("flac - Command-line FLAC encoder/decoder version %s\n", FLAC__VERSION_STRING
);
1170 printf("Copyright (C) 2000-2009 Josh Coalson\n");
1171 printf("Copyright (C) 2011-2016 Xiph.Org Foundation\n");
1173 printf("This program is free software; you can redistribute it and/or\n");
1174 printf("modify it under the terms of the GNU General Public License\n");
1175 printf("as published by the Free Software Foundation; either version 2\n");
1176 printf("of the License, or (at your option) any later version.\n");
1178 printf("This program is distributed in the hope that it will be useful,\n");
1179 printf("but WITHOUT ANY WARRANTY; without even the implied warranty of\n");
1180 printf("MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n");
1181 printf("GNU General Public License for more details.\n");
1183 printf("You should have received a copy of the GNU General Public License along\n");
1184 printf("with this program; if not, write to the Free Software Foundation, Inc.,\n");
1185 printf("51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n");
1186 printf("===============================================================================\n");
1189 static void usage_summary(void)
1193 printf(" Encoding: flac [<general-options>] [<encoding/format-options>] [INPUTFILE [...]]\n");
1194 printf(" Decoding: flac -d [<general-options>] [<format-options>] [FLACFILE [...]]\n");
1195 printf(" Testing: flac -t [<general-options>] [FLACFILE [...]]\n");
1196 printf("Analyzing: flac -a [<general-options>] [<analysis-options>] [FLACFILE [...]]\n");
1198 printf("Be sure to read the list of known bugs at:\n");
1199 printf("http://xiph.org/flac/documentation_bugs.html\n");
1203 void short_usage(void)
1207 printf("This is the short help; for all options use 'flac --help'; for even more\n");
1208 printf("instructions use 'flac --explain'\n");
1210 printf("Be sure to read the list of known bugs at:\n");
1211 printf("http://xiph.org/flac/documentation_bugs.html\n");
1213 printf("To encode:\n");
1214 printf(" flac [-#] [INPUTFILE [...]]\n");
1216 printf(" -# is -0 (fastest compression) to -8 (highest compression); -5 is the default\n");
1218 printf("To decode:\n");
1219 printf(" flac -d [INPUTFILE [...]]\n");
1221 printf("To test:\n");
1222 printf(" flac -t [INPUTFILE [...]]\n");
1225 void show_help(void)
1229 printf("general options:\n");
1230 printf(" -v, --version Show the flac version number\n");
1231 printf(" -h, --help Show this screen\n");
1232 printf(" -H, --explain Show detailed explanation of usage and options\n");
1233 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1234 printf(" -t, --test Same as -d except no decoded file is written\n");
1235 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1236 printf(" -c, --stdout Write output to stdout\n");
1237 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1238 printf(" --totally-silent Do not print anything, including errors\n");
1239 printf(" --no-utf8-convert Do not convert tags from local charset to UTF-8\n");
1240 printf(" -w, --warnings-as-errors Treat all warnings as errors\n");
1241 printf(" -f, --force Force overwriting of output files\n");
1242 printf(" -o, --output-name=FILENAME Force the output file name\n");
1243 printf(" --output-prefix=STRING Prepend STRING to output names\n");
1244 printf(" --delete-input-file Deletes after a successful encode/decode\n");
1245 printf(" --preserve-modtime Output files keep timestamp of input (default)\n");
1246 printf(" --keep-foreign-metadata Save/restore WAVE or AIFF non-audio chunks\n");
1247 printf(" --skip={#|mm:ss.ss} Skip the given initial samples for each input\n");
1248 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample for each input file\n");
1250 printf(" --ogg Use Ogg as transport layer\n");
1251 printf(" --serial-number Serial number to use for the FLAC stream\n");
1253 printf("analysis options:\n");
1254 printf(" --residual-text Include residual signal in text output\n");
1255 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1256 printf("decoding options:\n");
1257 printf(" -F, --decode-through-errors Continue decoding through stream errors\n");
1258 printf(" --cue=[#.#][-[#.#]] Set the beginning and ending cuepoints to decode\n");
1259 printf("encoding options:\n");
1260 printf(" -V, --verify Verify a correct encoding\n");
1261 printf(" --lax Allow encoder to generate non-Subset files\n");
1262 printf(" --ignore-chunk-sizes Ignore data chunk sizes in WAVE/AIFF files\n");
1263 printf(" --sector-align (DEPRECATED) Align multiple files on sector boundaries\n");
1264 printf(" --replay-gain Calculate ReplayGain & store in FLAC tags\n");
1265 printf(" --cuesheet=FILENAME Import cuesheet and store in CUESHEET block\n");
1266 printf(" --picture=SPECIFICATION Import picture and store in PICTURE block\n");
1267 printf(" -T, --tag=FIELD=VALUE Add a FLAC tag; may appear multiple times\n");
1268 printf(" --tag-from-file=FIELD=FILENAME Like --tag but gets value from file\n");
1269 printf(" -S, --seekpoint={#|X|#x|#s} Add seek point(s)\n");
1270 printf(" -P, --padding=# Write a PADDING block of length #\n");
1271 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 3\n");
1272 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 3\n");
1273 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1274 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4096 -r 4\n");
1275 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4096 -M -r 4\n");
1276 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4096 -m -r 5\n");
1277 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4096 -m -r 6\n");
1278 printf(" -A tukey(0.5) -A partial_tukey(2)\n");
1279 printf(" -7, --compression-level-7 Synonymous with -l 12 -b 4096 -m -r 6\n");
1280 printf(" -A tukey(0.5) -A partial_tukey(2)\n");
1281 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4096 -m -r 6\n");
1282 printf(" -A tukey(0.5) -A partial_tukey(2) -A punchout_tukey(3)\n");
1283 printf(" -b, --blocksize=# Specify blocksize in samples\n");
1284 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1285 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1286 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1287 printf(" -A, --apodization=\"function\" Window audio data with given the function\n");
1288 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors\n");
1289 printf(" -p, --qlp-coeff-precision-search Exhaustively search LP coeff quantization\n");
1290 printf(" -q, --qlp-coeff-precision=# Specify precision in bits\n");
1291 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1292 printf("format options:\n");
1293 printf(" --force-raw-format Treat input or output as raw samples\n");
1294 printf(" --force-aiff-format Force decoding to AIFF format\n");
1295 printf(" --force-rf64-format Force decoding to RF64 format\n");
1296 printf(" --force-wave64-format Force decoding to Wave64 format\n");
1297 printf("raw format options:\n");
1298 printf(" --endian={big|little} Set byte order for samples\n");
1299 printf(" --channels=# Number of channels\n");
1300 printf(" --bps=# Number of bits per sample\n");
1301 printf(" --sample-rate=# Sample rate in Hz\n");
1302 printf(" --sign={signed|uint32_t} Sign of samples\n");
1303 printf(" --input-size=# Size of the raw input in bytes\n");
1304 printf("negative options:\n");
1305 printf(" --no-adaptive-mid-side\n");
1306 printf(" --no-cued-seekpoints\n");
1307 printf(" --no-decode-through-errors\n");
1308 printf(" --no-delete-input-file\n");
1309 printf(" --no-error-on-compression-fail\n");
1310 printf(" --no-preserve-modtime\n");
1311 printf(" --no-keep-foreign-metadata\n");
1312 printf(" --no-exhaustive-model-search\n");
1313 printf(" --no-lax\n");
1314 printf(" --no-mid-side\n");
1316 printf(" --no-ogg\n");
1318 printf(" --no-padding\n");
1319 printf(" --no-qlp-coeff-prec-search\n");
1320 printf(" --no-replay-gain\n");
1321 printf(" --no-residual-gnuplot\n");
1322 printf(" --no-residual-text\n");
1323 printf(" --no-ignore-chunk-sizes\n");
1324 printf(" --no-sector-align\n");
1325 printf(" --no-seektable\n");
1326 printf(" --no-silent\n");
1327 printf(" --no-force\n");
1328 printf(" --no-verify\n");
1329 printf(" --no-warnings-as-errors\n");
1332 void show_explain(void)
1336 printf("For encoding:\n");
1337 printf(" The input file(s) may be a PCM WAVE or RF64 file, AIFF (or uncompressed\n");
1338 printf(" AIFF-C) file, or raw samples.\n");
1339 printf(" The output file(s) will be in native FLAC or Ogg FLAC format\n");
1340 printf("For decoding, the reverse is true.\n");
1342 printf("A single INPUTFILE may be - for stdin. No INPUTFILE implies stdin. Use of\n");
1343 printf("stdin implies -c (write to stdout). Normally you should use:\n");
1344 printf(" flac [options] -o outfilename or flac -d [options] -o outfilename\n");
1345 printf("instead of:\n");
1346 printf(" flac [options] > outfilename or flac -d [options] > outfilename\n");
1347 printf("since the former allows flac to seek backwards to write the STREAMINFO or\n");
1348 printf("WAVE/AIFF header contents when necessary.\n");
1350 printf("flac checks for the presence of a AIFF/WAVE header to decide whether or not to\n");
1351 printf("treat an input file as AIFF/WAVE format or raw samples. If any input file is\n");
1352 printf("raw you must specify the format options {-fb|fl} -fc -fp and -fs, which will\n");
1353 printf("apply to all raw files. You can force AIFF/WAVE files to be treated as raw\n");
1354 printf("files using -fr.\n");
1356 printf("general options:\n");
1357 printf(" -v, --version Show the flac version number\n");
1358 printf(" -h, --help Show basic usage a list of all options\n");
1359 printf(" -H, --explain Show this screen\n");
1360 printf(" -d, --decode Decode (the default behavior is to encode)\n");
1361 printf(" -t, --test Same as -d except no decoded file is written\n");
1362 printf(" -a, --analyze Same as -d except an analysis file is written\n");
1363 printf(" -c, --stdout Write output to stdout\n");
1364 printf(" -s, --silent Do not write runtime encode/decode statistics\n");
1365 printf(" --totally-silent Do not print anything of any kind, including\n");
1366 printf(" warnings or errors. The exit code will be the\n");
1367 printf(" only way to determine successful completion.\n");
1368 printf(" --no-utf8-convert Do not convert tags from local charset to UTF-8.\n");
1369 printf(" This is useful for scripts, and setting tags in\n");
1370 printf(" situations where the locale is wrong. This\n");
1371 printf(" option must appear before any tag options!\n");
1372 printf(" -w, --warnings-as-errors Treat all warnings as errors\n");
1373 printf(" -f, --force Force overwriting of output files\n");
1374 printf(" -o, --output-name=FILENAME Force the output file name; usually flac just\n");
1375 printf(" changes the extension. May only be used when\n");
1376 printf(" encoding a single file. May not be used in\n");
1377 printf(" conjunction with --output-prefix.\n");
1378 printf(" --output-prefix=STRING Prefix each output file name with the given\n");
1379 printf(" STRING. This can be useful for encoding or\n");
1380 printf(" decoding files to a different directory. Make\n");
1381 printf(" sure if your STRING is a path name that it ends\n");
1382 printf(" with a '/' slash.\n");
1383 printf(" --delete-input-file Automatically delete the input file after a\n");
1384 printf(" successful encode or decode. If there was an\n");
1385 printf(" error (including a verify error) the input file\n");
1386 printf(" is left intact.\n");
1387 printf(" --preserve-modtime Output files have their timestamps/permissions\n");
1388 printf(" set to match those of their inputs (this is\n");
1389 printf(" default). Use --no-preserve-modtime to make\n");
1390 printf(" output files have the current time and default\n");
1391 printf(" permissions.\n");
1392 printf(" --keep-foreign-metadata If encoding, save WAVE or AIFF non-audio chunks\n");
1393 printf(" in FLAC metadata. If decoding, restore any saved\n");
1394 printf(" non-audio chunks from FLAC metadata when writing\n");
1395 printf(" the decoded file. Foreign metadata cannot be\n");
1396 printf(" transcoded, e.g. WAVE chunks saved in a FLAC file\n");
1397 printf(" cannot be restored when decoding to AIFF. Input\n");
1398 printf(" and output must be regular files, not stdin/out.\n");
1399 printf(" --skip={#|mm:ss.ss} Skip the first # samples of each input file; can\n");
1400 printf(" be used both for encoding and decoding. The\n");
1401 printf(" alternative form mm:ss.ss can be used to specify\n");
1402 printf(" minutes, seconds, and fractions of a second.\n");
1403 printf(" --until={#|[+|-]mm:ss.ss} Stop at the given sample number for each input\n");
1404 printf(" file. The given sample number is not included\n");
1405 printf(" in the decoded output. The alternative form\n");
1406 printf(" mm:ss.ss can be used to specify minutes,\n");
1407 printf(" seconds, and fractions of a second. If a `+'\n");
1408 printf(" sign is at the beginning, the --until point is\n");
1409 printf(" relative to the --skip point. If a `-' sign is\n");
1410 printf(" at the beginning, the --until point is relative\n");
1411 printf(" to end of the audio.\n");
1413 printf(" --ogg When encoding, generate Ogg FLAC output instead\n");
1414 printf(" of native FLAC. Ogg FLAC streams are FLAC\n");
1415 printf(" streams wrapped in an Ogg transport layer. The\n");
1416 printf(" resulting file should have an '.oga' extension\n");
1417 printf(" and will still be decodable by flac. When\n");
1418 printf(" decoding, force the input to be treated as\n");
1419 printf(" Ogg FLAC. This is useful when piping input\n");
1420 printf(" from stdin or when the filename does not end in\n");
1421 printf(" '.oga' or '.ogg'.\n");
1422 printf(" --serial-number Serial number to use for the FLAC stream. When\n");
1423 printf(" encoding and no serial number is given, flac\n");
1424 printf(" uses a random one. If encoding to multiple files\n");
1425 printf(" the serial number is incremented for each file.\n");
1426 printf(" When decoding and no number is given, flac uses\n");
1427 printf(" the serial number of the first page.\n");
1429 printf("analysis options:\n");
1430 printf(" --residual-text Include residual signal in text output. This\n");
1431 printf(" will make the file very big, much larger than\n");
1432 printf(" even the decoded file.\n");
1433 printf(" --residual-gnuplot Generate gnuplot files of residual distribution\n");
1434 printf(" of each subframe\n");
1435 printf("decoding options:\n");
1436 printf(" -F, --decode-through-errors By default flac stops decoding with an error\n");
1437 printf(" and removes the partially decoded file if it\n");
1438 printf(" encounters a bitstream error. With -F, errors\n");
1439 printf(" are still printed but flac will continue\n");
1440 printf(" decoding to completion. Note that errors may\n");
1441 printf(" cause the decoded audio to be missing some\n");
1442 printf(" samples or have silent sections.\n");
1443 printf(" --cue=[#.#][-[#.#]] Set the beginning and ending cuepoints to\n");
1444 printf(" decode. The optional first #.# is the track and\n");
1445 printf(" index point at which decoding will start; the\n");
1446 printf(" default is the beginning of the stream. The\n");
1447 printf(" optional second #.# is the track and index point\n");
1448 printf(" at which decoding will end; the default is the\n");
1449 printf(" end of the stream. If the cuepoint does not\n");
1450 printf(" exist, the closest one before it (for the start\n");
1451 printf(" point) or after it (for the end point) will be\n");
1452 printf(" used. The cuepoints are merely translated into\n");
1453 printf(" sample numbers then used as --skip and --until.\n");
1454 printf(" A CD track can always be cued by, for example,\n");
1455 printf(" --cue=9.1-10.1 for track 9, even if the CD has\n");
1456 printf(" no 10th track.\n");
1457 printf("encoding options:\n");
1458 printf(" -V, --verify Verify a correct encoding by decoding the\n");
1459 printf(" output in parallel and comparing to the\n");
1460 printf(" original\n");
1461 printf(" --lax Allow encoder to generate non-Subset files\n");
1462 printf(" --ignore-chunk-sizes Ignore data chunk sizes in WAVE/AIFF files;\n");
1463 printf(" useful when piping data from programs which\n");
1464 printf(" generate bogus data chunk sizes.\n");
1465 printf(" --sector-align Align encoding of multiple CD format WAVE files\n");
1466 printf(" on sector boundaries. This option is DEPRECATED\n");
1467 printf(" and may not exist in future versions of flac.\n");
1468 printf(" shntool offers similar functionality.\n");
1469 printf(" --replay-gain Calculate ReplayGain values and store them as\n");
1470 printf(" FLAC tags. Title gains/peaks will be computed\n");
1471 printf(" for each file, and an album gain/peak will be\n");
1472 printf(" computed for all files. All input files must\n");
1473 printf(" have the same resolution, sample rate, and\n");
1474 printf(" number of channels. The sample rate must be\n");
1475 printf(" one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1,\n");
1476 printf(" or 48 kHz. NOTE: this option may also leave a\n");
1477 printf(" few extra bytes in the PADDING block.\n");
1478 printf(" --cuesheet=FILENAME Import the given cuesheet file and store it in\n");
1479 printf(" a CUESHEET metadata block. This option may only\n");
1480 printf(" be used when encoding a single file. A\n");
1481 printf(" seekpoint will be added for each index point in\n");
1482 printf(" the cuesheet to the SEEKTABLE unless\n");
1483 printf(" --no-cued-seekpoints is specified.\n");
1484 printf(" --picture=SPECIFICATION Import a picture and store it in a PICTURE block.\n");
1485 printf(" More than one --picture command can be specified.\n");
1486 printf(" The SPECIFICATION can either be a simple filename\n");
1487 printf(" for the picture file, or a complete specification\n");
1488 printf(" whose parts are separated by | characters. Some\n");
1489 printf(" parts may be left empty to invoke default values.\n");
1490 printf(" Using a filename is shorthand for \"||||FILE\".\n");
1491 printf(" The SPECIFICATION format is:\n");
1492 printf(" [TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE\n");
1493 printf(" TYPE is optional; it is a number from one of:\n");
1494 printf(" 0: Other\n");
1495 printf(" 1: 32x32 pixels 'file icon' (PNG only)\n");
1496 printf(" 2: Other file icon\n");
1497 printf(" 3: Cover (front)\n");
1498 printf(" 4: Cover (back)\n");
1499 printf(" 5: Leaflet page\n");
1500 printf(" 6: Media (e.g. label side of CD)\n");
1501 printf(" 7: Lead artist/lead performer/soloist\n");
1502 printf(" 8: Artist/performer\n");
1503 printf(" 9: Conductor\n");
1504 printf(" 10: Band/Orchestra\n");
1505 printf(" 11: Composer\n");
1506 printf(" 12: Lyricist/text writer\n");
1507 printf(" 13: Recording Location\n");
1508 printf(" 14: During recording\n");
1509 printf(" 15: During performance\n");
1510 printf(" 16: Movie/video screen capture\n");
1511 printf(" 17: A bright coloured fish\n");
1512 printf(" 18: Illustration\n");
1513 printf(" 19: Band/artist logotype\n");
1514 printf(" 20: Publisher/Studio logotype\n");
1515 printf(" The default is 3 (front cover). There may only be one picture each\n");
1516 printf(" of type 1 and 2 in a file.\n");
1517 printf(" MIME-TYPE is optional; if left blank, it will be detected from the\n");
1518 printf(" file. For best compatibility with players, use pictures with MIME\n");
1519 printf(" type image/jpeg or image/png. The MIME type can also be --> to\n");
1520 printf(" mean that FILE is actually a URL to an image, though this use is\n");
1521 printf(" discouraged.\n");
1522 printf(" DESCRIPTION is optional; the default is an empty string\n");
1523 printf(" The next part specifies the resolution and color information. If\n");
1524 printf(" the MIME-TYPE is image/jpeg, image/png, or image/gif, you can\n");
1525 printf(" usually leave this empty and they can be detected from the file.\n");
1526 printf(" Otherwise, you must specify the width in pixels, height in pixels,\n");
1527 printf(" and color depth in bits-per-pixel. If the image has indexed colors\n");
1528 printf(" you should also specify the number of colors used.\n");
1529 printf(" FILE is the path to the picture file to be imported, or the URL if\n");
1530 printf(" MIME type is -->\n");
1531 printf(" -T, --tag=FIELD=VALUE Add a FLAC tag. Make sure to quote the\n");
1532 printf(" comment if necessary. This option may appear\n");
1533 printf(" more than once to add several comments. NOTE:\n");
1534 printf(" all tags will be added to all encoded files.\n");
1535 printf(" --tag-from-file=FIELD=FILENAME Like --tag, except FILENAME is a file\n");
1536 printf(" whose contents will be read verbatim to set the\n");
1537 printf(" tag value. The contents will be converted to\n");
1538 printf(" UTF-8 from the local charset. This can be used\n");
1539 printf(" to store a cuesheet in a tag (e.g.\n");
1540 printf(" --tag-from-file=\"CUESHEET=image.cue\"). Do not\n");
1541 printf(" try to store binary data in tag fields! Use\n");
1542 printf(" APPLICATION blocks for that.\n");
1543 printf(" -S, --seekpoint={#|X|#x|#s} Include a point or points in a SEEKTABLE\n");
1544 printf(" # : a specific sample number for a seek point\n");
1545 printf(" X : a placeholder point (always goes at the end of the SEEKTABLE)\n");
1546 printf(" #x : # evenly spaced seekpoints, the first being at sample 0\n");
1547 printf(" #s : a seekpoint every # seconds; # does not have to be a whole number\n");
1548 printf(" You may use many -S options; the resulting SEEKTABLE will be the unique-\n");
1549 printf(" ified union of all such values.\n");
1550 printf(" With no -S options, flac defaults to '-S 10s'. Use -S- for no SEEKTABLE.\n");
1551 printf(" Note: -S #x and -S #s will not work if the encoder can't determine the\n");
1552 printf(" input size before starting.\n");
1553 printf(" Note: if you use -S # and # is >= samples in the input, there will be\n");
1554 printf(" either no seek point entered (if the input size is determinable\n");
1555 printf(" before encoding starts) or a placeholder point (if input size is not\n");
1556 printf(" determinable)\n");
1557 printf(" -P, --padding=# Tell the encoder to write a PADDING metadata\n");
1558 printf(" block of the given length (in bytes) after the\n");
1559 printf(" STREAMINFO block. This is useful if you plan\n");
1560 printf(" to tag the file later with an APPLICATION\n");
1561 printf(" block; instead of having to rewrite the entire\n");
1562 printf(" file later just to insert your block, you can\n");
1563 printf(" write directly over the PADDING block. Note\n");
1564 printf(" that the total length of the PADDING block will\n");
1565 printf(" be 4 bytes longer than the length given because\n");
1566 printf(" of the 4 metadata block header bytes. You can\n");
1567 printf(" force no PADDING block at all to be written with\n");
1568 printf(" --no-padding. The encoder writes a PADDING\n");
1569 printf(" block of 8192 bytes by default, or 65536 bytes\n");
1570 printf(" if the input audio is more than 20 minutes long.\n");
1571 printf(" -b, --blocksize=# Specify the blocksize in samples; the default is\n");
1572 printf(" 1152 for -l 0, else 4096; must be one of 192,\n");
1573 printf(" 576, 1152, 2304, 4608, 256, 512, 1024, 2048,\n");
1574 printf(" 4096 (and 8192 or 16384 if the sample rate is\n");
1575 printf(" >48kHz) for Subset streams.\n");
1576 printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 3\n");
1577 printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 3\n");
1578 printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
1579 printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4096 -r 4\n");
1580 printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4096 -M -r 4\n");
1581 printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4096 -m -r 5\n");
1582 printf(" -5 is the default setting\n");
1583 printf(" -6, --compression-level-6 Synonymous with -l 8 -b 4096 -m -r 6\n");
1584 printf(" -A tukey(0.5) -A partial_tukey(2)\n");
1585 printf(" -7, --compression-level-7 Synonymous with -l 12 -b 4096 -m -r 6\n");
1586 printf(" -A tukey(0.5) -A partial_tukey(2)\n");
1587 printf(" -8, --compression-level-8, --best Synonymous with -l 12 -b 4096 -m -r 6\n");
1588 printf(" -A tukey(0.5) -A partial_tukey(2) -A punchout_tukey(3)\n");
1589 printf(" -m, --mid-side Try mid-side coding for each frame\n");
1590 printf(" (stereo only)\n");
1591 printf(" -M, --adaptive-mid-side Adaptive mid-side coding for all frames\n");
1592 printf(" (stereo only)\n");
1593 printf(" -e, --exhaustive-model-search Do exhaustive model search (expensive!)\n");
1594 printf(" -A, --apodization=\"function\" Window audio data with given the function.\n");
1595 printf(" The functions are: bartlett, bartlett_hann,\n");
1596 printf(" blackman, blackman_harris_4term_92db,\n");
1597 printf(" connes, flattop, gauss(STDDEV), hamming,\n");
1598 printf(" hann, kaiser_bessel, nuttall, rectangle,\n");
1599 printf(" triangle, tukey(P), welch, partial_tukey(n),\n");
1600 printf(" punchout_tukey(n). More than one may be\n");
1601 printf(" specified but encoding time is a multiple of\n");
1602 printf(" the number of functions since they are each\n");
1603 printf(" tried in turn. The encoder chooses suitable\n");
1604 printf(" defaults in the absence of any -A options.\n");
1605 printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors.\n");
1606 printf(" Must be <= 12 for Subset streams if sample\n");
1607 printf(" rate is <=48kHz.\n");
1608 printf(" -p, --qlp-coeff-precision-search Do exhaustive search of LP coefficient\n");
1609 printf(" quantization (expensive!); overrides -q;\n");
1610 printf(" does nothing if using -l 0\n");
1611 printf(" -q, --qlp-coeff-precision=# Specify precision in bits of quantized\n");
1612 printf(" linear-predictor coefficients; 0 => let\n");
1613 printf(" encoder decide (the minimum is %u, the\n", FLAC__MIN_QLP_COEFF_PRECISION
);
1614 printf(" default is -q 0)\n");
1615 printf(" -r, --rice-partition-order=[#,]# Set [min,]max residual partition order\n");
1616 printf(" (# is 0 to 15 inclusive; min defaults to 0;\n");
1617 printf(" the default is -r 0; above 4 does not\n");
1618 printf(" usually help much)\n");
1619 printf("format options:\n");
1620 printf(" --force-raw-format Force input (when encoding) or output (when\n");
1621 printf(" decoding) to be treated as raw samples\n");
1622 printf(" --force-aiff-format Force the decoder to output AIFF format. This\n");
1623 printf(" option is not needed if the output filename (as\n");
1624 printf(" set by -o) ends with .aif or .aiff; this option\n");
1625 printf(" has no effect when encoding since input AIFF is\n");
1626 printf(" auto-detected.\n");
1627 printf(" --force-rf64-format Force the decoder to output RF64 format. This\n");
1628 printf(" option is not needed if the output filename (as\n");
1629 printf(" set by -o) ends with .rf64; this option\n");
1630 printf(" has no effect when encoding since input RF64 is\n");
1631 printf(" auto-detected.\n");
1632 printf(" --force-wave64-format Force the decoder to output Wave64 format. This\n");
1633 printf(" option is not needed if the output filename (as\n");
1634 printf(" set by -o) ends with .w64; this option\n");
1635 printf(" has no effect when encoding since input Wave64 is\n");
1636 printf(" auto-detected.\n");
1637 printf("raw format options:\n");
1638 printf(" --endian={big|little} Set byte order for samples\n");
1639 printf(" --channels=# Number of channels\n");
1640 printf(" --bps=# Number of bits per sample\n");
1641 printf(" --sample-rate=# Sample rate in Hz\n");
1642 printf(" --sign={signed|uint32_t} Sign of samples (the default is signed)\n");
1643 printf(" --input-size=# Size of the raw input in bytes. If you are\n");
1644 printf(" encoding raw samples from stdin, you must set\n");
1645 printf(" this option in order to be able to use --skip,\n");
1646 printf(" --until, --cuesheet, or other options that need\n");
1647 printf(" to know the size of the input beforehand. If\n");
1648 printf(" the size given is greater than what is found in\n");
1649 printf(" the input stream, the encoder will complain\n");
1650 printf(" about an unexpected end-of-file. If the size\n");
1651 printf(" given is less, samples will be truncated.\n");
1652 printf("negative options:\n");
1653 printf(" --no-adaptive-mid-side\n");
1654 printf(" --no-cued-seekpoints\n");
1655 printf(" --no-decode-through-errors\n");
1656 printf(" --no-delete-input-file\n");
1657 printf(" --no-preserve-modtime\n");
1658 printf(" --no-keep-foreign-metadata\n");
1659 printf(" --no-exhaustive-model-search\n");
1660 printf(" --no-lax\n");
1661 printf(" --no-mid-side\n");
1663 printf(" --no-ogg\n");
1665 printf(" --no-padding\n");
1666 printf(" --no-qlp-coeff-prec-search\n");
1667 printf(" --no-residual-gnuplot\n");
1668 printf(" --no-residual-text\n");
1669 printf(" --no-ignore-chunk-sizes\n");
1670 printf(" --no-sector-align\n");
1671 printf(" --no-seektable\n");
1672 printf(" --no-silent\n");
1673 printf(" --no-force\n");
1674 printf(" --no-verify\n");
1675 printf(" --no-warnings-as-errors\n");
1678 void format_mistake(const char *infilename
, FileFormat wrong
, FileFormat right
)
1680 /* WATCHOUT: indexed by FileFormat */
1681 static const char * const ff
[] = { " raw", " WAVE", "n RF64", "n AIFF", "n AIFF-C", " FLAC", "n Ogg FLAC" };
1682 flac__utils_printf(stderr
, 1, "WARNING: %s is not a%s file; treating as a%s file\n", infilename
, ff
[wrong
], ff
[right
]);
1685 int encode_file(const char *infilename
, FLAC__bool is_first_file
, FLAC__bool is_last_file
)
1687 FILE *encode_infile
;
1688 FLAC__byte lookahead
[12];
1689 uint32_t lookahead_length
= 0;
1690 FileFormat input_format
= FORMAT_RAW
;
1692 FLAC__off_t infilesize
;
1693 encode_options_t encode_options
;
1694 const char *outfilename
= get_encoded_outfilename(infilename
); /* the final name of the encoded file */
1695 /* internal_outfilename is the file we will actually write to; it will be a temporary name if infilename==outfilename */
1696 char *internal_outfilename
= 0; /* NULL implies 'use outfilename' */
1697 size_t infilename_length
;
1699 if(0 == outfilename
) {
1700 flac__utils_printf(stderr
, 1, "ERROR: filename too long: %s", infilename
);
1704 if(0 == strcmp(infilename
, "-")) {
1705 infilesize
= (FLAC__off_t
)(-1);
1706 encode_infile
= grabbag__file_get_binary_stdin();
1709 infilesize
= grabbag__file_get_filesize(infilename
);
1710 if(0 == (encode_infile
= flac_fopen(infilename
, "rb"))) {
1711 flac__utils_printf(stderr
, 1, "ERROR: can't open input file %s: %s\n", infilename
, strerror(errno
));
1716 if(!option_values
.force_raw_format
) {
1717 /* first set format based on name */
1718 infilename_length
= strlen(infilename
);
1719 if(infilename_length
>= 4 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-4), ".wav"))
1720 input_format
= FORMAT_WAVE
;
1721 else if(infilename_length
>= 5 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-5), ".rf64"))
1722 input_format
= FORMAT_RF64
;
1723 else if(infilename_length
>= 4 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-4), ".w64"))
1724 input_format
= FORMAT_WAVE64
;
1725 else if(infilename_length
>= 4 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-4), ".aif"))
1726 input_format
= FORMAT_AIFF
;
1727 else if(infilename_length
>= 5 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-5), ".aiff"))
1728 input_format
= FORMAT_AIFF
;
1729 else if(infilename_length
>= 5 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-5), ".flac"))
1730 input_format
= FORMAT_FLAC
;
1731 else if(infilename_length
>= 4 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-4), ".oga"))
1732 input_format
= FORMAT_OGGFLAC
;
1733 else if(infilename_length
>= 4 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-4), ".ogg"))
1734 input_format
= FORMAT_OGGFLAC
;
1736 /* attempt to guess the file type based on the first 12 bytes */
1737 if((lookahead_length
= fread(lookahead
, 1, 12, encode_infile
)) < 12) {
1738 /* all supported non-raw formats have at least 12 bytes of header to read */
1739 if(input_format
!= FORMAT_RAW
) {
1740 format_mistake(infilename
, input_format
, FORMAT_RAW
);
1741 if(option_values
.treat_warnings_as_errors
) {
1742 conditional_fclose(encode_infile
);
1747 input_format
= FORMAT_RAW
;
1750 if(!memcmp(lookahead
, "ID3", 3)) {
1751 flac__utils_printf(stderr
, 1, "ERROR: input file %s has an ID3v2 tag\n", infilename
);
1752 conditional_fclose(encode_infile
);
1755 else if(!memcmp(lookahead
, "RIFF", 4) && !memcmp(lookahead
+8, "WAVE", 4))
1756 input_format
= FORMAT_WAVE
;
1757 else if(!memcmp(lookahead
, "RF64", 4) && !memcmp(lookahead
+8, "WAVE", 4))
1758 input_format
= FORMAT_RF64
;
1759 else if(!memcmp(lookahead
, "riff\x2E\x91\xCF\x11\xA5\xD6\x28\xDB", 12)) /* just check 1st 12 bytes of GUID */
1760 input_format
= FORMAT_WAVE64
;
1761 else if(!memcmp(lookahead
, "FORM", 4) && !memcmp(lookahead
+8, "AIFF", 4))
1762 input_format
= FORMAT_AIFF
;
1763 else if(!memcmp(lookahead
, "FORM", 4) && !memcmp(lookahead
+8, "AIFC", 4))
1764 input_format
= FORMAT_AIFF_C
;
1765 else if(!memcmp(lookahead
, FLAC__STREAM_SYNC_STRING
, sizeof(FLAC__STREAM_SYNC_STRING
)))
1766 input_format
= FORMAT_FLAC
;
1767 /*@@@ this could be made more accurate by looking at the first packet to make sure it's Ogg FLAC and not, say, Ogg Vorbis. we do catch such problems later though. */
1768 else if(!memcmp(lookahead
, "OggS", 4))
1769 input_format
= FORMAT_OGGFLAC
;
1771 /* didn't find header of any supported format */
1772 if(input_format
!= FORMAT_RAW
) {
1773 format_mistake(infilename
, input_format
, FORMAT_RAW
);
1774 if(option_values
.treat_warnings_as_errors
) {
1775 conditional_fclose(encode_infile
);
1780 input_format
= FORMAT_RAW
;
1785 if(option_values
.keep_foreign_metadata
) {
1786 if(encode_infile
== stdin
|| option_values
.force_to_stdout
) {
1787 conditional_fclose(encode_infile
);
1788 return usage_error("ERROR: --keep-foreign-metadata cannot be used when encoding from stdin or to stdout\n");
1790 if(input_format
!= FORMAT_WAVE
&& input_format
!= FORMAT_WAVE64
&& input_format
!= FORMAT_RF64
&& input_format
!= FORMAT_AIFF
&& input_format
!= FORMAT_AIFF_C
) {
1791 conditional_fclose(encode_infile
);
1792 return usage_error("ERROR: --keep-foreign-metadata can only be used with WAVE, Wave64, RF64, or AIFF input\n");
1797 * Error if output file already exists (and -f not used).
1798 * Use grabbag__file_get_filesize() as a cheap way to check.
1800 if(!option_values
.test_only
&& !option_values
.force_file_overwrite
&& strcmp(outfilename
, "-") && grabbag__file_get_filesize(outfilename
) != (FLAC__off_t
)(-1)) {
1801 if(input_format
== FORMAT_FLAC
) {
1802 /* need more detailed error message when re-flac'ing to avoid confusing the user */
1803 flac__utils_printf(stderr
, 1,
1804 "ERROR: output file %s already exists.\n\n"
1805 "By default flac encodes files to FLAC format; if you meant to decode this file\n"
1806 "from FLAC to something else, use -d. If you meant to re-encode this file from\n"
1807 "FLAC to FLAC again, use -f to force writing to the same file, or -o to specify\n"
1808 "a different output filename.\n",
1812 else if(input_format
== FORMAT_OGGFLAC
) {
1813 /* need more detailed error message when re-flac'ing to avoid confusing the user */
1814 flac__utils_printf(stderr
, 1,
1815 "ERROR: output file %s already exists.\n\n"
1816 "By default 'flac -ogg' encodes files to Ogg FLAC format; if you meant to decode\n"
1817 "this file from Ogg FLAC to something else, use -d. If you meant to re-encode\n"
1818 "this file from Ogg FLAC to Ogg FLAC again, use -f to force writing to the same\n"
1819 "file, or -o to specify a different output filename.\n",
1824 flac__utils_printf(stderr
, 1, "ERROR: output file %s already exists, use -f to override\n", outfilename
);
1825 conditional_fclose(encode_infile
);
1829 if(option_values
.format_input_size
>= 0) {
1830 if (input_format
!= FORMAT_RAW
|| infilesize
>= 0) {
1831 flac__utils_printf(stderr
, 1, "ERROR: can only use --input-size when encoding raw samples from stdin\n");
1832 conditional_fclose(encode_infile
);
1836 infilesize
= option_values
.format_input_size
;
1840 if(option_values
.sector_align
&& (input_format
== FORMAT_FLAC
|| input_format
== FORMAT_OGGFLAC
)) {
1841 flac__utils_printf(stderr
, 1, "ERROR: can't use --sector-align when the input file is FLAC or Ogg FLAC\n");
1842 conditional_fclose(encode_infile
);
1845 if(option_values
.sector_align
&& input_format
== FORMAT_RAW
&& infilesize
< 0) {
1846 flac__utils_printf(stderr
, 1, "ERROR: can't use --sector-align when the input size is unknown\n");
1847 conditional_fclose(encode_infile
);
1851 if(input_format
== FORMAT_RAW
) {
1852 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) {
1853 conditional_fclose(encode_infile
);
1854 return usage_error("ERROR: for encoding a raw file you must specify a value for --endian, --sign, --channels, --bps, and --sample-rate\n");
1858 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) {
1859 conditional_fclose(encode_infile
);
1860 return usage_error("ERROR: raw format options (--endian, --sign, --channels, --bps, and --sample-rate) are not allowed for non-raw input\n");
1864 if(option_values
.force_to_stdout
) {
1865 if(option_values
.replay_gain
) {
1866 conditional_fclose(encode_infile
);
1867 return usage_error("ERROR: --replay-gain cannot be used when encoding to stdout\n");
1870 if(option_values
.replay_gain
&& option_values
.use_ogg
) {
1871 conditional_fclose(encode_infile
);
1872 return usage_error("ERROR: --replay-gain cannot be used when encoding to Ogg FLAC yet\n");
1875 if(!flac__utils_parse_skip_until_specification(option_values
.skip_specification
, &encode_options
.skip_specification
) || encode_options
.skip_specification
.is_relative
) {
1876 conditional_fclose(encode_infile
);
1877 return usage_error("ERROR: invalid value for --skip\n");
1880 if(!flac__utils_parse_skip_until_specification(option_values
.until_specification
, &encode_options
.until_specification
)) { /*@@@@ more checks: no + without --skip, no - unless known total_samples_to_{en,de}code */
1881 conditional_fclose(encode_infile
);
1882 return usage_error("ERROR: invalid value for --until\n");
1884 /* if there is no "--until" we want to default to "--until=-0" */
1885 if(0 == option_values
.until_specification
)
1886 encode_options
.until_specification
.is_relative
= true;
1888 encode_options
.verify
= option_values
.verify
;
1889 encode_options
.treat_warnings_as_errors
= option_values
.treat_warnings_as_errors
;
1891 encode_options
.use_ogg
= option_values
.use_ogg
;
1892 /* set a random serial number if one has not yet been specified */
1893 if(!option_values
.has_serial_number
) {
1894 option_values
.serial_number
= rand();
1895 option_values
.has_serial_number
= true;
1897 encode_options
.serial_number
= option_values
.serial_number
++;
1899 encode_options
.lax
= option_values
.lax
;
1900 encode_options
.padding
= option_values
.padding
;
1901 encode_options
.num_compression_settings
= option_values
.num_compression_settings
;
1902 FLAC__ASSERT(sizeof(encode_options
.compression_settings
) >= sizeof(option_values
.compression_settings
));
1903 memcpy(encode_options
.compression_settings
, option_values
.compression_settings
, sizeof(option_values
.compression_settings
));
1904 encode_options
.requested_seek_points
= option_values
.requested_seek_points
;
1905 encode_options
.num_requested_seek_points
= option_values
.num_requested_seek_points
;
1906 encode_options
.cuesheet_filename
= option_values
.cuesheet_filename
;
1907 encode_options
.continue_through_decode_errors
= option_values
.continue_through_decode_errors
;
1908 encode_options
.cued_seekpoints
= option_values
.cued_seekpoints
;
1909 encode_options
.channel_map_none
= option_values
.channel_map_none
;
1910 encode_options
.is_first_file
= is_first_file
;
1911 encode_options
.is_last_file
= is_last_file
;
1912 encode_options
.align_reservoir
= align_reservoir
;
1913 encode_options
.align_reservoir_samples
= &align_reservoir_samples
;
1914 encode_options
.replay_gain
= option_values
.replay_gain
;
1915 encode_options
.ignore_chunk_sizes
= option_values
.ignore_chunk_sizes
;
1916 encode_options
.sector_align
= option_values
.sector_align
;
1917 encode_options
.vorbis_comment
= option_values
.vorbis_comment
;
1918 FLAC__ASSERT(sizeof(encode_options
.pictures
) >= sizeof(option_values
.pictures
));
1919 memcpy(encode_options
.pictures
, option_values
.pictures
, sizeof(option_values
.pictures
));
1920 encode_options
.num_pictures
= option_values
.num_pictures
;
1921 encode_options
.format
= input_format
;
1922 encode_options
.debug
.disable_constant_subframes
= option_values
.debug
.disable_constant_subframes
;
1923 encode_options
.debug
.disable_fixed_subframes
= option_values
.debug
.disable_fixed_subframes
;
1924 encode_options
.debug
.disable_verbatim_subframes
= option_values
.debug
.disable_verbatim_subframes
;
1925 encode_options
.debug
.do_md5
= option_values
.debug
.do_md5
;
1926 encode_options
.error_on_compression_fail
= option_values
.error_on_compression_fail
;
1928 /* if infilename and outfilename point to the same file, we need to write to a temporary file */
1929 if(encode_infile
!= stdin
&& grabbag__file_are_same(infilename
, outfilename
)) {
1930 static const char *tmp_suffix
= ".tmp,fl-ac+en'c";
1931 size_t dest_len
= strlen(outfilename
) + strlen(tmp_suffix
) + 1;
1932 /*@@@@ still a remote possibility that a file with this filename exists */
1933 if((internal_outfilename
= safe_malloc_(dest_len
)) == NULL
) {
1934 flac__utils_printf(stderr
, 1, "ERROR allocating memory for tempfile name\n");
1935 conditional_fclose(encode_infile
);
1938 flac_snprintf(internal_outfilename
, dest_len
, "%s%s", outfilename
, tmp_suffix
);
1941 if(input_format
== FORMAT_RAW
) {
1942 encode_options
.format_options
.raw
.is_big_endian
= option_values
.format_is_big_endian
;
1943 encode_options
.format_options
.raw
.is_unsigned_samples
= option_values
.format_is_unsigned_samples
;
1944 encode_options
.format_options
.raw
.channels
= option_values
.format_channels
;
1945 encode_options
.format_options
.raw
.bps
= option_values
.format_bps
;
1946 encode_options
.format_options
.raw
.sample_rate
= option_values
.format_sample_rate
;
1948 retval
= flac__encode_file(encode_infile
, infilesize
, infilename
, internal_outfilename
? internal_outfilename
: outfilename
, lookahead
, lookahead_length
, encode_options
);
1950 else if(input_format
== FORMAT_FLAC
|| input_format
== FORMAT_OGGFLAC
) {
1951 retval
= flac__encode_file(encode_infile
, infilesize
, infilename
, internal_outfilename
? internal_outfilename
: outfilename
, lookahead
, lookahead_length
, encode_options
);
1953 else if(input_format
== FORMAT_WAVE
|| input_format
== FORMAT_WAVE64
|| input_format
== FORMAT_RF64
|| input_format
== FORMAT_AIFF
|| input_format
== FORMAT_AIFF_C
) {
1954 encode_options
.format_options
.iff
.foreign_metadata
= 0;
1956 /* initialize foreign metadata if requested */
1957 if(option_values
.keep_foreign_metadata
) {
1958 encode_options
.format_options
.iff
.foreign_metadata
=
1959 flac__foreign_metadata_new(
1960 input_format
==FORMAT_WAVE
|| input_format
==FORMAT_RF64
?
1961 FOREIGN_BLOCK_TYPE__RIFF
:
1962 input_format
==FORMAT_WAVE64
?
1963 FOREIGN_BLOCK_TYPE__WAVE64
:
1964 FOREIGN_BLOCK_TYPE__AIFF
1966 if(0 == encode_options
.format_options
.iff
.foreign_metadata
) {
1967 flac__utils_printf(stderr
, 1, "ERROR: creating foreign metadata object\n");
1968 conditional_fclose(encode_infile
);
1969 if(internal_outfilename
!= 0)
1970 free(internal_outfilename
);
1975 retval
= flac__encode_file(encode_infile
, infilesize
, infilename
, internal_outfilename
? internal_outfilename
: outfilename
, lookahead
, lookahead_length
, encode_options
);
1977 if(encode_options
.format_options
.iff
.foreign_metadata
)
1978 flac__foreign_metadata_delete(encode_options
.format_options
.iff
.foreign_metadata
);
1982 retval
= 1; /* double protection */
1986 if(strcmp(outfilename
, "-")) {
1987 if(option_values
.replay_gain
) {
1988 float title_gain
, title_peak
;
1990 grabbag__replaygain_get_title(&title_gain
, &title_peak
);
1992 0 != (error
= grabbag__replaygain_store_to_file_reference(internal_outfilename
? internal_outfilename
: outfilename
, option_values
.preserve_modtime
)) ||
1993 0 != (error
= grabbag__replaygain_store_to_file_title(internal_outfilename
? internal_outfilename
: outfilename
, title_gain
, title_peak
, option_values
.preserve_modtime
))
1995 flac__utils_printf(stderr
, 1, "%s: ERROR writing ReplayGain reference/title tags (%s)\n", outfilename
, error
);
1999 if(option_values
.preserve_modtime
&& strcmp(infilename
, "-"))
2000 grabbag__file_copy_metadata(infilename
, internal_outfilename
? internal_outfilename
: outfilename
);
2004 /* rename temporary file if necessary */
2005 if(retval
== 0 && internal_outfilename
!= 0) {
2006 if(flac_rename(internal_outfilename
, outfilename
) < 0) {
2007 #if defined _MSC_VER || defined __MINGW32__ || defined __EMX__
2008 /* on some flavors of windows, flac_rename() will fail if the destination already exists, so we unlink and try again */
2009 if(flac_unlink(outfilename
) < 0) {
2010 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
);
2013 else if(flac_rename(internal_outfilename
, outfilename
) < 0) {
2014 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
);
2018 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
);
2024 /* handle --delete-input-file, but don't want to delete if piping from stdin, or if input filename and output filename are the same */
2025 if(retval
== 0 && option_values
.delete_input
&& strcmp(infilename
, "-") && internal_outfilename
== 0)
2026 flac_unlink(infilename
);
2028 if(internal_outfilename
!= 0)
2029 free(internal_outfilename
);
2034 int decode_file(const char *infilename
)
2037 FLAC__bool treat_as_ogg
= false;
2038 FileFormat output_format
= FORMAT_WAVE
;
2039 decode_options_t decode_options
;
2040 const char *outfilename
= get_decoded_outfilename(infilename
);
2041 size_t infilename_length
;
2043 if(0 == outfilename
) {
2044 flac__utils_printf(stderr
, 1, "ERROR: filename too long: %s", infilename
);
2049 * Error if output file already exists (and -f not used).
2050 * Use grabbag__file_get_filesize() as a cheap way to check.
2052 if(!option_values
.test_only
&& !option_values
.force_file_overwrite
&& strcmp(outfilename
, "-") && grabbag__file_get_filesize(outfilename
) != (FLAC__off_t
)(-1)) {
2053 flac__utils_printf(stderr
, 1, "ERROR: output file %s already exists, use -f to override\n", outfilename
);
2057 if(option_values
.force_raw_format
)
2058 output_format
= FORMAT_RAW
;
2060 option_values
.force_aiff_format
||
2061 (strlen(outfilename
) >= 4 && 0 == FLAC__STRCASECMP(outfilename
+(strlen(outfilename
)-4), ".aif")) ||
2062 (strlen(outfilename
) >= 5 && 0 == FLAC__STRCASECMP(outfilename
+(strlen(outfilename
)-5), ".aiff"))
2064 output_format
= FORMAT_AIFF
;
2066 option_values
.force_rf64_format
||
2067 (strlen(outfilename
) >= 5 && 0 == FLAC__STRCASECMP(outfilename
+(strlen(outfilename
)-5), ".rf64"))
2069 output_format
= FORMAT_RF64
;
2071 option_values
.force_wave64_format
||
2072 (strlen(outfilename
) >= 4 && 0 == FLAC__STRCASECMP(outfilename
+(strlen(outfilename
)-4), ".w64"))
2074 output_format
= FORMAT_WAVE64
;
2076 output_format
= FORMAT_WAVE
;
2078 if(!option_values
.test_only
&& !option_values
.analyze
) {
2079 if(output_format
== FORMAT_RAW
&& (option_values
.format_is_big_endian
< 0 || option_values
.format_is_unsigned_samples
< 0))
2080 return usage_error("ERROR: for decoding to a raw file you must specify a value for --endian and --sign\n");
2083 if(option_values
.keep_foreign_metadata
) {
2084 if(0 == strcmp(infilename
, "-") || 0 == strcmp(outfilename
, "-"))
2085 return usage_error("ERROR: --keep-foreign-metadata cannot be used when decoding from stdin or to stdout\n");
2086 if(output_format
!= FORMAT_WAVE
&& output_format
!= FORMAT_WAVE64
&& output_format
!= FORMAT_RF64
&& output_format
!= FORMAT_AIFF
&& output_format
!= FORMAT_AIFF_C
)
2087 return usage_error("ERROR: --keep-foreign-metadata can only be used with WAVE, Wave64, RF64, or AIFF output\n");
2090 infilename_length
= strlen(infilename
);
2091 if(option_values
.use_ogg
)
2092 treat_as_ogg
= true;
2093 else if(infilename_length
>= 4 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-4), ".oga"))
2094 treat_as_ogg
= true;
2095 else if(infilename_length
>= 4 && 0 == FLAC__STRCASECMP(infilename
+(infilename_length
-4), ".ogg"))
2096 treat_as_ogg
= true;
2098 treat_as_ogg
= false;
2102 flac__utils_printf(stderr
, 1, "%s: Ogg support has not been built into this copy of flac\n", infilename
);
2107 if(!flac__utils_parse_skip_until_specification(option_values
.skip_specification
, &decode_options
.skip_specification
) || decode_options
.skip_specification
.is_relative
)
2108 return usage_error("ERROR: invalid value for --skip\n");
2110 if(!flac__utils_parse_skip_until_specification(option_values
.until_specification
, &decode_options
.until_specification
)) /*@@@ more checks: no + without --skip, no - unless known total_samples_to_{en,de}code */
2111 return usage_error("ERROR: invalid value for --until\n");
2112 /* if there is no "--until" we want to default to "--until=-0" */
2113 if(0 == option_values
.until_specification
)
2114 decode_options
.until_specification
.is_relative
= true;
2116 if(option_values
.cue_specification
) {
2117 if(!flac__utils_parse_cue_specification(option_values
.cue_specification
, &decode_options
.cue_specification
))
2118 return usage_error("ERROR: invalid value for --cue\n");
2119 decode_options
.has_cue_specification
= true;
2122 decode_options
.has_cue_specification
= false;
2124 decode_options
.treat_warnings_as_errors
= option_values
.treat_warnings_as_errors
;
2125 decode_options
.continue_through_decode_errors
= option_values
.continue_through_decode_errors
;
2126 decode_options
.replaygain_synthesis_spec
= option_values
.replaygain_synthesis_spec
;
2128 decode_options
.is_ogg
= treat_as_ogg
;
2129 decode_options
.use_first_serial_number
= !option_values
.has_serial_number
;
2130 decode_options
.serial_number
= option_values
.serial_number
;
2132 decode_options
.channel_map_none
= option_values
.channel_map_none
;
2133 decode_options
.format
= output_format
;
2135 if(output_format
== FORMAT_RAW
) {
2136 decode_options
.format_options
.raw
.is_big_endian
= option_values
.format_is_big_endian
;
2137 decode_options
.format_options
.raw
.is_unsigned_samples
= option_values
.format_is_unsigned_samples
;
2139 retval
= flac__decode_file(infilename
, option_values
.test_only
? 0 : outfilename
, option_values
.analyze
, option_values
.aopts
, decode_options
);
2142 decode_options
.format_options
.iff
.foreign_metadata
= 0;
2144 /* initialize foreign metadata if requested */
2145 if(option_values
.keep_foreign_metadata
) {
2146 decode_options
.format_options
.iff
.foreign_metadata
=
2147 flac__foreign_metadata_new(
2148 output_format
==FORMAT_WAVE
|| output_format
==FORMAT_RF64
?
2149 FOREIGN_BLOCK_TYPE__RIFF
:
2150 output_format
==FORMAT_WAVE64
?
2151 FOREIGN_BLOCK_TYPE__WAVE64
:
2152 FOREIGN_BLOCK_TYPE__AIFF
2154 if(0 == decode_options
.format_options
.iff
.foreign_metadata
) {
2155 flac__utils_printf(stderr
, 1, "ERROR: creating foreign metadata object\n");
2160 retval
= flac__decode_file(infilename
, option_values
.test_only
? 0 : outfilename
, option_values
.analyze
, option_values
.aopts
, decode_options
);
2162 if(decode_options
.format_options
.iff
.foreign_metadata
)
2163 flac__foreign_metadata_delete(decode_options
.format_options
.iff
.foreign_metadata
);
2166 if(retval
== 0 && strcmp(infilename
, "-")) {
2167 if(option_values
.preserve_modtime
&& strcmp(outfilename
, "-"))
2168 grabbag__file_copy_metadata(infilename
, outfilename
);
2169 if(option_values
.delete_input
&& !option_values
.test_only
&& !option_values
.analyze
)
2170 flac_unlink(infilename
);
2176 const char *get_encoded_outfilename(const char *infilename
)
2178 const char *suffix
= (option_values
.use_ogg
? ".oga" : ".flac");
2181 if(option_values
.output_prefix
) {
2182 p
= grabbag__file_get_basename(infilename
);
2188 return get_outfilename(p
, suffix
);
2191 const char *get_decoded_outfilename(const char *infilename
)
2196 if(option_values
.output_prefix
) {
2197 p
= grabbag__file_get_basename(infilename
);
2203 if(option_values
.analyze
) {
2206 else if(option_values
.force_raw_format
) {
2209 else if(option_values
.force_aiff_format
) {
2212 else if(option_values
.force_rf64_format
) {
2215 else if(option_values
.force_wave64_format
) {
2221 return get_outfilename(p
, suffix
);
2224 const char *get_outfilename(const char *infilename
, const char *suffix
)
2226 if(0 == option_values
.cmdline_forced_outfilename
) {
2227 static char buffer
[4096];
2229 if(0 == strcmp(infilename
, "-") || option_values
.force_to_stdout
) {
2235 if (flac__strlcpy(buffer
, option_values
.output_prefix
? option_values
.output_prefix
: "", sizeof buffer
) >= sizeof buffer
)
2237 if (flac__strlcat(buffer
, infilename
, sizeof buffer
) >= sizeof buffer
)
2239 /* the . must come after any / to avoid problems with, e.g. "some.directory/extensionless-filename" */
2240 if(0 == (p
= strrchr(buffer
, '.')) || strchr(p
, '/')) {
2241 if (flac__strlcat(buffer
, suffix
, sizeof buffer
) >= sizeof buffer
)
2246 if (flac__strlcat(buffer
, suffix
, sizeof buffer
) >= sizeof buffer
)
2253 return option_values
.cmdline_forced_outfilename
;
2256 void die(const char *message
)
2258 FLAC__ASSERT(0 != message
);
2259 flac__utils_printf(stderr
, 1, "ERROR: %s\n", message
);
2263 int conditional_fclose(FILE *f
)
2265 if(f
== 0 || f
== stdin
|| f
== stdout
)
2271 char *local_strdup(const char *source
)
2274 FLAC__ASSERT(0 != source
);
2275 if(0 == (ret
= strdup(source
)))
2276 die("out of memory during strdup()");