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