home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / sound2 / trakswap.zip / TRAKSWAP.DOC next >
Text File  |  1993-06-22  |  19KB  |  434 lines
  1.                 
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                 ┌─────────────────────────────────────────────┐
  14.                 │ .                                         . │
  15.                 │           ProLogic 303 Software             │
  16.                 │                                             │
  17.                 │                 Presents                    │
  18.                 │                ══════════                   │
  19.                 │                                             │
  20.                 │                   ▄▄▄▄▄▄▄▄▄▄▄▄              │
  21.                 │            Track ▀▄▄▄▄                      │
  22.                 │            ▄▄▄▄▄▄▄▄▄▄▄▀ wapper              │
  23.                 │                                             │
  24.                 │               Version 1.00                  │
  25.                 │                                             │
  26.                 │        Extended MOD Editor Series A         │
  27.                 │                                             │
  28.                 │          Programmed by NG PEI SIN           │
  29.                 │                                             │
  30.                 │              Copyright 1993.                │
  31.                 │ .                                         . │
  32.                 └─────────────────────────────────────────────┘
  33.  
  34.                                                        Track Swapper 1.00
  35.     Introduction
  36.     ▀▀▀▀▀▀▀▀▀▀▀▀
  37.  
  38.     Track Swapper 1.00 is an easy to use program that swaps the tracks of
  39.     MODule files. 
  40.  
  41.     Track Swapper is targeted at module producers  and  lovers  of  these
  42.     modules with stereo playback ability.
  43.  
  44.     The main purpose of Track Swapper is to enable the user to  swap  the
  45.     tracks of a module for stereo playback. User should be aware of their
  46.     player's  characteristic  for  stereo  playback.  Most  players  play
  47.     track 1 and track 4 on the left speaker and track 2  and  track 3  on
  48.     the right speaker on a stereo playback device.
  49.  
  50.     Track Swapper supports 4 channels modules.
  51.  
  52.     Track Swapper runs at DOS prompt.
  53.  
  54.     Track Swapper will swap the tracks of any valid MOD  file.  Supported
  55.     module formats are:
  56.                         - 15 samples Modules,
  57.                         - 31 samples Modules,
  58.                         - Amiga soundtracker/noisetracker Modules, and
  59.                         - 4 channel Startrekker Modules.
  60.  
  61.     What Is A MODule?
  62.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  63.  
  64.     A  module is  a  music  file  that  consists  of  15  or  31  sampled
  65.     instruments. Most modules have four music channels.
  66.  
  67.     By playing the instruments at different pitches, a soundtrack lasting
  68.     many minutes can be produced. A module usually has the  extension  of
  69.     .MOD or .NST.
  70.  
  71.     Track Swapper 1.00's Requirements
  72.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  73.  
  74.     Track Swapper 1.00 should  run  on  any  IBM PC  or  compatible  with
  75.     DOS 3.20 or higher and a CGA display or better.
  76.  
  77.     Track Swapper 1.00 uses about 119K bytes of conventional  memory  for
  78.     its processing. However, it may not function properly if  the  system
  79.     has less  than  it  requires.  If  the  system  has  far  too  little
  80.     conventional  memory  available,  the  program  may  even  refuse  to
  81.     execute.
  82.  
  83.     Free disk space of about the size of the original module is  required
  84.     for track swapping to take place.  This  applies  even  if  the  user
  85.     wants to overwrite the original file.  Track Swapper 1.00  creates  a
  86.     new file where the processed data will be first written into. The new
  87.     file will then be renamed at the end of  the  process  if  necessary.
  88.     This disk space consuming method is employed to provide a faster  and
  89.     safer processing of data.
  90.  
  91.     A hard disk is optional yet recommended for even faster processing.
  92.  
  93.                                                        Track Swapper 1.00
  94.  
  95.     Program Usage
  96.     ▀▀▀▀▀▀▀▀▀▀▀▀▀
  97.  
  98.     Usage : TRAKSWAP  Input File[.MOD]  [Output File][.MOD]  Track A  Track B
  99.                       ^^^^^^^^^^^^^^^^  ^^^^^^^^^^^^^^^^^^^  ^^^^^^^  ^^^^^^^
  100.      File to process ─────────┘                  │              │        │
  101.      Output file ────────────────────────────────┘              │        │
  102.      Tracks to swap ────────────────────────────────────────────┴────────┘
  103.  
  104.     When no Output File is given, the processed data will be  written  in
  105.     the current directory.
  106.  
  107.     If  either  the  Input File,  Track A  or  Track B  is   not   given,
  108.     Track Swapper 1.00 will display the help screen.
  109.  
  110.     The file name's extension is optional, however if none is  specified,
  111.     .MOD is assumed. Please take  note  that  Track Swapper 1.00  accepts
  112.     only .MOD and .NST extension. A message of "No file selected" will be
  113.     displayed if extensions other than .MOD and .NST is specified.
  114.  
  115.     Examples
  116.  
  117.     - TRAKSWAP GlovyLve.mod c:\temp\ 2 4
  118.       Explanation : Swap track 2 and 4 of the file  GloryLve.mod  in  the
  119.                     current  directory  and  write  processed   data   as
  120.                     c:\temp\GloryLve.mod
  121.  
  122.     - TRAKSWAP GloryLve 1 3           or          TRAKSWAP GloryLve * 1 3
  123.       Explanation : Swap track 1 and 3 of the file  GloryLve.mod  in  the
  124.                     current directory and overwrite the original file.
  125.  
  126.     - TRAKSWAP 4 c:\temp\GloryLve.mod *.nst 3 
  127.       Explanation : Swap track 3  and  4  of  the  file  GloryLve.mod  in
  128.                     c:\temp\ directory. Write the output  into  the  file
  129.                     GloryLve.nst in the current directory.
  130.              Note : As long as the number of  the  track  (1,2,3,4)  does
  131.                     not  join  together  or  link  with   Input File   or
  132.                     Output File, where Track A and Track B  appears  does
  133.                     not matter.
  134.  
  135.     - TRAKSWAP ..\GloryLve.mod .\ 1 4
  136.       Explanation : Swap track 1 and 4 of the file  GloryLve.mod  in  the
  137.                     directory one level  above  the  current.  Write  the
  138.                     output into GloryLve.mod in the current directory.
  139.  
  140.                                                        Track Swapper 1.00
  141.  
  142.     Error Messages
  143.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  144.  
  145.     When an error occurs, Track Swapper 1.00 will print a  message.  Some
  146.     of these messages will prompt  the  user  for  advice  to  solve  the
  147.     problem. Error messages and their explaination are as follows:
  148.  
  149.     - "Swapping with same track"
  150.       Program's immediate action: program ends
  151.  
  152.       Track Swapper 1.00 realise that Track A and Track B have  the  same
  153.       number. Swapping the same track makes no sense as what the user  is
  154.       trying to do, so the program print this error and exit  to  prevent
  155.       unnecessary processing of data which is a waste of time.
  156.  
  157.     - "Too many parameters"
  158.       Program's immediate action: program ends
  159.  
  160.       Track Swapper 1.00 detects too many parameters entered and fails to
  161.       determine which is the required parameters.
  162.  
  163.     - "The current drive is invalid ?!"
  164.       Program's immediate action: program ends
  165.  
  166.       This error may occurs when the program is trying to get the current
  167.       drive using DOS Interrupt routine. This error is not expected.
  168.  
  169.     - "Too many files selected"
  170.       Program's immediate action: program ends
  171.  
  172.       Too many files have been selected. This could be the cause of using
  173.       wildcards in Input File. The program found more than  one  matching
  174.       files that match the description in Input File. Being more specific
  175.       with the file name can avoid this error.
  176.  
  177.     - "No file selected"
  178.       Program's immediate action: program ends
  179.  
  180.       The  program  finds  no  file  name  matching  the  description  in
  181.       Input File. Check if the file exists or correct any typing mistake.
  182.       This error may also be caused by an invalid file name extension.
  183.  
  184.     - "Overwrite  .........  (Y/n) ?"
  185.       Program's immediate action: prompt user for advice
  186.  
  187.       Input File is equals to Output File. The program asks user  of  the
  188.       output data is to be written over the  original  file.  Type  Y  or
  189.       <Enter> to overwrite, N to exit Track Swapper.
  190.  
  191.     - "............ exists! Overwrite (y/N) ?"
  192.       Program's immediate action: prompt user for advice
  193.  
  194.       Output File matches another existing file. Type Y to overwrite  the
  195.       existing file or any other keys to exit the program.
  196.  
  197.                                                        Track Swapper 1.00
  198.  
  199.     - "Error opening ............ ─── Not present"
  200.       Program's immediate action: program ends
  201.  
  202.       Track Swapper had opened a zero byte file. This could be  cause  by
  203.       the absence of the file specified in Input File or the  file  is  a
  204.       zero byte file.
  205.  
  206.     - "Insufficient disk space for track swapping"
  207.       Program's immediate action: program ends
  208.  
  209.       There is not  enough  disk  space  in  the  destination  drive  for
  210.       Track Swapper to do its task. The  destination  drive  should  have
  211.       space slightly more than the file size of the source.
  212.  
  213.     - "Module Type : Startrekker. Header : ....
  214.        Should this MOD file be treated as a 15 samples MOD or 31  samples
  215.        MOD (1/3/A) ?"
  216.       Program's immediate action: prompt for advice
  217.  
  218.       Track Swapper detected that the selected MOD file is a  Startrekker
  219.       file. Track Swapper 1.00  will  ask  the  user  to  key  in  either
  220.       1,5 or A. Type 1 if the module is to be  handled  as  a  15 samples
  221.       file. Type 3 if the module is to be handled as a 31 samples module.
  222.       Type A to terminate Track Swapper (i.e. if you're not sure and want 
  223.       to consult a MOD editor).
  224.  
  225.     - "Unexpected error"
  226.       Program's immediate action: program ends
  227.  
  228.       An unexpected error occurs somewhere during  the  processing.  Some
  229.       unexpected events had taken place.
  230.  
  231.     Extended MOD Editor Series
  232.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  233.  
  234.     ProLogic 303 Software has started a new series  of  modules  editors.
  235.     There editors are different from those available. The series  provide
  236.     miscellaneous function and that  normal  editors  do  not  have.  For
  237.     example, series A is a track swapping utility.  More  of  the  series
  238.     will be introduced sometime later. Some  proposed  projects  includes
  239.     MODules analyser and MODules repair.
  240.  
  241.     Some Information for Programmers' Interest
  242.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  243.  
  244.     Track Swapper 1.00 is written in QuickBASIC 4.50. This  program  uses
  245.     no AT specific code, so this program will work even on XTs.
  246.  
  247.     Maximun speed capability is explored and implemented  in  every  part
  248.     of the program. This resulted in a 2020 lines source code.  If  speed
  249.     factor is to be ignored, the 2020 lines of source code can be shorten
  250.     into approximately 600 lines with about 70% reduction in the compiled
  251.     file size!
  252.  
  253.     The parameters verifying part like, reading the files directory, etc.
  254.     is achieved by using DOS interrupt routine.
  255.  
  256.                                                        Track Swapper 1.00
  257.  
  258.     Track Swapper 1.00's program structure are as follows:
  259.         - read and understand command parameters
  260.         - verify command parameters (to predict any errors beforehand)
  261.         - actual processing
  262.                 - copy MOD file header
  263.                 - swap 64 lines in a  pattern  (this  takes  50%  of  the
  264.                   source code)
  265.                 - write swapped pattern (there are  1024  bytes  in  each
  266.                   pattern)
  267.                 - loop until all pattern are swapped and written to disk
  268.                 - copy samples (MOD file instruments)
  269.                 - close all files
  270.         - end of program
  271.  
  272.     Packing List
  273.     ▀▀▀▀▀▀▀▀▀▀▀▀
  274.  
  275.     Track Swapper 1.00 comes as a package. This package contains:
  276.  
  277.       - TrakSwap.EXE ─── Main executable program
  278.            File size: 55128 bytes   Date: 22nd June 1993  Time: 3:03am
  279.                 File Authentication check method 1: 7E82
  280.                 File Authentication check method 2: 0659
  281.       - TrakSwap.DOC ─── Documentation for Track Swapper 1.00 (this file)
  282.            File size: 18739 bytes   Date: 22nd June 1993  Time: 3:03am
  283.  
  284.     Should any of the above file be missing or that their  date  or  file
  285.     size are different, the entire package is considered invalid. User is
  286.     advised to obtain a valid copy of Track Swapper.
  287.  
  288.     Copyrights
  289.     ▀▀▀▀▀▀▀▀▀▀
  290.  
  291.     Possession,   duplication,   distribution   and   using    of    this
  292.     ProLogic 303 Software  are  greatly  encourage   if   the   following
  293.     conditions are met.
  294.  
  295.     1. NO PART of the program (and the document) may  be  edited  in  any
  296.        form to any extent.
  297.  
  298.     2. User agrees that he WILL NOT attempt to reverse engineer,  modify,
  299.        translate or disassemble the software in whole or in part.
  300.  
  301.     3. Enclosed documents MUST be distributed with as a package.
  302.  
  303.     4. NO SUBLICENSE FEE.  Distributor may not charge its  customers  for
  304.        the software other than a nominal fee to cover for the cost of the
  305.        diskette.
  306.  
  307.                                                        Track Swapper 1.00
  308.  
  309.     5. If you want to distribute this software with a publication or with
  310.        your  product,  you  have  to  inform   the   author   about   the
  311.        publication. Permission  is  usually  granted.  This  notification
  312.        is to assist the  author  in  tracking  the  distribution  of  his
  313.        product.
  314.  
  315.     An exemption from any of the above  conditions  can  be  obtain  upon
  316.     written request with valid reasons.
  317.  
  318.     Warranty
  319.     ▀▀▀▀▀▀▀▀
  320.  
  321.     In  no  event  shall  members   of   ProLogic 303 Software   or   its
  322.     distributors be  liable  for  consequential,  incidental,  direct  or
  323.     indirect damages of any kind arising out of the delivery, performance
  324.     or use  of  the  software,  even  if  ProLogic 303 Software  and  its
  325.     distributors have been advised of the possibility of such damages.
  326.  
  327.     ProLogic 303 Software hereby disclaims  all  warranties  relating  to
  328.     this software, including any implied warranties  of  merchantability,
  329.     any theory of liability or fitness for a particular purpose.
  330.  
  331.     ProLogic 303 Software does not warrant that this  software  is  error
  332.     free. User of this software bears all risk  as  to  the  quality  and
  333.     performance of the software. However, ProLogic 303 Software tries its
  334.     best to provide quality programs for its users.
  335.  
  336.     Technical Support
  337.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  338.  
  339.     If you have encountered any problem or have any  questions  regarding
  340.     Track Swapper, please feel free to send them to the address below.
  341.  
  342.     Of if you have any comments or complains to make, do drop  the  us  a
  343.     mail.
  344.  
  345.     Direct all mails to:
  346.  
  347.                 Mr. NG PEI SIN,
  348.                 ProLogic 303 Software.
  349.                 111, Tampines Rd,
  350.                 Yi Mei Garden, #02-03,
  351.                 Singapore 1953.
  352.  
  353.     Or if you prefer, send a mail through the bulletin boards. Your  mail
  354.     will be replied immediately, if received.
  355.  
  356.                                                        Track Swapper 1.00
  357.  
  358.     Credits
  359.     ▀▀▀▀▀▀▀
  360.  
  361.     A group of people was invited to  test  this  product  before  it  is
  362.     released to the public. This group of people are:
  363.                 - Cheng Tze Yang, and
  364.                 - Clarence Song.
  365.                 (in alphabetical order)
  366.  
  367.     Donations
  368.     ▀▀▀▀▀▀▀▀▀
  369.  
  370.     This program has been donated to public domain. As  a  public  domain
  371.     program, users are not required to pay any registration fee.
  372.  
  373.     If, for any reason like feeling a little heavy  in  the  wallet,  you
  374.     feel like giving a donation (money or hardware) to us, please address
  375.     them to:
  376.  
  377.                 Mr. NG PEI SIN,
  378.                 ProLogic 303 Software.
  379.                 111, Tampines Rd,
  380.                 Yi Mei Garden, #02-03,
  381.                 Singapore 1953.
  382.  
  383.     Voluntary distributors wanted
  384.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  385.  
  386.     ProLogic 303 Software  is  looking  for  voluntary  distributors   to
  387.     distribute  its  products. ProLogic 303 Software's  products  include
  388.     MOD files and some utilities for IBM PCs/ATs.
  389.  
  390.     If you think you can help in  the  distribution,  please  send  us  a
  391.     letter or electronic mail to  inform  us.  This  is  to  help  us  in
  392.     tracking the location of our products. International  or  even  local
  393.     distributions are welcomed.
  394.  
  395.     Distributors will:
  396.     - get   first   hand   information    on    the    developments    of
  397.       ProLogic 303 Software, 
  398.     - be informed of the latest release of our products,
  399.     - be informed where to obtain a copy of  the  released  products.  In
  400.       some special cases, a copy of it may be mailed to you.
  401.  
  402.                                                        Track Swapper 1.00
  403.  
  404.     Voluntary partners wanted
  405.     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  406.  
  407.     If you are skilled in  programming,  writing  documents,  MODules  or
  408.     have    any    other    special    skills    that    will     benefit
  409.     ProLogic 303 Software, please consider joining us.
  410.  
  411.     We are a group of people out to spread our name through public domain
  412.     software and MODules.
  413.  
  414.     Just send us your particulars and a photograph of yourself.
  415.  
  416.     Thank You for downloading/copying this product.
  417.  
  418.     ┌────────────────────────────────────────────────────────────────────┐
  419.     │                ▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄                │
  420.     │             ▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄             │
  421.     │           ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄           │
  422.     │          ▄▄▄▄▄▄▄▄▄▄       ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄       ▄▄▄▄▄▄▄▄▄          │
  423.     │         ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄         │
  424.     │         ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄         │
  425.     │          ▄▄▄▄▄▄▄▄▄▄       ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄       ▄▄▄▄▄▄▄▄▄          │
  426.     │           ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄           │
  427.     │             ▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄             │
  428.     │                ▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄                │
  429.     │                                                                    │
  430.     │              P r o L o g i c   3 0 3   S o f t w a r e             │
  431.     └────────────────────────────────────────────────────────────────────┘
  432.  
  433.  
  434.