Debian Codegraph @

upstream/debian-trixie/man1/pnmtofiasco.1

raw
1 \
2 .\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
3 .\" Do not hand-hack it! If you have bug fixes or improvements, please find
4 .\" the corresponding HTML page on the Netpbm website, generate a patch
5 .\" against that, and send it to the Netpbm maintainer.
6 .TH "Pnmtofiasco User Manual" 1 "12 July 2000" "netpbm documentation"
7
8 .SH NAME
9
10 pnmtofiasco - Convert PNM file to FIASCO compressed file
11
12 .UN synopsis
13 .SH SYNOPSIS
14
15 \fBpnmtofiasco\fP
16 [\fIoption\fP]...
17 [\fIfilename\fP]...
18
19 .UN description
20 .SH DESCRIPTION
21 .PP
22 This program is part of
23 .BR "Netpbm" (1)\c
24 \&.
25
26 \fBpnmtofiasco\fP compresses the named pbm, pgm, or ppm image files,
27 or Standard Input if no file is named, and produces a FIASCO file on
28 Standard Output.
29
30 .UN options
31 .SH OPTIONS
32 .PP
33 In addition to the options common to all programs based on libnetpbm
34 (most notably \fB-quiet\fP, see
35 .UR index.html#commonoptions
36 Common Options
37 .UE
38 \&), \fBpnmtofiasco\fP recognizes the following
39 command line options:
40 .PP
41 All option names may be abbreviated; for example, --optimize may be
42 written --optim or --opt. For most options a one letter short option
43 is provided. Mandatory or optional arguments to long options are
44 mandatory or optional for short options, too. Both short and long
45 options are case sensitive.
46
47 .UN basicopts
48 .SS Basic Options
49
50
51 .TP
52 \fB-i\fP \fIname\fP, \fB--image-name=\fP\fIname\fP
53 Compress the named images, not Standard Input. If \fIname\fP is
54 \fB-\fP, read Standard Input. \fIname\fP has to be either an image
55 filename or a template of the form:
56
57 .nf
58 prefix[start-end{+,-}step]suffix
59
60 .fi
61 .sp
62 Templates are useful when compressing video streams: e.g., if you
63 specify the template \fBimg0[12-01-2].pgm\fP, then \fBpnmtofiasco\fP
64 compresses the images img012.pgm, img010.pgm, ..., img002.pgm.
65 .sp
66 If \fIname\fP is a relative path, \fBpnmtofiasco \fP searches for
67 the image files in the current directory and in the (colon-separated)
68 list of directories given by the environment variable
69 \fBFIASCO_IMAGES\fP.
70
71 .TP
72 \fB-o\fP \fIoutput-file\fP, \fB--output-name=\fP\fIname\fP
73 Write FIASCO output to the named file, not to Standard Output.
74 .sp
75 If \fIname\fP is a relative path and the environment variable
76 \fBFIASCO_DATA\fP is a (colon-separated) list of directories, then
77 \fBpnmtofiasco\fP writes the output file to the first (writable)
78 directory of this list. Otherwise, \fBpnmtofiasco\fP write it to the
79 current directory.
80
81 .TP
82 \fB-q\fP \fIN\fP, \fB--quality=\fP\fIN\fP
83 Set quality of compression to \fIN\fP. Quality is 1 (worst) to
84 100 (best); default is 20.
85
86 .TP
87 \fB-v\fP, \fB--version\fP
88 Print \fBpnmtofiasco\fP version number, then exit.
89
90 .TP
91 \fB-V\fP \fIN\fP, \fB--verbose \fP\fIN\fP
92 Set level of verbosity to \fIN\fP. Level is 0 (no output at
93 all), 1 (show progress meter), or 2 (show detailed compression
94 statistics); default is 1.
95
96 .TP
97 \fB-B\fP \fIN\fP, \fB--progress-meter \fP\fIN\fP
98 Set type of progress-meter to \fIN\fP. The following types are
99 available; default is 1:
100
101
102 .TP
103 \fB0\fP
104 no progress meter
105
106 .TP
107 \fB1\fP
108 RPM style progress bar using 50 hash marks
109
110 .TP
111 \fB2\fP
112 percentage meter
113
114
115
116 .TP
117 \fB-f\fP \fIname\fP, \fB--config=\fP\fIname\fP
118 Load parameter file \fIname \fP to initialize the options of
119 \fBpnmtofiasco\fP. See file \fBsystem.fiascorc\fP for an example of
120 the syntax. Options of \fBpnmtofiasco\fP are set by any of the
121 following methods (in the specified order):
122
123
124 .IP \(bu
125 Global resource file \fB/etc/system.fiascorc\fP
126 .IP \(bu
127 $HOME/.fiascorc
128 .IP \(bu
129 command line
130 .IP \(bu
131 --config=\fIname\fP
132
133
134 .TP
135 \fB-h\fP, \fB--info\fP
136 Print brief help, then exit.
137
138 .TP
139 \fB-H\fP, \fB--help\fP
140 Print detailed help, then exit.
141
142
143
144 .UN advancedopts
145 .SS Options for Advanced Users
146
147
148 .TP
149 \fB-b\fP \fIname\fP, \fB--basis-name=\fP\fIname\fP
150 Preload compression basis \fIname\fP into FIASCO. The basis
151 \fIname\fP provides the initial compression dictionary. Either use
152 one of the files "small.fco", "medium.fco", or
153 "large.fco" that come with \fBpnmtofiasco \fP or create a
154 new ASCII basis file.
155
156 .TP
157 \fB-z\fP \fIN\fP, \fB--optimize=\fP\fIN\fP
158 Set optimization level to \fIN\fP. Level is 0 (fastest) to 3
159 (slowest); default is 1. Be warned, the encoding time dramatically
160 increased when \fIN\fP=\fB2\fP or \fIN\fP=\fB3\fP while the
161 compression performance only slightly improves.
162
163 .TP
164 \fB-P\fP, \fB--prediction\fP
165 Use additional predictive coding. If this optimization is enabled
166 then the image is compressed in two steps. In the first step, a coarse
167 approximation of the image is computed using large unichrome
168 blocks. Finally, the delta image is computed and the prediction error
169 is approximated using the standard FIASCO algorithm.
170
171 .TP
172 \fB-D\fP \fIN\fP, \fB--dictionary-size=\fP\fIN\fP
173 Set size of dictionary that is used when coding the luminance band
174 to \fIN\fP; default is 10000, i.e., the dictionary is not restricted.
175
176 .TP
177 \fB-C\fP \fIN\fP, \fB--chroma-dictionary=\fP\fIN\fP
178 Set size of dictionary that is used when coding chroma bands to
179 \fIN\fP; default is 40.
180
181 .TP
182 \fB-Q\fP \fIN\fP, \fB--chroma-qfactor=\fP\fIN\fP
183 Reduce the quality of chroma band compression \fIN\fP-times with
184 respect to the user defined quality \fIq\fP of the luminance band
185 compression (\fB--quality\fP=\fIq\fP); default is 2.
186
187 .TP
188 \fB-t\fP \fIN\fP, \fB--tiling-exponent=\fP\fIN\fP
189 Subdivide the image into 2^\fIN\fP tiles prior coding; default is
190 4, i.e. the image is subdivided into 16 tiles. The processing order of
191 the individual tiles is defined by the option
192 \fB--tiling-method=\fP\fIname\fP.
193
194 .TP
195 \fB-T\fP \fIname\fP, \fB--tiling-method=\fP\fIname\fP
196 Order the individual image tiles (the image is subdivided into;
197 see option \fB--tiling-exponent=\fP\fIN\fP) by method \fIname\fP;
198 default is \fBdesc-variance\fP.
199
200
201 .TP
202 \fBdesc-variance\fP
203 Tiles with small variances are processed first.
204
205 .TP
206 \fBasc-variance\fP
207 Tiles with large variances are processed first.
208
209 .TP
210 \fBdesc-spiral\fP
211 Tiles are process in spiral order starting in the middle.
212
213 .TP
214 \fBasc-spiral\fP
215 Tiles are process in spiral order starting at the border.
216
217
218
219 .TP
220 \fB--rpf-mantissa=\fP\fIN\fP
221 Use \fIN\fP mantissa bits for quantized coefficients.
222
223 .TP
224 \fB--dc-rpf-mantissa=\fP\fIN\fP
225 Use \fIN\fP mantissa bits for quantized DC coefficients.
226
227 .TP
228 \fB--rpf-range=\fP\fIN\fP
229 Coefficients outside the quantization interval
230 [-\fIN\fP,+\fIN\fP] are set to zero.
231
232 .TP
233 \fB--dc-rpf-range=\fP\fIN\fP
234 DC coefficients outside the quantization interval
235 [-\fIN\fP,+\fIN\fP] are set to zero.
236
237
238
239 .UN videoopts
240 .SS Additional Options for Video Compression
241
242
243 .TP
244 \fB-s\fP \fIN\fP, \fB--smooth=\fP\fIN\fP
245 Smooth decompressed reference frames along the partitioning
246 borders by the given amount \fIN\fP. \fIN\fP is 0 (no smoothing) to
247 100; default is 70. This factor is stored in the FIASCO file.
248
249 .TP
250 \fB-m\fP \fIN\fP, \fB--min-level=\fP\fIN\fP
251 Start prediction (motion compensated prediction or additional
252 prediction) on block level \fIN\fP; default is level 6. I.e., motion
253 compensation is applied to all image blocks of at least 8x8 pixels
254 (binary tree level \fIN\fP=6), 16x8 (\fIN\fP=7), 16x16 (\fIN\fP=8),
255 etc.
256
257 .TP
258 \fB-M\fP \fIN\fP, \fB--max-level=\fP\fIN\fP
259 Stop prediction (motion compensated prediction or additional
260 prediction) on block level \fIN\fP; default is level 10. I.e.,
261 motion compensation is applied to all image blocks of at most 16x16
262 pixels (\fIN\fP=8), 32x16 (\fIN\fP=9), 32x32 (\fIN\fP=10), etc.
263
264 .TP
265 \fB-2\fP, \fB--half-pixel\fP
266 Use half pixel precise motion compensation.
267
268 .TP
269 \fB-F\fP \fIN\fP, \fB--fps=\fP\fIN\fP
270 Set number of frames per second to \fIN\fP. This value is stored
271 in the FIASCO output file and is used in the decoder
272 .BR "fiascotopnm" (1)\c
273 \& to control the framerate.
274
275 .TP
276 \fB-p\fP \fItype\fP, \fB--pattern=\fP\fItype\fP
277 Defines the type of inter frame compression which should be
278 applied to individual frames of a video stream. \fItype\fP is a
279 sequence of characters; default is "IPPPPPPPPP". Element
280 \fBN\fP defines the type of predicting which should be used for frame
281 \fBN\fP; the frame type pattern is periodically extended. Valid
282 characters are:
283
284
285 .TP
286 \fBI\fP
287 intra frame, i.e., no motion compensated prediction is used at
288 all.
289
290 .TP
291 \fBP\fP
292 predicted frame, i.e., a previously encoded frame is used for
293 prediction (forward prediction).
294
295 .TP
296 \fBB\fP
297 bidirectional predicted frame, i.e., not only a previously shown
298 frame but also a frame of the future is used for prediction (forward,
299 backward or interpolated prediction).
300
301
302
303 .TP
304 \fB--cross-B-search\fP
305 Instead of using exhaustive search the "Cross-B-Search"
306 algorithm is used to find the best interpolated prediction of
307 B-frames.
308
309 .TP
310 \fB--B-as-past-ref\fP
311 Also use previously encoded B-frames when prediction the current
312 frame. If this option is not set, only I- and P-frames are used to
313 predict the current frame.
314
315
316
317
318 .UN examples
319 .SH EXAMPLES
320 .PP
321 Compress the still image "foo.ppm" to the FIASCO file
322 "foo.wfa" using the default options:
323
324 .nf
325 pnmtofiasco < foo.ppm >foo.wfa
326
327 .fi
328 .PP
329 Compress the video frames "foo0*.ppm" to the FIASCO file
330 "video.wfa" using half pixel precise motion compensation at
331 a frame rate of 15 frames per second. Intra frame 1 is used to
332 predict P-frame 4, frames 1 and 4 are used to predict B-frames 2 and
333 3, and so on. Frame 10 is again an intra-frame.
334
335 .nf
336 pnmtofiasco -2 -p "IBBPBBPBB" -fps 15 -o video.wfa foo0*.ppm
337
338 .fi
339
340 .UN files
341 .SH FILES
342
343
344 .TP
345 \fB/etc/system.fiascorc\fP
346 The systemwide initialization file.
347
348 .TP
349 $HOME\fB/.fiascorc\fP
350 The personal initialization file.
351
352
353
354 .UN environment
355 .SH ENVIRONMENT
356
357
358
359
360 .TP
361 \fBFIASCO_IMAGES\fP
362 Search path for image files. Default is "./".
363
364 .TP
365 \fBFIASCO_DATA\fP
366 Search and save path for FIASCO files. Default is "./".
367
368
369
370 .UN seealso
371 .SH SEE ALSO
372 .BR "fiascotopnm" (1)\c
373 \&,
374 .BR "pnmtojpeg" (1)\c
375 \&,
376 .BR "pnmtojbig" (1)\c
377 \&,
378 .BR "pamtogif" (1)\c
379 \&,
380 .BR "pnm" (1)\c
381 \&
382 .PP
383 Ullrich Hafner, Juergen Albert, Stefan Frank, and Michael Unger.
384 \fBWeighted Finite Automata for Video Compression\fP, IEEE Journal on
385 Selected Areas In Communications, January 1998
386 .PP
387 Ullrich Hafner. \fBLow Bit-Rate Image and Video Coding with
388 Weighted Finite Automata\fP, Ph.D. thesis, Mensch & Buch Verlag,
389 ISBN 3-89820-002-7, October 1999.
390 .PP
391 FIASCO: An Open-Source Fractal Image and Sequence Codec, Linux Journal,
392 January 2001.
393
394 .UN author
395 .SH AUTHOR
396
397 Ullrich Hafner <\[email protected]\fP>
398 .SH DOCUMENT SOURCE
399 This manual page was generated by the Netpbm tool 'makeman' from HTML
400 source. The master documentation is at
401 .IP
402 .B http://netpbm.sourceforge.net/doc/pnmtofiasco.html
403 .PP