@Database XiPaintModule.guide @Remark Documentation for HHsXiPaintModule @Remark (C) by Helmut Hoffmann 1995/96 @Index Main @Node Main "HHsXiPaintModule - Overview" XiPaintModule 5.2 ============= +------------------------------------------------------------------------------+ | The fast and flexible loader/saver module for XiPaint (3.2,4.x,...): | | * fast loading of more than 20 file formats (incl. e.g. PhotoCD) | | * downscaled loading support (load big pictures with few memory) | | * TrueColor animation creation saver for CyberGraphX or EGS users incl. | | automatic animation creation from directory of pictures by ARexx script | | * New: Now with support for Progressive-JPeg loading! | | new: now with IFF-ILBM 15 Bit support | +------------------------------------------------------------------------------+ Please note: The demo version loads and saves only in greyscale! Please pay the shareware fee to get color loading/saving... -> New: Order the XiPaintModule for low add-on prices with the new @{"PhotoAlbum" Link PHOTOALBUM} (picture management software for all OS3.x Amigas) <- New: Registered module users can order my new @{"PhotoAlbum" Link PHOTOALBUM} (usable on all OS3.x Amigas) or the package of @{"PhotoAlbum" Link PHOTOALBUM}&@{"CyberShow" Link CYBERSHOW} for special side-grade prices; see the PhotoAlbum documentation for details! The new PhotoAlbum software can e.g. be found on Aminet in gfx/misc. @{"Disclaimer, Copyright, Usage and Distribution conditions" Link RECHTLICHES} -> Warning: @{"Illegal keyfiles" Link ILLEGAL} @{"Information about the supported picture file formats" Link PICFOR} @{"Solutions for possible problems" Link PROBLEME} @{"Installation" Link INSTALL} @{"Usage for loading" Link LOADING} (incl. downscaled loading function) @{"Usage for animation creation" Link ANIM} (free @{"animation players" Link PLAY} available as well) @{"Usage with very old XiPaint versions" Link OLDXIP} (upto XiPaint 3.1) @{"System requirements" Link VORAUS} @{"Hard- and software used for development" Link HARDSOFT} @{"Shareware modalities" Link SHAREWARE} (Ordering informations for full version) @{"Special Thanks" Link DANK} @{"Version history" Link VERS} @EndNode @Node ILLEGAL "Illegal keyfiles" Warning: I know that illegal/modified keyfiles of this module exist. The use of such keyfiles ("hhsxipaintmodkey.library") is strictly prohibited and can lead to undefined results and problems! For a program which you use you should also be willing to pay the shareware fee. Only if enough users register I will be able to do further improvements or create other graphic applications. You can also help me by sending me illegal keyfiles of this module which you find somewhere. The future software development depends on the honesty of all users! I also want to point out that all keyfiles contain visible and invisble marks which allow identification of the original user even if the keyfile is modified. Keyfiles which are found to be the base of illegal modified/distributed keyfiles become invalid immedietly and (beside other consequences) any future use of such keyfiles is prohibted. (->@{"Disclaimer, Copyright, Usage and Distribution conditions" Link RECHTLICHES}) @EndNode @Node INSTALL "Installation" The module can be installed automatically with the included script: Simply start it and select the XiPaint main directory in the file requester. The needed files will then be installed. If you prefer manual installation: "hhsxipaintmod.xio" is the main module and should be copied to the XiPaint/Modules directory for XiPaint 3.2 and up. For older versions the module should be copied to the XiPaint main directory and the additional ARexx script "hhsxipaintloader.rx" should come into the XiPaint/Makro directory. For all versions the "makeanim.rx" script can be installed in the XiPaint/Makro or XiPaint main directory. @EndNode @Node OLDXIP "Old XiPaint versions" XiPaint versions upto 3.1 did not support external modules. The only way to access the XiPaintModule from such old versions is by ARexx. Two scripts are included; one for loading (select it from the Makro/Execute menu in XiPaint) and one for @{"automatic animation creation" Link ANIM}. Please upgrade to a newer version of XiPaint to get full comfort in using the module! The full version of XiPaint 3.2 can be found on Aminet CD #11 and on the cover disk of the german "AmigaPlus 6/96" magazine. @EndNode @Node LOADING "Usage for loading" XiPaint supports external modules since version 3.2. The module will be detected by XiPaint a) as loaders "HHsUniversalLoader", "Universal_50%_size" and "Universal_25%_size" b) as saver "HHsYUVSqAnimation" For loading you must select the module to use (at least upto XiPaint 4.0 there is no feature which tries all modules for loading). You can select the module in the Settings/Loaders list of loader modules. The Loader will be automatically used (if selected) for opening of new projects and for loading into existing projects. Downscaled loading: The loader module now supports direct downscaled loading in XiPaint 3.2 and higher; simply select the appropriate loader version in the list. Currently the loader should appear 3 times: HHsUniversalLoader for full size, Universal_50%_Size for half size and Universal_25%_Size for quarter size. For most file formats (e.g. IFF, DEEP, JPeg, PCX, PPM, Targa, ...) the downscaling is done on a line by line base, so that memory will only be needed for the reduced size. This should enable you to get big pictures into XiPaint without memory problems. Please note that there is currently no progressive display during loading and no error messages are displayed. If loading fails, currently nothing will happen. @EndNode @Node ANIM "Usage for animation creation" 1) Automatic creation of HHsYUVSq TrueColor animations ------------------------------------------------------ With the script "makeanim.rx" you can automatically convert a directory of pictures into an HHsYUVSq animation file. Just start the script from XiPaint as macro or from Workbench or Shell. If you start it from XiPaint, you will probably have to switch to WB screen manually; there you get a requester asking for the source directory which should contain the pictures (all of the same size). Then you are asked for the destination animation file. Then the automatic conversion is started. Pictures are downscaled if necessary. You can watch the pictures beeing loaded in XiPaint. They are loaded in alphabetical order (users of old XiPaint versions prior to V3.2 should NOT play with XiPaint during this process as this can block the whole system). With newer versions it should be save to use XiPaint for other things during the process except loading as this might interact with the frame loading! If the conversion has finished, the last picture will remain in XiPaint as a project. You can close this manually. You can play the animations with my freeware player programs @{"CyberTVPlayer" Link PLAY} and @{"EGSTVPlayer" Link PLAY}. Please note: The loading/saving is done with HHsXiPaintMod.xio only; so you can only load pictures in one of the @{"supported formats" Link PICFOR}. If you want to make animations from pictures in other formats, you have to load and save them with the appropriate modules manually. But anyway, the module now seems to support nearly all formats... 2) Manual animation creation ---------------------------- XiPaint supports external modules since version 3.2. The module will be detected by XiPaint a) as loaders "HHsUniversalLoader", "Universal_50%_size" and "Universal_25%_size" b) as saver "HHsYUVSqAnimation" For animation creation you can select the "HHsYUVSqAnimation" saver in the Settings/Savers list of saver modules. To create a new animation, select a new filename for saving with this format; to append a frame to an existing animation, select the existing animation file for saving. XiPaint will warn you that the file is overwritten, but the module will only append the frame and not delete the old file. Please note: Image width must be in the range 80 to 360 (even size will be generated); Image height must be in the range 64 to 310. To append frames to an animation, the image size in XiPaint must match the frame size of the file you want to append to. Otherwise (or if you specify not a HHsYUVSq anim file) an error will occur. If something fails e.g. because the image size is unsuitable or the file is wrong, error requesters will appear. @EndNode @Node PLAY "Animation players for the HHsYUVSq animation format" You can play the TrueColor animations (HHsYUVSq format) with the following free player programs: 1) CyberTVPlayer Usable on all Amigas with at least OS3.0. Displays in TrueColor or HighColor on graphic boards with CyberGraphX or in reduced color (slow) on AGA Amigas. 2) EGSTVPlayer Usable on Amigas with EGS software installed; displays in TrueColor under the EGS environment on EGS compatible graphic boards. Both should be available on Aminet in gfx/board. If you order the module you will also receive the latest version of CyberTVPlayer or EGSTVPlayer. @EndNode @Node PICFOR "Information about the supported picture file formats" HHsXiPaintModule can currently read the following formats directly: 1) IFF-ILBM (all standard formats 1 to 8Bit, EHB, HAM6, HAM8, 15Bit, 24Bit) 2) PhotoCD (Base format 768x512 or 512x768 (portrait); linear 24Bit RGB) 3) JPeg (color and greyscale; incl. progressive JPeg) 4) PPM/PGM/PBM (P1&P4 b&w, P5 grey, P6 color) 5) QRT (also known as dump format by PD raytracers as POV-Ray) 6) Targa (RLE compr.&uncompr. 1/8/15/16/24/32Bit; incl. interleaved) 7) PCX (compr.&uncompr. EGA1-4Bit, VGA 8Bit grey/Colormap and 24Bit) 8) BMP (uncompr. 24Bit RGB,1Bit,4Bit or 8Bit Colormap; RLE compressed 8Bit,1Bit) 9) TIF (packbit-compr.&uncompr. 24Bit,1-8Bit grey/Color Motorola&Intel formats) 10) DEEP (compr.&uncompr. IFF-DEEP 24Bit and 32Bit formats) 11) YUV (color 1:1:1, 2:1:1, 4:1:1 and greyscale) 12) VLAB raw (color 1:1:1, 2:1:1, 4:1:1 and greyscale) 13) RGB (IFF-RGB: RGB8 and RGBN compressed; RGB5 uncompressed) 14) HHsYUVSq sequence format (sequential or random access) 15) IFF-PBM (DPII) format 16) ACBM (IFF-ACBM: 1 to 8Bit, EHB, HAM6, HAM8) 17) FBM (8Bit grey/Colormap and 24Bit) 18) Sun raster (uncompressed formats for 1Bit, 8Bit grey/ColorMap and 24Bit) 19) MacPaint (b&w compressed 1Bit format; datafork only) 20) HHsXRL formats (1-8Bit ColorMap incl. HAM6/8, 8Bit grey, 24Bit RGB compressed) 21) binary-EPS bitmaps (RGB and CMYK; this function is experimental) 22) TBCPlus frames & fields 23) EGS 7.x window iconification icons In addition picture and animation DataTypes are supported as well (for animation DataTypes at least OS3.1 is needed). For animation formats (HHsYUVSq and animation datatypes) always the first frame is loaded. If you have any problems with loading pictures with DataTypes or one of the above listet formats from CD-ROMs or other media you should read the @{"Solutions for possible problems" Link PROBLEME}. Supported picture file formats for saving: 1) HHsYUVSq TrueColor animation format (->@{"free animation players" Link PLAY}) @EndNode @Node PROBLEME "Solutions for possible problems" Problems with loading certain picture formats? ---------------------------------------------- If you have problems reading pictures in one of the support formats (esp. from CD-ROMs with DataTypes or PCX-VGA) and are sure, that you have enough memory free, please check the following: a) File systems: Some PD/ShareWare/Commercial add-on or replacement file systems (esp. CD-ROM file systems!) are buggy (e.g. they do not support some rarely used DOS functions properly). Try to copy the picture to a standard device (e.g. RAM:) and to view it from there. If this works, you know that your specific file system is buggy. For CD-ROMs I recommend to try one of the following file systems from which I have testet 1) and 2) myself: 1) Original AmigaDOS OS3.1 CD-ROM file system 2) AmiCD-File System V1.15 or higher 3) BabelCDROM FileSystem V1.2 or higher Several users reported problems with "AsimCD-Filesystem 3.0"; so this seems to be an unsuitable Filesystem (maybe the newer 3.4 version supports all necessary functions). Typical unimplemented or wrong functions in filesystems are: NameFromFH (needed for Datatype access) and ExamineFH (needed for several formats, e.g. PCX-VGA). b) DataTypes: Some DataTypes are instable and can crash on certain pictures with odd dimensions or incomplete pictures. I have no influence on this. If you have difficulties with certain DataTypes, look out for newer versions or contact the author of the DataType. @EndNode @Node VORAUS "System requirements" XiPaintModule should be usable on all Amigas and Dracos with + OS2.0 or higher + XiPaint (version 3.2 or higher recommended) + sufficient memory (always needed for 24Bit graphics) @EndNode @Node HARDSOFT "Hard- and software used for development" This program is written in pure Assembler (using the german assembler O.M.A.). Only the lowlevel JPeg functions have been implemented in C (based on the portable C source of the Independent JPeg Group: This software is based in part on the work of the independent JPeg Group) and compiled with the german MaxonC++ system. My development system is: Amiga 3000/030/25MHz/18MBRAM/OS3.1 Piccolo SD64(4MB) with CyberGraphX and EGS The module has been testet with XiPaint 3.1, 3.2, 4.0. @EndNode @Node SHAREWARE "Shareware modalities" XiPaintModule is Shareware. This means that you have to register with me, the author, and pay a shareware fee if you want to use it for more than 4 weeks. The unregistered version does also only load and save in greyscale. After registration you receive a keyfile together with the latest full version. The keyfile disables all restrictions. The keyfile concept allows you to use later demo version (which can e.g. appear on Aminet) as full versions. The cheapest way to order the module is to order it together with one of my applications @{"PhotoAlbum" Link PHOTOALBUM} (the new intuitive and fast picture management software for all Amigas with at least OS3.0; incl. TrueColor support for CyberGraphX) or @{"CyberShow" Link CYBERSHOW} (the fast slideshow presentation and viewer program for all Amigas with at least OS3.0; incl. TrueColor support for CyberGraphX). The add-on price for the module is then only 10DM or 7US$. Please make use of this special offer if possible! If you just want to order the module, the following prices are valid: XiPaintModule for new users: 20DM or 18US$ XiPaintModule for registered users of one of my other modules or programs like PhotoAlbum, CyberShow: 15DM or 14US$ (see @{"registration form" Link registration.txt/main} for other accepted currencies) (Special note for users in germany only: Wenn Sie schon registrierter Benutzer eines meiner Shareware-Programme sind und sich Ihre Anschrift nicht geändert hat, können Sie die Module direkt per Überweisung bestellen. Als Verwendungszweck geben Sie bitte "XiPaintMod für ...." an, wobei Sie das Programm was Sie schon haben und die Registriernummer angeben. Zusätzlich möglichst auch noch Name/Anschrift; die Bankverbindung: Konto-Nr. 5740147 BLZ 310 500 00 Stadtspark. Mönchengladbach) (No bank transfers from outside germany!) To register you must send in the filled in and signed @{"registration form" Link registration.txt/main} (included in demo version) and send it to my address together with the shareware fee as cheque, banknotes or pay by (international!) postal order / postel money order My adresse: Helmut Hoffmann Rubensstraße 4 D-41063 Mönchengladbach Deutschland After registration you receive your keyfile and the latest version of the program. The keyfile allows usage of later demo versions as full version. Please allow some time for handling/delivery. Usually this will be done very quickly (only few days), but under raw circumstanes it can take upto some weeks. By the way: Similair modules are available for ImageFX (FastIFXModules) and Photogenics (UniversalGIO) as well. @EndNode @Node CYBERSHOW "CyberShow: flexible slideshow and viewer program" CyberShow Professional is my universal image viewer featuring SlideShow presentation (incl. transition effects) and much more. It offers a great range of parameters and configurability to be used in every kind of image viewing task. The loading functions are nearly identical to thoose in the module. The system requirements are also similar: CyberShow can be used on all Amigas (and Dracos) with at least OS3.0. The maximum picture viewing quality can be reached in conjunction with graphic boards used under CyberGraphX. Demo version e.g. available on Aminet: "gfx/board/cybershow##.lha" @EndNode @Node PHOTOALBUM "PhotoAlbum: Picture management for all Amigas and Dracos with at least OS3.0" New: ->->-> PhotoAlbum <-<-<- +-------------------------------------------------------------------------------+ | The fast and intuitive picture management software for all Amigas with OS3.x: | | * Supports upto 256 colors on AGA Amigas | | * Supports TrueColor/HighColor on graphic boards with CyberGraphX | | (TrueColor displaying supported for thumbnails and full picture windows) | | * Supports more than 20 picture formats (incl. PhotoCD, IFF, JPeg (incl. | | Progressive), TIF, PCX, BMP, Targa, PPM, YUV, ... and DataTypes) | | * Open any number of picture windows incl. fast scrolling and zooming | | functions, conversion functions, direct transfer functions, ... | | * Font sensitive picture subtitles and gadget bar (fonts configurable) | | * Many options can be configured (by Tooltypes or in menues) | | * Support of several preview file formats (highly compressed to save space | | or uncompressed for high speed access etc.) | | * Functions for creation of picture databases across multiple volumes | | * Configurable thumbnail cache memory * Editable picture comments | | * new: now finer JPeg scaling (optional) to better fit pictures in frames | +-------------------------------------------------------------------------------+ Demo version e.g. available on Aminet: "gfx/misc/photoalbum##.lha" The loading functions are nearly identical to thoose in the module. The system requirements are also similar: PhotoAlbum can be used on all Amigas (and Dracos) with at least OS3.0. The maximum picture viewing quality can be reached in conjunction with graphic boards used under CyberGraphX. @EndNode @Node DANK "Special Thanks" I want to thank * Thomas Dorn and Ossowskis Schatztruhe for providing me with XiPaint * The "Independent JPeg Group" (JPeg source code) and the registered XiPaint module users from all over the world (currently located in 12 countries). @EndNode @Node RECHTLICHES "Disclaimer, Copyright, Usage and Distribution conditions" Disclaimer ========== This software (program and documentation) is provided "as is" and comes with no warranty, either expressed or implied. The author is in no way responsible for any damage or loss that may occur due to direct or indirect usage of this software. You use this software entirely at your own risk. Copyright ========= This software (program and documentation) is copyright by Helmut Hoffmann Rubensstrasse 4 D-41063 Mönchengladbach Germany This person is called "the author" in the following conditions. Usage and Distribution conditions ================================= For use and distribution of this software you must comply with the following conditions: 1) Everybody who uses or distributes this software automatically accepts the Disclaimer, Copyright and Usage/Distribution conditions. Every violation of the conditions excludes the user from future use or distribution of this product and any other products of the author. Persons who have violated the conditions in other programs of the author are also excluded from use or distribution of this product. 2) Everybody who uses this software for more than 4 weeks must register with the author and pay the stated shareware fee. He then receives a personal keyfile which will also remove the restrictions contained in the demo version. 3) Official demo versions may be distributed as long as the following points are met: * All files of the package must be kept together * No file may be modified or crunched in executable form * The only official method for packed distribution is the original .lha archive * Distributors may only charge for the duplication process (including media) and not for the software. Theese charges may not exceed the following limits: a) Demo on a PD-disk: 8US$ or 12DM including postage&packing b) Demo on a PD-CD-ROM: 50US$ or 75DM including postage&packing c) Demo on a BBS/Mailbox/ftp-site or other electronically callable system: Maximum charge 4US$ or 6DM for downloading Anyway, it must be made explictly clear to the buyer, that he does not pay for the program (demo) itself but only for the duplication service. * The demo may also be included with commercial products which are more expensive, as long as the conditions are met and it is made absolutely clear to the buyer of the commercial product, that he does not pay for the use of this software and must pay the shareware fee to be allowed to use it. The demo version may e.g. be part of distributions of the following products: Amiga computers, Draco computers, graphic boards with CyberGraphX- support, painting and image processing programs 4) The creation, distribution and modification of keyfiles (in this case: hhsxipaintmodkey.library) is not allowed (except for the author). Users of the keyfiles may only make a copy for back-up purposes. For each registration the program may only run on one machine at the same time. The creation of a back-up disk of the original disk is allowed. All keyfiles contain visible and invisible marks which allow trace back to the original user even if keyfiles are modified. The illegal use of faked or modified keyfiles or keyfiles which have been the base of modified keyfiles can lead to undefined results. Registered users must take care that their keyfiles can not be accessed by any other person. 5) Disassembling or analysation of this software (incl. the keyfiles) is prohibited. The integrated usage restrictions in the demo versions may under no circumstance be bypassed or removed. @EndNode @Node VERS "Version history" Version history --------------- V0.1 (7th aug. 95): Prerelease for loading functions V0.2 (20th aug. 95): Prerelease for loading by ARexx script: added Request option and screen switching functions V1.0 (15th sep. 95): First official release for use by Arexx script (usable with XiPaint 3.x) V2.0 (21st sep. 95): First release with direct loader module support for XiPaint 3.2 (just copy the .xio file into the XiPaint/Modules directory and configure it as loader) V2.1 (9th oct. 95): Extended TIF loader to support "Intel" byte order files and more variants V3.0 (11th dec. 95): TrueColor animation saving: extended module to support saving in HHsYUVSq animation format; included ARexx script to automatically create such animations from multiple pictures Extended IFF loader to accept 0-sized chunks Loader can now load bigger pictures into smaller projects Integrated downscaling support (only usable by scripts) V4.0 (9th feb. 96): Support for downscaled loading (50% size, 25% size) by additional entries in the XiPaint 3.2 loader list Added JPeg loading support (see special notes for JPeg!) Included script for automatic installation of modules Bug fixes in makeanim.rx script: now should also work if other project windows exist during anim creation Extended IFF loader to accept unusual sized color maps V4.1 (24th march 96): Changed PCX loading for more compatibility V4.2/3 (29th april 96): Extended PCX loading for even more compatibility V5.0 (30th may 96): Support for progressive JPeg loading Documentation converted to AmigaGuide format V5.1 (13th aug. 96): Extended loading functions for new variants of IFF-DEEP (e.g. as created by TVPaint 3) V5.2 (23rd oct. 96): Extended loading functions for IFF-ILBM 15Bit format New: Registered module users can order my new @{"PhotoAlbum" Link PHOTOALBUM} (usable on all OS3.x Amigas) or the package of @{"PhotoAlbum" Link PHOTOALBUM}&@{"CyberShow" Link CYBERSHOW} for special side-grade prices; see the PhotoAlbum documentation for details! The new PhotoAlbum software can e.g. be found on Aminet in gfx/misc. @EndNode