home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 9 / amigaformatcd09.iso / readerstuff / femi_hasani / extras / xfa_utility / xfa_util.doc < prev    next >
Encoding:
Text File  |  1994-11-11  |  6.1 KB  |  165 lines
  1.  
  2. *******************************************************************************
  3. *                                                                             *
  4. *           eXtra.Fast.Animation.  Converter/Player © ClassX 1994             *
  5. *                                                                             *
  6. *******************************************************************************
  7.  
  8. ** Introduction:
  9.  
  10. XFA_Util has been developed to give users the ability to play and 
  11. convert XFA animations.
  12. It is freely distributable only for NON COMMERCIAL purposes.
  13. It is subject to the law that rules the distribution of the "SHAREWARE"
  14. software. 
  15.  
  16. Tecnhical characteristics:
  17. XFA_Utils allows to:
  18. -Load XFA animations
  19. -Play XFA animations from Disk
  20. -Play XFA animations from memory
  21. -Convert XFA animations into separate IFF images
  22. -Play XFA animations via AREXX
  23.  
  24. Next Release:
  25. -Localization
  26. -IFF -> XFA conversion
  27. -Anim7, Anim5 ->  XFA conversion
  28. -Better XFA DiskPlay
  29.  
  30. *******************************************************************************
  31.  
  32. ** Fields "Src" "Dst" "Start" "End" "Format" **
  33.  
  34. XFA_Util's interface is simple and intuitive.
  35. Starting from the top there is the "Src" button, followed by a string field.
  36. Clicking this button, we can select a source file, which complete path will
  37. be displayed in the field.
  38. So, with "SRC" can be specied the source filename, which indicates the file
  39. that will be involved in operations like "Load XFA", "IFF-XFA" (and all those 
  40. operations that will need a source file to work with).
  41. Similarly, with "Dst" we can select the path of the file to save, or the
  42. base name of the IFF sequence to save.
  43. Under the "Src" field, there are three numerical fields, named "Start", "End",
  44. "Format".
  45. While "Start" and "End" are currently disabled, "Format" is used to store
  46. the format of the numerical extention to be appended to the filenames of
  47. the single IFF frames generated by XFA_Util (button "XFA->IFF").
  48. If, for example "Format" is set to "000", the saved IFF frames will have
  49. a three digit numerical extension.
  50.  
  51. ** The Buttons **
  52.  
  53. - Load XFA
  54. This button starts the loading process of the "Src" XFA animation.
  55. If there is already an animation in memory, it will be substituted with
  56. the new. 
  57.  
  58. - Play Mem
  59. This button causes the execution of the XFA animation previously loaded into
  60. memory.
  61. The execution of the animation is ruled by "Loop" and "AutoPause" checkboxes.
  62. After clicking this button, the play screen will appear and the program
  63. will wait for a left mouse button click to start.
  64. If Loop is enabled, the animation will cycle from the first frame to the last,
  65. until the user clicks the right mouse button.
  66. Keeping pressed the left mouse button freezes the animation.
  67. If AutoPause is enabled, the player will stop and wait for the left mouse
  68. button click everytime it reaches a frame sequence without moving objects
  69. (delta = 0).
  70. This mode is very useful, infact animations can pause for indefinite
  71. time and can be syncronized with external events through the mouse.
  72. To stop animations and return to XFA_Util it is necessary to click left and
  73. right mouse buttons together.
  74. For more information about Play modes, please refer to X-DVE user's manual.
  75.  
  76. - Play Disk
  77. Clicking this button, XFA_Util will attempt to play the "Src" XFA animation
  78. from disk.
  79. Currently, disk play routines does not support AutoPause or Loop settings
  80. (this is planned for the next release).
  81. As everyone knows, disk-based animation is much more slow than the one
  82. played from memory, but it has the great advantage to not use lots of RAM.
  83. The speed of a disk animation depends almost exclusively on how fast is
  84. the support from which it is played.
  85. For XFA animations compressed with 32BitI and 16BitI modes, disk play
  86. can cause some flickering.
  87. This problem cannot be avoided, because such animations need to be played
  88. at the maximum speed, under the constant, uninterrupted control of the
  89. CPU.
  90. However, animations compressed with 32Bit and 16Bit modes, will be played
  91. in a perfectly stable way.
  92. Note: Playing an XFA from disk requires that the currently loaded animation
  93. must be freed from memory.
  94.  
  95. - Free
  96. Clicking this button causes the currently loaded animation to be freed 
  97. from memory.
  98.  
  99. - I
  100. With this button, users can obtain information about the current XFA animation
  101. in memory.
  102.  
  103. - XFA->IFF
  104. With this button, the "Src" animation will be converted into separated IFF
  105. images.
  106. The base name and the destination path of the single IFF must be specified
  107. with the "Dst" field.
  108. Example:
  109. Suppose to convert the "DH1:XFA/INTRO.xfa" animation to a IFF sequence
  110. on a disk.
  111. All the thing to do are:
  112. -Click "Src" and select the source XFA in "DH1:XFA/" through the usual 
  113. file-requester.
  114. -Click "Dst" and select the destination device (ex: "DF0:")
  115. -Complete the "Dst" field with the base name of the IFF frames (ex: "FRAME")
  116. (the "Dst" field must show "DF0:FRAME")
  117. -Start the conversion clicking "XFA->IFF" button.
  118. -To stop the conversion simply click "STOP" or press the ESC key.
  119.  
  120. This will cause the generation of a sequence of frames in DF0 called
  121. FRAME00000,FRAME00001,FRAME00002,......
  122.  
  123.  
  124. ** AREXX Interface
  125.  
  126. XFA_Util has a simple AREXX interface, just to play XFA animations from
  127. external programs like Scala, MediaPoint, AmigaVision, CanDo, Helm, etc.
  128.  
  129. These are the XFA_Util AREXX commands:
  130.  
  131. SOURCE    <s>      ;Set the "Src" field of XFA_Util with the string <s>
  132. LOOP      <ON|OFF> ;Set/reset the loop play mode for XFA animations
  133. AUTOPAUSE <ON|OFF> ;Set/reset the autopause mode for XFA animations
  134. LOAD               ;Load the "Src" animation into memory
  135. FREE               ;Free last loaded animation from memory
  136. PLAYMEM            ;Play the animation already in memory
  137. PLAYDISK           ;Play the "Src" animation from disk (memory will be freed)
  138.  
  139. all these commands must be in CAPITALS
  140.  
  141. /* sample AREXX script to play an XFA from memory */
  142.  
  143.     options results
  144.     address 'XFA_Util'
  145.  
  146.     SOURCE "DK3:XFA/ClassX.XFA"
  147.    LOAD
  148.     AUTOPAUSE OFF
  149.     LOOP OFF
  150.     PLAYMEM
  151.     FREE
  152.    exit
  153.  
  154. /* end script */
  155.  
  156.  
  157. *******************************************************************************
  158.  
  159. ClassX Development
  160. Via Francesca 463
  161. I - 56030 Montecalvoli (PI)
  162. Tel+Fax +39 587 749206
  163.  
  164. *******************************************************************************
  165.