summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/fiascotopnm.1
blob: d9146f3e49e6890e7185d556e9e6328c4259a1ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
\
.\" 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 "Fiascotopnm User Manual" 1 "12 July 2000" "netpbm documentation"

.SH NAME
fiascotopnm - Convert compressed FIASCO image to PGM, or PPM

.UN synopsis
.SH SYNOPSIS

\fBfiascotopnm \fP
[\fIoption\fP]...
[\fIfilename\fP]...
.PP
All option names may be abbreviated; for example, --output may be
written --outp or --ou. For all options an 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.


.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBfiascotopnm\fP decompresses the named FIASCO files, or the
Standard Input if no file is named, and writes the images as PGM, or
PPM files, depending on whether the FIASCO image is black and white or
color.

.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBfiascotopnm\fP recognizes the following
command line options:


.TP
\fB-o\fP[\fIname\fP], \fB--output=\fP[\fIname\fP]
 Write decompressed image to the file \fIname\fP.ppm (if PPM) or
\fIname\fP.pgm (if PGM).  If \fIname\fP is \fB-\fP, then produce
the image file on the standard output. The optional argument
\fIname\fP can be omitted, then the input filename is used as
basename with the suffix .ppm or .pgm. In case of video streams, the
frames are stored in the files \fIname\fP.\fBN\fP.ppm where \fBN\fP
is the frame number (of the form 00..0 - 99..9); output on the
standard output is not possible with video streams.
.sp
 If \fIname\fP is a relative path and the environment variable
\fBFIASCO_IMAGES\fP is a (colon-separated) list of directories, then
the output file(s) are written to the first (writable) directory of
this list. Otherwise, the current directory is used to store the
output file(s).

.TP
\fB-z\fP, \fB--fast\fP
Decompress images in the 4:2:0 format; i.e., each chroma channel is
decompressed to an image of halved width and height. Use this option
on slow machines when the desired frame rate is not achieved; the
output quality is only slightly decreased. 

.TP
\fB-d\fP, \fB--double\fP
Double the size of the X11 window both in width and height; no pixel
interpolation is used, each pixel is just replaced by four identical
pixels.

.TP
\fB-p\fP, \fB--panel\fP
Show a panel with play, stop, pause, record and exit buttons to
control the display of videos. When pressing the record button, all
frames are decompressed and stored in memory. The other buttons work
in the usual way.

.TP
\fB-m\fP \fIN\fP, \fB--magnify=\fP\fIN\fP
Set magnification of the decompressed image. Positive values enlarge
and negative values reduce the image width and height by a factor of
2^|\fIN\fP|.

.TP
\fB-s\fP \fIN\fP, \fB--smoothing=\fP\fIN\fP
Smooth decompressed image(s) along the partitioning borders by the
given amount \fIN\fP. \fIN\fP is 1 (minimum) to 100 (maximum); default
is 70. When \fIN\fP=0, then the smoothing amount specified in the
FIASCO file is used (defined by the FIASCO coder).

.TP
\fB-F\fP \fIN\fP, \fB--fps=\fP\fIN\fP
Set number of frames per second to \fIN\fP. When using this option,
the frame rate specified in the FIASCO file is overridden.

.TP
\fB--verbose=\fP\fIN\fP
Set verbose of \fBfiascotopnm\fP to \fIN\fP.

.TP
\fB-v\fP, \fB--version\fP
Print \fBfiascotopnm\fP version number, then exit.

.TP
\fB-f\fP \fIname\fP, \fB--config=\fP\fIname\fP
Load parameter file \fIname\fP to initialize the options of
\fBfiascotopnm\fP.  See file \fBsystem.fiascorc\fP for an example of
the syntax. Options of \fBfiascotopnm \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\fB/.fiascorc\fP

.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.




.UN examples
.SH EXAMPLES

.nf
fiascotopnm foo.wfa >foo.ppm

.fi
.PP
Decompress the FIASCO file "foo.wfa" and store it as
"foo.ppm".

.nf
fiascotopnm -o foo1.wfa foo2.wfa

.fi
.PP
Decompress the FIASCO files "foo1.wfa" and
"foo2.wfa" and write the frames to the image files
"foo1.wfa.ppm" and "foo2.wfa.ppm".

.nf
fiascotopnm -oimage foo1.wfa

.fi
.PP
Decompress the FIASCO file "foo1.wfa" and write all 15
frames to the image files "image.00.ppm", ... ,
"image.14.ppm".

.nf
fiascotopnm --fast --magnify=-1 --double video.wfa >stream.ppm

.fi
.PP
Decompress the FIASCO file "video.wfa".  The
decompression speed is as fast as possible: the image is decompressed
(in 4:2:0 format) at a quarter of its original size; then the image is
enlarged again by pixel doubling.

.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
Save path for image files. Default is "./".

.TP
\fBFIASCO_DATA\fP
Search path for FIASCO files. Default is "./".




.UN seealso
.SH SEE ALSO
.BR "pnmtofiasco" (1)\c
\&,
.BR "pnm" (1)\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
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.

.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/fiascotopnm.html
.PP