@database Taffys PLayer.guide
@author "Paul Bowen"
@$VER: Taffys Player.guide 0.1 (16.1.00)

@node Main "Taffys Player"
                 @{b}=============================================
                        TAFFYS PLAYER VERSION 0.2 BETA
                 =============================================@{ub}
                 
                    @{fg shine}Simple FreeWare Multiformat Module Player@{fg text}
                             
                              © 2000 Paul Bowen
                               
                         Taffy@pbowen.Freeserve.co.uk                              
                             

     @{" Introduction    " link Introduction} - About Taffys Player.
     @{" Installation    " link Installation} - Installing on a hard disk.
     @{" Features        " link Features} - What it can do. 
     @{" Credits         " link Credits} - Who what and where.
     @{" Requirements    " link Requirements} - System requirements.
     @{" Bugs Updates    " link Bugs} - Planned improvements updates.
     @{" History         " link History} - Bugs I've missed & fixed. 

      @{apen 3}@{i}This is beta Software use it at your own Risk you have been Warned.@{ui}@{fg text}

@endnode
@node Introduction
                 
                                @{u}INTRODUCTION@{uu}
                 
           
 @{b}WHAT DOES IT DO..............@{ub}

     It tries to Play OctaMed and Protracker Modules using a mixture of
     Assembly language routines and library calls.
     
            @{b}-----------------------------------------------@{ub}
     
     
     @{fg shine}@{i}Great yet other Module Player and whats so good about this one then

     Err well.@{ui}@{fg text}

     *  Its small compact size. 
     
     *  The author is so sad he's tested it on just about every type of
        Octamed & Protracker Module. 
       
     *  It makes loads of checks and informs the user if anything go's
        wrong (most of the time).
        
     *  Checks Fastmem loading/Playing and turns on/off accordingly.
        
     *  The user has a choice of using the simple window displayed on 
        opening or clicking on the more gadget for extra goodies.
        
     *  Its got a very simple user interface.         
               
               
            @{b}-----------------------------------------------@{ub}              

                             @{"BACK TO INDEX" link Main}
@endnode

@node Installation
                             
                      @{b}Taffys Player (Installing it).@{ub}
      

     Installing this program is very easy you should have no problems just
     drag the Taffys Player Icon wherever you wish it to go on your Hard
     Disk.
    
            @{b}-----------------------------------------------@{ub}


 @{b}LIBRARIES....................@{ub}
 
     All the Libraries you need should already be in your sys/libs Drawer
     on your hard disk.
     If not the program will tell you what version number you need
     here's a list anyway.  
 
     * @{" medplayer.library " link Medplayer.library}     v7.1    4  Channels
     
     * @{" octaplayer.library " link  octaplayer.library}    v7.1    8  Channels
     
     * @{" octamixplayer.library " link  octamixplayer.library} v7.1    64 Channels
     
     * @{" ptreplay.library " link ptreplay.library}      v6.6    4  Channels 
 
     -  gadtools.library      v39
     -  asl.library           v40
     -  dos.library           v39    ;
     -  intuition.library     v40    ;
     
            @{b}-----------------------------------------------@{ub}
            
            
 @{b}OBTAINING LIBRARIES...........@{ub}      
 
     You can obtain the player librarys needed from the following.......
              
                 
 @{b}AMIGA FORMAT..................@{ub} 
  
     Cover CDs 41-49 in :+System+/Libs  for :- ptreplay.library v6.6.
     
     medplayer.library * octaplayer.library * octamix.library. 
     
     can also be found in various draws on the above cds.
     
          
 @{b}The AMINET....................@{ub}    
     
     The Aminet also contains all the above librarys.
     
     
 @{b}OTHER SITES...................@{ub}    
     
     For the Octamed librarys try Http://www.Octamed.co.uk   
     
                         
                             @{"BACK TO INDEX" link Main}    
@endnode

