README.txt
author Sam Lantinga <slouken@libsdl.org>
Tue, 17 Oct 2017 02:33:47 -0700
changeset 777 92882ef2ab81
parent 646 72383ae2d2e7
child 801 46acd70caa6a
permissions -rw-r--r--
Rewrote music.c to support any number of decode libraries using a compiled-in plugin interface
Mix_LoadWAV_RW() can now load sound formats that were previously available only as music.

This is still work in progress. Testing and project updates need to happen on other platforms.
     1 
     2 SDL_mixer 2.0
     3 
     4 The latest version of this library is available from:
     5 http://www.libsdl.org/projects/SDL_mixer/
     6 
     7 Due to popular demand, here is a simple multi-channel audio mixer.
     8 It supports 8 channels of 16 bit stereo audio, plus a single channel
     9 of music, mixed by the popular MikMod MOD, Timidity MIDI and SMPEG MP3
    10 libraries.
    11 
    12 See the header file SDL_mixer.h and the examples playwave.c and playmus.c
    13 for documentation on this mixer library.
    14 
    15 The mixer can currently load Microsoft WAVE files and Creative Labs VOC
    16 files as audio samples, and can load MIDI files via Timidity and the
    17 following music formats via MikMod:  .MOD .S3M .IT .XM. It can load
    18 Ogg Vorbis streams as music if built with Ogg Vorbis or Tremor libraries,
    19 and finally it can load MP3 music using the SMPEG or libmad libraries.
    20 
    21 Tremor decoding is disabled by default; you can enable it by passing
    22 	--enable-music-ogg-tremor
    23 to configure, or by defining MUSIC_OGG and OGG_USE_TREMOR.
    24 
    25 libmad decoding is disabled by default; you can enable it by passing
    26 	--enable-music-mp3-mad
    27 to configure, or by defining MUSIC_MP3_MAD
    28 vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
    29 WARNING: The license for libmad is GPL, which means that in order to
    30          use it your application must also be GPL!
    31 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    32 
    33 The process of mixing MIDI files to wave output is very CPU intensive,
    34 so if playing regular WAVE files sound great, but playing MIDI files
    35 sound choppy, try using 8-bit audio, mono audio, or lower frequencies.
    36 
    37 To play MIDI files, you'll need to get a complete set of GUS patches
    38 from:
    39 http://www.libsdl.org/projects/mixer/timidity/timidity.tar.gz
    40 and unpack them in /usr/local/lib under UNIX, and C:\ under Win32.
    41 
    42 This library is under the zlib license, see the file "COPYING.txt" for details.
    43