home *** CD-ROM | disk | FTP | other *** search
/ Woodland Treasury / Woodland_Treasury.iso / support / _arplayer / _help < prev    next >
Text File  |  1994-02-22  |  14KB  |  339 lines
  1.  
  2.                 ARPlayer - Desktop Movie Player
  3.                 ==============================
  4.  
  5. The purpose of ARPlayer is to play Acorn Replay movies. On-line help is
  6. provided on all operations via the !Help application.
  7.  
  8. There are two basic playback modes referred to below as video and sound
  9. playback modes.
  10.  
  11. Video mode occurs when playing a movie containing video information (it may
  12. have sound as well) and when video is enabled from the Setup window.
  13. Playback is single-tasking (all other tasks running on your computer are
  14. suspended) until the movie has finished playing.
  15.  
  16. Sound mode occurs when playing a movie file that only contains sound tracks
  17. or when the video tracks have been disabled from the Setup window. This mode
  18. of operation is multi-tasking. The counter updates as the movie plays (if
  19. the time bar is enabled) and other tasks run as normal. The sound data is
  20. loaded from the movie file on disc as it is needed.
  21.  
  22.  
  23.  
  24. Icon bar
  25. --------
  26.  
  27. ARPlayer installs an icon on the icon bar.
  28.  
  29. Click SELECT on this icon to open a movie window. If the 'Multiple windows'
  30. option is enabled then this will always open a new window otherwise it will
  31. open a window or bring the open window to the front.
  32.  
  33. The icon bar menu gives the following options
  34.  
  35.     Info        
  36.     Global choices ...
  37.     Multiple windows
  38.     Save choices
  39.     Quit
  40.  
  41.  - 'Info' leads to the standard program information box.
  42.  
  43.  - 'Global choices ...' opens the global choices window. See below for
  44. details.
  45.  
  46.  - 'Multiple windows' is a switch. If it is disabled then only one movie
  47. window will ever be displayed. If it is enabled then a new window will be
  48. opened whenever you click SELECT on the icon bar.
  49.  
  50.  - 'Save choices' saves the current setup to disc as the default. Two files
  51. are saved.
  52.  
  53. The contents of the 'Movie setup' window and the switches detailed above are
  54. stored in a file within the !ARPlayer application. This file is read each
  55. time the application is run.
  56.  
  57. The state of the system variables set by the 'Global choices' window is saved
  58. in a separate file that may be in one of two places. If the variable
  59. 'Choices$Write' is set then it will save the file as
  60. '<Choices$Write>.Boot.PreDesk.ARPlayer' otherwise it saves it as '<ARPlayer$Dir>.!State'.
  61.  
  62. Display window
  63. --------------
  64.  
  65. The display window is in two sections. The main picture area where the movie
  66. is displayed and a tool pane below containing control buttons and a time bar.
  67.  
  68. If a blank window is opened then the default ARMovie 'Replay' sprite is
  69. displayed. When a movie is loaded then the helpful sprite from the movie
  70. header will be shown. The title bar will show the movie description if it has
  71. one, otherwise it will show the filename of the movie.
  72.  
  73. The window will resize itself to the correct size for the movie. Note
  74. however that the tool pane below will not resize.
  75.  
  76. The display menu is as follows.
  77.  
  78.     File              Info ...
  79.                       Save frame 
  80.                       Save data 
  81.     Edit              Copy frame
  82.                       Clear clipboard
  83.     Movie setup ...
  84.     Time bar
  85.     Tool bar
  86.     Play
  87.  
  88.  - 'File.Info' will open the Movie Info dialogue box (see below).
  89.  
  90.  - 'File.Save frame' leads to a standard save dialogue box which will save
  91. out the current movie frame exactly as displayed in the display window.
  92.  
  93.  - 'File.Save data' leads to a save dialogue box with option buttons to choose
  94. which elements of the movie to extract. Dragging the directory icon to a
  95. directory display will run the 'Extract' utility and write out the elements
  96. selected.
  97.  
  98. The components of a movie you can extract are:-
  99.  
  100.    - Images. These is the compressed chunks of video data.
  101.    - Sound. All sound tracks present will be saved, the name depends on the
  102.      type of sample and the track number. See document 'ToUseJoin' for details.
  103.    - Keys. These are the uncompressed key frames stored with the movie to
  104.      improve access times.
  105.    - Sprite. This is the helpful sprite shown when the movie is first loaded and
  106.      often used as a thumbnail identifier.
  107.    - Header. This is the textual header to a movie which contains the data shown
  108.      in the movie info window.
  109.  
  110.  
  111.  - 'Edit.Copy frame' copies the displayed movie frame to the clipboard
  112. from where it can be imported by any application that supports the clipboard
  113. protocol.
  114.  
  115.  - 'Edit.Clear clipboard' clears the clipboard if it contains a frame from
  116. ARPlayer. This option will not be selectable if the clipboard is empty or owned
  117. by another application.
  118.  
  119.  - 'Movie setup' opens a window allowing all the various playback configure
  120. options for Acorn Replay to be setup. The options set only affect the movie
  121. in the display window.
  122.  
  123.  - 'Time bar' will toggle the time bar and time counter display on and off.
  124.  
  125.  - 'Tool bar' will toggle the movie controls on and off. If the tool
  126. bar is not shown then a movie can be controlled using the mouse buttons:
  127.    SELECT will pause the movie until it is pressed again
  128.    MENU (or ESCAPE) will stop playback
  129.    ADJUST will pause the movie whilst it is held down
  130.  
  131. In sound-only playback the movie is stopped by clicking ADJUST.
  132.  
  133.  - 'Play' will start playback.
  134.  
  135.  
  136. Time bar
  137. --------
  138.  
  139. This is in two sections. A slider bar in the main section, and a time
  140. counter to the right showing the current time in minutes, seconds and frames.
  141. Note that the frame count is from 0 to (number of frames in one second - 1). In
  142. the case of a movie with a fractional frame rate then the number of frames in
  143. one second will vary. eg a 12.5 frames per second movie an even numbered chunk
  144. will have 12 frames (eg 00:00.00 to 00:00.11) and an odd chunk 13 frames (eg
  145. 00:01.00 to 00:01.12).
  146.  
  147. The start point for playback can be set by clicking and dragging with SELECT
  148. on the slider bar. When the mouse button is released then the new frame will be
  149. found and displayed (which takes a few seconds). To just set the start point
  150. without loading the new frame drag to the desired point on the time bar
  151. holding down the CTRL key.
  152.  
  153. Note that the slider will update as a movie is playing except in the following
  154. cases.
  155.  
  156.  - When the movie is not playing in the Desktop
  157.  - When the current mode has only 2 or 4 colours
  158.  - When any part of the slider is off the screen
  159.  - When the slider overlaps the movie frame area
  160.  
  161. Note also that the time counter will only update during playback if you are
  162. playing sound only.
  163.  
  164. Tool bar
  165. --------
  166.  
  167. This has six control icons.
  168.  
  169.  - 'Stop' will stop playback, whether video or sound.
  170.  
  171.  - 'Play' will start playback from the current point shown on the time bar
  172. slider. Whether playback is multi-tasking or not depends on the settings in
  173. the Movie setup window.
  174.  
  175.  - 'Play big' will start playback from the current point and attempt to play
  176. the movie full screen. The default big mode is mode 13 (320x256 in 256 colours)
  177. but you can define which mode should be used for play big requests from the
  178. Global Choices window.
  179.  
  180.  - 'Pause' will toggle pause state on and off. If the movie was stopped when
  181. Pause was pressed then it will start playing and immediately enter Pause
  182. mode.
  183.  
  184.  - 'Single step' plays one frames worth of video and/or sound. If the player
  185. is currently playing then it enters pause mode first. Note that single
  186. stepping video from stopped mode takes a few seconds to retrieve the next
  187. frame.
  188.  
  189.  - 'Mute' enables or disables the sound track. This can be used before,
  190. during or after video or sound playback independently of any other controls. 
  191.  
  192. Movie info window
  193. -----------------
  194.  
  195. This window shows information about the movie from its header.
  196.  
  197.  - The first three lines have general descriptive text about the movie.
  198. Typically these will be a longish description of the contents, any copyright
  199. message, and who performed the digitisation/editing.
  200.  
  201. Below this is information about the format of the movie.
  202.  
  203.  - The video compression type, followed by name of the compression type and
  204. a copyright message for this type. Note that if the Info file for this
  205. compression type cannot be found then it will just say Video type X where X
  206. is the type number.
  207.  
  208.  - the size of each video frame in pixels
  209.  
  210.  - The format of the video data in the following order. Bits per pixel, frame
  211. rate and whether key frames are present.
  212.  
  213.  - The format of the sound data in the following order. Sound type, bits per
  214. sample, format, mono/stereo/number of channels and sample rate/sample
  215. period.
  216.  
  217.  - The arrangement of data in the file. The number of chunks, the number of
  218. frames in each chunk and the length of the movie.
  219.  
  220. If a movie has multiple sound tracks then the data for each sound track can be
  221. seen by adjusting the sound track number with the arrow icons.
  222.  
  223.  
  224. Movie setup window
  225. ------------------
  226.  
  227. This window sets the options for playback for the movie in the display
  228. window. Whilst the window is open then a movie will be played according to
  229. the options shown. If SELECT is pressed on 'Update' then the changes are
  230. registered. Clicking with ADJUST will register the changes and keep the
  231. window open. Clicking on Cancel will restore the setup to the state when it
  232. was previously opened or Update was last pressed.
  233.  
  234.  - 'Trajectory' will play the movie along a trajectory. To choose a
  235. trajectory either drag a trajectory file to the writeable icon or choose one
  236. from the popup menu. To popup the menu click SELECT on the popup icon or
  237. MENU over the writeable icon.
  238.  
  239.  - 'Shape' will play the movie in a shape. To choose a shape either drag a
  240. shape file to the writeable icon or choose one from the popup menu. To pop
  241. up the menu click SELECT on the popup icon or MENU over the writeable icon.
  242.  
  243.  - 'Loop' will cause the movie to restart from the beginning when it ends.
  244. You can either enter a number of times to play the movie (where a value of 1
  245. means the movie will be played only once, ie no loops) or select the
  246. 'Forever' icon in which case the movie will play until 'Stop' is pressed.
  247.  
  248.  - The 'sound track' field allows the selection of which sound track to play
  249. in the case of movies with multiple sound tracks.
  250.  
  251.  - 'Video' enables the video tracks of a movie. If a movie is played without
  252. video then the playback will be multi-tasking.
  253.  
  254.  - 'Adjust rate' allows you to change the apparent frame rate of the movie.
  255. eg a rate of 2.0 will play the movie at twice the normal rate. Note that
  256. sound-only playback will always occur at the speed given in the movie
  257. header. Also that it may not be physically possible to play back the movie
  258. at much faster rates, especially an uncompressed movie.
  259.  
  260.  - 'Extra args' allows you to enter any other arguments to the command-line
  261. passed to the Player. This is to allow use of any features added since this
  262. version ARPlayer was created. Note that you should always use the specific
  263. buttons and fields in this window in preference to the 'Extra args' feature
  264. if possible as some of the command-line arguments give messy results when
  265. used  together (eg -shape and -leave). Using the defined interface will sort
  266. these problems out, adding the parameters in directly via this interface
  267. will not.
  268.  
  269. Global choices window
  270. ---------------------
  271.  
  272. This window gives control over various system variables used by the ARMovie
  273. playback software. These variables affect playback at all times, not just
  274. from within ARPlayer. eg if you enable Interpolation from here then it will
  275. be used whenever any movie is played from any application.
  276.  
  277. These options are not stored in the ARPlayer choices file but instead are
  278. stored in a separate boot file. For more details of what the options do
  279. see the file !ARMovie.ProgIf which may be found within the !Boot application
  280. on your hard disc.
  281.  
  282.  - The 'ARMovie' field shows the date and version number of the ARMovie
  283. Player. 
  284.  
  285.  - 'Interpolate' improves image quality at the expense of extra processing
  286. power used. If your machine is not powerful enough you will notice the frame
  287. rate of movies dropping (leading to jerky motion or 'tearing' of frames). In
  288. this case you should disable the interpolation feature.
  289.  
  290. For advanced users: There is a line in the !Choices file labelled
  291. Interpolation. The two numbers after this label are used to set the
  292. ARMovie$Interpolate variable. By default these are set very large so that
  293. interpolation will always be enabled when requested. You can, however, change
  294. them so that interpolation is automatically disabled for movies above a
  295. certain frame size/rate. If the first value is -1 then ARMovie$Interpolate
  296. will be set to a single character. See !ARMovie.Documents.ProgIf for more
  297. details on this.
  298.  
  299.  - 'Use colour in 16 colour modes'. The standard palette in 16 colour modes
  300. is not well suited for displaying real-life colour images so by default
  301. movies are played back in greyscales only. If you enable this option then,
  302. assuming there is a suitable colour table for the current palette, playback
  303. will be in colour.
  304.  
  305.  - 'Preferred mode'. If this option is enabled then normal movie playback
  306. will be in the mode shown. Note this also applies to movies played from
  307. ARPlayer unless overridden by use of the 'Change mode' option in the Setup
  308. window.
  309.  
  310.  - 'Preferred big mode'. The default Big mode is mode 13 (320x256x256 colours
  311. at 50Hz). Enabling this option allows you to change this for one more suited
  312. to your monitor (eg if using a VGA monitor). This mode will be used when the
  313. Big option is set by use of their play big buttons. (Note that not all Replay
  314. compliant applications supply a 'Play big' button). You can specify a list of
  315. modes to use, separated by semi-colons. See Documents.PrefBig in !ARMovie for
  316. more details. 
  317.  
  318. The preferred modes default to the current mode if not set and will accept
  319. mode numbers or mode specification strings.
  320.  
  321.  - 'Create Colour Tables' allows you to create a new colour table for the
  322. current mode and palette. This is a single-tasking operation and takes quite
  323. a long time (upto 15 minutes approximately).  
  324.  
  325. The system variables set by these options are ARMovie$Interpolate,
  326. ARMovie$4Colour, ARMovie$PrefMode, ARMovie$PrefBigMode.
  327.  
  328. Copyright
  329. ---------
  330.  
  331. ARPlayer is copyright
  332.  
  333.   © Uniqueway Ltd, 1994.
  334.   © Acorn Computers Ltd, 1994.
  335.  
  336. ARPlayer may be distributed under license. The multitasking sound playback
  337. abilities of ARPlayer are available in a C library. Contact Acorn for
  338. further details of these.
  339.