1 <!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
3 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4 <!ENTITY dhfirstname "<firstname>Matt</firstname>">
5 <!ENTITY dhsurname "<surname>Zimmerman</surname>">
6 <!-- Please adjust the date whenever revising the manpage. -->
7 <!ENTITY dhdate "<date>July 26, 2003</date>">
8 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
9 allowed: see man(7), man(1). -->
10 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
11 <!ENTITY dhemail "<email>mdz@debian.org</email>">
12 <!ENTITY dhusername "Matt Zimmerman">
13 <!ENTITY dhucpackage "<refentrytitle>FLAC</refentrytitle>">
14 <!ENTITY dhpackage "flac">
16 <!ENTITY debian "<productname>Debian GNU/Linux</productname>">
17 <!ENTITY gnu "<acronym>GNU</acronym>">
30 <year>2002,2003,2004</year>
31 <holder>&dhusername;</holder>
41 <refname>&dhpackage;</refname>
43 <refpurpose>Free Lossless Audio Codec</refpurpose>
47 <command>flac</command>
48 <arg choice=opt><replaceable>options</replaceable></arg>
50 <arg><replaceable>infile.wav</replaceable></arg>
51 <arg><replaceable>infile.aiff</replaceable></arg>
52 <arg><replaceable>infile.raw</replaceable></arg>
57 <command>flac</command>
59 <arg>-d</arg> <arg>--decode</arg>
60 <arg>-t</arg> <arg>--test</arg>
61 <arg>-a</arg> <arg>--analyze</arg>
63 <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
64 <arg choice=opt rep=repeat><replaceable>infile.flac</replaceable></arg>
68 <title>DESCRIPTION</title>
70 <para><command>flac</command> is a command-line tool for
71 encoding, decoding, testing and analyzing FLAC streams.
74 <para>This manual page was originally written for the &debian;
75 distribution because the original program did not have a
80 <title>OPTIONS</title>
82 <para>A summary of options is included below. For a complete
83 description, see the HTML documentation.</para>
86 <title>General Options</title>
90 <term><option>-v</option>, <option>--version</option>
93 <para>Show the flac version number</para>
98 <term><option>-h</option>, <option>--help</option>
101 <para>Show basic usage and a list of all options</para>
106 <term><option>-H</option>, <option>--explain</option>
109 <para>Show detailed explanation of usage and all options</para>
114 <term><option>-d</option>, <option>--decode</option>
117 <para>Decode (the default behavior is to encode)</para>
122 <term><option>-t</option>, <option>--test</option>
125 <para>Test a flac encoded file (same as -d
126 except no decoded file is written)</para>
131 <term><option>-a</option>, <option>--analyze</option>
134 <para>Analyze a FLAC encoded file (same as -d
135 except an analysis file is written)</para>
140 <term><option>-c</option>, <option>--stdout</option>
143 <para>Write output to stdout</para>
148 <term><option>-s</option>, <option>--silent</option>
151 <para>Silent mode (do not write runtime
152 encode/decode statistics to stderr)</para>
157 <term><option>-f</option>, <option>--force</option>
160 <para>Force overwriting of output files. By default,
161 flac warns that the output file already exists and
162 continues to the next file.</para>
167 <term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
169 <para>Force the output file name (usually flac just
170 changes the extension). May only be used when
171 encoding a single file. May not be used in
172 conjunction with --output-prefix.</para>
177 <term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
179 <para>Prefix each output file name with the given
180 string. This can be useful for encoding or decoding
181 files to a different directory. Make sure if your
182 string is a path name that it ends with a trailing
188 <term><option>--delete-input-file</option>
191 <para>Automatically delete the input file after a
192 successful encode or decode. If there was an
193 error (including a verify error) the input file
194 is left intact.</para>
199 <term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
201 <para>Skip over the first number of samples of the input.
202 This works for both encoding and decoding, but not
203 testing. The alternative form mm:ss.ss can be used
204 to specify minutes, seconds, and fractions of a
210 <term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
212 <para>Stop at the given sample number for each input file.
213 This works for both encoding and decoding, but not testing.
214 The given sample number is not included in the decoded
215 output. The alternative form mm:ss.ss can be used to
216 specify minutes, seconds, and fractions of a second. If a
217 `+' (plus) sign is at the beginning, the --until point is
218 relative to the --skip point. If a `-' (minus) sign is at
219 the beginning, the --until point is relative to end of the
225 <term><option>--ogg</option></term>
228 <para>When encoding, generate Ogg-FLAC output instead
229 of native-FLAC. Ogg-FLAC streams are FLAC streams
230 wrapped in an Ogg transport layer. The resulting
231 file should have an '.ogg' extension and will still
232 be decodable by flac.</para>
233 <para>When decoding, force the input to be treated as
234 Ogg-FLAC. This is useful when piping input from
235 stdin or when the filename does not end in '.ogg'.</para>
240 <term><option>--serial-number</option>=<replaceable>#</replaceable></term>
243 <para>When used with --ogg, specifies the serial number to
244 use for the first Ogg FLAC stream, which is then
245 incremented for each additional stream. When encoding and
246 no serial number is given, flac uses a random number for
247 the first stream, then increments it for each additional
248 stream. When decoding and no number is given, flac uses
249 the serial number of the first page.</para>
257 <title>Analysis Options</title>
261 <term><option>--residual-text</option>
264 <para>Includes the residual signal in the analysis
265 file. This will make the file very big, much
266 larger than even the decoded file.</para>
271 <term><option>--residual-gnuplot</option>
274 <para>Generates a gnuplot file for every subframe;
275 each file will contain the residual distribution
276 of the subframe. This will create a lot of
285 <title>Decoding Options</title>
289 <term><option>--cue=[<replaceable>#.#</replaceable>][-[<replaceable>#.#</replaceable>]]</option></term>
291 <para>Set the beginning and ending cuepoints to decode.
292 The optional first #.# is the track and index point at
293 which decoding will start; the default is the beginning
294 of the stream. The optional second #.# is the track
295 and index point at which decoding will end; the default
296 is the end of the stream. If the seekpoint does not
297 exist, the closest one before it (for the start point)
298 or after it (for the end point) will be used. If those
299 don't exist, the start of the stream (for the start
300 point) or end of the stream (for the end point) will be
301 used. The cuepoints are merely translated into sample
302 numbers then used as --skip and --until.</para>
308 <term><option>-F</option>, <option>--decode-through-errors</option>
311 <para>By default flac stops decoding with an error
312 and removes the partially decoded file if it
313 encounters a bitstream error. With -F, errors are
314 still printed but flac will continue decoding to
315 completion. Note that errors may cause the decoded
316 audio to be missing some samples or have silent
325 <title>Encoding Options</title>
329 <term><option>-V</option>, <option>--verify</option></term>
332 <para>Verify a correct encoding by decoding the
333 output in parallel and comparing to the
339 <term><option>--lax</option></term>
342 <para>Allow encoder to generate non-Subset
348 <term><option>--replay-gain</option></term>
351 <para>Calculate ReplayGain values and store in
352 Vorbis comments, similar to vorbisgain. Title
353 gains/peaks will be computed for each input
354 file, and an album gain/peak will be computed
355 for all files. All input files must have the
356 same resolution, sample rate, and number of
357 channels. Only mono and stereo files are
358 allowed, and the sample rate must be one of
359 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48
360 kHz. Also note that this option may leave a
361 few extra bytes in a PADDING block as the exact
362 size of the tags is not known until all files
363 are processed. Note that this option cannot be
364 used when encoding to standard output (stdout).
370 <term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
373 <para>Import the given cuesheet file and store it in a
374 CUESHEET metadata block. This option may only be used
375 when encoding a single file. A seekpoint will be added
376 for each index point in the cuesheet to the SEEKTABLE
377 unless --no-cued-seekpoints is specified.</para>
382 <term><option>--sector-align</option></term>
385 <para>Align encoding of multiple CD format WAVE
386 files on sector boundaries. See the HTML
387 documentation for more information.</para>
392 <term><option>-S</option> {<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}, <option>--seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
396 Include a point or points in a SEEKTABLE. Using #,
397 a seek point at that sample number is added. Using
398 X, a placeholder point is added at the end of a the
399 table. Using #x, # evenly spaced seek points will
400 be added, the first being at sample 0. Using #s, a
401 seekpoint will be added every # seconds (# does not
402 have to be a whole number; it can be, for example, 9.5,
403 meaning a seekpoint every 9.5 seconds). You may use
404 many -S options; the resulting SEEKTABLE will be the
405 unique-ified union of all such values. With no -S
406 options, flac defaults to '-S 10s'. Use --no-seektable
407 for no SEEKTABLE. Note: '-S #x' and '-S #s' will not
408 work if the encoder can't determine the input size before
409 starting. Note: if you use '-S #' and # is >=
410 samples in the input, there will be either no seek
411 point entered (if the input size is determinable
412 before encoding starts) or a placeholder point (if
413 input size is not determinable).</para>
418 <term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
421 <para>Tell the encoder to write a PADDING metadata
422 block of the given length (in bytes) after the
423 STREAMINFO block. This is useful if you plan to
424 tag the file later with an APPLICATION block;
425 instead of having to rewrite the entire file later
426 just to insert your block, you can write directly
427 over the PADDING block. Note that the total length
428 of the PADDING block will be 4 bytes longer than
429 the length given because of the 4 metadata block
430 header bytes. You can force no PADDING block at
431 all to be written with --no-padding. The encoder
432 writes a PADDING block of 4096 bytes by default.
438 <term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
441 <para>Add a Vorbis comment. The comment must adhere
442 to the Vorbis comment spec; i.e. the FIELD must
443 contain only legal characters, terminated by an
444 'equals' sign. Make sure to quote the comment if
445 necessary. This option may appear more than once
446 to add several comments. NOTE: all tags will be
447 added to all encoded files.</para>
452 <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
455 <para>Specify the block size in samples. The
456 default is 1152 for -l 0, else 4608; must be one of
457 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
458 4096, 8192, 16384, or 32768 (unless --lax is used)</para>
463 <term><option>-m</option>, <option>--mid-side</option></term>
466 <para>Try mid-side coding for each frame (stereo
472 <term><option>-M</option>, <option>--adaptive-mid-side</option></term>
475 <para>Adaptive mid-side coding for all frames (stereo
481 <term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
484 <para>Fastest compression..highest compression
485 (default is -5). These are synonyms for other
490 <term><option>-0</option>, <option>--compression-level-0</option></term>
493 <para>Synonymous with -l 0 -b 1152 -r 2,2
499 <term><option>-1</option>, <option>--compression-level-1</option></term>
502 <para>Synonymous with -l 0 -b 1152 -M -r 2,2
508 <term><option>-2</option>, <option>--compression-level-2</option></term>
511 <para>Synonymous with -l 0 -b 1152 -m -r 3
517 <term><option>-3</option>, <option>--compression-level-3</option></term>
520 <para>Synonymous with -l 6 -b 4608 -r 3,3
526 <term><option>-4</option>, <option>--compression-level-4</option></term>
529 <para>Synonymous with -l 8 -b 4608 -M -r 3,3
535 <term><option>-5</option>, <option>--compression-level-5</option></term>
538 <para>Synonymous with -l 8 -b 4608 -m -r 3,3
544 <term><option>-6</option>, <option>--compression-level-6</option></term>
547 <para>Synonymous with -l 8 -b 4608 -m -r 4
553 <term><option>-7</option>, <option>--compression-level-7</option></term>
556 <para>Synonymous with -l 8 -b 4608 -m -e -r 6
562 <term><option>-8</option>, <option>--compression-level-8</option></term>
565 <para>Synonymous with -l 12 -b 4608 -m -e -r 6
576 <term><option>--fast</option></term>
579 <para>Fastest compression. Currently
580 synonymous with -0.</para>
585 <term><option>--best</option></term>
588 <para>Highest compression. Currently
589 synonymous with -8.</para>
594 <term><option>-e</option>, <option>--exhaustive-model-search</option></term>
597 <para>Do exhaustive model search
603 <term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
606 <para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
611 <term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
614 <para>Do exhaustive search of LP coefficient
615 quantization (expensive!). Overrides -q;
616 does nothing if using -l 0</para>
621 <term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
624 <para>Precision of the quantized linear-predictor
625 coefficients, 0 => let encoder decide (min is 5,
631 <term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
634 <para>Set the [min,]max residual partition order
635 (0..16). min defaults to 0 if unspecified. Default
644 <title>Format Options</title>
648 <term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
651 <para>Set the byte order for samples</para>
656 <term><option>--channels</option>=<replaceable>#</replaceable></term>
659 <para>Set number of channels.</para>
664 <term><option>--bps</option>=<replaceable>#</replaceable></term>
667 <para>Set bits per sample.</para>
672 <term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
675 <para>Set sample rate (in Hz).</para>
680 <term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
683 <para>Set the sign of samples (the default is signed).</para>
688 <term><option>--force-aiff-format</option></term>
691 <para>Force the decoder to output AIFF format. This option
692 is not needed if the output filename (as set by -o) ends
693 with <filename>.aiff</filename>. Also, this option has no
694 effect when encoding since input AIFF is auto-detected.</para>
699 <term><option>--force-raw-format</option></term>
702 <para>Force input (when encoding) or output (when decoding)
703 to be treated as raw samples (even if filename ends
704 in <filename>.wav</filename>).</para>
712 <title>Negative Options</title>
716 <term><option>--no-adaptive-mid-side</option></term>
717 <term><option>--no-decode-through-errors</option></term>
718 <term><option>--no-delete-input-file</option></term>
719 <term><option>--no-exhaustive-model-search</option></term>
720 <term><option>--no-lax</option></term>
721 <term><option>--no-mid-side</option></term>
722 <term><option>--no-ogg</option></term>
723 <term><option>--no-padding</option></term>
724 <term><option>--no-qlp-coeff-precision-search</option></term>
725 <term><option>--no-residual-gnuplot</option></term>
726 <term><option>--no-residual-text</option></term>
727 <term><option>--no-sector-align</option></term>
728 <term><option>--no-seektable</option></term>
729 <term><option>--no-silent</option></term>
730 <term><option>--no-verify</option></term>
732 <para>These flags can be used to invert the sense
733 of the corresponding normal option.</para>
742 <title>SEE ALSO</title>
744 <para>metaflac(1).</para>
746 <para>The programs are documented fully by HTML format
747 documentation, available in
748 <filename>/usr/share/doc/flac/html</filename> on
749 &debian; systems.</para>
752 <title>AUTHOR</title>
754 <para>This manual page was written by &dhusername; &dhemail; for
755 the &debian; system (but may be used by others).</para>
757 <!-- <para>Permission is granted to copy, distribute and/or modify
758 this document under the terms of the <acronym>GNU</acronym> Free
759 Documentation License, Version 1.1 or any later version
760 published by the Free Software Foundation; with no Invariant
761 Sections, no Front-Cover Texts and no Back-Cover Texts. A copy
762 of the license can be found under
763 <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
768 <!-- Keep this comment at the end of the file
773 sgml-minimize-attributes:nil
774 sgml-always-quote-attributes:t
777 sgml-parent-document:nil
778 sgml-default-dtd-file:nil
779 sgml-exposed-tags:nil
780 sgml-local-catalogs:nil
781 sgml-local-ecat-files:nil