1seejpeg v1.10 $Id: README,v 1.10 1999/11/08 06:35:14 evan Exp $
2
3------------------------------------------------------------------
4Copyright (C) 1993-1999 Evan Harris
5
6Permission is granted to freely redistribute and modify this code,
7providing the author(s) get credit for having written it.
8------------------------------------------------------------------
9
10seejpeg is another JPEG viewer which utilizes svgalib and contains
11limited GIF, PPM, BMP and TARGA viewing support.
12
13The most useful feature of seejpeg is that it automatically decides on
14the "best" video mode to use based on the image being displayed and
15the video card being used. To aid it, various hints may be given as
16program options. In the worst case, it may be overridden.
17
18Video modes supported are limited to 2048x1536, 2048x1152, 1920x1440,
191800x1012, 1600x1200, 1360x768, 1280x1024, 1280x720, 1152x864,
201072x600, 1024x768, 960x720, 848x480, 800x600, 720x540, 640x480,
21640x400, 512x384, 400x300, 320x240 and 320x200 in 256, 32K, 16M or
2216M32 colours (assuming the video card, and svgalib, supports these
23modes). Logical screen sizes are only limited by the size of video
24memory.
25
26"16M32" colours is 24 bit colour in a 32 bit colour space. It is the
27only 24 bit colour mode available on some cards (e.g., Riva 128).
28
29If the image is larger than the screen size the arrow keys may be used
30to scroll around that part of the image which could be loaded into
31video memory. The Backspace key can be used to move to the previous
32image. Pressing any other key moves to the next image, or exits the
33program.
34
35------------------------------------------------------------------
36
37Program options
38===============
39
40See the manual entry.
41
42------------------------------------------------------------------
43
44Compiling
45=========
46
47This program was tested using version 1.4.0 of svgalib. It should
48also work with later versions.
49
50The following symbols can be defined in the Makefile:
51
52NO_32K_CASCADE If the best mode is available in 16M32, 16M and 32K
53 modes and the complete image doesn't fit in memory
54 using the 16M32 mode, the 16M32 mode is discarded and
55 16M mode used instead. If the complete image then
56 doesn't fit in memory using the 16M mode, the 16M mode
57 is discarded and 32K mode used instead.
58 If this option is defined this action does not happen.
59
60TESTMODE This video mode is tested for -
61 If the video card supports it, we assume that hicolor or
62 truecolor (32K, 16M or 16M32) modes are available.
63 If the video card doesn't support it, we assume that only
64 256 colour modes are supported.
65 If this is not set in the Makefile, it is assumed to
66 be G640x480x32K. If there is a video card which supports
67 hicolor or truecolor but not this mode, let me know of
68 a better default to test for and I'll change it in the
69 next release.
70
71BUG_WORKAROUND Some versions of svgalib with some video cards can
72 scramble the video mode when multiple files or
73 slideshows are shown. This appears to be avoided
74 somewhat if the text video mode is set between each
75 picture. This is what the workaround does. This may
76 not be needed for some versions of svgalib or some
77 video cards. This option is defined by default in the
78 makefile.
79
80ONLY_1_8_MODES The new video modes introduced in seejpeg 1.10 require
81 svgalib 1.4.0 or later. If this option is defined,
82 only modes used in seejpeg 1.08 are considered. This
83 allows svgalib 1.3 to be used.
84
85Unless you change one of these options, or the default binary
86location, changing the Makefile should no longer be necessary.
87
88PIX_ALIGN is no longer set in the Makefile. If you wish to try
89different a value for it, see chiptype_init() in display.c. If you
90lower PIX_ALIGN and it works, send me the changes.
91
92To build seejpeg, you require version 6 of the JPEG library. This
93library is NOT included with seejpeg. It is available on
94sunsite.unc.edu under /pub/Linux/libs, amongst others. You may need
95to adjust the JPEG_HEADERS and JPEG_LIBS definitions in the Makefile
96to find the JPEG header and library files.
97
98Note that some prepackaged Linux distributions do not include all of
99the required libjpeg-6 files in their standard installations.
100Additionally, those that do do not all install it in the same place.
101The files may be in /usr/{include,lib}, /usr/local/{include,lib} or
102/usr/X11R6/{include,lib}, to name three possible locations. If in
103doubt, obtain, compile and install libjpeg-6 yourself. If you still
104have problems, let me know.
105
106------------------------------------------------------------------
107
108Acknowledgements
109================
110
111The following people have contributed to the development of seejpeg.
112Thanks everyone.
113
114Harm Hanemaayer <hhanemaa@cs.ruu.nl>
115 svgalib development, putting up with lots of silly questions,
116 providing lots of useful information, and a makefile bug report
117<wolter@wppc9.oz.au>
118Jean-Francois Cordeau <cordeauj@jsp.umontreal.ca>
119Peter Mutsaers <muts@compi.hobby.nl>
120<ahughes@muddcs.cs.hmc.edu>
121 makefile bug report in 1.0
122Jeff Grills <jefftep@cs.utexas.edu>
123 colour lookup (256 colour mode) bug report in 1.2
124Michael Weller <eowmob@exp-math.uni-essen.de>
125 PIX_ALIGN patches against 1.1, prompting to add multiple
126 images and the slideshow
127 on-going svgalib development
128Nils Rennebarth <nils@exp-math.uni-essen.de>
129 described how to compile with libgr-1.3 cleanly
130Lord Maximilien <lordmax@ix.netcom.com>
131 helped fixed Trident 800x600 problems, suggested the new options
132 which were added in 1.6
133Ed Sawicki <ed@alcpress.com>
134 suggested the reload keyboard command
135
136------------------------------------------------------------------
137
138Feedback
139========
140
141The current version was compiled and tested with svgalib version 1.4.0
142and a 4MB Riva128 based video card. There are no known bugs with this
143configuration (in seejpeg, that is). If you find a bug with any
144configuration please report it, including all the information
145displayed using the "-v" option.
146
147As of version 1.2, I have considered seejpeg "finished". Despite
148that, there have been 13 distinct versions since then. 8-) As has
149been the case since version 1.2, future releases will primarily be bug
150and compatibility fixes, although new features (sometimes only minor)
151have been added in each "major" release.
152
153Please send any feedback, especially bug reports, to:
154
155Evan Harris (evan@cs.mu.oz.au)
156