Commit 9906056d authored by Josh Coalson's avatar Josh Coalson
Browse files

add --until, --cuesheet, --force-aiff-format

parent eb7a8e4b
......@@ -129,7 +129,7 @@
<B>METADATA</B>
</P>
<P>
FLAC defines several types of metadata blocks (see the <A HREF="format.html">format</A> page for the complete list. Metadata blocks can be any length and new ones can be defined. A decoder is allowed to skip any metadata types it does not understand. Only one is mandatory: the STREAMINFO block. This block has information like the sample rate, number of channels, etc., and data that can help the decoder manage its buffers, like the minimum and maximum data rate and minimum and maximum block size. Also included in the STREAMINFO block is the MD5 signature of the <I>unencoded</I> audio data. This is useful for checking an entire stream for transmission errors.
FLAC defines several types of metadata blocks (see the <A HREF="format.html">format</A> page for the complete list). Metadata blocks can be any length and new ones can be defined. A decoder is allowed to skip any metadata types it does not understand. Only one is mandatory: the STREAMINFO block. This block has information like the sample rate, number of channels, etc., and data that can help the decoder manage its buffers, like the minimum and maximum data rate and minimum and maximum block size. Also included in the STREAMINFO block is the MD5 signature of the <I>unencoded</I> audio data. This is useful for checking an entire stream for transmission errors.
</P>
<P>
Other blocks allow for padding, seek tables, and application-specific data. You can see <B><TT>flac</TT></B> options below for adding PADDING blocks or specifying seek points. FLAC does not require seek points for seeking but they can speed up seeks, or be used for cueing in editing applications.
......@@ -223,16 +223,16 @@
<B><TT>flac</TT></B> will be invoked one of four ways, depending on whether you are encoding, decoding, testing, or analyzing:
<UL>
<LI>
Encoding: flac [-s] [--skip #] [-V] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#encoding_options">&lt;encoding options&gt;</A></I>] [inputfile [...]]
Encoding: flac [<I><A HREF="#general_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#encoding_options">&lt;encoding options&gt;</A></I>] [inputfile [...]]
</LI>
<LI>
Decoding: flac -d [-s] [--skip #] [-F] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [inputfile [...]]
Decoding: flac -d [<I><A HREF="#general_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [FLACfile [...]]
</LI>
<LI>
Testing: flac -t [-s] [inputfile [...]]
Testing: flac -t [<I><A HREF="#general_options">&lt;format-options&gt;</A></I>] [FLACfile [...]]
</LI>
<LI>
Analyzing: flac -a [-s] [--skip #] [<I><A HREF="#analysis_options">&lt;analysis-options&gt;</A></I>] [inputfile [...]]
Analyzing: flac -a [<I><A HREF="#general_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#analysis_options">&lt;analysis-options&gt;</A></I>] [FLACfile [...]]
</LI>
</UL>
</P>
......@@ -366,10 +366,27 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
<TT>--skip=#</TT>
<TT>--skip={#|mm:ss.ss}</TT>
</TD>
<TD>
Skip over the first # of samples of the input. This works for both encoding and decoding, but not testing.
Skip over the first # of samples of the input. This works for both encoding and decoding, but not testing. The alternative form <TT>mm:ss.ss</TT> can be used to specify minutes, seconds, and fractions of a second.<P>
Examples:<P>
<TT>--skip=123</TT> : skip the first 123 samples of the input<P>
<TT>--skip=1:23.45</TT> : skip the first 1 minute and 23.45 samples of the input
</TD>
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
<TT>--until={#|[+|-]mm:ss.ss}</TT>
</TD>
<TD>
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 <TT>mm:ss.ss</TT> can be used to specify minutes, seconds, and fractions of a second. If a <TT>+</TT> sign is at the beginning, the --until point is relative to the --skip point. If a <TT>-</TT> sign is at the beginning, the --until point is relative to end of the audio.<P>
Examples:<P>
<TT>--until=123</TT> : decode only the first 123 samples of the input (samples 0-122, stopping at 123)<P>
<TT>--until=1:23.45</TT> : decode only the first 1 minute and 23.45 seconds of the input<P>
<TT>--skip=1:00 --until=+1:23.45</TT> : decode 1:00 to 2:23.45<P>
<TT>--until=-1:23.45</TT> : decode everything except the last 1 minute and 23.45 seconds<P>
<TT>--until=-0:00</TT> : decode until the end of the input (the same as not specifying <TT>--until</TT>)
</TD>
</TR>
<TR>
......@@ -471,6 +488,15 @@
Note that this option cannot be used when encoding to standard output (stdout).
</TD>
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
<TT>--cuesheet=FILENAME</TT>
</TD>
<TD>
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.<P>
The cuesheet file must be of the sort written by <A HREF="http://www.goldenhawk.com/cdrwin.htm">CDRwin</A>, <A HREF="http://www.dcsoft.com/prod03.htm">CDRcue</A>, <A HREF="http://www.exactaudiocopy.de/">EAC</A>, et al.
</TD>
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
<TT>--sector-align</TT>
......@@ -735,6 +761,14 @@
Specify that the samples in the raw file are signed or unsigned (the default is signed).
</TD>
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
<TT>--force-aiff-format</TT>
</TD>
<TD>
Force the decoder to output AIFF format. This option is not needed if the output filename (as set by -o) ends with .aiff. Also, this option has no effect when encoding since input AIFF is auto-detected.
</TD>
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
<TT>--force-raw-format</TT>
......@@ -803,7 +837,7 @@
<B><TT>metaflac</TT></B> is the command-line <TT>.flac</TT> file metadata editor. You can use it to list the contents of blocks, delete or insert blocks, and manage padding.
</P>
<P>
The documentation for <B><TT>metaflac</TT></B> is currently being rewritten, but the usage screen should explain it pretty well. Do <TT>metaflac --help</TT> to see the full usage.
The HTML documentation for <B><TT>metaflac</TT></B> is currently being rewritten, but the usage screen should explain it pretty well, and there is a man page. Do <TT>metaflac --help</TT> to see the full usage.
</P>
</FONT>
</TD></TR>
......
......@@ -3,7 +3,7 @@
.\" <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" "02 December 2002" "" ""
.TH "FLAC" "1" "20 December 2002" "" ""
.SH NAME
flac \- Free Lossless Audio Codec
.SH SYNOPSIS
......@@ -23,7 +23,7 @@ format; see below.
.PP
A summary of options is included below. For a complete
description, see the HTML documentation.
.SS "GENERIC OPTIONS"
.SS "GENERAL OPTIONS"
.TP
\fB-v, --version \fR
Show the flac version number
......@@ -71,10 +71,23 @@ successful encode or decode. If there was an
error (including a verify error) the input file
is left intact.
.TP
\fB--skip=\fI#\fB\fR
Skip the specified number of samples at the
beginning of the input file (can be used for both
encoding and decoding)
\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
\fB--until={\fI#\fB|[\fI+\fB|\fI-\fB]\fImm:ss.ss\fB}\fR
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
......@@ -142,6 +155,13 @@ size of the tags is not known until all files
are processed. Note that this option cannot be
used when encoding to standard output (stdout).
.TP
\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--sector-align\fR
Align encoding of multiple CD format WAVE
files on sector boundaries. See the HTML
......@@ -284,6 +304,12 @@ Set sample rate (in Hz).
\fB--sign={\fIsigned\fB|\fIunsigned\fB}\fR
Set the sign of samples (the default is signed).
.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
......@@ -325,6 +351,8 @@ These flags can be used to invert the sense
of the corresponding normal option.
.SH "SEE ALSO"
.PP
metaflac(1).
.PP
The programs are documented fully by HTML format
documentation, available in
\fI/usr/share/doc/flac/html\fR on
......
......@@ -4,7 +4,7 @@
<!ENTITY dhfirstname "<firstname>Matt</firstname>">
<!ENTITY dhsurname "<surname>Zimmerman</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>November 6, 2002</date>">
<!ENTITY dhdate "<date>December 18, 2002</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
......@@ -70,7 +70,7 @@
description, see the HTML documentation.</para>
<refsect2>
<title>Generic Options</title>
<title>General Options</title>
<variablelist>
<varlistentry>
......@@ -173,11 +173,28 @@
</varlistentry>
<varlistentry>
<term><option>--skip</option>=<replaceable>#</replaceable></term>
<term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
<listitem>
<para>Skip the specified number of samples at the
beginning of the input file (can be used for both
encoding and decoding)</para>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
......@@ -305,6 +322,18 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sector-align</option></term>
......@@ -610,6 +639,17 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--force-aiff-format</option></term>
<listitem>
<para>Force the decoder to output AIFF format. This option
is not needed if the output filename (as set by -o) ends
with <filename>.aiff</filename>. Also, this option has no
effect when encoding since input AIFF is auto-detected.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--force-raw-format</option></term>
......@@ -657,6 +697,8 @@
<refsect1>
<title>SEE ALSO</title>
<para>metaflac(1).</para>
<para>The programs are documented fully by HTML format
documentation, available in
<filename>/usr/share/doc/flac/html</filename> on
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment