man/flac.sgml

   1 <!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2
   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>Nov 4, 2006</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">
  15
  16   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  17   <!ENTITY gnu         "<acronym>GNU</acronym>">
  18 ]>
  19
  20 <refentry>
  21   <docinfo>
  22     <address>
  23       &dhemail;
  24     </address>
  25     <author>
  26       &dhfirstname;
  27       &dhsurname;
  28     </author>
  29     <copyright>
  30       <year>2002,2003,2004,2005</year>
  31       <holder>&dhusername;</holder>
  32     </copyright>
  33     &dhdate;
  34   </docinfo>
  35   <refmeta>
  36     &dhucpackage;
  37
  38     &dhsection;
  39   </refmeta>
  40   <refnamediv>
  41     <refname>&dhpackage;</refname>
  42
  43     <refpurpose>Free Lossless Audio Codec</refpurpose>
  44   </refnamediv>
  45   <refsynopsisdiv>
  46     <cmdsynopsis>
  47       <command>flac</command>
  48       <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
  49       <group rep=repeat>
  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.oga</replaceable></arg>
  55         <arg><replaceable>infile.ogg</replaceable></arg>
  56         <arg>-</arg>
  57       </group>
  58     </cmdsynopsis>
  59     <cmdsynopsis>
  60       <command>flac</command>
  61       <group>
  62         <arg>-d</arg> <arg>--decode</arg>
  63         <arg>-t</arg> <arg>--test</arg>
  64         <arg>-a</arg> <arg>--analyze</arg>
  65       </group>
  66       <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
  67       <group rep=repeat>
  68         <arg><replaceable>infile.flac</replaceable></arg>
  69         <arg><replaceable>infile.oga</replaceable></arg>
  70         <arg><replaceable>infile.ogg</replaceable></arg>
  71         <arg>-</arg>
  72       </group>
  73     </cmdsynopsis>
  74   </refsynopsisdiv>
  75   <refsect1>
  76     <title>DESCRIPTION</title>
  77
  78     <para><command>flac</command> is a command-line tool for encoding, decoding, testing and analyzing FLAC streams.</para>
  79
  80   </refsect1>
  81   <refsect1>
  82     <title>OPTIONS</title>
  83
  84     <para>A summary of options is included below.  For a complete
  85     description, see the HTML documentation.</para>
  86
  87     <refsect2>
  88       <title>General Options</title>
  89
  90       <variablelist>
  91         <varlistentry>
  92           <term><option>-v</option>, <option>--version</option></term>
  93           <listitem>
  94             <para>Show the flac version number</para>
  95           </listitem>
  96         </varlistentry>
  97
  98         <varlistentry>
  99           <term><option>-h</option>, <option>--help</option>
 100           </term>
 101           <listitem>
 102             <para>Show basic usage and a list of all options</para>
 103           </listitem>
 104         </varlistentry>
 105
 106         <varlistentry>
 107           <term><option>-H</option>, <option>--explain</option>
 108           </term>
 109           <listitem>
 110             <para>Show detailed explanation of usage and all options</para>
 111           </listitem>
 112         </varlistentry>
 113
 114         <varlistentry>
 115           <term><option>-d</option>, <option>--decode</option>
 116           </term>
 117           <listitem>
 118             <para>Decode (the default behavior is to encode)</para>
 119           </listitem>
 120         </varlistentry>
 121
 122         <varlistentry>
 123           <term><option>-t</option>, <option>--test</option>
 124           </term>
 125           <listitem>
 126             <para>Test a flac encoded file (same as -d except no decoded file is written)</para>
 127           </listitem>
 128         </varlistentry>
 129
 130         <varlistentry>
 131           <term><option>-a</option>, <option>--analyze</option>
 132           </term>
 133           <listitem>
 134             <para>Analyze a FLAC encoded file (same as -d except an analysis file is written)</para>
 135           </listitem>
 136         </varlistentry>
 137
 138         <varlistentry>
 139           <term><option>-c</option>, <option>--stdout</option>
 140           </term>
 141           <listitem>
 142             <para>Write output to stdout</para>
 143           </listitem>
 144         </varlistentry>
 145
 146         <varlistentry>
 147           <term><option>-s</option>, <option>--silent</option>
 148           </term>
 149           <listitem>
 150             <para>Silent mode (do not write runtime encode/decode statistics to stderr)</para>
 151           </listitem>
 152         </varlistentry>
 153
 154         <varlistentry>
 155           <term><option>--totally-silent</option>
 156           </term>
 157           <listitem>
 158             <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>
 159           </listitem>
 160         </varlistentry>
 161
 162         <varlistentry>
 163           <term><option>--no-utf8-convert</option>
 164           </term>
 165           <listitem>
 166             <para>Do not convert tags from local charset to UTF-8.  This is useful for scripts, and setting tags in situations where the locale is wrong.  This option must appear before any tag options!</para>
 167           </listitem>
 168         </varlistentry>
 169
 170         <varlistentry>
 171           <term><option>-w</option>, <option>--warnings-as-errors</option>
 172           </term>
 173           <listitem>
 174             <para>Treat all warnings as errors (which cause flac to terminate with a non-zero exit code).</para>
 175           </listitem>
 176         </varlistentry>
 177
 178         <varlistentry>
 179           <term><option>-f</option>, <option>--force</option>
 180           </term>
 181           <listitem>
 182             <para>Force overwriting of output files.  By default, flac warns that the output file already exists and continues to the next file.</para>
 183           </listitem>
 184         </varlistentry>
 185
 186         <varlistentry>
 187           <term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
 188           <listitem>
 189             <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>
 190           </listitem>
 191         </varlistentry>
 192
 193         <varlistentry>
 194           <term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
 195           <listitem>
 196             <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>
 197           </listitem>
 198         </varlistentry>
 199
 200         <varlistentry>
 201           <term><option>--delete-input-file</option>
 202           </term>
 203           <listitem>
 204             <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>
 205           </listitem>
 206         </varlistentry>
 207
 208         <varlistentry>
 209           <term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
 210           <listitem>
 211             <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>
 212           </listitem>
 213         </varlistentry>
 214
 215         <varlistentry>
 216           <term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
 217           <listitem>
 218             <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>
 219           </listitem>
 220         </varlistentry>
 221
 222         <varlistentry>
 223           <term><option>--ogg</option></term>
 224
 225           <listitem>
 226             <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 '.oga' extension and will still be decodable by flac.</para>
 227             <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 '.oga' or '.ogg'.</para>
 228           </listitem>
 229         </varlistentry>
 230
 231         <varlistentry>
 232           <term><option>--serial-number</option>=<replaceable>#</replaceable></term>
 233
 234           <listitem>
 235             <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>
 236           </listitem>
 237         </varlistentry>
 238
 239       </variablelist>
 240     </refsect2>
 241
 242     <refsect2>
 243       <title>Analysis Options</title>
 244
 245       <variablelist>
 246         <varlistentry>
 247           <term><option>--residual-text</option>
 248           </term>
 249           <listitem>
 250             <para>Includes the residual signal in the analysis file.  This will make the file very big, much larger than even the decoded file.</para>
 251           </listitem>
 252         </varlistentry>
 253
 254         <varlistentry>
 255           <term><option>--residual-gnuplot</option>
 256           </term>
 257           <listitem>
 258             <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>
 259           </listitem>
 260         </varlistentry>
 261
 262       </variablelist>
 263     </refsect2>
 264
 265     <refsect2>
 266       <title>Decoding Options</title>
 267
 268       <variablelist>
 269         <varlistentry>
 270           <term><option>--cue=[<replaceable>#.#</replaceable>][-[<replaceable>#.#</replaceable>]]</option></term>
 271           <listitem>
 272             <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>
 273           </listitem>
 274         </varlistentry>
 275
 276         <varlistentry>
 277           <term><option>-F</option>, <option>--decode-through-errors</option>
 278           </term>
 279           <listitem>
 280             <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>
 281           </listitem>
 282         </varlistentry>
 283
 284       </variablelist>
 285     </refsect2>
 286
 287     <refsect2>
 288       <title>Encoding Options</title>
 289
 290       <variablelist>
 291         <varlistentry>
 292           <term><option>-V</option>, <option>--verify</option></term>
 293
 294           <listitem>
 295             <para>Verify a correct encoding by decoding the output in parallel and comparing to the original</para>
 296           </listitem>
 297         </varlistentry>
 298
 299         <varlistentry>
 300           <term><option>--lax</option></term>
 301
 302           <listitem>
 303             <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>
 304           </listitem>
 305         </varlistentry>
 306
 307         <varlistentry>
 308           <term><option>--replay-gain</option></term>
 309
 310           <listitem>
 311             <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>
 312           </listitem>
 313         </varlistentry>
 314
 315         <varlistentry>
 316           <term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
 317
 318           <listitem>
 319             <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>
 320           </listitem>
 321         </varlistentry>
 322
 323         <varlistentry>
 324           <term><option>--picture</option>={<replaceable>FILENAME</replaceable>|<replaceable>SPECIFICATION</replaceable>}</term>
 325
 326           <listitem>
 327             <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>
 328             <para>[TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</para>
 329             <para>TYPE is optional; it is a number from one of:</para>
 330             <para>0: Other</para>
 331             <para>1: 32x32 pixels 'file icon' (PNG only)</para>
 332             <para>2: Other file icon</para>
 333             <para>3: Cover (front)</para>
 334             <para>4: Cover (back)</para>
 335             <para>5: Leaflet page</para>
 336             <para>6: Media (e.g. label side of CD)</para>
 337             <para>7: Lead artist/lead performer/soloist</para>
 338             <para>8: Artist/performer</para>
 339             <para>9: Conductor</para>
 340             <para>10: Band/Orchestra</para>
 341             <para>11: Composer</para>
 342             <para>12: Lyricist/text writer</para>
 343             <para>13: Recording Location</para>
 344             <para>14: During recording</para>
 345             <para>15: During performance</para>
 346             <para>16: Movie/video screen capture</para>
 347             <para>17: A bright coloured fish</para>
 348             <para>18: Illustration</para>
 349             <para>19: Band/artist logotype</para>
 350             <para>20: Publisher/Studio logotype</para>
 351             <para>The default is 3 (front cover).  There may only be one picture each of type 1 and 2 in a file.</para>
 352
 353             <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 --&gt; to mean that FILE is actually a URL to an image, though this use is discouraged.</para>
 354
 355             <para>DESCRIPTION is optional; the default is an empty string.</para>
 356
 357             <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>
 358
 359             <para>FILE is the path to the picture file to be imported, or the URL if MIME type is --&gt;</para>
 360
 361             <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>
 362
 363             <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>
 364           </listitem>
 365         </varlistentry>
 366
 367         <varlistentry>
 368           <term><option>--sector-align</option></term>
 369
 370           <listitem>
 371             <para>Align encoding of multiple CD format files on sector boundaries.  See the HTML documentation for more information.</para>
 372           </listitem>
 373         </varlistentry>
 374
 375         <varlistentry>
 376           <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
 378           <listitem>
 379             <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>
 380           </listitem>
 381         </varlistentry>
 382
 383         <varlistentry>
 384           <term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
 385
 386           <listitem>
 387             <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>
 388           </listitem>
 389         </varlistentry>
 390
 391         <varlistentry>
 392           <term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
 393
 394           <listitem>
 395             <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>
 396           </listitem>
 397         </varlistentry>
 398
 399         <varlistentry>
 400           <term><option>--tag-from-file</option>=<replaceable>FIELD=FILENAME</replaceable></term>
 401
 402           <listitem>
 403             <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>
 404           </listitem>
 405         </varlistentry>
 406
 407         <varlistentry>
 408           <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
 409
 410           <listitem>
 411             <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 &gt;48kHz).</para>
 412           </listitem>
 413         </varlistentry>
 414
 415         <varlistentry>
 416           <term><option>-m</option>, <option>--mid-side</option></term>
 417
 418           <listitem>
 419             <para>Try mid-side coding for each frame (stereo input only)</para>
 420           </listitem>
 421         </varlistentry>
 422
 423         <varlistentry>
 424           <term><option>-M</option>, <option>--adaptive-mid-side</option></term>
 425
 426           <listitem>
 427             <para>Adaptive mid-side coding for all frames (stereo input only)</para>
 428           </listitem>
 429         </varlistentry>
 430
 431         <varlistentry>
 432           <term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
 433
 434           <listitem>
 435             <para>Fastest compression..highest compression (default is -5).  These are synonyms for other options:</para>
 436
 437             <variablelist>
 438               <varlistentry>
 439                 <term><option>-0</option>, <option>--compression-level-0</option></term>
 440
 441                 <listitem>
 442                   <para>Synonymous with -l 0 -b 1152 -r 3</para>
 443                 </listitem>
 444               </varlistentry>
 445
 446               <varlistentry>
 447                 <term><option>-1</option>, <option>--compression-level-1</option></term>
 448
 449                 <listitem>
 450                   <para>Synonymous with -l 0 -b 1152 -M -r 3</para>
 451                 </listitem>
 452               </varlistentry>
 453
 454               <varlistentry>
 455                 <term><option>-2</option>, <option>--compression-level-2</option></term>
 456
 457                 <listitem>
 458                   <para>Synonymous with -l 0 -b 1152 -m -r 3</para>
 459                 </listitem>
 460               </varlistentry>
 461
 462               <varlistentry>
 463                 <term><option>-3</option>, <option>--compression-level-3</option></term>
 464
 465                 <listitem>
 466                   <para>Synonymous with -l 6 -b 4096 -r 4</para>
 467                 </listitem>
 468               </varlistentry>
 469
 470               <varlistentry>
 471                 <term><option>-4</option>, <option>--compression-level-4</option></term>
 472
 473                 <listitem>
 474                   <para>Synonymous with -l 8 -b 4096 -M -r 4</para>
 475                 </listitem>
 476               </varlistentry>
 477
 478               <varlistentry>
 479                 <term><option>-5</option>, <option>--compression-level-5</option></term>
 480
 481                 <listitem>
 482                   <para>Synonymous with -l 8 -b 4096 -m -r 5</para>
 483                 </listitem>
 484               </varlistentry>
 485
 486               <varlistentry>
 487                 <term><option>-6</option>, <option>--compression-level-6</option></term>
 488
 489                 <listitem>
 490                   <para>Synonymous with -l 8 -b 4096 -m -r 6</para>
 491                 </listitem>
 492               </varlistentry>
 493
 494               <varlistentry>
 495                 <term><option>-7</option>, <option>--compression-level-7</option></term>
 496
 497                 <listitem>
 498                   <para>Synonymous with -l 8 -b 4096 -m -e -r 6</para>
 499                 </listitem>
 500               </varlistentry>
 501
 502               <varlistentry>
 503                 <term><option>-8</option>, <option>--compression-level-8</option></term>
 504
 505                 <listitem>
 506                   <para>Synonymous with -l 12 -b 4096 -m -e -r 6</para>
 507                 </listitem>
 508               </varlistentry>
 509             </variablelist>
 510
 511           </listitem>
 512
 513         </varlistentry>
 514
 515         <varlistentry>
 516           <term><option>--fast</option></term>
 517
 518           <listitem>
 519             <para>Fastest compression.  Currently synonymous with -0.</para>
 520           </listitem>
 521         </varlistentry>
 522
 523         <varlistentry>
 524           <term><option>--best</option></term>
 525
 526           <listitem>
 527             <para>Highest compression.  Currently synonymous with -8.</para>
 528           </listitem>
 529         </varlistentry>
 530
 531         <varlistentry>
 532           <term><option>-e</option>, <option>--exhaustive-model-search</option></term>
 533
 534           <listitem>
 535             <para>Do exhaustive model search (expensive!)</para>
 536           </listitem>
 537         </varlistentry>
 538
 539         <varlistentry>
 540           <term><option>-A</option> <replaceable>function</replaceable>, <option>--apodization</option>=<replaceable>function</replaceable></term>
 541
 542           <listitem>
 543             <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>
 544             <para>For gauss(STDDEV), STDDEV is the standard deviation (0&lt;STDDEV&lt;=0.5).</para>
 545             <para>For tukey(P), P specifies the fraction of the window that is tapered (0&lt;=P&lt;=1; P=0 corresponds to "rectangle" and P=1 corresponds to "hann").</para>
 546             <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>
 547             <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>
 548           </listitem>
 549         </varlistentry>
 550
 551         <varlistentry>
 552           <term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
 553
 554           <listitem>
 555             <para>Specifies the maximum LPC order. This number must be &lt;= 32. For Subset streams, it must be &lt;=12 if the sample rate is &lt;=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>
 556           </listitem>
 557         </varlistentry>
 558
 559         <varlistentry>
 560           <term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
 561
 562           <listitem>
 563             <para>Do exhaustive search of LP coefficient quantization (expensive!).  Overrides -q; does nothing if using -l 0</para>
 564           </listitem>
 565         </varlistentry>
 566
 567         <varlistentry>
 568           <term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
 569
 570           <listitem>
 571             <para>Precision of the quantized linear-predictor coefficients, 0 => let encoder decide (min is 5, default is 0)</para>
 572           </listitem>
 573         </varlistentry>
 574
 575         <varlistentry>
 576           <term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
 577
 578           <listitem>
 579             <para>Set the [min,]max residual partition order (0..16). min defaults to 0 if unspecified.  Default is -r 5.</para>
 580           </listitem>
 581         </varlistentry>
 582
 583       </variablelist>
 584
 585     </refsect2>
 586     <refsect2>
 587       <title>Format Options</title>
 588
 589       <variablelist>
 590         <varlistentry>
 591           <term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
 592
 593           <listitem>
 594             <para>Set the byte order for samples</para>
 595           </listitem>
 596         </varlistentry>
 597
 598         <varlistentry>
 599           <term><option>--channels</option>=<replaceable>#</replaceable></term>
 600
 601           <listitem>
 602             <para>Set number of channels.</para>
 603           </listitem>
 604         </varlistentry>
 605
 606         <varlistentry>
 607           <term><option>--bps</option>=<replaceable>#</replaceable></term>
 608
 609           <listitem>
 610             <para>Set bits per sample.</para>
 611           </listitem>
 612         </varlistentry>
 613
 614         <varlistentry>
 615           <term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
 616
 617           <listitem>
 618             <para>Set sample rate (in Hz).</para>
 619           </listitem>
 620         </varlistentry>
 621
 622         <varlistentry>
 623           <term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
 624
 625           <listitem>
 626             <para>Set the sign of samples (the default is signed).</para>
 627           </listitem>
 628         </varlistentry>
 629
 630         <varlistentry>
 631           <term><option>--input-size</option>=<replaceable>#</replaceable></term>
 632
 633           <listitem>
 634             <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>
 635           </listitem>
 636         </varlistentry>
 637
 638         <varlistentry>
 639           <term><option>--force-aiff-format</option></term>
 640
 641           <listitem>
 642             <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>
 643           </listitem>
 644         </varlistentry>
 645
 646         <varlistentry>
 647           <term><option>--force-raw-format</option></term>
 648
 649           <listitem>
 650             <para>Force input (when encoding) or output (when decoding) to be treated as raw samples (even if filename ends in <filename>.wav</filename>).</para>
 651           </listitem>
 652         </varlistentry>
 653
 654       </variablelist>
 655     </refsect2>
 656
 657     <refsect2>
 658       <title>Negative Options</title>
 659
 660       <variablelist>
 661         <varlistentry>
 662           <term><option>--no-adaptive-mid-side</option></term>
 663           <term><option>--no-decode-through-errors</option></term>
 664           <term><option>--no-delete-input-file</option></term>
 665           <term><option>--no-exhaustive-model-search</option></term>
 666           <term><option>--no-lax</option></term>
 667           <term><option>--no-mid-side</option></term>
 668           <term><option>--no-ogg</option></term>
 669           <term><option>--no-padding</option></term>
 670           <term><option>--no-qlp-coeff-precision-search</option></term>
 671           <term><option>--no-residual-gnuplot</option></term>
 672           <term><option>--no-residual-text</option></term>
 673           <term><option>--no-sector-align</option></term>
 674           <term><option>--no-seektable</option></term>
 675           <term><option>--no-silent</option></term>
 676           <term><option>--no-verify</option></term>
 677           <term><option>--no-warnings-as-errors</option></term>
 678           <listitem>
 679             <para>These flags can be used to invert the sense of the corresponding normal option.</para>
 680           </listitem>
 681         </varlistentry>
 682       </variablelist>
 683
 684     </refsect2>
 685
 686   </refsect1>
 687   <refsect1>
 688     <title>SEE ALSO</title>
 689
 690     <para>metaflac(1).</para>
 691
 692     <para>The programs are documented fully by HTML format documentation, available in <filename>/usr/share/doc/flac/html</filename> on &debian; systems.</para>
 693   </refsect1>
 694   <refsect1>
 695     <title>AUTHOR</title>
 696
 697     <para>This manual page was written by &dhusername; &dhemail; for the &debian; system (but may be used by others).</para>
 698
 699     <!-- <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> -->
 700
 701   </refsect1>
 702 </refentry>
 703
 704 <!-- Keep this comment at the end of the file
 705       Local variables:
 706       mode: sgml
 707       sgml-omittag:t
 708       sgml-shorttag:t
 709       sgml-minimize-attributes:nil
 710       sgml-always-quote-attributes:t
 711       sgml-indent-step:2
 712       sgml-indent-data:t
 713       sgml-parent-document:nil
 714       sgml-default-dtd-file:nil
 715       sgml-exposed-tags:nil
 716       sgml-local-catalogs:nil
 717       sgml-local-ecat-files:nil
 718       End:
 719       -->