README.txt
author Sam Lantinga <slouken@libsdl.org>
Sat, 21 Oct 2017 14:40:31 -0700
changeset 823 bcd59adacdcc
parent 819 17ddbf810d08
child 901 253f50984a9a
permissions -rw-r--r--
Fixed linker order so -lmingw32 comes before -lSDL2main
     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.
    10 
    11 See the header file SDL_mixer.h and the examples playwave.c and playmus.c
    12 for documentation on this mixer library.
    13 
    14 The mixer can currently load Microsoft WAVE files and Creative Labs VOC
    15 files as audio samples, it can load FLAC files with libFLAC, it can load
    16 Ogg Vorbis files with Ogg Vorbis or Tremor libraries, it can load MP3 files
    17 using mpg123, SMPEG or libmad, and it can load MIDI files with Timidity,
    18 FluidSynth, and natively on Windows, Mac OSX, and Linux, and finally it can
    19 load the following file formats via ModPlug or MikMod: .MOD .S3M .IT .XM.
    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 using FluidSynth, you'll need to set the SDL_SOUNDFONTS
    38 environment variable to a Sound Font 2 (.sf2) file containing the musical
    39 instruments you want to use for MIDI playback.
    40 (On some Linux distributions you can install the fluid-soundfont-gm package)
    41 
    42 To play MIDI files using Timidity, you'll need to get a complete set of
    43 GUS patches from:
    44 http://www.libsdl.org/projects/mixer/timidity/timidity.tar.gz
    45 and unpack them in /usr/local/lib under UNIX, and C:\ under Win32.
    46 
    47 iOS:
    48 In order to use this library on iOS, you should include the SDL.xcodeproj
    49 and Xcode-iOS/SDL_mixer.xcodeproj in your application, add the SDL/include
    50 and SDL_mixer directories to your "Header Search Paths" setting, then add the
    51 libSDL2.a and libSDL2_mixer.a to your "Link Binary with Libraries" setting.
    52 
    53 This library is under the zlib license, see the file "COPYING.txt" for details.
    54