home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1999 February / PCO_0299.ISO / filesbbs / linux / mikmod-3.000 / mikmod-3 / mikmod-3.1.2 / README < prev    next >
Encoding:
Text File  |  1998-12-07  |  8.0 KB  |  243 lines
  1.  
  2.                               //===============\\
  3.                               ||               ||
  4.                               ||  MikMod'Unix  ||
  5.                               ||               ||
  6.                               \\===============//
  7.  
  8.                                  version 3.1.2
  9.  
  10.  
  11. Hello folks !
  12.  
  13. You've just got the latest version of MikMod, numbered 3.1.2.
  14. As usual with each new version, there's a lot of bugfixes and
  15. improvements.
  16. Check out the ChangeLog for more information.
  17.  
  18.  
  19. Building MikMod under Unix (refer to README.OS2 for OS/2)
  20. --------------------------
  21.  
  22. You'll need an ANSI C compiler to build MikMod.
  23.  
  24. In this directory, run
  25.  
  26.   ./configure
  27.  
  28. The configure script will attempt to guess correct values for various
  29. system-dependent variables used during the build process, and will
  30. create appropriate Makefiles for proper compilation. 
  31.  
  32. If you're not familiar with configure scripts and their standard
  33. options, you can find more general information about them in the file
  34. INSTALL.
  35.  
  36. The configure script can be given several options to tweak your
  37. configuration of MikMod :
  38.  
  39. * library options :
  40.  
  41. --enable-af : This option will compile the Digital AudioFile driver.
  42. --enable-alsa : This option will compile the Advanced Linux Sound
  43. Architecture driver.
  44. --enable-esd : This option will compile the Enlightened Sound Daemon
  45. driver.
  46. --enable-oss : This option will compile the Open Sound System driver.
  47.  
  48. Since the configure script will search for the appropriate include
  49. files and drivers, to compile as much drivers as possible, these
  50. options are mostly useful in their negative form :
  51.  
  52.   ./configure --disable-esd
  53.  
  54. will configure MikMod without the Enlightened Sound Daemon driver, even
  55. if all the necessary files for compiling are present on the system. 
  56.  
  57. --enable-hqmixer : This option will use the high-quality mixer instead
  58. of the fast default mixer. The high-quality mixer works hard to prevent
  59. clicks and other spurious noise in output. However, doing this needs a
  60. lot of CPU power. On my main development machine, a PC with a 200 MHz
  61. processor runninga slow Unix flavour, the high-quality mixer isn't fast
  62. enough to mix at 44100 Hz, and can't mix more than 16 channels real-time
  63. at 22050 Hz. Your mileage may vary, but if you don't have a very fast
  64. machine or are using a output-to-disk driver, you won't like this option.
  65.  
  66. * player option :
  67.  
  68. --enable-snagger : On some platforms (currently only Linux, FreeBSD,
  69. NetBSD and OpenBSD), this option will enable the rescheduling options of
  70. MikMod, which can be used to gain more CPU time. Obviously, this needs
  71. root privileges, or at least that MikMod is setuid root.
  72.  
  73.  
  74. After you've successfully run configure, simply run
  75.  
  76.   make
  77. to get all things build. Then, run
  78.  
  79.   make install
  80.  
  81. to have both the library and the player installed. Depending on where
  82. you choose to install them (using the --prefix= option in configure),
  83. you may need root privileges for this operation.
  84.  
  85.  
  86. Using the player
  87. ----------------
  88.  
  89. Run MikMod without parameters to get the available options, or display
  90. its man page (if you did "make install") with
  91.  
  92.   man mikmod
  93.  
  94. Once you're in the player, if you haven't choosed terse mode (a la
  95. MikMod 2), pressing the H key will give you an help screen with the list
  96. of the keys you can use. I hope it's understandable.
  97.  
  98. If you're playing MikMod in quiet mode under Unix (with the -q/-quiet
  99. switch), you can tell MikMod to jump to the next/previous song by
  100. sending the MikMod process SIGUSR1 or SIGUSR2 respectivly. In other
  101. words, let's say you're doing something like this:
  102.  
  103. $ mikmod -playlist myalltimefavmods -random -once -tol -quiet &
  104. [1] 7531
  105.  
  106. You've told MikMod to read the songs out of the playlist myalltimefavmods
  107. (-playlist), to play them in random order (-random) , to delete each
  108. module from the playlist after playing (so none get played twice) -once),
  109. to skip over any file access errors (-tol), to not spit out any output
  110. (-quiet), and to run in the background.
  111. Your shell will give you the process ID, in this case it's 7531.  You
  112. can also find this out from "ps", "top", or a number of process
  113. management utilities.  Now, let's say a song you don't like as much comes
  114. on, or for some reason one seems to be looping forever, you can do
  115. this...
  116.  
  117. $ kill -s SIGUSR1 7531
  118.  
  119. or
  120.  
  121. $ kill -USR1 %1
  122.  
  123. (if your shell supports the %n process notation)
  124. and MikMod will start playing the next file in the list.
  125. If you want the previous file, just use SIGUSR2 in place of SIGUSR1.
  126. Note that if you've used the "play once" option (-k/-once), asking for
  127. the previous song will in fact restart the current song.
  128. This feature also works when MikMod is in interactive mode (with the
  129. curses interface), but is less useful then, since you have full player
  130. control...
  131.  
  132.  
  133. Known problems
  134. ______________
  135.  
  136. Alas, no software is perfect, and MikMod still has a few bugs... However,
  137. we're working on them and you can bet they'll disappear in a future
  138. release.
  139.  
  140. - The DSM loader has not been extensively tested and may be broken. I
  141.   would like to hear about them, success as well as failures... And if
  142.   you have such modules, I'd like to get them for testing...
  143. - Synthsound instruments (midi-like) are not played in MED modules, and
  144.   effect 9 is not played correctly... yet.
  145. - The EsounD driver has some issues. Please read README.EsounD if you
  146.   want to use this driver.
  147.  
  148.  
  149. Future
  150. ______
  151.  
  152. Here's what's on my todolist :
  153.  
  154. - Fix all remaining bugs. Yes, really.
  155. - Port to more hardware and more Unices
  156. - Write a nice X11 interface...
  157. - Write a file selector and playlist manager for the curses player
  158. - Anything else which will be requested...
  159.  
  160.  
  161. Status
  162. ------
  163.  
  164. The following platforms are known to work :
  165.  
  166. - Linux i386 :
  167.    o with the built-in OSS driver in kernels 2.* ; it may work with 1.*
  168.      kernels but has not been tested.
  169.    o with the EsounD driver (on top of OSS and ALSA).
  170.      Please read README.Esound as well.
  171.    o with the ALSA driver
  172.      Please read README.ALSA as well.
  173.  
  174. - FreeBSD with the built-in OSS driver.
  175.  
  176. - OpenBSD 2.2 i386, with the OpenBSD driver. NetBSD should work as well.
  177.   
  178. - HP-UX 10 on HP 9000 hardware, with the HP audio driver.
  179.  
  180. - IRIX 6 on various SGI hardware :
  181.    o using the SGI Audio library.
  182.      Please read README.SGI as well.
  183.    o using the EsounD driver.
  184.      Please reade README.EsounD as well.
  185.  
  186. - Various Sun Sparc/UltraSparc running Solaris 2.5, 2.5.1 and 2.6
  187.   Please read README.SUN as well.
  188.  
  189. - OS/2 3.0 and 4.0
  190.   Please read README.OS2 as well.
  191.  
  192. MikMod compiles but has not been tested since ages on :
  193.  
  194. - IBM RS/6000 running AIX 3
  195.  
  196. MikMod used to work on :
  197.  
  198. - DEC Alpha running OSF/1 with the AudioFile driver
  199.  
  200. If your favorite system is not supported, please drop me a note and I'll
  201. see what I can do for you.
  202.  
  203. Thanks
  204. ------
  205.  
  206. I would like to thank everyone who contributed to MikMod. Their names
  207. are in the AUTHORS file. Thanks a lot !
  208.  
  209. License
  210. -------
  211.  
  212. The MikMod sound library, contained in the drivers, extra, include,
  213. loaders, mmio and playercode directories, is covered by the GNU Library
  214. General Public License, which you can find in COPYING.LIB.
  215.  
  216. The sound player example, contained in the mikmod directory, is covered
  217. by the GNU General Public License, which you can find in mikmod/COPYING.
  218.  
  219. Contact info
  220. ------------
  221.  
  222. Since MikMod for DOS has been officially withdrawn, there's no need to
  223. bother MikMak (Jean-Paul Mikkers) or Air Richter (Jake Stine), the two
  224. main MikMod authors, with email regarding this version of MikMod.
  225. Please send all your MikMod related e-mail to me, at :
  226.   miodrag@multimania.com
  227.  
  228. MikMod's official home page has moved with each new maintener, so the
  229. latest official MikMod'Unix homepage is located at :
  230.   http://www.multimania.com/miodrag/mikmod
  231. (the previous URL at mygale.org is still valid and will redirect to
  232. multimania, as it is in fact the same domain...)
  233.  
  234. Latest releases of MikMod'Unix can be found on the official homepage, as
  235. well as on 
  236.   ftp://sunsite.unc.edu/pub/Linux/apps/sound/players
  237. and all sunsite mirrors.
  238.  
  239. I hope you'll enjoy using this version of MikMod as well as I enjoyed
  240. debugging and improving it. Yes, really, I enjoy debugging coredumps...  
  241.  
  242. -- Miodrag ("Miod") Vallat (miodrag@multimania.com)
  243.