README
author Sam Lantinga <slouken@libsdl.org>
Sun, 08 Nov 2009 18:40:07 +0000
changeset 474 a2c238c0c4b2
parent 357 d6d0cfdbea65
child 519 46f32853e389
permissions -rw-r--r--
Don't break binary compatibility!
slouken@22
     1
slouken@86
     2
SDL_mixer 1.2
slouken@0
     3
slouken@51
     4
The latest version of this library is available from:
slouken@86
     5
http://www.libsdl.org/projects/SDL_mixer/
slouken@51
     6
slouken@0
     7
Due to popular demand, here is a simple multi-channel audio mixer.
slouken@48
     8
It supports 8 channels of 16 bit stereo audio, plus a single channel
slouken@0
     9
of music, mixed by the popular MikMod MOD, Timidity MIDI and SMPEG MP3
slouken@0
    10
libraries.
slouken@0
    11
slouken@29
    12
See the header file SDL_mixer.h and the examples playwave.c and playmus.c
slouken@0
    13
for documentation on this mixer library.
slouken@0
    14
slouken@91
    15
The mixer can currently load Microsoft WAVE files and Creative Labs VOC
slouken@91
    16
files as audio samples, and can load MIDI files via Timidity and the
slouken@147
    17
following music formats via MikMod:  .MOD .S3M .IT .XM. It can load
slouken@353
    18
Ogg Vorbis streams as music if built with Ogg Vorbis or Tremor libraries,
slouken@357
    19
and finally it can load MP3 music using the SMPEG or libmad libraries.
slouken@0
    20
slouken@357
    21
Tremor decoding is disabled by default; you can enable it by passing
slouken@353
    22
	--enable-music-ogg-tremor
slouken@353
    23
to configure, or by defining OGG_MUSIC and OGG_USE_TREMOR.
slouken@353
    24
slouken@357
    25
libmad decoding is disabled by default; you can enable it by passing
slouken@357
    26
	--enable-music-mp3-mad
slouken@357
    27
to configure, or by defining MP3_MAD_MUSIC
slouken@357
    28
vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
slouken@357
    29
WARNING: The license for libmad is GPL, which means that in order to
slouken@357
    30
         use it your application must also be GPL!
slouken@357
    31
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
slouken@357
    32
slouken@0
    33
The process of mixing MIDI files to wave output is very CPU intensive,
slouken@0
    34
so if playing regular WAVE files sound great, but playing MIDI files
slouken@0
    35
sound choppy, try using 8-bit audio, mono audio, or lower frequencies.
slouken@0
    36
slouken@0
    37
To play MIDI files, you'll need to get a complete set of GUS patches
slouken@29
    38
from:
slouken@86
    39
http://www.libsdl.org/projects/mixer/timidity/timidity.tar.gz
slouken@0
    40
and unpack them in /usr/local/lib under UNIX, and C:\ under Win32.
slouken@0
    41
slouken@137
    42
This library is available under the GNU Library General Public License,
slouken@137
    43
see the file "COPYING" for details.
slouken@0
    44