2 Copyright (C) 2006 Mathieu Olivier
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to:
18 Free Software Foundation, Inc.
19 59 Temple Place - Suite 330
20 Boston, MA 02111-1307, USA
24 // ALSA module, used by Linux
28 #include <alsa/asoundlib.h>
35 static snd_pcm_t* pcm_handle = NULL;
36 static snd_pcm_sframes_t expected_delay = 0;
37 static unsigned int alsasoundtime;
39 static snd_seq_t* seq_handle = NULL;
45 Create "snd_renderbuffer" with the proper sound format if the call is successful
46 May return a suggested format if the requested format isn't available
49 qboolean SndSys_Init (const snd_format_t* requested, snd_format_t* suggested)
51 const char* pcm_name, *seq_name;
52 int i, err, seq_client, seq_port;
53 snd_pcm_hw_params_t* hw_params = NULL;
54 snd_pcm_format_t snd_pcm_format;
55 snd_pcm_uframes_t buffer_size;
57 Con_Print ("SndSys_Init: using the ALSA module\n");
60 i = COM_CheckParm ("-sndseqin"); // TODO turn this into a cvar, maybe
61 if (i != 0 && i < com_argc - 1)
62 seq_name = com_argv[i + 1];
65 seq_client = atoi(seq_name);
67 if(strchr(seq_name, ':'))
68 seq_port = atoi(strchr(seq_name, ':') + 1);
69 Con_Printf ("SndSys_Init: seq input port has been set to \"%d:%d\". Enabling sequencer input...\n", seq_client, seq_port);
70 err = snd_seq_open (&seq_handle, "default", SND_SEQ_OPEN_INPUT, 0);
73 Con_Print ("SndSys_Init: can't open seq device\n");
76 err = snd_seq_set_client_name(seq_handle, gamename);
79 Con_Print ("SndSys_Init: can't set name of seq device\n");
82 err = snd_seq_create_simple_port(seq_handle, gamename, SND_SEQ_PORT_CAP_WRITE | SND_SEQ_PORT_CAP_SUBS_WRITE, SND_SEQ_PORT_TYPE_MIDI_GENERIC | SND_SEQ_PORT_TYPE_APPLICATION);
85 Con_Print ("SndSys_Init: can't create seq port\n");
88 err = snd_seq_connect_from(seq_handle, 0, seq_client, seq_port);
91 Con_Printf ("SndSys_Init: can't connect to seq port \"%d:%d\"\n", seq_client, seq_port);
94 err = snd_seq_nonblock(seq_handle, 1);
97 Con_Print ("SndSys_Init: can't make seq nonblocking\n");
104 snd_seq_close(seq_handle);
109 // Check the requested sound format
110 if (requested->width < 1 || requested->width > 2)
112 Con_Printf ("SndSys_Init: invalid sound width (%hu)\n",
115 if (suggested != NULL)
117 memcpy (suggested, requested, sizeof (*suggested));
119 if (requested->width < 1)
120 suggested->width = 1;
122 suggested->width = 2;
124 Con_Printf ("SndSys_Init: suggesting sound width = %hu\n",
131 if (pcm_handle != NULL)
133 Con_Print ("SndSys_Init: WARNING: Init called before Shutdown!\n");
137 // Determine the name of the PCM handle we'll use
138 switch (requested->channels)
141 pcm_name = "surround40";
144 pcm_name = "surround51";
147 pcm_name = "surround71";
150 pcm_name = "default";
153 // COMMANDLINEOPTION: Linux ALSA Sound: -sndpcm <devicename> selects which pcm device to us, default is "default"
154 i = COM_CheckParm ("-sndpcm");
155 if (i != 0 && i < com_argc - 1)
156 pcm_name = com_argv[i + 1];
158 // Open the audio device
159 Con_Printf ("SndSys_Init: PCM device is \"%s\"\n", pcm_name);
160 err = snd_pcm_open (&pcm_handle, pcm_name, SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK);
163 Con_Printf ("SndSys_Init: can't open audio device \"%s\" (%s)\n",
164 pcm_name, snd_strerror (err));
168 // Allocate the hardware parameters
169 err = snd_pcm_hw_params_malloc (&hw_params);
172 Con_Printf ("SndSys_Init: can't allocate hardware parameters (%s)\n",
176 err = snd_pcm_hw_params_any (pcm_handle, hw_params);
179 Con_Printf ("SndSys_Init: can't initialize hardware parameters (%s)\n",
184 // Set the access type
185 err = snd_pcm_hw_params_set_access (pcm_handle, hw_params, SND_PCM_ACCESS_RW_INTERLEAVED);
188 Con_Printf ("SndSys_Init: can't set access type (%s)\n",
193 // Set the sound width
194 if (requested->width == 1)
195 snd_pcm_format = SND_PCM_FORMAT_U8;
197 snd_pcm_format = SND_PCM_FORMAT_S16;
198 err = snd_pcm_hw_params_set_format (pcm_handle, hw_params, snd_pcm_format);
201 Con_Printf ("SndSys_Init: can't set sound width to %hu (%s)\n",
202 requested->width, snd_strerror (err));
206 // Set the sound channels
207 err = snd_pcm_hw_params_set_channels (pcm_handle, hw_params, requested->channels);
210 Con_Printf ("SndSys_Init: can't set sound channels to %hu (%s)\n",
211 requested->channels, snd_strerror (err));
215 // Set the sound speed
216 err = snd_pcm_hw_params_set_rate (pcm_handle, hw_params, requested->speed, 0);
219 Con_Printf ("SndSys_Init: can't set sound speed to %u (%s)\n",
220 requested->speed, snd_strerror (err));
224 buffer_size = requested->speed / 5;
225 err = snd_pcm_hw_params_set_buffer_size_near (pcm_handle, hw_params, &buffer_size);
228 Con_Printf ("SndSys_Init: can't set sound buffer size to %lu (%s)\n",
229 buffer_size, snd_strerror (err));
233 buffer_size /= NB_PERIODS;
234 err = snd_pcm_hw_params_set_period_size_near(pcm_handle, hw_params, &buffer_size, 0);
237 Con_Printf ("SndSys_Init: can't set sound period size to %lu (%s)\n",
238 buffer_size, snd_strerror (err));
242 err = snd_pcm_hw_params (pcm_handle, hw_params);
245 Con_Printf ("SndSys_Init: can't set hardware parameters (%s)\n",
250 snd_pcm_hw_params_free (hw_params);
252 snd_renderbuffer = Snd_CreateRingBuffer(requested, 0, NULL);
255 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
256 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_ALSA);
261 // It's not very clean, but it avoids a lot of duplicated code.
264 if (hw_params != NULL)
265 snd_pcm_hw_params_free (hw_params);
267 snd_pcm_close(pcm_handle);
278 Stop the sound card, delete "snd_renderbuffer" and free its other resources
281 void SndSys_Shutdown (void)
283 if (seq_handle != NULL)
285 snd_seq_close(seq_handle);
289 if (pcm_handle != NULL)
291 snd_pcm_close(pcm_handle);
295 if (snd_renderbuffer != NULL)
297 Mem_Free(snd_renderbuffer->ring);
298 Mem_Free(snd_renderbuffer);
299 snd_renderbuffer = NULL;
308 Try to recover from errors
311 static qboolean SndSys_Recover (int err_num)
315 // We can only do something on underrun ("broken pipe") errors
316 if (err_num != -EPIPE)
319 err = snd_pcm_prepare (pcm_handle);
322 Con_Printf ("SndSys_Recover: unable to recover (%s)\n",
325 // TOCHECK: should we stop the playback ?
339 static snd_pcm_sframes_t SndSys_Write (const unsigned char* buffer, unsigned int nbframes)
341 snd_pcm_sframes_t written;
343 written = snd_pcm_writei (pcm_handle, buffer, nbframes);
346 if (developer.integer >= 1000 && vid_activewindow)
347 Con_Printf ("SndSys_Write: audio write returned %ld (%s)!\n",
348 written, snd_strerror (written));
350 if (SndSys_Recover (written))
352 written = snd_pcm_writei (pcm_handle, buffer, nbframes);
354 Con_DPrintf ("SndSys_Write: audio write failed again (error %ld: %s)!\n",
355 written, snd_strerror (written));
360 snd_renderbuffer->startframe += written;
361 expected_delay += written;
372 Submit the contents of "snd_renderbuffer" to the sound card
375 void SndSys_Submit (void)
377 unsigned int startoffset, factor;
378 snd_pcm_uframes_t limit, nbframes;
379 snd_pcm_sframes_t written;
381 if (pcm_handle == NULL ||
382 snd_renderbuffer->startframe == snd_renderbuffer->endframe)
385 startoffset = snd_renderbuffer->startframe % snd_renderbuffer->maxframes;
386 factor = snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
387 limit = snd_renderbuffer->maxframes - startoffset;
388 nbframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
390 if (nbframes > limit)
392 written = SndSys_Write (&snd_renderbuffer->ring[startoffset * factor], limit);
393 if (written < 0 || (snd_pcm_uframes_t)written != limit)
400 written = SndSys_Write (&snd_renderbuffer->ring[startoffset * factor], nbframes);
410 Returns the number of sample frames consumed since the sound started
413 unsigned int SndSys_GetSoundTime (void)
415 snd_pcm_sframes_t delay, timediff;
418 if (pcm_handle == NULL)
421 err = snd_pcm_delay (pcm_handle, &delay);
424 if (developer.integer >= 1000 && vid_activewindow)
425 Con_DPrintf ("SndSys_GetSoundTime: can't get playback delay (%s)\n",
428 if (! SndSys_Recover (err))
431 err = snd_pcm_delay (pcm_handle, &delay);
434 Con_DPrintf ("SndSys_GetSoundTime: can't get playback delay, again (%s)\n",
440 if (expected_delay < delay)
442 Con_DPrintf ("SndSys_GetSoundTime: expected_delay(%ld) < delay(%ld)\n",
443 expected_delay, delay);
447 timediff = expected_delay - delay;
448 expected_delay = delay;
450 alsasoundtime += (unsigned int)timediff;
452 return alsasoundtime;
458 SndSys_LockRenderBuffer
460 Get the exclusive lock on "snd_renderbuffer"
463 qboolean SndSys_LockRenderBuffer (void)
472 SndSys_UnlockRenderBuffer
474 Release the exclusive lock on "snd_renderbuffer"
477 void SndSys_UnlockRenderBuffer (void)
486 Send keyboard events originating from the sound system (e.g. MIDI)
489 void SndSys_SendKeyEvents(void)
491 snd_seq_event_t *event;
496 if(snd_seq_event_input(seq_handle, &event) <= 0)
502 case SND_SEQ_EVENT_NOTEON:
503 if(event->data.note.velocity)
505 Key_Event(K_MIDINOTE0 + event->data.note.note, 0, true);
508 case SND_SEQ_EVENT_NOTEOFF:
509 Key_Event(K_MIDINOTE0 + event->data.note.note, 0, false);