mirrors
/
flac
mirror of https://github.com/xiph/flac
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes: preset description and subset blocksizes 

As described in github issue #236, the description of compression
presets in flac.sgml wasn't updated. Also, the description of which
blocksizes are considered subset has been lagging behind in the
manpages as well as the build-in help of FLAC for years, as this
was changed back in 2007. This commit fixes those issues
This commit is contained in:
Martijn van Beurden 2021-08-31 08:55:06 +02:00
parent f59cb6f7b4
commit a21bdc4a9e
3 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/flac.1
View File

@ -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" "2013/09/18" "" ""
.TH "FLAC" "1" "2021/08/31" "" ""
.SH NAME
flac \- Free Lossless Audio Codec
@ -230,7 +230,7 @@ Add a FLAC tag. The comment must adhere to the Vorbis comment spec; i.e. the FI
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. 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 blocksize in samples. The default is 1152 for -l 0, else 4096. For subset streams this must be <= 4608 if the samplerate <= 48kHz, for subset streams with higher samplerates it must be <= 16384.
.TP
\fB-m, --mid-side\fR
Try mid-side coding for each frame (stereo input only)

14
man/flac.sgml
View File

@ -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>2013/09/18</date>">
<!ENTITY dhdate "<date>2021/08/31</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
@ -27,7 +27,7 @@
&dhsurname;
</author>
<copyright>
<year>2002-2005, 2011-2013</year>
<year>2002-2005, 2011-2021</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
@ -480,7 +480,7 @@
<term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
<listitem>
<para>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 &gt;48kHz).</para>
<para>Specify the blocksize in samples. The default is 1152 for -l 0, else 4096. For subset streams this must be &lt;= 4608 if the samplerate &lt;= 48kHz, for subset streams with higher samplerates it must be &lt;= 16384.</para>
</listitem>
</varlistentry>
@ -511,7 +511,7 @@
<term><option>-0</option>, <option>--compression-level-0</option></term>
<listitem>
<para>Synonymous with -l 0 -b 1152 -r 3</para>
<para>Synonymous with -l 0 -b 1152 -r 3 --no-mid-side</para>
</listitem>
</varlistentry>
@ -535,7 +535,7 @@
<term><option>-3</option>, <option>--compression-level-3</option></term>
<listitem>
<para>Synonymous with -l 6 -b 4096 -r 4</para>
<para>Synonymous with -l 6 -b 4096 -r 4 --no-mid-side</para>
</listitem>
</varlistentry>
@ -567,7 +567,7 @@
<term><option>-7</option>, <option>--compression-level-7</option></term>
<listitem>
<para>Synonymous with -l 8 -b 4096 -m -e -r 6 -A tukey(0.5) -A partial_tukey(2)</para>
<para>Synonymous with -l 12 -b 4096 -m -r 6 -A tukey(0.5) -A partial_tukey(2)</para>
</listitem>
</varlistentry>
@ -575,7 +575,7 @@
<term><option>-8</option>, <option>--compression-level-8</option></term>
<listitem>
<para>Synonymous with -l 12 -b 4096 -m -e -r 6 -A tukey(0.5) -A partial_tukey(2) -A punchout_tukey(3)</para>
<para>Synonymous with -l 12 -b 4096 -m -r 6 -A tukey(0.5) -A partial_tukey(2) -A punchout_tukey(3)</para>
</listitem>
</varlistentry>
</variablelist>

10
src/flac/main.c
View File

@ -1569,14 +1569,16 @@ void show_explain(void)
printf(" block of 8192 bytes by default, or 65536 bytes\n");
printf(" if the input audio is more than 20 minutes long.\n");
printf(" -b, --blocksize=# Specify the blocksize in samples; the default is\n");
printf(" 1152 for -l 0, else 4096; must be one of 192,\n");
printf(" 576, 1152, 2304, 4608, 256, 512, 1024, 2048,\n");
printf(" 4096 (and 8192 or 16384 if the sample rate is\n");
printf(" >48kHz) for Subset streams.\n");
printf(" 1152 for -l 0, else 4096; for subset streams this\n");
printf(" must be <= 4608 if the samplerate <= 48kHz,\n");
printf(" for subset streams with a higher samplerates it\n");
printf(" must be <= 16384.\n");
printf(" -0, --compression-level-0, --fast Synonymous with -l 0 -b 1152 -r 3\n");
printf(" --no-mid-side\n");
printf(" -1, --compression-level-1 Synonymous with -l 0 -b 1152 -M -r 3\n");
printf(" -2, --compression-level-2 Synonymous with -l 0 -b 1152 -m -r 3\n");
printf(" -3, --compression-level-3 Synonymous with -l 6 -b 4096 -r 4\n");
printf(" --no-mid-side\n");
printf(" -4, --compression-level-4 Synonymous with -l 8 -b 4096 -M -r 4\n");
printf(" -5, --compression-level-5 Synonymous with -l 8 -b 4096 -m -r 5\n");
printf(" -5 is the default setting\n");