@node Features

                               @{b}FEATURES@{ub} 
                             
     After loading a supported module you are able to PLAY STOP CONTINUE      
     from the small window.
                    
          
 @{b}CUSTOM WINDOW................@{ub}
               
     Clicking on the "MORE" gadget after loading a supported module     
     opens a custom window with adjustable options for the module loaded.
                                                            
     @{" Four Channel Octamed Module Loaded." link FourChannel}
     @{" Eight Channel Octamed Module Loaded." link EightChannel }
     @{" Mix mode (64) Channel Octamed Module Loaded." link sixtyfourChannel}
     @{" Protracker Module." link protracker}
     @{" General Module Information displayed on every window." link General}        
   
                         
 @{b}SUPPORTED MODULES............@{ub}

     *  Four Channel Octamed Module's using   @{" Medplayer.library." link medplayer.library}     v7.1

     *  Eight Channel Octamed Module's using  @{" Octaplayer.library." link octaplayer.library}    v7.1
     
     *  Sixty Four Channel Modules using      @{" Octamixplayer.library." link  octamixplayer.library} v7.1  
         
     *  Four Channel Protracker Modules using @{" ptreplay.library." link ptreplay.library}      v6.6 

     
 @{b}FILE ID'S SUPPORTED..........@{ub} 
     
     *  MMD0 MMD1 MMD2 MMD3 M.K. 
               
            
 @{b}AUTOMATIC CHECKS.............@{ub}
                                       
     * @{" Fastmem Play " link fastmemplay} on/off at loading. 
             
     *  Load Fastram check before loading.
             
     *  Does not rely on the MMD id for Module Replaying or loading.
             
     *  Automatically loads to Fastram if Chip to Small and turns on
       @{" Fastmem Play " link fastmemplay}.
                        
     @{fg shine}*@{fg text}  (Hope to add Load and play Fast RAM for Octamed Modules.) 
         
         
            @{b}-----------------------------------------------@{ub}
                                                                  
                             @{"BACK TO INDEX" link Main}
@endnode
                  
@node   FourChannel                    

        @{b}Options for 4 Channel Octamed Module (medplayer Library v7.1).@{ub}
            
                     
 @{b}CYCLE GADGETS................@{ub}
                                                     
     * @{" Fastmem Play " link fastmemplay}         Turns @{" Fastmem Play " link fastmemplay} on/off.
     
     *  Reset MIDI             Not available in this version.
     
     * @{" LowPass Filter " link Audio Filter}       Toggles lowpass filter on/off. 
                               The Module Playing will override this 
                               setting if lowpass filtering is used by the
                               Module.
                               
                               
 @{b}INTEGER GADGETS..............@{ub}                             

     *  Fast Memory Play       Change the size of the Fast memory
        Buffer Size            Play buffer. See :- @{" Fastmem Play " link fastmemplay}

                                         
 @{b}BUTTON GADGETS...............@{ub}                      
               
     *  Apply Changes          Affects all the changes made with the cycle
                               and integer gadgets (Not Filter).
                               Divide's the integer contents by four checks
                               max min.
                               Stops the Module if Playing calls library
                               routine's required.
              
     *  PLAY                   Plays the currently loaded Module.
             
     *  STOP                   Stops the currently Playing Module.
             
     *  CONT                   Continues the Module from current Position.
              
     *  EJECT                  Stops/Ejects/Unloads Module free's Player
                               Closes Player library.
                           
                           
 @{b}PLEASE NOTE..................@{ub} 
  
     @{fg shine}@{i}These options are only available by clicking on the more gadget
     when a supported Module is loaded.@{ui}@{fg text}
                                       
     When Playing Module from first window after adjusting the above 
     settings.  
              
     * @{" LowPass Filter " link Audio Filter} on/off is Ignored.
              
     *  Any Buffer size changes or @{" Fastmem Play " link fastmemplay} state will remain as set
        by this window.
                               
                               
            @{b}-----------------------------------------------@{ub} 
                     
                           @{"BACK TO INDEX" link Main}
@endnode

