home *** CD-ROM | disk | FTP | other *** search
/ YPA: Your Privacy Assured / YPA.ISO / other_goodies / music / hip200.lha / HippoPlayer.doc < prev    next >
Text File  |  1995-03-19  |  39KB  |  1,145 lines

  1. ******************************************************************************
  2.                             --- HippoPlayer ---
  3.                  Programmed by K-P Koljonen
  4.              (Moonstone / Hippopotamus Design)
  5.  
  6.                    This program may be freely distributed
  7.                 as long as all files are included unaltered! 
  8.                       Not for commercial use without
  9.                        a permission from the author.
  10.             Copyright ⌐ 1994-1995 K-P Koljonen
  11.                               ** FREEWARE **
  12. ******************************************************************************
  13.  
  14.  
  15. HippoPlayer (HiP) is a multiformat module player for the Amiga.  It works
  16. perfectly under Kickstart 1.2 and has all the same and even more features
  17. than the players requiring Kick2.0+ to run.
  18.  
  19. One main reason why I started making this program was that there were no
  20. good Kick1.3 compatible players around, or I didn't know of one.  The other
  21. reason was that my good friend Jarno Paananen (Guru/Sahara Surfers) made a
  22. replay routine for Screamtracker ]I[ modules.
  23.  
  24. The aim was to make a good module player that works on every Amiga
  25. configuration and has lot's of USEFUL features.  To achieve speed, little
  26. size and memory usage, HiP is 100% assembler.
  27.  
  28. "Newcomers will run screaming away", as Nemesis1 stated.
  29. At first HiP may seem complicated.  There's no familiar tapedeck symbols,
  30. only some bits of text scattered around.  Learn to use HiP, it should be
  31. worth the effort :)...
  32.  
  33. HiP has good support for Screamtracker ]I[, Fasttracker 1 & 2, Taketracker,
  34. and Multitracker modules (from here onwards referred as PS3Ms), meaning
  35. that you can listen them with a 68000 Amiga with listenable quality.  All
  36. are played by the famous replayer by Guru.  HiP was the second program to
  37. use the PS3M-routines after Guru's own player.
  38.  
  39.  
  40.  Some features:
  41.  ╖ Screamtracker ]I[, Fasttracker 1 & 2, Taketracker, Multitracker, 1 to 32ch
  42.  ╖ SID-emulation by Hσkan Sundell & Ron Birk (works even on kick1.2)
  43.  ╖ TFMX-modules, normal and the seven channel ones
  44.  ╖ A bunch of 4-8 channel sample & synth music formats
  45.  ╖ Easy to use, nice 3D-interface
  46.  ╖ Keyboard control
  47.  ╖ AppWindow
  48.  ╖ ARexx 
  49.  ╖ Public screen support
  50.  ╖ Internal multitasking
  51.  ╖ Loads and decompresses XPK, FImp, PowerPacker, LhA, Zip and Gzip files
  52.  ╖ Tested on:
  53.      A500/000, kickstart 1.2, 0.5+0.5m memory
  54.      A1200/030, kickstart 3.0, 2+4m memory (with enforcer)
  55.  
  56. HippoPlayer was/is developed on:
  57.     - v1.00-v1.25    A500/010, kickstart 1.3/3.1, 1+2M memory, HD
  58.     - v1.27-v1.40    A1200/020, kickstart 3.0, 2+0M memory, HD
  59.     - v2.00-v?.??    A1200/030, kickstart 3.0, 2+4M memory, HD
  60.  
  61.  
  62. ******************************************************************************
  63. *                           *** Requirements ***                     *
  64. ******************************************************************************
  65. Any Amiga with some memory and Kickstart 1.2 or higher.  Reqtools.library
  66. of any version will be needed for the requesters.  There is kick1.3
  67. reqtools.library included in the archive.
  68.  
  69. In order to...             you need...
  70. ------------------------------------------------------------------
  71. Load XPK files            xpkmaster.library and some sublibs
  72. Load PowerPacker files        powerpacker.library
  73. Load lha, zip and gzip files    to look at 'Archivers'
  74. Play SID files            PlaySID.library
  75. Play 4ch MED modules        medplayer.library v2+
  76. Play 5-8ch MED modules        octaplayer.library v2+
  77.  
  78. All libraries must be copied into Libs: drawer.
  79.  
  80. reqtools.library and powerpacker.library by Nico Franτois.
  81. xpkmaster.library by Urban Dominik Mⁿller (?).
  82. PlaySID.library by Per Hσkan Sundell & Ron Birk.
  83. medplayer.library and octaplayer.library by Teijo Kinnunen.
  84.  
  85.  
  86. Installation
  87. ------------
  88. Copy HiP and the info-file wherever you keep your tools.  If you prefer
  89. MagicWB you should rename HiP_MagicWB.info to HiP.info.  Also copy
  90. reqtools.library in libs:  if it's not there already.
  91.  
  92.  
  93. Font
  94. ----
  95. HiP will use pearl 8 font if it is already in memory (it won't be loaded
  96. from disk), otherwise topaz 8 is used.
  97.  
  98.  
  99.  
  100.  
  101. ******************************************************************************
  102. *                           *** Music formats ***                     *
  103. ******************************************************************************
  104. Here's a list of the music formats HippoPlayer can play and what functions
  105. they support.  Also the authors of the replayers are listed.
  106.  
  107. Stop/Continue    = 1 - The music can be stopped and continued.
  108. Multiple songs   = 2 - Modules can have more than one song.
  109. Volume         = 3 - Volume can be controlled.
  110. End detect     = 4 - Songend can be detected.
  111. Forward/backward = 5 - You can jump forwards and backwards in the song.
  112.  
  113. Replayer            12345    Author
  114. --------------------------------------------------------------------
  115. BP SoundMon v2.0        x-xxx    Brian Postma
  116. Delta Music v2.0        x-x--    Bent Nielsen
  117. Fred                xx---    Frederic Hahn & JC
  118. Future Composer v1.0-v1.4    x-xx-    SuperSero (of the Superions)
  119. JamCracker            x--x-    M. Gemmel
  120. MED 4-8ch            x----    Teijo Kinnunen
  121. Music Assembler            x-x--    Oscar Giesen & Marco Swagerman
  122. Oktalyzer 8ch            --xx-    Armin Sander
  123. Protracker            xxxxx    K-P Koljonen
  124. PS3M                x-xxx    Jarno Paananen
  125. SID                xx--x    Hσkan Sundell & Ron Birk
  126. SIDMon v1.0            x----    Reiner van Vliet
  127. Sonic Arranger            -x---    Carsten Schlote
  128. TFMX                xxxxx    Chris Hⁿlsbeck
  129. TFMX 7ch            xxxxx    Chris Hⁿlsbeck & Jochen Hippel
  130. The Player 6.1A            x-x--    Jarno Paananen
  131.  
  132.  
  133.  
  134.  
  135. Loading files
  136. -------------
  137. Normally all modules will be loaded in CHIP.  SID-, Oktalyzer- and PS3M-
  138. modules and TFMX song data will be loaded in FAST RAM if possible.
  139.  
  140. All compressed files will be loaded in CHIP.  However, it's possible to
  141. uncompress some kilobytes from the beginning of an XPKed file, and check if
  142. it is one of the above or a PT module that is to be played with PS3M or
  143. with fastram replayer.
  144.  
  145. Advantages of loading to FAST:
  146.     FAST RAM is much faster than CHIP, so mixing can be done faster.
  147.     CHIP RAM is saved if the module can or should be loaded in FAST.
  148.  
  149. LhA, Zip and Gzip files can be checked and will be loaded in fast if
  150. necessary.
  151.  
  152.  
  153.  
  154.  
  155. Protracker
  156. -----------
  157. The most popular music format on the Amiga.  HiP features my own Protracker
  158. play routine.
  159.  
  160. - Fastram player
  161.  ╖ Plays modules from fast ram
  162.  ╖ Uses 4x65kb for buffers (TOO much)
  163.  ╖ Doesn't play looped samples with 900 command correctly
  164.  ╖ Doesn't play C-201000 combinations correctly
  165.                 ---02000
  166.  ╖ May have some other bugs too
  167.  ╖ Is VERY fast (about the only positive thing)
  168.  
  169. - Multisong modules
  170. There are some modules around with several songs separated by the B
  171. command.  HiP allows you to play these kind of modules correctly.  Just use
  172. the 'PS' and 'NS' gadgets (or the respective keys) to select different
  173. songs.  The only player that supports this feature, by the way :).
  174.  
  175.  
  176.  
  177.  
  178. TFMX
  179. ----
  180. HiP can play both 4 and 7-channel TFMX modules, including the excellent
  181. Turrican 2 and 3 intro tunes.  A TFMX module consists of two files.  They
  182. must be named 'mdat.<name>' and 'smpl.<name>'.  To play, select
  183. 'mdat.<name>'.  HippoPlayer will then try to load the 'smpl.<name>' file.
  184.  
  185. The mixing rate of TFMX 7 channel replayer can be changed.  The bigger
  186. value, the better quality and bigger CPU load.  I have noticed that mixing
  187. rates 21kHz and 22kHz give somewhat strange results, so I use 20kHz.
  188.  
  189.  
  190.  
  191.  
  192. PS3M 
  193. ----
  194. (Screamtracker ]I[, Protracker, Fasttracker 1 & 2, Taketracker, Multitracker)
  195.  
  196. Jarno Paananen (Guru/Sahara Surfers) has made replayers for these.  It is
  197. able to play 1-32 voices simultaneously by mixing them through four
  198. channels.  The mixing routine is amazingly fast, even on Amiga 500 8
  199. channel modules are very listenable.  The replayer gobbles quite a bit of
  200. memory for it's buffers, so don't be surprised.
  201.  
  202. Mixing rates can be changed.  Again, the bigger value, the better quality
  203. and bigger CPU load.  Using the system friendly mode on A500 will probably
  204. more or less jam the machine, therefore you should use the killer mode for
  205. the best quality.
  206.  
  207. PS3M allows mixing rates higher than 28kHz, which is normally the hardware
  208. limit.  In some AGA screen modes (dblPAL, dblNTSC, atleast) mixingrates can
  209. be upto 56kHz high.  Ofcoz, this doesn't work under OCS/ECS Amigas.
  210.  
  211. These modules can and should be played from FAST RAM.
  212.  
  213. Play mode
  214. - - - - -
  215. Mono        Play all channels on both sides.
  216. Stereo        Normal.
  217. Surround    Play some of the right side on the left and vice versa.
  218. Real Surround    About the same, but uses more memory.
  219. 14-bit stereo    BEST QUALITY, biggest CPU load, largest memory usage and
  220.         lowest volume level.
  221.  
  222.  
  223.  
  224. SID
  225. ---
  226. These are tunes ripped from C64 games & demos.  Both normal file + icon and
  227. one file formats are supported.  The playing is done by PlaySID.library by
  228. Hσkan Sundell and Ron Birk.  Great job dudes!
  229.  
  230. *** Note!  Under Kickstart 1.2/1.3 playsid.library v1.1 does not work
  231. because it uses some Kick2.0+ functions.  I have made a little patch to
  232. bypass the problem.  This patch works ONLY with lib version v1.1 and
  233. Kick1.2/1.3.
  234.  
  235.  
  236.  
  237. ******************************************************************************
  238. *                    *** Gadgets & keyboard controls ****                    *
  239. ******************************************************************************
  240.  
  241.  Keyboard shortcuts are bracketed. 
  242.  
  243.  New    Clear the module list, select new modules and play the first one.
  244.  
  245.  Play    Load and/or play selected module. If nothing selected, pop up
  246.     file requester. [RETURN]
  247.  
  248.  Cont    Continue playing after stop.
  249.  
  250.  Stop    Stop playing.
  251.  
  252.  Eject    Stop playing and free current module. [TAB]
  253.  
  254.  Prev    Load and play previous module. [ARROW RIGHT]
  255.  
  256.  Next    Load and play next module. [ARROW LEFT]
  257.  
  258.  PS    Play previous song. [K]
  259.  
  260.  NS    Play next song. [L]
  261.  
  262.  <    Backward, jump to previous pattern. [,]
  263.  
  264.  >    Forward, jump to next pattern. [.]
  265.  
  266.  Add    Add modules to the end of the list, pop up the file requester. [A]
  267.     When adding files to the list you can also add directories.
  268.     They will be scanned for files.
  269.  
  270.  Del    Delete selected module from the list. [BACKSPACE]
  271.  
  272.  Clr    Clear the list. [D]
  273.  
  274.  Horizontal slider
  275.     Volume controller. [B][N]
  276.  
  277.  ?    Enter the info window. [HELP]
  278.       Samplenames  Displays sample names of MODs, S3Ms, XMs, FTMs and
  279.                MTMs.
  280.       SID-info     Information about SID-modules.
  281.  
  282.                Sample names or SID-info can also be invoked by
  283.                pressing left mousebutton on the leftmost third
  284.                        of the name/type box or the 'I' key. (When there's
  285.                        no info available the info window will be opened.)
  286.  
  287.       Help           Description of gadgets & keyboard shortcuts.
  288.       About           About HiP...
  289.        Exit           Hmm..
  290.  
  291.  Pre    Pop up the prefs window. You can also close it with this button.
  292.  
  293.  Mo    Move the chosen module. [M]
  294.     Removes the module from list allowing you to move around.
  295.     To insert it back press Mo again or Play (or the keys).
  296.  
  297.  In    Insert modules after the selected module. [I]
  298.     This is almost the same as 'Add'.
  299.  
  300.  In + right mousebutton [S]
  301.     Sort list alphabetically. With lot's of files this may be a
  302.     bit slow (bubble sort).
  303.  
  304.  Lp    Load module program. [P]
  305.  
  306.  Sp    Save module program. [W]
  307.  
  308.  The leftmost propgadget
  309.     Scroll module list.
  310.  
  311.  Windowclose-button [ESC]
  312.     Close all windows except requesters and exit.
  313.  
  314.  ** Other keys **
  315.  ARROW UP    Select previous module.
  316.  ARROW DOWN    Select next module.
  317.  SPACE        Toggle play/stop.
  318.  *, (next to RETURN) Randomize and play a module.
  319.  7,8,9,0    Show: time-pos/len-song number, clock, free mem, module name.
  320.  Z              Toggles selected scope.
  321.  F1-F10        Load & play a module or a module prorgram.
  322.  `~ (next to 1)    Zip window (also shows when hidden).
  323.  
  324.  lamiga-lshift-control + h
  325.         Hides HiP and shows when pressed again.
  326.  
  327. *** Keyboard note ***
  328. Press lamiga-lshift-control-<key> to use the HiP-keys WITHOUT first
  329. activating the window.  This is one of the two ways (the other is ARexx) to
  330. control HiP when it is hidden!  Pressing zip window this way will bring the
  331. window to front and activate it.
  332.  
  333. *** File requester note ***
  334. HiP uses the great reqtools-requesters.  To select multiple files click
  335. files with shift pressed!  You can also select directoris when 'Add'ing or
  336. 'In'serting.
  337.  
  338.  
  339. Filebox
  340. -------
  341. Here you can see the module list.  You can select a module by pressing the
  342. left mousebutton on it or by pressing arrows up and down.
  343.  
  344.  
  345.  
  346. Right mousebutton
  347. -----------------
  348. Pressing the right mousebutton or the respective key will shrink the window
  349. so that only the titlebar will be shown.  Press again on the activated
  350. window to expand.
  351. If you somehow lose the window, just load the program again.  If there
  352. already was one HippoPlayer running, it's window will be popped to front
  353. and expanded.  Also pressing lamiga-lshift-control+`~ will pop the window
  354. to front.
  355.  
  356.  
  357.  
  358.  
  359. ******************************************************************************
  360. *                              *** Prefsá****                     *
  361. ******************************************************************************
  362. Here you can configure HippoPlayer by using the gadgets & buttons.  You can
  363. invoke a multiple choice requester by pressing right mousebutton on the
  364. following gadgets:
  365.     ╖ Play
  366.     ╖ Show
  367.     ╖ PS3M mode 2
  368.     ╖ Type of scope
  369. The requesters are somewhat different than in most other programs because I
  370. use only reqtools.library (no MUI :).
  371.  
  372.  
  373. Play
  374. ----
  375.  List repeatedly    Play module list over and over.
  376.  List once        Play list once stop.
  377.  Module repeatedly    Play one module over and over.
  378.  Module once        Play one module once and stop.
  379.  Modules in random order
  380.         Play modules in random order.
  381.         When playing has started, same module will not be played twice
  382.                 unless all modules have been played first.
  383.              
  384. 'Play'  affects  the  replayers  where  the end of the song can be detected
  385. from.
  386.  
  387.  
  388.  
  389. Show (titlebar information)
  390. ----
  391.  Time, pos/len, song    Show playing time, song position/length and
  392.             song number/max song (#n/n) depending of what kind
  393.             of a module is being played.
  394.  Clock            Show clock (24h).
  395.  Free memory        Show free chip and fast in kilobytes.
  396.  Module name        Show module name.
  397.  
  398.  
  399.  
  400. Filter control
  401. --------------
  402. Filter controlled by module, filter forced off or on.
  403.  
  404.  
  405.  
  406. Module directory
  407. ----------------
  408. Here you can enter your module directory or select it by pressing '?'.
  409.  
  410.  
  411.  
  412. Program directory
  413. -----------------
  414. Same as above but for saving module programs.
  415.  
  416.  
  417.  
  418. Screen
  419. ------
  420. Select a public screen.  All HiP's windows and requesters will then be
  421. opened on the defined screen.  If the screen is not available, default
  422. screen will be used (usually Workbench).
  423.  
  424.  
  425.  
  426. Protracker tempo
  427. ----------------
  428. Enable or disable Protracker tempo command.  Use on old modules that use
  429. speeds higher than $1F.
  430.  
  431.  
  432.  
  433. PT replayer
  434. -----------
  435. Normal:  Use normal Protracker replayer to play modules from CHIP RAM.
  436. Fastram: Play PT modules from FASTram.
  437. PS3M:     Use Guru's PS3M to play modules from CHIP or FAST.
  438.      This way you can use those neat modes, eg listen Protracker
  439.      modules with real surround.
  440.  
  441.  
  442.  
  443. Scopes
  444. ------
  445. Select one of the seven scopes by clicking the gadget.  The 'Scope on/off'
  446. button will start it up.  You can close a scope by closing it's window or
  447. clicking the gadget again.
  448.  
  449. These are for Protracker-modules only:
  450.  
  451. Quadrascope (& bars)
  452.  -  This  is  just  like  the  one in Protracker.  Channel order:  1,2,3,4.
  453. Hipposcope (& bars)
  454.  - Couldn't invent a better name.. Bass-sounds look nice with this one.
  455.    Channel order: 1,2,3,4.
  456. Frequency analyzer (& bars)
  457.  - This one's more processor intensive.  There is one for the left and the
  458.    right side. It is supposed to display frequencies while not using
  459.    period values. This is not FFT, but is based on Guru's strange idea...
  460.    Bass-sounds are on the left and treble-sounds on the right.
  461.    Bar channel order: 1,4,2,3.
  462. Patternscope
  463.  - Protracker-emulator... Shows pattern data, four fake VU-meters and four
  464.    tiny periodboxes.
  465.    Channels: 1,2,3,4.
  466. Bars
  467.  - These will try to visualize the volume and the period of each channel.
  468.    The vertical position represents sample period and the width sample volume.   
  469.  
  470. There  are  almost  the  same  scopes  for PS3M:  Quadrascope (stereoscope,
  471. actually), hipposcope and frequency analyzer.  No bars.
  472.  
  473. The  scopes  will  need some kilobytes of memory for buffers.  They are run
  474. with priority of -30 so that they won't interfere with anything important.
  475.  
  476.  
  477.  
  478. TFMX rate
  479. ---------
  480. Mixing rate for the 7-channel TFMX replayer.
  481.  
  482.  
  483.  
  484. Timeout
  485. -------
  486. Set playing time (mins:secs).  Disabled in the leftmost position.  Timeout
  487. can affect all modules or only those from which the end can't be detected
  488. from.  You can select this by pressing 'Timeout'.
  489.  
  490. Example:  Play Protracker-modules until they end and PSIDs for, say 3
  491. minutes.  Or you can play all kinds of modules for only 30 secs (intro scan
  492. :).
  493.  
  494.  
  495.  
  496. Filebox size
  497. ------------
  498. Define the number of files showed simultaneously in the main window.
  499. Minimum is 3 and maximum is 50 (will need a BIG screen).  If the value is
  500. too big for the current screen, it will be truncated.
  501.  
  502.  
  503.  
  504.  
  505. Archivers (LhA... Zip... Gzip...)
  506. ---------
  507. HiP can decompress and play LhA, Zip and Gzip files.  You need to specify a
  508. path, a command and options for each.
  509.  
  510. LhA, Zip and Gip archives will be extracted into a file right after '>'
  511. (output redirection).  The %s means the name of the archive to be opened.
  512. The output file can be placed somewhere else than in RAM:  if you don't
  513. have enough memory.
  514.  
  515. You need: LhA, UnZip or Gzip, according to what kind of packed files you have
  516.       (be sure they really are where you defined them to be),
  517.       and 'Run' command in C:.
  518.  
  519. These kind of files are identified by checking the name.  LhA files have
  520. suffix '.lzh' or '.lha', zip files '.zip', and gzip files '.z' or '.gz'.
  521.  
  522. ** Hint **
  523. - Archived files may be packed with XPK, FImp or Powerpacker.  For example,
  524. you could use xpkDLTA to encipher a module and then LhA it.  Gives very
  525. good compression of sound related data.
  526.  
  527. ** LhA hint **
  528. - You can store both TFMX mdat.  and smpl.  files in one archive!  Just
  529. remember that the files MUST BE unpacked before archiving and mdat file
  530. MUST BE added into archive first!
  531.  
  532.  
  533. Archiver commands
  534. -----------------
  535.  
  536. LhA -> c:lha >RAM:virtahepo p -qMNIQw "%s"
  537. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  538. c:lha        the program lha and complete path
  539. >RAM:virtahepo    A file where decompressed data will be stored.
  540.         Can be placed for example on HD (>dh1:temp/rhinocerus)
  541. p        Print files to stdout, in other words in file after the '>'.
  542. -qMNIQw        q    be quiet
  543.         M    no autoshow files
  544.         N    no progress indicator
  545.         I    ignore LHAOPTs variable
  546.         Qw    disable wildcards
  547. "%s"        The %s will be replaced with archive name.
  548.  
  549. Zip -> C:unzip >RAM:virtahepo -cqq "%s"
  550. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  551. -cqq    c    extract files to stdout.
  552.     qq    be very quiet
  553.  
  554. Gzip -> c:gzip >RAM:virtahepo -cdq "%s"
  555. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  556. -cdq    c    write to stdout, keep original files unchanged
  557.     d    decompress
  558.     q    be quiet
  559.     
  560. You can also use other programs for uncompressing.
  561. Example:    LhA -> c:lhx >RAM:virtahepo p -qMNQw "%s"
  562.  
  563. Gzip note:  Being a UNIX program, Gzip will need a considerable amount of
  564. stack for not crashing.  You should set the size of the stack with 'stack
  565. <stacksize>' command.  Something like 20000-50000 should be ok.
  566.  
  567.  
  568.  
  569.  
  570. PS3M settings
  571. -------------
  572. This replayer (by Guru/S2) can play S3Ms, XMs, FTMs, MODs and MTMs.
  573.  
  574. State/buf (System state / buffer size):
  575.     System - Allow multitasking when playing.
  576.     Killer - Disable system and stop almost all DMA to get the best
  577.                  quality. The blue flickering represents free CPU time.
  578.          Stop playing by pressing mousebuttons.
  579.     Buffer - 4kB, 8kB, 16kB, 32kB mixing buffer size.
  580.          Smaller buffer gives faster response, but decreases the
  581.          "backup" buffer possibly causing more "skipping".
  582.  
  583. Play mode:     Playing modes (see the PS3M doc for more info, or just
  584.                 try them out)
  585.  
  586. Volume boost:
  587.     Makes the sound clearer and louder (use when 8 or more channels)
  588.  
  589. Mrate (mixing rate):
  590.     Mixing rate in kHz.
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597. Fade volume
  598. -----------
  599. This will cause those replayers that support volume to fade music in and
  600. out.
  601.  
  602.  
  603.  
  604. Hotkeys
  605. -------
  606. Enable/disable lamiga-lshift-control-<key> keys.  This hotkey-combination
  607. may conflict with other programs, so be aware.
  608.  
  609.  
  610.  
  611. Doubleclick
  612. -----------
  613. When enabled, a module can be loaded and played by doubleclicking on it.
  614.  
  615.  
  616.  
  617. Center name
  618. -----------
  619. When enabled, chosen module will be centered in the filebox.
  620.  
  621.  
  622.  
  623. XPK identify
  624. ------------
  625. When on, all XPKed files will be checked if they should be loaded in FAST
  626. memory.  You should set this if you listen to modules played by PS3M.
  627.  
  628.  
  629.  
  630. Continue on error
  631. -----------------
  632. Errors that occur while loading will be ignored, file will be skipped and
  633. the next one will be loaded.  Beware!  You must have at least ONE module in
  634. the list that can be loaded!  Otherwise HiP may be left stuck in a loop
  635. trying to load modules and always failing.
  636.  
  637.  
  638.  
  639. Doublebuffering
  640. ---------------
  641. Normally when loading a module the one that is playing is ejected.  With
  642. this button you can force HiP to play the current module and load the next
  643. one at the same time.  Useful for floppydisk users, no delays between
  644. playing.  Doublebuffering needs memory for two modules, so if you have
  645. memory problems switch this off.  Doublebuffering may also fragment memory.
  646.  
  647.  
  648.  
  649. Nasty audio
  650. -----------
  651. Select allocation priority of the audio channels.  When on, no program
  652. except HiP can use the channels.  PS3M uses maximum priority at all times.
  653.  
  654.  
  655.  
  656. Priority
  657. --------
  658. Select the main program priority:  -1, 0, +1.
  659.  
  660.  
  661.  
  662. Startup
  663. -------
  664. When enabled, HiP will start playing immediately on startup.  The module or
  665. the program to be played can be chosen by clicking the 'Startup' gadget.
  666.  
  667.  
  668.  
  669. Function keys
  670. -------------
  671. You can install a module or a module program for each of the function keys
  672. (F1-F10) by clicking this gadget.  Then when you press a fkey, the
  673. corresponding module program or module will be loaded and played.
  674.  
  675.  
  676.  
  677. Save, Use, Cancel
  678. -----------------
  679. I guess you can guess these.  If you close the prefs window, it's same as
  680. 'Cancel'ling.  The prefs-file will be saved in the S:  directory.
  681.  
  682.  
  683.  
  684.  
  685.  
  686. ******************************************************************************
  687. *                        *** Command line options ***                  *
  688. ******************************************************************************
  689.  
  690. Add modules to the list
  691. -----------------------
  692. HiP  <file2> <file2> ... <file16>
  693.  
  694. All the files will be added to the list and the first one will be played.
  695. Existing list will be cleared.
  696.  
  697.  
  698. Load a module program
  699. ---------------------
  700. HiP PRG <module program>
  701.  
  702. The program will be loaded and the first module will be played.  If the
  703. playmode is set as 'Modules in random order', then a random module will be
  704. picked and played.  Existing list will be cleared.  (The PRG-keyword is not
  705. necessary, but is faster.)
  706.  
  707. All filenames must be entered with full paths!
  708.  
  709. **** NOTE THIS:  You can also do these things while HiP is ALREADY running!
  710. This allows you to use HiP as a command line module player.  Eg in
  711. Directory Opus it makes a good play button.
  712.  
  713.  
  714. Hide on startup
  715. ---------------
  716. HiP HIDE [other parameters]
  717.  
  718. HIDE makes HiP even more a command line player.  It will force HiP not open
  719. it's window.  Also reqtools.library is not needed (it will be loaded later
  720. if the window is opened).  HiP can be controlled with hotkeys (if enabled)
  721. and/or ARexx if the window is not opened.
  722.  
  723.  
  724. Quit
  725. ----
  726. HiP QUIT
  727.  
  728. If there is already HiP running, it will be terminated.
  729.  
  730.  
  731.  
  732. ******************************************************************************
  733. *                              *** ARexx ***                           *
  734. ******************************************************************************
  735. HiP has an ARexx port 'HIPPOPLAYER'.  It will be initialized at startup IF
  736. RexxMaster is found running.  Works (ofcourse) on Kick1.3 too.  There are
  737. some simple ARexx-examples in the ARexx-dir.
  738. *** Note!  The ARexx-interface and commands are not very thoroughly tested.
  739. If there appears any misbehaviour, tell me please!
  740.  
  741. Parameters in [] may be omitted, parameters in <> may not!
  742.  
  743. CHOOSE <num>        Choose file number <num> in list.
  744. ADD [file]        Add file [file] to list. If not specified, open
  745.             file requester.
  746. DEL            Delete chosen file from list.
  747. CLEAR            Clear list.
  748. MOVE <num>        Move chosen module after file number <num>.
  749. INSERT <file>        Insert file <file> after chosen file.
  750. SORT            Sort file list.
  751. LOADPRG [file]        Load program [file]. If not specified, open
  752.             file requester.
  753.  
  754. PLAY [file]        Clear list and play file [file]. If not specified,
  755.             open file requester.
  756. EJECT            Stop playing and free current module.
  757. STOP            Stop playing.
  758. CONT            Continue playing after stop.
  759. PLAYSONG <num>        Play song number <num>.
  760. RANDPLAY        Pick a random module and play it.
  761. FFWD            Jump forwards in song.
  762. REW            Jump backwards in song.
  763. VOLUME <vol>        Set volume <vol> (0-64).
  764.  
  765. QUIT            Close all windows and exit program.
  766. ZIP <0/1>        0: small main window, 1: normal main window
  767. HIDE <0/1>        0: hide main window, 1: show main window
  768. PUBSCREEN <screen>    Set public screen for HiP's windows & requesters.
  769.             Note that this is case sensitive.
  770.  
  771. TIMEOUT <secs>        Set timeout (0-600 secs).
  772. PS3MBOOST <value>    Set PS3M volume boost (0-8).
  773. PS3MMODE <mode>        Set PS3M mode. 1: surround, 2: stereo, 3: mono,
  774.             4: real surround, 5: 14-bit stereo.
  775. PS3MRATE <rate>        Set PS3M mixing rate (5000-56000).
  776.  
  777. LOADPREFS <file>    Load prefs file. Restart HiP with the new settings.
  778.             HiP only saves prefs to S:HippoPlayer.prefs, so
  779.             you have to collect them manually somewhere for
  780.             ARexx-usage.
  781.  
  782. GET <xxxx>    With this command you can get different information from HiP.
  783.         The <xxxx> can be one of the following:
  784.         xxxx:    result:
  785.         PLAY    0 if not playing, 1 if playing.
  786.         CFIL    Number of chosen file, 0 if none chosen.
  787.         NFIL    Number of files in list.
  788.         CURR    Number of loaded module.
  789.         NAME    Module name.
  790.         TYPE    Module type.
  791.         CNAM    Name of chosen file.
  792.         CSNG    Current song number.
  793.         NSNG    Number of songs available.
  794.         CSPO    Current song position.
  795.         MSPO    Maximum song position.
  796.         FNAM    Full name of loaded file.
  797.         COMM    Comment for loaded file.
  798.         SIZE    Size of loaded file.
  799.             
  800.         
  801.  
  802. ******************************************************************************
  803. *                              *** History ***                           *
  804. ******************************************************************************
  805. Read this!  Some things are not mentioned elsewhere!
  806.  
  807.  
  808. v1.00    Works...
  809.     I couldn't check the bug I suspected because a friend of
  810.         mine wanted to upload the program everywhere. This bug causes
  811.     memory to get fragmented when loading XPK files.
  812.  
  813. v1.01    No major bugs left..
  814.  
  815. v1.10   ╖ Removed some small bugs here and there.
  816.     ╖ A description of the gadgets in the program.
  817.     ╖ Support for multisong Protracker modules.
  818.         ╖ Replayer which plays S3M/FTM/MOD/MTM modules, by Guru (jee).
  819.     ╖ Load/save module program.
  820.     ╖ Commandline options.
  821.     ╖ Four scopes.
  822.     ╖ Communication between most of HiP's processes. All windows except
  823.           reqtools requesters will be closed when the main window is closed.
  824.     ╖ Window positions will be saved in the prefs-file. Also the state
  825.       of the scope (on/off) will be saved.
  826.     ╖ Doesn't interfere with serial transfers on slower Amigas anymore.
  827.           Exceptions are MED, TFMX, The Player.
  828.           They use their own way of timing (level 6 here I come).
  829.         ╖ Works correctly on both PAL and NTSC.
  830.     ╖ Behaves more intelligently with bigger fonts, eh...
  831.     ╖ If playingmode is 'Random', Next/Prev will randomize a new
  832.       module instead of what they would normally do.
  833.     ╖ Removed a bug in ProTracker's arpeggio.
  834.     ╖ Newlook propgadgets on Kickstarts 2.0+.
  835.     ╖ FutureComposer end-detect.
  836.  
  837. v1.11    ╖ Now should work on 50/60/72Hz screens correctly.
  838.     ╖ New icon (less eyesore?).
  839.     ╖ Filter control in Prefs.
  840.     ╖ Doesn't try to open windows over screen's borders.
  841.     ╖ Info window, in which an option to show samplenames.
  842.     ╖ TFMX channel autodetect.
  843.     ╖ New PS3M -> Mixingrate: 5-56 kHz, volumeboost: 0-8
  844.     ╖ Lotsa fixes'n stuff.
  845.  
  846. v1.12 (19.7.1994)
  847. -----------------
  848.     ╖ Fixes'n stuff part 2.
  849.     ╖ New scope: Frequency analyzer
  850.     ╖ More stuff in info window.
  851.     ╖ New formats: The Holy Noise, MED 5-8 channels.
  852.     ╖ Executable size (and memory usage) reduced.
  853.       Achieved this by packing nearly all the replayers.
  854.     ╖ Removed a bug that caused PT vibratos to disappear. This bug
  855.       was created when I removed the arpeggio-bug. Hmm..
  856.     ╖ More informative loading phase.
  857.     ╖ Enables/disables gadgets according to current replayer.
  858.     ╖ New prefs design.
  859.     ╖ Modulebox can now contain 8 names.
  860.     ╖ Titlebar information printed with SetWindowTitles().
  861.     ╖ PT modules can be played from FAST RAM.
  862.     ╖ End-detect: JamCracker, Oktalyzer, SoundMon v2.0.
  863.  
  864. v1.14 (30.7.1994)
  865. -----------------
  866.     ╖ Fixed a bug in 'del' (caused a crash sometimes).
  867.     ╖ Almost full keyboard control.
  868.     ╖ New formats: Delta Music v2.0, Sonic Arranger.
  869.     ╖ Some enchancements in the filebox and in the slider.
  870.     ╖ PS3M now frees ALL buffers needed for playing.
  871.     ╖ LhA, Zip & Gzip compatibility.
  872.     ╖ Added a clock (titlebar info).
  873.  
  874. v1.15 (5.8.1994)
  875. ----------------
  876.     ╖ A couple of fixes here and there.
  877.     ╖ Next/prev working fine again.
  878.     ╖ Added a key for random play.
  879.  
  880. v1.16 (12.8.1994)
  881. -----------------
  882.     ╖ LhA/Zip/Gzip filehandling much better.
  883.     ╖ A bug in samplenamesroutine fixed.
  884.     ╖ PS3M priority reduced from 2 to 0.  
  885.     ╖ PS3M system friendly mode end-detect (S3M, FTM, MOD, MTM).
  886.     ╖ Show free memory in titlebar.
  887.     ╖ SoundMon v2.0 bug fixed.
  888.     ╖ Stringgadgets' fontbug corrected (hopefully).
  889.     ╖ Volumeboost controlled with propgadget.
  890.     ╖ Scope priority from -5 to -30.
  891.     ╖ Priority selector in prefs (for mainprogram).
  892.     ╖ Startup errormessages.
  893.     ╖ Memory usage reduced 5kb compared to v1.15
  894.  
  895. v1.17 (?.8.1994)
  896. ----------------
  897.     ╖ Some fixes.
  898.     ╖ Numerous bugs seemed to appear in v1.16. Hunt in progress..
  899.       Removed one in TFMX 7ch interface.
  900.       SoundMon v2.0 bug removed (again, was not fixed in v1.16).
  901.  
  902. v1.18 (22.8.1994)
  903. -----------------
  904.     ╖ Bughunt continues.
  905.       Several removed and among them one that possibly scrambled memory.
  906.     ╖ Non-existent doublebuffering changed to fade volume.
  907.  
  908. v1.19 (?.?.1994)
  909. ----------------
  910.     ╖ No volume fading when tune ends while using randomplay.
  911.     ╖ PS3M priority changed again, this time to +1.
  912.     ╖ Windowcoloring.
  913.     ╖ PT replayer still had bugs left: vibrato & tremolo were too
  914.       strong! Fixed.
  915.     ╖ No more H.P.Lovecraft.
  916.  
  917. v1.20 (2.9.1994)
  918. ----------------
  919.     ╖ LhA/Zip/Gzip enchanced and some bugs removed.
  920.     ╖ New backround color looked wrong on 8+ color screens. Fixd.
  921.     
  922. v1.23 (?.9.1994)
  923. ----------------
  924.     ╖ SID support! Now you can listen all those cool C64 tunes!
  925.     ╖ Samplenames => Moduleinfo. Now also info about SID modules.
  926.     ╖ Open moduleinfo window also by pressing left mousebutton on the
  927.       name/type box or pressing 'I'.
  928.  
  929. v1.25 (13.9.1994)
  930. -----------------
  931.     ╖ Major changes in LhA/Zip/Gzip interface. Should work OK, finally.
  932.       The version in v1.15 onwards really acted strange!
  933.     ╖ Stereoscope for PS3M, might not work very well though.
  934.  
  935. v1.28 (21.10.1994)
  936. ------------------
  937.     ╖ The timer will wrap properly now.
  938.     ╖ All replayers excluding PT and PS3M didn't work on 68040 because
  939.       of the copyback-cache. Should work OK now.
  940.     ╖ Timer and pos/len are now shown at the same time.
  941.     ╖ Moduleinfo reorganized. All PT samplenames in same window.
  942.  
  943. v1.30 (7.11.1994)
  944. -----------------
  945.     ╖ Fixed a very silly bug (changed the volume depending on the size
  946.       of the module being played!).
  947.     ╖ New scope: SID.
  948.     ╖ Improved Shell interface. Allows HiP to be more a commandline
  949.       moduleplayer.
  950.     ╖ Time, pos/len and song number shown at the same time.
  951.     ╖ The timer uses DateStamp().
  952.     ╖ Requesters use the same font as the mainprogram.
  953.     ╖ Some gfx bugs fixed.
  954.     ╖ NEW VERSION OF THE PS3M! Mixingroutines for 68000 and 68020++. 
  955.       Faster and more beautiful! Stop/cont/fastforward/rewind etc.
  956.     ╖ Two more scopes for PS3M.
  957.     ╖ Removed The Holy Noise.
  958.     ╖ The Player version increased to v6.1A.
  959.     ╖ When a module jumps backwards it is considered ended. Works with
  960.           PS3M and ProTracker.
  961.  
  962. v1.31 (12.11.1994)
  963. ------------------
  964.     ╖ Several not so serious bugs fixed.
  965.     ╖ After playing TFMX 7c tunes, programs using lev4 interrupt crashed
  966.       (like PS3M). Fixed.
  967.     ╖ Some Prefs-window reorganization.
  968.     ╖ Hippoicon by Tommi Lindstr÷m (Hawk/Hippopotamus Design).
  969.         
  970. v1.32 (18.11.1994)
  971. ------------------
  972.     ╖ Pressing "Play" on the module currently being played caused
  973.        HiP to load next module (in list-playmodes).
  974.     ╖ Module program directory saved in the prefsfile.
  975.     ╖ Samplenameviewer works OK, no more garbage.
  976.     ╖ Some PS3M bugs removed (stop-eject=no guru).
  977.     ╖ ProTracker replayer can cope with a bit mutated modules too.
  978.  
  979. v1.33 (7.12.-94)
  980. ----------------
  981.     ╖ Unofficial release...
  982.  
  983. v1.34 (11.12.-94)
  984. -----------------
  985.     ╖ Numerous fixes here and there.
  986.     ╖ BPSoundMon enchancements: position/length, ffwd and rew, volume.
  987.     ╖ More info in the infowindow.
  988.     ╖ Number of subsongs checked: TFMX, TFMX 7c, Fred.
  989.     ╖ When there's no "moduleinfo" available and the left mousebutton is
  990.       pressed on the left third of the textbox, infowindow will be opened.
  991.     ╖ TFMX & TFMX 7c enchancements: position/length, ffwd and rew,
  992.           songend.
  993.     ╖ Sometimes PS3M didn't start to play in killermode (my fault). Fixed.
  994.     ╖ New design in the main window.
  995.     ╖ Amount of files showed in the main window now selectable.
  996.     ╖ Amount of songs (if available) shown after current songnumber.
  997.     ╖ Some samplenameviewer bugs removed.
  998.     ╖ IMPORTANT: Versions 1.30 to 1.33 didn't work on A500 or A600,
  999.       in other words on 68000. This version should work OK.
  1000.  
  1001. v1.35 (2.1.-95)
  1002. ---------------
  1003.     ╖ Samplenameviewer still had a bug! Vanquished it!
  1004.     ╖ New scope for ProTracker: patternscope.
  1005.     ╖ Prefs: doubleclick, center name, some gfx changes,
  1006.              multiple choice requesters with RMB.
  1007.     ╖ Stringgadgets in prefs will only accept fonts of size 8 or
  1008.       smaller. No more trash.
  1009.      ╖ Aargh! Stupid LhA command mistake corrected! %s" -> "%s" !
  1010.     ╖ ProTracker replayer caused Enforcer hits! Fixed...
  1011.     ╖ Module name shown in the title of the samplenamewindow.
  1012.     ╖ Removed that little window when opening LhA, zip and gzip files.
  1013.     ╖ ProTracker: Songnumber not shown and NS/PS gadgets disabled
  1014.       when there's only one song in module (most modules have only
  1015.       one song).
  1016.     ╖ Removed the SID scope. It was "illegal" as it used some
  1017.           undocumented functions in the playsid.library. 
  1018.     ╖ Removed the PT fastram player. It was terrible.
  1019.     ╖ TWO SERIOUS BUGS REMOVED! When playing ProTracker modules
  1020.           (or alike), my PT replayer and Guru's PS3M sometimes
  1021.       scrambled system's memorylist! Aargh (part 2)!!
  1022.     ╖ Found more bugs in the PT replayer. I have been using it for
  1023.       two years and there's still bugs left... Some effect commands
  1024.           weren't played correctly while notedelaying (EEx). Fxd.
  1025.     ╖ Player v6.1A: Stop/cont working again. 
  1026.  
  1027. v1.38 (9.1.1995)
  1028. ----------------
  1029.     ╖ Oktalyzer modules played wrong on non-50Hz screens. Fixed.
  1030.     ╖ One TFMX 7c interface bug removed.
  1031.     ╖ Added startup play.
  1032.     ╖ Added load & play module or program by pressing the function
  1033.       keys.
  1034.     ╖ No need to have PRG in front of the filename anymore when loading
  1035.       programs via commandline.
  1036.     ╖ Programs can be loaded with New/Play.
  1037.     ╖ File & directoryrequesters use the font defined in system's prefs.
  1038.     ╖ Fixed one bug in PS3M (divide by zero-exception when playing S3Ms).
  1039.  
  1040. v1.39 (12.1.1995)
  1041. -----------------
  1042.     ╖ Quick bug fix! Damn I'm stupid! v1.38 doesn't work on 68000,
  1043.       this version does.
  1044.     ╖ The main window is now an AppWindow! Now you can drop modules and
  1045.       module programs on the window and they get loaded and played.
  1046.       This feature is for kick2.0+ only.
  1047.  
  1048. v1.40 (21.1.1995)
  1049. -----------------
  1050.     ╖ The terrible fastramplayer is back. Works somehow.
  1051.     ╖ Prefs: Show module name in titlebar, set playing time (timeout).
  1052.     ╖ Works better with arc-handler (ARC:).
  1053.     ╖ Killed a killer bug in the PT replayer.
  1054.     ╖ LhA enchancement: Load both TFMX mdat and smpl files from one
  1055.       archive.
  1056.  
  1057. v2.00 (19.3.1995)
  1058. -----------------
  1059.     * ARexx support
  1060.     * Public screen support
  1061.     * Keyboard control changes: you can use the keys without activating
  1062.       the window first by pressing lamiga-lshift-control-<key>.    
  1063.     * New PS3M: support for Fasttracker 2 (XM) modules.
  1064.     * Improved outlook.
  1065.     * Patched playsid.library so that it's possible to play SID-tunes
  1066.       also on kick1.2/1.3.
  1067.     * Prefs: continue on error, hotkeys, nasty audio, doublebuffering,
  1068.              program dir selector.
  1069.     * Main window: move, insert, sort (hidden under insert)
  1070.     + Timeout has now two modes.
  1071.     + You can 'Add', 'New' and 'In' directories.
  1072.     + New The Player v6.1a replayer.
  1073.     + PT replayer causes no serialstops.
  1074.     + Command line: HIDE, QUIT.
  1075.     + Prefs: PS3M volume boost has immediate effect on music.
  1076.     + Included some support progs.
  1077.     ╖ PSID-files are loaded in public mem if possible.
  1078.     ╖ HiP can be hidden with lamiga-lshift-control+h.
  1079.     ╖ Key for toggling current scope.
  1080.     ╖ Uses less CPU than v1.40 when not playing.
  1081.     ╖ Filebox routines optimized & jump scroll with shifts.
  1082.     ╖ New algorithmic random generator (thanks Thomas!).
  1083.     ╖ If PT replayer is set as 'Fastram', modules smaller than
  1084.       the replayer's chip buffers (256kb) will be loaded in chipram.. :)
  1085.     ╖ Recognizes .Lha .lHa .lHA like suffixes too.
  1086.     ╖ Only 8 channel Oktalyzer-tunes are loaded in fast ram.
  1087.     ╖ Faster gadget disabling/enabling (OffGadget() was sloooow).
  1088.     ╖ Fixed and enforcer hit when toggling prefs window.
  1089.     ╖ Bug fix in the doc: the player table had some wrong info.
  1090.     ╖ General good stuff and nice things.
  1091.         
  1092.  
  1093.  
  1094. ******************************************************************************
  1095. *                               *** Thanks ***                           *
  1096. ******************************************************************************
  1097.  
  1098. Jarno Paananen (Guru/Sahara Surfers)
  1099. - Hi pal! Thanks very much for the PS3M and everything else!
  1100.  
  1101. Nico Franτois
  1102. - For the great reqtools.library!
  1103.  
  1104. Ron Birk & Per Hσkan Sundell
  1105. - For making almost perfect SID-emulation.
  1106.  
  1107. Tommi Lindstr÷m & Richard Harris
  1108. - Tommi for the face portrait and Richard for the 8-color icon.
  1109.  
  1110.  
  1111. In alphabetic order:
  1112. --------------------
  1113. Fredrik Andersson
  1114. Arto Ikola
  1115. Agust Arni Jonsson
  1116. Kari JΣrvi÷
  1117. Zdenek Kabelac
  1118. Aki Laukkanen
  1119. Paul Petershagen
  1120. Morten Wilken Rasmussen
  1121. Thomas Schuerger
  1122.  
  1123. Thanks for all the ones who have sent me bug reports and suggestions!
  1124.  
  1125.  
  1126. ******************************************************************************
  1127. *                                *** About ***                           *
  1128. ******************************************************************************
  1129. The program was made by using Asm-Ones v1.06/1.09/1.25.  Pure assembler
  1130. 100%+++.  Sourcecode length without any includes or play routines = 265kb.
  1131.  
  1132. Bug reports, comments & suggestions, module swapping and C-64 wares are
  1133. welcome!
  1134.  
  1135.   Kari-Pekka Koljonen
  1136.   Torikatu 31
  1137.   40900 SΣynΣtsalo
  1138.   Finland
  1139.  
  1140.  E-mail: k-p@jybox.jyu.fi
  1141.      Kari-Pekka_Koljonen@sonata.fipnet.fi
  1142.      (use the latter if you get no reply from jybox)
  1143.  
  1144.  Finns phone: 941-3742699
  1145.