annotate README @ 249:e122de403a2d

Patch to not puke on Timidity++-specific config file directives.
author Ryan C. Gordon <icculus@icculus.org>
date Thu, 07 Feb 2002 07:48:24 +0000
parents effbf695ba58
children 6e1ee1f5be1b
rev   line source
78
8b7d48449ad1 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
1 SDL_sound. An abstract soundfile decoder.
8b7d48449ad1 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
2
8b7d48449ad1 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
3 Check here, until I get to write more of this README:
232
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
4 http://icculus.org/SDL_sound/
78
8b7d48449ad1 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
5
239
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
6 SDL_sound _REQUIRES_ Simple Directmedia Layer (SDL) to function, and cannot
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
7 be built without it. You can get SDL from http://www.libsdl.org/. SDL_sound
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
8 has only been tried with the SDL 1.2 series, but may work on older versions.
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
9 Reports of success or failure are welcome.
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
10
232
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
11 Some optional external libraries that SDL_sound can use and where to find them:
239
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
12 SMPEG (used to decode MP3s): http://www.lokigames.com/development/smpeg.php3
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
13 libvorbis (used to decode OGGs): http://www.xiph.org/ogg/vorbis/
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
14 libFLAC (used to decode FLACs): http://flac.sourceforge.net/
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
15 libModPlug (used to decode MODs, etc): http://modplug-xmms.sourceforge.net/
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
16 libMikMod (used to decode MODs, etc, too): http://www.mikmod.org/
232
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
17
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
18 These external libraries are OPTIONAL. SDL_sound will build and function
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
19 without them, but various sound file formats are not supported unless these
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
20 libraries are available. Unless explicitly disabled during initial build
239
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
21 configuration, SDL_sound always supports these file formats internally:
232
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
22
239
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
23 - Microsoft .WAV files (uncompressed and MS-ADPCM encoded).
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
24 - Creative Labs .VOC files
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
25 - Shorten (.SHN) files
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
26 - Audio Interchange format (AIFF) files
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
27 - Sun Audio (.AU) files
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
28 - MIDI files
30e21a90f3b1 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 232
diff changeset
29 - Raw waveform data
232
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
30
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
31
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
32 Building/Installing:
78
8b7d48449ad1 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
33
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
34 MacOS X users:
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
35 If you want to use the command line tools, read the next section. If you
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
36 prefer to use PowerBuilder, download this file:
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
37 http://icculus.org/SDL_sound/downloads/PBProjects.tar.gz
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
38 ...and extract it into your SDL_sound directory. The PowerBuilder project
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
39 files include several of the external libraries, whereas you will have to
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
40 find and install those libraries yourself with the command line tools.
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
41
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
42 MacOS 9 users:
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
43 Included with the source is CWProject.sit, which contains project files for
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
44 CodeWarrior 5.0 and later.
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
45
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 239
diff changeset
46 Linux, Unix, BeOS, MacOS X command line, BSD users:
228
daa18455baf9 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
47 If you pulled from CVS, run "./bootstrap" first.
daa18455baf9 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
48 Then, run ./configure with your favorite options, "make", "make install".
78
8b7d48449ad1 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
49
128
e139a7a6855b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 78
diff changeset
50 Win32 users:
e139a7a6855b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 78
diff changeset
51 Download http://icculus.org/SDL_sound/downloads/SDL_sound_win32.zip and
e139a7a6855b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 78
diff changeset
52 unzip it in the root of the source tree (the directory with SDL_sound.c,
e139a7a6855b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 78
diff changeset
53 etc). This will give you Visual C++ project files and some other needed
e139a7a6855b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 78
diff changeset
54 code.
e139a7a6855b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 78
diff changeset
55
228
daa18455baf9 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
56 There will be a shared library and a binary called "playsound".
daa18455baf9 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 128
diff changeset
57
78
8b7d48449ad1 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
58
232
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
59 Reporting bugs/commenting:
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
60 There is a mailing list available. To subscribe, send a blank email to
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
61 sdlsound-subscribe@icculus.org. This is the best way to get in touch with
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
62 SDL_sound developers.
34000a50353b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 228
diff changeset
63