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 August 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 .SS "ANALYSIS OPTIONS"
  79 .TP
  80 \fB--residual-text \fR
  81 Includes the residual signal in the analysis
  82 file.  This will make the file very big, much
  83 larger than even the decoded file.
  84 .TP
  85 \fB--residual-gnuplot \fR
  86 Generates a gnuplot file for every subframe;
  87 each file will contain the residual distribution
  88 of the subframe.  This will create a lot of
  89 files.
  90 .SS "DECODING OPTIONS"
  91 .TP
  92 \fB-F, --decode-through-errors \fR
  93 By default flac stops decoding with an error
  94 and removes the partially decoded file if it
  95 encounters a bitstream error.  With -F, errors are
  96 still printed but flac will continue decoding to
  97 completion.  Note that errors may cause the decoded
  98 audio to be missing some samples or have silent
  99 sections.
 100 .SS "ENCODING OPTIONS"
 101 .TP
 102 \fB-V, --verify\fR
 103 Verify a correct encoding by decoding the
 104 output in parallel and comparing to the
 105 original
 106 .TP
 107 \fB--ogg\fR
 108 When encoding, generate Ogg-FLAC output instead
 109 of native-FLAC.  Ogg-FLAC streams are FLAC streams
 110 wrapped in an Ogg transport layer.  The resulting
 111 file should have an '.ogg' extension and will still
 112 be decodable by flac.
 113
 114 When decoding, force the input to be treated as
 115 Ogg-FLAC.  This is useful when piping input from
 116 stdin or when the filename does not end in '.ogg'.
 117 .TP
 118 \fB--lax\fR
 119 Allow encoder to generate non-Subset
 120 files.
 121 .TP
 122 \fB--sector-align\fR
 123 Align encoding of multiple CD format WAVE
 124 files on sector boundaries.  See the HTML
 125 documentation for more information.
 126 .TP
 127 \fB-S {\fI#\fB|\fIX\fB|\fI#x\fB}, --seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB}\fR
 128 Include a point or points in a SEEKTABLE.  Using #,
 129 a seek point at that sample number is added.  Using
 130 X, a placeholder point is added at the end of a the
 131 table.  Using #x, # evenly spaced seek points will
 132 be added, the first being at sample 0.  You may use
 133 many -S options; the resulting SEEKTABLE will be the
 134 unique-ified union of all such values.  With no -S
 135 options, flac defaults to '-S 100x'.  Use -S- for
 136 no SEEKTABLE.  Note: '-S #x' will not work if the
 137 encoder can't determine the input size before
 138 starting.  Note: if you use '-S #' and # is >=
 139 samples in the input, there will be either no seek
 140 point entered (if the input size is determinable
 141 before encoding starts) or a placeholder point (if
 142 input size is not determinable).
 143 .TP
 144 \fB-P \fI#\fB, --padding=\fI#\fB\fR
 145 Tell the encoder to write a PADDING metadata
 146 block of the given length (in bytes) after the
 147 STREAMINFO block.  This is useful if you plan to
 148 tag the file later with an APPLICATION block;
 149 instead of having to rewrite the entire file later
 150 just to insert your block, you can write directly
 151 over the PADDING block.  Note that the total length
 152 of the PADDING block will be 4 bytes longer than
 153 the length given because of the 4 metadata block
 154 header bytes.  You can force no PADDING block at
 155 all to be written with -P-, which is the default.
 156 .TP
 157 \fB-b \fI#\fB, --blocksize=\fI#\fB\fR
 158 Specify the block size in samples.  The
 159 default is 1152 for -l 0, else 4608; must be one of
 160 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
 161 4096, 8192, 16384, or 32768 (unless --lax is used)
 162 .TP
 163 \fB-m, --mid-side\fR
 164 Try mid-side coding for each frame (stereo
 165 input only)
 166 .TP
 167 \fB-M, --adaptive-mid-side\fR
 168 Adaptive mid-side coding for all frames (stereo
 169 input only)
 170 .TP
 171 \fB-0..-8, --compression-level-0..--compression-level-8\fR
 172 Fastest compression..highest compression
 173 (default is -5).  These are synonyms for other
 174 options:
 175 .RS
 176 .TP
 177 \fB-0, --compression-level-0\fR
 178 Synonymous with -l 0 -b 1152 -r 2,2
 179 .TP
 180 \fB-1, --compression-level-1\fR
 181 Synonymous with -l 0 -b 1152 -M -r 2,2
 182 .TP
 183 \fB-2, --compression-level-2\fR
 184 Synonymous with -l 0 -b 1152 -m -r 3
 185 .TP
 186 \fB-3, --compression-level-3\fR
 187 Synonymous with -l 6 -b 4608 -r 3,3
 188 .TP
 189 \fB-4, --compression-level-4\fR
 190 Synonymous with -l 8 -b 4608 -M -r 3,3
 191 .TP
 192 \fB-5, --compression-level-5\fR
 193 Synonymous with -l 8 -b 4608 -m -r 3,3
 194 .TP
 195 \fB-6, --compression-level-6\fR
 196 Synonymous with -l 8 -b 4608 -m -r 4
 197 .TP
 198 \fB-7, --compression-level-7\fR
 199 Synonymous with -l 8 -b 4608 -m -e -r 6
 200 .TP
 201 \fB-8, --compression-level-8\fR
 202 Synonymous with -l 12 -b 4608 -m -e -r 6
 203 .RE
 204 .TP
 205 \fB--fast\fR
 206 Fastest compression.  Currently
 207 synonymous with -0.
 208 .TP
 209 \fB--best\fR
 210 Highest compression.  Currently
 211 synonymous with -8.
 212 .TP
 213 \fB-e, --exhaustive-model-search\fR
 214 Do exhaustive model search
 215 (expensive!)
 216 .TP
 217 \fB-E, --escape-coding\fR
 218 Do escape coding in the entropy coder.  This
 219 causes the encoder to use an unencoded representation
 220 of the residual in a partition if it is smaller.  It
 221 increases the runtime and usually results in an
 222 improvement of less than 1%.
 223 .TP
 224 \fB-l \fI#\fB, --max-lpc-order=\fI#\fB\fR
 225 Set the maximum LPC order; 0 means use only the fixed predictors
 226 .TP
 227 \fB-p, --qlp-coeff-precision-search\fR
 228 Do exhaustive search of LP coefficient
 229 quantization (expensive!).  Overrides -q;
 230 does nothing if using -l 0
 231 .TP
 232 \fB-q \fI#\fB, --qlp-coeff-precision=\fI#\fB\fR
 233 Precision of the quantized linear-predictor
 234 coefficients, 0 => let encoder decide (min is 5,
 235 default is 0)
 236 .TP
 237 \fB-r [\fI#\fB,]\fI#\fB, --rice-partition-order=[\fI#\fB,]\fI#\fB\fR
 238 Set the [min,]max residual partition order
 239 (0..16). min defaults to 0 if unspecified.  Default
 240 is -r 3,3.
 241 .SS "FORMAT OPTIONS"
 242 .TP
 243 \fB--endian={\fIbig\fB|\fIlittle\fB}\fR
 244 Set the byte order for samples
 245 .TP
 246 \fB--channels=\fI#\fB\fR
 247 Set number of channels.
 248 .TP
 249 \fB--bps=\fI#\fB\fR
 250 Set bits per sample.
 251 .TP
 252 \fB--sample-rate=\fI#\fB\fR
 253 Set sample rate (in Hz).
 254 .TP
 255 \fB--sign={\fIsigned\fB|\fIunsigned\fB}\fR
 256 Set the sign of samples (the default is signed).
 257 .TP
 258 \fB--force-raw-input\fR
 259 Force input to be treated as raw samples (even if filename ends
 260 in \fI.wav\fR).
 261 .SS "NEGATIVE OPTIONS"
 262 .TP
 263 \fB--no-adaptive-mid-side\fR
 264 .TP
 265 \fB--no-decode-through-errors\fR
 266 .TP
 267 \fB--no-delete-input-file\fR
 268 .TP
 269 \fB--no-escape-coding\fR
 270 .TP
 271 \fB--no-exhaustive-model-search\fR
 272 .TP
 273 \fB--no-lax\fR
 274 .TP
 275 \fB--no-mid-side\fR
 276 .TP
 277 \fB--no-ogg\fR
 278 .TP
 279 \fB--no-padding\fR
 280 .TP
 281 \fB--no-qlp-coeff-precision-search\fR
 282 .TP
 283 \fB--no-residual-gnuplot\fR
 284 .TP
 285 \fB--no-residual-text\fR
 286 .TP
 287 \fB--no-sector-align\fR
 288 .TP
 289 \fB--no-seektable\fR
 290 .TP
 291 \fB--no-silent\fR
 292 .TP
 293 \fB--no-verify\fR
 294 These flags can be used to invert the sense
 295 of the corresponding normal option.
 296 .SH "SEE ALSO"
 297 .PP
 298 The programs are documented fully by HTML format
 299 documentation, available in
 300 \fI/usr/share/doc/flac/html\fR on
 301 Debian GNU/Linux systems.
 302 .SH "AUTHOR"
 303 .PP
 304 This manual page was written by Matt Zimmerman <mdz@debian.org> for
 305 the Debian GNU/Linux system (but may be used by others).