man/flac.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "FLAC" "1" "19 September 2002" "" ""
   7 .SH NAME
   8 flac \- Free Lossless Audio Codec
   9 .SH SYNOPSIS
  10
  11 \fBflac\fR [ \fB\fIOPTION\fB\fR ] \fB\fIinfile\fB\fR \fB\fI...\fB\fR
  12
  13 .SH "DESCRIPTION"
  14 .PP
  15 This manual page documents briefly the
  16 \fBflac\fR command.
  17 .PP
  18 This manual page was written for the Debian GNU/Linux
  19 distribution because the original program does not have a
  20 manual page.  Instead, it has documentation in HTML
  21 format; see below.
  22 .SH "OPTIONS"
  23 .PP
  24 A summary of options is included below.  For a complete
  25 description, see the HTML documentation.
  26 .SS "GENERIC OPTIONS"
  27 .TP
  28 \fB-v, --version \fR
  29 Show the flac version number
  30 .TP
  31 \fB-h, --help \fR
  32 Show basic usage and a list of all options
  33 .TP
  34 \fB-H, --explain \fR
  35 Show detailed explanation of usage and all options
  36 .TP
  37 \fB-d, --decode \fR
  38 Decode (the default behavior is to encode)
  39 .TP
  40 \fB-t, --test \fR
  41 Test a flac encoded file (same as -d
  42 except no decoded file is written)
  43 .TP
  44 \fB-a, --analyze \fR
  45 Analyze a flac encoded file (same as -d
  46 except an analysis file is written)
  47 .TP
  48 \fB-c, --stdout \fR
  49 Write output to stdout
  50 .TP
  51 \fB-s, --silent \fR
  52 Silent mode (do not write runtime
  53 encode/decode statistics to stderr)
  54 .TP
  55 \fB-o \fIfilename\fB, --output-name=\fIfilename\fB\fR
  56 Force the output file name (usually flac just
  57 changes the extension).  May only be used when
  58 encoding a single file.  May not be used in
  59 conjunction with --output-prefix.
  60 .TP
  61 \fB--output-prefix=\fIstring\fB\fR
  62 Prefix each output file name with the given
  63 string.  This can be useful for encoding or decoding
  64 files to a different directory.  Make sure if your
  65 string is a path name that it ends with a trailing
  66 `/' (slash).
  67 .TP
  68 \fB--delete-input-file \fR
  69 Automatically delete the input file after a
  70 successful encode or decode.  If there was an
  71 error (including a verify error) the input file
  72 is left intact.
  73 .TP
  74 \fB--skip=\fI#\fB\fR
  75 Skip the specified number of samples at the
  76 beginning of the input file (can be used for both
  77 encoding and decoding)
  78 .TP
  79 \fB--ogg\fR
  80 When encoding, generate Ogg-FLAC output instead
  81 of native-FLAC.  Ogg-FLAC streams are FLAC streams
  82 wrapped in an Ogg transport layer.  The resulting
  83 file should have an '.ogg' extension and will still
  84 be decodable by flac.
  85
  86 When decoding, force the input to be treated as
  87 Ogg-FLAC.  This is useful when piping input from
  88 stdin or when the filename does not end in '.ogg'.
  89 .TP
  90 \fB--serial-number=\fI#\fB\fR
  91 When used with --ogg, specifies the serial
  92 number to use for the FLAC stream.  When encoding and
  93 no serial number is given, flac uses '0'.  When
  94 decoding and no number is given, flac uses the serial
  95 number of the first page.
  96 .SS "ANALYSIS OPTIONS"
  97 .TP
  98 \fB--residual-text \fR
  99 Includes the residual signal in the analysis
 100 file.  This will make the file very big, much
 101 larger than even the decoded file.
 102 .TP
 103 \fB--residual-gnuplot \fR
 104 Generates a gnuplot file for every subframe;
 105 each file will contain the residual distribution
 106 of the subframe.  This will create a lot of
 107 files.
 108 .SS "DECODING OPTIONS"
 109 .TP
 110 \fB-F, --decode-through-errors \fR
 111 By default flac stops decoding with an error
 112 and removes the partially decoded file if it
 113 encounters a bitstream error.  With -F, errors are
 114 still printed but flac will continue decoding to
 115 completion.  Note that errors may cause the decoded
 116 audio to be missing some samples or have silent
 117 sections.
 118 .SS "ENCODING OPTIONS"
 119 .TP
 120 \fB-V, --verify\fR
 121 Verify a correct encoding by decoding the
 122 output in parallel and comparing to the
 123 original
 124 .TP
 125 \fB--lax\fR
 126 Allow encoder to generate non-Subset
 127 files.
 128 .TP
 129 \fB--sector-align\fR
 130 Align encoding of multiple CD format WAVE
 131 files on sector boundaries.  See the HTML
 132 documentation for more information.
 133 .TP
 134 \fB-S {\fI#\fB|\fIX\fB|\fI#x\fB}, --seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB}\fR
 135 Include a point or points in a SEEKTABLE.  Using #,
 136 a seek point at that sample number is added.  Using
 137 X, a placeholder point is added at the end of a the
 138 table.  Using #x, # evenly spaced seek points will
 139 be added, the first being at sample 0.  You may use
 140 many -S options; the resulting SEEKTABLE will be the
 141 unique-ified union of all such values.  With no -S
 142 options, flac defaults to '-S 100x'.  Use -S- for
 143 no SEEKTABLE.  Note: '-S #x' will not work if the
 144 encoder can't determine the input size before
 145 starting.  Note: if you use '-S #' and # is >=
 146 samples in the input, there will be either no seek
 147 point entered (if the input size is determinable
 148 before encoding starts) or a placeholder point (if
 149 input size is not determinable).
 150 .TP
 151 \fB-P \fI#\fB, --padding=\fI#\fB\fR
 152 Tell the encoder to write a PADDING metadata
 153 block of the given length (in bytes) after the
 154 STREAMINFO block.  This is useful if you plan to
 155 tag the file later with an APPLICATION block;
 156 instead of having to rewrite the entire file later
 157 just to insert your block, you can write directly
 158 over the PADDING block.  Note that the total length
 159 of the PADDING block will be 4 bytes longer than
 160 the length given because of the 4 metadata block
 161 header bytes.  You can force no PADDING block at
 162 all to be written with -P-, which is the default.
 163 .TP
 164 \fB-T \fIFIELD=VALUE\fB, --tag=\fIFIELD=VALUE\fB\fR
 165 Add a Vorbis comment.  The comment must adhere
 166 to the Vorbis comment spec; i.e. the FIELD must
 167 contain only legal characters, terminated by an
 168 \&'equals' sign.  Make sure to quote the comment if
 169 necessary.  This option may appear more than once
 170 to add several comments.  NOTE: all tags will be
 171 added to all encoded files.
 172 .TP
 173 \fB-b \fI#\fB, --blocksize=\fI#\fB\fR
 174 Specify the block size in samples.  The
 175 default is 1152 for -l 0, else 4608; must be one of
 176 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
 177 4096, 8192, 16384, or 32768 (unless --lax is used)
 178 .TP
 179 \fB-m, --mid-side\fR
 180 Try mid-side coding for each frame (stereo
 181 input only)
 182 .TP
 183 \fB-M, --adaptive-mid-side\fR
 184 Adaptive mid-side coding for all frames (stereo
 185 input only)
 186 .TP
 187 \fB-0..-8, --compression-level-0..--compression-level-8\fR
 188 Fastest compression..highest compression
 189 (default is -5).  These are synonyms for other
 190 options:
 191 .RS
 192 .TP
 193 \fB-0, --compression-level-0\fR
 194 Synonymous with -l 0 -b 1152 -r 2,2
 195 .TP
 196 \fB-1, --compression-level-1\fR
 197 Synonymous with -l 0 -b 1152 -M -r 2,2
 198 .TP
 199 \fB-2, --compression-level-2\fR
 200 Synonymous with -l 0 -b 1152 -m -r 3
 201 .TP
 202 \fB-3, --compression-level-3\fR
 203 Synonymous with -l 6 -b 4608 -r 3,3
 204 .TP
 205 \fB-4, --compression-level-4\fR
 206 Synonymous with -l 8 -b 4608 -M -r 3,3
 207 .TP
 208 \fB-5, --compression-level-5\fR
 209 Synonymous with -l 8 -b 4608 -m -r 3,3
 210 .TP
 211 \fB-6, --compression-level-6\fR
 212 Synonymous with -l 8 -b 4608 -m -r 4
 213 .TP
 214 \fB-7, --compression-level-7\fR
 215 Synonymous with -l 8 -b 4608 -m -e -r 6
 216 .TP
 217 \fB-8, --compression-level-8\fR
 218 Synonymous with -l 12 -b 4608 -m -e -r 6
 219 .RE
 220 .TP
 221 \fB--fast\fR
 222 Fastest compression.  Currently
 223 synonymous with -0.
 224 .TP
 225 \fB--best\fR
 226 Highest compression.  Currently
 227 synonymous with -8.
 228 .TP
 229 \fB-e, --exhaustive-model-search\fR
 230 Do exhaustive model search
 231 (expensive!)
 232 .TP
 233 \fB-E, --escape-coding\fR
 234 Do escape coding in the entropy coder.  This
 235 causes the encoder to use an unencoded representation
 236 of the residual in a partition if it is smaller.  It
 237 increases the runtime and usually results in an
 238 improvement of less than 1%.
 239 .TP
 240 \fB-l \fI#\fB, --max-lpc-order=\fI#\fB\fR
 241 Set the maximum LPC order; 0 means use only the fixed predictors
 242 .TP
 243 \fB-p, --qlp-coeff-precision-search\fR
 244 Do exhaustive search of LP coefficient
 245 quantization (expensive!).  Overrides -q;
 246 does nothing if using -l 0
 247 .TP
 248 \fB-q \fI#\fB, --qlp-coeff-precision=\fI#\fB\fR
 249 Precision of the quantized linear-predictor
 250 coefficients, 0 => let encoder decide (min is 5,
 251 default is 0)
 252 .TP
 253 \fB-r [\fI#\fB,]\fI#\fB, --rice-partition-order=[\fI#\fB,]\fI#\fB\fR
 254 Set the [min,]max residual partition order
 255 (0..16). min defaults to 0 if unspecified.  Default
 256 is -r 3,3.
 257 .SS "FORMAT OPTIONS"
 258 .TP
 259 \fB--endian={\fIbig\fB|\fIlittle\fB}\fR
 260 Set the byte order for samples
 261 .TP
 262 \fB--channels=\fI#\fB\fR
 263 Set number of channels.
 264 .TP
 265 \fB--bps=\fI#\fB\fR
 266 Set bits per sample.
 267 .TP
 268 \fB--sample-rate=\fI#\fB\fR
 269 Set sample rate (in Hz).
 270 .TP
 271 \fB--sign={\fIsigned\fB|\fIunsigned\fB}\fR
 272 Set the sign of samples (the default is signed).
 273 .TP
 274 \fB--force-raw-format\fR
 275 Force input (when encoding) or output (when decoding)
 276 to be treated as raw samples (even if filename ends
 277 in \fI.wav\fR).
 278 .SS "NEGATIVE OPTIONS"
 279 .TP
 280 \fB--no-adaptive-mid-side\fR
 281 .TP
 282 \fB--no-decode-through-errors\fR
 283 .TP
 284 \fB--no-delete-input-file\fR
 285 .TP
 286 \fB--no-escape-coding\fR
 287 .TP
 288 \fB--no-exhaustive-model-search\fR
 289 .TP
 290 \fB--no-lax\fR
 291 .TP
 292 \fB--no-mid-side\fR
 293 .TP
 294 \fB--no-ogg\fR
 295 .TP
 296 \fB--no-padding\fR
 297 .TP
 298 \fB--no-qlp-coeff-precision-search\fR
 299 .TP
 300 \fB--no-residual-gnuplot\fR
 301 .TP
 302 \fB--no-residual-text\fR
 303 .TP
 304 \fB--no-sector-align\fR
 305 .TP
 306 \fB--no-seektable\fR
 307 .TP
 308 \fB--no-silent\fR
 309 .TP
 310 \fB--no-verify\fR
 311 These flags can be used to invert the sense
 312 of the corresponding normal option.
 313 .SH "SEE ALSO"
 314 .PP
 315 The programs are documented fully by HTML format
 316 documentation, available in
 317 \fI/usr/share/doc/flac/html\fR on
 318 Debian GNU/Linux systems.
 319 .SH "AUTHOR"
 320 .PP
 321 This manual page was written by Matt Zimmerman <mdz@debian.org> for
 322 the Debian GNU/Linux system (but may be used by others).