home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / MM1 / SOUNDUTILS / mm1_tracker.lzh / TRACKER4.6 / Docs / tracker.doc < prev    next >
Text File  |  1994-11-24  |  8KB  |  205 lines
  1. History:
  2. -------
  3. soundtracker was originally written by Karsten Obarsky for the amiga, a
  4. loong time ago. There have been numerous variants built upon it, the
  5. latest being protracker.
  6.  
  7. Liam Corner had the original idea of a player for the sunstation, and
  8. proved that it was possible. 
  9. I wouldn't have thought of writing it myself, but armed with his original code, 
  10. I used my knowledge of the amiga tracker format to `add some improvements'. 
  11. Of course, I ended up rewriting the whole code. At that point, it ran on 
  12. silicon graphics indigos and suns.
  13.  
  14. Steve Haehnichen wrote a soundblaster variant of that program which I have 
  15. finally added to the other versions. I did not have any news from him for
  16. sometime now, so I've decided to distribute it all. If it doesn't work as it is,
  17. it shouldn't be difficult to fix. 
  18.  
  19. Hannu Savolainen sent me the linux version and helped me put it up to date.
  20. This one should work.
  21.  
  22. Bjoern Stabell and Markus Gyger sent me some support for hpux, Andrew Leahy 
  23. for decs.
  24. Thomas R. Lawrence is still updating his port for the macintosh.
  25.  
  26. Dave Tiller sent me the fix for solaris 2.2
  27.  
  28. I finally got to port it BACK to the amiga. Full circle !
  29. Cyrille Micheneau and Pascal Rullier have volunteered to help me with that.
  30. Reinhard Katzmann succesfully compiled the preliminary release of tracker for
  31. the amiga.
  32.  
  33. Some other people have helped me recently. 
  34. Mike Battersby sent me some interim bug-fixes for linux and a much better
  35. design for the makefile.
  36. Andrew A. Chernov is the guy behind the FreeBSD port.
  37.  
  38. Many thanks also to Matthew Donaldson, Joerg-Cyril Hoehle and Lukas Wunner 
  39. for sending me very useful bug reports and giving us an ever better 
  40. sounding player !
  41.  
  42. Also, thanks to Loic Grenie, whose unix expertise I used extensively to
  43. get bg/fg routines to `work' (remaining bugs are mine, of course).
  44.  
  45. There are obviously some people I may have forgotten or incorrectly cited in
  46. this text. I hope this is not too dire a problem.
  47.  
  48. I also heard of some variants on the NeXt which I have been too busy to get
  49. yet. 
  50.  
  51. If you want to modify tracker or make it run on another machine, or correct
  52. problems, please do so.
  53. HOWEVER, IF YOU INTEND TO PORT IT TO ANOTHER MACHINE, I WOULD VERY MUCH
  54. APPRECIATE THAT YOU CHECK UP WITH ME FIRST. 
  55. There just might already be a port in progress, or I might have a newer
  56. version. Even so, I'd like to be able to maintain one source instead of
  57. a bazillion of version. My e-mail is espie@ens.fr, not liable to change
  58. for some time.
  59.  
  60. PRELIMINARY
  61. -----------
  62. As I am a lazy person, this file tends to change more slowly than the tracker
  63. program itself.  Some options may no longer exist, some may have been added.
  64. Many things may be different.  I mainly try to get out a working, efficient
  65. reasonably bug-free program.  If I manage to write corresponding docs, fine !
  66. If I don't, tough luck ! Anyhow, looking at the source file should provide
  67. you with enough insight for everything.
  68. --
  69.  
  70. This is tracker version 4.3. It includes numerous bug-fixes, a much better
  71. command line interface and runtime interface, and improved support for 
  72. compressed formats--thanks to Steve for this.  As this version was not tested
  73. on the old soundblaster port, you might need to do some tweaking around 
  74. to make it work for such a machine. If you would be kind enough as to
  75. send me any requested changes, I would appreciate it.
  76.  
  77. To build tracker, you should have a good look at the makefile.
  78. Usually, just changing the install dir, and machine, then
  79. make install should be enough.  You may want to install tracker by hand,
  80. as it is trivial. 
  81.  
  82. tracker is a giftware program, it is not guaranteed to do anything
  83. at all, either useful or useless. You've been warned, use it at your own risk. 
  84. This said, there doesn't seem to be any relevant bugs left in the current
  85. revision of code, and it is getting more and more stable.
  86.  
  87. ``Soundtracker'' is a family of music composition programs
  88. that exists on the amiga. The resulting data files (modules)
  89. have been appearing on ftp sites for some time now.
  90.  
  91. For a machine with sufficient horsepower and some audio capability,
  92. it is possible to emulate the amiga audio hardware in real time,
  93. and play those modules.
  94. After that, you're only limited by the machine's capabilities. The
  95. sparc is a bit poor (8Khz sampling), in contrast with the indigo,
  96. which gives an almost perfect rendition of most modules.
  97.  
  98. This release of tracker supports most amiga soundtracker file formats,
  99. and plays most of the existing effects, so that about 99% of the modules
  100. are output correctly.
  101.  
  102. Here is some supplementary information.
  103.  
  104. Environment variables:
  105. OVERSAMPLE can be used to control the accuracy of the reproduction.
  106. (The number of samples used to output one audio word).
  107. The higher, the better, but the more CPU it will use. The default
  108. value (1) is quite good at high frequencies, but not so for, for instance
  109. a poor sparc station's 8000 Hz. You can try, say, 2 or 3. After that,
  110. there won't be any noticeable improvement, and anyway, the program won't
  111. be fast enough to keep up with the output rate. Note that the program is
  112. special-cased for the default value (1), which should be significantly faster
  113. on some architectures.
  114.  
  115. FREQUENCY can be used to set the audio output at a specific frequency
  116. (if the hardware supports it). The hardware will decide which frequency
  117. to actually use, according to other external parameters.
  118.  
  119. MONO can be used to force mono output, which uses less
  120. cpu power.
  121.  
  122. TRANSPOSE is the number of halftones to transpose each note (>0 is higher).
  123. Useful for low frequency sparcs which can't play some tunes accurately, or
  124. when you get bored...
  125.  
  126. MODPATH can be set to be a path where you wish to look for mod files. This
  127. is a sh-styled path: setenv MODPATH dir1:dir2:...
  128.  
  129. Command line switches:
  130. -stereo/-mono: 
  131.     switch between stereo/mono output
  132. -mix <percent>: 
  133.     for stereo output, decide how to mix left/right channels.
  134.     0 is spatial stereo, 100 is mono. The change tends to
  135.     be exponential, so you may want to experiment with values 
  136.     around 90+.
  137. -frequency <freq>:
  138.     ask for a given output frequency. The normal output frequency
  139.     is a `normal' frequency for your machine. <freq> will be rounded
  140.     to a near available value.
  141. -oversample <n>:
  142.     where n is usually 1, 2 or 3. Try to use 1,2 or 3 sample values
  143.     to accurately render a given sample. Changing the frequency 
  144.     usually works better, but there might be cases where 2 or 3 gives
  145.     you a better rendering for a given module. Big cpu-eater.
  146. -new/old/both:
  147.     select a soundtracker format, between new (31 instr), old (15 instr)
  148.     and both (auto-detect what's going on). You should only use it if
  149.     tracker gets very confused on a module.
  150. -picky:
  151.     do not allow for any problems in a module.
  152. -tolerant:
  153.     allow for many problems that would normally stop a module
  154. -repeats / -repeats <n>:
  155.     repeat each module n times. With no value (or a 0), repeat the
  156.     module forever.
  157. -verbose:
  158.     show a sample listing for the module.
  159. -scroll:
  160.     scroll-display the module being played.
  161. -sync:
  162.     try to synchronize that scroll display with what you hear.
  163.     Needs much cpu power to work correcty.
  164. -speed <n>:
  165.     change the base tempo to n. The normal value is 50 (PAL video
  166.     frequency). Some modules have been written on a buggy NTSC composer,
  167.     so you may wish to use -speed 60. Weird values like -speed 10 or
  168.     -speed 2000 are allowable. 
  169.     Note that the samples may sound a bit strange since you only change
  170.     the tempo there.
  171. -transpose <k>:
  172.     transpose the song up k half-notes. Doesn't work all the time.
  173.     Doesn't work right most of the time. For fun only. If k is
  174.     negative, it obviously transposes the song down.
  175. -start n:
  176.     start the module at pattern number n instead of number 0
  177.  
  178.         Sample control:
  179.         --------------
  180. -cut 012...abcd:
  181.     suppress samples from the audio output.
  182. -add 012..abcd 
  183.     add samples to the audio output (exclusive with cut).
  184.  
  185.  
  186. Runtime control:
  187.     n: go to next song
  188.     p: restart current song/go to previous song
  189.     >: fast forward
  190.     <: rewind
  191.     S: NTSC tempo (60)
  192.     s: PAL tempo (50)
  193.     q
  194.     x
  195.     e: quit right away
  196.  
  197. Send bug reports to espie@ens.fr,
  198.  
  199. encouragements and nice things to espie@ens.fr, zenith@dcs.warwick.ac.uk, 
  200. shaehnic@ucsd.edu, hsavolai@cc.helsinki.fi 
  201. --
  202.  
  203.     Marc Espie, Paris, february 1994
  204.  
  205.