30
<year>2002,2003,2004,2005</year>
31
<holder>&dhusername;</holder>
30
<year>2002,2003,2004,2005</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>--totally-silent</option>
160
<para>Do not print anything of any kind,
161
including warnings or errors. The exit
162
code will be the only way to determine
163
successful completion.</para>
168
<term><option>-f</option>, <option>--force</option>
171
<para>Force overwriting of output files. By default,
172
flac warns that the output file already exists and
173
continues to the next file.</para>
178
<term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
180
<para>Force the output file name (usually flac just
181
changes the extension). May only be used when
182
encoding a single file. May not be used in
183
conjunction with --output-prefix.</para>
188
<term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
190
<para>Prefix each output file name with the given
191
string. This can be useful for encoding or decoding
192
files to a different directory. Make sure if your
193
string is a path name that it ends with a trailing
199
<term><option>--delete-input-file</option>
202
<para>Automatically delete the input file after a
203
successful encode or decode. If there was an
204
error (including a verify error) the input file
205
is left intact.</para>
210
<term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
212
<para>Skip over the first number of samples of the input.
213
This works for both encoding and decoding, but not
214
testing. The alternative form mm:ss.ss can be used
215
to specify minutes, seconds, and fractions of a
221
<term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
223
<para>Stop at the given sample number for each input file.
224
This works for both encoding and decoding, but not testing.
225
The given sample number is not included in the decoded
226
output. The alternative form mm:ss.ss can be used to
227
specify minutes, seconds, and fractions of a second. If a
228
`+' (plus) sign is at the beginning, the --until point is
229
relative to the --skip point. If a `-' (minus) sign is at
230
the beginning, the --until point is relative to end of the
236
<term><option>--ogg</option></term>
239
<para>When encoding, generate Ogg FLAC output instead
240
of native FLAC. Ogg FLAC streams are FLAC streams
241
wrapped in an Ogg transport layer. The resulting
242
file should have an '.ogg' extension and will still
243
be decodable by flac.</para>
244
<para>When decoding, force the input to be treated as
245
Ogg FLAC. This is useful when piping input from
246
stdin or when the filename does not end in '.ogg'.</para>
251
<term><option>--serial-number</option>=<replaceable>#</replaceable></term>
254
<para>When used with --ogg, specifies the serial number to
255
use for the first Ogg FLAC stream, which is then
256
incremented for each additional stream. When encoding and
257
no serial number is given, flac uses a random number for
258
the first stream, then increments it for each additional
259
stream. When decoding and no number is given, flac uses
260
the serial number of the first page.</para>
268
<title>Analysis Options</title>
272
<term><option>--residual-text</option>
275
<para>Includes the residual signal in the analysis
276
file. This will make the file very big, much
277
larger than even the decoded file.</para>
282
<term><option>--residual-gnuplot</option>
285
<para>Generates a gnuplot file for every subframe;
286
each file will contain the residual distribution
287
of the subframe. This will create a lot of
296
<title>Decoding Options</title>
300
<term><option>--cue=[<replaceable>#.#</replaceable>][-[<replaceable>#.#</replaceable>]]</option></term>
302
<para>Set the beginning and ending cuepoints to decode.
303
The optional first #.# is the track and index point at
304
which decoding will start; the default is the beginning
305
of the stream. The optional second #.# is the track
306
and index point at which decoding will end; the default
307
is the end of the stream. If the cuepoint does not
308
exist, the closest one before it (for the start point)
309
or after it (for the end point) will be used. If those
310
don't exist, the start of the stream (for the start
311
point) or end of the stream (for the end point) will be
312
used. The cuepoints are merely translated into sample
313
numbers then used as --skip and --until.</para>
318
<term><option>-F</option>, <option>--decode-through-errors</option>
321
<para>By default flac stops decoding with an error
322
and removes the partially decoded file if it
323
encounters a bitstream error. With -F, errors are
324
still printed but flac will continue decoding to
325
completion. Note that errors may cause the decoded
326
audio to be missing some samples or have silent
335
<title>Encoding Options</title>
339
<term><option>-V</option>, <option>--verify</option></term>
342
<para>Verify a correct encoding by decoding the
343
output in parallel and comparing to the
349
<term><option>--lax</option></term>
352
<para>Allow encoder to generate non-Subset
353
files. The resulting FLAC file may not be
354
streamable or might have trouble being played
355
in all players (especially hardware devices),
356
so you should only use this option in
357
combination with custom encoding options meant
363
<term><option>--replay-gain</option></term>
366
<para>Calculate ReplayGain values and store in
367
Vorbis comments, similar to vorbisgain. Title
368
gains/peaks will be computed for each input
369
file, and an album gain/peak will be computed
370
for all files. All input files must have the
371
same resolution, sample rate, and number of
372
channels. Only mono and stereo files are
373
allowed, and the sample rate must be one of
374
8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48
375
kHz. Also note that this option may leave a
376
few extra bytes in a PADDING block as the exact
377
size of the tags is not known until all files
378
are processed. Note that this option cannot be
379
used when encoding to standard output (stdout).
385
<term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
388
<para>Import the given cuesheet file and store it in a
389
CUESHEET metadata block. This option may only be used
390
when encoding a single file. A seekpoint will be added
391
for each index point in the cuesheet to the SEEKTABLE
392
unless --no-cued-seekpoints is specified.</para>
397
<term><option>--sector-align</option></term>
400
<para>Align encoding of multiple CD format WAVE
401
files on sector boundaries. See the HTML
402
documentation for more information.</para>
407
<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>
411
Include a point or points in a SEEKTABLE. Using #,
412
a seek point at that sample number is added. Using
413
X, a placeholder point is added at the end of a the
414
table. Using #x, # evenly spaced seek points will
415
be added, the first being at sample 0. Using #s, a
416
seekpoint will be added every # seconds (# does not
417
have to be a whole number; it can be, for example, 9.5,
418
meaning a seekpoint every 9.5 seconds). You may use
419
many -S options; the resulting SEEKTABLE will be the
420
unique-ified union of all such values. With no -S
421
options, flac defaults to '-S 10s'. Use --no-seektable
422
for no SEEKTABLE. Note: '-S #x' and '-S #s' will not
423
work if the encoder can't determine the input size before
424
starting. Note: if you use '-S #' and # is >=
425
samples in the input, there will be either no seek
426
point entered (if the input size is determinable
427
before encoding starts) or a placeholder point (if
428
input size is not determinable).</para>
433
<term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
436
<para>Tell the encoder to write a PADDING metadata
437
block of the given length (in bytes) after the
438
STREAMINFO block. This is useful if you plan to
439
tag the file later with an APPLICATION block;
440
instead of having to rewrite the entire file later
441
just to insert your block, you can write directly
442
over the PADDING block. Note that the total length
443
of the PADDING block will be 4 bytes longer than
444
the length given because of the 4 metadata block
445
header bytes. You can force no PADDING block at
446
all to be written with --no-padding. The encoder
447
writes a PADDING block of 4096 bytes by default.
453
<term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
456
<para>Add a Vorbis comment. The comment must adhere
457
to the Vorbis comment spec; i.e. the FIELD must
458
contain only legal characters, terminated by an
459
'equals' sign. Make sure to quote the comment if
460
necessary. This option may appear more than once
461
to add several comments. NOTE: all tags will be
462
added to all encoded files.</para>
467
<term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
470
<para>Specify the block size in samples. The
471
default is 1152 for -l 0, else 4608; must be one of
472
192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
473
4096, 8192, 16384, or 32768 (unless --lax is used)</para>
478
<term><option>-m</option>, <option>--mid-side</option></term>
481
<para>Try mid-side coding for each frame (stereo
487
<term><option>-M</option>, <option>--adaptive-mid-side</option></term>
490
<para>Adaptive mid-side coding for all frames (stereo
496
<term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
499
<para>Fastest compression..highest compression
500
(default is -5). These are synonyms for other
505
<term><option>-0</option>, <option>--compression-level-0</option></term>
508
<para>Synonymous with -l 0 -b 1152 -r 2,2
514
<term><option>-1</option>, <option>--compression-level-1</option></term>
517
<para>Synonymous with -l 0 -b 1152 -M -r 2,2
523
<term><option>-2</option>, <option>--compression-level-2</option></term>
526
<para>Synonymous with -l 0 -b 1152 -m -r 3
532
<term><option>-3</option>, <option>--compression-level-3</option></term>
535
<para>Synonymous with -l 6 -b 4608 -r 3,3
541
<term><option>-4</option>, <option>--compression-level-4</option></term>
544
<para>Synonymous with -l 8 -b 4608 -M -r 3,3
550
<term><option>-5</option>, <option>--compression-level-5</option></term>
553
<para>Synonymous with -l 8 -b 4608 -m -r 3,3
559
<term><option>-6</option>, <option>--compression-level-6</option></term>
562
<para>Synonymous with -l 8 -b 4608 -m -r 4
568
<term><option>-7</option>, <option>--compression-level-7</option></term>
571
<para>Synonymous with -l 8 -b 4608 -m -e -r 6
577
<term><option>-8</option>, <option>--compression-level-8</option></term>
580
<para>Synonymous with -l 12 -b 4608 -m -e -r 6
591
<term><option>--fast</option></term>
594
<para>Fastest compression. Currently
595
synonymous with -0.</para>
600
<term><option>--best</option></term>
603
<para>Highest compression. Currently
604
synonymous with -8.</para>
609
<term><option>-e</option>, <option>--exhaustive-model-search</option></term>
612
<para>Do exhaustive model search
618
<term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
621
<para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
626
<term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
629
<para>Do exhaustive search of LP coefficient
630
quantization (expensive!). Overrides -q;
631
does nothing if using -l 0</para>
636
<term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
639
<para>Precision of the quantized linear-predictor
640
coefficients, 0 => let encoder decide (min is 5,
646
<term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
649
<para>Set the [min,]max residual partition order
650
(0..16). min defaults to 0 if unspecified. Default
659
<title>Format Options</title>
663
<term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
666
<para>Set the byte order for samples</para>
671
<term><option>--channels</option>=<replaceable>#</replaceable></term>
674
<para>Set number of channels.</para>
679
<term><option>--bps</option>=<replaceable>#</replaceable></term>
682
<para>Set bits per sample.</para>
687
<term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
690
<para>Set sample rate (in Hz).</para>
695
<term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
698
<para>Set the sign of samples (the default is signed).</para>
703
<term><option>--input-size</option>=<replaceable>#</replaceable></term>
706
<para>Specify the size of the raw input in bytes. If you are
707
encoding raw samples from stdin, you must set this option
708
in order to be able to use --skip, --until, --cue-sheet, or
709
other options that need to know the size of the input
710
beforehand. If the size given is greater than what is
711
found in the input stream, the encoder will complain about
712
an unexpected end-of-file. If the size given is less,
713
samples will be truncated.</para>
718
<term><option>--force-aiff-format</option></term>
721
<para>Force the decoder to output AIFF format. This option
722
is not needed if the output filename (as set by -o) ends
723
with <filename>.aiff</filename>. Also, this option has no
724
effect when encoding since input AIFF is auto-detected.</para>
729
<term><option>--force-raw-format</option></term>
732
<para>Force input (when encoding) or output (when decoding)
733
to be treated as raw samples (even if filename ends
734
in <filename>.wav</filename>).</para>
742
<title>Negative Options</title>
746
<term><option>--no-adaptive-mid-side</option></term>
747
<term><option>--no-decode-through-errors</option></term>
748
<term><option>--no-delete-input-file</option></term>
749
<term><option>--no-exhaustive-model-search</option></term>
750
<term><option>--no-lax</option></term>
751
<term><option>--no-mid-side</option></term>
752
<term><option>--no-ogg</option></term>
753
<term><option>--no-padding</option></term>
754
<term><option>--no-qlp-coeff-precision-search</option></term>
755
<term><option>--no-residual-gnuplot</option></term>
756
<term><option>--no-residual-text</option></term>
757
<term><option>--no-sector-align</option></term>
758
<term><option>--no-seektable</option></term>
759
<term><option>--no-silent</option></term>
760
<term><option>--no-verify</option></term>
762
<para>These flags can be used to invert the sense
763
of the corresponding normal option.</para>
772
<title>SEE ALSO</title>
774
<para>metaflac(1).</para>
776
<para>The programs are documented fully by HTML format
777
documentation, available in
778
<filename>/usr/share/doc/flac/html</filename> on
779
&debian; systems.</para>
782
<title>AUTHOR</title>
784
<para>This manual page was written by &dhusername; &dhemail; for
785
the &debian; system (but may be used by others).</para>
787
<!-- <para>Permission is granted to copy, distribute and/or modify
788
this document under the terms of the <acronym>GNU</acronym> Free
789
Documentation License, Version 1.1 or any later version
790
published by the Free Software Foundation; with no Invariant
791
Sections, no Front-Cover Texts and no Back-Cover Texts. A copy
792
of the license can be found under
793
<filename>/usr/share/common-licenses/FDL</filename>.</para> -->
798
<!-- Keep this comment at the end of the file
803
sgml-minimize-attributes:nil
804
sgml-always-quote-attributes:t
807
sgml-parent-document:nil
808
sgml-default-dtd-file:nil
809
sgml-exposed-tags:nil
810
sgml-local-catalogs:nil
811
sgml-local-ecat-files:nil
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>
53
<arg><replaceable>infile.flac</replaceable></arg>
54
<arg><replaceable>infile.ogg</replaceable></arg>
59
<command>flac</command>
61
<arg>-d</arg> <arg>--decode</arg>
62
<arg>-t</arg> <arg>--test</arg>
63
<arg>-a</arg> <arg>--analyze</arg>
65
<arg choice=opt><replaceable>OPTIONS</replaceable></arg>
67
<arg><replaceable>infile.flac</replaceable></arg>
68
<arg><replaceable>infile.ogg</replaceable></arg>
74
<title>DESCRIPTION</title>
76
<para><command>flac</command> is a command-line tool for encoding, decoding, testing and analyzing FLAC streams.</para>
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></term>
92
<para>Show the flac version number</para>
97
<term><option>-h</option>, <option>--help</option>
100
<para>Show basic usage and a list of all options</para>
105
<term><option>-H</option>, <option>--explain</option>
108
<para>Show detailed explanation of usage and all options</para>
113
<term><option>-d</option>, <option>--decode</option>
116
<para>Decode (the default behavior is to encode)</para>
121
<term><option>-t</option>, <option>--test</option>
124
<para>Test a flac encoded file (same as -d except no decoded file is written)</para>
129
<term><option>-a</option>, <option>--analyze</option>
132
<para>Analyze a FLAC encoded file (same as -d except an analysis file is written)</para>
137
<term><option>-c</option>, <option>--stdout</option>
140
<para>Write output to stdout</para>
145
<term><option>-s</option>, <option>--silent</option>
148
<para>Silent mode (do not write runtime encode/decode statistics to stderr)</para>
153
<term><option>--totally-silent</option>
156
<para>Do not print anything of any kind, including warnings or errors. The exit code will be the only way to determine successful completion.</para>
161
<term><option>-w</option>, <option>--warnings-as-errors</option>
164
<para>Treat all warnings as errors (which cause flac to terminate with a non-zero exit code).</para>
169
<term><option>-f</option>, <option>--force</option>
172
<para>Force overwriting of output files. By default, flac warns that the output file already exists and continues to the next file.</para>
177
<term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
179
<para>Force the output file name (usually flac just changes the extension). May only be used when encoding a single file. May not be used in conjunction with --output-prefix.</para>
184
<term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
186
<para>Prefix each output file name with the given string. This can be useful for encoding or decoding files to a different directory. Make sure if your string is a path name that it ends with a trailing `/' (slash).</para>
191
<term><option>--delete-input-file</option>
194
<para>Automatically delete the input file after a successful encode or decode. If there was an error (including a verify error) the input file 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. This works for both encoding and decoding, but not testing. The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second.</para>
206
<term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
208
<para>Stop at the given sample number for each input file. This works for both encoding and decoding, but not testing. The given sample number is not included in the decoded output. The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second. If a `+' (plus) sign is at the beginning, the --until point is relative to the --skip point. If a `-' (minus) sign is at the beginning, the --until point is relative to end of the audio.</para>
213
<term><option>--ogg</option></term>
216
<para>When encoding, generate Ogg FLAC output instead of native FLAC. Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer. The resulting file should have an '.ogg' extension and will still be decodable by flac.</para>
217
<para>When decoding, force the input to be treated as Ogg FLAC. This is useful when piping input from stdin or when the filename does not end in '.ogg'.</para>
222
<term><option>--serial-number</option>=<replaceable>#</replaceable></term>
225
<para>When used with --ogg, specifies the serial number to use for the first Ogg FLAC stream, which is then incremented for each additional stream. When encoding and no serial number is given, flac uses a random number for the first stream, then increments it for each additional stream. When decoding and no number is given, flac uses the serial number of the first page.</para>
233
<title>Analysis Options</title>
237
<term><option>--residual-text</option>
240
<para>Includes the residual signal in the analysis file. This will make the file very big, much larger than even the decoded file.</para>
245
<term><option>--residual-gnuplot</option>
248
<para>Generates a gnuplot file for every subframe; each file will contain the residual distribution of the subframe. This will create a lot of files.</para>
256
<title>Decoding Options</title>
260
<term><option>--cue=[<replaceable>#.#</replaceable>][-[<replaceable>#.#</replaceable>]]</option></term>
262
<para>Set the beginning and ending cuepoints to decode. The optional first #.# is the track and index point at which decoding will start; the default is the beginning of the stream. The optional second #.# is the track and index point at which decoding will end; the default is the end of the stream. If the cuepoint does not exist, the closest one before it (for the start point) or after it (for the end point) will be used. If those don't exist, the start of the stream (for the start point) or end of the stream (for the end point) will be used. The cuepoints are merely translated into sample numbers then used as --skip and --until. A CD track can always be cued by, for example, --cue=9.1-10.1 for track 9, even if the CD has no 10th track.</para>
267
<term><option>-F</option>, <option>--decode-through-errors</option>
270
<para>By default flac stops decoding with an error and removes the partially decoded file if it encounters a bitstream error. With -F, errors are still printed but flac will continue decoding to completion. Note that errors may cause the decoded audio to be missing some samples or have silent sections.</para>
278
<title>Encoding Options</title>
282
<term><option>-V</option>, <option>--verify</option></term>
285
<para>Verify a correct encoding by decoding the output in parallel and comparing to the original</para>
290
<term><option>--lax</option></term>
293
<para>Allow encoder to generate non-Subset files. The resulting FLAC file may not be streamable or might have trouble being played in all players (especially hardware devices), so you should only use this option in combination with custom encoding options meant for archival.</para>
298
<term><option>--replay-gain</option></term>
301
<para>Calculate ReplayGain values and store them as FLAC tags, similar to vorbisgain. Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files. All input files must have the same resolution, sample rate, and number of channels. Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. Also note that this option may leave a few extra bytes in a PADDING block as the exact size of the tags is not known until all files are processed. Note that this option cannot be used when encoding to standard output (stdout).</para>
306
<term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
309
<para>Import the given cuesheet file and store it in a CUESHEET metadata block. This option may only be used when encoding a single file. A seekpoint will be added for each index point in the cuesheet to the SEEKTABLE unless --no-cued-seekpoints is specified.</para>
314
<term><option>--picture</option>={<replaceable>FILENAME</replaceable>|<replaceable>SPECIFICATION</replaceable>}</term>
317
<para>Import a picture and store it in a PICTURE metadata block. More than one --picture command can be specified. Either a filename for the picture file or a more complete specification form can be used. The SPECIFICATION is a string whose parts are separated by | (pipe) characters. Some parts may be left empty to invoke default values. FILENAME is just shorthand for "||||FILENAME". The format of SPECIFICATION is</para>
318
<para>[TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</para>
319
<para>TYPE is optional; it is a number from one of:</para>
320
<para>0: Other</para>
321
<para>1: 32x32 pixels 'file icon' (PNG only)</para>
322
<para>2: Other file icon</para>
323
<para>3: Cover (front)</para>
324
<para>4: Cover (back)</para>
325
<para>5: Leaflet page</para>
326
<para>6: Media (e.g. label side of CD)</para>
327
<para>7: Lead artist/lead performer/soloist</para>
328
<para>8: Artist/performer</para>
329
<para>9: Conductor</para>
330
<para>10: Band/Orchestra</para>
331
<para>11: Composer</para>
332
<para>12: Lyricist/text writer</para>
333
<para>13: Recording Location</para>
334
<para>14: During recording</para>
335
<para>15: During performance</para>
336
<para>16: Movie/video screen capture</para>
337
<para>17: A bright coloured fish</para>
338
<para>18: Illustration</para>
339
<para>19: Band/artist logotype</para>
340
<para>20: Publisher/Studio logotype</para>
341
<para>The default is 3 (front cover). There may only be one picture each of type 1 and 2 in a file.</para>
343
<para>MIME-TYPE is optional; if left blank, it will be detected from the file. For best compatibility with players, use pictures with MIME type image/jpeg or image/png. The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.</para>
345
<para>DESCRIPTION is optional; the default is an empty string.</para>
347
<para>The next part specfies the resolution and color information. If the MIME-TYPE is image/jpeg, image/png, or image/gif, you can usually leave this empty and they can be detected from the file. Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel. If the image has indexed colors you should also specify the number of colors used. When manually specified, it is not checked against the file for accuracy.</para>
349
<para>FILE is the path to the picture file to be imported, or the URL if MIME type is --></para>
351
<para>For example, "|image/jpeg|||../cover.jpg" will embed the JPEG file at ../cover.jpg, defaulting to type 3 (front cover) and an empty description. The resolution and color info will be retrieved from the file itself.</para>
353
<para>The specification "4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff" will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors. The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block.</para>
358
<term><option>--sector-align</option></term>
361
<para>Align encoding of multiple CD format files on sector boundaries. See the HTML documentation for more information.</para>
366
<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>
369
<para>Include a point or points in a SEEKTABLE. Using #, a seek point at that sample number is added. Using X, a placeholder point is added at the end of a the table. Using #x, # evenly spaced seek points will be added, the first being at sample 0. Using #s, a seekpoint will be added every # seconds (# does not have to be a whole number; it can be, for example, 9.5, meaning a seekpoint every 9.5 seconds). You may use many -S options; the resulting SEEKTABLE will be the unique-ified union of all such values. With no -S options, flac defaults to '-S 10s'. Use --no-seektable for no SEEKTABLE. Note: '-S #x' and '-S #s' will not work if the encoder can't determine the input size before starting. Note: if you use '-S #' and # is >= samples in the input, there will be either no seek point entered (if the input size is determinable before encoding starts) or a placeholder point (if input size is not determinable).</para>
374
<term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
377
<para>Tell the encoder to write a PADDING metadata block of the given length (in bytes) after the STREAMINFO block. This is useful if you plan to tag the file later with an APPLICATION block; instead of having to rewrite the entire file later just to insert your block, you can write directly over the PADDING block. Note that the total length of the PADDING block will be 4 bytes longer than the length given because of the 4 metadata block header bytes. You can force no PADDING block at all to be written with --no-padding. The encoder writes a PADDING block of 8192 bytes by default (or 65536 bytes if the input audio stream is more that 20 minutes long).</para>
382
<term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
385
<para>Add a FLAC tag. The comment must adhere to the Vorbis comment spec; i.e. the FIELD must contain only legal characters, terminated by an 'equals' sign. Make sure to quote the comment if necessary. This option may appear more than once to add several comments. NOTE: all tags will be added to all encoded files.</para>
390
<term><option>--tag-from-file</option>=<replaceable>FIELD=FILENAME</replaceable></term>
393
<para>Like --tag, except FILENAME is a file whose contents will be read verbatim to set the tag value. The contents will be converted to UTF-8 from the local charset. This can be used to store a cuesheet in a tag (e.g. --tag-from-file="CUESHEET=image.cue"). Do not try to store binary data in tag fields! Use APPLICATION blocks for that.</para>
398
<term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
401
<para>Specify the block size in samples. Subset streams must use one of 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048, 4096 (and 8192 or 16384 if the sample rate is >48kHz).</para>
406
<term><option>-m</option>, <option>--mid-side</option></term>
409
<para>Try mid-side coding for each frame (stereo input only)</para>
414
<term><option>-M</option>, <option>--adaptive-mid-side</option></term>
417
<para>Adaptive mid-side coding for all frames (stereo input only)</para>
422
<term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
425
<para>Fastest compression..highest compression (default is -5). These are synonyms for other options:</para>
429
<term><option>-0</option>, <option>--compression-level-0</option></term>
432
<para>Synonymous with -l 0 -b 1152 -r 3</para>
437
<term><option>-1</option>, <option>--compression-level-1</option></term>
440
<para>Synonymous with -l 0 -b 1152 -M -r 3</para>
445
<term><option>-2</option>, <option>--compression-level-2</option></term>
448
<para>Synonymous with -l 0 -b 1152 -m -r 3</para>
453
<term><option>-3</option>, <option>--compression-level-3</option></term>
456
<para>Synonymous with -l 6 -b 4096 -r 4</para>
461
<term><option>-4</option>, <option>--compression-level-4</option></term>
464
<para>Synonymous with -l 8 -b 4096 -M -r 4</para>
469
<term><option>-5</option>, <option>--compression-level-5</option></term>
472
<para>Synonymous with -l 8 -b 4096 -m -r 5</para>
477
<term><option>-6</option>, <option>--compression-level-6</option></term>
480
<para>Synonymous with -l 8 -b 4096 -m -r 6</para>
485
<term><option>-7</option>, <option>--compression-level-7</option></term>
488
<para>Synonymous with -l 8 -b 4096 -m -e -r 6</para>
493
<term><option>-8</option>, <option>--compression-level-8</option></term>
496
<para>Synonymous with -l 12 -b 4096 -m -e -r 6</para>
506
<term><option>--fast</option></term>
509
<para>Fastest compression. Currently synonymous with -0.</para>
514
<term><option>--best</option></term>
517
<para>Highest compression. Currently synonymous with -8.</para>
522
<term><option>-e</option>, <option>--exhaustive-model-search</option></term>
525
<para>Do exhaustive model search (expensive!)</para>
530
<term><option>-A</option> <replaceable>function</replaceable>, <option>--apodization</option>=<replaceable>function</replaceable></term>
533
<para>Window audio data with given the apodization function. The functions are: bartlett, bartlett_hann, blackman, blackman_harris_4term_92db, connes, flattop, gauss(STDDEV), hamming, hann, kaiser_bessel, nuttall, rectangle, triangle, tukey(P), welch.</para>
534
<para>For gauss(STDDEV), STDDEV is the standard deviation (0<STDDEV<=0.5).</para>
535
<para>For tukey(P), P specifies the fraction of the window that is tapered (0<=P<=1; P=0 corresponds to "rectangle" and P=1 corresponds to "hann").</para>
536
<para>More than one -A option (up to 32) may be used. Any function that is specified erroneously is silently dropped. The encoder chooses suitable defaults in the absence of any -A options; any -A option specified replaces the default(s).</para>
537
<para>When more than one function is specified, then for every subframe the encoder will try each of them separately and choose the window that results in the smallest compressed subframe. Multiple functions can greatly increase the encoding time.</para>
542
<term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
545
<para>Specifies the maximum LPC order. This number must be <= 32. For Subset streams, it must be <=12 if the sample rate is <=48kHz. If 0, the encoder will not attempt generic linear prediction, and use only fixed predictors. Using fixed predictors is faster but usually results in files being 5-10% larger.</para>
550
<term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
553
<para>Do exhaustive search of LP coefficient quantization (expensive!). Overrides -q; does nothing if using -l 0</para>
558
<term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
561
<para>Precision of the quantized linear-predictor coefficients, 0 => let encoder decide (min is 5, default is 0)</para>
566
<term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
569
<para>Set the [min,]max residual partition order (0..16). min defaults to 0 if unspecified. Default is -r 5.</para>
577
<title>Format Options</title>
581
<term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
584
<para>Set the byte order for samples</para>
589
<term><option>--channels</option>=<replaceable>#</replaceable></term>
592
<para>Set number of channels.</para>
597
<term><option>--bps</option>=<replaceable>#</replaceable></term>
600
<para>Set bits per sample.</para>
605
<term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
608
<para>Set sample rate (in Hz).</para>
613
<term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
616
<para>Set the sign of samples (the default is signed).</para>
621
<term><option>--input-size</option>=<replaceable>#</replaceable></term>
624
<para>Specify the size of the raw input in bytes. If you are encoding raw samples from stdin, you must set this option in order to be able to use --skip, --until, --cue-sheet, or other options that need to know the size of the input beforehand. If the size given is greater than what is found in the input stream, the encoder will complain about an unexpected end-of-file. If the size given is less, samples will be truncated.</para>
629
<term><option>--force-aiff-format</option></term>
632
<para>Force the decoder to output AIFF format. This option is not needed if the output filename (as set by -o) ends with <filename>.aiff</filename>. Also, this option has no effect when encoding since input AIFF is auto-detected.</para>
637
<term><option>--force-raw-format</option></term>
640
<para>Force input (when encoding) or output (when decoding) to be treated as raw samples (even if filename ends in <filename>.wav</filename>).</para>
648
<title>Negative Options</title>
652
<term><option>--no-adaptive-mid-side</option></term>
653
<term><option>--no-decode-through-errors</option></term>
654
<term><option>--no-delete-input-file</option></term>
655
<term><option>--no-exhaustive-model-search</option></term>
656
<term><option>--no-lax</option></term>
657
<term><option>--no-mid-side</option></term>
658
<term><option>--no-ogg</option></term>
659
<term><option>--no-padding</option></term>
660
<term><option>--no-qlp-coeff-precision-search</option></term>
661
<term><option>--no-residual-gnuplot</option></term>
662
<term><option>--no-residual-text</option></term>
663
<term><option>--no-sector-align</option></term>
664
<term><option>--no-seektable</option></term>
665
<term><option>--no-silent</option></term>
666
<term><option>--no-verify</option></term>
667
<term><option>--no-warnings-as-errors</option></term>
669
<para>These flags can be used to invert the sense of the corresponding normal option.</para>
678
<title>SEE ALSO</title>
680
<para>metaflac(1).</para>
682
<para>The programs are documented fully by HTML format documentation, available in <filename>/usr/share/doc/flac/html</filename> on &debian; systems.</para>
685
<title>AUTHOR</title>
687
<para>This manual page was written by &dhusername; &dhemail; for the &debian; system (but may be used by others).</para>
689
<!-- <para>Permission is granted to copy, distribute and/or modify this document under the terms of the <acronym>GNU</acronym> Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license can be found under <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
694
<!-- Keep this comment at the end of the file
699
sgml-minimize-attributes:nil
700
sgml-always-quote-attributes:t
703
sgml-parent-document:nil
704
sgml-default-dtd-file:nil
705
sgml-exposed-tags:nil
706
sgml-local-catalogs:nil
707
sgml-local-ecat-files:nil
added
removed
man/flac.sgml
