home *** CD-ROM | disk | FTP | other *** search
/ Collection of Hack-Phreak Scene Programs / cleanhpvac.zip / cleanhpvac / CV2SAM31.ZIP / CVT2SAM.DOC next >
Text File  |  1993-03-07  |  8KB  |  200 lines
  1. ----------------------------------------------------------------------
  2.                Convert to SAM 
  3. ----------------------------------------------------------------------
  4.  
  5.               Version 3.01 (03/06/93)
  6.               Jim Dahl
  7.  
  8. ---------------------------------------
  9. 0. THIS VERSION
  10. ---------------------------------------
  11.  
  12. 1.1 HISTORY. This is the fifth 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. Version 3.00 (Mar 05, 1993)
  49.     SPEED!  As always in new versions, all routines run faster, but
  50.         this time VERY dramatically!
  51.     Added ability to convert WAV files
  52.     Fixed bugs in certain VOC blocks (silence primarily)
  53.     Released to only select locations as 'test' version
  54.  
  55. Version 3.01 (Mar 06, 1993)
  56.     Addresses bugs discovered in 3.00, public release
  57.  
  58.  
  59. 1.2 WHY USE CVT2SAM?  CVT2SAM is provided to you, by me, as a free utility.
  60. I encourage you to use it and copy it.  CVT2SAM, however, is not 'junkware'
  61. (a cheap utility whipped up overnight then sent to the mass markets and left
  62. unsupported), rather it constantly evolves and includes many hours work and
  63. thousands of lines of code.  Each section of code has been rewritten, from
  64. scratch, two or three times to optimize the speed and increase modularity of
  65. the code.  I have heard many comments that the speed of CVT2SAM is amazingly
  66. fast compared to other utilities of the type (though most utilities just strip
  67. the VOC header and treat the rest as raw data, rather than processing the
  68. individual blocks in blocked VOC's).  
  69.  
  70. ---------------------------------------
  71. 1. PURPOSE
  72. ---------------------------------------
  73.  
  74. CVT2SAM converts raw sound files and VOC files to .SAM files
  75. suitable for use in ModEdit.  Most types of VOC files and WAV files, and all 
  76. raw sound types work with CVT2SAM.  If the CTV format is not recognized,
  77. the type will be assumed to be a raw sample, so unknown formats will not 
  78. be converted correctly.
  79.  
  80. CVT2SAM will also convert instruments (SAM files) back to raw sound data
  81. so you can edit it with your standard sound editor using the '-R' switch.
  82. (You can then, of course, convert your edited instrument back to a SAM).
  83.  
  84. ---------------------------------------
  85. 2. USAGE
  86. ---------------------------------------
  87.  
  88. After typing 'CVT2SAM' on the command line, the program will prompt for
  89. an input file name and an output file name.  The output file name will
  90. default to the first eight characters of the input file name with a '.SAM'
  91. extension.
  92.  
  93. Instead of using the interactive mode, the user can also type:
  94.  
  95.      CVT2SAM  [InFile] [OutFile] [-?] [-C] [-R]
  96.  
  97. If both an input file and an output file are specified, the program will
  98. execute the conversion.  If only an input file is specified, the program
  99. will prompt for an output file, with a default value of the first eight
  100. characters of the input file name with a '.SAM' extension.
  101.  
  102. It is recommended that the '.SAM' extension be used, as ModEdit will only
  103. recognize those samples which have an '.SAM' extension.
  104.  
  105. CVT2SAM assumes that the OutFile should be overwritten if it already exists
  106. and therefore does not prompt or warn the user.
  107.  
  108. The '-?' option brings up a short help screen.  The '-C' option instructs
  109. the CTV converter to convert even compressed data (see note in section 4.3).
  110.  
  111. The '-R' option tells CVT2SAM that you are converting a SAM file back to
  112. a raw sound sample.  In this case, the default output file has a 'RAW'
  113. extension.
  114.  
  115. --------------------------------------*
  116. 3. FUNCTION
  117. --------------------------------------*
  118.  
  119. 3.1 WHAT DOES CVT2SAM DO?  CVT2SAM converts the sound data from the input 
  120. file from unsigned to signed sound data.  (Most popular sound types, 
  121. including VOC files, use unsigned data; SAM files use signed data).  CVT2SAM 
  122. also recognizes CTV block types headers and performs the appropriate action 
  123. to convert the blocks to raw sound data when possible.
  124.  
  125. 3.2 HOW EFFICIENT IS CVT2SAM?  CVT2SAM was written in assembly, then PKLITE'd 
  126. so it is very compact and time efficient.  (For version 3.01 the VOC
  127. routines have been optimized, again.)
  128.  
  129. --------------------------------------*
  130. 4. USAGE TIPS - RAW, VOC, and WAV FILES
  131. --------------------------------------*
  132.  
  133. 4.1 VOC SAMPLING RATES.  A rate of 8000hz corresponds to C2 in ModEdit, 
  134. the default instrument pitch.  However, with ModEdit 3, you can adjust the
  135. rate of each sample at playback or loading time, therefore all VOC speeds
  136. and sampling rates can be used.  WAV files come only in certain sampling
  137. rate, so adjustment of the pitch will be necessary in ModEdit.
  138.  
  139. 4.2 VOC BLOCK TYPES.  This version of CVT2SAM recognizes VOC file structure 
  140. and all current block types.  Silence blocks are expanded; new data and 
  141. consecutive data blocks are converted, marker blocks are discarded, message 
  142. blocks are displayed on the screen, and repeat blocks are expanded.
  143.  
  144. 4.3 VOC COMPRESSION.  As the hardware compression feature of the Sound 
  145. Blaster actually discards data from the VOC, compressed VOC files are not 
  146. supported.  Though the -C option is available to force the conversion of
  147. compressed VOC files, I do not recommend its use.  The resulting SAM file
  148. will be very poor quality, as the decompression occurs on a hardware level
  149. at playback time, not in the software.  The feature is included only for
  150. completeness.
  151.  
  152. 4.4 NEW VOC TYPES.  Stereo VOC blocks can not be used, as the SAM format 
  153. does not support stereo and there is no comfortable way to convert a 
  154. stereo sample to a mono sample.  Also, the high sampling rate VOC files
  155. are not supported (above 22000hz) because I don't have any to test.  As I 
  156. gain information of other new block types, I will address them and include 
  157. them if appropriate.
  158.  
  159. 4.5 WAV FILES.  CVT2SAM now supports the conversion of WAV files.  The WAV
  160. file must be a standard RIFF file with a single WAV block (i.e. no imbedded
  161. pictures or MIDI information or other RIFF blocks, including second WAV
  162. blocks).  Though the specification does allow for them, I have never seen
  163. such a WAV file, however, so most should be supported.
  164.  
  165. ----------------------------------------
  166. 5. SUPPORT
  167. ----------------------------------------
  168.  
  169. Should you encounter ANY error, please contact me, and send me the file
  170. (if applicable).
  171.  
  172.  
  173. I can be contacted at:
  174.  
  175. Internet
  176.     JADAHL@VM1.NoDak.Edu
  177.  
  178. Compuserve, AOL, other on-line services
  179.     Though I subscribe to many of these, mail will reach me quickest
  180.     if you route it to my Internet address
  181.  
  182. Dakota Systems BBS
  183.     (701) 746-5291  (USR Dual Standard)
  184.     (701) 775-0872  (2400 baud)
  185.     Jim Dahl
  186.  
  187. City Lites BBS
  188.     (701) 775-1143  (2400- baud)
  189.     (701) 772-5399  (9600+ baud)
  190.     Jim Dahl
  191.  
  192. Home
  193.     Jim Dahl
  194.     2236 Springbrook Ct.
  195.     Grand Forks, ND 58201
  196.  
  197. Feel free to contact me with any questions/comments (particularly error
  198. reports!)  If for some reason you want the source code, no problem, just
  199. get in touch.
  200.