2 ===========================================================================
3 Copyright (C) 1999-2005 Id Software, Inc.
5 This file is part of Quake III Arena source code.
7 Quake III Arena source code is free software; you can redistribute it
8 and/or modify it under the terms of the GNU General Public License as
9 published by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
12 Quake III Arena source code is distributed in the hope that it will be
13 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Foobar; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 ===========================================================================
26 #include <CoreAudio/AudioHardware.h>
32 #define CHUNK_SIZE 1024
34 static unsigned int submissionChunk = 0; // in sample frames
35 static unsigned int coreaudiotime = 0; // based on the number of chunks submitted so far
36 static qboolean s_isRunning = false;
37 static pthread_mutex_t coreaudio_mutex;
38 static AudioDeviceID outputDeviceID = kAudioDeviceUnknown;
46 static OSStatus audioDeviceIOProc(AudioDeviceID inDevice,
47 const AudioTimeStamp *inNow,
48 const AudioBufferList *inInputData,
49 const AudioTimeStamp *inInputTime,
50 AudioBufferList *outOutputData,
51 const AudioTimeStamp *inOutputTime,
55 unsigned int frameCount, factor;
57 outBuffer = (float*)outOutputData->mBuffers[0].mData;
58 factor = snd_renderbuffer->format.channels * snd_renderbuffer->format.width;
61 // Lock the snd_renderbuffer
62 if (SndSys_LockRenderBuffer())
64 unsigned int maxFrames, sampleIndex, sampleCount;
65 unsigned int startOffset, endOffset;
67 const float scale = 1.0f / SHRT_MAX;
69 // Transfert up to a chunk of sample frames from snd_renderbuffer to outBuffer
70 maxFrames = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
71 if (maxFrames >= submissionChunk)
72 frameCount = submissionChunk;
74 frameCount = maxFrames;
76 // Convert the samples from shorts to floats. Scale the floats to be [-1..1].
77 startOffset = snd_renderbuffer->startframe % snd_renderbuffer->maxframes;
78 endOffset = (snd_renderbuffer->startframe + frameCount) % snd_renderbuffer->maxframes;
79 if (startOffset > endOffset) // if the buffer wraps
81 sampleCount = (snd_renderbuffer->maxframes - startOffset) * snd_renderbuffer->format.channels;
82 samples = (const short*)(&snd_renderbuffer->ring[startOffset * factor]);
83 for (sampleIndex = 0; sampleIndex < sampleCount; sampleIndex++)
84 outBuffer[sampleIndex] = samples[sampleIndex] * scale;
86 outBuffer = &outBuffer[sampleCount];
87 sampleCount = frameCount * snd_renderbuffer->format.channels - sampleCount;
88 samples = (const short*)(&snd_renderbuffer->ring[0]);
89 for (sampleIndex = 0; sampleIndex < sampleCount; sampleIndex++)
90 outBuffer[sampleIndex] = samples[sampleIndex] * scale;
94 sampleCount = frameCount * snd_renderbuffer->format.channels;
95 samples = (const short*)(&snd_renderbuffer->ring[startOffset * factor]);
96 for (sampleIndex = 0; sampleIndex < sampleCount; sampleIndex++)
97 outBuffer[sampleIndex] = samples[sampleIndex] * scale;
100 snd_renderbuffer->startframe += frameCount;
102 // Unlock the snd_renderbuffer
103 SndSys_UnlockRenderBuffer();
106 // If there was not enough samples, complete with silence samples
107 if (frameCount < submissionChunk)
109 unsigned int missingFrames;
111 missingFrames = submissionChunk - frameCount;
112 Con_DPrintf("audioDeviceIOProc: %u sample frames missing\n", missingFrames);
113 memset(&outBuffer[frameCount * snd_renderbuffer->format.channels], 0, missingFrames * sizeof(outBuffer[0]));
116 coreaudiotime += submissionChunk;
125 Create "snd_renderbuffer" with the proper sound format if the call is successful
126 May return a suggested format if the requested format isn't available
129 qboolean SndSys_Init (const snd_format_t* requested, snd_format_t* suggested)
132 UInt32 propertySize, bufferByteCount;
133 AudioStreamBasicDescription streamDesc;
138 Con_Printf("Initializing CoreAudio...\n");
140 // We only accept 16-bit samples for the moment
141 if (requested->width != 2)
143 // Suggest a 16-bit format instead
144 if (suggested != NULL)
146 memcpy (suggested, requested, sizeof (suggested));
147 suggested->width = 2;
153 // Get the output device
154 propertySize = sizeof(outputDeviceID);
155 status = AudioHardwareGetProperty(kAudioHardwarePropertyDefaultOutputDevice, &propertySize, &outputDeviceID);
158 Con_Printf("CoreAudio: AudioDeviceGetProperty() returned %d when getting kAudioHardwarePropertyDefaultOutputDevice\n", status);
161 if (outputDeviceID == kAudioDeviceUnknown)
163 Con_Printf("CoreAudio: outputDeviceID is kAudioDeviceUnknown\n");
167 // Configure the output device
168 propertySize = sizeof(bufferByteCount);
169 bufferByteCount = CHUNK_SIZE * sizeof(float) * requested->channels;
170 status = AudioDeviceSetProperty(outputDeviceID, NULL, 0, false, kAudioDevicePropertyBufferSize, propertySize, &bufferByteCount);
173 Con_Printf("CoreAudio: AudioDeviceSetProperty() returned %d when setting kAudioDevicePropertyBufferSize to %d\n", status, CHUNK_SIZE);
177 propertySize = sizeof(bufferByteCount);
178 status = AudioDeviceGetProperty(outputDeviceID, 0, false, kAudioDevicePropertyBufferSize, &propertySize, &bufferByteCount);
181 Con_Printf("CoreAudio: AudioDeviceGetProperty() returned %d when setting kAudioDevicePropertyBufferSize\n", status);
185 submissionChunk = bufferByteCount / sizeof(float);
186 if (submissionChunk % requested->channels != 0)
188 Con_Print("CoreAudio: chunk size is NOT a multiple of the number of channels\n");
191 submissionChunk /= requested->channels;
192 Con_DPrintf(" Chunk size = %d sample frames\n", submissionChunk);
194 // Print out the device status
195 propertySize = sizeof(streamDesc);
196 status = AudioDeviceGetProperty(outputDeviceID, 0, false, kAudioDevicePropertyStreamFormat, &propertySize, &streamDesc);
199 Con_Printf("CoreAudio: AudioDeviceGetProperty() returned %d when getting kAudioDevicePropertyStreamFormat\n", status);
202 Con_DPrint (" Hardware format:\n");
203 Con_DPrintf(" %5d mSampleRate\n", (unsigned int)streamDesc.mSampleRate);
204 Con_DPrintf(" %c%c%c%c mFormatID\n",
205 (streamDesc.mFormatID & 0xff000000) >> 24,
206 (streamDesc.mFormatID & 0x00ff0000) >> 16,
207 (streamDesc.mFormatID & 0x0000ff00) >> 8,
208 (streamDesc.mFormatID & 0x000000ff) >> 0);
209 Con_DPrintf(" %5d mBytesPerPacket\n", streamDesc.mBytesPerPacket);
210 Con_DPrintf(" %5d mFramesPerPacket\n", streamDesc.mFramesPerPacket);
211 Con_DPrintf(" %5d mBytesPerFrame\n", streamDesc.mBytesPerFrame);
212 Con_DPrintf(" %5d mChannelsPerFrame\n", streamDesc.mChannelsPerFrame);
213 Con_DPrintf(" %5d mBitsPerChannel\n", streamDesc.mBitsPerChannel);
215 if(streamDesc.mFormatID != kAudioFormatLinearPCM)
217 Con_Print("CoreAudio: Default audio device doesn't support linear PCM!\n");
221 // Add the callback function
222 status = AudioDeviceAddIOProc(outputDeviceID, audioDeviceIOProc, NULL);
225 Con_Printf("CoreAudio: AudioDeviceAddIOProc() returned %d\n", status);
229 // We haven't sent any sample frames yet
232 if (pthread_mutex_init(&coreaudio_mutex, NULL) != 0)
234 Con_Print("CoreAudio: can't create pthread mutex\n");
235 AudioDeviceRemoveIOProc(outputDeviceID, audioDeviceIOProc);
239 snd_renderbuffer = Snd_CreateRingBuffer(requested, 0, NULL);
241 // Start sound running
242 status = AudioDeviceStart(outputDeviceID, audioDeviceIOProc);
245 Con_Printf("CoreAudio: AudioDeviceStart() returned %d\n", status);
246 pthread_mutex_destroy(&coreaudio_mutex);
247 AudioDeviceRemoveIOProc(outputDeviceID, audioDeviceIOProc);
252 Con_Print(" Initialization successful\n");
261 Stop the sound card, delete "snd_renderbuffer" and free its other resources
264 void SndSys_Shutdown(void)
271 status = AudioDeviceStop(outputDeviceID, audioDeviceIOProc);
274 Con_Printf("AudioDeviceStop: returned %d\n", status);
279 pthread_mutex_destroy(&coreaudio_mutex);
281 status = AudioDeviceRemoveIOProc(outputDeviceID, audioDeviceIOProc);
284 Con_Printf("AudioDeviceRemoveIOProc: returned %d\n", status);
288 if (snd_renderbuffer != NULL)
290 Mem_Free(snd_renderbuffer->ring);
291 Mem_Free(snd_renderbuffer);
292 snd_renderbuffer = NULL;
301 Submit the contents of "snd_renderbuffer" to the sound card
304 void SndSys_Submit (void)
306 // Nothing to do here (this sound module is callback-based)
314 Returns the number of sample frames consumed since the sound started
317 unsigned int SndSys_GetSoundTime (void)
319 return coreaudiotime;
325 SndSys_LockRenderBuffer
327 Get the exclusive lock on "snd_renderbuffer"
330 qboolean SndSys_LockRenderBuffer (void)
332 return (pthread_mutex_lock(&coreaudio_mutex) == 0);
338 SndSys_UnlockRenderBuffer
340 Release the exclusive lock on "snd_renderbuffer"
343 void SndSys_UnlockRenderBuffer (void)
345 pthread_mutex_unlock(&coreaudio_mutex);