home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-386-Vol-2of3.iso / c / cv2sam22.zip / CVT2SAM.DOC next >
Text File  |  1993-02-17  |  8KB  |  188 lines
  1. ----------------------------------------------------------------------
  2.                Convert to SAM 
  3. ----------------------------------------------------------------------
  4.  
  5.               Version 2.20 (02/20/93)
  6.               Jim Dahl
  7.  
  8. ---------------------------------------
  9. 0. THIS VERSION
  10. ---------------------------------------
  11.  
  12. 1.1 HISTORY. This is the fourth version (versions 1.00 and 1.10 supported only 
  13. RAW data, requiring a VOC conversion utility to be utilized).  With VOC 
  14. support added, the program has been renamed from RAW2SAM to CVT2SAM to 
  15. demonstrate its multi-format input capabilities.
  16.  
  17. Version 1.00 (Nov 92)
  18.     First release written for a friend
  19.     Converted raw data to SAM data
  20.  
  21. Version 1.10 (Dec 1, 1992)
  22.     Makes 1.00 more usable (no notable new features)
  23.     Added parameter reading routines so filenames can now be specified
  24.         on the command line
  25.     Complete rewrite of raw data to SAM conversion code (VERY efficient
  26.         now!)
  27.  
  28. Version 2.00 (Feb 15, 1993)
  29.     Very buggy version of 2.01, same features, but many didn't work.
  30.     A few copies leaked out before I caught the problems, which were
  31.         corrected within the day.
  32.  
  33. Version 2.01 (Feb 15, 1993)
  34.     Name changed to CVT2SAM to reflect new multi-format ability
  35.     Added VOC support (inlcuding blocked VOC's.  Supported are:
  36.         message blocks, marker blocks, data blocks, subsequent
  37.         data blocks, silence blocks.  Also recognized, but not
  38.         expanded were repeat blocks.
  39.     Added option '-C' to convert packed data
  40.     Added help screen '-?' online
  41.  
  42. Version 2.20 (Feb 20, 1993)
  43.     VOC routines rewritten to be optimally efficient (were dependant
  44.         on RAW routines before for data processing)
  45.     Added '-R' option to reverse conversion from SAM to RAW
  46.     Added ability to expand VOC repeats
  47.  
  48.     * This will be the final version unless new bugs are discovered, or
  49.     * I decide to add support for new formats.  I will, of course,
  50.     * support this program, free of charge, however, so feel free to
  51.     * contact me (I will even honor most requests for new features if
  52.     * I have the time).
  53.  
  54. 1.2 WHY USE CVT2SAM?  CVT2SAM is provided to you, by me, as a free utility.
  55. I encourage you to use it and copy it.  CVT2SAM, however, is not 'junkware'
  56. (a cheap utility whipped up overnight then sent to the mass markets and left
  57. unsupported), rather it constantly evolves and includes many hours work and
  58. thousands of lines of code.  Each section of code has been rewritten, from
  59. scratch, two or three times to optimize the speed and increase modularity of
  60. the code.  I have heard many comments that the speed of CVT2SAM is amazingly
  61. fast compared to other utilities of the type (though most utilities just strip
  62. the VOC header and treat the rest as raw data, rather than processing the
  63. individual blocks in blocked VOC's).  
  64.  
  65. ---------------------------------------
  66. 1. PURPOSE
  67. ---------------------------------------
  68.  
  69. CVT2SAM converts raw sound files and VOC files to .SAM files
  70. suitable for use in ModEdit.  Most types of VOC files and all raw
  71. sound types work with CVT2SAM.  If the CTV format is not recognized,
  72. the type will be assumed to be a raw sample, so unknown formats, such as
  73. Microsoft's WAV format, will not be converted correctly.
  74.  
  75. CVT2SAM will also convert instruments (SAM files) back to raw sound data
  76. so you can edit it with your standard sound editor using the '-R' switch.
  77. (You can then, of course, convert your edited instrument back to a SAM).
  78.  
  79. ---------------------------------------
  80. 2. USAGE
  81. ---------------------------------------
  82.  
  83. After typing 'CVT2SAM' on the command line, the program will prompt for
  84. an input file name and an output file name.  The output file name will
  85. default to the first eight characters of the input file name with a '.SAM'
  86. extension.
  87.  
  88. Instead of using the interactive mode, the user can also type:
  89.  
  90.      CVT2SAM  [InFile] [OutFile] [-?] [-C] [-R]
  91.  
  92. If both an input file and an output file are specified, the program will
  93. execute the conversion.  If only an input file is specified, the program
  94. will prompt for an output file, with a default value of the first eight
  95. characters of the input file name with a '.SAM' extension.
  96.  
  97. It is recommended that the '.SAM' extension be used, as ModEdit will only
  98. recognize those samples which have an '.SAM' extension.
  99.  
  100. CVT2SAM assumes that the OutFile should be overwritten if it already exists
  101. and therefore does not prompt or warn the user.
  102.  
  103. The '-?' option brings up a short help screen.  The '-C' option instructs
  104. the CTV converter to convert even compressed data (see note in section 4.3).
  105.  
  106. The '-R' option tells CVT2SAM that you are converting a SAM file back to
  107. a raw sound sample.  In this case, the default output file has a 'RAW'
  108. extension.
  109.  
  110. --------------------------------------*
  111. 3. FUNCTION
  112. --------------------------------------*
  113.  
  114. 3.1 WHAT DOES CVT2SAM DO?  CVT2SAM converts the sound data from the input 
  115. file from unsigned to signed sound data.  (Most popular sound types, 
  116. including VOC files, use unsigned data; SAM files use signed data).  CVT2SAM 
  117. also recognizes CTV block types headers and performs the appropriate action 
  118. to convert the blocks to raw sound data when possible.
  119.  
  120. 3.2 HOW EFFICIENT IS CVT2SAM?  CVT2SAM was written in assembly, then PKLITE'd 
  121. so it is very compact and time efficient.  (For version 2.20 the VOC
  122. routines have been rewritten to be optimally efficient.)
  123.  
  124. --------------------------------------*
  125. 4. USAGE TIPS - RAW and VOC FILES
  126. --------------------------------------*
  127.  
  128. 4.1 VOC SAMPLING RATES.  A rate of 8000hz corresponds to C2 in ModEdit, 
  129. the default instrument pitch.  However, with ModEdit 3, you can adjust the
  130. rate of each sample at playback or loading time, therefore all VOC speeds
  131. and sampling rates can be used.
  132.  
  133. 4.2 VOC BLOCK TYPES.  This version of CVT2SAM recognizes VOC file structure 
  134. and all current block types.  Silence blocks are expanded; new data and 
  135. consecutive data blocks are converted, marker blocks are discarded, message 
  136. blocks are displayed on the screen, and repeat blocks are expanded.
  137.  
  138. 4.3 VOC COMPRESSION.  As the hardware compression feature of the Sound 
  139. Blaster actually discards data from the VOC, compressed VOC files are not 
  140. supported.  If you do not have or can not obtain a decompressed copy of the 
  141. VOC file, use the -C switch to tell CVT2SAM to convert compressed data as 
  142. well (though bear in mind that the actual decompression of it is done by the 
  143. hardware at playback time only if the sound is in VOC format, so by 
  144. converting a 2:1 compressed VOC sampled at 8000hz, you would be left with a 
  145. much poorer quality 4000hz SAM file.  That is why hardware compression is 
  146. NOT supported by default, and not recommended).
  147.  
  148. 4.4 NEW VOC TYPES.  Stereo VOC blocks can not be used, as the SAM format 
  149. does not support stereo and there is no comfortable way to convert a 
  150. stereo sample to a mono sample.  As I gain information of other new block
  151. types, I will address them and include them if appropriate.
  152.  
  153. ----------------------------------------
  154. 5. SUPPORT
  155. ----------------------------------------
  156.  
  157. Should you encounter ANY error, please contact me, and send me the file
  158. (if applicable).
  159.  
  160.  
  161. I can be contacted at:
  162.  
  163. Internet
  164.     JADAHL@VM1.NoDak.Edu
  165.  
  166. Compuserve, AOL, other on-line services
  167.     Though I subscribe to many of these, mail will reach me quickest
  168.     if you route it to my Internet address
  169.  
  170. Dakota Systems BBS
  171.     (701) 746-5291  (USR Dual Standard)
  172.     (701) 775-0872  (2400 baud)
  173.     Jim Dahl
  174.  
  175. City Lites BBS
  176.     (701) 775-1143  (2400- baud)
  177.     (701) 772-5399  (9600+ baud)
  178.     Jim Dahl
  179.  
  180. Home
  181.     Jim Dahl
  182.     2236 Springbrook Ct.
  183.     Grand Forks, ND 58201
  184.  
  185. Feel free to contact me with any questions/comments (particularly error
  186. reports!)  If for some reason you want the source code, no problem, just
  187. get in touch.
  188.