README.txt
changeset 618 2906d3207f34
parent 519 46f32853e389
child 619 ef1750c624ed
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.txt	Mon May 27 00:15:03 2013 -0700
     1.3 @@ -0,0 +1,43 @@
     1.4 +
     1.5 +SDL_mixer 1.2
     1.6 +
     1.7 +The latest version of this library is available from:
     1.8 +http://www.libsdl.org/projects/SDL_mixer/
     1.9 +
    1.10 +Due to popular demand, here is a simple multi-channel audio mixer.
    1.11 +It supports 8 channels of 16 bit stereo audio, plus a single channel
    1.12 +of music, mixed by the popular MikMod MOD, Timidity MIDI and SMPEG MP3
    1.13 +libraries.
    1.14 +
    1.15 +See the header file SDL_mixer.h and the examples playwave.c and playmus.c
    1.16 +for documentation on this mixer library.
    1.17 +
    1.18 +The mixer can currently load Microsoft WAVE files and Creative Labs VOC
    1.19 +files as audio samples, and can load MIDI files via Timidity and the
    1.20 +following music formats via MikMod:  .MOD .S3M .IT .XM. It can load
    1.21 +Ogg Vorbis streams as music if built with Ogg Vorbis or Tremor libraries,
    1.22 +and finally it can load MP3 music using the SMPEG or libmad libraries.
    1.23 +
    1.24 +Tremor decoding is disabled by default; you can enable it by passing
    1.25 +	--enable-music-ogg-tremor
    1.26 +to configure, or by defining OGG_MUSIC and OGG_USE_TREMOR.
    1.27 +
    1.28 +libmad decoding is disabled by default; you can enable it by passing
    1.29 +	--enable-music-mp3-mad
    1.30 +to configure, or by defining MP3_MAD_MUSIC
    1.31 +vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
    1.32 +WARNING: The license for libmad is GPL, which means that in order to
    1.33 +         use it your application must also be GPL!
    1.34 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    1.35 +
    1.36 +The process of mixing MIDI files to wave output is very CPU intensive,
    1.37 +so if playing regular WAVE files sound great, but playing MIDI files
    1.38 +sound choppy, try using 8-bit audio, mono audio, or lower frequencies.
    1.39 +
    1.40 +To play MIDI files, you'll need to get a complete set of GUS patches
    1.41 +from:
    1.42 +http://www.libsdl.org/projects/mixer/timidity/timidity.tar.gz
    1.43 +and unpack them in /usr/local/lib under UNIX, and C:\ under Win32.
    1.44 +
    1.45 +This library is under the zlib license, see the file "COPYING" for details.
    1.46 +