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