summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorluz.paz <luzpaz@users.noreply.github.com>2018-05-22 10:17:53 -0400
committerErik de Castro Lopo <erikd@mega-nerd.com>2018-05-24 07:20:19 +1000
commit01eb19708c11f6aae1013e7c9c29c83efda33bfb (patch)
tree63e8b47f83baacc674f28f5328fa52d045fd45d2 /doc
parent0db0e878b8c7eb09f9f42fb39ca43b7cbc5e8aca (diff)
downloadflac-01eb19708c11f6aae1013e7c9c29c83efda33bfb.tar.gz
Fix miscellaneous typos.
Found via `codespell -q 3`
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in2
-rw-r--r--doc/html/changelog.html12
-rw-r--r--doc/html/documentation_format_overview.html2
-rw-r--r--doc/html/documentation_tools_flac.html4
-rw-r--r--doc/html/format.html4
5 files changed, 12 insertions, 12 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index b6bf2ed5..ba71f8f9 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -386,7 +386,7 @@ SHOW_DIRECTORIES = YES
# version control system). Doxygen will invoke the program by executing (via
# popen()) the command <command> <input-file>, where <command> is the value of
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
-# provided by doxygen. Whatever the progam writes to standard output
+# provided by doxygen. Whatever the program writes to standard output
# is used as the file version. See the manual for examples.
FILE_VERSION_FILTER =
diff --git a/doc/html/changelog.html b/doc/html/changelog.html
index 5cc98e9f..214a62c4 100644
--- a/doc/html/changelog.html
+++ b/doc/html/changelog.html
@@ -42,7 +42,7 @@
</div>
<div class="box_header"></div>
<div class="box_body">
- This is an informal changelog, a summary of changes in each release. (See also <a href="documentation_bugs.html">known bugs</a>.) Particulary important for developers is the precise description of changes to the library interfaces. See also the <a href="api/group__porting.html">porting guide</a> for specific instructions on porting to newer versions of FLAC.<br />
+ This is an informal changelog, a summary of changes in each release. (See also <a href="documentation_bugs.html">known bugs</a>.) Particularly important for developers is the precise description of changes to the library interfaces. See also the <a href="api/group__porting.html">porting guide</a> for specific instructions on porting to newer versions of FLAC.<br />
<a name="flac_1_3_2"><b>FLAC 1.3.2</b> (01-Jan-2017)</a>
@@ -331,7 +331,7 @@
<li>
libFLAC++:
<ul>
- <li>Add a number of convienience methods.</li>
+ <li>Add a number of convenience methods.</li>
</ul>
</li>
</ul>
@@ -718,8 +718,8 @@
<li>
libraries:
<ul>
- <li>Merged libOggFLAC into libFLAC; both formats are now supporte through the same API.</li>
- <li>Merged libOggFLAC++ into libFLAC++; both formats are now supporte through the same API.</li>
+ <li>Merged libOggFLAC into libFLAC; both formats are now supported through the same API.</li>
+ <li>Merged libOggFLAC++ into libFLAC++; both formats are now supported through the same API.</li>
<li>libFLAC and libFLAC++: Simplified encoder setup with new <span class="argument">FLAC__stream_encoder_set_compression_level()</span> function.</li>
<li>libFLAC: Improved compression with no impact on FLAC format or decoding time by adding a windowing stage before LPC analysis.</li>
<li>libFLAC: Fixed a bug where missing STREAMINFO fields (min/max framesize, total samples, MD5 sum) and seek point offsets were not getting rewritten back to Ogg FLAC file (<a href="http://sourceforge.net/p/flac/bugs/197/">SF #1338969</a>).</li>
@@ -734,8 +734,8 @@
<li>
all libraries;
<ul>
- <li>Merged libOggFLAC into libFLAC; both formats are now supporte through the same API.</li>
- <li>Merged libOggFLAC++ into libFLAC++; both formats are now supporte through the same API.</li>
+ <li>Merged libOggFLAC into libFLAC; both formats are now supported through the same API.</li>
+ <li>Merged libOggFLAC++ into libFLAC++; both formats are now supported through the same API.</li>
<li>Merged seekable stream decoder and file decoder into the stream decoder.</li>
<li>Merged seekable stream encoder and file encoder into the stream encoder.</li>
<li>Added #defines for the API version number to make porting easier; see <tt>include/lib*FLAC*/export.h</tt>.</li>
diff --git a/doc/html/documentation_format_overview.html b/doc/html/documentation_format_overview.html
index f2742e15..758f6cb8 100644
--- a/doc/html/documentation_format_overview.html
+++ b/doc/html/documentation_format_overview.html
@@ -73,7 +73,7 @@
<br />
<b>MODELING</b><br />
<br />
- In the next stage, the encoder tries to approximate the signal with a function in such a way that when the approximation is subracted, the result (called the <i>residual</i>, <i>residue</i>, or <i>error</i>) requires fewer bits-per-sample to encode. The function's parameters also have to be transmitted so they should not be so complex as to eat up the savings. FLAC has two methods of forming approximations: 1) fitting a simple polynomial to the signal; and 2) general linear predictive coding (LPC). I will not go into the details here, only some generalities that involve the encoding options.<br />
+ In the next stage, the encoder tries to approximate the signal with a function in such a way that when the approximation is subtracted, the result (called the <i>residual</i>, <i>residue</i>, or <i>error</i>) requires fewer bits-per-sample to encode. The function's parameters also have to be transmitted so they should not be so complex as to eat up the savings. FLAC has two methods of forming approximations: 1) fitting a simple polynomial to the signal; and 2) general linear predictive coding (LPC). I will not go into the details here, only some generalities that involve the encoding options.<br />
<br />
First, fixed polynomial prediction (specified with <span class="argument">-l 0</span>) is much faster, but less accurate than LPC. The higher the maximum LPC order, the slower, but more accurate, the model will be. However, there are diminishing returns with increasing orders. Also, at some point (usually around order 9) the part of the encoder that guesses what is the best order to use will start to get it wrong and the compression will actually decrease slightly; at that point you will have to you will have to use the exhaustive search option <span class="argument">-e</span> to overcome this, which is significantly slower.<br />
<br />
diff --git a/doc/html/documentation_tools_flac.html b/doc/html/documentation_tools_flac.html
index 09c8f244..aca194b6 100644
--- a/doc/html/documentation_tools_flac.html
+++ b/doc/html/documentation_tools_flac.html
@@ -538,7 +538,7 @@
<span class="argument">-V</span>, <span class="argument">--verify</span>
</td>
<td>
- Verify the encoding process. With this option, <span class="commandname">flac</span> will create a parallel decoder that decodes the output of the encoder and compares the result against the original. It will abort immediately with an error if a mismatch occurs. <span class="argument">-V</span> increases the total encoding time but is guaranteed to catch any unforseen bug in the encoding process.
+ Verify the encoding process. With this option, <span class="commandname">flac</span> will create a parallel decoder that decodes the output of the encoder and compares the result against the original. It will abort immediately with an error if a mismatch occurs. <span class="argument">-V</span> increases the total encoding time but is guaranteed to catch any unforeseen bug in the encoding process.
</td>
</tr>
<tr>
@@ -612,7 +612,7 @@
<br />
<span class="argument">DESCRIPTION</span> is optional; the default is an empty string.<br />
<br />
- The next part specfies the resolution and color information. If the <span class="argument">MIME-TYPE</span> is <tt>image/jpeg</tt>, <tt>image/png</tt>, or <tt>image/gif</tt>, you can usually leave this empty and they can be detected from the file. Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel. If the image has indexed colors you should also specify the number of colors used. When manually specified, it is not checked against the file for accuracy.<br />
+ The next part specifies the resolution and color information. If the <span class="argument">MIME-TYPE</span> is <tt>image/jpeg</tt>, <tt>image/png</tt>, or <tt>image/gif</tt>, you can usually leave this empty and they can be detected from the file. Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel. If the image has indexed colors you should also specify the number of colors used. When manually specified, it is not checked against the file for accuracy.<br />
<br />
<span class="argument">FILE</span> is the path to the picture file to be imported, or the URL if MIME type is --&gt;<br />
<br />
diff --git a/doc/html/format.html b/doc/html/format.html
index 1047092a..20f257a2 100644
--- a/doc/html/format.html
+++ b/doc/html/format.html
@@ -175,7 +175,7 @@
<br />
<a name="definitions"><font size="+1"><b><u>Definitions</u></b></font></a><br />
<br />
- Many terms like "block" and "frame" are used to mean different things in differenct encoding schemes. For example, a frame in MP3 corresponds to many samples across several channels, whereas an S/PDIF frame represents just one sample for each channel. The definitions we use for FLAC follow. Note that when we talk about blocks and subblocks we are referring to the raw unencoded audio data that is the input to the encoder, and when we talk about frames and subframes, we are referring to the FLAC-encoded data.
+ Many terms like "block" and "frame" are used to mean different things in different encoding schemes. For example, a frame in MP3 corresponds to many samples across several channels, whereas an S/PDIF frame represents just one sample for each channel. The definitions we use for FLAC follow. Note that when we talk about blocks and subblocks we are referring to the raw unencoded audio data that is the input to the encoder, and when we talk about frames and subframes, we are referring to the FLAC-encoded data.
<ul>
<li>
<b>Block</b>: One or more audio samples that span several channels.
@@ -241,7 +241,7 @@
<br />
FLAC currently defines two similar methods for the coding of the error signal from the prediction stage. The error signal is coded using Rice codes in one of two ways: 1) the encoder estimates a single Rice parameter based on the variance of the residual and Rice codes the entire residual using this parameter; 2) the residual is partitioned into several equal-length regions of contiguous samples, and each region is coded with its own Rice parameter based on the region's mean. (Note that the first method is a special case of the second method with one partition, except the Rice parameter is based on the residual variance instead of the mean.)<br />
<br />
- The FLAC format has reserved space for other coding methods. Some possiblities for volunteers would be to explore better context-modeling of the Rice parameter, or Huffman coding. See <a href="http://www.hpl.hp.com/techreports/98/HPL-98-193.html">LOCO-I</a> and <a href="http://www.cs.tut.fi/~albert/Dev/pucrunch/packing.html">pucrunch</a> for descriptions of several universal codes.<br />
+ The FLAC format has reserved space for other coding methods. Some possibilities for volunteers would be to explore better context-modeling of the Rice parameter, or Huffman coding. See <a href="http://www.hpl.hp.com/techreports/98/HPL-98-193.html">LOCO-I</a> and <a href="http://www.cs.tut.fi/~albert/Dev/pucrunch/packing.html">pucrunch</a> for descriptions of several universal codes.<br />
<br />
<a name="format_overview"><font size="+1"><b><u>Format</u></b></font></a><br />
<br />