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>-F</option>, <option>--decode-through-errors</option>
292 <para>By default flac stops decoding with an error
293 and removes the partially decoded file if it
294 encounters a bitstream error. With -F, errors are
295 still printed but flac will continue decoding to
296 completion. Note that errors may cause the decoded
297 audio to be missing some samples or have silent
306 <title>Encoding Options</title>
310 <term><option>-V</option>, <option>--verify</option></term>
313 <para>Verify a correct encoding by decoding the
314 output in parallel and comparing to the
320 <term><option>--lax</option></term>
323 <para>Allow encoder to generate non-Subset
329 <term><option>--replay-gain</option></term>
332 <para>Calculate ReplayGain values and store in
333 Vorbis comments, similar to vorbisgain. Title
334 gains/peaks will be computed for each input
335 file, and an album gain/peak will be computed
336 for all files. All input files must have the
337 same resolution, sample rate, and number of
338 channels. Only mono and stereo files are
339 allowed, and the sample rate must be one of
340 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48
341 kHz. Also note that this option may leave a
342 few extra bytes in a PADDING block as the exact
343 size of the tags is not known until all files
344 are processed. Note that this option cannot be
345 used when encoding to standard output (stdout).
351 <term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
354 <para>Import the given cuesheet file and store it in a
355 CUESHEET metadata block. This option may only be used
356 when encoding a single file. A seekpoint will be added
357 for each index point in the cuesheet to the SEEKTABLE
358 unless --no-cued-seekpoints is specified.</para>
363 <term><option>--sector-align</option></term>
366 <para>Align encoding of multiple CD format WAVE
367 files on sector boundaries. See the HTML
368 documentation for more information.</para>
373 <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>
377 Include a point or points in a SEEKTABLE. Using #,
378 a seek point at that sample number is added. Using
379 X, a placeholder point is added at the end of a the
380 table. Using #x, # evenly spaced seek points will
381 be added, the first being at sample 0. Using #s, a
382 seekpoint will be added every # seconds (# does not
383 have to be a whole number; it can be, for example, 9.5,
384 meaning a seekpoint every 9.5 seconds). You may use
385 many -S options; the resulting SEEKTABLE will be the
386 unique-ified union of all such values. With no -S
387 options, flac defaults to '-S 10s'. Use --no-seektable
388 for no SEEKTABLE. Note: '-S #x' and '-S #s' will not
389 work if the encoder can't determine the input size before
390 starting. Note: if you use '-S #' and # is >=
391 samples in the input, there will be either no seek
392 point entered (if the input size is determinable
393 before encoding starts) or a placeholder point (if
394 input size is not determinable).</para>
399 <term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
402 <para>Tell the encoder to write a PADDING metadata
403 block of the given length (in bytes) after the
404 STREAMINFO block. This is useful if you plan to
405 tag the file later with an APPLICATION block;
406 instead of having to rewrite the entire file later
407 just to insert your block, you can write directly
408 over the PADDING block. Note that the total length
409 of the PADDING block will be 4 bytes longer than
410 the length given because of the 4 metadata block
411 header bytes. You can force no PADDING block at
412 all to be written with --no-padding. The encoder
413 writes a PADDING block of 4096 bytes by default.
419 <term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
422 <para>Add a Vorbis comment. The comment must adhere
423 to the Vorbis comment spec; i.e. the FIELD must
424 contain only legal characters, terminated by an
425 'equals' sign. Make sure to quote the comment if
426 necessary. This option may appear more than once
427 to add several comments. NOTE: all tags will be
428 added to all encoded files.</para>
433 <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
436 <para>Specify the block size in samples. The
437 default is 1152 for -l 0, else 4608; must be one of
438 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
439 4096, 8192, 16384, or 32768 (unless --lax is used)</para>
444 <term><option>-m</option>, <option>--mid-side</option></term>
447 <para>Try mid-side coding for each frame (stereo
453 <term><option>-M</option>, <option>--adaptive-mid-side</option></term>
456 <para>Adaptive mid-side coding for all frames (stereo
462 <term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
465 <para>Fastest compression..highest compression
466 (default is -5). These are synonyms for other
471 <term><option>-0</option>, <option>--compression-level-0</option></term>
474 <para>Synonymous with -l 0 -b 1152 -r 2,2
480 <term><option>-1</option>, <option>--compression-level-1</option></term>
483 <para>Synonymous with -l 0 -b 1152 -M -r 2,2
489 <term><option>-2</option>, <option>--compression-level-2</option></term>
492 <para>Synonymous with -l 0 -b 1152 -m -r 3
498 <term><option>-3</option>, <option>--compression-level-3</option></term>
501 <para>Synonymous with -l 6 -b 4608 -r 3,3
507 <term><option>-4</option>, <option>--compression-level-4</option></term>
510 <para>Synonymous with -l 8 -b 4608 -M -r 3,3
516 <term><option>-5</option>, <option>--compression-level-5</option></term>
519 <para>Synonymous with -l 8 -b 4608 -m -r 3,3
525 <term><option>-6</option>, <option>--compression-level-6</option></term>
528 <para>Synonymous with -l 8 -b 4608 -m -r 4
534 <term><option>-7</option>, <option>--compression-level-7</option></term>
537 <para>Synonymous with -l 8 -b 4608 -m -e -r 6
543 <term><option>-8</option>, <option>--compression-level-8</option></term>
546 <para>Synonymous with -l 12 -b 4608 -m -e -r 6
557 <term><option>--fast</option></term>
560 <para>Fastest compression. Currently
561 synonymous with -0.</para>
566 <term><option>--best</option></term>
569 <para>Highest compression. Currently
570 synonymous with -8.</para>
575 <term><option>-e</option>, <option>--exhaustive-model-search</option></term>
578 <para>Do exhaustive model search
584 <term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
587 <para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
592 <term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
595 <para>Do exhaustive search of LP coefficient
596 quantization (expensive!). Overrides -q;
597 does nothing if using -l 0</para>
602 <term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
605 <para>Precision of the quantized linear-predictor
606 coefficients, 0 => let encoder decide (min is 5,
612 <term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
615 <para>Set the [min,]max residual partition order
616 (0..16). min defaults to 0 if unspecified. Default
625 <title>Format Options</title>
629 <term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
632 <para>Set the byte order for samples</para>
637 <term><option>--channels</option>=<replaceable>#</replaceable></term>
640 <para>Set number of channels.</para>
645 <term><option>--bps</option>=<replaceable>#</replaceable></term>
648 <para>Set bits per sample.</para>
653 <term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
656 <para>Set sample rate (in Hz).</para>
661 <term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
664 <para>Set the sign of samples (the default is signed).</para>
669 <term><option>--force-aiff-format</option></term>
672 <para>Force the decoder to output AIFF format. This option
673 is not needed if the output filename (as set by -o) ends
674 with <filename>.aiff</filename>. Also, this option has no
675 effect when encoding since input AIFF is auto-detected.</para>
680 <term><option>--force-raw-format</option></term>
683 <para>Force input (when encoding) or output (when decoding)
684 to be treated as raw samples (even if filename ends
685 in <filename>.wav</filename>).</para>
693 <title>Negative Options</title>
697 <term><option>--no-adaptive-mid-side</option></term>
698 <term><option>--no-decode-through-errors</option></term>
699 <term><option>--no-delete-input-file</option></term>
700 <term><option>--no-exhaustive-model-search</option></term>
701 <term><option>--no-lax</option></term>
702 <term><option>--no-mid-side</option></term>
703 <term><option>--no-ogg</option></term>
704 <term><option>--no-padding</option></term>
705 <term><option>--no-qlp-coeff-precision-search</option></term>
706 <term><option>--no-residual-gnuplot</option></term>
707 <term><option>--no-residual-text</option></term>
708 <term><option>--no-sector-align</option></term>
709 <term><option>--no-seektable</option></term>
710 <term><option>--no-silent</option></term>
711 <term><option>--no-verify</option></term>
713 <para>These flags can be used to invert the sense
714 of the corresponding normal option.</para>
723 <title>SEE ALSO</title>
725 <para>metaflac(1).</para>
727 <para>The programs are documented fully by HTML format
728 documentation, available in
729 <filename>/usr/share/doc/flac/html</filename> on
730 &debian; systems.</para>
733 <title>AUTHOR</title>
735 <para>This manual page was written by &dhusername; &dhemail; for
736 the &debian; system (but may be used by others).</para>
738 <!-- <para>Permission is granted to copy, distribute and/or modify
739 this document under the terms of the <acronym>GNU</acronym> Free
740 Documentation License, Version 1.1 or any later version
741 published by the Free Software Foundation; with no Invariant
742 Sections, no Front-Cover Texts and no Back-Cover Texts. A copy
743 of the license can be found under
744 <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
749 <!-- Keep this comment at the end of the file
754 sgml-minimize-attributes:nil
755 sgml-always-quote-attributes:t
758 sgml-parent-document:nil
759 sgml-default-dtd-file:nil
760 sgml-exposed-tags:nil
761 sgml-local-catalogs:nil
762 sgml-local-ecat-files:nil