@node  General
                          
                       @{b}General Module Attributes@{ub}

                            
 @{b}ATTRIBUTES...................@{ub}   
                                         
     *  Module Size            Size of Module in Bytes. 
         
     *  Instruments            Number of Samples,Synth sounds used.
          
     *  Num Blocks             Number of Blocks used.
          
     *  Playing Seq            Number of Blocks in sequence.
        
     *  Module File Type       Type of Module loaded.
        
     *  Memory Type            Type of Memory used Chip or Fast.
        
            @{b}-----------------------------------------------@{ub}
            
            
 @{b}PLEASE NOTE.................@{ub}
 
     *  Playing Sel is used instead of Playing Seq in Modules with file
        type MMD2 and MMD3. Which is the number of Sequences Used.    
                 
            @{b}-----------------------------------------------@{ub}
                             
                           @{"BACK TO INDEX" link Main}                     
@endnode

@node  EightChannel                    

       @{b}Options for 8 Channel Octamed Module (octaplayer Library v7.1).@{ub}

        
 @{b}CYCLE GADGETS................@{ub}
  
     * @{" Fastmem Play " link fastmemplay}         Turns @{" Fastmem Play " link fastmemplay} on/off.  
                         
     * @{" High Quality " link HQ Mode}         Turns High Quality mode on/off.
        
     * @{" LowPass Filter " link Audio Filter}       Toggles lowpass filter on/off. The Module
                               Playing will override this setting if lowpass
                               filtering is used by the Module.
                               
                               
 @{b}INTEGER GADGETS..............@{ub}                             

     *  Fast Memory Play       Change the size of the Fast memory Play
        Buffer Size            buffer. See:- @{" Fastmem Play " link fastmemplay}             
                                                
 @{b}BUTTON GADGETS...............@{ub}                      
               
     *  Apply Changes          Affects all the changes made with the cycle
                               and integer gadgets (Not Filter).
                               Divide's the integer contents by four checks
                               max min.
                               Stops the Module if Playing calls library
                               routine's required.
              
     *  PLAY                   Plays the currently loaded Module.
             
     *  STOP                   Stops the currently Playing Module.
             
     *  CONT                   Continues the Module from current Position.
              
     *  EJECT                  Stops/Ejects/Unloads Module free's Player
                               Closes Player library.
                           
                           
 @{b}PLEASE NOTE..................@{ub}  
 
     @{fg shine}@{i}These options are only available by clicking on the more gadget
     when a supported Module is loaded.@{ui}@{fg text}
                                       
     When Playing Module from first window after adjusting the above 
     settings.  
              
     * @{" LowPass Filter " link Audio Filter} on/off is Ignored.
              
     *  Any Buffer size changes or @{" Fastmem Play " link fastmemplay} state will remain
        as set by this window.
                               
                               
            @{b}-----------------------------------------------@{ub} 
                             
                         @{"BACK TO INDEX" link Main}
@endnode

@node  sixtyfourChannel      
              
@{b}Options for Mix Mode 64 Channel Octamed Module (octamixplayer.Library v7.1).@{ub}


 @{b}CYCLE GADGETS................@{ub}

     * @{" Set 14Bit Mode " link Set14BitMode}       Turns 14Bit Play Mode on/off.    
     
     * @{" LowPass Filter " link Audio Filter}       Toggles lowpass filter on/off.The Module
                               Playing will override this setting if lowpass
                               filtering is used by the Module.
                               
                               
 @{b}INTEGER GADGETS..............@{ub} 

     * @{" MixBuffer " link  MixBuffer64}             Change the size of the Mixing buffer.
                                       
     * @{" Change Mixing freq " link  Mixing frequency64}    Change the Output Mixing frequency.

                                        
 @{b}BUTTON GADGETS...............@{ub}                      
               
     *  Apply Changes          Affects all the changes made with the cycle
                               and integer gadgets (Not Filter).
                               Sets value in MixBuffer & Mixing frequency
                               integer Gadgets.                              
                               Stops the Module if Playing calls library
                               routine's required.
              
     *  PLAY                   Plays the currently loaded Module.
             
     *  STOP                   Stops the currently Playing Module.
             
     *  CONT                   Continues the Module from current Position.
              
     *  EJECT                  Stops/Ejects/Unloads Module free's Player
                               Closes Player library.
                           
                           
 @{b}PLEASE NOTE..................@{ub}  
 
     @{fg shine}@{i}These options are only available by clicking on the more gadget
     when a supported Module is loaded.@{ui}@{fg text}
                                       
     When Playing Module from first window after adjusting the above 
     settings.  
              
     * @{" LowPass Filter " link Audio Filter} on/off is Ignored.
              
     *  Any Buffer size changes will remain as set by this window.
                                                              
            @{b}-----------------------------------------------@{ub} 
                                              
                             @{"BACK TO INDEX" link Main}
