1872 lines
69 KiB
Diff
1872 lines
69 KiB
Diff
diff -urNp a/userguide/avstopam.html b/userguide/avstopam.html
|
|
--- a/userguide/avstopam.html 2021-06-02 12:56:59.584286425 +0200
|
|
+++ b/userguide/avstopam.html 2021-06-02 15:00:33.799300026 +0200
|
|
@@ -2,12 +2,13 @@
|
|
<html><head><title>Avstopam User Manual</title></head>
|
|
<body>
|
|
<h1>avstopam</h1>
|
|
-Updated: 07 February 2010
|
|
-<br>
|
|
-<a href="#index">Table Of Contents</a>
|
|
+
|
|
+<p>Updated: 07 February 2010</p>
|
|
+
|
|
+<p><a href="#index">Table Of Contents</a></p>
|
|
<h2>NAME</h2>
|
|
|
|
-<p>avstopam - convert an AVS X image to a Netpbm image
|
|
+<p>avstopam - convert an AVS X image to a Netpbm image</p>
|
|
|
|
<h2 id="synopsis">SYNOPSIS</h2>
|
|
|
|
@@ -16,40 +17,40 @@ Updated: 07 February 2010
|
|
|
|
<h2 id="description">DESCRIPTION</h2>
|
|
|
|
-<p>This program is part of <a href="index.html">Netpbm</a>.
|
|
+<p>This program is part of <a href="index.html">Netpbm</a>.</p>
|
|
|
|
<p><b>avstopam</b> reads a Stardent <abbr title="Application
|
|
Visualization System">AVS</abbr> X image as input and produces a Netpbm
|
|
-image as output.
|
|
+image as output.</p>
|
|
|
|
<p><i>avsfile</i> is the input file, which defaults to Standard Input.
|
|
-Output is always on Standard Output.
|
|
+Output is always on Standard Output.</p>
|
|
|
|
<h2 id="options">OPTIONS</h2>
|
|
|
|
<p>There are no command line options defined specifically
|
|
for <b>avstopam</b>, but it recognizes the options common to all
|
|
programs based on libnetpbm (See <a href="index.html#commonoptions">
|
|
-Common Options</a>.)
|
|
+Common Options</a>.)</p>
|
|
|
|
<h2 id="author">AUTHOR</h2>
|
|
|
|
<p>Copyright © 2010 Scott Pakin,
|
|
-<a href="mailto:scott+pbm@pakin.org">scott+pbm@pakin.org</a>
|
|
+<a href="mailto:scott+pbm@pakin.org">scott+pbm@pakin.org</a></p>
|
|
|
|
<h2 id="seealso">SEE ALSO</h2>
|
|
|
|
-<p><a href="pamtoavs.html">pamtoavs</a>, <a href="pam.html">pam</a>
|
|
+<p><a href="pamtoavs.html">pamtoavs</a>, <a href="pam.html">pam</a></p>
|
|
|
|
<hr>
|
|
|
|
<h2 id="index">Table Of Contents</h2>
|
|
<ul>
|
|
-<li><a href="#synopsis">SYNOPSIS</a>
|
|
-<li><a href="#description">DESCRIPTION</a>
|
|
-<li><a href="#options">OPTIONS</a>
|
|
-<li><a href="#author">AUTHOR</a>
|
|
-<li><a href="#seealso">SEE ALSO</a>
|
|
+<li><a href="#synopsis">SYNOPSIS</a></li>
|
|
+<li><a href="#description">DESCRIPTION</a></li>
|
|
+<li><a href="#options">OPTIONS</a></li>
|
|
+<li><a href="#author">AUTHOR</a></li>
|
|
+<li><a href="#seealso">SEE ALSO</a></li>
|
|
</ul>
|
|
</body>
|
|
</html>
|
|
diff -urNp a/userguide/faxformat.html b/userguide/faxformat.html
|
|
--- a/userguide/faxformat.html 2021-06-02 12:56:59.576286351 +0200
|
|
+++ b/userguide/faxformat.html 2021-06-02 15:02:58.710711998 +0200
|
|
@@ -5,10 +5,11 @@
|
|
Updated: 03 December 2008
|
|
<br>
|
|
|
|
+<h2>SYNOPSIS</h2>
|
|
<p>This page, part of the <a href="index.html">Netpbm user's guide</a>,
|
|
describes FAX formats in relation to Netpbm facilities.
|
|
|
|
-
|
|
+<h2>DESCRIPTION</h2>
|
|
<p>The ITU (formerly CCITT) publishes standards for operation of fax machines
|
|
(the idea is to provide a way to be sure that a fax machine is able to receive
|
|
a fax sent by another). These standards incidentally specify graphics file
|
|
diff -urNp a/userguide/libnetpbm_ug.html b/userguide/libnetpbm_ug.html
|
|
--- a/userguide/libnetpbm_ug.html 2021-06-02 12:56:59.584286425 +0200
|
|
+++ b/userguide/libnetpbm_ug.html 2021-06-02 14:36:35.392293125 +0200
|
|
@@ -374,7 +374,7 @@ plain format.
|
|
<h2 id="reference">Reference</h2>
|
|
|
|
<p>The <a href="libnetpbm_image.html">Libnetpbm Netpbm Image
|
|
-Processing Manual</a> describes the the <b>libnetpbm</b> functions for
|
|
+Processing Manual</a> describes the <b>libnetpbm</b> functions for
|
|
processing image data.
|
|
|
|
<p>The <a href="libpm.html">Libnetpbm Utility Manual</a>
|
|
diff -urNp a/userguide/pamfunc.html b/userguide/pamfunc.html
|
|
--- a/userguide/pamfunc.html 2021-06-02 12:56:59.585286434 +0200
|
|
+++ b/userguide/pamfunc.html 2021-06-02 14:40:09.474375441 +0200
|
|
@@ -60,7 +60,7 @@ output image.
|
|
and bit string (such as and with 01001000). For the arithmetic functions, the
|
|
function arguments and results are the fraction that a sample is of the
|
|
maxval, i.e. normal interpretation of PAM tuples. But for the bit string
|
|
-functions, the value is the the bit string whose value as a binary cipher is
|
|
+functions, the value is the bit string whose value as a binary cipher is
|
|
the sample value, and the maxval indicates the width of the bit string.
|
|
|
|
<h4>Arithmetic functions</h4>
|
|
diff -urNp a/userguide/pammixmulti.html b/userguide/pammixmulti.html
|
|
--- a/userguide/pammixmulti.html 2021-06-02 12:56:59.586286443 +0200
|
|
+++ b/userguide/pammixmulti.html 2021-06-02 14:28:03.105311615 +0200
|
|
@@ -7,8 +7,8 @@ Updated: 18 November 2018
|
|
<a href="#index">Table Of Contents</a>
|
|
|
|
|
|
-<h2>NAME</h2>
|
|
-<p>pammixmulti - blend together multiple PAM images
|
|
+<h2 id="name">NAME</h2>
|
|
+<p>pammixmulti - blend together multiple PAM images</p>
|
|
|
|
|
|
<h2 id="synopsis">SYNOPSIS</h2>
|
|
@@ -22,14 +22,14 @@ Updated: 18 November 2018
|
|
<p>Minimum unique abbreviation of an option is acceptable. You can use a
|
|
single hyphen instead of double hyphens to denote options. You can use white
|
|
space in place of the equals sign to separate an option name from its
|
|
-value.
|
|
+value.</p>
|
|
|
|
|
|
<h2 id="description">DESCRIPTION</h2>
|
|
-<p>This file is part of <a href="index.html">Netpbm</a>.
|
|
+<p>This file is part of <a href="index.html">Netpbm</a>.</p>
|
|
|
|
<p><b>pammixmulti</b> mixes two or more images to produce a new image. The
|
|
-program provides multiple ways to interpret "mix."
|
|
+program provides multiple ways to interpret "mix."</p>
|
|
|
|
|
|
<h2 id="options">OPTIONS</h2>
|
|
@@ -37,7 +37,7 @@ program provides multiple ways to interp
|
|
<p>In addition to the options common to all programs based on libnetpbm
|
|
(most notably <b>-quiet</b>, see <a href="index.html#commonoptions">
|
|
Common Options</a>), <b>pammixmulti</b> recognizes the following
|
|
-command line options:
|
|
+command line options:</p>
|
|
|
|
<dl compact>
|
|
<dt><b>--blend</b>=average|random|mask</dt>
|
|
@@ -50,7 +50,7 @@ output is produced by selecting the corr
|
|
images, chosen at random on a per-pixel basis. With
|
|
<b>--blend</b>=<code>mask</code>, each pixel in the output is produced by a
|
|
weighted average of the corresponding pixels from all the input images based
|
|
-on the grayscale level of an additional mask image.
|
|
+on the grayscale level of an additional mask image.</p>
|
|
</dd>
|
|
|
|
<dt><b>--maskfile</b>=<i>filename</i></dt>
|
|
@@ -60,7 +60,7 @@ grayscale mask file to control the blend
|
|
not grayscale, the first channel is treated as gray). Where the mask file is
|
|
black, the first image is selected. Where the mask file is white, the last
|
|
image is selected. Intermediate levels of gray select intermediate
|
|
-images.
|
|
+images.</p>
|
|
</dd>
|
|
|
|
<dt><b>--stdev</b>=<i>number</i></dt>
|
|
@@ -77,7 +77,7 @@ that includes roughly equal amounts of t
|
|
and 2 but less of the corresponding pixel from image 3. As <i>number</i>
|
|
tends towards the number of input images (going beyond that has diminishing
|
|
impact), the output tends to look more
|
|
-like <b>--blend</b>=average. <i>number</i> defaults to 0.25.
|
|
+like <b>--blend</b>=average. <i>number</i> defaults to 0.25.</p>
|
|
</dd>
|
|
|
|
<dt><b>--randomseed</b> <i>integer</i>
|
|
@@ -85,45 +85,45 @@ like <b>--blend</b>=average. <i>number</
|
|
<dd>This is the seed for the random number generator used with
|
|
<b>--blend=random</b>
|
|
|
|
-<p>Use this to ensure you get the same image on separate invocations.
|
|
+<p>Use this to ensure you get the same image on separate invocations.</p>
|
|
|
|
</dl>
|
|
|
|
<h2 id="arguments">ARGUMENTS</h2>
|
|
|
|
-<p>You supply the names of the files to mix as non-option arguments.
|
|
+<p>You supply the names of the files to mix as non-option arguments.</p>
|
|
|
|
|
|
<h2 id="examples">EXAMPLES</h2>
|
|
|
|
-<p>Average a bunch of PPM images to produce a new PAM image:
|
|
+<p>Average a bunch of PPM images to produce a new PAM image:</p>
|
|
<pre><code>
|
|
pammixmulti input*.ppm >output.ppm
|
|
</code></pre>
|
|
|
|
<p>Mix these same images by taking each pixel from a randomly selected input
|
|
-image:
|
|
+image:</p>
|
|
|
|
<pre><code>
|
|
pammixmulti --blend=random input*.ppm >output.ppm
|
|
</code></pre>
|
|
|
|
<p>Use a mask image to control the fading among input images on a
|
|
-pixel-by-pixel basis:
|
|
+pixel-by-pixel basis:</p>
|
|
|
|
<pre><code>
|
|
pammixmulti --blend=mask --maskfile=mask.pgm >output.pam \
|
|
one.pam two.pam three.pam four.pam
|
|
</code></pre>
|
|
|
|
-<p>Do the same but with more abrupt transitions:
|
|
+<p>Do the same but with more abrupt transitions:</p>
|
|
|
|
<pre><code>
|
|
pammixmulti --blend=mask --maskfile=mask.pgm --stdev=0.0 >output.pam \
|
|
one.pam two.pam three.pam four.pam
|
|
</code></pre>
|
|
|
|
-<p>and now with more gradual transitions:
|
|
+<p>and now with more gradual transitions:</p>
|
|
|
|
<pre><code>
|
|
pammixmulti --blend=mask --maskfile=mask.pgm --stdev=1.0 >output.pam \
|
|
@@ -133,12 +133,12 @@ pixel-by-pixel basis:
|
|
|
|
<h2 id="history">HISTORY</h2>
|
|
|
|
-<p><b>pammixmulti</b> was new in Netpbm 10.85 (December 2018).
|
|
+<p><b>pammixmulti</b> was new in Netpbm 10.85 (December 2018).</p>
|
|
|
|
|
|
<h2 id="author">AUTHOR</h2>
|
|
|
|
-<p>Copyright 2018 Scott Pakin, scott+pbm@pakin.org.
|
|
+<p>Copyright 2018 Scott Pakin, scott+pbm@pakin.org.</p>
|
|
|
|
<h2 id="seealso">SEE ALSO</h2>
|
|
|
|
@@ -146,20 +146,20 @@ pixel-by-pixel basis:
|
|
<a href="ppmmix.html">ppmmix</a>,
|
|
<a href="pamarith.html">pamarith</a>,
|
|
<a href="pnm.html">pnm</a>,
|
|
-<a href="pam.html">pam</a>
|
|
+<a href="pam.html">pam</a></p>
|
|
|
|
|
|
<h2 id="index">Table Of Contents</h2>
|
|
|
|
<ul>
|
|
-<li><a href="#synopsis">SYNOPSIS</a>
|
|
-<li><a href="#description">DESCRIPTION</a>
|
|
-<li><a href="#options">OPTIONS</a>
|
|
-<li><a href="#arguments">ARGUMENTS</a>
|
|
-<li><a href="#examples">EXAMPLES</a>
|
|
-<li><a href="#history">HISTORY</a>
|
|
-<li><a href="#author">AUTHOR</a>
|
|
-<li><a href="#seealso">SEE ALSO</a>
|
|
+<li><a href="#synopsis">SYNOPSIS</a></li>
|
|
+<li><a href="#description">DESCRIPTION</a></li>
|
|
+<li><a href="#options">OPTIONS</a></li>
|
|
+<li><a href="#arguments">ARGUMENTS</a></li>
|
|
+<li><a href="#examples">EXAMPLES</a></li>
|
|
+<li><a href="#history">HISTORY</a></li>
|
|
+<li><a href="#author">AUTHOR</a></li>
|
|
+<li><a href="#seealso">SEE ALSO</a></li>
|
|
</ul>
|
|
|
|
</body>
|
|
diff -urNp a/userguide/pampaintspill.html b/userguide/pampaintspill.html
|
|
--- a/userguide/pampaintspill.html 2021-06-02 12:56:59.575286342 +0200
|
|
+++ b/userguide/pampaintspill.html 2021-06-02 15:06:31.354767352 +0200
|
|
@@ -2,12 +2,12 @@
|
|
<html><head><title>Pampaintspill User Manual</title></head>
|
|
<body>
|
|
<h1>pampaintspill</h1>
|
|
-Updated: 06 March 2021
|
|
+<p>Updated: 06 March 2021
|
|
<br>
|
|
-<a href="#index">Table Of Contents</a>
|
|
+<a href="#index">Table Of Contents</a></p>
|
|
|
|
<h2>NAME</h2>
|
|
-pampaintspill - smoothly spill colors into the background
|
|
+<p>pampaintspill - smoothly spill colors into the background</p>
|
|
|
|
<h2 id="synopsis">SYNOPSIS</h2>
|
|
|
|
@@ -17,17 +17,17 @@ pampaintspill - smoothly spill colors in
|
|
[<b>--wrap</b>] [<b>--all</b>]
|
|
[<b>--downsample</b>=<i>number</i>]
|
|
[<b>--power</b>=<i>number</i>] [<i>filename</i>]
|
|
-[<b>-randomseed=</b><i>integer</i>]
|
|
+[<b>-randomseed=</b><i>integer</i>]</p>
|
|
|
|
|
|
<p>Minimum unique abbreviations of option are acceptable. You may use
|
|
double hyphens instead of single hyphen to denote options. You may use
|
|
white space in place of the equals sign to separate an option name
|
|
-from its value.
|
|
+from its value.</p>
|
|
|
|
<h2 id="description">DESCRIPTION</h2>
|
|
|
|
-<p>This program is part of <a href="index.html">Netpbm</a>.
|
|
+<p>This program is part of <a href="index.html">Netpbm</a>.</p>
|
|
|
|
<p><b>pampaintspill</b> produces a smooth color gradient from all of the
|
|
non-background-colored pixels in an input image, effectively "spilling
|
|
@@ -38,27 +38,27 @@ paint" onto the background. <b>pampaint
|
|
<li><b>pampaintspill</b> accepts any number of paint
|
|
sources (non-background-colored pixels), which can lie anywhere
|
|
on the canvas. <b>pamgradient</b> accepts exactly
|
|
- four paint sources, one in each corner of the image.
|
|
+ four paint sources, one in each corner of the image.</li>
|
|
|
|
<li><b>pampaintspill</b> requires an input image while
|
|
<b>pamgradient</b> generates a new image from
|
|
- scratch.
|
|
+ scratch.</li>
|
|
|
|
<li><b>pampaintspill</b> can produce tileable output and
|
|
can control how tightly the gradient colors bind to their source
|
|
- pixels.
|
|
+ pixels.</li>
|
|
</ul>
|
|
|
|
<p>Results are generally best when the input image contains just a few, crisp
|
|
spots of color. Use your drawing program's pencil tool — as opposed to a
|
|
-paintbrush or airbrush tool — with a small nib.
|
|
+paintbrush or airbrush tool — with a small nib.</p>
|
|
|
|
<h2 id="options">OPTIONS</h2>
|
|
|
|
<p>In addition to the options common to all programs based on libnetpbm
|
|
(most notably <b>-quiet</b>, see <a href="index.html#commonoptions">
|
|
Common Options</a>), <b>pampaintspill</b> recognizes the following
|
|
-command line options:
|
|
+command line options:</p>
|
|
|
|
<dl>
|
|
<dt><b>--bgcolor</b>=<i>color</i></dt>
|
|
@@ -107,42 +107,42 @@ command line options:
|
|
<dd>This is the seed for the random number generator that generates the
|
|
pixels.
|
|
|
|
- <p>Use this to ensure you get the same image on separate invocations.
|
|
+ <p>Use this to ensure you get the same image on separate invocations.</p>
|
|
|
|
- <p>This option was new in Netpbm 10.94 (March 2021).
|
|
+ <p>This option was new in Netpbm 10.94 (March 2021).</p>
|
|
</dl>
|
|
|
|
|
|
<h2 id="seealso">SEE ALSO</h2>
|
|
|
|
<ul>
|
|
-<li><a href="pamgradient.html"><b>pamgradient</b></a>
|
|
-<li><a href="ppmmake.html"><b>ppmmake</b></a>,
|
|
-<li><a href="ppmrainbow.html"><b>ppmrainbow</b></a>,
|
|
-<li><a href="pgmramp.html"><b>pgmramp</b></a>,
|
|
-<li><a href="ppmpat.html"><b>ppmpat</b></a>,
|
|
-<li><a href="pam.html"><b>pam</b></a>
|
|
+<li><a href="pamgradient.html"><b>pamgradient</b></a></li>
|
|
+<li><a href="ppmmake.html"><b>ppmmake</b></a>,</li>
|
|
+<li><a href="ppmrainbow.html"><b>ppmrainbow</b></a>,</li>
|
|
+<li><a href="pgmramp.html"><b>pgmramp</b></a>,</li>
|
|
+<li><a href="ppmpat.html"><b>ppmpat</b></a>,</li>
|
|
+<li><a href="pam.html"><b>pam</b></a></li>
|
|
</ul>
|
|
|
|
<h2 id="history">HISTORY</h2>
|
|
|
|
-<p><b>pampaintspill</b> was new in Netpbm 10.50 (March 2010).
|
|
+<p><b>pampaintspill</b> was new in Netpbm 10.50 (March 2010).</p>
|
|
|
|
|
|
<h2 id="copyright">COPYRIGHT</h2>
|
|
|
|
<p>Copyright © 2010 Scott Pakin,
|
|
-<a href="mailto:scott+pbm@pakin.org"><i>scott+pbm@pakin.org</i></a>.
|
|
+<a href="mailto:scott+pbm@pakin.org"><i>scott+pbm@pakin.org</i></a>.</p>
|
|
|
|
<h2 id="index">Table Of Contents</h2>
|
|
|
|
<ul>
|
|
-<li><a href="#synopsis">SYNOPSIS</a>
|
|
-<li><a href="#description">DESCRIPTION</a>
|
|
-<li><a href="#options">OPTIONS</a>
|
|
-<li><a href="#seealso">SEE ALSO</a>
|
|
-<li><a href="#history">HISTORY</a>
|
|
-<li><a href="#copyright">COPYRIGHT</a>
|
|
+<li><a href="#synopsis">SYNOPSIS</a></li>
|
|
+<li><a href="#description">DESCRIPTION</a></li>
|
|
+<li><a href="#options">OPTIONS</a></li>
|
|
+<li><a href="#seealso">SEE ALSO</a></li>
|
|
+<li><a href="#history">HISTORY</a></li>
|
|
+<li><a href="#copyright">COPYRIGHT</a></li>
|
|
</ul>
|
|
|
|
</body>
|
|
diff -urNp a/userguide/pamrecolor.html b/userguide/pamrecolor.html
|
|
--- a/userguide/pamrecolor.html 2021-06-02 12:56:59.574286333 +0200
|
|
+++ b/userguide/pamrecolor.html 2021-06-02 15:09:53.837724488 +0200
|
|
@@ -2,9 +2,9 @@
|
|
<html><head><title>Pamrecolor User Manual</title></head>
|
|
<body>
|
|
<h1>pamrecolor</h1>
|
|
-Updated: 31 July 2010
|
|
+<p>Updated: 31 July 2010
|
|
<br>
|
|
-<a href="#index">Table Of Contents</a>
|
|
+<a href="#index">Table Of Contents</a></p>
|
|
|
|
<h2>NAME</h2>
|
|
pamrecolor - alter colors without affecting luminance
|
|
@@ -22,15 +22,15 @@ pamrecolor - alter colors without affect
|
|
[<b>-randomseed=</b><i>integer</i>]
|
|
|
|
[<i>infile</i>]
|
|
-
|
|
+</p>
|
|
|
|
<p>Minimum unique abbreviation of option is acceptable. You may use double
|
|
hyphens instead of single hyphen to denote options. You may use white
|
|
-space in place of the equals sign to separate an option name from its value.
|
|
+space in place of the equals sign to separate an option name from its value.</p>
|
|
|
|
<h2 id="description">DESCRIPTION</h2>
|
|
|
|
-<p>This program is part of <a href="index.html">Netpbm</a>.
|
|
+<p>This program is part of <a href="index.html">Netpbm</a>.</p>
|
|
|
|
<p><b>pamrecolor</b> changes an image's colors to be as close as
|
|
possible to given target colors but with the constraint that the
|
|
@@ -39,17 +39,17 @@ image will look identical if both are co
|
|
(e.g. with
|
|
<a href="ppmtopgm.html">ppmtopgm</a>). You can have <b>pamrecolor</b> select
|
|
target colors randomly, specify a single hue for the entire image, or take the
|
|
-target colors from a target image.
|
|
+target colors from a target image.</p>
|
|
|
|
<p>In addition to real Netpbm images, <b>pamrecolor</b> works on pseudo-Netpbm
|
|
images based on arbitrary color spaces. You can define the color space
|
|
-explicitly or choose one of many that <b>pamrecolor</b> knows by name.
|
|
+explicitly or choose one of many that <b>pamrecolor</b> knows by name.</p>
|
|
|
|
<p>The output is a PAM image on standard output. Options control the
|
|
exact format of the PAM. If you want a PNM (PBM, PGM, or PPM) image,
|
|
use <a href="pamtopnm.html">pamtopnm</a> on the output. There is no
|
|
need to convert if you will use the image as input to a current Netpbm
|
|
-program, but many other programs don't know what a PAM is.
|
|
+program, but many other programs don't know what a PAM is.</p>
|
|
|
|
|
|
<h2 id="options">OPTIONS</h2>
|
|
@@ -57,7 +57,7 @@ program, but many other programs don't k
|
|
<p>In addition to the options common to all programs based on libnetpbm
|
|
(most notably <b>-quiet</b>, see <a href="index.html#commonoptions">
|
|
Common Options</a>), <b>pamrecolor</b> recognizes the following
|
|
-command line options:
|
|
+command line options:</p>
|
|
|
|
<dl>
|
|
|
|
@@ -76,9 +76,9 @@ the raster have different meaning. Many
|
|
images actually use a variation with a different color space. For example,
|
|
<a href="http://www.gimp.org/">GIMP</a> uses sRGB internally and if you
|
|
have GIMP generate a Netpbm image file, it really generates a variation of
|
|
-the format that uses sRGB.
|
|
+the format that uses sRGB.</p>
|
|
|
|
-<p><b>pamrecolor</b> knows the following color spaces (<i>name</i> values):
|
|
+<p><b>pamrecolor</b> knows the following color spaces (<i>name</i> values):</p>
|
|
|
|
<dl>
|
|
<dt>adobe</dt>
|
|
@@ -109,7 +109,7 @@ the format that uses sRGB.
|
|
<p>The default is "ntsc" because this is the color space that the Netpbm
|
|
formats and many graphics utilities use. As a counterexample,
|
|
<a href="http://www.gimp.org/">GIMP</a> uses sRGB as its native color
|
|
-space.
|
|
+space.</p>
|
|
|
|
<p>The luminance values <b>pamrecolor</b> uses for each of the above come from
|
|
Bruce Lindbloom's
|
|
diff -urNp a/userguide/pbmtog3.html b/userguide/pbmtog3.html
|
|
--- a/userguide/pbmtog3.html 2021-06-02 12:56:59.585286434 +0200
|
|
+++ b/userguide/pbmtog3.html 2021-06-02 14:44:07.715692749 +0200
|
|
@@ -36,7 +36,7 @@ use those encodings.
|
|
<p>In addition to the options common to all programs based on libnetpbm
|
|
(most notably <b>-quiet</b>, see <a href="index.html#commonoptions">
|
|
Common Options</a>), <b>pbmtog3</b> recognizes the following
|
|
-command line options:
|
|
+command line options:</p>
|
|
|
|
<dl>
|
|
<dt><b>-reversebits</b>
|
|
@@ -80,7 +80,7 @@ You cannot specify both.
|
|
<h2 id="history">HISTORY</h2>
|
|
|
|
<p>Before Netpbm 10.79 (June 2017), there was a different program by the same
|
|
-name in Netpbm, which was written by by Paul Haeberli
|
|
+name in Netpbm, which was written by Paul Haeberli
|
|
<<a href="mailto:paul@manray.sgi.com">paul@manray.sgi.com</a>> in 1989
|
|
and then modified extensively by others.
|
|
|
|
diff -urNp a/userguide/ppmtogif.html b/userguide/ppmtogif.html
|
|
--- a/userguide/ppmtogif.html 2021-06-02 12:56:59.574286333 +0200
|
|
+++ b/userguide/ppmtogif.html 2021-06-02 15:48:19.167930575 +0200
|
|
@@ -5,17 +5,17 @@
|
|
|
|
<h2>NAME</h2>
|
|
|
|
-ppmtogif - replaced by pamtogif
|
|
-
|
|
-<h2>DESCRIPTION</h2>
|
|
+<p>ppmtogif - replaced by pamtogif</p>
|
|
|
|
<p>This program is part of <a href="index.html">Netpbm</a>.
|
|
|
|
+<h2>SYNOPSIS</h2>
|
|
<p><b>ppmtogif</b> was replaced in Netpbm 10.37 (December 2006) by
|
|
<b><a href="pamtogif.html">pamtogif</a></b>.
|
|
|
|
<p><b>pamtogif</b> is mostly backward compatible with <b>ppmtogif</b>.
|
|
|
|
+<h2>DESCRIPTION</h2>
|
|
<p>One way <b>pamtogif</b> is not backward compatible with <b>ppmtogif</b>
|
|
is that to specify a transparency (alpha) mask with <b>ppmtogif</b>, you
|
|
supply the transparency as a separate pseudo-PGM image and use the
|
|
diff -urNp a/userguide/ppmtompeg.html b/userguide/ppmtompeg.html
|
|
--- a/userguide/ppmtompeg.html 2021-06-02 12:56:59.580286388 +0200
|
|
+++ b/userguide/ppmtompeg.html 1970-01-01 01:00:00.000000000 +0100
|
|
@@ -1,1294 +0,0 @@
|
|
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.3//EN">
|
|
-<html><head><title>Ppmtompeg User Manual</title></head>
|
|
-<body>
|
|
-<h1>ppmtompeg</h1>
|
|
-Updated: 23 July 2006
|
|
-<br>
|
|
-<a href="#index">Table Of Contents</a>
|
|
-
|
|
-<h2>NAME</h2>
|
|
-ppmtompeg - encode an MPEG-1 bitstream
|
|
-
|
|
-<h2 id="synopsis">SYNOPSIS</h2>
|
|
-
|
|
-<b>ppmtompeg</b>
|
|
-[<i>options</i>]
|
|
-<i>parameter-file</i>
|
|
-
|
|
-<h2 id="description">DESCRIPTION</h2>
|
|
-
|
|
-<p>This program is part of <a href="index.html">Netpbm</a>.
|
|
-
|
|
-<p><b>ppmtompeg</b> produces an MPEG-1 video stream. MPEG-1 is the
|
|
-first great video compression method, and is what is used in Video CDs
|
|
-(VCD). <b>ppmtompeg</b> originated in the year 1995. DVD uses a more
|
|
-advanced method, MPEG-2. There is an even newer method called MPEG-4
|
|
-which is also called Divx. I don't know where one finds that used.
|
|
-
|
|
-<p>There's technically a difference between a compression method for
|
|
-video and an actual file (stream) format for a movie, and I don't know
|
|
-if it can be validly said that the format of the stream
|
|
-<b>ppmtompeg</b> produces is MPEG-1.
|
|
-
|
|
-<p>Mencoder from the <a href="http://www.mplayerhq.hu">Mplayer
|
|
-package</a> is probably superior for most video format generation
|
|
-needs, if for no other reason than that it is more popular.
|
|
-
|
|
-<p>The programming library <a href="http://pm2v.free.fr"><b>PM2V</b></a>
|
|
-generates MPEG-2 streams.
|
|
-
|
|
-<p>Use <a href="http://www.mplayerhq.hu">Mplayer</a> (not part of Netpbm)
|
|
-to do the reverse conversion: to create a series of PNM files from an MPEG
|
|
-stream.
|
|
-
|
|
-<p><i>param_file</i> is a parameter file which includes a list of
|
|
-input files and other parameters. The file is described in detail
|
|
-below.
|
|
-
|
|
-<p>To understand this program, you need to understand something about
|
|
-the complex MPEG-1 format. One source of information about this
|
|
-standard format is the section Introduction to MPEG in the <a
|
|
-href="http://www.faqs.org/faqs/compression-faq">Compression FAQ</a>.
|
|
-
|
|
-<h2 id="options">OPTIONS</h2>
|
|
-
|
|
-<p>The <b>-gop</b>, <b>-combine_gops</b>, <b>-frames</b>, and
|
|
-<b>-combine_frames</b> options are all mutually exclusive.
|
|
-
|
|
-<dl compact>
|
|
-<dt><b>-stat stat_file</b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to append the statistics that
|
|
-it write to Standard Output to the file <i>stat_file</i> as well. The
|
|
-statistics use the following abbreviations: bits per block (bpb), bits
|
|
-per frame (bpf), seconds per frame (spf), and bits per second (bps).
|
|
-
|
|
-<p>These statistics include how many I, P, and B frames there were,
|
|
-and information about compression and quality.
|
|
-
|
|
-
|
|
-<dt><b>-quiet</b> <i>num_seconds</i>
|
|
-
|
|
-<dd> causes <b>ppmtompeg</b> not to report remaining time more often
|
|
-than every <i>num_seconds</i> seconds (unless the time estimate rises,
|
|
-which will happen near the beginning of the run). A negative value
|
|
-tells <b>ppmtompeg</b> not to report at all. 0 is the default
|
|
-(reports once after each frame). Note that the time remaining is an
|
|
-estimate and does not take into account time to read in frames.
|
|
-
|
|
-<dt><b>-realquiet</b> <dd> causes <b>ppmtompeg</b> to run silently,
|
|
-with the only screen output being errors. Particularly useful when
|
|
-reading input from stdin. The equivalent of the <b>-quiet</b>
|
|
-common option of most other Netpbm programs.
|
|
-
|
|
-<dt>
|
|
-<b>-no_frame_summary</b>
|
|
-
|
|
-<dd> This option prevents <b>ppmtompeg</b> from printing a summary
|
|
-line for each frame
|
|
-
|
|
-<dt><b>-float_dct</b>
|
|
-
|
|
-<dd> forces <b>ppmtompeg</b> to use a more accurate, yet more
|
|
-computationally expensive version of the DCT.
|
|
-
|
|
-<dt><b>-gop</b> <i>gop_num</i>
|
|
-<dd>
|
|
-causes <b>ppmtompeg</b> to encode only the numbered GOP (first GOP is 0). The
|
|
-parameter file is the same as for normal usage. The output file will be
|
|
-the normal output file with the suffix <b>.gop.</b><i>gop_num</i>.
|
|
-<b>ppmtompeg</b> does not output any sequence information.
|
|
-
|
|
-<dt><b>-combine_gops</b>
|
|
-
|
|
-<dd> causes <b>ppmtompeg</b> simply to combine some GOP files into a
|
|
-single MPEG output stream. <b>ppmtompeg</b> inserts a sequence header
|
|
-and trailer. In this case, the parameter file needs only to contain
|
|
-the SIZE value, an output file, and perhaps a list of input GOP
|
|
-files (see below).
|
|
-
|
|
-If you don't supply a list of input GOP files is used, then
|
|
-<b>ppmtompeg</b> assumes you're using the same parameter file you used
|
|
-when you created the input (with the <b>-gop</b> option) and
|
|
-calculates the corresponding gop filenames itself. If this is not the
|
|
-case, you can specify input GOP files in the same manner as normal
|
|
-input files -- except instead of using INPUT_DIR, INPUT, and
|
|
-END_INPUT, use GOP_INPUT_DIR, GOP_INPUT, and GOP_END_INPUT. If no
|
|
-input GOP files are specified, then the default is to use the output
|
|
-file name with suffix <b>.gop.</b><i>gop_num</i>, with <i>gop_num</i>
|
|
-starting from 0, as the input files.
|
|
-
|
|
-<p>Thus, unless you're mixing and matching GOP files from different
|
|
-sources, you can simply use the same parameter file for creating the
|
|
-GOP files (<b>-gop</b>) and for later turning them into an MPEG stream
|
|
-(<b>-combine_gops</b>).
|
|
-
|
|
-
|
|
-<dt><b>-frames <i>first_frame</i> <i>last_frame</i></b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to encode only the frames numbered
|
|
-<i>first_frame</i> to <i>last_frame</i>, inclusive. The parameter
|
|
-file is the same as for normal usage. The output will be placed in
|
|
-separate files, one per frame, with the file names being the normal
|
|
-output file name with the suffix <b>.frame.</b><i>frame_num</i>. No
|
|
-GOP header information is output. (Thus, the parameter file need not
|
|
-include the GOP_SIZE value)
|
|
-
|
|
-<p>Use <b>ppmtompeg -combine_frames</b> to combine these frames later into
|
|
-an MPEG stream.
|
|
-
|
|
-
|
|
-<dt><b>-combine_frames</b>
|
|
-
|
|
-<dd> This option causes <b>ppmtompeg</b> simply to combine some
|
|
-individual MPEG frames (such as you might have created with an earlier
|
|
-run of <b>ppmtompeg -frames</b>) into a single MPEG stream. Sequence
|
|
-and GOP headers are inserted appropriately. In this case, the
|
|
-parameter file needs to contain only the SIZE value, the GOP_SIZE
|
|
-value, an output file, and perhaps a list of frame files (see below).
|
|
-
|
|
-<p>The parameter file may specify input frame files in the same manner
|
|
-as normal input files -- except instead of using INPUT_DIR, INPUT, and
|
|
-END_INPUT, use FRAME_INPUT_DIR, FRAME_INPUT, and FRAME_END_INPUT. If
|
|
-no input frame files are specified, then the default is to use the
|
|
-output file name with suffix <b>.frame.</b><i>frame_num</i>, with
|
|
-<i>frame_num</i> starting from 0, as the input files.
|
|
-
|
|
-
|
|
-
|
|
-<dt><b>-nice</b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to run any remote processes
|
|
-"nicely," i.e. at low priority. (This is relevant only if you are
|
|
-running <b>ppmtompeg</b> in parallel mode. Otherwise, there are no
|
|
-remote processes). See 'man nice.'
|
|
-
|
|
-<dt><b>-max_machines <i>num_machines</i></b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to use no more than
|
|
-<i>num_machines</i> machines as slaves for use in parallel encoding.
|
|
-
|
|
-<dt><b>-snr</b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to include the signal-to-noise
|
|
-ratio in the reported statistics. Prints SNR (Y U V) and peak SNR (Y
|
|
-U V) for each frame. In summary, prints averages of luminance only
|
|
-(Y). SNR is defined as 10*log(variance of original/variance of
|
|
-error). Peak SNR is defined as 20*log(255/RMSE). Note that
|
|
-<b>ppmtompeg</b> runs a little slower when you use this option.
|
|
-
|
|
-<dt><b>-mse</b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to report the mean squared
|
|
-error per block. It also automatically reports the quality of the
|
|
-images, so there is no need to specify <b>-snr</b> then.
|
|
-
|
|
-<dt><b>-bit_rate_info</b> <i>rate_file</i>
|
|
-
|
|
-<dd> This option makes <b>ppmtompeg</b> write bit rate information
|
|
-into the file <i>rate_file</i>. Bit rate information is bits per frame, and
|
|
-also bits per I-frame-to-I-frame.
|
|
-
|
|
-<dt><b>-mv_histogram</b>
|
|
-
|
|
-<dd> This option causes <b>ppmtompeg</b> to print a histogram of the
|
|
-motion vectors as part of statistics. There are three histograms --
|
|
-one for P frame, one for forward B frame, and one for backward B frame
|
|
-motion vectors.
|
|
-
|
|
-<p>The output is in the form of a matrix, each entry corresponding to one
|
|
-motion vector in the search window. The center of the matrix
|
|
-represents (0,0) motion vectors.
|
|
-
|
|
-<dt><b>-debug_sockets</b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to print to Standard Output
|
|
-messages that narrate the communication between the machines when you run
|
|
-<b>ppmtompeg</b> in <a href="#parallel">parallel mode</a>.
|
|
-
|
|
-<dt><b>-debug_machines</b>
|
|
-
|
|
-<dd>This option causes <b>ppmtompeg</b> to print to Standard Output
|
|
-messages that narrate the progress of the conversion on the various
|
|
-machines when you run <b>ppmtompeg</b> in <a href="#parallel">parallel
|
|
-mode</a>.
|
|
-
|
|
-</dl>
|
|
-
|
|
-<h2 id="parmfile">PARAMETER FILE</h2>
|
|
-
|
|
-<p>The parameter file <strong>must</strong> contain the following
|
|
-lines (except when using the <b>-combine_gops</b> or <b>-combine_frames</b>
|
|
-options):
|
|
-
|
|
-<dl compact>
|
|
-
|
|
-<dt><b>PATTERN</b> <i>pattern</i>
|
|
-
|
|
-<dd>This statement specifies the pattern (sequence) of I frames, P frames,
|
|
-and B frames. <i>pattern</i> is just a sequence of the letters I, P, and
|
|
-B with nothing between. Example:
|
|
-
|
|
-<pre>
|
|
- PATTERN IBBPBBPBBPBBPBB
|
|
-</pre>
|
|
-
|
|
-<p>See <a href="#ipb">I Frames, P Frames, B Frames</a>.
|
|
-
|
|
-<dt><b>OUTPUT</b> <i>output file</i>
|
|
-<dd>This names the file where the output MPEG stream goes.
|
|
-
|
|
-<dt><b>INPUT_DIR</b> <i>directory</i>
|
|
-
|
|
-<dd>This statement tells where the input images (frames) come from.
|
|
-If each frame is in a separate file, <i>directory</i> is the directory
|
|
-where they all are. You may use <b>.</b> to refer to the current
|
|
-directory. A null <i>directory</i> refers to the root directory of the
|
|
-system file tree.
|
|
-
|
|
-<p>To have <b>ppmtompeg</b> read all the frames serially from Standard
|
|
-Input, specify
|
|
-<pre>
|
|
- INPUT_DIR stdin
|
|
-</pre>
|
|
-
|
|
-<dt><b>INPUT</b>
|
|
-<dd>
|
|
-This line must be followed by a list of the input files (in display order)
|
|
-and then the line <b>END_INPUT</b>.
|
|
-
|
|
-<p>There are three types of lines between INPUT and END_INPUT. First,
|
|
-a line may simply be the name of an input file. Second, the line
|
|
-may be of the form <i>single_star_expr</i>
|
|
-<b>[</b><i>x</i><b>-</b><i>y</i><b>]</b>.
|
|
-<i>single_star_expr</i> can have a single <b>*</b> in it. It is
|
|
-replaced by all the numbers between x and y inclusive. So, for
|
|
-example, the line <b>tennis*.ppm [12-15]</b> refers to the files
|
|
-tennis12.ppm, tennis13.ppm, tennis14.ppm, tennis15.ppm.
|
|
-
|
|
-<p>Uniform zero-padding occurs, as well. For example, the line
|
|
-<b>football.*.ppm [001-130]</b> refers to the files football.001.ppm,
|
|
-football.002.ppm, ..., football.009.ppm, football.010.ppm, ...,
|
|
-football.130.ppm.
|
|
-
|
|
-<p>The third type of line is: <i>single_star_expr</i>
|
|
-<b>[</b><i>x</i><b>-</b><i>y</i><b>+</b><i>s</i><b>]</b>, where the
|
|
-line is treated exactly as above, except that we skip by <i>s</i>. Thus, the
|
|
-line <b>football.*.ppm [001-130+4]</b> refers to the files
|
|
-football.001.ppm, football.005.ppm, football.009.ppm,
|
|
-football.013.ppm, etc.
|
|
-
|
|
-<p>Furthermore, a line may specify a shell command to execute to
|
|
-generate lines to be interpreted as described above, as if those lines
|
|
-were in the parameter file instead. Use back ticks, like in the
|
|
-Bourne Shell, like this:
|
|
-
|
|
-<pre>
|
|
- `cat myfilelist`
|
|
-</pre>
|
|
-
|
|
-<p>
|
|
-If input is from Standard Input (per the <b>INPUT_DIR</b> statement),
|
|
-<b>ppmtompeg</b> ignores the <b>INPUT</b>/<b>END_INPUT</b> block, but
|
|
-it still must be present.
|
|
-
|
|
-<dt><b>BASE_FILE_FORMAT</b> {<b>PPM</b> | <b>PNM</b> | <b>YUV</b> |
|
|
- <b>JPEG</b> | <b>JMOVIE</b>}
|
|
-
|
|
-<dd><b>ppmtompeg</b> must convert all input files to one of the
|
|
-following formats as a first step of processing: PNM, YUV, JPEG(v4),
|
|
-or JMOVIE. (The conversion may be trivial if your input files are
|
|
-already in one of these formats). This line specifies which of the
|
|
-four formats. PPM is actually a subset of PNM. The separate
|
|
-specification is allowed for backward compatibility. Use PNM instead
|
|
-of PPM in new applications.
|
|
-
|
|
-<dt><b>INPUT_CONVERT</b> <i>conversion_command</i>
|
|
-
|
|
-<dd>You must specify how to convert a file to the base file format.
|
|
-If no conversion is necessary, then you would just say:
|
|
-
|
|
- <pre>
|
|
- INPUT_CONVERT *
|
|
- </pre>
|
|
-
|
|
-<p>Otherwise, <i>conversion_command</i> is a shell command that causes
|
|
-an image in the format your specified with <b>BASE_FILE_FORMAT</b> to
|
|
-be written to Standard Output. <b>ppmtompeg</b> executes the command
|
|
-once for each line between <b>INPUT</b> and <b>END_INPUT</b> (which is
|
|
-normally, but not necessarily, a file name). In the conversion
|
|
-command, <b>ppmtompeg</b> replaces each '*' with the contents of that
|
|
-line.
|
|
-
|
|
- If you had a bunch of gif files, you might say:
|
|
- <pre>
|
|
- INPUT_CONVERT giftopnm *
|
|
- </pre>
|
|
-
|
|
- If you have a bunch of separate a.Y, a.U, and a.V files (where
|
|
- the U and V have already been subsampled), then you might say:
|
|
-
|
|
- <pre>
|
|
- INPUT_CONVERT cat *.Y *.U *.V
|
|
- </pre>
|
|
-
|
|
-<p>Input conversion is not allowed with input from stdin, so use
|
|
-
|
|
- <pre>
|
|
- INPUT_CONVERT *
|
|
- </pre>
|
|
-
|
|
-as described above.
|
|
-
|
|
-<dt><b>SIZE</b> <i>width</i><b>x</b><i>height</i>
|
|
-
|
|
-<dd>
|
|
-
|
|
-<p><i>width</i> and <i>height</i> are the width and height of each
|
|
-frame in pixels.
|
|
-
|
|
-<p>When <b>ppmtompeg</b> can get this information from the input image
|
|
-files, it ignores the <b>SIZE</b> parameter and you may omit it.
|
|
-
|
|
-<p>When the image files are in YUV format, the files don't contain
|
|
-dimension information, so <b>SIZE</b> is required.
|
|
-
|
|
-<p>When <b>ppmtompeg</b> is running in parallel mode, not all of the
|
|
-processes in the network have access to the image files, so
|
|
-<b>SIZE</b> is required and must give the same dimensions as the
|
|
-input image files.
|
|
-
|
|
-<dt><b>YUV_SIZE</b> <i>width</i><b>x</b><i>height</i>
|
|
-
|
|
-<dd>This is an obsolete synonym of <b>SIZE</b>.
|
|
-
|
|
-<dt><b>YUV_FORMAT</b> {<b>ABEKAS</b> | <b>PHILLIPS</b> | <b>UCB</b> |
|
|
- <b>EYUV</b> | <i>pattern</i>}
|
|
-
|
|
-<dd>This is meaningful only when <b>BASE_FILE_FORMAT</b> specifies
|
|
-YUV format, and then it is required. It specifies the sub-format of
|
|
-the YUV class.
|
|
-
|
|
-
|
|
-<dt><b>GOP_SIZE</b> <i>n</i>
|
|
-
|
|
-<dd><i>n</i> is the number of frames in a Group of Pictures. Except that
|
|
-because a GOP must start with an I frame, <b>ppmtompeg</b> makes a GOP as
|
|
-much longer than <i>n</i> as it has to to make the next GOP start with an
|
|
-I frame.
|
|
-
|
|
-<p>Normally, it makes sense to make your GOP size a multiple of your
|
|
-pattern length (the latter is determined by the PATTERN parameter file
|
|
-statement).
|
|
-
|
|
-<p>See <a href="#gop">Group Of Pictures</a>.
|
|
-
|
|
-<dt><b>SLICES_PER_FRAME</b> <i>n</i>
|
|
-<dd><i>n</i> is roughly the number of slices per frame. Note, at
|
|
-least one MPEG player may complain if slices do not start at the left
|
|
-side of an image. To ensure this does not happen, make sure the
|
|
-number of rows is divisible by SLICES_PER_FRAME.
|
|
-
|
|
-<dt><b>PIXEL</b> {<b>FULL</b> | <b>HALF</b>}
|
|
-
|
|
-<dd>use half-pixel motion vectors, or just full-pixel ones It is
|
|
-usually important that you use half-pixel motion vectors, because it
|
|
-results in both better quality and better compression.
|
|
-
|
|
-
|
|
-<dt><b>RANGE</b> <i>n</i>
|
|
-<dd>Use a search range of <i>n</i> pixels in each of the four directions
|
|
-from a subject pixel. (So the search window is a square <i>n</i>*2 pixels
|
|
-on a side).
|
|
-
|
|
-<dt><b>PSEARCH_ALG</b> {<b>EXHAUSTIVE</b> | <b>TWOLEVEL</b> |
|
|
- <b>SUBSAMPLE</b> | <b>LOGARITHMIC</b>}
|
|
-
|
|
-<dd>This statement tells <b>ppmtompeg</b> what kind of search
|
|
- technique (algorithm) to use for P frames. You select the desired
|
|
- combination of speed and compression. <b>EXHAUSTIVE</b> gives the
|
|
- best compression, but <b>LOGARITHMIC</b> is the fastest.
|
|
- <b>TWOLEVEL</b> is an exhaustive full-pixel search, followed by a
|
|
- local half- pixel search around the best full-pixel vector (the
|
|
- PIXEL option is ignored for this search technique).
|
|
-
|
|
-<dt><b>BSEARCH_ALG</b> {<b>SIMPLE</b> | <b>CROSS2</b> | <b>EXHAUSTIVE</b>}
|
|
-
|
|
-<dd>This statement tells <b>ppmtompeg</b> what kind of search
|
|
- technique (algorithm) to use for B frames. <b>SIMPLE</b> means
|
|
- find best forward and backward vectors, then interpolate.
|
|
- <b>CROSS2</b> means find those two vectors, then see what backward
|
|
- vector best matches the best forward vector, and vice versa.
|
|
- <b>EXHAUSTIVE</b> does an n-squared search and is
|
|
- <em>extremely</em> slow in relation to the others (<b>CROSS2</b>
|
|
- is about half as fast as <b>SIMPLE</b>).
|
|
-
|
|
-<dt><b>IQSCALE</b> <i>n</i>
|
|
-<dd>Use <i>n</i> as the qscale for I frames.
|
|
- See <a href="#qscale">Qscale</a>.
|
|
-
|
|
-<dt><b>PQSCALE</b> <i>n</i>
|
|
-<dd>Use <i>n</i> as the qscale for P frames.
|
|
- See <a href="#qscale">Qscale</a>.
|
|
-
|
|
-<dt><b>BQSCALE</b> <i>n</i>
|
|
-<dd>Use <i>n</i> as the qscale for B frames.
|
|
- See <a href="#qscale">Qscale</a>.
|
|
-
|
|
-<dt><b>REFERENCE_FRAME</b> {<b>ORIGINAL</b> | <b>DECODED</b>} <dd>This
|
|
-statement determines whether <b>ppmtompeg</b> uses the original images
|
|
-or the decoded images when computing motion vectors. Using decoded
|
|
-images is more accurate and should increase the playback quality of
|
|
-the output, but it makes the encoding take longer and seems to give
|
|
-worse compression. It also causes some complications with parallel
|
|
-encoding. (see the section on parallel encoding). One thing you can
|
|
-do as a trade-off is select <b>ORIGINAL</b> here, and lower the
|
|
-qscale (see <b>QSCALE</b> if the quality is not good enough.
|
|
-
|
|
-<table border="1" cellpadding="5" cellspacing="0" >
|
|
- <caption>Original or Decoded? (Normalized)</caption>
|
|
-<?makeman r c c c c c. ?>
|
|
-<?makeman _ ?>
|
|
- <tr style="text-align:center; background-color:#CCCCCC">
|
|
- <th>Reference</th>
|
|
- <th>Compression</th>
|
|
- <th>Speed</th>
|
|
- <th>Quality I</th>
|
|
- <th>Quality P</th>
|
|
- <th>Quality B</th>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Decoded</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">969</td>
|
|
- <td style="text-align:center">919</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Original</td>
|
|
- <td style="text-align:center">885</td>
|
|
- <td style="text-align:center">1373</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">912</td>
|
|
- <td style="text-align:center">884</td>
|
|
- </tr>
|
|
- </table>
|
|
-
|
|
-
|
|
-
|
|
-</dl>
|
|
-
|
|
-<p>The following lines are optional:
|
|
-
|
|
-<dl>
|
|
-
|
|
-<dt><b>FORCE_ENCODE_LAST_FRAME</b>
|
|
-
|
|
-<dd>This statement is obsolete. It does nothing.
|
|
-
|
|
-<p>Before Netpbm 10.26 (January 2005), <b>ppmtompeg</b> would drop
|
|
-trailing B frames from your movie, since a movie can't end with a B
|
|
-frame. (See <a href="#ipb">I Frames, P Frames, B Frames</a>.)
|
|
-You would have to specify <b>FORCE_ENCODE_LAST_FRAME</b> to stop
|
|
-that from happening and get the same function that <b>ppmtompeg</b>
|
|
-has today.
|
|
-
|
|
-
|
|
-<dt><b>NIQTABLE</b>
|
|
-
|
|
-<dd>This statement specifies a custom non-intra quantization table.
|
|
-If you don't specify this statement, <b>ppmtompeg</b> uses a default
|
|
-non-intra quantization table.
|
|
-
|
|
-<p>
|
|
-The 8 lines immediately following <b>NIQTABLE</b> specify the quantization
|
|
-table. Each line defines a table row and consists of 8 integers,
|
|
-whitespace-delimited, which define the table columns.
|
|
-
|
|
-<dt><b>IQTABLE</b>
|
|
-
|
|
-<dd>This is analogous to NIQTABLE, but for the intra quantization table.
|
|
-
|
|
-<dt><b>ASPECT_RATIO</b> <i>ratio</i>
|
|
-
|
|
-<dd>This statement specifies the aspect ratio for <b>ppmtompeg</b> to
|
|
-specify in the MPEG output. I'm not sure what this is used for.
|
|
-
|
|
-<p><i>ratio</i> must be 1.0, 0.6735, 0.7031, 0.7615, 0.8055, 0.8437,
|
|
-0.8935, 0.9157, 0.9815, 1.0255, 1.0695, 1.0950, 1.1575, or 1.2015.
|
|
-
|
|
-<dt><b>FRAME_RATE</b> <i>rate</i>
|
|
-<dd>This specifies the frame rate for <b>ppmtompeg</b> to specify in the
|
|
-MPEG output. Some players use this value to determine the playback rate.
|
|
-
|
|
-<p><i>rate</i> must be 23.976, 24, 25, 29.97, 30, 50, 59.94, or 60.
|
|
-
|
|
-<dt><b>BIT_RATE</b> <i>rate</i>
|
|
-<dd>This specifies the bit rate for Constant Bit Rate (CBR) encoding.
|
|
-
|
|
-<p><i>rate</i> must be an integer.
|
|
-
|
|
-<dt><b>BUFFER_SIZE</b> <i>size</i>
|
|
-
|
|
-<dd>This specifies the value
|
|
-<b>ppmtompeg</b> is to specify in the MPEG output for the Video
|
|
-Buffering Verifier (VBV) buffer size needed to decode the sequence.
|
|
-
|
|
-<p>A Video Verifying Buffer is a buffer in which a decoder keeps the
|
|
-decoded bits in order to match the uneven speed of the decoding with
|
|
-the required constant playback speed.
|
|
-
|
|
-<p>As <b>ppmtompeg</b> encodes the image, it simulates the decoding
|
|
-process in terms of how many bits would be in the VBV as each frame gets
|
|
-decoded, assuming a VBV of the size you indicate.
|
|
-
|
|
-<p>If you specify the <b>WARN_VBV_UNDERFLOW</b> statement,
|
|
-<b>ppmtompeg</b> issues a warning each time the simulation underflows
|
|
-the buffer, which suggests that an underflow would occur on playback,
|
|
-which suggests the buffer is too small.
|
|
-
|
|
-<p>If you specify the <b>WARN_VBV_OVERFLOW</b> statement,
|
|
-<b>ppmtompeg</b> issues a warning each time the simulation overflows
|
|
-the buffer, which suggests that an overflow would occur on playback,
|
|
-which suggests the buffer is too small.
|
|
-
|
|
-<dt><b>WARN_VBV_UNDERFLOW</b>
|
|
-<dt><b>WARN_VBV_OVERFLOW</b>
|
|
-
|
|
-<dd>See <b>BUFFER_SIZE</b>.
|
|
-
|
|
-<p>These options were new in Netpbm 10.26 (January 2005). Before that,
|
|
-<b>ppmtompeg</b> issued the warnings always.
|
|
-
|
|
-</dl>
|
|
-
|
|
-
|
|
-The following statements apply only to parallel operation:
|
|
-
|
|
-<dl>
|
|
-
|
|
-<dt><b>PARALLEL</b>
|
|
-
|
|
-<dd>This statement, paired with <b>END PARALLEL</b>, is what causes
|
|
-<b>ppmtompeg</b> to operate in parallel mode. See <a
|
|
-href="#parallel">Parallel Operation</a>.
|
|
-
|
|
-<dt><b>END PARALLEL</b>
|
|
-
|
|
-<dd>This goes with <b>PARALLEL</b>.
|
|
-
|
|
-<dt><b>PARALLEL_TEST_FRAMES</b> <i>n</i>
|
|
-
|
|
-<dd>The master starts off by measuring each slave's speed. It does
|
|
-this by giving each slave <i>n</i> frames to encode and noting how
|
|
-long the slave takes to finish. These are not just test frames,
|
|
-though -- they're real frames and the results become part of the
|
|
-output.
|
|
-<b>ppmtompeg</b> is old and measures time in undivided seconds, so
|
|
-to get useful timings, specify enough frames that it will take at
|
|
-least 5 seconds to process them. The default is 10.
|
|
-
|
|
-<p>If you specify <b>FORCE_I_ALIGN</b>, <b>ppmtompeg</b> will increase
|
|
-the test frames value enough to maintain the alignment.
|
|
-
|
|
-<p>If there aren't enough frames for every slave to have the indicated
|
|
-number of test frames, <b>ppmtompeg</b> will give some slaves fewer.
|
|
-
|
|
-
|
|
-<dt><b>PARALLEL_TIME_CHUNKS</b> <i>t</i>
|
|
-
|
|
-<dd>When you specify this statement, the master attempts to feed work
|
|
-to the slaves in chunks that take <i>t</i> seconds to process. It uses
|
|
-the speed measurement it made when it started up (see PARALLEL_TEST_FRAMES)
|
|
-to decide how many frames to put in the chunk. This statement obviously
|
|
-doesn't affect the first batch of work sent to each slave, which is the
|
|
-one used to measure the slave's speed.
|
|
-
|
|
-<p>Smaller values of <i>t</i> increase communication, but improve load
|
|
-balancing. The default is 30 seconds.
|
|
-
|
|
-<p>You may specify only one of PARALLEL_TIME_CHUNKS, PARALLEL_CHUNK_TAPER,
|
|
-and PARALLEL_PERFECT. PARALLEL_CHUNK_TAPER is usually best.
|
|
-
|
|
-<dt><b>PARALLEL_CHUNK_TAPER</b>
|
|
-
|
|
-<dd>When you specify this statement, the master distributes work like
|
|
-with PARALLEL_TIME_CHUNKS, except that the master chooses the number
|
|
-of seconds for the chunks. It starts with a large number and, as it
|
|
-gets closer to finishing the job, reduces it. That way, it reduces
|
|
-scheduling overhead when precise scheduling isn't helpful, but still
|
|
-prevents a slave from finishing early after all the work has already
|
|
-been handed out to the other slaves, and then sitting idle while
|
|
-there's still work to do.
|
|
-
|
|
-<p>You may specify only one of PARALLEL_TIME_CHUNKS, PARALLEL_CHUNK_TAPER,
|
|
-and PARALLEL_PERFECT. PARALLEL_CHUNK_TAPER is usually best.
|
|
-
|
|
-
|
|
-<dt><b>PARALLEL_PERFECT</b>
|
|
-
|
|
-<dd>If this statement is present, <b>ppmtompeg</b> schedules on the
|
|
-assumption that each machine is about the same speed. The master will
|
|
-simply divide up the frames evenly between the slaves -- each
|
|
-slave gets the same number of frames. If some slaves are faster than
|
|
-others, they will finish first and remain idle while the slower slaves
|
|
-continue.
|
|
-
|
|
-<p>This has the advantage of minimal scheduling overhead. Where slaves
|
|
-have different speeds, though, it makes inefficient use of the fast
|
|
-ones. Where slaves are the same speed, it also has the disadvantage
|
|
-that they all finish at the same time and feed their output to the
|
|
-single Combine Server in a burst, which makes less efficient use of
|
|
-the Combine Server and thus can increase the total elapsed time.
|
|
-
|
|
-<p>You may specify only one of PARALLEL_TIME_CHUNKS, PARALLEL_CHUNK_TAPER,
|
|
-and PARALLEL_PERFECT. PARALLEL_CHUNK_TAPER is usually best.
|
|
-
|
|
-<dt><b>RSH</b> <i>remote_shell_command</i>
|
|
-
|
|
-<dd><b>ppmtompeg</b> executes the shell command
|
|
-<i>remote_shell_command</i> to start a process on another machine.
|
|
-The default command is <b>rsh</b>, and whatever command you specify
|
|
-must have compatible semantics. <b>ssh</b> is usually compatible.
|
|
-The command <b>ppmtompeg</b> uses is one like this:
|
|
-<b>ssh remote.host.com -l username shellcommand</b>.
|
|
-
|
|
-<p>Be sure to set up <b>.rhosts</b> files or SSH key authorizations
|
|
-where needed. Otherwise, you'll have to type in passwords.
|
|
-
|
|
-<p>On some HP machines, <b>rsh</b> is the restricted shell, and you want
|
|
-to specify <b>remsh</b>.
|
|
-
|
|
-<dt><b>FORCE_I_ALIGN</b>
|
|
-
|
|
-<dd>This statement forces each slave to encode a chunk of frames which
|
|
-is a multiple of the pattern length (see <b>PATTERN</b>). Since the
|
|
-first frame in any pattern is an I frame, this forces each chunk
|
|
-encoded by a slave to begin with an I frame.
|
|
-
|
|
-<p>This document used to say there was an argument to
|
|
-<b>FORCE_I_ALIGN</b> which was the number of frames <b>ppmtompeg</b>
|
|
-would use (and was required to be a multiple of the pattern length).
|
|
-But <b>ppmtompeg</b> has apparently always ignored that argument, and
|
|
-it does now.
|
|
-
|
|
-<dt><b>KEEP_TEMP_FILES</b>
|
|
-
|
|
-<dd>This statement causes <b>ppmtompeg</b> not to delete the temporary
|
|
-files it uses to transmit encoded frames to the combine server. This
|
|
-means you will be left with a file for each frame, the same as you
|
|
-would get with the <b>-frames</b> option.
|
|
-
|
|
-<p>This is mostly useful for debugging.
|
|
-
|
|
-<p>This works only if you're using a shared filesystem to communicate
|
|
-between the servers.
|
|
-
|
|
-<p>This option was new in Netpbm 10.26 (January 2005).
|
|
-
|
|
-</dl>
|
|
-
|
|
-
|
|
-<h3 id="parameterfile">Parameter File Notes</h3>
|
|
-
|
|
-<p> If you use the <b>-combine_gops</b> option, then you need to specify
|
|
-only the SIZE and OUTPUT values in the parameter file. In
|
|
-addition, the parameter file may specify input GOP files in the same
|
|
-manner as normal input files -- except instead of using INPUT_DIR,
|
|
-INPUT, and END_INPUT, use GOP_INPUT_DIR, GOP_INPUT, and GOP_END_INPUT.
|
|
-If you specify no input GOP files, then <b>ppmtompeg</b> uses by default the
|
|
-output file name with suffix <b>.gop.</b><i>gop_num</i>, with <i>gop_num</i>
|
|
-starting from 0, as the input files.
|
|
-
|
|
-<p>If you use the <b>-combine_frames</b> option, then you need to
|
|
-specify only the SIZE, GOP_SIZE, and OUTPUT values in the
|
|
-parameter file. In addition, the parameter file may specify input
|
|
-frame files in the same manner as normal input files -- except instead
|
|
-of using INPUT_DIR, INPUT, and END_INPUT, use FRAME_INPUT_DIR,
|
|
-FRAME_INPUT, and FRAME_END_INPUT. If no input frame files are
|
|
-specified, then the default is to use the output file name with suffix
|
|
-<b>.frame.</b><i>frame_num</i>, with <i>frame_num</i> starting from 0,
|
|
-as the input files.
|
|
-
|
|
-<p>Any number of spaces and tabs may come between each option and value. Lines
|
|
-beginning with <b>#</b> are ignored. Any other lines are ignored except for
|
|
-those between INPUT and END_INPUT. This allows you to use the same
|
|
-parameter file for normal usage and for <b>-combine_gops</b> and
|
|
-<b>-combine_frames</b>.
|
|
-
|
|
-<p>The file format is case-sensitive so all keywords should be in
|
|
-upper case.
|
|
-
|
|
-<p>The statements may appear in any order, except that the order within
|
|
-a block statement (such as INPUT ... END INPUT) is significant.
|
|
-
|
|
-<p><b>ppmtompeg</b> is prepared to handle up to 16 B frames between
|
|
-reference frames when encoding with input from stdin. (To build a
|
|
-modified <b>ppmtompeg</b> with a higher limit, change the constant
|
|
-B_FRAME_RUN in frame.c and recompile).
|
|
-
|
|
-<h2 id="general">GENERAL USAGE INFORMATION</h2>
|
|
-
|
|
-<h3 id="qscale">Qscale</h3>
|
|
-
|
|
-<p>The quantization scale values (qscale) give a trade-off between
|
|
-quality and compression. Using different Qscale values has very little
|
|
-effect on speed. The qscale values can be set separately for I, P, and
|
|
-B frames.
|
|
-
|
|
-<p>You select the qscale values with the <b>IQSCALE</b>,
|
|
-<b>PQSCALE</b>, and <b>BSCALE</b> parameter file statements.
|
|
-
|
|
-<p>A qscale value is an integer from 1 to 31. Larger numbers give
|
|
-better compression, but worse quality. In the following, the quality
|
|
-numbers are peak signal-to-noise ratio, defined as:
|
|
-<img src="ppmtompeg-snr.gif" alt="signal-to-noise formula" height="52" width="302">
|
|
-where MSE is the mean squared error.
|
|
-
|
|
-
|
|
-<p>Flower garden tests:
|
|
-
|
|
-<table border="1" cellpadding="5" cellspacing="0">
|
|
- <caption>Qscale vs Quality</caption>
|
|
-<?makeman r r r r. ?>
|
|
-<?makeman _ ?>
|
|
- <tr style="text-align:center">
|
|
- <th>Qscale</th>
|
|
- <th>I Frames</th>
|
|
- <th>P Frames</th>
|
|
- <th>B Frames</th>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">1</td>
|
|
- <td style="text-align:right">43.2</td>
|
|
- <td style="text-align:right">46.3</td>
|
|
- <td style="text-align:right">46.5</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">6</td>
|
|
- <td style="text-align:right">32.6</td>
|
|
- <td style="text-align:right">34.6</td>
|
|
- <td style="text-align:right">34.3</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">11</td>
|
|
- <td style="text-align:right">28.6</td>
|
|
- <td style="text-align:right">29.5</td>
|
|
- <td style="text-align:right">30.0</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">16</td>
|
|
- <td style="text-align:right">26.3</td>
|
|
- <td style="text-align:right">26.8</td>
|
|
- <td style="text-align:right">28.6</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">21</td>
|
|
- <td style="text-align:right">24.7</td>
|
|
- <td style="text-align:right">25.0</td>
|
|
- <td style="text-align:right">27.9</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">26</td>
|
|
- <td style="text-align:right">23.5</td>
|
|
- <td style="text-align:right">23.9</td>
|
|
- <td style="text-align:right">27.5</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">31</td>
|
|
- <td style="text-align:right">22.6</td>
|
|
- <td style="text-align:right">23.0</td>
|
|
- <td style="text-align:right">27.3</td>
|
|
- </tr>
|
|
-</table>
|
|
-
|
|
-<table border="1" cellpadding="5" cellspacing="0">
|
|
- <caption>Qscale vs Compression</caption>
|
|
-<?makeman r r r r. ?>
|
|
-<?makeman _ ?>
|
|
- <tr style="text-align:center">
|
|
- <th>Qscale</th>
|
|
- <th>I Frames</th>
|
|
- <th>P Frames</th>
|
|
- <th>B Frames</th>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">1</td>
|
|
- <td style="text-align:right">2</td>
|
|
- <td style="text-align:right">2</td>
|
|
- <td style="text-align:right">2</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">6</td>
|
|
- <td style="text-align:right">7</td>
|
|
- <td style="text-align:right">10</td>
|
|
- <td style="text-align:right">15</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">11</td>
|
|
- <td style="text-align:right">11</td>
|
|
- <td style="text-align:right">18</td>
|
|
- <td style="text-align:right">43</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">16</td>
|
|
- <td style="text-align:right">15</td>
|
|
- <td style="text-align:right">29</td>
|
|
- <td style="text-align:right">97</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">21</td>
|
|
- <td style="text-align:right">19</td>
|
|
- <td style="text-align:right">41</td>
|
|
- <td style="text-align:right">173</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">26</td>
|
|
- <td style="text-align:right">24</td>
|
|
- <td style="text-align:right">56</td>
|
|
- <td style="text-align:right">256</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">31</td>
|
|
- <td style="text-align:right">28</td>
|
|
- <td style="text-align:right">73</td>
|
|
- <td style="text-align:right">330</td>
|
|
- </tr>
|
|
-</table>
|
|
-
|
|
-
|
|
-<h3 id="searchtech">Search Techniques</h3>
|
|
-
|
|
-<p>There are several different motion vector search techniques
|
|
-available. There are different techniques available for P frame
|
|
-search and B frame search. Using different search techniques present
|
|
-little difference in quality, but a large difference in compression
|
|
-and speed.
|
|
-
|
|
-<p>There are 4 types of P frame search: Exhaustive, TwoLevel,
|
|
-SubSample, and Logarithmic.
|
|
-
|
|
-<p>There are 3 types of B frame search: Exhaustive, Cross2, and
|
|
-Simple.
|
|
-
|
|
-The recommended search techniques are TwoLevel and Logarithmic for
|
|
-P frame search, and Cross2 and Simple for B frame search. Here are
|
|
-some numbers comparing the different search methods:
|
|
-
|
|
-<table border="1" cellpadding="5" cellspacing="0">
|
|
- <caption>P frame Motion Vector Search (Normalized)</caption>
|
|
-<?makeman r c c c. ?>
|
|
-<?makeman _ ?>
|
|
- <tr style="text-align:center">
|
|
- <th>Technique</th>
|
|
- <th>Compression<a href="#smallbetter"><sup>1</sup></a></th>
|
|
- <th>Speed <a href="#largefaster"><sup>2</sup></a></th>
|
|
- <th>Quality <a href="#largebetter"><sup>3</sup></a></th>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Exhaustive</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">SubSample</td>
|
|
- <td style="text-align:center">1008</td>
|
|
- <td style="text-align:center">2456</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">TwoLevel</td>
|
|
- <td style="text-align:center">1009</td>
|
|
- <td style="text-align:center">3237</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Logarithmic</td>
|
|
- <td style="text-align:center">1085</td>
|
|
- <td style="text-align:center">8229</td>
|
|
- <td style="text-align:center">998</td>
|
|
- </tr>
|
|
-</table>
|
|
-
|
|
-<table border="1" cellpadding="5" cellspacing="0">
|
|
- <caption>B frame Motion Vector Search (Normalized)</caption>
|
|
-<?makeman r c c c. ?>
|
|
-<?makeman _ ?>
|
|
- <tr style="text-align:center">
|
|
- <th>Technique</th>
|
|
- <th>Compression<a href="#smallbetter"><sup>1</sup></a></th>
|
|
- <th>Speed<a href="#largefaster"><sup>2</sup></a></th>
|
|
- <th>Quality<a href="#largebetter"><sup>3</sup></a></th>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Exhaustive</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Cross2</td>
|
|
- <td style="text-align:center">975</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">996</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Simple</td>
|
|
- <td style="text-align:center">938</td>
|
|
- <td style="text-align:center">1765</td>
|
|
- <td style="text-align:center">991</td>
|
|
- </tr>
|
|
-</table>
|
|
-
|
|
-<a name="smallbetter"> </a><sup>1</sup>Smaller numbers are better
|
|
-compression.
|
|
-
|
|
-<a name="largefaster"> </a><sup>2</sup>Larger numbers mean faster
|
|
-execution.
|
|
-
|
|
-<a name="largebetter"> </a><sup>3</sup>Larger numbers mean better quality.
|
|
-
|
|
-<p>For some reason, Simple seems to give better compression, but it
|
|
-depends on the image sequence.
|
|
-
|
|
-<p>Select the search techniques with the <b>PSEARCH_ALG</b> and
|
|
-<b>BSEARCH_ALG</b> parameter file statements.
|
|
-
|
|
-
|
|
-<h3 id="gop">Group Of Pictures (GOP)</h3>
|
|
-
|
|
-<p>A Group of Pictures (GOP) is a roughly independently decodable
|
|
-sequence of frames. An MPEG video stream is made of one or more
|
|
-GOP's. You may specify how many frames should be in each GOP with the
|
|
-<b>GOP_SIZE</b> parameter file statement. A GOP always starts with an
|
|
-I frame.
|
|
-
|
|
-<p>Instead of encoding an entire sequence, you can encode a single
|
|
-GOP. To do this, use the <b>-gop</b> command option. You can later
|
|
-join the resulting GOP files at any time by running <b>ppmtompeg</b>
|
|
-with the <b>-combine_gops</b> command option.
|
|
-
|
|
-
|
|
-<h3 id="slices">Slices</h3>
|
|
-
|
|
-<p>A slice is an independently decodable unit in a frame. It can be
|
|
-as small as one macroblock, or it can be as big as the entire frame.
|
|
-Barring transmission error, adding slices does not change quality or
|
|
-speed; the only effect is slightly worse compression. More slices are
|
|
-used for noisy transmission so that errors are more recoverable. Since
|
|
-usually errors are not such a problem, we usually just use one slice
|
|
-per frame.
|
|
-
|
|
-<p>Control the slice size with the <b>SLICES_PER_FRAME</b> parameter
|
|
-file statement.
|
|
-
|
|
-<p>Some MPEG playback systems require that each slice consist of whole
|
|
-rows of macroblocks. If you are encoding for this kind of player, if
|
|
-the height of the image is H pixels, then you should set the
|
|
-SLICES_PER_FRAME to some number which divides H/16. For example, if
|
|
-the image is 240 pixels (15 macroblocks) high, then you should use
|
|
-only 15, 5, 3, or 1 slices per frame.
|
|
-
|
|
-<p>Note: these MPEG playback systems are really wrong, since the MPEG
|
|
-standard says this doesn't have to be so.
|
|
-
|
|
-
|
|
-
|
|
-<h3 id="searchwindow">Search Window</h3>
|
|
-
|
|
-<p>The search window is the window in which <b>ppmtompeg</b> searches
|
|
-for motion vectors. The window is a square. You can specify the size
|
|
-of the square, and whether to allow half-pixel motion vectors or not,
|
|
-with the <b>RANGE</b> and <b>PIXEL</b> parameter file statements.
|
|
-
|
|
-<h3 id="ipb">I Frames, P Frames, B Frames</h3>
|
|
-
|
|
-<p>In MPEG-1, a movie is represented as a sequence of MPEG frames,
|
|
-each of which is an I Frame, a P Frame, or a B Frame. Each represents
|
|
-an actual frame of the movie (don't get confused by the dual use of
|
|
-the word "frame." A movie frame is a graphical image. An MPEG frame
|
|
-is a set of data that describes a movie frame).
|
|
-
|
|
-<p>An I frame ("intra" frame) describes a movie frame in isolation --
|
|
-without respect to any other frame in the movie. A P frame
|
|
-("predictive" frame) describes a movie frame by describing how it
|
|
-differs from the movie frame described by the latest preceding I or
|
|
-P frame. A B frame ("bidirectional" frame) describes a movie frame by
|
|
-describing how it differs from the movie frames described by the
|
|
-nearest I or P frame before <em>and</em> after it.
|
|
-
|
|
-<p>Note that the first frame of a movie must be described by an I
|
|
-frame (because there is no previous movie frame) and the last movie
|
|
-frame must be described by an I or P frame (because there is no
|
|
-subsequent movie frame).
|
|
-
|
|
-<p>Beyond that, you can choose which frames are represented by which
|
|
-types. You specify a pattern, such as IBPBP and <b>ppmtompeg</b>
|
|
-simply repeats it over and over throughout the movie. The pattern
|
|
-affects speed, quality, and stream size. Here is a chart which shows
|
|
-some of the trade-offs:
|
|
-
|
|
-<table border="1" cellpadding="5" cellspacing="0">
|
|
- <caption>Comparison of I/P/B Frames (Normalized)</caption>
|
|
-<?makeman r c c c. ?>
|
|
-<?makeman _ ?>
|
|
- <tr style="text-align:center">
|
|
- <th>Frame Type</th>
|
|
- <th>Size</th>
|
|
- <th>Speed</th>
|
|
- <th>Quality</th>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">I frames</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- <td style="text-align:center">1000</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">P frames</td>
|
|
- <td style="text-align:center">409</td>
|
|
- <td style="text-align:center">609</td>
|
|
- <td style="text-align:center">969</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">B frames</td>
|
|
- <td style="text-align:center">72</td>
|
|
- <td style="text-align:center">260</td>
|
|
- <td style="text-align:center">919</td>
|
|
- </tr>
|
|
- </table>
|
|
-
|
|
-(this is with constant qscale)
|
|
-
|
|
-<p>A standard sequence is IBBPBBPBBPBBPBB.
|
|
-
|
|
-<p>Select the sequence with the <b>PATTERN</b> parameter file statement.
|
|
-
|
|
-<p>Since the last MPEG frame cannot be a B frame (see above), if the
|
|
-pattern you specify indicates a B frame for the last movie frame of
|
|
-the movie, <b>ppmtompeg</b> makes it an I frame instead.
|
|
-
|
|
-<p>Before Netpbm 10.26 (January 2005), <b>ppmtompeg</b> instead drops
|
|
-the trailing B frames by default, and you need the
|
|
-<b>FORCE_ENCODE_LAST_FRAME</b> parameter file statement to make it do
|
|
-this.
|
|
-
|
|
-<p>The MPEG frames don't appear in the MPEG-1 stream in the same order that
|
|
-the corresponding movie frames appear in the movie -- the B frames come after
|
|
-the I and P frames on which they are based. For example, if the movie is
|
|
-4 frames that you will represent with the pattern IBBP, the MPEG-1 stream
|
|
-will start with an I frame describing movie frame 0. The next frame in
|
|
-the MPEG-1 stream is a P frame describing movie frame 3. The last two
|
|
-frames in the MPEG-1 stream are B frames describing movie frames 1 and 2,
|
|
-respectively.
|
|
-
|
|
-
|
|
-<h3 id="iofiles">Specifying Input and Output Files</h3>
|
|
-
|
|
-<p>Specify the input frame images with the <b>INPUT_DIR</b>,
|
|
-<b>INPUT</b>, <b>END_INPUT</b>, <b>BASE_FILE_FORMAT</b>,
|
|
-<b>SIZE</b>, <b>YUV_FORMAT</b> and <b>INPUT_CONVERT</b> parameter
|
|
-file statements.
|
|
-
|
|
-<p>Specify the output file with the <b>OUTPUT</b> parameter file statement.
|
|
-
|
|
-
|
|
-<h3 id="statistics">Statistics</h3>
|
|
-
|
|
-<p><b>ppmtompeg</b> can generate a variety of statistics about the
|
|
-encoding. See the <b>-stat</b>, <b>-snr</b>, <b>-mv_histogram</b>,
|
|
-<b>-quiet</b>, <b>-no_frame_summary</b>, and <b>-bit_rate_info</b>
|
|
-options.
|
|
-
|
|
-
|
|
-<h2 id="parallel">PARALLEL OPERATION</h2>
|
|
-
|
|
-<p>You can run <b>ppmtompeg</b> on multiple machines at once, encoding
|
|
-the same MPEG stream. When you do, the machines are used as shown in
|
|
-the following diagram. We call this "parallel mode."
|
|
-
|
|
-<p><img src="ppmtompeg-par.gif" alt="ppmtompeg-par.gif">
|
|
-
|
|
-<p>To do parallel processing, put the statement
|
|
-
|
|
-<pre>
|
|
- PARALLEL
|
|
-</pre>
|
|
-
|
|
-in the parameter file, followed by a listing of the machines, one
|
|
-machine per line, then
|
|
-
|
|
-<pre>
|
|
- END_PARALLEL
|
|
-</pre>
|
|
-
|
|
-Each of the machine lines must be in one of two forms. If the machine
|
|
-has filesystem access to the input files, then the line is:
|
|
-
|
|
-<p>
|
|
-<i>machine</i> <i>user</i> <i>executable</i>
|
|
-
|
|
-<p>The executable is normally <b>ppmtompeg</b> (you may need to give
|
|
-the complete path if you've built for different architectures). If
|
|
-the machine does not have filesystem access to the input files, the line
|
|
-is:
|
|
-
|
|
-<p><b>REMOTE</b> <i>machine</i> <i>user</i> <i>executable</i>
|
|
-<i>parameter file</i>
|
|
-
|
|
-<p>The <b>-max_machines</b> command option limits the number of
|
|
-machines <b>ppmtompeg</b> will use. If you specify more machines in
|
|
-the parameter file than <b>-max_machines</b> allows, <b>ppmtompeg</b>
|
|
-uses only the machines listed first. This is handy if you want to
|
|
-experiment with different amounts of parallelism.
|
|
-
|
|
-<p>In general, you should use full path file names when describing
|
|
-executables and parameter files. This <em>includes</em> the parameter
|
|
-file argument on the original invocation of <b>ppmtompeg</b>.
|
|
-
|
|
-<p>All file names must be the same on all systems (so if e.g. you're
|
|
-using an NFS filesystem, you must make sure it is mounted at the same
|
|
-mountpoint on all systems).
|
|
-
|
|
-<p>Because not all of the processes involved in parallel operation
|
|
-have easy access to the input files, you must specify the <b>SIZE</b>
|
|
-parameter file statement when you do parallel operation.
|
|
-
|
|
-<p>The machine on which you originally invoke <b>ppmtompeg</b> is the
|
|
-master machine. It hosts a "combine server,", a
|
|
-"decode server," and a number of "i/o servers,"
|
|
-all as separate processes. The other machines in the network (listed
|
|
-in the parameter file) are slave machines. Each hosts a single
|
|
-process that continuously requests work from the master and does it.
|
|
-The slave process does the computation to encode MPEG frames. It
|
|
-processes frames in batches identified by the master.
|
|
-
|
|
-<p>The master uses a remote shell command to start a process on a
|
|
-slave machine. By default, it uses an <b>rsh</b> shell command to do
|
|
-this. But use the <b>RSH</b> parameter file statement to control
|
|
-this. The shell command the master executes remotely is
|
|
-<b>ppmtompeg</b>, but with options to indicate that it is to perform
|
|
-slave functions.
|
|
-
|
|
-<p>The various machines talk to each other over TCP connections. Each
|
|
-machine finds and binds to a free TCP port number and tells its
|
|
-partners the port number. These port numbers are at least 2048.
|
|
-
|
|
-<p>Use the PARALLEL_TEST_FRAMES, PARALLEL_TIME_CHUNKS, and
|
|
-PARALLEL_PERFECT parameter file statements to control the way the
|
|
-master divides up work among the slaves.
|
|
-
|
|
-<p>Use the <b>-nice</b> command option to cause all slave processes to run
|
|
-"nicely," i.e. as low priority processes. That way, this substantial and
|
|
-long-running CPU load will have minimal impact on other, possibly
|
|
-interactive, users of the systems.
|
|
-
|
|
-<h2 id="speed">SPEED</h2>
|
|
-
|
|
-<p>Here is a look at <b>ppmtompeg</b> speed, in single-node (not parallel)
|
|
-operation:
|
|
-
|
|
-<table border="1" cellpadding="5" cellspacing="0">
|
|
- <caption>Compression Speed</caption>
|
|
-<?makeman r c. ?>
|
|
-<?makeman _ ?>
|
|
- <tr style="text-align:center">
|
|
- <th>Machine Type</th>
|
|
- <th>Macroblocks per second<sup>1</sup></th>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">HP 9000/755</td>
|
|
- <td style="text-align:center">280</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">DEC 3000/400</td>
|
|
- <td style="text-align:center">247</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">HP 9000/750</td>
|
|
- <td style="text-align:center">191</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">Sparc 10</td>
|
|
- <td style="text-align:center">104</td>
|
|
- </tr>
|
|
- <tr>
|
|
- <td style="text-align:right">DEC 5000</td>
|
|
- <td style="text-align:center">68</td>
|
|
- </tr>
|
|
-</table>
|
|
-<sup>1</sup>A macroblock is a 16x16 pixel square
|
|
-
|
|
-<p>The measurements in the table are with inputs and outputs via a
|
|
-conventional locally attached filesystem. If you are using a network
|
|
-filesystem over a single 10 MB/s Ethernet, that constrains your speed more
|
|
-than your CPU speed. In that case, don't expect to get better than 4
|
|
-or 5 frames per second no matter how fast your CPUs are.
|
|
-
|
|
-<p>Network speed is even more of a bottleneck when the slaves do not
|
|
-have filesystem access to the input files -- i.e. you declare them
|
|
-REMOTE.
|
|
-
|
|
-<p>Where I/O is the bottleneck, size of the input frames can make a big
|
|
-difference. So YUV input is better than PPM, and JPEG is better than
|
|
-both.
|
|
-
|
|
-<p>When you're first trying to get parallel mode working, be sure to
|
|
-use the <b>-debug_machines</b> option so you can see what's going on.
|
|
-Also, <b>-debug_sockets</b> can help you diagnose communication
|
|
-problems.
|
|
-
|
|
-
|
|
-<h2 id="authors">AUTHORS</h2>
|
|
-
|
|
-<ul>
|
|
-
|
|
-<li>Kevin Gong - University of California, Berkeley, <a
|
|
-href="mailto:keving@cs.berkeley.edu">keving@cs.berkeley.edu</a>
|
|
-
|
|
-<li>Ketan Patel - University of California, Berkeley, <a
|
|
-href="mailto:kpatel@cs.berkeley.edu">kpatel@cs.berkeley.edu</a>
|
|
-
|
|
-<li>Dan Wallach - University of California, Berkeley, <a
|
|
-href="mailto:dwallach@cs.berkeley.edu">dwallach@cs.berkeley.edu</a>
|
|
-
|
|
-<li>Darryl Brown - University of California, Berkeley, <a
|
|
-href="mailto:darryl@cs.berkeley.edu">darryl@cs.berkeley.edu</a>
|
|
-
|
|
-<li>Eugene Hung - University of California, Berkeley, <a
|
|
-href="mailto:eyhung@cs.berkeley.edu">eyhung@cs.berkeley.edu</a>
|
|
-
|
|
-<li>Steve Smoot - University of California, Berkeley, <a
|
|
-href="mailto:smoot@cs.berkeley.edu">smoot@cs.berkeley.edu</a>
|
|
-
|
|
-</ul>
|
|
-
|
|
-<hr>
|
|
-<h2 id="index">Table Of Contents</h2>
|
|
-<ul>
|
|
-<li><a href="#synopsis">SYNOPSIS</a>
|
|
-<li><a href="#description">DESCRIPTION</a>
|
|
-<li><a href="#options">OPTIONS</a>
|
|
-<li><a href="#parmfile">PARAMETER FILE</a>
|
|
- <ul>
|
|
- <li><a href="#parameterfile">Parameter File Notes</a>
|
|
- </ul>
|
|
-<li><a href="#general">GENERAL USAGE INFORMATION</a>
|
|
- <ul>
|
|
- <li><a href="#qscale">Qscale</a>
|
|
- <li><a href="#searchtech">Search Techniques</a>
|
|
- <li><a href="#gop">Group Of Pictures (GOP)</a>
|
|
- <li><a href="#slices">Slices</a>
|
|
- <li><a href="#searchwindow">Search Window</a>
|
|
- <li><a href="#ipb">I Frames, P Frames, B Frames</a>
|
|
- <li><a href="#iofiles">Specifying Input and Output Files </a>
|
|
- <li><a href="#statistics">Statistics</a>
|
|
- </ul>
|
|
-<li><a href="#parallel">PARALLEL OPERATION</a>
|
|
-<li><a href="#speed">SPEED</a>
|
|
-<li><a href="#authors">AUTHORS</a>
|
|
-</ul>
|
|
-</body>
|
|
-</html>
|
|
Binární soubory a/userguide/.pamgradient.html.swp a b/userguide/.pamgradient.html.swp jsou rozdílné
|
|
diff -urNp a/userguide/pamhomography.html b/userguide/pamhomography.html
|
|
--- a/userguide/pamhomography.html 2021-06-02 21:32:17.861061500 +0200
|
|
+++ b/userguide/pamhomography.html 2021-06-02 21:43:06.846140198 +0200
|
|
@@ -1,15 +1,7 @@
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.3//EN">
|
|
-<html xmlns="http://www.w3.org/1999/xhtml">
|
|
-<head>
|
|
-<title>pamhomography</title>
|
|
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
-<script type="text/javascript" src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
|
-<script type="text/javascript" id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
|
-</head>
|
|
-
|
|
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pamhomography User Manual</title></head>
|
|
<body>
|
|
-
|
|
-<h1 id="pamhomography">pamhomography</h1>
|
|
+<h1>pamhomography</h1>
|
|
|
|
Updated: 03 January 2021
|
|
<br>
|
|
@@ -17,8 +9,7 @@ Updated: 03 January 2021
|
|
|
|
|
|
<h2>NAME</h2>
|
|
-
|
|
-<p>pamhomography - map one arbitrary quadrilateral image region to another</p>
|
|
+pamhomography - map one arbitrary quadrilateral image region to another
|
|
|
|
|
|
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|