home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 1: Collection A / 17Bit_Collection_A.iso / files / 72.dms / 72.adf / QuickFlix-DOC < prev    next >
Text File  |  2008-06-02  |  14KB  |  303 lines
  1.  
  2.                            QuickFlix Rev 0.13
  3.  
  4.     Copyright (c) 1987  Jeff Kunzelman, Rodney Iwashina, Takeshi Suganuma
  5.  
  6.   If you like this program please feel free to send a donation ($10.00)
  7.   payable to:
  8.           Rodney Iwashina  11333 Yolanda Ave.  Northridge, Ca. 91326
  9.  
  10.   You can make as many copies of this program as you like and give it to
  11.   all your friends, on the condition that you abide by these guidelines:
  12.  
  13.      The copy(s) (including documentation) must remain unmodified
  14.      and intact.
  15.      The copy(s) cannot be sold for money or profit, except by the
  16.      original authors.
  17.      At the time of transfer, the new recipient(s) agree(s) to the above
  18.      guidelines.
  19.  
  20.   Suggestions and comments of any kind can be sent to the above address,
  21.   through CIS (76224,102) or Bix (riwashina).  We hope you enjoy this!
  22.  
  23.  
  24. Introduction:
  25.  
  26.         QuickFlix is an IFF slideshow and cel animation program.
  27.         It takes full advantage of the Amiga's multi-tasking operating
  28.         system by creating multiple tasks to manage each of its
  29.         resources, communicating via executive messages and ports,
  30.         and sharing data in a common memory pool.  QuickFlix supports
  31.         the LO-RES, HI-RES, NON-INTERLACE, INTERLACE, HAM and OVERSCAN
  32.         modes of the Amiga.  QuickFlix can be run with internal timing
  33.         or can be triggered by an external source.  A stand-alone
  34.         slideshow or animation sequence can be generated when
  35.         QuickFlix is run with internal timing.  External triggering allows a
  36.         user to interactively control the slideshow or animation.
  37.         QuickFlix implements a caching system that pre-loads pictures
  38.         into memory.  This feature allows QuickFlix to support the
  39.         rapid frame rate necessary for cel animation.
  40.  
  41.  
  42. CLI Usage:
  43.  
  44.         QuickFlix [-t<tick rate>] [-l<log file>] <script file> ...
  45.  
  46.         <script file> is the name of the script file containing the
  47.                 names of the pictures, the special effects information,
  48.                 and the timing information.  All timing information is
  49.                 expressed in number of ticks.  Multiple script files
  50.                 may be chained together by specifying them on the
  51.                 command line.
  52.  
  53.         -t<tick rate> indicates the timer tick rate, where <tick rate>
  54.                 is a decimal integer from 0 to 60, corresponding to tick
  55.                 rates of 0 to 60 ticks per second.  When the tick rate is
  56.                 set to 0, the external triggering is enabled.  This
  57.                 option defaults to 30 tick per second.
  58.  
  59.         -l<log file> designates the file to log informational and error
  60.                 messages.  If this option is not specified, no log file
  61.                 will be created.
  62.  
  63.         QuickFlix can be exited at any time by pressing the ESC key or
  64.                 <CTRL> C; holding the CTRL key down and pressing the C key.
  65.  
  66.         usage example:
  67.  
  68.                 QuickFlix -t24 -lram:logfile script
  69.  
  70.                 This example will read the script information from the
  71.                 file "script", the tick rate will be 24 ticks per
  72.                 second, and the log information will be written to the
  73.                 file "logfile" in ramdisk.
  74.  
  75.  
  76. Workbench Usage:
  77.  
  78.         QuickFlix can also be invoked from the Workbench.  A single
  79.         script can be invoked by double-clicking on the desired script
  80.         file icon.  A single script file can also be invoked by
  81.         shift-clicking (holding the SHIFT key down and clicking on the
  82.         the icon) the desired script file icon, then double-clicking
  83.         on the QuickFlix icon.  Multiple scripts can be invoked by
  84.         shift-clicking all desired script file icons, then double-clicking
  85.         on the QuickFlix icon.  When multiple scripts are selected, the
  86.         'tool types' information from the first shift-selected script
  87.         will be used for all subsequent scripts.
  88.  
  89.         Valid Tool Types:
  90.  
  91.              n=<anything> (no seperate fast memory cache)
  92.              l=<log file name>
  93.              t=<ticks per second> (t=0 = use joystick)
  94.  
  95.              All others will be ignored.
  96.  
  97.  
  98. Script Format:
  99.  
  100.         Entries in the script file must conform to the following format:
  101.  
  102.         s <picture file> - any IFF picture file
  103.                 (s is the mnemonic for (s)lide)
  104.  
  105.         n <ticks> - Switch to next picture in script in <ticks> ticks
  106.                 where <ticks> is a positive decimal integer.  If
  107.                 the last picture in the script includes this entry,
  108.                 QuickFlix will exit when the switch occurs, otherwise
  109.                 the last picture will remain on the screen until QuickFlix
  110.                 is manually exited via an ESC or <CTRL> C.
  111.                 (n is the mnemonic for (n)ext)
  112.  
  113.         i <start ticks> <end ticks> <interval ticks> <red> <green> <blue> -
  114.                 Fade in the current picture starting at <start ticks> ticks
  115.                 after the picture is switched in, end fade at <end ticks>
  116.                 ticks after the picture is switched in, fade at intervals
  117.                 of <interval ticks> ticks, and fade in from color <red>,
  118.                 <green>, <blue> where all tick values are positive decimal
  119.                 integers and all colors are hexidecimal values from 0 to f.
  120.                 (i is the mnemonic for fade (i)n)
  121.  
  122.         o <start ticks> <end ticks> <interval ticks> <red> <green> <blue> -
  123.                 Fade out the current picture starting at <start ticks> ticks
  124.                 after the picture is switched in, end fade at <end ticks>
  125.                 ticks after the picture is switched in, fade at intervals
  126.                 of <interval ticks> ticks, and fade out to color <red>,
  127.                 <green>, <blue> where all tick values are positive decimal
  128.                 integers and all colors are hexidecimal values from 0 to f.
  129.                 (o is the mnemonic for fade (o)ut)
  130.  
  131.         c <start ticks> <end ticks> <delay factor> - Cycle color ranges
  132.                 starting at <start ticks> ticks after the picture is
  133.                 switched in, end cycling at <end ticks> ticks after the
  134.                 picture is swithced in, with a delay factor of
  135.                 <delay factor> applied to the color cycle rate where
  136.                 all values are positive decimal integers.  The color
  137.                 cycle ranges and rates are read from the IFF file.
  138.                 (c is the mnemonic for (c)ycle)
  139.  
  140.         script example:
  141.  
  142.                 s picture1
  143.                 n 40
  144.                 i 0 0 1 0 0 0
  145.                 o 20 0 1 f f f
  146.                 s picture2
  147.                 n 60
  148.                 i 0 0 2 f f f
  149.                 o 30 0 2 0 0 0
  150.                 s picture3
  151.                 n 80
  152.                 i 0 0 1 0 0 f
  153.                 o 60 0 1 0 0 f
  154.                 c 0 0 1
  155.  
  156.                 This example will show three pictures.  The first picture
  157.                 is "picture1".  It will be shown for 40 ticks, fade in from
  158.                 black when it is switched in, and fade out to white 20
  159.                 ticks from the time it is switched in.  The second picture
  160.                 is "picture2".  I will be shwon for 60 ticks, fade in from
  161.                 white when it is switched in, and fade out to black 30
  162.                 ticks from the time it is switched in.  The third picture
  163.                 is "picture3".  It will be shown for 80 ticks, fade in
  164.                 from blue when the picture is switched in, fade out to blue
  165.                 60 ticks from the time it is switched in, and will color
  166.                 cycle the cycle ranges with a delay factor of 1.  QuickFlix
  167.                 will exit after showing this picture since it is the last
  168.                 one in the script and it specifies a switch.
  169.  
  170.  
  171. Cell Animation:
  172.  
  173.         Given the architecture of the system, cel animation becomes
  174.         a simple exercise of script manipulation.  The pictures that
  175.         make up the animation can be entered to be shown for a short
  176.         nubmer of ticks, and the tick rate can be adjusted to a reasonable
  177.         rate for animation.  The cache allows rapid switching of pictures
  178.         as long as the pictures are in the cache, otherwise the pictures
  179.         have to be read from the disk.  The cache will hold about 5
  180.         320x200x5 (typical DeluxePaint) pictures on a 512K Amiga, about
  181.         40 on a 2.5M Amiga.  These numbers will vary depending on the
  182.         resolution, interlace, and number of bit planes, because the cache
  183.         is memory dependent.  The more memory, the better, but if the
  184.         display rate exceeds the cache fill rate, the cache will
  185.         eventually get behind, causing a pause in the animation.  There
  186.         are a number of things you can do to optimize animations.
  187.         Additional memory will result in a larger cache and therefore
  188.         a higher cache hit rate.  A hard disk will increase the transfer
  189.         rate of pictures from disk to cache.  Pictures with fewer bit
  190.         planes will decrease the amount of memory needed for each picture.
  191.         Repeating short sequences of pictures in the script will allow
  192.         a higher cache hit rate.  Color cycling can be used to simulate
  193.         animation.
  194.  
  195.  
  196. External Triggering:
  197.  
  198.         External triggering allows a user to interactively control the
  199.         slideshow or animation.
  200.  
  201.         A joystick connected to port 2 of the Amiga can be used for
  202.         interactive control.  The joystick can increase or decrease
  203.         the tick rate by pushing the joystick up or pulling it back.
  204.         Pressing the joystick button at any time will enable the
  205.         single-step mode.  In this mode, each button press will cause
  206.         a timer tick to occur.  Continuous timer tick mode is re-enabled
  207.         by moving the joystick up or down.  Moving the joystick to the
  208.         right will switch to the next picture in the script.
  209.  
  210.  
  211. Known Problems:
  212.  
  213.         The picture switching rate does not keep up with the tick rate
  214.         at tick rates exceeding about 24 frames per second.
  215.  
  216.         Fades and color cycling effects do not work on HAM pictures.
  217.  
  218.  
  219. Future Enhancements:
  220.  
  221.         We are continuously trying to improve our product.  Suggestions
  222.         and comments are more than welcome.  We would like to know what
  223.         type of application you are using QuickFlix for and any
  224.         enhancements that you would like to see incorporated into it.
  225.         Our current list of enhancements follow.
  226.  
  227.                 Repeat and reverse for script.
  228.                 External device synchronization.
  229.                 Additional special effects.
  230.                 IFF ANIM support.
  231.  
  232.                 We are currently testing a version which works
  233.                 real-time with MIDI!!
  234.  
  235. Notes:
  236.  
  237.    What is the logfile for?
  238.  
  239.        The logfile output option is extremly handy to determine
  240.        problems.  QuickFlix is very quiet about runtime problems.
  241.        This allows QuickFlix to be used in 'live' situations where
  242.        a silently skipped frame is preferable to the audience seeing
  243.        requesters, flashes, and bells, because a file couldn't be found.
  244.  
  245.        The logfile option causes the creation of a logfile which
  246.        will contain a trace of the general operation of the QuickFlix
  247.        system.  Information will include cache statistics and errors.
  248.        The errors will indicate various nasties such as bad IFF files,
  249.        missing files, memory resource problems, etc.  A good place
  250.        to put the logfile is in the ram disk (i.e. -l ram:logfile).
  251.        The log file will not be created with an icon so it must be
  252.        accessed from the CLI.
  253.  
  254.    More info on effects:
  255.  
  256.        In color cycle effects an end time of 0 indicates: cycle
  257.        until next slide.  In fade effects an end time of 0 indicates:
  258.        fade until you reach the target color.
  259.  
  260.        Color cycling can be used to slow sequences down while still
  261.        giving the screen an 'animated' look.  This will allow the
  262.        caches to refill allowing long uninterrupted sequences in
  263.        a small amount of memory.  Also remember that QuickFlix
  264.        implements real caches.  This means reusing pictures in sequences
  265.        will improve the chances that the specified picture is already
  266.        loaded in the cache and will not be reloaded off the disk.
  267.  
  268.        QuickFlix allows multiple effects to be active at once.
  269.        You can fade and color cycle simultaneously!
  270.  
  271.    A note about Caches:
  272.  
  273.        Since QuickFlix does its own caching it is recommended that
  274.        you do not use Facc, AddBuffers or a ramdisk.  QuickFlix
  275.        will allocate as much memory possible to cache the specified
  276.        pictures.  Since QuickFlix knows the order in which the
  277.        pictures will be displayed it can more effectively cache the
  278.        picture data than either Facc or AddBuffers.
  279.  
  280.    When run from the WorkBench:
  281.  
  282.        When QuickFlix is run from the WorkBench it will change its
  283.        working directory into the directory which contains the
  284.        currently being processed script.  This allows scripts
  285.        to contain 'relative' picture filenames if the IFF files
  286.        reside in the directory with the script.
  287.  
  288.    Bug fixes:
  289.  
  290.        Since Ver 0.12:
  291.            Color cycling no longer goes into 'turbo' mode when
  292.            color cycling is present on the last slide.
  293.  
  294.            The caches are correctly managed even if available FAST memory
  295.            contigious space is less than available CHIP memory contigious
  296.            space.  (This caused Ver 0.12 to NOT use FAST memory as
  297.            cache space in many cases)
  298.  
  299.    Really!
  300.  
  301.        We are looking for comments about this program, so
  302.        drop us a note and tell us what you think.
  303.