annotate INSTALL @ 433:f1c16afd9ebe

Read until buffer is full in Sound_Decode() rather than one packet per call.
author Ryan C. Gordon <icculus@icculus.org>
date Sat, 21 Dec 2002 11:32:14 +0000
parents 41412aa092d1
children 50bb9a6cebfe
rev   line source
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
1 Building is pretty easy. Please read README, too, as it duplicates and
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
2 expands upon much of this information.
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
3
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
4
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
5 ALL PLATFORMS:
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
6
184
47cc2de2ae36 Changed reference to "LICENSE" file to "COPYING".
Ryan C. Gordon <icculus@icculus.org>
parents: 140
diff changeset
7 Please understand your rights and mine: read the text file COPYING in the root
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
8 of the source tree. If you can't abide by it, delete this source tree now.
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
9
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
10 The best documentation for the SDL_sound API is SDL_sound.h. It is VERY
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
11 heavily commented, and makes an excellent, in-depth reference to all the
379
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
12 functions. The official API reference is generated from this file with
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
13 a program called "Doxygen" (http://www.doxygen.org/)
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
14
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
15
416
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
16 Borland C++ Builder for Linux (Kylix 3):
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
17 Unzip the "borland.zip" file in the root of the source tree and use the
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
18 project files in the newly-created Borland/k3 directory. Makefiles for the
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
19 command line compiler are in Borland/freebcc ...
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
20
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
21
264
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
22 Unix:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
23 (If you pulled the source from CVS), run ./bootstrap
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
24
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
25 run ./configure --help, and see if there's any options you need. Rerun
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
26 configure with those options. If this is confusing to you, just run
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
27 ./configure with no options: the defaults are generally decent, and
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
28 configure is usually smart enough to figure out what's best..
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
29
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
30 If configuration succeeded, run "make".
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
31
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
32 Run "make install" as root to install the library for use on your system.
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
33
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
34 This should work for most Unix-style systems, including Linux, *BSD, BeOS, and
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
35 MacOS X. Reports of success and failure are welcome.
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
36
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
37
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
38 MacOS 9 users:
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
39 Included with the source is CWProject.sit, which contains project files for
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
40 CodeWarrior 5.0 and later.
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
41
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
42
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
43 MacOS X command line tools:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
44 You can use the "UNIX" instructions above if you like the command line tools.
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
45
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
46
264
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
47 MacOS X Project Builder:
319
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
48 If you prefer to use Project Builder, use the project files included with
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
49 this source: PBProjects.tar.gz...unpack it in the root of the SDL_sound
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
50 folder. This archive contains several external libraries you would have
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
51 to download/install manually if you used the command line tools (these
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
52 libraries are for extra decoders, and are NOT required for SDL_sound to
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
53 function...however, without them, the number of sound formats you can
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
54 decode is reduced.)
264
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
55
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
56
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
57 BeOS:
abe472572e38 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 253
diff changeset
58 You can use the "UNIX" instructions above, too.
248
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
59
effbf695ba58 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 243
diff changeset
60
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
61 Win32 Visual C:
319
4a2cd7d4aa06 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 264
diff changeset
62 For Visual C, use:
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
63 http://icculus.org/SDL_sound/downloads/sdl_sound_visualc_srcs.zip
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
64 ...and unzip it somewhere. This zipfile has a complete copy of the
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
65 SDL_sound sources, Visual C project files, and several external libraries,
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
66 too. This zip is everything you should need, and you can scrap this copy of
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
67 the source.
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
68
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
69
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
70 Win32 Cygwin:
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
71 Cygwin users can try their luck with the Unix build instructions in this
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
72 tarball instead.
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
73
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
74
416
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
75 Win32 Borland C++ Builder 6:
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
76 Unzip the "borland.zip" file in the root of the source tree and use the
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
77 project files in the newly-created Borland/bcb6 directory. Makefiles for the
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
78 command line compiler are in Borland/freebcc ... these are unmaintained, and
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
79 you will need to go find the external libraries you want to use (those that
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
80 wish to maintain these project files should contact me).
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
81
41412aa092d1 Added Borland C++ info, other revisions.
Ryan C. Gordon <icculus@icculus.org>
parents: 379
diff changeset
82
253
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
83 If building is successful, there will be a shared library and a binary
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
84 called "playsound".
6e1ee1f5be1b Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 248
diff changeset
85
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
86
379
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
87 Windows CE (Microsoft PocketPC):
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
88 You'll need Microsoft's PocketPC development environment, and this zipfile:
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
89 http://icculus.org/SDL_sound/downloads/SDL_soundCE.zip
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
90
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
91 Unzip that into the root of this source tree. The new "wce" directory has
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
92 project files, and the source to some of the external decoders is included.
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
93 Note that not all of the decoders are supported on PocketPC (but please, do
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
94 send us patches if you get them working!)
7e49f4901ceb Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 319
diff changeset
95
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
96
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
97 OTHER PLATFORMS:
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
98
140
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
99 Send me patches, and instructions, and I'll list them here. Consider
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
100 joining the SDL_sound mailing list. Details are at:
c28566f219e2 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 0
diff changeset
101 http://icculus.org/SDL_sound/
0
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
102
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
103 --ryan. (icculus@clutteredmind.org)
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
104
1078b3528e6f Initial revision
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
105