home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_2.iso / files / 702a.lha / PowerPlayer_v3.4 / PowerPlayer.doc.pp / PowerPlayer.doc
Text File  |  1992-12-07  |  19KB  |  485 lines

  1. ==============================================================================
  2.  
  3.             P O W E R P L A Y E R
  4.  
  5.             .....User-Manual.....
  6.  
  7. ==============================================================================
  8.  
  9. Copyright
  10. ---------
  11. PowerPlayer is FREEWARE, this means that it may be freely distributed as
  12. long as the package is distributed unaltered and complete with the files
  13. PowerPlayer, PowerPlayer.info, PowerPlayer.DOC, PowerPlayer.DOK ,
  14. PowerPlayer Music Cruncher, ReqToolsLib, PowerPackerLib, LhLib and the
  15. installation-script!  If you want to make any changes -» contact ME !  I
  16. cannot guarantee that all files included in this package are freely
  17. distributable and/or public domain.
  18.  
  19. The author of this software can't be made liable for the contents of this
  20. package and every damage caused by it.
  21.  
  22.         © 1991/92 STEPHAN FUHRMANN, WEST-GERMANY
  23.  
  24. These freely distributable shared libraries are included in the
  25. PowerPlayer-Package:
  26.  
  27. -ReqTools.Library © by Nico François
  28. -PowerPacker.Library © by Nico François
  29. -Lh.Library © by Holger P.Krekel and Olaf 'Olsen' Barthel
  30.  
  31. Version 3.4 (16 SEP 1992)
  32.  
  33. ==============================================================================
  34.  
  35. Greetings
  36. ---------
  37. Greetings go to
  38. -Mum
  39. -Delta/TCC for the great REAL DINKELATOR DOPPELBOCK INTRO !
  40. -Flynn/TRSI for his great NoisePlayer
  41. -Holger P.Krekel & Olaf 'Olsen' Barthel for their lh.library
  42. -Bryan Ford (Mr.Multiplayer)
  43. -Nico François for his _GREAT_ reqtools.library & powerpacker.library and
  44.  his hints concerning the reqtools.library
  45. -Teijo Kinnunen for his routines & 68030 tests
  46.  
  47. ==============================================================================
  48.  
  49. History
  50. -------
  51. V 1.0:    Version with BUGS & no COOL features :-(
  52. V 1.1:    Removed ALL bugs, added coool CLI-Interface & CLI-InfoPage, PMC
  53. V 1.2:    Added the 4-Channel Oktalyzer-Replay
  54. V 1.3:    Added DeltaMusic (finally got a song :-) ),
  55.     corrected PowerPlayer to recognize SoundMon for ALL Versions,
  56.     optimized ProTracker-Replay
  57. V 1.5:    Added the possibility to start the File-Requester with a specific
  58.     directory, the NoiseTracker 1.3D-Replay has been disabled for a
  59.     strange reason -» FIXED
  60. V 1.6:    In the meantime aged Req.Library has been displaced by the
  61.     ReqTools.Library that generates i.e. nice 3D-Requesters.
  62. V 1.7:    Instead of a VBlank-Interrupt, that replays songs with strange
  63.     speeds when running on Amigas with NTSC or a 10 Hz monitor a
  64.     CIA-Timerinterrupt is used.
  65. V 1.8:    Added the "Restart"-function
  66. V 1.9:    Improved the outputs for faults, the ECLOCK-Frequency will be fetched
  67.     under OS 2.0 from the System, optimized Replays again
  68.     found a bug that exists in ALL tracker-replays, that writes into
  69.     unallocated memory. I don't know whether this bug exists in all
  70.     other Module-Players, too. I recommend to use only PowerPlayer !!!
  71. V 2.0:    Added a replay for TFMX-Modules WITH built-in replay-routine
  72. V 2.1:    Added a replay for MED-Modules
  73. V 2.2:    Now features a GUI (graphical user interface) with a CD-player-like
  74.     button-system. Now uses a big Lh-Buffer for faster decrunching.
  75. V 2.3:    Pressing the right mousebutton will iconify/deiconify the window
  76.     now, the window will be centered beneath the mousepointer when
  77.     launched, new shortcuts were added, code has been optimized
  78. V 2.4:    New functions: First song, last song and random play !
  79. V 2.5:    PowerPlayer will now display a busy-mousepointer when loading &
  80.     decrunching a file and disable the IDCMP of the window.
  81. V 2.6:  PowerPlayer will now look fine on a 2 color-screen
  82. V 2.7:    A little bit more WB 2.0-feeling by adding 3D-Borders
  83. V 2.8:  Included new Protracker-replay (V2.1A), hitting return while
  84.     displaying requesters will activate the negative response
  85.     (for all pessimists ;-)), the PowerPlayer-task is running with
  86.         priority 1, optimized all replays again
  87. V 2.9:    Included Sonix Arranger-replay, new commandline parsing routine +
  88.     commandline flags, multiple modulenames can be specified in the
  89.     commandline
  90. V 3.0:    WorkBench tooltypes for all flags supported (please read the
  91.     chapter "Calling PowerPlayer"), ARexx is supported with many commands
  92.     (please read the chapter "ARexx support"), new "NoReq"-Flag for
  93.         Workbench and CLI (useful for ARexx)
  94. V 3.1:    You may optionally use the filerequester of the asl.library
  95. V 3.2:    SoundMon-Replay now 100% resetable, fixed timing for CPUs
  96.         faster than 68000, now 99.9% safe to use NoisePacker modules,
  97.         new OctaMED pro replay
  98. V 3.3:    New powerful compression, OctaMED 4.0-Replay, Soundmon fixed
  99.     to play samples correctly, new BP-Soundmon type
  100. V 3.4:    Hotkeys, now may used without window, AmigaDOS BREAKable
  101.  
  102. ==============================================================================
  103.  
  104. This version of the PowerPlayer supports:
  105.         FutureComposer 1.4
  106.         NoiseTracker (Protracker V2.1a Replay)
  107.         JamCracker
  108.         SoundMon
  109.         Startrekker 4 Voice
  110.         Fred
  111.         SidMon
  112.         NoiseTracker 1.3D packed modules
  113.         NoiseTracker 1.3D packed modules with replay-routine
  114.         Mark II Sound System
  115.         NoisePacker 2.03
  116.         Oktalyzer 4 Voice
  117.         DeltaMusic
  118.         TFMX with replayroutine
  119.         OctaMED-Modules (MMD0 & MMD1)
  120.         Sonix Arranger with replayroutine
  121.         Morten Grouleff's Musicprogram
  122.  
  123. ==============================================================================
  124.  
  125. Installation
  126. ------------
  127. The PowerPlayer NEEDS the PowerPacker.Library and the ReqTools.Library in
  128. your libs:-directory.  The script included in this package will install
  129. them for you.  Optionally the Lh.Library is used.  If you feel fit enough
  130. you can crunch your modules with the powerful PMC which uses the
  131. LH.Library.
  132.  
  133. ==============================================================================
  134.  
  135. Introduction
  136. ------------
  137. Hello and welcome to the world of PowerPlayer!  This fantastic tool was
  138. written in 1991/1992 by Stephan Fuhrmann, using the outstanding abilities
  139. of the
  140.  
  141. -ReqTools.Library by Nico François for the File- and Text-Requestors
  142.  
  143. -PowerPacker.Library by Nico François for uncrunching powerpacked files
  144.  
  145. -Lh.Library by Holger P. Krekel and Olaf 'Olsen' Barthel for _BEST_
  146.  compression of modules, executable simple cruncher included.
  147.  
  148. The PowerPlayer is a tool for playing music made with one of the supported
  149. music-programs or compatibles with the good old AMIGA stereo digital
  150. sound-facilities !  There have been many of these programs before, but
  151. PowerPlayer is something different:
  152.  
  153. -cool fast tricky optimized 100% assembly code, most parts PC-Relative
  154. -little pretty (?) play-window
  155. -maaaany optimized replays
  156. -PowerPacker-Library for using always the latest and fastest decrunch-routine
  157. -Lh-Library for deepest compression ever seen on modules (try it out !)
  158. -ARexx-Port for remote control of PowerPlayer
  159. -may be used in thousands of ways from WorkBench and from CLI
  160. -allocates its audio-channels with the audio.device
  161.  
  162. But let us start at the beginning:
  163.  
  164. Calling PowerPlayer
  165. -------------------
  166.     WorkBench
  167.     ---------
  168.         DoubleClick
  169.         -----------
  170.             DoubleClick the icon of the PowerPlayer, choose the
  171.             file in the File-Requester, hit 'OK' and enjoy !
  172.         DefaultTool
  173.         -----------
  174.             You have a module with an icon. Select this icon and
  175.             activate the info-function of the Workbench. Now
  176.             select the DefaultTool. Enter the path of
  177.             PowerPlayer and press <RETURN> to terminate the input.
  178.             Press the SAVE-Gadget.
  179.             Now everytime you doubleclick the project-icon
  180.             PowerPlayer will be loaded and will play your song !
  181.         MultiSelect
  182.         -----------
  183.             Move the mousepointer over the PowerPlayer-Icon and
  184.             press the left mousebutton ONCE. Now press SHIFT and
  185.             leave it pressed. Select the songs you want to hear
  186.             with the mouse. Now doubleclick the last song and
  187.             release SHIFT. Your songs will be loaded !
  188.  
  189.         ToolTypes
  190.         ---------
  191.                         Place the mousepointer over the powerplayer-icon
  192.             and activate it by choosing "Info" out of the
  193.             Workbench-menus. You have got the possibility
  194.             to add/change the following ToolTypes:
  195.                         QUALIFIER=(qualifier for hotkeys)
  196.                 This specifies the qualifier you want for
  197.                 the hotkeys
  198.                         DIRECTORY=(directory you want in the filerequester)
  199.                 This specifies the directory that will be
  200.                 displayed first in the filerequester
  201.                 Example: DIRECTORY=DF0:Modules
  202.             PATTERN=(pattern you want in the filerequester)
  203.                 This specifies the pattern all files in
  204.                 the filerequester are matched with
  205.                 Example: PATTERN=MOD.#?
  206.             LED=[0|1|M]
  207.                                 This specifies the mode of the filter-LED:
  208.                 0=Force filter-led off
  209.                 1=Force filter-led on
  210.                                 M=Let the module decide (default)
  211.                 Example: LED=0
  212.             NOREQ=[TRUE|FALSE]
  213.                 Tells PowerPlayer to pop up *NO* filerequester
  214.                                 if it started without any files specified.
  215.                 Useful for ARexx since you can't control
  216.                 Nico's Filrequester with ARexx ;-).
  217.                         NOWIN=[TRUE|FALSE]
  218.                 Tells PowerPlayer to open *NO* window
  219.                 on startup.
  220.             ASL=[TRUE|FALSE]
  221.                 Tells PowerPlayer to use the filerequester
  222.                 of the asl.library. You need OS 2.0 to do
  223.                 this. If PowerPlayer failed to open the
  224.                 library or the requester the reqtools-
  225.                 requester will be used.
  226.     CLI/Shell
  227.     ---------
  228.         Filerequester
  229.         -------------
  230.             Everyone knows how to handle filerequesters, so I
  231.             do not want to explain the very sophisticated one
  232.             of the reqtools.library. Type the name of PowerPlayer
  233.             in the CLI/Shell you have opened and add the
  234.             parameter '-r' to the command. You will see
  235.             a filerequester where you can select your songs.
  236.                         This flag is obsolete, PowerPlayer will pop up
  237.                         the filerequester if there are no files specified
  238.             on startup.
  239.             Example: PowerPlayer -r
  240.         Filename
  241.         --------
  242.             If you do not want to select the file by making use
  243.             of the filerequester (i.e. in scripts) you may also
  244.             add one or multipe modulenames with its/their path
  245.             to the commandline.
  246.             Example: PowerPlayer df0:MOD.PowerTheme ram:SID.Mega
  247.  
  248.         Information
  249.         -----------
  250.             If you want to see the cool information-page,
  251.             enter: PowerPlayer ?
  252.         Flags
  253.         -----
  254.             There are multiple flags that can make the time
  255.             you pass using the PowerPlayer more convenient:
  256.             -r........use filerequester (obsolete)
  257.             -nr.......don't pop up filerequester at start when
  258.                     there are no files specified
  259.                         -nw.......don't open a window at start
  260.             -dDIR.....set the directory of the filerequester
  261.                     i.e. '-dDF0:modules'.
  262.             -pPAT.....set the pattern of the filerequester
  263.                     i.e. '-pMOD#?'.
  264.             -qQUAL....set the qualifier for the hotkeys
  265.                     (see hotkey-chapter)
  266.             -l0/1/M...set the mode of the filter-led.
  267.                     0=force filter off
  268.                     1=force filter on
  269.                     M=module controls filter
  270.             -ASL......Tells PowerPlayer to use the filerequester
  271.                     of the asl.library. You need OS 2.0
  272.                     to do this. If PowerPlayer failed to
  273.                     open the library or the requester the
  274.                     reqtools-requester will be used.
  275. Play-Requester
  276. --------------
  277. The Play-Requester contains information about the module and some gadgets.
  278. If you start PowerPlayer without a window (NOWIN) and have specified a
  279. qualifier for hotkeys you are able to open the window by pressing qualifier
  280. and 'w'.
  281.  
  282. Questionmark....displays the usual information concerning copyright &
  283.         features.
  284.         Key: '1'
  285. Eject...........ejects the current list of songs & asks you with a
  286.         filerequester for a new one. Key: '2' or 'e'
  287. FirstSong.......will load & play the first song from the list.
  288. PrevSong........will load & play the previous song from the list.
  289.         Key: '3','[','(' or '{' !
  290. Play............will play the song. Will automatically unpause, if you
  291.         hammer the PLAY again the song will start from the
  292.         beginning.
  293.         Key: '4' or 'p'
  294. FastForward.....will play the song twice as fast as normal. This gives a
  295.         nice FF-effect ! Rehammer will switch back to normal speed.
  296.         Key: '5' or 'f'
  297. NextSong........will load & play the next song from the list.
  298.         Key '6','<RETURN>', ']',')' or '}' !
  299. LastSong........will load & play the last song from the list.
  300. Stop............will stop the song. Automatically unpauses, unFFs and
  301.         unplays!
  302.         Key: '7' or 's'
  303. Pause...........stops the song until you repress pause or push play.
  304.         Key: '8' or '<SPACE>'
  305. Reset...........will start the song again.
  306.         Key: '9' or 'r'
  307. RND.............will load & play a randomly chosen song.
  308.         Key: '~' or '/'
  309.  
  310. Almost every gadget has an equivalent on the keyboard (Keys 1-9), ESC and
  311. CTRL-C will exit the PowerPlayer.
  312.  
  313. CTRL-F resizes the window to full size and places it in front of all other
  314. windows.
  315.  
  316. Pressing the right mousebutton will change to the iconify-mode. The window
  317. will shrink to a minimum height of 10 pixels. The gadgets will disappear,
  318. but you can still control PowerPlayer with the keyboard-shortcuts.
  319. To unshrink the window to its normal size you just have to hit the
  320. right mousebutton again.
  321.  
  322. The display of the window contains
  323. -the name of the module (top of window)
  324. -type of the module & length of the module in bytes (middle of window)
  325. -the gadgets and the position-indicator that displays your position in the
  326.  file-list.
  327.  
  328. My GUI works with a recolor-routine that can handle crazy palettes in a clever
  329. way. It searches for the brightest and darkest colors for the shadows and
  330. it searches for the color with the biggest contrast to the background for
  331. text-output.
  332.  
  333. Hotkeys
  334. -------
  335. Hotkeys enable you to use PowerPlayers standard set of keys -
  336. no matter what the active window or screen is. This means that you can
  337. control PowerPlayer from your wordprocessor without leaving the
  338. wordprocessors screen/window.
  339.  
  340. This feature is turned on by the QUALIFIER ToolType or by the -q flag.
  341. Valid qualifiers are:
  342.  
  343. LSHIFT/LEFT_SHIFT
  344. RSHIFT/RIGHT_SHIFT
  345. CAPSLOCK
  346. CONTROL
  347. LALT/LEFT_ALT
  348. RALT/RIGHT_ALT
  349. LCOMMAND/LEFT_COMMAND/LAMIGA/LEFT_AMIGA
  350. RCOMMAND/RIGHT_COMMAND/RAMIGA/RIGHT_AMIGA
  351.  
  352. To mix these qualifiers you have to seperate the qualifiers with a '!' or
  353. a '|':
  354.  
  355. CONTROL!LSHIFT!LALT
  356.  
  357. This is the recommended standard qualifier that is preset in PowerPlayers
  358. ToolType.
  359.  
  360. ==============================================================================
  361.  
  362. ARexx support
  363. -------------
  364. PowerPlayer offers an ARexx-Port named "PowerPlayer.REXX".
  365.  
  366. The ARexx-Port supports the following commands:
  367.  
  368. PlEject             acts exactly like the "Eject"-button
  369. PlFirst             acts exactly like the "First"-button
  370. PlPrevious          acts exactly like the "Previous"-button
  371. PlPlay            acts exactly like the "Play"-button
  372. PlFF            acts exactly like the "FF"-button
  373. PlNext            acts exactly like the "Next"-button
  374. PlLast            acts exactly like the "Last"-button
  375. PlStop            acts exactly like the "Stop"-button
  376. PlPause            acts exactly like the "Pause"-button
  377. PlReset            acts exactly like the "Reset"-button
  378. PlRnd            acts exactly like the "Rnd"-button
  379. PlQuit            tells PowerPlayer to quit. Don't try to access the
  380.                         ARexx-Port after this command!
  381. PlLoad "<ModName>"    loads <ModName> and plays it.
  382.  
  383. ==============================================================================
  384.  
  385. The PowerPlayer Music Cruncher
  386. ------------------------------
  387. PMC has been developed to crunch modules only and I think that it does its
  388. job very good. It beats the compression-ratio of _EVERY_ known cruncher/archiver
  389. on the AMIGA and it is very fast when crunching & decrunching.
  390.  
  391. I have developed the new "SFCD" (Stephan Fuhrmanns Compact Density) mode
  392. which is based upon the old "SFHD" (Stephan Fuhrmanns High Density) mode.
  393. To crunch/decrunch "SFCD"/"SFHD" type modules you require Lh.Library v1.8+.
  394.  
  395. MOD.TEST    |UNCRUNCHED    |SFCD    |SFHD    |POWERPACKER
  396. ----------------+---------------+-------+-------+-----------
  397. SIZE (bytes)    |320044        |189734    |210540    |237832
  398. SUCCESS        |00%        |40%    |34%    |25%
  399. CRUNCHTIME    |0:00        |2:37    |2:47    |2:58
  400. DECRUNCHTIME    |0:00        |0:17    |0:17    |0:07
  401.  
  402. Using PMC is rather simple:
  403.  
  404. PMC [SOURCENAME] [DESTNAME]
  405.  
  406. PMC will load [SOURCENAME], crunch it (or decrunch, if already crunched)
  407. and save it as [DESTNAME].
  408.  
  409. PMC writes "SFCD" type modules only, but it can read & decrunch "SFCD" and
  410. "SFHD" type modules.
  411.  
  412. PowerPlayer reads & decrunches "SFCD" & "SFHD" type modules automatically
  413. if the Lh.Library is in your Libs: directory.
  414.  
  415. I have seen some guys loading up modules on BBSs in the PMC-format.
  416. PLEASE use '.PMC' as suffix and note that they need PowerPlayer to replay.
  417. AND check the BBS wether there's PowerPlayer existing or not, they
  418. won't be very happy if they download the stuff and don't find the
  419. PowerPlayer !
  420.  
  421. An example BBS-entry could look like this:
  422. SONG.PMC    Very good module, use PowerPlayer to replay
  423.  
  424. I recommend uploading the modules in the PMC-format without unimportant
  425. 'trash' in an archive. You don't have to decrunch manually, the file
  426. needs less diskspace (it's still crunched) and there's last but not least
  427. the PMC-format that has been developed ONLY for the PowerPlayer, so you
  428. _NEED_ the PowerPlayer to decrunch ß-} !  By doing this you can show your
  429. consent to the PowerPlayer!
  430.  
  431. ==============================================================================
  432.  
  433. Technical Information
  434. ---------------------
  435. PowerPlayer won't create his own process.  It seems to be a modern feature
  436. to launch everything in the background, but I wanted to give the user the
  437. possibility to stop the computer i.e.  in the startup-sequence as long as
  438. the song plays.  I think this is the best way to realize this, if you want
  439. to create a background process for PowerPlayer you will have to "RunBack"
  440. it yourself !
  441.  
  442. ==============================================================================
  443.  
  444. Since there are sooo many music-proggies for the AMIGA, it is impossible to
  445. include all the existing replays.  To give you and me the possibility to
  446. expand PowerPlayer to the best moduleplayer ever written, I will built in
  447. any replay-routine sent to me, if the following work is done:
  448.  
  449. -Sourcecode of the Music-Routine in ASSEMBLY, PC-Relative if possible.
  450.  At this time I can only include replayers at the base of the
  451.  verticalblank-interrupt. The sourcecode has to be on a 3.5"-disk
  452. -Add a description how to recognize that certain kind of module or other-
  453.  wise simply enclose 3 or more of those modules and I'll find out myself
  454. -In any case,though, I would like you to add 3 or more Songs that can be
  455.  played with your replay, if possible. I have to test the routines, and
  456.  a music-proggy with less than 3 adequate songs is surely not very useful.
  457. -If the disk has only ONE error, I'll take for granted that you do not want
  458.  it back and shred it. So do use high-quality-disks formatted carefully
  459.  before using (verify) !
  460.  
  461. If you want some cool features added to the PowerPlayer, do this:
  462.  
  463. -Write a detailed letter with all new features you think of
  464. -If you would like to have the new version
  465. -include a disk for PowerPlayer and 5 DM (DEUTSCH MARK) for my working on it !
  466.  
  467. If you want an update, do this:
  468. -Include a disk for PowerPlayer and 5 DM (DEUTSCH MARK) for all the work
  469.  (envelope, stamps...) !
  470. -I will send you the actual version of PowerPlayer
  471.  
  472. Donations are always welcome and may speed up the answer!! Think of the work
  473. I had to do to make PowerPlayer to that what it is today.
  474.  
  475. My Address:    Stephan Fuhrmann
  476.         Erikstr. 30
  477.         W-2380 Schleswig
  478.         Germany
  479.  
  480. Always add the version of the PowerPlayer you are using and where you got
  481. it from!
  482.  
  483. ==============================================================================
  484. (EOF)
  485.