src/audio/pulse/SDL_pulseaudio.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 21 Sep 2009 09:27:08 +0000
branchSDL-1.2
changeset 4216 5b99971a27b4
parent 4159 a1b03ba2fcd0
child 4398 fe15c4e8efe6
permissions -rw-r--r--
Fixed bug #698

Hans de Goede 2009-02-13 01:10:52 PST

Since the new "glitch free" version of pulseaudio (used in Fedora 10 amongst
others), the sound of SDL using apps (like a simple playmus call) has been
crackling.

While looking in to fixing this I noticed that the current pulseaudio code in
SDL uses pa_simple. However pa_simple uses a thread to pump pulseaudio events
and ipc, given that SDL already has its own thread for audio handling this is
clearly suboptimal, leading to unnecessary context switching IPC, etc. Also
pa_simple does not allow one to implement the WaitAudio() callback for SDL
audiodrivers properly.

Given that my work is mostly a rewrite (although some original pieces remain)
I'm attaching the new .c and .h file, as that is easier to review then the huge
diff.

Let me know if you also want the diff.

This new version has the following features:
-no longer use an additional thread next to the SDL sound thread
-do not crackle with glitch free audio
-when used with a newer pulse, which does glitch free audio, the total latency
is
the same as with the alsa driver
-proper WaitAudio() implementation, saving another mixlen worth of latency
-adds a WaitDone() implementation

This patch has been written in consultancy with Lennart Poetering (the
pulseaudio author) and has been reviewed by him for correct use of the pa API.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 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     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     St├ęphan Kochen
    20     stephan@kochen.nl
    21     
    22     Based on parts of the ALSA and ESounD output drivers.
    23 */
    24 #include "SDL_config.h"
    25 
    26 #ifndef _SDL_pulseaudio_h
    27 #define _SDL_pulseaudio_h
    28 
    29 #include "../SDL_sysaudio.h"
    30 
    31 /* Hidden "this" pointer for the video functions */
    32 #define _THIS	SDL_AudioDevice *this
    33 
    34 struct SDL_PrivateAudioData {
    35 	pa_mainloop *mainloop;
    36 	pa_mainloop_api *mainloop_api;
    37 	pa_context *context;
    38 	pa_stream *stream;
    39 
    40 	/* Raw mixing buffer */
    41 	Uint8 *mixbuf;
    42 	int    mixlen;
    43 };
    44 
    45 #if (PA_API_VERSION < 12)
    46 /** Return non-zero if the passed state is one of the connected states */
    47 static inline int PA_CONTEXT_IS_GOOD(pa_context_state_t x) {
    48     return
    49         x == PA_CONTEXT_CONNECTING ||
    50         x == PA_CONTEXT_AUTHORIZING ||
    51         x == PA_CONTEXT_SETTING_NAME ||
    52         x == PA_CONTEXT_READY;
    53 }
    54 /** Return non-zero if the passed state is one of the connected states */
    55 static inline int PA_STREAM_IS_GOOD(pa_stream_state_t x) {
    56     return
    57         x == PA_STREAM_CREATING ||
    58         x == PA_STREAM_READY;
    59 }
    60 #endif	/* pulseaudio <= 0.9.10 */
    61 
    62 /* Old variable names */
    63 #define mainloop		(this->hidden->mainloop)
    64 #define mainloop_api		(this->hidden->mainloop_api)
    65 #define context			(this->hidden->context)
    66 #define stream			(this->hidden->stream)
    67 #define mixbuf			(this->hidden->mixbuf)
    68 #define mixlen			(this->hidden->mixlen)
    69 
    70 #endif /* _SDL_pulseaudio_h */
    71