Mercurial > sdl-ios-xcode
annotate include/SDL_mutex.h @ 942:41a59de7f2ed
Here are patches for SDL12 and SDL_mixer for 4 or 6 channel
surround sound on Linux using the Alsa driver. To use them, naturally
you need a sound card that will do 4 or 6 channels and probably also a
recent version of the Alsa drivers and library. Since the only SDL
output driver that knows about surround sound is the Alsa driver,
you���ll want to choose it, using:
export SDL_AUDIODRIVER=alsa
There are no syntactic changes to the programming API. No new
library calls, no differences in arguments.
There are two semantic changes:
(1) For library calls with number of channels as an argument, formerly
you could use only 1 or 2 for the number of channels. Now you
can also use 4 or 6.
(2) The two "left" and "right" arguments to Mix_SetPanning, for the
case of 4 or 6 channels, no longer simply control the volumes of
the left and right channels. Now the "left" argument is converted
to an angle and Mix_SetPosition is called, and the "right" argu-
ment is ignored.
With two exceptions, so far as I know, the modified SDL12 and
SDL_mixer work the same way as the original versions, when opened for
1 or 2 channel output. The two exceptions are bugs which I fixed.
Well, the first, anyway, is a bug for sure. When rate conversions up
or down by a factor of two are applied (in src/audio/SDL_audiocvt.c),
streams with different numbers of channels (that is, mono and stereo)
are treated the same way: either each sample is copied or every other
sample is omitted. This is ok for mono, but for stereo, it is frames
that should be copied or omitted, where by "frame" I mean a portion of
the stream containing one sample for each channel. (In the SDL source,
confusingly, sometimes frames are called "samples".) So for these
rate conversions, stereo streams have to be treated differently, and
they are, in my modified version.
The other problem that might be characterized as a bug arises
when SDL_mixer is passed a multichannel chunk which does not have an
integral number of frames. Due to the way the effect_position code
loops over frames, when the chunk ends with a partial frame, memory
outside the chunk buffer will be accessed. In the case of stereo,
it���s possible that because malloc may give more memory than requested,
this potential problem never actually causes a segment fault. I don���t
know. For 6 channel chunks, I do know, and it does cause segment
faults.
If SDL_mixer is passed defective chunks and this causes a segment
fault, arguably, that���s not a bug in SDL_mixer. Still, whether or not
it counts as a bug, it���s easy to protect against, so why not? I added
code in mixer.c to discard any partial frame at the end of a chunk.
Then what about when SDL or SDL_mixer is opened for 4 or 6 chan-
nel output? What happens with the parts of the current library
designed for stereo? I don���t know whether I���ve covered all the bases,
but I���ve tried:
(1) For playing 2 channel waves, or other cases where SDL knows it has
to match up a 2 channel source with a 4 or 6 channel output, I���ve
added code in SDL_audiocvt.c to make the necessary conversions.
(2) For playing midis using timidity, I���ve converted timidity to do 4
or 6 channel output, upon request.
(3) For playing mods using mikmod, I put ad hoc code in music.c to
convert the stereo output that mikmod produces to 4 or 6 chan-
nels. Obviously it would be better to change the mikmod code to
mix down into 4 or 6 channels, but I have a hard time following
the code in mikmod, so I didn���t do that.
(4) For playing mp3s, I put ad hoc code in smpeg to copy channels in
the case when 4 or 6 channel output is needed.
(5) There seems to be no problem with .ogg files - stereo .oggs can be
up converted as .wavs are.
(6) The effect_position code in SDL_mixer is now generalized to in-
clude the cases of 4 and 6 channel streams.
I���ve done a very limited amount of compatibility testing for some
of the games using SDL I happen to have. For details, see the file
TESTS.
I���ve put into a separate archive, Surround-SDL-testfiles.tgz, a
couple of 6 channel wave files for testing and a 6 channel ogg file.
If you have the right hardware and version of Alsa, you should be able
to play the wave files with the Alsa utility aplay (and hear all
channels, except maybe lfe, for chan-id.wav, since it���s rather faint).
Don���t expect aplay to give good sound, though. There���s something
wrong with the current version of aplay.
The canyon.ogg file is to test loading of 6 channel oggs. After
patching and compiling, you can play it with playmus. (My version of
ogg123 will not play it, and I had to patch mplayer to get it to play
6 channel oggs.)
Greg Lee <greg@ling.lll.hawaii.edu>
Thus, July 1, 2004
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 21 Aug 2004 12:27:02 +0000 |
parents | b8d311d90021 |
children | 3bdcef7e1c90 |
rev | line source |
---|---|
0 | 1 /* |
2 SDL - Simple DirectMedia Layer | |
769
b8d311d90021
Updated copyright information for 2004 (Happy New Year!)
Sam Lantinga <slouken@libsdl.org>
parents:
417
diff
changeset
|
3 Copyright (C) 1997-2004 Sam Lantinga |
0 | 4 |
5 This library is free software; you can redistribute it and/or | |
6 modify it under the terms of the GNU Library General Public | |
7 License as published by the Free Software Foundation; either | |
8 version 2 of the License, or (at your option) any later version. | |
9 | |
10 This library is distributed in the hope that it will be useful, | |
11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 Library General Public License for more details. | |
14 | |
15 You should have received a copy of the GNU Library General Public | |
16 License along with this library; if not, write to the Free | |
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
18 | |
19 Sam Lantinga | |
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
0 | 21 */ |
22 | |
23 #ifdef SAVE_RCSID | |
24 static char rcsid = | |
25 "@(#) $Id$"; | |
26 #endif | |
27 | |
28 #ifndef _SDL_mutex_h | |
29 #define _SDL_mutex_h | |
30 | |
31 /* Functions to provide thread synchronization primitives | |
32 | |
33 These are independent of the other SDL routines. | |
34 */ | |
35 | |
36 #include "SDL_main.h" | |
37 #include "SDL_types.h" | |
38 | |
39 #include "begin_code.h" | |
40 /* Set up for C function definitions, even when using C++ */ | |
41 #ifdef __cplusplus | |
42 extern "C" { | |
43 #endif | |
44 | |
45 /* Synchronization functions which can time out return this value | |
46 if they time out. | |
47 */ | |
48 #define SDL_MUTEX_TIMEDOUT 1 | |
49 | |
50 /* This is the timeout value which corresponds to never time out */ | |
51 #define SDL_MUTEX_MAXWAIT (~(Uint32)0) | |
52 | |
53 | |
54 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
55 /* Mutex functions */ | |
56 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
57 | |
58 /* The SDL mutex structure, defined in SDL_mutex.c */ | |
59 struct SDL_mutex; | |
60 typedef struct SDL_mutex SDL_mutex; | |
61 | |
62 /* Create a mutex, initialized unlocked */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
63 extern DECLSPEC SDL_mutex * SDLCALL SDL_CreateMutex(void); |
0 | 64 |
65 /* Lock the mutex (Returns 0, or -1 on error) */ | |
66 #define SDL_LockMutex(m) SDL_mutexP(m) | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
67 extern DECLSPEC int SDLCALL SDL_mutexP(SDL_mutex *mutex); |
0 | 68 |
417
04ec6995f75d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
69 /* Unlock the mutex (Returns 0, or -1 on error) |
04ec6995f75d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
70 It is an error to unlock a mutex that has not been locked by |
04ec6995f75d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
71 the current thread, and doing so results in undefined behavior. |
04ec6995f75d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
72 */ |
0 | 73 #define SDL_UnlockMutex(m) SDL_mutexV(m) |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
74 extern DECLSPEC int SDLCALL SDL_mutexV(SDL_mutex *mutex); |
0 | 75 |
76 /* Destroy a mutex */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
77 extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_mutex *mutex); |
0 | 78 |
79 | |
80 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
81 /* Semaphore functions */ | |
82 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
83 | |
84 /* The SDL semaphore structure, defined in SDL_sem.c */ | |
85 struct SDL_semaphore; | |
86 typedef struct SDL_semaphore SDL_sem; | |
87 | |
88 /* Create a semaphore, initialized with value, returns NULL on failure. */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
89 extern DECLSPEC SDL_sem * SDLCALL SDL_CreateSemaphore(Uint32 initial_value); |
0 | 90 |
91 /* Destroy a semaphore */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
92 extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem *sem); |
0 | 93 |
94 /* This function suspends the calling thread until the semaphore pointed | |
95 * to by sem has a positive count. It then atomically decreases the semaphore | |
96 * count. | |
97 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
98 extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem *sem); |
0 | 99 |
100 /* Non-blocking variant of SDL_SemWait(), returns 0 if the wait succeeds, | |
101 SDL_MUTEX_TIMEDOUT if the wait would block, and -1 on error. | |
102 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
103 extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem *sem); |
0 | 104 |
105 /* Variant of SDL_SemWait() with a timeout in milliseconds, returns 0 if | |
106 the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in | |
107 the allotted time, and -1 on error. | |
108 On some platforms this function is implemented by looping with a delay | |
109 of 1 ms, and so should be avoided if possible. | |
110 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
111 extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem *sem, Uint32 ms); |
0 | 112 |
113 /* Atomically increases the semaphore's count (not blocking), returns 0, | |
114 or -1 on error. | |
115 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
116 extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem *sem); |
0 | 117 |
118 /* Returns the current count of the semaphore */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
119 extern DECLSPEC Uint32 SDLCALL SDL_SemValue(SDL_sem *sem); |
0 | 120 |
121 | |
122 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
123 /* Condition variable functions */ | |
124 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
125 | |
126 /* The SDL condition variable structure, defined in SDL_cond.c */ | |
127 struct SDL_cond; | |
128 typedef struct SDL_cond SDL_cond; | |
129 | |
130 /* Create a condition variable */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
131 extern DECLSPEC SDL_cond * SDLCALL SDL_CreateCond(void); |
0 | 132 |
133 /* Destroy a condition variable */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
134 extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond *cond); |
0 | 135 |
136 /* Restart one of the threads that are waiting on the condition variable, | |
137 returns 0 or -1 on error. | |
138 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
139 extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond *cond); |
0 | 140 |
141 /* Restart all threads that are waiting on the condition variable, | |
142 returns 0 or -1 on error. | |
143 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
144 extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond *cond); |
0 | 145 |
146 /* Wait on the condition variable, unlocking the provided mutex. | |
147 The mutex must be locked before entering this function! | |
148 Returns 0 when it is signaled, or -1 on error. | |
149 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
150 extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond *cond, SDL_mutex *mut); |
0 | 151 |
152 /* Waits for at most 'ms' milliseconds, and returns 0 if the condition | |
153 variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not | |
154 signaled in the allotted time, and -1 on error. | |
155 On some platforms this function is implemented by looping with a delay | |
156 of 1 ms, and so should be avoided if possible. | |
157 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
158 extern DECLSPEC int SDLCALL SDL_CondWaitTimeout(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms); |
0 | 159 |
160 /* Ends C function definitions when using C++ */ | |
161 #ifdef __cplusplus | |
162 } | |
163 #endif | |
164 #include "close_code.h" | |
165 | |
166 #endif /* _SDL_mutex_h */ |