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>February 23, 2001</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>2000</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
  49             <arg><option><replaceable>OPTION</replaceable></option></arg>
  50             <arg choice=plain><replaceable>infile</replaceable></arg>
  51             <arg choice=plain><replaceable>outfile</replaceable></arg>
  52           </cmdsynopsis>
  53         </refsynopsisdiv>
  54         <refsect1>
  55           <title>DESCRIPTION</title>
  56
  57           <para>This manual page documents briefly the
  58             <command>flac</command> command.</para>
  59
  60           <para>This manual page was written for the &debian;
  61             distribution because the original program does not have a
  62             manual page.  Instead, it has documentation in HTML
  63             format; see below.</para>
  64
  65         </refsect1>
  66         <refsect1>
  67           <title>OPTIONS</title>
  68
  69           <para>A summary of options is included below.  For a complete
  70           description, see the HTML documentation.</para>
  71
  72           <refsect2>
  73             <title>Generic Options</title>
  74
  75             <variablelist>
  76               <varlistentry>
  77                 <term><option>-d</option>
  78                 </term>
  79                 <listitem>
  80                   <para>Decode (default behavior is encode)</para>
  81                 </listitem>
  82               </varlistentry>
  83
  84               <varlistentry>
  85                 <term><option>-t</option>
  86                 </term>
  87                 <listitem>
  88                   <para>Test a flac encoded file (same as -d
  89                     except no decoded file is written)</para>
  90                 </listitem>
  91               </varlistentry>
  92
  93               <varlistentry>
  94                 <term><option>-a</option>
  95                 </term>
  96                 <listitem>
  97                   <para>Analyze a flac encoded file (same as -d
  98                     except an analysis file is written)</para>
  99                 </listitem>
 100               </varlistentry>
 101
 102               <varlistentry>
 103                 <term><option>-s</option>
 104                 </term>
 105                 <listitem>
 106                   <para>Silent mode (do not write runtime
 107                     encode/decode statistics to stdout)</para>
 108                 </listitem>
 109               </varlistentry>
 110
 111               <varlistentry>
 112                 <term><option>--skip</option> <replaceable>samples</replaceable></term>
 113                 <listitem>
 114                   <para>Skip the specified number of samples at the
 115                     beginning of the input file (can be used for both
 116                     encoding and decoding)</para>
 117                 </listitem>
 118               </varlistentry>
 119
 120             </variablelist>
 121           </refsect2>
 122
 123           <refsect2>
 124             <title>Analysis Options</title>
 125
 126             <variablelist>
 127               <varlistentry>
 128                 <term><option>--a-rtext</option>
 129                 </term>
 130                 <listitem>
 131                   <para>Includes the residual signal in the analysis
 132                     file.  This will make the file very big, much
 133                     larger than even the decoded file.</para>
 134                 </listitem>
 135               </varlistentry>
 136
 137               <varlistentry>
 138                 <term><option>--a-rgp</option>
 139                 </term>
 140                 <listitem>
 141                   <para>Generates a gnuplot file for every subframe;
 142                     each file will contain the residual distribution
 143                     of the subframe.  This will create a lot of
 144                     files.</para>
 145                 </listitem>
 146               </varlistentry>
 147
 148             </variablelist>
 149           </refsect2>
 150
 151           <refsect2>
 152             <title>Encoding Options</title>
 153
 154             <variablelist>
 155               <varlistentry>
 156                 <term><option>--lax</option></term>
 157
 158                 <listitem>
 159                   <para>Allow encoder to generate non-Subset
 160                     files</para>
 161                 </listitem>
 162               </varlistentry>
 163
 164               <varlistentry>
 165                 <term><option>-S</option> <replaceable>{ # | X | #x }</replaceable></term>
 166
 167                 <listitem>
 168                   <para>
 169                     Include a point or points in a SEEKTABLE.  Using #,
 170                     a seek point at that sample number is added.  Using
 171                     X, a placeholder point is added at the end of a the
 172                     table.  Using #x, # evenly spaced seek points will
 173                     be added, the first being at sample 0.  You may use
 174                     many -S options; the resulting SEEKTABLE will be the
 175                     unique-ified union of all such values.  With no -S
 176                     options, flac defaults to '-S 100x'.  Use -S- for
 177                     no SEEKTABLE.  Note: '-S #x' will not work if the
 178                     encoder can't determine the input size before
 179                     starting.  Note: if you use '-S #' and # is >=
 180                     samples in the input, there will be either no seek
 181                     point entered (if the input size is determinable
 182                     before encoding starts) or a placeholder point (if
 183                     input size is not determinable)</para>
 184                 </listitem>
 185               </varlistentry>
 186
 187               <varlistentry>
 188                 <term><option>-P</option> <replaceable>bytes</replaceable></term>
 189
 190                 <listitem>
 191                   <para>Tell the encoder to write a PADDING metadata
 192                     block of the given length (in bytes) after the
 193                     STREAMINFO block.  -P 0 implies no PADDING block,
 194                     which is the default.  This is useful if you plan
 195                     to tag the file later with an APPLICATION block;
 196                     instead of having to rewrite the entire file later
 197                     just to insert your block, you can write directly
 198                     over the PADDING block.</para>
 199                 </listitem>
 200               </varlistentry>
 201
 202               <varlistentry>
 203                 <term><option>-b</option> <replaceable>blocksize</replaceable></term>
 204
 205                 <listitem>
 206                   <para>Default is 1152 for -l 0, else 4608; must be
 207                     192/576/1152/2304/4608/256/512/1024/2048/4096/8192/16384/32768
 208                     (unless --lax is used)</para>
 209                 </listitem>
 210               </varlistentry>
 211
 212               <varlistentry>
 213                 <term><option>-m</option></term>
 214
 215                 <listitem>
 216                   <para>Try mid-side coding for each frame (stereo
 217                     input only)</para>
 218                 </listitem>
 219               </varlistentry>
 220
 221               <varlistentry>
 222                 <term><option>-m</option></term>
 223
 224                 <listitem>
 225                   <para>Loose mid-side coding for all frames (stereo
 226                     input only)</para>
 227                 </listitem>
 228               </varlistentry>
 229
 230               <varlistentry>
 231                 <term><option>-0</option>..<option>-9</option></term>
 232
 233                 <listitem>
 234                   <para>Fastest compression..highest compression
 235                     (default is -6).  These are synonyms for other
 236                     options:</para>
 237
 238                   <variablelist>
 239                     <varlistentry>
 240                       <term><option>-0</option></term>
 241
 242                       <listitem>
 243                         <para>Synonymous with -l 0</para>
 244                       </listitem>
 245                     </varlistentry>
 246
 247                     <varlistentry>
 248                       <term><option>-1</option></term>
 249
 250                       <listitem>
 251                         <para>Synonymous with -l 0 -M</para>
 252                       </listitem>
 253                     </varlistentry>
 254
 255                     <varlistentry>
 256                       <term><option>-2</option></term>
 257
 258                       <listitem>
 259                         <para>Synonymous with -l 0 -m -r # (# is
 260                           automatically determined by the block
 261                           size)</para>
 262                       </listitem>
 263                     </varlistentry>
 264
 265                     <varlistentry>
 266                       <term><option>-3</option></term>
 267
 268                       <listitem>
 269                         <para>Reserved</para>
 270                       </listitem>
 271                     </varlistentry>
 272
 273                     <varlistentry>
 274                       <term><option>-4</option></term>
 275
 276                       <listitem>
 277                         <para>Synonymous with -l 8</para>
 278                       </listitem>
 279                     </varlistentry>
 280
 281                     <varlistentry>
 282                       <term><option>-5</option></term>
 283
 284                       <listitem>
 285                         <para>Synonymous with -l 8 -M</para>
 286                       </listitem>
 287                     </varlistentry>
 288
 289                     <varlistentry>
 290                       <term><option>-6</option></term>
 291
 292                       <listitem>
 293                         <para>Synonymous with -l 8 -m -r # (# is
 294                           automatically determined by the block
 295                           size)</para>
 296                       </listitem>
 297                     </varlistentry>
 298
 299                     <varlistentry>
 300                       <term><option>-7</option></term>
 301
 302                       <listitem>
 303                         <para>Reserved</para>
 304                       </listitem>
 305                     </varlistentry>
 306
 307                     <varlistentry>
 308                       <term><option>-8</option></term>
 309
 310                       <listitem>
 311                         <para>Synonymous with -l 32 -m -r # (# is
 312                           automatically determined by the block
 313                           size)</para>
 314                       </listitem>
 315                     </varlistentry>
 316
 317                     <varlistentry>
 318                       <term><option>-9</option></term>
 319
 320                       <listitem>
 321                         <para>Synonymous with -l 32 -m -e -r 16 -p
 322                           (very slow!)</para>
 323                       </listitem>
 324                     </varlistentry>
 325                   </variablelist>
 326
 327                 </listitem>
 328
 329
 330               </varlistentry>
 331
 332               <varlistentry>
 333                 <term><option>-e</option></term>
 334
 335                 <listitem>
 336                   <para>Do exhaustive model search
 337                     (expensive!)</para>
 338                 </listitem>
 339               </varlistentry>
 340
 341               <varlistentry>
 342                 <term><option>-l</option> <replaceable>max_lpc_order</replaceable></term>
 343
 344                 <listitem>
 345                   <para>0 => use only fixed predictors</para>
 346                 </listitem>
 347               </varlistentry>
 348
 349               <varlistentry>
 350                 <term><option>-p</option></term>
 351
 352                 <listitem>
 353                   <para>Do exhaustive search of LP coefficient
 354                     quantization (expensive!).  Overrides -q,
 355                     does nothing if using -l 0</para>
 356                 </listitem>
 357               </varlistentry>
 358
 359               <varlistentry>
 360                 <term><option>-q</option> <replaceable>bits</replaceable></term>
 361
 362                 <listitem>
 363                   <para>Precision of the quantized linear-predictor
 364                     coefficients, 0 => let encoder decide (min is 5,
 365                     default is 0)</para>
 366                 </listitem>
 367               </varlistentry>
 368
 369               <varlistentry>
 370                 <term><option>-r</option> <replaceable>level</replaceable></term>
 371
 372                 <listitem>
 373                   <para>Residual partition order (0..16). 0
 374                     => none, default is 0, above 4 doesn't usually
 375                     help much)</para>
 376                 </listitem>
 377               </varlistentry>
 378
 379               <varlistentry>
 380                 <term><option>-V</option></term>
 381
 382                 <listitem>
 383                   <para>Verify a correct encoding by decoding the
 384                     output in parallel and comparing to the
 385                     original</para>
 386                 </listitem>
 387               </varlistentry>
 388
 389               <varlistentry>
 390                 <term><option>-S-</option> <option>-m-</option> <option>-M-</option> <option>-e-</option> <option>-p-</option> <option>-V-</option> <option>--lax-</option>
 391                 </term>
 392
 393                 <listitem>
 394                   <para>These flags can be used to invert the sense
 395                     of the corresponding normal option.</para>
 396                 </listitem>
 397               </varlistentry>
 398             </variablelist>
 399
 400           </refsect2>
 401           <refsect2>
 402             <title>Format Options</title>
 403
 404             <variablelist>
 405               <varlistentry>
 406                 <term><option>-fb</option></term>
 407
 408                 <listitem>
 409                   <para>Big-endian byte order</para>
 410                 </listitem>
 411               </varlistentry>
 412
 413               <varlistentry>
 414                 <term><option>-fl</option></term>
 415
 416                 <listitem>
 417                   <para>Little-endian byte order</para>
 418                 </listitem>
 419               </varlistentry>
 420
 421               <varlistentry>
 422                 <term><option>-fc</option>
 423                   <replaceable>channels</replaceable></term>
 424
 425                 <listitem>
 426                   <para>Set number of channels.</para>
 427                 </listitem>
 428               </varlistentry>
 429
 430               <varlistentry>
 431                 <term><option>-fp</option>
 432                   <replaceable>bits_per_sample</replaceable></term>
 433
 434                 <listitem>
 435                   <para>Set bits per sample.</para>
 436                 </listitem>
 437               </varlistentry>
 438
 439               <varlistentry>
 440                 <term><option>-fs</option>
 441                   <replaceable>sample_rate</replaceable></term>
 442
 443                 <listitem>
 444                   <para>Set sample rate (in Hz).</para>
 445                 </listitem>
 446               </varlistentry>
 447
 448               <varlistentry>
 449                 <term><option>-fu</option></term>
 450
 451                 <listitem>
 452                   <para>Unsigned samples (default is signed)</para>
 453                 </listitem>
 454               </varlistentry>
 455
 456               <varlistentry>
 457                 <term><option>-fr</option></term>
 458
 459                 <listitem>
 460                   <para>Force to raw format (even if filename ends
 461                     in <filename>.wav</filename>).</para>
 462                 </listitem>
 463               </varlistentry>
 464
 465               <varlistentry>
 466                 <term><option>-fw</option></term>
 467
 468                 <listitem>
 469                   <para>Force to RIFF WAVE.</para>
 470                 </listitem>
 471               </varlistentry>
 472
 473             </variablelist>
 474           </refsect2>
 475
 476         </refsect1>
 477           <refsect1>
 478             <title>SEE ALSO</title>
 479
 480             <para>The programs are documented fully by HTML format
 481               documentation, available in
 482               <filename>/usr/share/doc/flac/html</filename> on
 483                 &debian; systems.</para>
 484           </refsect1>
 485           <refsect1>
 486             <title>AUTHOR</title>
 487
 488             <para>This manual page was written by &dhusername; &dhemail; for
 489               the &debian; system (but may be used by others).</para>
 490
 491             <!-- <para>Permission is granted to copy, distribute and/or modify
 492             this document under the terms of the <acronym>GNU</acronym> Free
 493             Documentation License, Version 1.1 or any later version
 494             published by the Free Software Foundation; with no Invariant
 495             Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
 496             of the license can be found under
 497           <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
 498
 499         </refsect1>
 500       </refentry>
 501
 502         <!-- Keep this comment at the end of the file
 503               Local variables:
 504               mode: sgml
 505               sgml-omittag:t
 506               sgml-shorttag:t
 507               sgml-minimize-attributes:nil
 508               sgml-always-quote-attributes:t
 509               sgml-indent-step:2
 510               sgml-indent-data:t
 511               sgml-parent-document:nil
 512               sgml-default-dtd-file:nil
 513               sgml-exposed-tags:nil
 514               sgml-local-catalogs:nil
 515               sgml-local-ecat-files:nil
 516               End:
 517               -->