home *** CD-ROM | disk | FTP | other *** search
/ Magazyn Amiga Shareware Floppies / ma08.dms / ma08.adf / powerplayer / PowerPlayer.doc < prev    next >
Text File  |  1992-08-23  |  19KB  |  448 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.         © 1991/92 STEPHAN FUHRMANN, WEST-GERMANY
  20.  
  21. These freely distributable shared libraries are included in the
  22. PowerPlayer-Package:
  23.  
  24. -ReqTools.Library © by Nico François
  25. -PowerPacker.Library © by Nico François
  26. -Lh.Library © by Holger P.Krekel and Olaf 'Olsen' Barthel
  27.  
  28. Version 3.0 (11 JUL 1992)
  29.  
  30. ==============================================================================
  31.  
  32. Greetings
  33. ---------
  34. Greetings go to
  35. -Mum
  36. -Delta/TCC for the great REAL DINKELATOR DOPPELBOCK INTRO !
  37. -Flynn/TRSI for his great NoisePlayer
  38. -Holger P.Krekel & Olaf 'Olsen' Barthel for their lh.library
  39. -Bryan Ford (MultiPlayer) -» enjoyed my debugging-lesson ?!
  40. -Nico François for his _GREAT_ reqtools.library & powerpacker.library and
  41.  his hints concerning the reqtools.library
  42.  
  43. ==============================================================================
  44.  
  45. History
  46. -------
  47. V 1.0:    Version with BUGS & no COOL features :-(
  48. V 1.1:    Removed ALL bugs, added coool CLI-Interface & CLI-InfoPage, PMC
  49. V 1.2:    Added the 4-Channel Oktalyzer-Replay
  50. V 1.3:    Added DeltaMusic (finally got a song :-) ),
  51.     corrected PowerPlayer to recognize SoundMon for ALL Versions,
  52.     optimized ProTracker-Replay
  53. V 1.5:    Added the possibility to start the File-Requester with a specific
  54.     directory, the NoiseTracker 1.3D-Replay has been disabled for a
  55.     strange reason -» FIXED
  56. V 1.6:    In the meantime aged Req.Library has been displaced by the
  57.     ReqTools.Library that generates i.e. nice 3D-Requesters.
  58. V 1.7:    Instead of a VBlank-Interrupt, that replays songs with strange
  59.     speeds when running on Amigas with NTSC or a 10 Hz monitor a
  60.     CIA-Timerinterrupt is used.
  61. V 1.8:    Added the "Restart"-function
  62. V 1.9:    Improved the outputs for faults, the ECLOCK-Frequency will be fetched
  63.     under OS 2.0 from the System, optimized Replays again
  64.     found a bug that exists in ALL tracker-replays, that writes into
  65.     unallocated memory. I don't know whether this bug exists in all
  66.     other Module-Players, too. I recommend to use only PowerPlayer !!!
  67. V 2.0:    Added a replay for TFMX-Modules WITH built-in replay-routine
  68. V 2.1:    Added a replay for MED-Modules
  69. V 2.2:    Now features a GUI (graphical user interface) with a CD-player-like
  70.     button-system. Now uses a big Lh-Buffer for faster decrunching.
  71. V 2.3:    Pressing the right mousebutton will iconify/deiconify the window
  72.     now, the window will be centered beneath the mousepointer when
  73.     launched, new shortcuts were added, code has been optimized
  74. V 2.4:    New functions: First song, last song and random play !
  75. V 2.5:    PowerPlayer will now display a busy-mousepointer when loading &
  76.     decrunching a file and disable the IDCMP of the window.
  77. V 2.6:  PowerPlayer will now look fine on a 2 color-screen
  78. V 2.7:    A little bit more WB 2.0-feeling by adding 3D-Borders
  79. V 2.8:  Included new Protracker-replay (V2.1A), hitting return while
  80.     displaying requesters will activate the negative response
  81.     (for all pessimists ;-)), the PowerPlayer-task is running with
  82.         priority 1, optimized all replays again
  83. V 2.9:    Included Sonix Arranger-replay, new commandline parsing routine +
  84.     commandline flags, multiple modulenames can be specified in the
  85.     commandline
  86. V 3.0:    WorkBench tooltypes for all flags supported (please read the
  87.     chapter "Calling PowerPlayer"), ARexx is supported with many commands
  88.     (please read the chapter "ARexx support"), new "NoReq"-Flag for
  89.         Workbench and CLI (useful for ARexx)
  90.  
  91. ==============================================================================
  92.  
  93. This version of the PowerPlayer supports:
  94.         FutureComposer 1.4
  95.         NoiseTracker (Protracker V2.1a Replay)
  96.         JamCracker
  97.         SoundMon
  98.         Startrekker 4 Voice
  99.         Fred
  100.         SidMon
  101.         NoiseTracker 1.3D packed modules
  102.         NoiseTracker 1.3D packed modules with replay-routine
  103.         Mark II Sound System
  104.         NoisePacker 2.03
  105.         Oktalyzer 4 Voice
  106.         DeltaMusic
  107.         TFMX with replayroutine
  108.         MED-Modules
  109.         Sonix Arranger with replayroutine
  110.  
  111. ==============================================================================
  112.  
  113. Installation
  114. ------------
  115. The PowerPlayer NEEDS the PowerPacker.Library and the ReqTools.Library in
  116. your libs:-directory.  The script included in this package will install
  117. them for you.  Optionally the Lh.Library is used.  If you feel fit enough
  118. you can crunch your modules with the powerful PMC which uses the
  119. LH.Library.
  120.  
  121. ==============================================================================
  122.  
  123. Introduction
  124. ------------
  125. Hello and welcome to the world of PowerPlayer!  This fantastic tool was
  126. written in 1991/1992 by Stephan Fuhrmann, using the outstanding abilities
  127. of the
  128.  
  129. -ReqTools.Library by Nico François for the File- and Text-Requestors
  130.  
  131. -PowerPacker.Library by Nico François for uncrunching powerpacked files
  132.  
  133. -Lh.Library by Holger P. Krekel and Olaf 'Olsen' Barthel for _BEST_
  134.  compression of modules, executable simple cruncher included.
  135.  
  136. The PowerPlayer is a tool for playing music made with one of the supported
  137. music-programs or compatibles with the good old AMIGA stereo digital
  138. sound-facilities !  There have been many of these programs before, but
  139. PowerPlayer is something different:
  140.  
  141. -cool fast tricky optimized 100% assembly code, most parts PC-Relative
  142. -little pretty (?) play-window
  143. -maaaany optimized replays
  144. -PowerPacker-Library for using always the latest and fastest decrunch-routine
  145. -Lh-Library for deepest compression ever seen on modules (try it out !)
  146. -ARexx-Port for remote control of PowerPlayer
  147. -may be used in thousands of ways from WorkBench and from CLI
  148.  
  149. But let us start at the beginning:
  150.  
  151. Calling PowerPlayer
  152. -------------------
  153.     WorkBench
  154.     ---------
  155.         DoubleClick
  156.         -----------
  157.             DoubleClick the icon of the PowerPlayer, choose the
  158.             file in the File-Requester, hit 'OK' and enjoy !
  159.         DefaultTool
  160.         -----------
  161.             You have a module with an icon. Select this icon and
  162.             activate the info-function of the Workbench. Now
  163.             select the DefaultTool. Enter the path of
  164.             PowerPlayer and press <RETURN> to terminate the input.
  165.             Press the SAVE-Gadget.
  166.             Now everytime you doubleclick the project-icon
  167.             PowerPlayer will be loaded and will play your song !
  168.         MultiSelect
  169.         -----------
  170.             Move the mousepointer over the PowerPlayer-Icon and
  171.             press the left mousebutton ONCE. Now press SHIFT and
  172.             leave it pressed. Select the songs you want to hear
  173.             with the mouse. Now doubleclick the last song and
  174.             release SHIFT. Your songs will be loaded !
  175.  
  176.         ToolTypes
  177.         ---------
  178.                         Place the mousepointer over the powerplayer-icon
  179.             and activate it by choosing "Info" out of the
  180.             Workbench-menus. You have got the possibility
  181.             to add/change the following ToolTypes:
  182.                         DIRECTORY=(directory you want in the filerequester)
  183.                 This specifies the directory that will be
  184.                 displayed first in the filerequester
  185.                 Example: DIRECTORY=DF0:Modules
  186.             PATTERN=(pattern you want in the filerequester)
  187.                 This specifies the pattern all files in
  188.                 the filerequester are matched with
  189.                 Example: PATTERN=MOD.#?
  190.             LED=[0|1|M]
  191.                                 This specifies the mode of the filter-LED:
  192.                 0=Force filter-led off
  193.                 1=Force filter-led on
  194.                                 M=Let the module decide (default)
  195.                 Example: LED=0
  196.             NOREQ=[TRUE|FALSE]
  197.                 Tells PowerPlayer to pop up *NO* filerequester
  198.                                 if it started without any files specified.
  199.                 Useful for ARexx since you can't control
  200.                 Nico's Filrequester with ARexx ;-).
  201.     CLI/Shell
  202.     ---------
  203.         Filerequester
  204.         -------------
  205.             Everyone knows how to handle filerequesters, so I
  206.             do not want to explain the very sophisticated one
  207.             of the reqtools.library. Type the name of PowerPlayer
  208.             in the CLI/Shell you have opened and add the
  209.             parameter '-r' to the command. You will see
  210.             a filerequester where you can select your songs.
  211.                         This flag is obsolete, PowerPlayer will pop up
  212.                         the filerequester if there are no files specified
  213.             on startup.
  214.             Example: PowerPlayer -r
  215.         Filename
  216.         --------
  217.             If you do not want to select the file by making use
  218.             of the filerequester (i.e. in scripts) you may also
  219.             add one or multipe modulenames with its/their path
  220.             to the commandline.
  221.             Example: PowerPlayer df0:MOD.PowerTheme ram:SID.Mega
  222.  
  223.         Information
  224.         -----------
  225.             If you want to see the cool information-page,
  226.             enter: PowerPlayer ?
  227.         Flags
  228.         -----
  229.             There are multiple flags that can make the time
  230.             you pass using the PowerPlayer more convenient:
  231.             -r........use filerequester (obsolete)
  232.             -nr.......don't pop up filerequester at start when
  233.                     there are no files specified
  234.             -dDIR.....set the directory of the filerequester
  235.                     i.e. '-dDF0:modules'.
  236.             -pPAT.....set the pattern of the filerequester
  237.                     i.e. '-pMOD#?'.
  238.             -l0/1/M...set the mode of the filter-led.
  239.                     0=force filter off
  240.                     1=force filter on
  241.                     M=module controls filter
  242. Play-Requester
  243. --------------
  244. The Play-Requester contains information about the module and some gadgets.
  245. All versions +2.1 have a new userinterface. There's a main window that
  246. stays at where it is as long as PowerPlayer is running:
  247.  
  248. Questionmark....displays the usual information concerning copyright &
  249.         features.
  250.         Key: '1'
  251. Eject...........ejects the current list of songs & asks you with a
  252.         filerequester for a new one. Key: '2' or 'e'
  253. FirstSong.......will load & play the first song from the list.
  254. PrevSong........will load & play the previous song from the list.
  255.         Key: '3','[','(' or '{' !
  256. Play............will play the song. Will automatically unpause, if you
  257.         hammer the PLAY again the song will start from the
  258.         beginning.
  259.         Key: '4' or 'p'
  260. FastForward.....will play the song twice as fast as normal. This gives a
  261.         nice FF-effect ! Rehammer will switch back to normal speed.
  262.         Key: '5' or 'f'
  263. NextSong........will load & play the next song from the list.
  264.         Key '6','<RETURN>', ']',')' or '}' !
  265. LastSong........will load & play the last song from the list.
  266. Stop............will stop the song. Automatically unpauses, unFFs and
  267.         unplays!
  268.         Key: '7' or 's'
  269. Pause...........stops the song until you repress pause or push play.
  270.         Key: '8' or '<SPACE>'
  271. Reset...........will start the song again.
  272.         Key: '9' or 'r'
  273. RND.............will load & play a randomly chosen song.
  274.         Key: '~' or '/'
  275.  
  276. Almost every gadget has an equivalent on the keyboard (Keys 1-9), ESC and
  277. CTRL-C will exit the PowerPlayer.
  278.  
  279. CTRL-F resizes the window to full size and places it in front of all other
  280. windows.
  281.  
  282. Pressing the right mousebutton will change to the iconify-mode. The window
  283. will shrink to a minimum height of 10 pixels. The gadgets will disappear,
  284. but you can still control PowerPlayer with the keyboard-shortcuts.
  285. To unshrink the window to its normal size you just have to hit the
  286. right mousebutton again.
  287.  
  288. The display of the window contains
  289. -the name of the module (top of window)
  290. -type of the module & length of the module in bytes (middle of window)
  291. -the gadgets and the position-indicator that displays your position in the
  292.  file-list.
  293.  
  294. My GUI works with a recolor-routine that can handle crazy palettes in a clever
  295. way. It searches for the brightest and darkest colors for the shadows and
  296. it searches for the color with the biggest contrast to the background for
  297. text-output.
  298.  
  299. ==============================================================================
  300.  
  301. ARexx support
  302. -------------
  303. PowerPlayer offers an ARexx-Port named "PowerPlayer.REXX".
  304.  
  305. The ARexx-Port supports the following commands:
  306.  
  307. PlEject             acts exactly like the "Eject"-button
  308. PlFirst             acts exactly like the "First"-button
  309. PlPrevious          acts exactly like the "Previous"-button
  310. PlPlay            acts exactly like the "Play"-button
  311. PlFF            acts exactly like the "FF"-button
  312. PlNext            acts exactly like the "Next"-button
  313. PlLast            acts exactly like the "Last"-button
  314. PlStop            acts exactly like the "Stop"-button
  315. PlPause            acts exactly like the "Pause"-button
  316. PlReset            acts exactly like the "Reset"-button
  317. PlRnd            acts exactly like the "Rnd"-button
  318. PlQuit            tells PowerPlayer to quit. Don't try to access the
  319.                         ARexx-Port after this command!
  320. PlLoad "<ModName>"    loads <ModName> and plays it.
  321.  
  322. ==============================================================================
  323.  
  324. The PowerPlayer Music Cruncher
  325. ------------------------------
  326. There are more powerful datacrunchers than the PowerPacker, but LhArc has
  327. got a complex file-format and the IMPLODER has no commentated function in
  328. its explode.library to decrunch FileImploder's datafiles, so I was very
  329. happy to receive the Lh.Library and include my own cruncher/decruncher-
  330. utility (PMC) to the PowerPlayer.  The usage of the PMC is veeeerrry
  331. simple.  You only have to open a CLI/SHELL and then type in PMC, the name
  332. of the file to crunch and finally the name of the destination-file.
  333. Example:
  334.  
  335. PMC df0:modules/MOD.PowerTheme df0:modules/MOD.PowerTheme.LH
  336.  
  337. PMC will then display something like
  338.  
  339. Crunching df0:modules/MOD.PowerTheme, Please stand by !
  340.  
  341. And after an unimportant little time (99 secs) it will display the result:
  342.  
  343.     Result
  344.     ------
  345.     Uncrunched: 214418
  346.     Crunched: 158052
  347.     Percentage: 73
  348.  
  349. PowerPacker crunched the same file in 109 secs, but only crunched it to
  350. 168760 bytes (78 %).  The only advantage of PowerPacker is that it
  351. decrunches in 10 secs (Lh:  14 secs).  I do not want to harm poor ole Nico
  352.  :-) but I think that YOU should crunch with PMC if you don't already have
  353. the PowerPacker.  Or just don't crunch the stuff if you have a harddisk big
  354.  & quick enough with hundreds of free megabytes.
  355. ( I don't have the latter :-( ).
  356.  
  357. It may happen that the percentage is wrong.  This happens if the crunched
  358. file is too big.  The reason for this is the 16 Bit Source of the CPU-Divu
  359. Operation.  Of course, the file is not affected.
  360.  
  361. PMC creates files of the SFHD-Format (Stephan Fuhrmann's High Density :-)
  362. ).  Typical for these files is the 4 bytes ID 'SFHD' at the beginning.  The
  363. 2nd long is the uncrunched length,the 3rd long is the crunched length.
  364.  
  365. I have seen some guys loading up modules on BBSs in the PMC-format.
  366. PLEASE use '.PMC' as suffix and note that they need PowerPlayer to replay.
  367. AND check the BBS wether there's PowerPlayer existing or not, they
  368. won't be very happy if they download the stuff and don't find the
  369. PowerPlayer !
  370.  
  371. An example BBS-entry could look like this:
  372. SONG.PMC    Very good module, use PowerPlayer to replay
  373.  
  374. I recommend uploading the modules in the PMC-format without unimportant
  375. 'trash' in an archive. You don't have to decrunch manually, the file
  376. needs less diskspace (it's still crunched) and there's last but not least
  377. the PMC-format that has been developed ONLY for the PowerPlayer, so you
  378. _NEED_ the PowerPlayer to decrunch ß-} !  By doing this you can show your
  379. consent to the PowerPlayer!
  380.  
  381. ==============================================================================
  382.  
  383. Technical Information
  384. ---------------------
  385. PowerPlayer won't create his own process.  It seems to be a modern feature
  386. to launch everything in the background, but I wanted to give the user the
  387. possibility to stop the computer i.e.  in the startup-sequence as long as
  388. the song plays.  I think this is the best way to realize this, if you want
  389. to create a background process for PowerPlayer you will have to "RunBack"
  390. it yourself !
  391.  
  392. PowerPlayer uses the AUDIO.DEVICE to allocate audio-channels.  I think
  393. PowerPlayer is the only ModulePlayer that does this.  The great advantage
  394. of this method is that PowerPlayer refuses to run when another program uses
  395. the audio-channels.  If you have ever heard the chaos two ModulePlayers
  396. playing simultaneous evoke you will like this feature.
  397.  
  398. ATTENTION!  Do use the NoisePacker-Routine V2.03 with care !  My Amiga
  399. crashes after a while when I play a noisepacked Module.  The programmers of
  400. this replay-routine have done something weird with the CIA that should not
  401. be made in Multitasking.  If you have a CIA-free replayer, give it to me.
  402. Do NOT process important data while and after playing such a module !
  403.  
  404. Since there are sooo many music-proggies for the AMIGA, it is impossible to
  405. include all the existing replays.  To give you and me the possibility to
  406. expand PowerPlayer to the best moduleplayer ever written, I will built in
  407. any replay-routine sent to me, if the following work is done:
  408.  
  409. - Sourcecode of the Music-Routine in ASSEMBLY, PC-Relative if possible.
  410.   At this time I can only include replayers at the base of the
  411.   verticalblank-interrupt. The sourcecode has to be on a 3.5"-disk
  412. - Add a description how to recognize that certain kind of module or other-
  413.   wise simply enclose 3 or more of those modules and I'll find out myself
  414. - In any case,though, I would like you to add 3 or more Songs that can be
  415.   played with your replay, if possible. I have to test the routines, and
  416.   a music-proggy with less than 3 adequate songs is surely not very useful.
  417. - Include an envelope addressed to you, with 5 DM or more (I accept only
  418.   DEUTSCH-MARK, no cheques or other trash like that)
  419. - If the disk has only ONE error, I'll take for granted that you do not want
  420.   it back and shred it. So do use high-quality-disks formatted carefully
  421.   before using (verify) !
  422.  
  423. If you want some cool features added to the PowerPlayer, do this:
  424.  
  425. - Write a detailed letter with all new features you think of
  426. - If you'd like to have the update with all/some features wanted, include
  427.   a disk and an envelope addressed to you
  428. - Include 5 DM (DEUTSCH MARK) for my working on it !
  429.  
  430. If you want an update, do this:
  431. - Include a disk and an envelope addressed to you
  432. - Include 5 DEUTSCHE MARK for all the work !
  433. - I will send you the actual version of PowerPlayer
  434.  
  435. DON'T PANIC when I do not reply your letter at once !  I have not enough
  436. time to spend half the day with my computer.
  437.  
  438. My Address:    Stephan Fuhrmann
  439.         Erikstr. 30
  440.         W-2380 Schleswig
  441.         Germany
  442.  
  443. ==============================================================================
  444.  
  445.         - 80x25 space for rent -
  446.  
  447. ==============================================================================
  448.