diff options
Diffstat (limited to 'upstream/opensuse-leap-15-6/man1/pnmtofiasco.1')
| -rw-r--r-- | upstream/opensuse-leap-15-6/man1/pnmtofiasco.1 | 392 |
1 files changed, 392 insertions, 0 deletions
diff --git a/upstream/opensuse-leap-15-6/man1/pnmtofiasco.1 b/upstream/opensuse-leap-15-6/man1/pnmtofiasco.1 new file mode 100644 index 00000000..54ebf10f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man1/pnmtofiasco.1 @@ -0,0 +1,392 @@ +\ +.\" This man page was generated by the Netpbm tool 'makeman' from HTML source. +.\" Do not hand-hack it! If you have bug fixes or improvements, please find +.\" the corresponding HTML page on the Netpbm website, generate a patch +.\" against that, and send it to the Netpbm maintainer. +.TH "Pnmtofiasco User Manual" 0 "July 12, 2000" "netpbm documentation" + +.SH NAME + +pnmtofiasco - Convert PNM file to FIASCO compressed file + +.UN synopsis +.SH SYNOPSIS + +\fBpnmtofiasco\fP +[\fIoption\fP]... +[\fIfilename\fP]... + +.UN description +.SH DESCRIPTION +.PP +This program is part of +.BR "Netpbm" (1)\c +\&. + +\fBpnmtofiasco\fP compresses the named pbm, pgm, or ppm image files, +or Standard Input if no file is named, and produces a FIASCO file on +Standard Output. + +.UN options +.SH OPTIONS +.PP +All option names may be abbreviated; for example, --optimize may be +written --optim or --opt. For most options a one letter short option +is provided. Mandatory or optional arguments to long options are +mandatory or optional for short options, too. Both short and long +options are case sensitive. +.PP +The basic options are: + + +.TP +\fB-i\fP \fIname\fP, \fB--input-name=\fP\fIname\fP +Compress the named images, not Standard Input. If \fIname\fP is +\fB-\fP, read Standard Input. \fIname\fP has to be either an image +filename or a template of the form: + +.nf +prefix[start-end{+,-}step]suffix +.fi +.sp +Templates are useful when compressing video streams: e.g., if you +specify the template \fBimg0[12-01-2].pgm\fP, then \fBpnmtofiasco\fP +compresses the images img012.pgm, img010.pgm, ..., img002.pgm. +.sp +If \fIname\fP is a relative path, \fBpnmtofiasco \fP searches for +the image files in the current directory and in the (colon-separated) +list of directories given by the environment variable +\fBFIASCO_IMAGES\fP. + +.TP +\fB-o\fP \fIoutput-file\fP, \fB--output-name=\fP\fIname\fP +Write FIASCO output to the named file, not to Standard Output. +.sp +If \fIname\fP is a relative path and the environment variable +\fBFIASCO_DATA\fP is a (colon-separated) list of directories, then +\fBpnmtofiasco\fP writes the output file to the first (writable) +directory of this list. Otherwise, \fBpnmtofiasco\fP write it to the +current directory. + +.TP +\fB-q\fP \fIN\fP, \fB--quality=\fP\fIN\fP +Set quality of compression to \fIN\fP. Quality is 1 (worst) to +100 (best); default is 20. + +.TP +\fB-v\fP, \fB--version\fP +Print \fBpnmtofiasco\fP version number, then exit. + +.TP +\fB-V\fP \fIN\fP, \fB--verbose \fP\fIN\fP +Set level of verbosity to \fIN\fP. Level is 0 (no output at +all), 1 (show progress meter), or 2 (show detailed compression +statistics); default is 1. + +.TP +\fB-B\fP \fIN\fP, \fB--progress-meter \fP\fIN\fP +Set type of progress-meter to \fIN\fP. The following types are +available; default is 1: + + +.TP +\fB0\fP +no progress meter + +.TP +\fB1\fP +RPM style progress bar using 50 hash marks + +.TP +\fB2\fP +percentage meter + + + +.TP +\fB-f\fP \fIname\fP, \fB--config=\fP\fIname\fP +Load parameter file \fIname \fP to initialize the options of +\fBpnmtofiasco\fP. See file \fBsystem.fiascorc\fP for an example of +the syntax. Options of \fBpnmtofiasco\fP are set by any of the +following methods (in the specified order): + + +.IP \(bu +Global resource file \fB/etc/system.fiascorc\fP +.IP \(bu +$HOME/.fiascorc +.IP \(bu +command line +.IP \(bu +--config=\fIname\fP + + +.TP +\fB-h\fP, \fB--info\fP +Print brief help, then exit. + +.TP +\fB-H\fP, \fB--help\fP +Print detailed help, then exit. + + +.PP +The options for advanced users are: + + +.TP +\fB-b\fP \fIname\fP, \fB--basis-name=\fP\fIname\fP +Preload compression basis \fIname\fP into FIASCO. The basis +\fIname\fP provides the initial compression dictionary. Either use +one of the files "small.fco", "medium.fco", or +"large.fco" that come with \fBpnmtofiasco \fP or create a +new ASCII basis file. + +.TP +\fB-z\fP \fIN\fP, \fB--optimize=\fP\fIN\fP +Set optimization level to \fIN\fP. Level is 0 (fastest) to 3 +(slowest); default is 1. Be warned, the encoding time dramatically +increased when \fIN\fP=\fB2\fP or \fIN\fP=\fB3\fP while the +compression performance only slightly improves. + +.TP +\fB-P\fP, \fB--prediction\fP +Use additional predictive coding. If this optimization is enabled +then the image is compressed in two steps. In the first step, a coarse +approximation of the image is computed using large unichrome +blocks. Finally, the delta image is computed and the prediction error +is approximated using the standard FIASCO algorithm. + +.TP +\fB-D\fP \fIN\fP, \fB--dictionary-size=\fP\fIN\fP +Set size of dictionary that is used when coding the luminance band +to \fIN\fP; default is 10000, i.e., the dictionary is not restricted. + +.TP +\fB-C\fP \fIN\fP, \fB--chroma-dictionary=\fP\fIN\fP +Set size of dictionary that is used when coding chroma bands to +\fIN\fP; default is 40. + +.TP +\fB-Q\fP \fIN\fP, \fB--chroma-qfactor=\fP\fIN\fP +Reduce the quality of chroma band compression \fIN\fP-times with +respect to the user defined quality \fIq\fP of the luminance band +compression (\fB--quality\fP=\fIq\fP); default is 2. + +.TP +\fB-t\fP \fIN\fP, \fB--tiling-exponent=\fP\fIN\fP +Subdivide the image into 2^\fIN\fP tiles prior coding; default is +4, i.e. the image is subdivided into 16 tiles. The processing order of +the individual tiles is defined by the option +\fB--tiling-method=\fP\fIname\fP. + +.TP +\fB-T\fP \fIname\fP, \fB--tiling-method=\fP\fIname\fP +Order the individual image tiles (the image is subdivided into; +see option \fB--tiling-exponent=\fP\fIN\fP) by method \fIname\fP; +default is \fBdesc-variance\fP. + + +.TP +\fBdesc-variance\fP +Tiles with small variances are processed first. + +.TP +\fBasc-variance\fP +Tiles with large variances are processed first. + +.TP +\fBdesc-spiral\fP +Tiles are process in spiral order starting in the middle. + +.TP +\fBasc-spiral\fP +Tiles are process in spiral order starting at the border. + + + +.TP +\fB--rpf-mantissa=\fP\fIN\fP +Use \fIN\fP mantissa bits for quantized coefficients. + +.TP +\fB--dc-rpf-mantissa=\fP\fIN\fP +Use \fIN\fP mantissa bits for quantized DC coefficients. + +.TP +\fB--rpf-range=\fP\fIN\fP +Coefficients outside the quantization interval +[-\fIN\fP,+\fIN\fP] are set to zero. + +.TP +\fB--dc-rpf-range=\fP\fIN\fP +DC coefficients outside the quantization interval +[-\fIN\fP,+\fIN\fP] are set to zero. + + +.PP +Additional options for video compression are + + +.TP +\fB-s\fP \fIN\fP, \fB--smooth=\fP\fIN\fP +Smooth decompressed reference frames along the partitioning +borders by the given amount \fIN\fP. \fIN\fP is 0 (no smoothing) to +100; default is 70. This factor is stored in the FIASCO file. + +.TP +\fB-m\fP \fIN\fP, \fB--min-level=\fP\fIN\fP +Start prediction (motion compensated prediction or additional +prediction) on block level \fIN\fP; default is level 6. I.e., motion +compensation is applied to all image blocks of at least 8x8 pixels +(binary tree level \fIN\fP=6), 16x8 (\fIN\fP=7), 16x16 (\fIN\fP=8), +etc. + +.TP +\fB-M\fP \fIN\fP, \fB--max-level=\fP\fIN\fP +Stop prediction (motion compensated prediction or additional +prediction) on block level \fIN\fP; default is level 10. I.e., +motion compensation is applied to all image blocks of at most 16x16 +pixels (\fIN\fP=8), 32x16 (\fIN\fP=9), 32x32 (\fIN\fP=10), etc. + +.TP +\fB-2\fP, \fB--half-pixel\fP +Use half pixel precise motion compensation. + +.TP +\fB-F\fP \fIN\fP, \fB--fps=\fP\fIN\fP +Set number of frames per second to \fIN\fP. This value is stored +in the FIASCO output file and is used in the decoder +.BR "fiascotopnm" (1)\c +\& to control the framerate. + +.TP +\fB-p\fP \fItype\fP, \fB--pattern=\fP\fItype\fP +Defines the type of inter frame compression which should be +applied to individual frames of a video stream. \fItype\fP is a +sequence of characters; default is "IPPPPPPPPP". Element +\fBN\fP defines the type of predicting which should be used for frame +\fBN\fP; the frame type pattern is periodically extended. Valid +characters are: + + +.TP +\fBI\fP +intra frame, i.e., no motion compensated prediction is used at +all. + +.TP +\fBP\fP +predicted frame, i.e., a previously encoded frame is used for +prediction (forward prediction). + +.TP +\fBB\fP +bidirectional predicted frame, i.e., not only a previously shown +frame but also a frame of the future is used for prediction (forward, +backward or interpolated prediction). + + + +.TP +\fB--cross-B-search\fP +Instead of using exhaustive search the "Cross-B-Search" +algorithm is used to find the best interpolated prediction of +B-frames. + +.TP +\fB--B-as-past-ref\fP +Also use previously encoded B-frames when prediction the current +frame. If this option is not set, only I- and P-frames are used to +predict the current frame. + + + + +.UN examples +.SH EXAMPLES +.PP +Compress the still image "foo.ppm" to the FIASCO file +"foo.wfa" using the default options: + +.nf + pnmtofiasco < foo.ppm >foo.wfa +.fi +.PP +Compress the video frames "foo0*.ppm" to the FIASCO file +"video.wfa" using half pixel precise motion compensation at +a frame rate of 15 frames per second. Intra frame 1 is used to +predict P-frame 4, frames 1 and 4 are used to predict B-frames 2 and +3, and so on. Frame 10 is again an intra-frame. + +.nf + pnmtofiasco -2 -p "IBBPBBPBB" -fps 15 -o video.wfa foo0*.ppm +.fi + +.UN files +.SH FILES + + +.TP +\fB/etc/system.fiascorc\fP +The systemwide initialization file. + +.TP +$HOME\fB/.fiascorc\fP +The personal initialization file. + + + +.UN environment +.SH ENVIRONMENT + + + + +.TP +\fBFIASCO_IMAGES\fP +Search path for image files. Default is "./". + +.TP +\fBFIASCO_DATA\fP +Search and save path for FIASCO files. Default is "./". + + + +.UN seealso +.SH SEE ALSO +.BR "fiascotopnm" (1)\c +\&, +.BR "pnmtojpeg" (1)\c +\&, +.BR "pnmtojbig" (1)\c +\&, +.BR "pamtogif" (1)\c +\&, +.BR "pnm" (5)\c +\& +.PP +Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger. +\fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on +Selected Areas In Communications, January 1998 +.PP +Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with +Weighted Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag, +ISBN 3-89820-002-7, October 1999. +.PP +.UR http://www.linuxjournal.com/node/4367/print +FIASCO: An Open-Source Fractal Image and Sequence Codec +.UE +\&, Linux Journal, +January 2001. + +.UN author +.SH AUTHOR + +Ullrich Hafner <\fIhafner@bigfoot.de\fP> +.SH DOCUMENT SOURCE +This manual page was generated by the Netpbm tool 'makeman' from HTML +source. The master documentation is at +.IP +.B http://netpbm.sourceforge.net/doc/pnmtofiasco.html +.PP
\ No newline at end of file |