home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / CDTV / cdtvtools-20 / videodisc / videodisc.doc < prev    next >
Encoding:
Text File  |  1992-03-03  |  6.1 KB  |  205 lines
  1.                             "videodisc"
  2.  
  3.         A means of controlling videodisc equipment via ARexx
  4.  
  5.  
  6.  
  7. Introduction
  8. ------------
  9.  
  10. The "videodisc" program was designed to let ARexx scripts (and applications
  11. capable of sending ARexx messages) control any of the video devices
  12. supported by the Amiga "player.device".
  13.  
  14. Player.device is an Amiga shared device that provides mid-level support for
  15. the play back of audio/visual materials from supported video disc players
  16. and video tape decks. It commonly distributed with the AmigaVision
  17. authoring system.
  18.  
  19. When run, "videodisc" opens an ARexx port, accepts straight-forward English
  20. commands, and translates them into the necessary "player.device" commands.
  21.  
  22. "Videodisc" does not reply to your script or application until after it has
  23. completed an operation.  For example, if told to play from frame 1 to frame
  24. 100, (using one command) your ARexx script won't continue until frame 100
  25. has been reached.  This prevents search latency from affecting the timing
  26. of a script or application.
  27.  
  28.  
  29.  
  30. Setup
  31. -----
  32.  
  33. "Player.device" should be in your DEVS: directory.  This file is the actual
  34. shared device that accepts commands and sends them to another smaller
  35. program that is specific to each player.  The file is included in the devs
  36. directory of the "videodisc" distribution disk. It's also in the devs
  37. directory of the AmigaVision Boot Disk.
  38.  
  39. The directory "players," and all the files in it, should be in your DEVS:
  40. directory.  These files are the individual programs that accept mid-level
  41. commands from "player.device," and convert them to player-specific commands
  42. to be sent out the designated port.  Some video devices need different code
  43. for different baud rates, so there may be more than one file for a
  44. particular player.
  45.  
  46. The file "player-units" should be in your DEVS: directory.  When
  47. "player.device" initial izes, this file is read to determine which type of
  48. player should be used, which serial de vice should be used, which port
  49. number, and the baud rate to be used.  See Appendix A for a sample
  50. "player-units" file.  YOU configure this file to let player.device know
  51. what you're using.
  52.  
  53.  
  54.  
  55. Operation
  56. ---------
  57.  
  58. You start "videodisc" by simply RUNning it from a CLI or shell.  "Videodisc"
  59. will display an ARexx port name (usually VIDEODISC.1) and send an
  60. INITIALIZE command to the current video device.
  61.  
  62. When you wish to terminate "videodisc", send it a QUIT command.  This can be
  63. accomplished from the command line by typing:
  64.  
  65.  
  66. RX "address videodisc.1 quit"
  67.  
  68.  
  69.  
  70. ARexx Command Set
  71. -----------------
  72.  
  73. You send "videodisc" commands by addressing the port named when "videodisc" is
  74. run. Usually this will be "videodisc.1"  If it's not it means there is
  75. another copy of "videodisc" running.  Having two (or more) copies of
  76. "videodisc" running at the same time does not provide any benefits.  (You
  77. cannot, for example, drive two players simultaneously this way.)
  78.  
  79. The basic commands are listed below.  Items in brackets are optional, items
  80. in parenthe ses are defaults, and items separated by slashes are mutually
  81. exclusive.  Capitalized words are actual commands or keywords, lower case
  82. words describe arguments.
  83.  
  84.  
  85. VIDEO [(ON) / OFF]
  86.  
  87.  
  88. INDEX [CHAPTER / (FRAME)] [(ON) / OFF]
  89.  
  90.  
  91. CX [(ON) / OFF]
  92.  
  93.  
  94. STILL [frame number / (current frame)]
  95.  
  96.  
  97. SEARCH [CHAPTER / FRAME] [number / (0)]
  98.  
  99.  
  100. STEP [(FORWARD) / REVERSE] [number of frames / (1)]
  101.  
  102.  
  103. WAITFOR [CHAPTER / (FRAME)] number
  104.  
  105.  
  106. PLAY    [SLOW / (NORMAL) / FAST] [(FORWARD) / REVERSE]...
  107.  
  108.     [FROM [(FRAME) / CHAPTER] number]...
  109.  
  110.     [UNTIL [(TIME) / CHAPTER] number]
  111.  
  112.  
  113. INITIALIZE
  114.  
  115.  
  116. RESET
  117.  
  118.  
  119. IDLE
  120.  
  121.  
  122. QUIT
  123.  
  124.  
  125.  
  126. The valid ranges for standard arguments are as follows.
  127.  
  128. frame numbers = 1-54000  (Most players will go to the last frame on a disc
  129. if told to search to 54000, some will return an error, others will go to
  130. frame 1.  Most players will go to frame 1 if told to go to frame 0, others
  131. will return an error, some do both.)
  132.  
  133. chapter numbers = 0-99  (Most players will go to the last chapter if told
  134. to search to 99, some will return an error.)
  135.  
  136.  
  137.  
  138. Known Bugs
  139. ----------
  140.  
  141. Gets a lock on shell (shell window can't be closed.)
  142.  
  143. Cannot be stopped if a videodisc command fails.
  144.  
  145. Fixed parsing order on PLAY command
  146.  
  147.  
  148.  
  149. Revision History
  150. ----------------
  151.  
  152. 91.11.14        Version .12     Removed debugging info
  153.  
  154. 91.11.04        Version .11     Added WAITFOR command
  155.  
  156. 91.10.15        Version .1      First (sort of) working version.
  157.  
  158.  
  159.  
  160.  
  161. Appendix A - Layout of "devs:player-units" file
  162. -----------------------------------------------
  163.  
  164. The "player-units" file is a plain ASCII text file that is loaded and
  165. parsed when player.device starts up.  It is up to you to make sure that the
  166. file is properly configured for your setup.
  167.  
  168.  
  169. Here's a sample file:
  170.  
  171. --- file begins here ---
  172. 0 Sony_1200_9600 9600 serial.device 3
  173. --- file ends here ---
  174.  
  175.  
  176. And an explanation:
  177.  
  178. The first number, in this case "0", is simply the "device number" -- it
  179. will always be zero.
  180.  
  181. Next is the filename of the "player file" that is to be used, in this case
  182. "Sony_1200_9600". Note that you should not include the path, as these files
  183. must be in devs:players/.  Also note that some players have different files
  184. for different baud rates.  Always use a file that is greater than or equal
  185. to the actual baud rate that you plan to use.
  186.  
  187. Next comes the actual baud rate that the player is configured for, in this
  188. case, "9600". Note that most players have DIP switches which allow you to
  189. change the baud rate, but some have a fixed rate while others have an
  190. electronic menu that allows the rate to be changed.
  191.  
  192. Next, the name of a shared device that is to be used when communicating
  193. with the player.  This should usually be "serial.device".  Do not give a
  194. path, as the file should be in devs:
  195.  
  196. Finally, there's the "unit number" that is to be used with the
  197. serial.device (or whatever other device is being used.)  This will usually
  198. be "0", as that is the unit number for the default port.  In the sample, it
  199. is set to "3" because I'm using an A2232 multi-serial port board, and
  200. that's the unit number of my player.
  201.  
  202. These argument must be in the stated order, separated by spaces, and the
  203. line should be terminated with a \n.  (Or a press of the return key if
  204. you're editing the file by hand.)
  205.