home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / pd / graphics / viewers / agmsfilm / agmsplayfilm.doc < prev    next >
Text File  |  1993-01-05  |  5KB  |  129 lines

  1. AGMSPlayFilm plays film files created by AGMSMakeFilm.  It uses a custom
  2. screen and two sound channels while playing the film.  It multitasks - you
  3. can move the screen with the animation while it is playing.  Controls let
  4. you view the film at various speeds, including backwards.
  5.  
  6. Because AGMSPlayFilm consumes data at an enormous rate, the display can get
  7. ahead of the data reading.  This results in a pause in the audio and video.
  8. If this happens, either get a faster hard drive, use a smaller picture size
  9. or slow down the play speed.  You can also play with the relative priorities
  10. of displaying images and reading files.  Changing buffer sizes can also
  11. help.
  12.  
  13. Here are the command line parameters:
  14.  
  15.  
  16. From/A
  17.  
  18. The name of the film file to play.  Required!
  19.  
  20.  
  21. Times/K
  22.  
  23. An optional number of times to see the cartoon.  A value of zero (the
  24. default) means play the cartoon forever.  Reaching the end of the cartoon
  25. and starting over counts as one time.
  26.  
  27.  
  28. Buffers/K
  29.  
  30. The number of frames to read ahead.  Each frame takes up the Chip RAM needed
  31. to hold the picture and sound.  If you ask for too many (run out of memory),
  32. the program will take as many as it can.  At least two are needed.
  33.  
  34. For significantly better performance, the buffers should come from the same
  35. block of Chip RAM (use the Verbose option to check on this).  A freshly
  36. booted computer running no other programs will give you the largest whole
  37. blocks of Chip RAM, so booting without a Startup-Sequence will give you the
  38. best performance, Chip RAM block wise.
  39.  
  40. Of course, having more buffers makes the cartoon playback smoother,
  41. particularly if other programs are accessing the disk at the same time.
  42.  
  43.  
  44. Verbose/S
  45.  
  46. Used for debugging.  Displays various status messages, including the amount
  47. of file reading it has to do.  Also lets you see how many different blocks
  48. of Chip RAM are used (ideally all buffers would come from only one block).
  49.  
  50.  
  51. AudioPri/K
  52.  
  53. The priority of the audio.  If a higher priority sound comes along,
  54. AGMSPlayFilm will shut down.  If a higher priority sound is already playing
  55. when you start AGMSPlayFilm then it will also shut down.  The default
  56. priority is 120.  You can use programs such as Experiment IV and
  57. AGMSPlaySound to generate music and sounds at various priorities.  Most
  58. other audio software uses priority 127.
  59.  
  60.  
  61. FlipTaskPri/K
  62.  
  63. A separate task is run to flip the screen between pictures.  If you give it
  64. a high priority (the default) then it will display every picture exactly
  65. when it should be displayed, but will consume valuable CPU time doing that.
  66. That CPU time could have been spent reading the film file.  If you use a
  67. lower priority (less than 5) then the Amiga tasks that run the hard disk
  68. will have more time to read the cartoon file, perhaps avoiding timing
  69. problems that greatly reduce disk accessing speeds.  At very low priorities
  70. (less than 0) the frame flipping is only done when nothing else has to be
  71. done (lower priority than checking the keyboard for user commands).  The
  72. trouble with low frame flipping priorities is that it will skip the
  73. occasional frame, leading to a jerky display.
  74.  
  75.  
  76. Control-C
  77.  
  78. Stops the program.  You can use the CLI command "Break" to stop it too.  The
  79. TIMES parameter also can stop the cartoon.
  80.  
  81.  
  82. Control-D
  83.  
  84. Toggles between TRIGGER mode and STRAIGHT mode.  AGMSPlayFilm starts up in
  85. STRAIGHT mode.  See Control-E and Control-F to find out what those modes do.
  86.  
  87.  
  88. Control-E, Control-F
  89.  
  90. Speed controls.  In STRAIGHT mode, each time you hit Control-F speeds up
  91. the film by one quarter of its true speed.  Similarly Control-E slows it
  92. down.  You can slow it down to a stop and even more to make it go backwards.
  93.  
  94. In TRIGGER mode Control-E rewinds the film to the beginning and stops it.
  95. While it is stopped, the buffers are pre-loaded with the first few frames of
  96. the film.  Control-F starts the film playing at normal speed.
  97.  
  98. The CLI "Break" command can send these signals if you use the appropriate
  99. parameters.  Useful for scripts and AmigaVision applications.  For example,
  100. if you want to have the film start at 11:00 PM (probably showing a film of a
  101. local fire :-), you could use this AmigaDOS 2.0 script:
  102.  
  103.   echo >t:TempScript "Wait 3" ; Wait for AGMSPlayFilm to load up.
  104.   echo >>t:TempScript "Break $Process D" ; Switch to TRIGGER mode.
  105.   echo >>t:TempScript "Break $Process E" ; Rewind and stop film.
  106.   echo >>t:TempScript "Wait Until 23:00" ; Wait until 11 PM.
  107.   echo >>t:TempScript "Break $Process F" ; Start the film playing.
  108.   run Execute t:TempScript
  109.   AGMSPlayFilm Fire.film Times 1
  110.  
  111.  
  112. Distribution
  113.  
  114. AGMSPlayFilm is FreeWare.  Copyright (c) 1993 by Alexander G. M. Smith.
  115. That means that you can use it freely, can't blame me for anything that goes
  116. wrong (there are probably a few bugs left), and you shouldn't expect more
  117. from it than you paid for it.  Also, don't blame me if your hard drive melts
  118. down under the stress of live animation playback :-).
  119.  
  120.  
  121. Bugs
  122.  
  123. The only one I know about is that Control-E in trigger mode doesn't always
  124. redisplay the first frame of the film when it rewinds it.  A second
  125. control-E should fix up the display.  Let me know if you find any other
  126. bugs.  My E-mail addresses are in the program credits (use "?" as the
  127. command line argument and then a second "?" at the prompt to see the
  128. credits).
  129.