2 * OpenAL cross platform audio library
3 * Copyright (C) 1999-2007 by authors.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library 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. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 * Or go to http://www.gnu.org/copyleft/lgpl.html
31 #include <CoreServices/CoreServices.h>
33 #include <AudioUnit/AudioUnit.h>
34 #include <AudioToolbox/AudioToolbox.h>
41 ALdouble sampleRateRatio
; // Ratio of hardware sample rate / requested sample rate
42 AudioStreamBasicDescription format
; // This is the OpenAL format as a CoreAudio ASBD
44 AudioConverterRef audioConverter
; // Sample rate converter if needed
45 AudioBufferList
*bufferList
; // Buffer for data coming from the input device
46 ALCvoid
*resampleBuffer
; // Buffer for returned RingBuffer data when resampling
51 static const ALCchar ca_device
[] = "CoreAudio Default";
54 static void destroy_buffer_list(AudioBufferList
* list
)
59 for(i
= 0;i
< list
->mNumberBuffers
;i
++)
60 free(list
->mBuffers
[i
].mData
);
65 static AudioBufferList
* allocate_buffer_list(UInt32 channelCount
, UInt32 byteSize
)
67 AudioBufferList
*list
;
69 list
= calloc(1, sizeof(AudioBufferList
) + sizeof(AudioBuffer
));
72 list
->mNumberBuffers
= 1;
74 list
->mBuffers
[0].mNumberChannels
= channelCount
;
75 list
->mBuffers
[0].mDataByteSize
= byteSize
;
76 list
->mBuffers
[0].mData
= malloc(byteSize
);
77 if(list
->mBuffers
[0].mData
== NULL
)
86 static OSStatus
ca_callback(void *inRefCon
, AudioUnitRenderActionFlags
*ioActionFlags
, const AudioTimeStamp
*inTimeStamp
,
87 UInt32 inBusNumber
, UInt32 inNumberFrames
, AudioBufferList
*ioData
)
89 ALCdevice
*device
= (ALCdevice
*)inRefCon
;
90 ca_data
*data
= (ca_data
*)device
->ExtraData
;
92 aluMixData(device
, ioData
->mBuffers
[0].mData
,
93 ioData
->mBuffers
[0].mDataByteSize
/ data
->frameSize
);
98 static OSStatus
ca_capture_conversion_callback(AudioConverterRef inAudioConverter
, UInt32
*ioNumberDataPackets
,
99 AudioBufferList
*ioData
, AudioStreamPacketDescription
**outDataPacketDescription
, void* inUserData
)
101 ALCdevice
*device
= (ALCdevice
*)inUserData
;
102 ca_data
*data
= (ca_data
*)device
->ExtraData
;
104 // Read from the ring buffer and store temporarily in a large buffer
105 ReadRingBuffer(data
->ring
, data
->resampleBuffer
, (ALsizei
)(*ioNumberDataPackets
));
107 // Set the input data
108 ioData
->mNumberBuffers
= 1;
109 ioData
->mBuffers
[0].mNumberChannels
= data
->format
.mChannelsPerFrame
;
110 ioData
->mBuffers
[0].mData
= data
->resampleBuffer
;
111 ioData
->mBuffers
[0].mDataByteSize
= (*ioNumberDataPackets
) * data
->format
.mBytesPerFrame
;
116 static OSStatus
ca_capture_callback(void *inRefCon
, AudioUnitRenderActionFlags
*ioActionFlags
,
117 const AudioTimeStamp
*inTimeStamp
, UInt32 inBusNumber
,
118 UInt32 inNumberFrames
, AudioBufferList
*ioData
)
120 ALCdevice
*device
= (ALCdevice
*)inRefCon
;
121 ca_data
*data
= (ca_data
*)device
->ExtraData
;
122 AudioUnitRenderActionFlags flags
= 0;
125 // fill the bufferList with data from the input device
126 err
= AudioUnitRender(data
->audioUnit
, &flags
, inTimeStamp
, 1, inNumberFrames
, data
->bufferList
);
129 ERR("AudioUnitRender error: %d\n", err
);
133 WriteRingBuffer(data
->ring
, data
->bufferList
->mBuffers
[0].mData
, inNumberFrames
);
138 static ALCenum
ca_open_playback(ALCdevice
*device
, const ALCchar
*deviceName
)
140 ComponentDescription desc
;
146 deviceName
= ca_device
;
147 else if(strcmp(deviceName
, ca_device
) != 0)
148 return ALC_INVALID_VALUE
;
150 /* open the default output unit */
151 desc
.componentType
= kAudioUnitType_Output
;
152 desc
.componentSubType
= kAudioUnitSubType_DefaultOutput
;
153 desc
.componentManufacturer
= kAudioUnitManufacturer_Apple
;
154 desc
.componentFlags
= 0;
155 desc
.componentFlagsMask
= 0;
157 comp
= FindNextComponent(NULL
, &desc
);
160 ERR("FindNextComponent failed\n");
161 return ALC_INVALID_VALUE
;
164 data
= calloc(1, sizeof(*data
));
165 device
->ExtraData
= data
;
167 err
= OpenAComponent(comp
, &data
->audioUnit
);
170 ERR("OpenAComponent failed\n");
172 device
->ExtraData
= NULL
;
173 return ALC_INVALID_VALUE
;
179 static void ca_close_playback(ALCdevice
*device
)
181 ca_data
*data
= (ca_data
*)device
->ExtraData
;
183 CloseComponent(data
->audioUnit
);
186 device
->ExtraData
= NULL
;
189 static ALCboolean
ca_reset_playback(ALCdevice
*device
)
191 ca_data
*data
= (ca_data
*)device
->ExtraData
;
192 AudioStreamBasicDescription streamFormat
;
193 AURenderCallbackStruct input
;
197 /* init and start the default audio unit... */
198 err
= AudioUnitInitialize(data
->audioUnit
);
201 ERR("AudioUnitInitialize failed\n");
205 err
= AudioOutputUnitStart(data
->audioUnit
);
208 ERR("AudioOutputUnitStart failed\n");
212 /* retrieve default output unit's properties (output side) */
213 size
= sizeof(AudioStreamBasicDescription
);
214 err
= AudioUnitGetProperty(data
->audioUnit
, kAudioUnitProperty_StreamFormat
, kAudioUnitScope_Output
, 0, &streamFormat
, &size
);
215 if(err
!= noErr
|| size
!= sizeof(AudioStreamBasicDescription
))
217 ERR("AudioUnitGetProperty failed\n");
222 TRACE("Output streamFormat of default output unit -\n");
223 TRACE(" streamFormat.mFramesPerPacket = %d\n", streamFormat
.mFramesPerPacket
);
224 TRACE(" streamFormat.mChannelsPerFrame = %d\n", streamFormat
.mChannelsPerFrame
);
225 TRACE(" streamFormat.mBitsPerChannel = %d\n", streamFormat
.mBitsPerChannel
);
226 TRACE(" streamFormat.mBytesPerPacket = %d\n", streamFormat
.mBytesPerPacket
);
227 TRACE(" streamFormat.mBytesPerFrame = %d\n", streamFormat
.mBytesPerFrame
);
228 TRACE(" streamFormat.mSampleRate = %5.0f\n", streamFormat
.mSampleRate
);
231 /* set default output unit's input side to match output side */
232 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioUnitProperty_StreamFormat
, kAudioUnitScope_Input
, 0, &streamFormat
, size
);
235 ERR("AudioUnitSetProperty failed\n");
239 if(device
->Frequency
!= streamFormat
.mSampleRate
)
241 if((device
->Flags
&DEVICE_FREQUENCY_REQUEST
))
242 ERR("CoreAudio does not support changing sample rates (wanted %dhz, got %dhz)\n", device
->Frequency
, streamFormat
.mSampleRate
);
243 device
->Flags
&= ~DEVICE_FREQUENCY_REQUEST
;
245 device
->UpdateSize
= (ALuint
)((ALuint64
)device
->UpdateSize
*
246 streamFormat
.mSampleRate
/
248 device
->Frequency
= streamFormat
.mSampleRate
;
251 /* FIXME: How to tell what channels are what in the output device, and how
252 * to specify what we're giving? eg, 6.0 vs 5.1 */
253 switch(streamFormat
.mChannelsPerFrame
)
256 if((device
->Flags
&DEVICE_CHANNELS_REQUEST
) &&
257 device
->FmtChans
!= DevFmtMono
)
259 ERR("Failed to set %s, got Mono instead\n", DevFmtChannelsString(device
->FmtChans
));
260 device
->Flags
&= ~DEVICE_CHANNELS_REQUEST
;
262 device
->FmtChans
= DevFmtMono
;
265 if((device
->Flags
&DEVICE_CHANNELS_REQUEST
) &&
266 device
->FmtChans
!= DevFmtStereo
)
268 ERR("Failed to set %s, got Stereo instead\n", DevFmtChannelsString(device
->FmtChans
));
269 device
->Flags
&= ~DEVICE_CHANNELS_REQUEST
;
271 device
->FmtChans
= DevFmtStereo
;
274 if((device
->Flags
&DEVICE_CHANNELS_REQUEST
) &&
275 device
->FmtChans
!= DevFmtQuad
)
277 ERR("Failed to set %s, got Quad instead\n", DevFmtChannelsString(device
->FmtChans
));
278 device
->Flags
&= ~DEVICE_CHANNELS_REQUEST
;
280 device
->FmtChans
= DevFmtQuad
;
283 if((device
->Flags
&DEVICE_CHANNELS_REQUEST
) &&
284 device
->FmtChans
!= DevFmtX51
)
286 ERR("Failed to set %s, got 5.1 Surround instead\n", DevFmtChannelsString(device
->FmtChans
));
287 device
->Flags
&= ~DEVICE_CHANNELS_REQUEST
;
289 device
->FmtChans
= DevFmtX51
;
292 if((device
->Flags
&DEVICE_CHANNELS_REQUEST
) &&
293 device
->FmtChans
!= DevFmtX61
)
295 ERR("Failed to set %s, got 6.1 Surround instead\n", DevFmtChannelsString(device
->FmtChans
));
296 device
->Flags
&= ~DEVICE_CHANNELS_REQUEST
;
298 device
->FmtChans
= DevFmtX61
;
301 if((device
->Flags
&DEVICE_CHANNELS_REQUEST
) &&
302 device
->FmtChans
!= DevFmtX71
)
304 ERR("Failed to set %s, got 7.1 Surround instead\n", DevFmtChannelsString(device
->FmtChans
));
305 device
->Flags
&= ~DEVICE_CHANNELS_REQUEST
;
307 device
->FmtChans
= DevFmtX71
;
310 ERR("Unhandled channel count (%d), using Stereo\n", streamFormat
.mChannelsPerFrame
);
311 device
->Flags
&= ~DEVICE_CHANNELS_REQUEST
;
312 device
->FmtChans
= DevFmtStereo
;
313 streamFormat
.mChannelsPerFrame
= 2;
316 SetDefaultWFXChannelOrder(device
);
318 /* use channel count and sample rate from the default output unit's current
319 * parameters, but reset everything else */
320 streamFormat
.mFramesPerPacket
= 1;
321 switch(device
->FmtType
)
324 device
->FmtType
= DevFmtByte
;
327 streamFormat
.mBitsPerChannel
= 8;
328 streamFormat
.mBytesPerPacket
= streamFormat
.mChannelsPerFrame
;
329 streamFormat
.mBytesPerFrame
= streamFormat
.mChannelsPerFrame
;
333 device
->FmtType
= DevFmtShort
;
336 streamFormat
.mBitsPerChannel
= 16;
337 streamFormat
.mBytesPerPacket
= 2 * streamFormat
.mChannelsPerFrame
;
338 streamFormat
.mBytesPerFrame
= 2 * streamFormat
.mChannelsPerFrame
;
341 streamFormat
.mFormatID
= kAudioFormatLinearPCM
;
342 streamFormat
.mFormatFlags
= kLinearPCMFormatFlagIsSignedInteger
|
343 kAudioFormatFlagsNativeEndian
|
344 kLinearPCMFormatFlagIsPacked
;
346 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioUnitProperty_StreamFormat
, kAudioUnitScope_Input
, 0, &streamFormat
, sizeof(AudioStreamBasicDescription
));
349 ERR("AudioUnitSetProperty failed\n");
354 data
->frameSize
= FrameSizeFromDevFmt(device
->FmtChans
, device
->FmtType
);
355 input
.inputProc
= ca_callback
;
356 input
.inputProcRefCon
= device
;
358 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioUnitProperty_SetRenderCallback
, kAudioUnitScope_Input
, 0, &input
, sizeof(AURenderCallbackStruct
));
361 ERR("AudioUnitSetProperty failed\n");
368 static void ca_stop_playback(ALCdevice
*device
)
370 ca_data
*data
= (ca_data
*)device
->ExtraData
;
373 AudioOutputUnitStop(data
->audioUnit
);
374 err
= AudioUnitUninitialize(data
->audioUnit
);
376 ERR("-- AudioUnitUninitialize failed.\n");
379 static ALCenum
ca_open_capture(ALCdevice
*device
, const ALCchar
*deviceName
)
381 AudioStreamBasicDescription requestedFormat
; // The application requested format
382 AudioStreamBasicDescription hardwareFormat
; // The hardware format
383 AudioStreamBasicDescription outputFormat
; // The AudioUnit output format
384 AURenderCallbackStruct input
;
385 ComponentDescription desc
;
386 AudioDeviceID inputDevice
;
387 UInt32 outputFrameCount
;
394 desc
.componentType
= kAudioUnitType_Output
;
395 desc
.componentSubType
= kAudioUnitSubType_HALOutput
;
396 desc
.componentManufacturer
= kAudioUnitManufacturer_Apple
;
397 desc
.componentFlags
= 0;
398 desc
.componentFlagsMask
= 0;
400 // Search for component with given description
401 comp
= FindNextComponent(NULL
, &desc
);
404 ERR("FindNextComponent failed\n");
405 return ALC_INVALID_VALUE
;
408 data
= calloc(1, sizeof(*data
));
409 device
->ExtraData
= data
;
411 // Open the component
412 err
= OpenAComponent(comp
, &data
->audioUnit
);
415 ERR("OpenAComponent failed\n");
419 // Turn off AudioUnit output
421 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioOutputUnitProperty_EnableIO
, kAudioUnitScope_Output
, 0, &enableIO
, sizeof(ALuint
));
424 ERR("AudioUnitSetProperty failed\n");
428 // Turn on AudioUnit input
430 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioOutputUnitProperty_EnableIO
, kAudioUnitScope_Input
, 1, &enableIO
, sizeof(ALuint
));
433 ERR("AudioUnitSetProperty failed\n");
437 // Get the default input device
438 propertySize
= sizeof(AudioDeviceID
);
439 err
= AudioHardwareGetProperty(kAudioHardwarePropertyDefaultInputDevice
, &propertySize
, &inputDevice
);
442 ERR("AudioHardwareGetProperty failed\n");
446 if(inputDevice
== kAudioDeviceUnknown
)
448 ERR("No input device found\n");
452 // Track the input device
453 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioOutputUnitProperty_CurrentDevice
, kAudioUnitScope_Global
, 0, &inputDevice
, sizeof(AudioDeviceID
));
456 ERR("AudioUnitSetProperty failed\n");
460 // set capture callback
461 input
.inputProc
= ca_capture_callback
;
462 input
.inputProcRefCon
= device
;
464 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioOutputUnitProperty_SetInputCallback
, kAudioUnitScope_Global
, 0, &input
, sizeof(AURenderCallbackStruct
));
467 ERR("AudioUnitSetProperty failed\n");
471 // Initialize the device
472 err
= AudioUnitInitialize(data
->audioUnit
);
475 ERR("AudioUnitInitialize failed\n");
479 // Get the hardware format
480 propertySize
= sizeof(AudioStreamBasicDescription
);
481 err
= AudioUnitGetProperty(data
->audioUnit
, kAudioUnitProperty_StreamFormat
, kAudioUnitScope_Input
, 1, &hardwareFormat
, &propertySize
);
482 if(err
!= noErr
|| propertySize
!= sizeof(AudioStreamBasicDescription
))
484 ERR("AudioUnitGetProperty failed\n");
488 // Set up the requested format description
489 switch(device
->FmtType
)
492 requestedFormat
.mBitsPerChannel
= 8;
493 requestedFormat
.mFormatFlags
= kAudioFormatFlagIsPacked
;
496 requestedFormat
.mBitsPerChannel
= 16;
497 requestedFormat
.mFormatFlags
= kAudioFormatFlagIsSignedInteger
| kAudioFormatFlagsNativeEndian
| kAudioFormatFlagIsPacked
;
500 requestedFormat
.mBitsPerChannel
= 32;
501 requestedFormat
.mFormatFlags
= kAudioFormatFlagIsPacked
;
505 ERR("%s samples not supported\n", DevFmtTypeString(device
->FmtType
));
509 switch(device
->FmtChans
)
512 requestedFormat
.mChannelsPerFrame
= 1;
515 requestedFormat
.mChannelsPerFrame
= 2;
523 ERR("%s not supported\n", DevFmtChannelsString(device
->FmtChans
));
527 requestedFormat
.mBytesPerFrame
= requestedFormat
.mChannelsPerFrame
* requestedFormat
.mBitsPerChannel
/ 8;
528 requestedFormat
.mBytesPerPacket
= requestedFormat
.mBytesPerFrame
;
529 requestedFormat
.mSampleRate
= device
->Frequency
;
530 requestedFormat
.mFormatID
= kAudioFormatLinearPCM
;
531 requestedFormat
.mReserved
= 0;
532 requestedFormat
.mFramesPerPacket
= 1;
534 // save requested format description for later use
535 data
->format
= requestedFormat
;
536 data
->frameSize
= FrameSizeFromDevFmt(device
->FmtChans
, device
->FmtType
);
538 // Use intermediate format for sample rate conversion (outputFormat)
539 // Set sample rate to the same as hardware for resampling later
540 outputFormat
= requestedFormat
;
541 outputFormat
.mSampleRate
= hardwareFormat
.mSampleRate
;
543 // Determine sample rate ratio for resampling
544 data
->sampleRateRatio
= outputFormat
.mSampleRate
/ device
->Frequency
;
546 // The output format should be the requested format, but using the hardware sample rate
547 // This is because the AudioUnit will automatically scale other properties, except for sample rate
548 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioUnitProperty_StreamFormat
, kAudioUnitScope_Output
, 1, (void *)&outputFormat
, sizeof(outputFormat
));
551 ERR("AudioUnitSetProperty failed\n");
555 // Set the AudioUnit output format frame count
556 outputFrameCount
= device
->UpdateSize
* data
->sampleRateRatio
;
557 err
= AudioUnitSetProperty(data
->audioUnit
, kAudioUnitProperty_MaximumFramesPerSlice
, kAudioUnitScope_Output
, 0, &outputFrameCount
, sizeof(outputFrameCount
));
560 ERR("AudioUnitSetProperty failed: %d\n", err
);
564 // Set up sample converter
565 err
= AudioConverterNew(&outputFormat
, &requestedFormat
, &data
->audioConverter
);
568 ERR("AudioConverterNew failed: %d\n", err
);
572 // Create a buffer for use in the resample callback
573 data
->resampleBuffer
= malloc(device
->UpdateSize
* data
->frameSize
* data
->sampleRateRatio
);
575 // Allocate buffer for the AudioUnit output
576 data
->bufferList
= allocate_buffer_list(outputFormat
.mChannelsPerFrame
, device
->UpdateSize
* data
->frameSize
* data
->sampleRateRatio
);
577 if(data
->bufferList
== NULL
)
580 data
->ring
= CreateRingBuffer(data
->frameSize
, (device
->UpdateSize
* data
->sampleRateRatio
) * device
->NumUpdates
);
581 if(data
->ring
== NULL
)
587 DestroyRingBuffer(data
->ring
);
588 free(data
->resampleBuffer
);
589 destroy_buffer_list(data
->bufferList
);
591 if(data
->audioConverter
)
592 AudioConverterDispose(data
->audioConverter
);
594 CloseComponent(data
->audioUnit
);
597 device
->ExtraData
= NULL
;
599 return ALC_INVALID_VALUE
;
602 static void ca_close_capture(ALCdevice
*device
)
604 ca_data
*data
= (ca_data
*)device
->ExtraData
;
606 DestroyRingBuffer(data
->ring
);
607 free(data
->resampleBuffer
);
608 destroy_buffer_list(data
->bufferList
);
610 AudioConverterDispose(data
->audioConverter
);
611 CloseComponent(data
->audioUnit
);
614 device
->ExtraData
= NULL
;
617 static void ca_start_capture(ALCdevice
*device
)
619 ca_data
*data
= (ca_data
*)device
->ExtraData
;
620 OSStatus err
= AudioOutputUnitStart(data
->audioUnit
);
622 ERR("AudioOutputUnitStart failed\n");
625 static void ca_stop_capture(ALCdevice
*device
)
627 ca_data
*data
= (ca_data
*)device
->ExtraData
;
628 OSStatus err
= AudioOutputUnitStop(data
->audioUnit
);
630 ERR("AudioOutputUnitStop failed\n");
633 static ALCenum
ca_capture_samples(ALCdevice
*device
, ALCvoid
*buffer
, ALCuint samples
)
635 ca_data
*data
= (ca_data
*)device
->ExtraData
;
636 AudioBufferList
*list
;
640 // If no samples are requested, just return
644 // Allocate a temporary AudioBufferList to use as the return resamples data
645 list
= alloca(sizeof(AudioBufferList
) + sizeof(AudioBuffer
));
647 // Point the resampling buffer to the capture buffer
648 list
->mNumberBuffers
= 1;
649 list
->mBuffers
[0].mNumberChannels
= data
->format
.mChannelsPerFrame
;
650 list
->mBuffers
[0].mDataByteSize
= samples
* data
->frameSize
;
651 list
->mBuffers
[0].mData
= buffer
;
653 // Resample into another AudioBufferList
654 frameCount
= samples
;
655 err
= AudioConverterFillComplexBuffer(data
->audioConverter
, ca_capture_conversion_callback
,
656 device
, &frameCount
, list
, NULL
);
659 ERR("AudioConverterFillComplexBuffer error: %d\n", err
);
660 return ALC_INVALID_VALUE
;
665 static ALCuint
ca_available_samples(ALCdevice
*device
)
667 ca_data
*data
= device
->ExtraData
;
668 return RingBufferSize(data
->ring
) / data
->sampleRateRatio
;
672 static const BackendFuncs ca_funcs
= {
685 ALCboolean
alc_ca_init(BackendFuncs
*func_list
)
687 *func_list
= ca_funcs
;
691 void alc_ca_deinit(void)
695 void alc_ca_probe(enum DevProbe type
)
700 AppendDeviceList(ca_device
);
702 case ALL_DEVICE_PROBE
:
703 AppendAllDeviceList(ca_device
);
705 case CAPTURE_DEVICE_PROBE
:
706 AppendCaptureDeviceList(ca_device
);