home *** CD-ROM | disk | FTP | other *** search
/ Magazyn Amiga Shareware Floppies / ma10.dms / ma10.adf / SPLAY14A / SmartPlay.DOC < prev    next >
Encoding:
Text File  |  1992-11-01  |  14.7 KB  |  332 lines
  1. 92/11/01
  2.  
  3.               Funky DOX for SmartPlay v1.4a by Xtreme Intelligence
  4.              ======================================================
  5.  
  6.  
  7. GENERAL ABOUT SMARTPLAY v1.4:
  8. =============================
  9.  
  10.   Well, this is not just another lame ST/NT/PT player with some faked and
  11.   bugged replayroutines, lousy windows or other crap! Yeah, this really
  12.   small and fast player uses the PT100% replayer with all features from
  13.   old 31 instrument SoundTrackers, Noise/Startrekker and new ProTrackers
  14.   added! No more unwanted effects caused by some f*cked up replayroutine
  15.   made for NT2.0 only..
  16.  
  17.   SmartPlay now also supports a couple of other moduleformats than normal
  18.   ST/NT/PT modules! Read on for more info on supported moduleformats..
  19.  
  20.   Another BIG improvement compared to other players: SmartPlay loads the
  21.   SONGDATA of a ST/NT/PT module to PUBLIC-MEM if possible, and the samples
  22.   are allocated/loaded separately, so you can play songs MUCH larger than
  23.   the largest chipmem chunk!!
  24.  
  25.   So, when all your great players with those nice windows and stuff are
  26.   unable to load your module as one piece into memory, SmartPlayer easily
  27.   loads the samples into your fragmented chipmem! Smart enough?
  28.  
  29.  
  30. GENERAL INFO ON MODULE FORMATS:
  31. ===============================
  32.  
  33.   The main idea with this program is still to play normal tracker modules
  34.   (ST/NT/PT), fast, smooth, and with low chip-memory usage.
  35.  
  36.   However, there are several other useful moduleformats around, so I decided
  37.   to add some more replayroutines to SmartPlay. For this purpose I added a
  38.   "SmartRePlay.library", so if you want to play any other modules than
  39.   ST/NT/PT, you'll need this library in your system! With the SmartRePlay.lib
  40.   v1.1 you are able to play DeltaMusic, JamCracker, FutureComposer, GMOD &
  41.   XMOD modules. To play MED or OctaMED modules, SmartPlay needs the MEDPlayer-
  42.   library v2.0+!
  43.  
  44.   ** More formats will be supported in future releases of SmartPlay.
  45.  
  46.   The main idea with this external shared library, is that you don't need
  47.   to have all the replayroutines loaded into memory just to play a simple
  48.   ST/NT/PT module. You probably have better use for your memory, than to
  49.   store unused replayroutines in it!? I sure hope so.. ;)
  50.  
  51.   Other modules than normal ST/NT/PT will be loaded as one part into chip-
  52.   memory!
  53.  
  54.  
  55. FORMATS SUPPORTED IN SMARTPLAY v1.4:
  56. ====================================
  57.  
  58.      SoundTracker 31 inst. - (No external lib needed!)
  59.      NoiseTracker          -            ""
  60.      ProTracker            -            ""
  61.      Other ST/NT clones..  -            ""
  62.  
  63.      DeltaMusic            - (Needs SmartRePlay.library)
  64.      JamCracker & JCpro    -            ""
  65.      FutureComposer v1.4   -            ""
  66.      FutureComposer v1.0-3 -            ""
  67.      GMOD, XMOD            -            ""
  68.      MED & OctaMED         - (Needs MEDPlayer.library)
  69.  
  70.   PowerPacked modules are NOT supported anymore! Due to the great amount
  71.   of bugs in the PowerPacker.library all those routines have been removed.
  72.   When there is a new version of the PowerPacker.library available (with all
  73.   those bugs removed), SmartPlay will probably support PowerPacked files
  74.   again.
  75.  
  76.  
  77. WHAT'S NEW IN v1.4?
  78. ===================
  79.  
  80.   - CIA interrupt now used as default. Use the VB=VBLANK command to use the
  81.     normal (faster) Vertical Blank interrupt. The CIA interrupt was added
  82.     so people with other sync frequency than 50Hz would be able to use this
  83.     player as well. Playing 50Hz modules with 72Hz sounds really bad.
  84.  
  85.   - PT-Modules using CIA-timing will now work in both VBlank & CIA interrupt
  86.     modes.
  87.  
  88.   - NL=NOLIB command fixed. In v1.3 this command didn't do a thing!
  89.  
  90.  
  91. SMARTPLAY v1.4 SYSTEM REQUIREMENTS:
  92. ===================================
  93.  
  94.      Any Amiga running KS2.0 v37+ (Required to run)
  95.             ReqTools.library v38+ (Required to run)
  96.  
  97.          SmartRePlay.library 1.1+ (Play other than ST/NT/PT modules)
  98.            MEDPlayer.library 2.0+ (Play MED & OCTAMED modules)
  99.  
  100.   The ReqTools.library is Copyright (C) by Nico Francois. Check the file
  101.   DISTRIBUTION.TXT for more information on Nico's copyrights!
  102.  
  103.  
  104. USING SMARTPLAY v1.4:
  105. =====================
  106.  
  107.   SmartPlay is quite easy to use, as it is to be run from CLI only, using
  108.   simple commandline statements and reqtools.library for the userinterface.
  109.   If you are familiar with the OS2.0 DOS-commands you should have no problem
  110.   understanding the template.. 
  111.  
  112.     TEMPLATE: MODULE/M,STOP/S,NEXT/S,FORCE/S,ONCE/S,DIE/S,REPEAT/S,QUIET/S,
  113.               ABOUT/S,INFO/S,VB=VBLANK/S,NM=NOMOUSE/S,NC=NOCONFIG/S
  114.               NR=NOREQ/S,PP=PROCPRI/K/N,IP=INTPRI/K/N:
  115.  
  116.       MODULE: Name of any ST/NT/PT 31 instrument module to play. Multi-
  117.               selection supported. You can fill your commandline with
  118.               modulenames, or use the SHIFT key in the filerequester to
  119.               select multiple modules!
  120.  
  121.               If you want to play all modules in a DIRECTORY, just leave a
  122.               "/" or ":" at the end of the name, and SmartPlay will use the
  123.               MODULE argument as a directory. Check out the NOREQ command
  124.               for use with directories with other files than modules too!
  125.  
  126.               Note: Do NOT specify BOTH modulenames AND directories in the
  127.               same commandline! SmartPlay will use the first name in the
  128.               chain to go in module OR in directory mode! FileRequesters will
  129.               only select modules, NOT directories.
  130.  
  131.               If the modulename is left out, SmartPlay will bring up a file-
  132.               requester, and ask for some modules to play.
  133.  
  134.               * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  135.               NOTE: PowerPacked modules NOT supported at the moment! (Look
  136.               above in this file for more info!!)
  137.               * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  138.  
  139.         STOP: Break current module playing, and quit SmartPlay by sending
  140.               a ^C signal to the process named "SmartPlay" .. Works as any
  141.               DOS "Break" command!
  142.  
  143.               SmartPlay will NOT ask for any more modules to play if you
  144.               use this STOP command. To select a new module, just start a
  145.               new SmartPlay or use the NEXT command. Note: (pressing left+
  146.               right mousebuttons simultaneously will have the same effect
  147.               as the NEXT command - see NOMOUSE for more info!).
  148.  
  149.               Any new SmartPlay started will remove any old SmartPlay present
  150.               in memory before loading/playing. If there is a SmartPlay in
  151.               memory, e.g. waiting in a filerequester, you can't load a
  152.               new SmartPlay before the previos one is gone.
  153.  
  154.         NEXT: Break current module playing, and load next module by sending a
  155.               ^D signal to the SmartPlay process. Equal to Left+Right mouse-
  156.               button stop! If not the DIE or REPEAT commands are set, and
  157.               all modules specified are played, SmartPlay will ask for more
  158.               modules by a filerequester.
  159.  
  160.        FORCE: FORCE SmartPlayer to play ANY file, even if the identifier is
  161.               gone. SmartPlay will only play unknown files in the ST/NT/PT
  162.               replayer, if FORCED to. You can't FORCE SmartPlay to play any
  163.               unknown files in e.g. the DeltaMusic routine!
  164.  
  165.               ** Warning: If you FORCE SmartPlay to play e.g. a textfile,
  166.               SmartPlay MAY guru right up in your face! More likely it
  167.               will tell you "Out of CHIP-MEMORY" while loading, but don't
  168.               use this command if you arn't 100% sure it is a ST/NT/PT
  169.               module you FORCE SmartPlay to play!
  170.  
  171.               ** Note: If you have some modules SmartPlay v1.4 can't play,
  172.               please send some information on the moduleformat to me, so i
  173.               can implement them in future releases. (See the chapter HOW
  174.               TO REACH THE AUTHOR to get my E-Mail address)
  175.  
  176.         ONCE: Stop, and load next module if specified, instead of looping
  177.               the module at last pattern. Doesn't work if the module JUMPS
  178.               in the last pattern! Maybe in some other version.. Check out
  179.               the REPEAT command for more tips&tricks!
  180.  
  181.               >> NOTE << The ONCE command may not work in some module-
  182.               formats! E.g. MED & OctaMED and DeltaMusic replayers will NOT
  183.               be affected by ONCE! To play next module, press both mouse-
  184.               buttons, or use the NEXT command!
  185.  
  186.          DIE: Quit SmartPlay instead of asking for more modules when the
  187.               REPEAT command is left out and all modules are played.
  188.  
  189.       REPEAT: Repeat the chain of multiselected modules (selectied in the
  190.               commandline OR in the multiselect filerequester). This function
  191.               used with the ONCE command will play your selected modules non-
  192.               stop. When REPEAT is enabled, the DIE command will have no
  193.               effect! Stop playing using the STOP command, or by starting
  194.               a new SmartPlay..
  195.  
  196.        QUIET: Same as >NIL:, but will still pass possible errormessages
  197.               to current output. In v1.1a and further versions most errors
  198.               will be shown by reqtools requesters, and wont be affected
  199.               by this command. Use the NOREQ command to turn off any 
  200.               annoying(?) error-requesters.
  201.  
  202.        ABOUT: Display a small about-text with my E-Mail address. Yeah!
  203.  
  204.         INFO: Show some information on current module playing.
  205.  
  206.       VBLANK: VBLANK or VB will force SmartPlay to use a Vertical Blank
  207.               interrupt instead of the CIA interrupt. A VBLANK interrupt
  208.               is FASTER than a CIA interrupt, but e.g. MultiSync monitors
  209.               will change the speed of the VB interrupts! So, CIA is safer,
  210.               and VBLANK is faster. Make your choise..
  211.  
  212.      NOMOUSE: NOMOUSE or simply NM will turn OFF the left+right mouse-
  213.               button stop function. (May be useful if you've got other
  214.               programs using that function)
  215.  
  216.     NOCONFIG: NOCONFIG or just NC will ignore the configfile, and use the 
  217.               commandline arguments only.
  218.  
  219.        NOREQ: NOREQ or NR will turn off ALL error-requesters! Use if you
  220.               are playing a directory containing other files than modules
  221.               too! In this case SmartPlay will quietly skip all unknown
  222.               files, and play all valid modules in your directory.
  223.  
  224.        NOLIB: NOLIB or NL will prevent SmartPlay from playing other than
  225.               normal modules. No external player libraries will be loaded!
  226.  
  227.      PROCPRI: ProcPri or PP will set the priority for the "SmartPlay"
  228.               process. This priority is 0 by default, as SmartPlay may not
  229.               receive the BREAK-signal, and get problems while loading if
  230.               this priority is too low. There should be no real difference
  231.               what priority you use, as this process is just waiting while
  232.               playing the modules. Don't use lower pri than -5 if you want
  233.               SmartPlay to work properly. Any value between 127 and -127
  234.               is accepted as a priority value.
  235.               ** Don't touch if you don't know what it really does..
  236.  
  237.       INTPRI: IntPri or IP will set the priority for the "SPlay-INT" VB-
  238.               interrupt. This option was added coz some programs may get
  239.               some problems with other hi-pri interrupts. Default value
  240.               for this priority is 1.
  241.               ** Don't touch if you don't know what it really does..
  242.  
  243.   Ok, that was the commandline arguments. Now for the configfile format..
  244.   The configfile is named "ENV:SmartPlay.CFG", and will be loaded every time
  245.   SmartPlay is run. If the configfile isn't found, or the NOCONFIG flag is
  246.   set, SmartPlay will use the commandline arguments only.
  247.  
  248.   The configfile is a normal textfile, so you can create/edit it in any
  249.   texteditor (e.g. CygnusEd). This is NOT a script-language! It's more like
  250.   an "additional commandline".
  251.  
  252.   Rules: Only ONE command per line! SmartPlay will skip all extra spaces,
  253.   tabs, and other junk. You can type anything in the file, but only the
  254.   following commands are understood by SmartPlay:
  255.  
  256.   List of supported config commands in v1.4:
  257.  
  258.      QUIET  -  Turn on quiet mode
  259.      FORCE  -     ""   force mode
  260.      ONCE   -     ""   play-once mode
  261.      DIE    -     ""   die-after-play mode
  262.      REPEAT -     ""   repeat mode
  263.      VB     -     ""   vblank interrupt
  264.  
  265.      NOREQ  -  Disable all error requesters
  266.      NR     -     ""   same as above
  267.      NM     -     ""   mousestop while playing
  268.      NL     -     ""   library loading (only ST/NT/PT modules will be played)
  269.  
  270.   Check out the commandline arguments above for more info on these commands.
  271.  
  272.                                  ** ** **
  273.  
  274.   Not too difficult to use, is it? You don't really NEED all those
  275.   parameters to play a simple module - just type "SmartPlay" in the CLI-
  276.   window, and reqtools will take care of you. However, all these arguments
  277.   makes SmartPlay easier to adapt to diffrent needs and systems.
  278.  
  279.   SmartPlay will detach itself from CLI, so there is no need to "RUN" the
  280.   program. If SmartPlay is playing a module when you try to load a new one,
  281.   the previous module will automatically STOP and all memory will be freed
  282.   before loading the next module. No need to use STOP before loading.
  283.  
  284.  
  285. BUGS DEPARTMENT v1.4a:
  286. ======================
  287.  
  288.   - PT1.0 vibrato not supported (I think?). I couldn't get my hands on the
  289.     old ProTracker v1.0 so I couldn't possible check the vibrato command..
  290.     Rumours has there was some fast vibrato, but im not sure about this as
  291.     there are no PT1.0 modules around either..
  292.  
  293.   - The GMOD format is not FULLY supported. SmartPLay will play all GMOD
  294.     modules with 50Hz vblank timing. Portable GMOD modules, and GMOD modules
  295.     with that strange timing not supported! Any 60Hz GMOD modules will go
  296.     50Hz in normal PAL Amigas!
  297.  
  298.   Well, there MAY be other bugs. As usual I'll take NO responsibility for
  299.   possible bugs caused by late-hour coding..
  300.  
  301.   But if you do find any bugs, please contact me at the address below so
  302.   I can fix them in the next version of SmartPlay.
  303.  
  304.  
  305. HOW TO REACH THE AUTHOR:
  306. ========================
  307.  
  308.   Send possible bug-reports, new module formats etc. to the author
  309.   (Xtreme Intelligence) by E-Mail at:
  310.  
  311.      Last Input Ignored (SysOp: Eagle)
  312.      +358-0-5051123
  313.      1200-14400 HST DS /w v32bis & v42bis
  314.      Open 24H / day
  315.  
  316.   ..or E-Mail addressed to Last Input Ignored:s FidoNet Number 2:220/293.
  317.  
  318.   The newest version of SmartPlay is always FileRequestable with the
  319.   MAGIC name "SPLAY" from 2:220/293.
  320.  
  321.  
  322. ANY COPYRIGHTS ON SMARTPLAY v1.4?
  323. =================================
  324.  
  325.   Nope, this is all FREEWARE - I need NO money or support from anyone
  326.   using this program! Spread it, sell it, use it or delete it .. really
  327.   not my problem anymore. I just made it. Thanx.
  328.  
  329.  
  330.                                        - Signed: Xtreme Intelligence 1992
  331.  
  332.