view BUGS @ 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 abe872771687
children 9867f3d86e44
line wrap: on
line source


All:
	Audio rate conversion is only implemented by multiplying or dividing
	by a power of two.  This is a side-effect of the requirement that the
	raw audio buffer size be a power of two, and can hopefully be fixed.
	This means 8 KHz audio converted to 22 KHz ends up being 16 KHz. :-/

	When the implementation is writing directly to video memory the mouse
	cursor doesn't work properly.  Applications which do this should use
	their own mouse cursor and call SDL_ShowCursor(0) to hide the system
	cursor.

Linux:
	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	It requires handling of keyboard mapping events and using the XIM
	input translation extension.  I will implement it as requested.
	Latin-1 keyboard input works fine.

	The keyboard modifiers are not set to the correct state on startup.

	The AAlib, GGI, and SVGAlib video drivers are not heavily tested.

Win32:
	The MCI driver can't tell if the CD-ROM drive is paused or stopped.

	The SDL_INIT_EVENTTHREAD flag is not supported on Win32
	(Idea: create a separate DirectInput polling thread)
	The main purpose of this flag is for smooth cursor motion in
	fullscreen environments.

	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	This requires the ToUnicode() API which is only implemented on
	Windows NT/2000, not on Windows 95/98.
	Latin-1 keyboard input works fine.

	Joysticks are only supported under the Win32 MultiMedia API,
	DirectInput support is not yet implemented.

BeOS:
	BePPC is not supported, apparently not even by Be Inc.

	SDL_WM_GrabInput() is not implemented.
	Does anyone know how to do this?  SDL_WM_GrabInput() is designed
	to prevent the user from switching input and mouse focus away from
	the SDL application.

	Continuous relative mouse motion is not implemented.

	Wide UNICODE character input (Kanji, etc.) has not been tested.
	Latin-1 keyboard input works fine.

MacOS:
	Palette handling isn't implemented in windowed mode yet.

	Audio hasn't been extensively tested, in particular the locking
	isn't implemented and mixer routines may not call malloc() or free()
	because they are called at interrupt time.

	SDL_WM_GrabInput() is not implemented.
	Does anyone know how to do this?  SDL_WM_GrabInput() is designed
	to prevent the user from switching input and mouse focus away from
	the SDL application.

	Continuous relative mouse motion is not implemented.

	SDL_AddTimer() and SDL_RemoveTimer() haven't been implemented yet.

	Not all of the keys are properly recognized on the keyboard.

MacOS X:
	Depth switching for windowed mode isn't implemented yet.
	
	Palette handling isn't implemented in windowed mode yet.
	
	Command-line arguments dialog is not implemented yet.

	Fullscreen drawing has some artifacts.
	
	Fullscreen OpenGL for the software renderer is broken.

	Some OpenGL parameters are not accounted for, for example color bits customization.
	
	Continuous mouse motion perhaps is not as smooth as it should be.

	SDL_WM_GrabInput() is implemented, but it "freezes" the hardware
	cursor in the center of the window/screen.  Also, mouse moved events
	are not generated, and the keyboard cannot be grabbed.

	MacOS X seems to have a broken pthread_cancel() implementation.
	Actually, it just only has one cancellation point defined.
	http://lists.apple.com/archives/darwin-development/2004/Jun/24/killingapthread.001.txt

FreeBSD:
	pthread_cancel() isn't supported by FreeBSD 3.X, so threads don't
	work on versions of FreeBSD earlier than 4.0.

	The CD-ROM handling doesn't work completely.

	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	It requires handling of keyboard mapping events and using the XIM
	input translation extension.  I will implement it as requested.
	Latin-1 keyboard input works fine.

	The keyboard modifiers are not set to the correct state on startup.

Solaris:
	The joystick functions are not implemented yet.

	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	It requires handling of keyboard mapping events and using the XIM
	input translation extension.  I will implement it as requested.
	Latin-1 keyboard input works fine.

	The keyboard modifiers are not set to the correct state on startup.

IRIX:
	The CD-ROM handling doesn't work completely.

	The joystick functions are not implemented yet.

	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	It requires handling of keyboard mapping events and using the XIM
	input translation extension.  I will implement it as requested.
	Latin-1 keyboard input works fine.

	The keyboard modifiers are not set to the correct state on startup.

EPOC:
    Only Crystal version of Epoc/SymbianOS is currently supported.

    SDL is implemented in static library only. SDL uses static/global
    variables and that is not allowed in EPOC dll libraries.

    Sound is not yet supported.

    Joystick, OpenGL and cdrom is not supported (think about cdrom in a cell phone:-).
    
    No console output screen. Printing to stdout do not have any effect.

QNX:
	Fullscreen switch doesn't work (disabled for now).
 

OpenBSD:  -= NOT YET SUPPORTED =-
	This is reported to work, but I haven't verified this.

	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	It requires handling of keyboard mapping events and using the XIM
	input translation extension.  I will implement it as requested.
	Latin-1 keyboard input works fine.

	The keyboard modifiers are not set to the correct state on startup.

OSF/Tru64:  -= NOT YET SUPPORTED =-
	The audio functions are not implemented yet.

	Joysticks and CD-ROM functions are not implemented yet.

	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	It requires handling of keyboard mapping events and using the XIM
	input translation extension.  I will implement it as requested.
	Latin-1 keyboard input works fine.

	The keyboard modifiers are not set to the correct state on startup.

AIX:  -= NOT YET SUPPORTED =-
	This port has only been tested with AIX 4.3.3

	The OpenGL support doesn't work yet.

	The joystick subsystem isn't implemented yet.

	Endian detection doesn't work yet - needs a unique CPP symbol.

	Wide UNICODE character input (Kanji, etc.) is not yet supported.
	It requires handling of keyboard mapping events and using the XIM
	input translation extension.  I will implement it as requested.
	Latin-1 keyboard input works fine.

	The keyboard modifiers are not set to the correct state on startup.

	The AIX port was done by Carsten.Griwodz@KOM.tu-darmstadt.de
	More information on this port is available at:
	http://www.kom.e-technik.tu-darmstadt.de/~griff/SDL/

AmigaOS:  -= NOT YET SUPPORTED =-
	The OpenGL support isn't implemented yet.

	SDL_WM_GrabInput() is not implemented.
	Does anyone know how to do this?  SDL_WM_GrabInput() is designed
	to prevent the user from switching input and mouse focus away from
	the SDL application.

	Continuous relative mouse motion is not implemented.

	The AmigaOS port was done by Gabriele.Greco@galactica.it