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" "30 October 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--replay-gain\fR
 130 Calculate ReplayGain values and store in
 131 Vorbis comments, similar to vorbisgain.  Title
 132 gains/peaks will be computed for each input
 133 file, and an album gain/peak will be computed
 134 for all files.  All input files must have the
 135 same resolution, sample rate, and number of
 136 channels.  Only mono and stereo files are
 137 allowed, and the sample rate must be one of
 138 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48
 139 kHz.  Also note that this option may leave a
 140 few extra bytes in a PADDING block as the exact
 141 size of the tags is not known until all files
 142 are processed.  Note that this option cannot be
 143 used when encoding to standard output (stdout).
 144 .TP
 145 \fB--sector-align\fR
 146 Align encoding of multiple CD format WAVE
 147 files on sector boundaries.  See the HTML
 148 documentation for more information.
 149 .TP
 150 \fB-S {\fI#\fB|\fIX\fB|\fI#x\fB}, --seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB}\fR
 151 Include a point or points in a SEEKTABLE.  Using #,
 152 a seek point at that sample number is added.  Using
 153 X, a placeholder point is added at the end of a the
 154 table.  Using #x, # evenly spaced seek points will
 155 be added, the first being at sample 0.  You may use
 156 many -S options; the resulting SEEKTABLE will be the
 157 unique-ified union of all such values.  With no -S
 158 options, flac defaults to '-S 100x'.  Use --no-seektable
 159 for no SEEKTABLE.  Note: '-S #x' will not work if the
 160 encoder can't determine the input size before
 161 starting.  Note: if you use '-S #' and # is >=
 162 samples in the input, there will be either no seek
 163 point entered (if the input size is determinable
 164 before encoding starts) or a placeholder point (if
 165 input size is not determinable).
 166 .TP
 167 \fB-P \fI#\fB, --padding=\fI#\fB\fR
 168 Tell the encoder to write a PADDING metadata
 169 block of the given length (in bytes) after the
 170 STREAMINFO block.  This is useful if you plan to
 171 tag the file later with an APPLICATION block;
 172 instead of having to rewrite the entire file later
 173 just to insert your block, you can write directly
 174 over the PADDING block.  Note that the total length
 175 of the PADDING block will be 4 bytes longer than
 176 the length given because of the 4 metadata block
 177 header bytes.  You can force no PADDING block at
 178 all to be written with --no-padding, which is the
 179 default.
 180 .TP
 181 \fB-T \fIFIELD=VALUE\fB, --tag=\fIFIELD=VALUE\fB\fR
 182 Add a Vorbis comment.  The comment must adhere
 183 to the Vorbis comment spec; i.e. the FIELD must
 184 contain only legal characters, terminated by an
 185 \&'equals' sign.  Make sure to quote the comment if
 186 necessary.  This option may appear more than once
 187 to add several comments.  NOTE: all tags will be
 188 added to all encoded files.
 189 .TP
 190 \fB-b \fI#\fB, --blocksize=\fI#\fB\fR
 191 Specify the block size in samples.  The
 192 default is 1152 for -l 0, else 4608; must be one of
 193 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
 194 4096, 8192, 16384, or 32768 (unless --lax is used)
 195 .TP
 196 \fB-m, --mid-side\fR
 197 Try mid-side coding for each frame (stereo
 198 input only)
 199 .TP
 200 \fB-M, --adaptive-mid-side\fR
 201 Adaptive mid-side coding for all frames (stereo
 202 input only)
 203 .TP
 204 \fB-0..-8, --compression-level-0..--compression-level-8\fR
 205 Fastest compression..highest compression
 206 (default is -5).  These are synonyms for other
 207 options:
 208 .RS
 209 .TP
 210 \fB-0, --compression-level-0\fR
 211 Synonymous with -l 0 -b 1152 -r 2,2
 212 .TP
 213 \fB-1, --compression-level-1\fR
 214 Synonymous with -l 0 -b 1152 -M -r 2,2
 215 .TP
 216 \fB-2, --compression-level-2\fR
 217 Synonymous with -l 0 -b 1152 -m -r 3
 218 .TP
 219 \fB-3, --compression-level-3\fR
 220 Synonymous with -l 6 -b 4608 -r 3,3
 221 .TP
 222 \fB-4, --compression-level-4\fR
 223 Synonymous with -l 8 -b 4608 -M -r 3,3
 224 .TP
 225 \fB-5, --compression-level-5\fR
 226 Synonymous with -l 8 -b 4608 -m -r 3,3
 227 .TP
 228 \fB-6, --compression-level-6\fR
 229 Synonymous with -l 8 -b 4608 -m -r 4
 230 .TP
 231 \fB-7, --compression-level-7\fR
 232 Synonymous with -l 8 -b 4608 -m -e -r 6
 233 .TP
 234 \fB-8, --compression-level-8\fR
 235 Synonymous with -l 12 -b 4608 -m -e -r 6
 236 .RE
 237 .TP
 238 \fB--fast\fR
 239 Fastest compression.  Currently
 240 synonymous with -0.
 241 .TP
 242 \fB--best\fR
 243 Highest compression.  Currently
 244 synonymous with -8.
 245 .TP
 246 \fB-e, --exhaustive-model-search\fR
 247 Do exhaustive model search
 248 (expensive!)
 249 .TP
 250 \fB-l \fI#\fB, --max-lpc-order=\fI#\fB\fR
 251 Set the maximum LPC order; 0 means use only the fixed predictors
 252 .TP
 253 \fB-p, --qlp-coeff-precision-search\fR
 254 Do exhaustive search of LP coefficient
 255 quantization (expensive!).  Overrides -q;
 256 does nothing if using -l 0
 257 .TP
 258 \fB-q \fI#\fB, --qlp-coeff-precision=\fI#\fB\fR
 259 Precision of the quantized linear-predictor
 260 coefficients, 0 => let encoder decide (min is 5,
 261 default is 0)
 262 .TP
 263 \fB-r [\fI#\fB,]\fI#\fB, --rice-partition-order=[\fI#\fB,]\fI#\fB\fR
 264 Set the [min,]max residual partition order
 265 (0..16). min defaults to 0 if unspecified.  Default
 266 is -r 3,3.
 267 .SS "FORMAT OPTIONS"
 268 .TP
 269 \fB--endian={\fIbig\fB|\fIlittle\fB}\fR
 270 Set the byte order for samples
 271 .TP
 272 \fB--channels=\fI#\fB\fR
 273 Set number of channels.
 274 .TP
 275 \fB--bps=\fI#\fB\fR
 276 Set bits per sample.
 277 .TP
 278 \fB--sample-rate=\fI#\fB\fR
 279 Set sample rate (in Hz).
 280 .TP
 281 \fB--sign={\fIsigned\fB|\fIunsigned\fB}\fR
 282 Set the sign of samples (the default is signed).
 283 .TP
 284 \fB--force-raw-format\fR
 285 Force input (when encoding) or output (when decoding)
 286 to be treated as raw samples (even if filename ends
 287 in \fI.wav\fR).
 288 .SS "NEGATIVE OPTIONS"
 289 .TP
 290 \fB--no-adaptive-mid-side\fR
 291 .TP
 292 \fB--no-decode-through-errors\fR
 293 .TP
 294 \fB--no-delete-input-file\fR
 295 .TP
 296 \fB--no-escape-coding\fR
 297 .TP
 298 \fB--no-exhaustive-model-search\fR
 299 .TP
 300 \fB--no-lax\fR
 301 .TP
 302 \fB--no-mid-side\fR
 303 .TP
 304 \fB--no-ogg\fR
 305 .TP
 306 \fB--no-padding\fR
 307 .TP
 308 \fB--no-qlp-coeff-precision-search\fR
 309 .TP
 310 \fB--no-residual-gnuplot\fR
 311 .TP
 312 \fB--no-residual-text\fR
 313 .TP
 314 \fB--no-sector-align\fR
 315 .TP
 316 \fB--no-seektable\fR
 317 .TP
 318 \fB--no-silent\fR
 319 .TP
 320 \fB--no-verify\fR
 321 These flags can be used to invert the sense
 322 of the corresponding normal option.
 323 .SH "SEE ALSO"
 324 .PP
 325 The programs are documented fully by HTML format
 326 documentation, available in
 327 \fI/usr/share/doc/flac/html\fR on
 328 Debian GNU/Linux systems.
 329 .SH "AUTHOR"
 330 .PP
 331 This manual page was written by Matt Zimmerman <mdz@debian.org> for
 332 the Debian GNU/Linux system (but may be used by others).