@endnode


@node protracker

       @{b}Options for ProTracker 4 Channel Module (ptreplay.Library v6.6).@{ub}                            


 @{b}CYCLE GADGETS................@{ub}

     * @{" LowPass Filter " link Audio Filter}       Toggles lowpass filter on/off. The Module
                               Playing will override this setting if audio
                               filtering is used by the Module.
                               
                               
 @{b}BUTTON GADGETS...............@{ub}                      
               
     *  PLAY                   Plays the currently loaded Module.
             
     *  STOP                   Stops the currently Playing Module.
             
     *  CONT                   Continues the Module from current Position.
              
     *  EJECT                  Stops/Ejects/Unloads Module free's Player
                               Closes Player library.
                           
                           
 @{b}PLEASE NOTE..................@{ub}  
 
     @{fg shine}@{i}These options are only available by clicking on the more gadget
     when a supported Module is loaded.@{ui}@{fg text}
                                       
     When Playing Module from first window after adjusting the above 
     settings.  
              
     * @{" LowPass Filter " link Audio Filter} on/off is Ignored.
              
              @{b}-----------------------------------------------@{ub} 
               
                         @{"BACK TO INDEX" link Main}
@endnode

@node  Credits

                       @{b}THANKYOU TO THE FOLLOWING@{ub} 
                     
 @{b}PLAYER LIBRARIES USED.........@{ub} 
 
     
     Teijo Kinnuem and Ray-Frost & Copyright RBF Software. 
                   
     *  @{" Medplayer.library " link medplayer.library}
        
     *  @{" Octaplayer.library " link octaplayer.library}
        
     *  @{" Octamixplayer.library " link octamixplayer.library}
           
               
            @{b}-----------------------------------------------@{ub} 


     Andreas Pålsson Copyright (c) 1996 Andreas Pålsson 
     (Pucko/Digital Dreams)
                                         
     *  @{" ptreplay.library " link ptreplay.library}
                           
                     
            @{b}-----------------------------------------------@{ub}

                             
     *  Anybody who's Uploaded source code Thankyou.
            
                              
            @{b}-----------------------------------------------@{ub}   
                              
                           @{"BACK TO INDEX" link Main}

@endnode
@node  Requirements

                          @{b}SYSTEM REQUIREMENTS@{ub}
                                               
     *  Amiga Running Workbench 3.0 or Better.
             
     *  The Faster the processor the Better.
                                   
     *  Should run on a standard Amiga A1200 not Tested can't be bothered
        to pull board out.
               
     *  Will work with 2Megs but don't expect much with 2Megs of anything.
           
     *  The more Memory the better.
                 
     *  Written on an Amiga A1200 040 16MB OS 3.5.                               
            
                                                                                                      
            @{b}-----------------------------------------------@{ub}    
                              
                      @{"BACK TO INDEX" link Main}

@endnode
@node  Bugs

                                 @{b}BUGS@{ub}
 
 @{b}WHAT DON'T WORK..............@{ub}
                                                   
     *  Midi Loading/Reset Midi not active.
          
     *  Can't spell to save my life.  
        
                   
 @{b}UPDATES......................@{ub}
      
     *  I hope to add more Players Plus PowerPacker and other Packers.
      
     *  Toggle load to Fast/chip Mem. 
                 
     *  Add Midi loading Playing.
      
     *  Protracker Library Support. (Done) 
      
     *  This Software is Beta.
                                      
     *  Written on an Amiga A1200 040 16MB  OS 3.5 
 
                   
             @{b}-----------------------------------------------@{ub}   
                 
                          @{"BACK TO INDEX" link Main}

