home *** CD-ROM | disk | FTP | other *** search
/ Sound Sensations! / sound_sensations.iso / mod / spplay / spp.doc next >
Text File  |  1992-03-09  |  18KB  |  526 lines
  1.             SuperProPlay v1.2
  2.  
  3.                By Joshua C. Jensen
  4.  
  5.                    Release Date: March 2, 1992
  6.  
  7.  
  8.      I. QUICK START
  9.      ---------------------------------------------------------
  10.      Assuming you have already dearchived SuperProPlay, just
  11.      type:
  12.  
  13.        SPP
  14.  
  15.      at the DOS prompt.  Everything else is automatic!
  16.  
  17.  
  18.      II. INTRODUCTION
  19.      ---------------------------------------------------------
  20.      SuperProPlay allows you to play Amiga Soundtracker,
  21.      Noisetracker, 4 channel Startrekker, and Protracker modules
  22.      on a PC (10Mhz+, 12 mhz for optimum performance).
  23.  
  24.      SuperProPlay is written completely in assembly and is now
  25.      6,400 lines in length.
  26.  
  27.      IIa. WHAT ARE THESE THINGS CALLED MODULES?
  28.      ---------------------------------------------------------
  29.      A module consists of 15 or 31 "samples" and a 4 channel
  30.      music score.  The samples are actual digitized sounds,
  31.      sampled in through a variety of different sources.  By
  32.      taking these samples and playing them at different pitches,
  33.      a rich, musical soundtrack can be created that makes
  34.      synthesized sound look puny.
  35.  
  36.      The music score of a module is made up of several different
  37.      things.  Number one is the note.  The note is stored as a
  38.      "sampling" rate or a period of time.  The lower the note,
  39.      the longer the period of time.
  40.  
  41.      Next is the instrument.  For every note played, a
  42.      corresponding instrument is played.
  43.  
  44.      The special effect is next.  These range from arpeggios to
  45.      volume slides to speed changes.
  46.  
  47.      By combining these items, musical scores lasting several
  48.      minutes, sometimes ten minutes or more, can be created using
  49.      minimal space.
  50.  
  51.      IIb. PLAYBACK DEVICES
  52.      ---------------------------------------------------------
  53.      SuperProPlay supports several playback devices:
  54.  
  55.              * PC Internal Speaker
  56.              * Soundblaster
  57.              * Soundblaster Pro (next release)
  58.              * Adlib Gold (next release)
  59.              * Roland (coming soon)
  60.              * and other MIDI devices (coming soon)
  61.  
  62.      The PC's internal speaker is not really up to handling
  63.      modules.  It can barely handle a 5-bit sample (and that is
  64.      barely).  This is nearly half of the total bits in the
  65.      sample we have to play.  So, if the music gets loud and
  66.      muffled, you'll know why.
  67.  
  68.      The Soundblaster is a wonderful device for modules.  The
  69.      Amiga plays a 9-bit stereo sample.  The Soundblaster plays
  70.      an 8-bit mono.  Even so, this is very good...much, much
  71.      better than the internal speaker.
  72.  
  73.      Creative Labs, Inc. should have the Soundblaster Pro
  74.      programming specs out soon.  The Soundblaster Pro will play
  75.      an 8-bit stereo sample.  Channels 1 and 4 go out the left
  76.      speaker, channels 2 and 3 go out the right speaker.  This
  77.      should sound pretty good.
  78.  
  79.      The Adlib Gold will play a 9-bit stereo sample.  This
  80.      doubles the quality of the 8-bit stereo sample, and even
  81.      makes it sound better than the Amiga.  This should sound
  82.      awesome.
  83.  
  84.      IIc. IMPLEMENTATION
  85.      ---------------------------------------------------------
  86.      SuperProPlay implements all regular Amiga effects including
  87.      Protracker effects.  Most Amiga modules have samples that
  88.      are less than 64k in them.  A few rare modules have samples
  89.      greater than 64k.    These can be played on a 12mhz machine,
  90.      but 12mhz really can't cope.  Try it on the next step up, a
  91.      16mhz machine.
  92.  
  93.      IId. PROTRACKER
  94.      ---------------------------------------------------------
  95.      The Amiga's name comes with its standard in graphics, music,
  96.      and whatever other types of files it has.    This standard is
  97.      the reason why everything on the Amiga looks good.  This
  98.      standard was also the deciding factor in designing
  99.      SuperProPlay.
  100.  
  101.      SuperProPlay originally began with Soundtracker modules.
  102.      These contained some nice, standard Amiga effects.  But as
  103.      time went on, more and more Amiga trackers began appearing,
  104.      implementing more and more new commands.
  105.  
  106.      One tracker that is quickly becoming a standard is
  107.      Protracker.  Protracker supports all the Soundtracker
  108.      commands, plus a host of its own.    In implementing the
  109.      Protracker format, I have opened up a wide range of Amiga
  110.      modules whose special effects were otherwise not playable by
  111.      anything but Protracker.  Protracker adds many commands like
  112.      tremelos, note delays, repeat loops, etc.    You will find
  113.      that many modules benefit greatly by having these extra
  114.      commands.
  115.  
  116.  
  117.      III. SUPERPROPLAY COMMAND LINE OPTIONS
  118.      ---------------------------------------------------------
  119.      SuperProPlay has simple (and very simplistic) command-line
  120.      playing capabilities.
  121.  
  122.      SPP [-1/-2] [-0] [-f] [filename [.MOD]]
  123.  
  124.      The items in [ ] are optional.  The filename can contain
  125.      wildcard characters, so SPP * would be valid.  SPP * would
  126.      play all *.MOD files in the current directory one after
  127.      another.  Playback of a list of files can be aborted by
  128.      hitting ESC several times in rapid succession.
  129.  
  130.      -1  should be used if you are playing samples on a 10mhz
  131.      machine.
  132.  
  133.      -2  is the default, 12mhz machines or better.
  134.  
  135.      -3  is for 12mhz machines playing modules with samples
  136.      greater than 64k.  If your machine acts screwy, use this.
  137.  
  138.      -0  tells SuperProPlay to play through the PC speaker.
  139.      This is the default and using this switch will override
  140.      any automatic detections.  SuperProPlay automatically
  141.      detects a Soundblaster card.
  142.  
  143.      -f  will create a list of all module files in the current
  144.      directory.  See below (Module File List).
  145.  
  146.  
  147.      IV. SUPERPROPLAY INTERACTIVE MODE
  148.      ---------------------------------------------------------
  149.      Typing SPP on its own will bring up a file selection list.
  150.      From here, files can be tagged, played, deleted, output
  151.      device can be changed, etc.  Help is available on all
  152.      keypresses by pressing F10.
  153.  
  154.      Commands on the file selection screen are as follows:
  155.  
  156.      Cursor Left or
  157.      Cursor Up      - Move the highlight bar up
  158.  
  159.      Cursor Right or
  160.      Cursor Down  - Move the highlight bar down
  161.  
  162.      Home      - Move the highlight bar to the top of the
  163.             screen
  164.  
  165.      End      - Move the highlight bar to the bottom of the
  166.             screen
  167.  
  168.      PgUp      - Move up a page of files
  169.  
  170.      PgDn      - Move down a page of files
  171.  
  172.      Return or
  173.      Enter      - This will play the currently highlighted
  174.             module, or change the drive or directory.
  175.  
  176.      ESC      - Quits SuperProPlay.
  177.  
  178.      O          - Brings up a menu showing all the output
  179.             devices available and allows selection from
  180.             them.
  181.  
  182.      D          - Deletes the currently highlighted module
  183.             with confirmation.
  184.  
  185.      Space      - Tags or untags the currently highlighted
  186.             module and advances to the next module.
  187.  
  188.      T          - Tags all the modules in the directory.
  189.  
  190.      U          - Untags all the modules in the directory.
  191.  
  192.      P          - Plays all tagged modules.
  193.  
  194.      S          - Pulls up a sample list for the current
  195.             module (see below).
  196.  
  197.  
  198.      V. SAMPLE LIST/MENU
  199.      ---------------------------------------------------------
  200.      This menu is set up to view, play, save, or load samples for
  201.      the current module.  This is only temporary and when you
  202.      exit, all changes are destroyed.  Note that this is a very
  203.      untested section of the program.  Use with caution!!
  204.  
  205.      Keys that work from within this menu are:
  206.  
  207.      F1       Save the current sample to disk.    Prompts for a
  208.           filename.
  209.  
  210.      F2       Load a sample from disk.    Prompts for a filename.
  211.  
  212.      F3       Plays the module with the changes.
  213.  
  214.      ESC      Exits the sample menu.
  215.  
  216.      In addition to the above keys, samples can be played from
  217.      here, too.  Below is a crude rendition of a piano keyboard.
  218.  
  219.         2   3    4    6   7        9    0   -
  220.            F#2 G#2 A#2     C#3 D#3       F#3 G#3 A#3
  221.  
  222.           Q   W   E   R   T   Y   U   I   O   P   [
  223.          F-2 G-2 A-2 B-2 C-3 D-3 E-3 F-3 G-3 A-3 B-3
  224.  
  225.         S   D        G    H   J        L    ;
  226.            C#1 D#1       F#1 G#1 A#1       C#2 D#2
  227.  
  228.           Z   X   C   V   B   N   M   ,   .   /
  229.          C-1 D-1 E-1 F-1 G-1 A-1 B-1 C-2 D-2 E-2
  230.  
  231.  
  232.      VI. PLAYBACK KEYS
  233.      ---------------------------------------------------------
  234.      These keys will work during any playback.
  235.  
  236.      Space or
  237.      Return or
  238.      ESC       Stop playing
  239.  
  240.      F1        Decrease volume bar character by one
  241.  
  242.      F2        Increase volume bar character by one
  243.  
  244.      F3        Decrease volume bar attribute by one
  245.  
  246.      F4        Increase volume bar attribute by one
  247.  
  248.      F5        Scroll music
  249.  
  250.      F6        Unassigned
  251.  
  252.      F7        Show miniature real-time spectrum analyzer
  253.  
  254.      F8        Show big real-time spectrum analyzer
  255.  
  256.      - or
  257.      F11       Decrement master volume
  258.  
  259.      + or
  260.      F12       Increment master volume
  261.  
  262.      1           Turn channel 1 on/off
  263.  
  264.      2           Turn channel 2 on/off
  265.  
  266.      3           Turn channel 3 on/off
  267.  
  268.      4           Turn channel 4 on/off
  269.  
  270.      7           Decrement foreground attribute for real-
  271.            time spectrum analyzer
  272.  
  273.      8           Increment foreground attribute for real-
  274.            time spectrum analyzer
  275.  
  276.      9           Decrement background attribute for real-
  277.            time spectrum analyzer
  278.  
  279.      0           Increment background attribute for real-
  280.            time spectrum analyzer
  281.  
  282.      [           Decrement number of counts per next note
  283.  
  284.      ]           Increment number of counts per next note
  285.  
  286.      A           Decrement channel 1 volume
  287.  
  288.      Z           Increment channel 1 volume
  289.  
  290.      S           Decrement channel 2 volume
  291.  
  292.      X           Increment channel 2 volume
  293.  
  294.      D           Decrement channel 3 volume
  295.  
  296.      C           Increment channel 3 volume
  297.  
  298.      F           Decrement channel 4 volume
  299.  
  300.      V           Increment channel 4 volume
  301.  
  302.      Left Arrow   Slow music down
  303.  
  304.      Right Arrow  Speed music up
  305.  
  306.      Down Arrow   Restore original speed
  307.  
  308.      End      Almost pause music
  309.  
  310.      Home      Go to beginning of music
  311.  
  312.      PgUp      Decrement current block by one
  313.  
  314.      PgDn      Increment current block by one
  315.  
  316.  
  317.      VII. MODULE FILE LIST
  318.      ---------------------------------------------------------
  319.      By using the -f command-line switch, a list of all modules
  320.      in the current directory can be created.  Use redirection to
  321.      redirect them to a file.
  322.  
  323.      C:\MODULES> SPP -f > LIST.TXT
  324.  
  325.      Would create a file LIST.TXT with the contents similar to:
  326.  
  327.      CRUSADE.MOD       87k CRUSADE.SONG.st    20  31        02:30
  328.      RAINY_NT.MOD     209k rainynight          54  31        06:46
  329.      BRIDGE.MOD       145k bridge          32  31        04:00
  330.  
  331.  
  332.      VIII. MODULE EDITING
  333.      ---------------------------------------------------------
  334.      SuperProPlay Advanced will contain complete and total real-
  335.      time module editing!  Yes, folks!    You heard it!  Real-
  336.      time...on a PC!
  337.  
  338.      This version of SuperProPlay contains a small sample of the
  339.      beginning stages of some editing I am working on.    To sample
  340.      it, press E on a module from the file selection screen.  Use
  341.      standard moving keys, the keyboard, F7 and F8 to increment
  342.      the current sample, F9 and F10 to increment the current
  343.      block.  Note: This is not even in the beta-testing stages.
  344.      If it locks up your machine, it's not my fault.
  345.  
  346.      Compare MED for the Amiga.  Coming in version 2.00.   The
  347.      very next release!  Available at the end of March.
  348.  
  349.  
  350.      IX. SHAREWARE
  351.      ---------------------------------------------------------
  352.      This software is Shareware.  This means that if you use this
  353.      software, like it, and continue to use it, in order to keep
  354.      your conscience clear, donate some money to the development
  355.      of this software.
  356.  
  357.      I have a problem with Shareware.  The problem is that no one
  358.      has ever supported anything I have written so far.  This is
  359.      the last and final test in this area.  If anyone has
  360.      anything they'd like to say, send me a letter!  Support
  361.      Shareware.
  362.  
  363.      Be forewarned!  An actual registration fee will be charged
  364.      in SuperProPlay Advanced.    $10 or more now will guarantee
  365.      you a copy of SPP Advanced.
  366.  
  367.  
  368.      X. CREDIT & THANKS:
  369.      ---------------------------------------------------------
  370.      These people have directly and indirectly helped in the
  371.      development of SuperProPlay.  Thanks to all of them!  If you
  372.      have ideas, your name could appear here, too.
  373.  
  374.      Joshua Dinerstein - Provided the MED source code for the
  375.              Amiga which contained a MED playback
  376.              routine.  It was close enough to a
  377.              Soundtracker format that I used it.
  378.  
  379.      Ted Birch           - For obtaining the Soundblaster
  380.              programming info.
  381.  
  382.      Tom Campbell      - One of my few and only beta testers.
  383.              Thanks for all the suggestions.
  384.  
  385.  
  386.      XI. COPYRIGHT/LICENSE/WARRANTY
  387.      ---------------------------------------------------------
  388.      This license agreement applies only to the version of
  389.      SuperProPlay that accompanies this document.
  390.  
  391.      The software (SPP.EXE and SPP.DOC) is Copyright 1992
  392.      by the author (Joshua C. Jensen).    You are hereby granted
  393.      permission to:  use this software; give copies to anyone;
  394.      and distribute the software and documentation via electronic
  395.      means.
  396.  
  397.      You are specifically prohibited from charging, selling, or
  398.      requesting any monetary amount for any copies, however made.
  399.      The software may not be used for any commercial purposes
  400.      without written contract from the author (Joshua C. Jensen).
  401.  
  402.      This software may be distributed in the Shareware/Public
  403.      Domain libraries that charge for copying and distributing
  404.      disks so long as those companies contact the author first
  405.      and receive his written permission to do so.
  406.  
  407.      There is no warranty of any kind; this software is provided
  408.      on an "AS-IS" basis.  The author (Joshua C. Jensen) is not
  409.      liable for any damages whatsoever, directly or indirectly,
  410.      that may occur as a result of using this software or
  411.      documentation.  By owning/using this software, you agree to
  412.      all the above terms.
  413.  
  414.      No copy of this software may be distributed or given away
  415.      without this document; the software or document may not be
  416.      altered in any way; the software may not be reverse-
  417.      engineered by disassembly or any other method that could
  418.      cause alteration.
  419.  
  420.      The software and documentation are
  421.      Copyright (C) 1991/1992 by Joshua C. Jensen
  422.  
  423.  
  424.      XII. FREQUENTLY ASKED QUESTIONS
  425.      ---------------------------------------------------------
  426.      Q. How do I make modules?
  427.      A. Modules are generally created using MED or Protracker on
  428.     the Amiga.  SuperProPlay Advanced (available at the end
  429.     of March) will contain _full_ real-time editing
  430.     comparable to MED or Protracker.
  431.  
  432.      Q. Can I have the source code?
  433.      A. It is my intention to release the full source for
  434.     SuperProPlay to create a standard on the IBM also.
  435.     Right now, I am holding back, because certain companies
  436.     are investigating SuperProPlay and may incorporate the
  437.     playing routines in their games.  There is one company so
  438.     far that has used my playing routines.    That is Inland
  439.     International Software.  They/we used it in a game called
  440.     the Crusade.  Contact them at 753-5720 for ordering
  441.     information.
  442.  
  443.  
  444.      XIII. WHAT'S NEW
  445.      ---------------------------------------------------------
  446.      ***** Whats been asked for and coming soon
  447.      o Driving MIDI equipment
  448.      o Editor built into the program.  Will include support for
  449.        editing in real-time.  Compare MED for the Amiga.
  450.      o Documentation on the Module file format
  451.      o Adlib Gold stereo support
  452.      o Soundblaster Pro stereo support
  453.  
  454.      ** New in 1.2
  455.      o Fixed Soundblaster Detect routines
  456.      o Channel toggle (1,2,3,4)
  457.      o Control master volume
  458.      o Control individual channel volume.
  459.      o Now scrolls module file.
  460.      o Fixed Tone Portamento.
  461.      o Brings up a sample menu 's'
  462.      o Brings up an output selection menu 'o'
  463.  
  464.      ** New in 1.1
  465.      o Fixed file display selection... now includes name, time,
  466.        etc.
  467.  
  468.      ** New in 1.00
  469.      o New directory routine
  470.      o Worked all the bugs out of the Protracker playback
  471.        routines...almost
  472.      o Added Spectrum Analyzer mode -- full 32-bit Fourier
  473.        transforms.
  474.  
  475.      ** New in 0.99
  476.      o Now sorts directory into alphabetical order
  477.      o New Help pop-up
  478.  
  479.      ** New in 0.98
  480.      o Changed name to SuperProPlay.
  481.      o Added full Protracker support (Super Protracker Player,
  482.        get it?)
  483.      o New key 'd' lets you delete a module (with confirmation)
  484.      o Bought a Soundblaster board.  Have added full Soundblaster
  485.        support.
  486.      o Have up to 1000 modules in a directory!
  487.      o Totally seized control of keyboard.
  488.      o Fixed bugs in Vibrato and Volume Slide commands
  489.  
  490.      ** New in 0.95
  491.      o Can now 'space' tag/untag and then 'p' play all tagged
  492.        files.
  493.  
  494.      ** New in 0.92
  495.      o Really stupid file selection technique... oh, well, it
  496.        works.
  497.      o Displays filename of Module playing in multi-play mode
  498.        (PS *)
  499.      o Command line option for people with slower/faster machines
  500.      o Will play multiple files from the command line.
  501.  
  502.      ** New in 0.90
  503.  
  504.      o First public release of PLAYSTM.  Was the grandfather of
  505.        SuperProPlay.
  506.  
  507.  
  508.      XIV. CONTACT/SUPPORT
  509.      ---------------------------------------------------------
  510.      For any support, bug reporting, registration, or anything
  511.      to that effect, contact me via one of the following places.
  512.  
  513.               Joshua C. Jensen
  514.               P.O. Box 414
  515.               Hyde Park, UT 84318
  516.  
  517.      The Holo Deck BBS    (801) 563-6348    1:302/1
  518.      Into The Woods    (801) 753-2408
  519.  
  520.      or via any 1:302 Fidonet address.
  521.  
  522. ---- This file passed through "The Gramcracker BBS - Home of the ■"    
  523. ---- Handcuffs SYSOP        
  524. »»» 
  525. »»» 
  526.