home *** CD-ROM | disk | FTP | other *** search
/ PC-Online 1996 May / PCOnline_05_1996.bin / linux / source / contrib / seejpeg / seejpeg-.4 / seejpeg- / seejpeg-1.4.3 / README < prev    next >
Text File  |  1994-04-15  |  9KB  |  206 lines

  1. seejpeg  v1.4.3
  2.  
  3. ------------------------------------------------------------------
  4. Copyright (C) 1993, 1994 Evan Harris
  5.  
  6. Permission is granted to freely redistribute and modify this code,
  7. providing the author(s) get credit for having written it.
  8. ------------------------------------------------------------------
  9.  
  10. seejpeg is another JPEG viewer which utilizes svgalib and contains
  11. limited GIF, PPM and TARGA viewing support.
  12.  
  13. The most useful feature of seejpeg is that it automatically decides on
  14. the "best" video mode to use based on the image being displayed and
  15. the video card being used.  To aid it, various hints may be given as
  16. program options.  In the worst case, it may be overridden.
  17.  
  18. Video modes supported are limited to 1280x1024, 1024x768, 800x600,
  19. 640x480 and 320x200 in 256, 32K or 16M colours (assuming the video
  20. card, and svgalib, supports these modes).  Logical screen sizes are
  21. only limited by the size of video memory.
  22.  
  23. In normal mode, if the image is larger than the screen size the arrow
  24. keys may be used to scroll around that part of the image which could
  25. be loaded into video memory.  Pressing any other key exits the
  26. program.
  27.  
  28. ------------------------------------------------------------------
  29.  
  30. Program options
  31. ===============
  32.  
  33. -q    QUANTIZE PICTURE (256 colour mode)        (JPEG only)
  34.     This option forces the image to be quantized into a colour
  35.     map with 256 entries, and subsequently seejpeg uses a 256
  36.     colour mode.  If this option is not given seejpeg will not
  37.     use a 256 colour mode unless the TESTMODE is not available
  38.     (see below) in which case it will implicitly set -q.
  39.     The default quantization to use is two pass quantization -
  40.     this is memory intensive and may cause the machine to page
  41.     if the image is large or memory is small.  This should be
  42.     the only occasion in which seejpeg causes a machine to page.
  43. -1    ONE PASS QUANTIZATION (-q implicit)        (JPEG only)
  44.     As -q, except that it uses one pass quantization.  This does
  45.     not cause a machine to page, but the results are worse, unless
  46.     the image is greyscale.
  47. -g    FORCE GREYSCALE MODE (-1 implicit)        (JPEG only)
  48.     Display the image in greyscale.  This is not necessary for
  49.     an image compressed using the greyscale option on cjpeg as this
  50.     mode will be set automatically.  It can be used for images
  51.     compressed without the greyscale flag, or for displaying colour
  52.     images in greyscale.
  53. -v    VERBOSE
  54.     Display the video modes being used, the program version number
  55.     and lots of other stuff.  Without this option, seejpeg operates
  56.     silently.
  57. -w    ONLY USE WIDTH TO DETERMINE VIDEO MODE
  58.     By default, the video mode chosen is the smallest one possible
  59.     which is not smaller than the image.  This may not be desirable
  60.     for long, thin images.  It may be preferable to choose the
  61.     video mode based on the width only, rather than the width and
  62.     height, in which case this option should be used.
  63. -f F    SET FUZZ FACTOR TO DETERMINE VIDEO MODE
  64.     A video mode is selected if it is larger than the image.
  65.     Using this option allows a video mode to be selected if it is
  66.     larger than (or equal to) F * image_width and F * image_height.
  67.     Currently, F must be in the range [0.5,1.0].  This option may
  68.     be used in conjunction with -w to only use the image width.
  69. -F S    FORCE THE USE OF THE GIVEN VIDEO MODE
  70.     To completely override the video mode selection routines a
  71.     video mode string (e.g. G640x480x32K) may be given instead.
  72.     If this is a 256 colour mode, quantization (-q) is
  73.     automatically selected.
  74. -dx    DOUBLE THE SIZE OF THE IMAGE IN THE X DIRECTION
  75. -s T    SHOW THE IMAGES IN A SLIDESHOW
  76.     Each image is shown for T seconds.  The images cannot be
  77.     scrolled when being showed in a slideshow.  The slideshow cannot
  78.     be stopped or paused, except by the interrupt character
  79.     (e.g. ^C).
  80. -C    CYCLE THROUGH ALL IMAGES
  81.     The program does not exit after showing all the images, instead
  82.     it returns to the first image and shows them all again.  Normally
  83.     this can be stopped by pressing the Q key, at which point it will
  84.     continue to show all images in the cycle and then stop.  When
  85.     showing the images in a slideshow this option will cause the
  86.     slideshow to run forever (until interrupted by, e.g., ^C).
  87.  
  88. In addition to colour and greyscale JPEG formats, GIF, PPM and TARGA
  89. image formats are supported to a limited degree.  If the image is in
  90. GIF, PPM or TARGA format the -q, -1 and -g options are inoperative
  91. and, as a result, some video modes are not available for selection
  92. using -F.
  93.  
  94. Unfortunately, due to a limitation in libjpeg, the GIF support has to
  95. perform its own colour map construction so it can use 256 colour
  96. modes.  This may cause problems, although I haven't seen any yet.  GIF
  97. support currently only uses 256 colour modes, however changing this
  98. should be easy, if the demand is there for it.  GIF support has had
  99. limited testing.
  100.  
  101. PPM support is barely tested.  It uses 16M or 32K modes for colour
  102. images, and 256 modes for greyscale images.
  103.  
  104. TARGA support is completely untested as I've never seen or generated a
  105. TARGA image.  The -targa option of cjpeg is not included in seejpeg,
  106. let me know if something like it is required.
  107.  
  108. ------------------------------------------------------------------
  109.  
  110. Compiling
  111. =========
  112.  
  113. This program requires version 0.91 or higher of svgalib.  This is
  114. changed from previous versions because we now call vga_init() which
  115. gives up supervisor rights really quickly.
  116.  
  117. The following symbols can be defined in the Makefile:
  118. PIX_ALIGN    The constraints on the logical line length for different
  119.         video cards are different.  Some video cards (like my
  120.         CLGD5426) want the logical line length to be a multiple
  121.         of 8 pixels, while others don't look good unless it is a
  122.         multiple of 64 pixels (such as some (all?) Mach32 cards).
  123.         This value also affects the horizontal scrolling, so use
  124.         the smallest you can get away with.
  125.         The default value is now 64 pixels.  Hopefully this
  126.         produces good results for everybody.  Other values that
  127.         may be worth trying would be 8, 16 and 32.  I recommend
  128.         using the lowest value that produces a good display.
  129. NO_32K_CASCADE    If the best mode is available in 16M and 32K modes and
  130.         the complete image doesn't fit in memory using the 16M
  131.         mode, the 16M mode is discarded and 32K mode used instead.
  132.         If you define this option this action does not happen.
  133.         The only time I can think of this option being useful is
  134.         if a video card supports 16M modes but not 32K modes.
  135. TESTMODE    This video mode is tested for -
  136.         If the video card supports it, we assume that hicolor or
  137.         truecolor (32K or 16M) modes are available.
  138.         If the video card doesn't support it, we assume that only
  139.         256 colour modes are supported.
  140.         If this is not set in the Makefile, it is assumed to
  141.         be G640x480x32K.  If there is a video card which supports
  142.         hicolor or truecolor but not this mode, let me know of
  143.         a better default to test for and I'll change it in the
  144.         next release.
  145. BUG_WORKAROUND    Some versions of svgalib with some video cards can scramble
  146.         the video mode when multiple files or slideshows are shown.
  147.         This appears to be avoided somewhat if the text video mode
  148.         is set between each picture.  This is what the workaround
  149.         does.  This may not be needed for some versions of svgalib
  150.         or some video cards.  It is for my CLGD5426 based card with
  151.         svgalib 1.06.  This option is defined by default in the
  152.         makefile.
  153. Unless you change one of these options, or the default binary
  154. location, changing the Makefile should no longer be necessary.
  155.  
  156. You now can build a version of seejpeg which uses libgr-1.3.  This
  157. shared library is NOT included with seejpeg.  It is available on
  158. sunsite in /pub/Linux/libs, amongst others.  The seejpeg makefile
  159. assumes that the the installation is as per the README in libgr-1.3.
  160. If this is not the case, the definition of GRHEADERS may have to be
  161. changed in the makefile.
  162.  
  163. ------------------------------------------------------------------
  164.  
  165. Acknowledgements
  166. ================
  167.  
  168. The following people have contributed to the development of seejpeg.
  169. Thanks everyone.
  170.  
  171. Harm Hanemaayer <hhanemaa@cs.ruu.nl>
  172.     ongoing svgalib development, putting up with lots of silly
  173.     questions, providing lots of useful information, and a makefile
  174.     bug report
  175. <wolter@wppc9.oz.au>
  176. Jean-Francois Cordeau <cordeauj@jsp.umontreal.ca>
  177. Peter Mutsaers <muts@compi.hobby.nl>
  178. <ahughes@muddcs.cs.hmc.edu>
  179.     makefile bug report in 1.0
  180. Jeff Grills <jefftep@cs.utexas.edu>
  181.     colour lookup (256 colour mode) bug report in 1.2
  182. Michael Weller <eowmob@exp-math.uni-essen.de>
  183.     PIX_ALIGN patches against 1.1, prompting to add multiple
  184.     images and the slideshow
  185. Nils Rennebarth <nils@exp-math.uni-essen.de>
  186.     described how to compile with libgr-1.3 cleanly
  187.  
  188. ------------------------------------------------------------------
  189.  
  190. Feedback
  191. ========
  192.  
  193. The current version was compiled and tested with svgalib version 1.06
  194. and a 1MB CLGD5426 based video card.  There are no known bugs with
  195. this configuration (in seejpeg, that is 8-).  If you find a bug with
  196. any configuration please report it, including all the information
  197. displayed using the "-v" option.
  198.  
  199. As of version 1.2, I have considered seejpeg "finished".  Future
  200. releases will primarily be bug fixes, although new features may be
  201. added as well (as they were in 1.4).
  202.  
  203. Please send any feedback, especially bug reports, to:
  204.  
  205. Evan Harris (evan@cs.mu.oz.au)
  206.