Mercurial > SDL_sound_CoreAudio
annotate README @ 518:16cbfcb8d7fb
Fixed bogus memory deference when SMPEG fails init (thanks, Chris!).
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Sun, 29 Oct 2006 07:14:48 +0000 |
| parents | 41412aa092d1 |
| children | 50bb9a6cebfe |
| rev | line source |
|---|---|
| 78 | 1 SDL_sound. An abstract soundfile decoder. |
| 2 | |
| 256 | 3 SDL_sound is a library that handles the decoding of several popular sound file |
| 4 formats, such as .WAV and .MP3. It is meant to make the programmer's sound | |
| 5 playback tasks simpler. The programmer gives SDL_sound a filename, or feeds | |
| 6 it data directly from one of many sources, and then reads the decoded | |
| 7 waveform data back at her leisure. If resource constraints are a concern, | |
| 8 SDL_sound can process sound data in programmer-specified blocks. Alternately, | |
| 9 SDL_sound can decode a whole sound file and hand back a single pointer to the | |
| 10 whole waveform. SDL_sound can also handle sample rate, audio format, and | |
| 11 channel conversion on-the-fly and behind-the-scenes, if the programmer | |
| 12 desires. | |
| 13 | |
| 14 Please check the website for the most up-to-date information about SDL_sound: | |
| 232 | 15 http://icculus.org/SDL_sound/ |
| 78 | 16 |
| 239 | 17 SDL_sound _REQUIRES_ Simple Directmedia Layer (SDL) to function, and cannot |
| 18 be built without it. You can get SDL from http://www.libsdl.org/. SDL_sound | |
| 19 has only been tried with the SDL 1.2 series, but may work on older versions. | |
| 20 Reports of success or failure are welcome. | |
| 21 | |
| 232 | 22 Some optional external libraries that SDL_sound can use and where to find them: |
|
416
41412aa092d1
Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents:
319
diff
changeset
|
23 SMPEG (used to decode MP3s): http://icculus.org/smpeg/ |
|
41412aa092d1
Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents:
319
diff
changeset
|
24 libvorbisfile (used to decode OGGs): http://www.xiph.org/ogg/vorbis/ |
| 239 | 25 libFLAC (used to decode FLACs): http://flac.sourceforge.net/ |
| 26 libModPlug (used to decode MODs, etc): http://modplug-xmms.sourceforge.net/ | |
| 27 libMikMod (used to decode MODs, etc, too): http://www.mikmod.org/ | |
| 232 | 28 |
| 319 | 29 Experimental QuickTime support for the Mac is included, but has not been |
| 30 integrated with the build system, and probably doesn't work with | |
| 31 QuickTime for Windows. | |
| 32 | |
| 232 | 33 These external libraries are OPTIONAL. SDL_sound will build and function |
| 34 without them, but various sound file formats are not supported unless these | |
| 35 libraries are available. Unless explicitly disabled during initial build | |
| 239 | 36 configuration, SDL_sound always supports these file formats internally: |
| 232 | 37 |
| 239 | 38 - Microsoft .WAV files (uncompressed and MS-ADPCM encoded). |
| 39 - Creative Labs .VOC files | |
| 40 - Shorten (.SHN) files | |
| 41 - Audio Interchange format (AIFF) files | |
| 42 - Sun Audio (.AU) files | |
| 43 - MIDI files | |
| 264 | 44 - MP3 files (internal decoder, different than the one SMPEG uses) |
| 239 | 45 - Raw waveform data |
| 232 | 46 |
| 47 Building/Installing: | |
| 253 | 48 Please read the INSTALL document. |
| 78 | 49 |
| 232 | 50 Reporting bugs/commenting: |
| 51 There is a mailing list available. To subscribe, send a blank email to | |
| 52 sdlsound-subscribe@icculus.org. This is the best way to get in touch with | |
| 53 SDL_sound developers. | |
| 54 | |
| 253 | 55 --ryan. (icculus@clutteredmind.org) |
| 56 | |
| 319 | 57 |