@endnode

@node  History


                               @{b}HISTORY@{ub}
                           
 @{b}FIRST UPLOADED...............@{ub}
                              
     *  16.12.99  Version 0.1 beta.
         
     *  Plays octamed modules using (medplayer) (octaplayer)  
            
        (octamixplayer) libraries.
                      
      @{fg shine}Bugs.......@{fg text}

         
     *  Did not always close the file after reading it (sorry).
     
     *  Crashed after loading a mix mod in fast ram.
     
     *  Did not display mod size if less 10K properly.  
         
         
 @{b}SECOND UPLOAD................@{ub}    
      
     *  16.1.2000 Version 0.2 beta.
         
     *  Added Protracker support Fixed some major bugs the program
        should be more stable now.
            
     *  Toggle filter on/off without hitting apply changes gadget added.
     
     *  Once play-stop-cont is hit, repeatedly hitting that gadget will
        have no effect.
            
     *  Major rewrite of parts of the whole program adding Protracker
        support was not easy. (Grab that audio.device and don't tell me
        about it then).           
                          
     *  This Software is Beta.
     
            @{b}-----------------------------------------------@{ub}  
                   
                             @{"BACK TO INDEX" link Main}

@endnode
@node  Medplayer.library

                           @{b}MEDPLAYER.LIBRARY@{ub}
                           
                           
 @{b}BASIC INFORMATION............@{ub}
                              
     *  Medplayer library is a shared library for loading and playing four
        channel Med Songs with MIDI support.
                                 
     *  @{fg shine}Please See Octamed Sound Studio programmers directory for
        more information.@{fg text}
        
     @{fg shine}@{i}Written by Teijo Kinnuem & Copyright Ray-Frost RBF Software.@{ui}@{fg text}
    
            @{b}-----------------------------------------------@{ub}  
               
                             @{"BACK TO INDEX" link Main}
@endnode
@node  octaplayer.library

                          @{b}OCTAPLAYER.LIBRARY@{ub}
                           
                           
 @{b}BASIC INFORMATION............@{ub}
                              
     *  Octaplayer library is a shared library for loading and playing
        5-8 channel Songs.
                                 
     *  @{fg shine}Please See Octamed Sound Studio programmers directory for more
        information.@{fg text}
        
     @{fg shine}@{i}Written by Teijo Kinnuem & Copyright Ray-Frost RBF Software.@{ui}@{fg text}   
     
            @{b}-----------------------------------------------@{ub}  
               
                             @{"BACK TO INDEX" link Main}
        
@endnode
@node  octamixplayer.library

                          @{b}OCTAMIXPLAYER.LIBRARY@{ub}
                           
                           
 @{b}BASIC INFORMATION............@{ub}
                              
     *  Octamixplayer library is a shared library for loading and playing
        1-64 channel Songs.
                                 
     *  @{fg shine}Please See Octamed Sound Studio programmers directory for more
        information.@{fg text}
        
     @{fg shine}@{i}Written by Teijo Kinnuem & Copyright Ray-Frost RBF Software.@{ui}@{fg text}   
     
            @{b}-----------------------------------------------@{ub}  
               
                             @{"BACK TO INDEX" link Main}
        
@endnode
@node  ptreplay.library

                           @{b}PTREPLAY.LIBRARY@{ub}
                           
                           
 @{b}BASIC INFORMATION............@{ub}
                              
     *  Ptreplay library is a shared library for loading and playing
        4 channel Protracker Modules.
                                 
     *  @{fg shine}More information available on the Aminet and Amiga Format
        Cover CD 41:-Seriously_Amiga-/Programming/Basic/ACE_FTP/prgs/
        audio/ptreplay.lha@{fg text}
        
     @{fg shine}@{i}Copyright (c) 1994-1996 Mattias Karlsson (BetaSoft)
     Copyright (c) 1996 Andreas Pålsson (Pucko/Digital Dreams).@{ui}@{fg text}   
     
            @{b}-----------------------------------------------@{ub}  
               
                             @{"BACK TO INDEX" link Main}
        
