annotate README @ 1982:3b4ce57c6215

First shot at new audio data types (int32 and float32). Notable changes: - Converters between types are autogenerated. Instead of making multiple passes over the data with seperate filters for endianess, size, signedness, etc, converting between data types is always one specialized filter. This simplifies SDL_BuildAudioCVT(), which otherwise had a million edge cases with the new types, and makes the actually conversions more CPU cache friendly. Left a stub for adding specific optimized versions of these routines (SSE/MMX/Altivec, assembler, etc) - Autogenerated converters are built by SDL/src/audio/sdlgenaudiocvt.pl. This does not need to be run unless tweaking the code, and thus doesn't need integration into the build system. - Went through all the drivers and tried to weed out all the "Uint16" references that are better specified with the new SDL_AudioFormat typedef. - Cleaned out a bunch of hardcoded bitwise magic numbers and replaced them with new SDL_AUDIO_* macros. - Added initial float32 and int32 support code. Theoretically, existing drivers will push these through converters to get the data they want to feed to the hardware. Still TODO: - Optimize and debug new converters. - Update the CoreAudio backend to accept float32 data directly. - Other backends, too? - SDL_LoadWAV() needs to be updated to support int32 and float32 .wav files (both of which exist and can be generated by 'sox' for testing purposes). - Update the mixer to handle new datatypes. - Optionally update SDL_sound and SDL_mixer, etc.
author Ryan C. Gordon <icculus@icculus.org>
date Thu, 24 Aug 2006 12:10:46 +0000
parents 1c8672065e3b
children c9aa6bcb26f3
rev   line source
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
1
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
2 Simple DirectMedia Layer
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
3
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
4 (SDL)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
5
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
6 Version 1.2
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
7
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
8 ---
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
9 http://www.libsdl.org/
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
10
602
a24bd700f92e *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 579
diff changeset
11 This is the Simple DirectMedia Layer, a general API that provides low
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
12 level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
13 and 2D framebuffer across multiple platforms.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
14
1763
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
15 The current version supports Linux, Windows, Windows CE, BeOS, MacOS,
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
16 Mac OS X, FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX.
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
17 The code contains support for AmigaOS, Dreamcast, Atari, AIX, OSF/Tru64,
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
18 RISC OS, SymbianOS, and OS/2, but these are not officially supported.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
19
1763
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
20 SDL is written in C, but works with C++ natively, and has bindings to
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
21 several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
22 Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
23 Pike, Pliant, Python, Ruby, and Smalltalk.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
24
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
25 This library is distributed under GNU LGPL version 2, which can be
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
26 found in the file "COPYING". This license allows you to use SDL
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
27 freely in commercial programs as long as you link with the dynamic
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
28 library.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
29
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
30 The best way to learn how to use SDL is to check out the header files in
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
31 the "include" subdirectory and the programs in the "test" subdirectory.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
32 The header files and test programs are well commented and always up to date.
1763
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
33 More documentation is available in HTML format in "docs/index.html", and
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
34 a documentation wiki is available online at:
1c8672065e3b Updated to include new languages and platform support
Sam Lantinga <slouken@libsdl.org>
parents: 1621
diff changeset
35 http://www.libsdl.org/cgi/docwiki.cgi
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
36
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
37 The test programs in the "test" subdirectory are in the public domain.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
38
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
39 Frequently asked questions are answered online:
369
e405cf8bf580 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 362
diff changeset
40 http://www.libsdl.org/faq.php
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
41
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
42 If you need help with the library, or just want to discuss SDL related
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
43 issues, you can join the developers mailing list:
369
e405cf8bf580 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 362
diff changeset
44 http://www.libsdl.org/mailing-list.php
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
45
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
46 Enjoy!
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
47 Sam Lantinga (slouken@libsdl.org)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
48