.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "FLAC" "1" "09 October 2006" "" ""
+.TH "FLAC" "1" "Nov 4, 2006" "" ""
.SH NAME
flac \- Free Lossless Audio Codec
.SH SYNOPSIS
-\fBflac\fR [ \fB\fIoptions\fB\fR ] [ \fB\fIinfile.wav\fB\fR | \fB\fIinfile.aiff\fB\fR | \fB\fIinfile.raw\fB\fR | \fB\fIinfile.flac\fB\fR | \fB-\fR\fI ...\fR ]
+\fBflac\fR [ \fB\fIOPTIONS\fB\fR ] [ \fB\fIinfile.wav\fB\fR | \fB\fIinfile.rf64\fB\fR | \fB\fIinfile.aiff\fB\fR | \fB\fIinfile.raw\fB\fR | \fB\fIinfile.flac\fB\fR | \fB\fIinfile.oga\fB\fR | \fB\fIinfile.ogg\fB\fR | \fB-\fR\fI ...\fR ]
-\fBflac\fR [ \fB-d\fR | \fB--decode\fR | \fB-t\fR | \fB--test\fR | \fB-a\fR | \fB--analyze\fR ] [ \fB\fIOPTIONS\fB\fR ] [ \fB\fIinfile.flac\fB\fR\fI ...\fR ]
+\fBflac\fR [ \fB-d\fR | \fB--decode\fR | \fB-t\fR | \fB--test\fR | \fB-a\fR | \fB--analyze\fR ] [ \fB\fIOPTIONS\fB\fR ] [ \fB\fIinfile.flac\fB\fR | \fB\fIinfile.oga\fB\fR | \fB\fIinfile.ogg\fB\fR | \fB-\fR\fI ...\fR ]
.SH "DESCRIPTION"
.PP
\fB--totally-silent \fR
Do not print anything of any kind, including warnings or errors. The exit code will be the only way to determine successful completion.
.TP
+\fB--no-utf8-convert \fR
+Do not convert tags from local charset to UTF-8. This is useful for scripts, and setting tags in situations where the locale is wrong. This option must appear before any tag options!
+.TP
+\fB-w, --warnings-as-errors \fR
+Treat all warnings as errors (which cause flac to terminate with a non-zero exit code).
+.TP
\fB-f, --force \fR
Force overwriting of output files. By default, flac warns that the output file already exists and continues to the next file.
.TP
\fB--delete-input-file \fR
Automatically delete the input file after a successful encode or decode. If there was an error (including a verify error) the input file is left intact.
.TP
+\fB--preserve-modtime \fR
+Output files have their timestamps/permissions set to match those of their inputs (this is default). Use --no-preserve-modtime to make output files have the current time and default permissions.
+.TP
+\fB--keep-foreign-metadata \fR
+If encoding, save WAVE, RF64, or AIFF non-audio chunks in FLAC metadata. If decoding, restore any saved non-audio chunks from FLAC metadata when writing the decoded file. Foreign metadata cannot be transcoded, e.g. WAVE chunks saved in a FLAC file cannot be restored when decoding to AIFF. Input and output must be regular files (not stdin or stdout).
+.TP
\fB--skip={\fI#\fB|\fImm:ss.ss\fB}\fR
Skip over the first number of samples of the input. This works for both encoding and decoding, but not testing. The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second.
.TP
Stop at the given sample number for each input file. This works for both encoding and decoding, but not testing. The given sample number is not included in the decoded output. The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second. If a `+' (plus) sign is at the beginning, the --until point is relative to the --skip point. If a `-' (minus) sign is at the beginning, the --until point is relative to end of the audio.
.TP
\fB--ogg\fR
-When encoding, generate Ogg FLAC output instead of native FLAC. Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer. The resulting file should have an '.ogg' extension and will still be decodable by flac.
+When encoding, generate Ogg FLAC output instead of native FLAC. Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer. The resulting file should have an '.oga' extension and will still be decodable by flac.
-When decoding, force the input to be treated as Ogg FLAC. This is useful when piping input from stdin or when the filename does not end in '.ogg'.
+When decoding, force the input to be treated as Ogg FLAC. This is useful when piping input from stdin or when the filename does not end in '.oga' or '.ogg'.
.TP
\fB--serial-number=\fI#\fB\fR
When used with --ogg, specifies the serial number to use for the first Ogg FLAC stream, which is then incremented for each additional stream. When encoding and no serial number is given, flac uses a random number for the first stream, then increments it for each additional stream. When decoding and no number is given, flac uses the serial number of the first page.
\fB--cuesheet=\fIfilename\fB\fR
Import the given cuesheet file and store it in a CUESHEET metadata block. This option may only be used when encoding a single file. A seekpoint will be added for each index point in the cuesheet to the SEEKTABLE unless --no-cued-seekpoints is specified.
.TP
-\fB--picture=\fISPECIFICATION\fB\fR
-Import a picture and store it in a PICTURE metadata block. More than one --picture command can be specified. The SPECIFICATION is a string whose parts are separated by | (pipe) characters. Some parts may be left empty to invoke default values. The format of SPECIFICATION is
+\fB--picture={\fIFILENAME\fB|\fISPECIFICATION\fB}\fR
+Import a picture and store it in a PICTURE metadata block. More than one --picture command can be specified. Either a filename for the picture file or a more complete specification form can be used. The SPECIFICATION is a string whose parts are separated by | (pipe) characters. Some parts may be left empty to invoke default values. FILENAME is just shorthand for "||||FILENAME". The format of SPECIFICATION is
-[TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE
+[TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE
TYPE is optional; it is a number from one of:
The default is 3 (front cover). There may only be one picture each of type 1 and 2 in a file.
-MIME-TYPE is mandatory; for best compatibility with players, use pictures with MIME type image/jpeg or image/png. The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.
+MIME-TYPE is optional; if left blank, it will be detected from the file. For best compatibility with players, use pictures with MIME type image/jpeg or image/png. The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.
DESCRIPTION is optional; the default is an empty string.
The specification "4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff" will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors. The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block.
.TP
\fB--sector-align\fR
-Align encoding of multiple CD format files on sector boundaries. See the HTML documentation for more information.
+Align encoding of multiple CD format files on sector boundaries. See the HTML documentation for more information. This option is DEPRECATED and may not exist in future versions of flac.
.TP
\fB-S {\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}, --seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}\fR
Include a point or points in a SEEKTABLE. Using #, a seek point at that sample number is added. Using X, a placeholder point is added at the end of a the table. Using #x, # evenly spaced seek points will be added, the first being at sample 0. Using #s, a seekpoint will be added every # seconds (# does not have to be a whole number; it can be, for example, 9.5, meaning a seekpoint every 9.5 seconds). You may use many -S options; the resulting SEEKTABLE will be the unique-ified union of all such values. With no -S options, flac defaults to '-S 10s'. Use --no-seektable for no SEEKTABLE. Note: '-S #x' and '-S #s' will not work if the encoder can't determine the input size before starting. Note: if you use '-S #' and # is >= samples in the input, there will be either no seek point entered (if the input size is determinable before encoding starts) or a placeholder point (if input size is not determinable).
Like --tag, except FILENAME is a file whose contents will be read verbatim to set the tag value. The contents will be converted to UTF-8 from the local charset. This can be used to store a cuesheet in a tag (e.g. --tag-from-file="CUESHEET=image.cue"). Do not try to store binary data in tag fields! Use APPLICATION blocks for that.
.TP
\fB-b \fI#\fB, --blocksize=\fI#\fB\fR
-Specify the block size in samples. The default is 1152 for -l 0, else 4608. Subset streams must use one of 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048, 4096 (and 8192 or 16384 if the sample rate is >48kHz).
+Specify the block size in samples. Subset streams must use one of 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048, 4096 (and 8192 or 16384 if the sample rate is >48kHz).
.TP
\fB-m, --mid-side\fR
Try mid-side coding for each frame (stereo input only)
.RS
.TP
\fB-0, --compression-level-0\fR
-Synonymous with -l 0 -b 1152 -r 2,2
+Synonymous with -l 0 -b 1152 -r 3
.TP
\fB-1, --compression-level-1\fR
-Synonymous with -l 0 -b 1152 -M -r 2,2
+Synonymous with -l 0 -b 1152 -M -r 3
.TP
\fB-2, --compression-level-2\fR
Synonymous with -l 0 -b 1152 -m -r 3
.TP
\fB-3, --compression-level-3\fR
-Synonymous with -l 6 -b 4608 -r 3,3
+Synonymous with -l 6 -b 4096 -r 4
.TP
\fB-4, --compression-level-4\fR
-Synonymous with -l 8 -b 4608 -M -r 3,3
+Synonymous with -l 8 -b 4096 -M -r 4
.TP
\fB-5, --compression-level-5\fR
-Synonymous with -l 8 -b 4608 -m -r 3,3
+Synonymous with -l 8 -b 4096 -m -r 5
.TP
\fB-6, --compression-level-6\fR
-Synonymous with -l 8 -b 4608 -m -r 4
+Synonymous with -l 8 -b 4096 -m -r 6
.TP
\fB-7, --compression-level-7\fR
-Synonymous with -l 8 -b 4608 -m -e -r 6
+Synonymous with -l 8 -b 4096 -m -e -r 6
.TP
\fB-8, --compression-level-8\fR
-Synonymous with -l 12 -b 4608 -m -e -r 6
+Synonymous with -l 12 -b 4096 -m -e -r 6
.RE
.TP
\fB--fast\fR
Precision of the quantized linear-predictor coefficients, 0 => let encoder decide (min is 5, default is 0)
.TP
\fB-r [\fI#\fB,]\fI#\fB, --rice-partition-order=[\fI#\fB,]\fI#\fB\fR
-Set the [min,]max residual partition order (0..16). min defaults to 0 if unspecified. Default is -r 3,3.
+Set the [min,]max residual partition order (0..16). min defaults to 0 if unspecified. Default is -r 5.
.SS "FORMAT OPTIONS"
.TP
\fB--endian={\fIbig\fB|\fIlittle\fB}\fR
\fB--input-size=\fI#\fB\fR
Specify the size of the raw input in bytes. If you are encoding raw samples from stdin, you must set this option in order to be able to use --skip, --until, --cue-sheet, or other options that need to know the size of the input beforehand. If the size given is greater than what is found in the input stream, the encoder will complain about an unexpected end-of-file. If the size given is less, samples will be truncated.
.TP
-\fB--force-aiff-format\fR
-Force the decoder to output AIFF format. This option is not needed if the output filename (as set by -o) ends with \fI\&.aiff\fR\&. Also, this option has no effect when encoding since input AIFF is auto-detected.
-.TP
\fB--force-raw-format\fR
Force input (when encoding) or output (when decoding) to be treated as raw samples (even if filename ends in \fI\&.wav\fR).
+.TP
+\fB--force-aiff-format\fR
+Force the decoder to output AIFF format. This option is not needed if the output filename (as set by -o) ends with \fI\&.aif\fR or \fI\&.aiff\fR\&. Also, this option has no effect when encoding since input AIFF is auto-detected.
+.TP
+\fB--force-rf64-format\fR
+Force the decoder to output RF64 format. This option is not needed if the output filename (as set by -o) ends with \fI\&.rf64\fR\&. Also, this option has no effect when encoding since input RF64 is auto-detected.
+.TP
+\fB--force-wave64-format\fR
+Force the decoder to output Wave64 format. This option is not needed if the output filename (as set by -o) ends with \fI\&.w64\fR\&. Also, this option has no effect when encoding since input Wave64 is auto-detected.
.SS "NEGATIVE OPTIONS"
.TP
\fB--no-adaptive-mid-side\fR
.TP
\fB--no-delete-input-file\fR
.TP
+\fB--no-preserve-modtime\fR
+.TP
+\fB--no-keep-foreign-metadata\fR
+.TP
\fB--no-exhaustive-model-search\fR
.TP
+\fB--no-force\fR
+.TP
\fB--no-lax\fR
.TP
\fB--no-mid-side\fR
.TP
\fB--no-qlp-coeff-precision-search\fR
.TP
+\fB--no-replay-gain\fR
+.TP
\fB--no-residual-gnuplot\fR
.TP
\fB--no-residual-text\fR
\fB--no-silent\fR
.TP
\fB--no-verify\fR
+.TP
+\fB--no-warnings-as-errors\fR
These flags can be used to invert the sense of the corresponding normal option.
.SH "SEE ALSO"
.PP
projects / platform / upstream / flac.git / blobdiff