@endnode
@node  fastmemplay

                              @{b}FASTMEM PLAY@{ub}


 @{b}FUNCTION.....................@{ub}

     *  Enables or disables Fastmem playing, and sets the size of the
        output buffer 4 to 400 divisible by four.(rounded by program.)
        
     *  Enabling allows samples greater than 131,072 bytes to be played in
        chip or fast ram.
        
     *	Changes made only applied to module by clicking on the APPLY CHANGES
	gadget. 
	
        @{fg shine}@{i}Only available in 4 and 8 Channel Octamed Modules.@{ui}@{fg text}
        
            @{b}-----------------------------------------------@{ub}  
               
                            
@endnode
@node  Audio Filter

                              @{b}LOWPASS FILTER@{ub}


 @{b}FUNCTION.....................@{ub}

     *  Toggling the Amiga's lowpass filter off/on done by this 
        (bchg #1,$BFE001). Sorry !
     
     *  Lowpass filter works by reducing the high frequencies.     
                      
     *  Enabling the lowpass filter smooths the sound but reduces the volume. 
                 
     *	Enabling the lowpass filter eliminates buzz at low sample rates. 
	 	
     *	Modules which toggle filter on/off will override filter setting.
     
     *  Lowpass filter is set off when playing from first window.
                
            @{b}-----------------------------------------------@{ub}  
               
                            
@endnode
@node  HQ Mode

               @{b}HIGH QUALITY MODE (8 CHANNEL OCTAMED MODULE)@{ub}


 @{b}FUNCTION.....................@{ub}

     *  Enabling smooths out the sound but takes up processor time.
     
     *  An A1200 68020 is needed.     
                      
     *  Significantly increases the audio quality. 
                 
     *	Enabling reduces volume of Module. 
     
     *	Changes made only applied to module by clicking on the APPLY CHANGES
	gadget.
	 	
                 @{b}-----------------------------------------------@{ub}  
@endnode
@node  Set14BitMode

                    @{b}14 BITMODE (64 CHANNEL OCTAMED MODULE)@{ub}

 @{b}FUNCTION.....................@{ub}

     *  The sound is much louder when turned off but suffers from distortion.
     
     *  An A1200 68020 is needed.     
                      
     *  Enabling significantly increases the audio quality. 
                 
     *	Enabling reduces volume of Module. 
           
     *	Changes made only applied to module by clicking on the APPLY CHANGES
	gadget.	
	 	
                 @{b}-----------------------------------------------@{ub}  
@endnode
@node  MixBuffer64

                    @{b}MIX BUFFER (64 CHANNEL OCTAMED MODULE)@{ub}

 @{b}FUNCTION.....................@{ub}

     *  An area of memory used to mix samples together before output.
     
     *  An A1200 68020 is the min spec here but still a bit slow.  
     
     *  Default of 1024 is adequate for most Modules.
     
     *  Values between 4-32768 can be entered.    
                             	 	
     *	Changes made only applied to module by clicking on the APPLY CHANGES
	gadget.           
	             	 	
                 @{b}-----------------------------------------------@{ub}  
@endnode
@node  Mixing frequency

                 @{b}MIXING FREQUENCY (64 CHANNEL OCTAMED MODULE)@{ub}

 @{b}FUNCTION.....................@{ub}

     *  Specifies in Hertz how quickly the samples should be mixed.
     
     *  An A1200 68020 is the min spec here but still a bit slow.  
     
     *  The higher the frequency the better the sound quality the more
        processor load.
     
     *  Highest possible frequency depends on the screen mode in use.
     
     *  Maximum value program allows you to use is 28375. 
     
     *  Values between 1000-65535 can be entered. 
                             	 	
     *	Changes made only applied to module by clicking on the APPLY CHANGES
	gadget.       
	                 	 	
                 @{b}-----------------------------------------------@{ub}  
@endnode
               
                            
