1 /*****************************************************************************
2 * auhal.c: AUHAL and Coreaudio output plugin
3 *****************************************************************************
4 * Copyright (C) 2005 - 2013 VLC authors and VideoLAN
7 * Authors: Derk-Jan Hartman <hartman at videolan dot org>
8 * Felix Paul Kühne <fkuehne at videolan dot org>
9 * David Fuhrmann <david dot fuhrmann at googlemail dot com>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
32 #import <vlc_common.h>
33 #import <vlc_plugin.h>
34 #import <vlc_dialog.h> // dialog_Fatal
35 #import <vlc_aout.h> // aout_*
37 #import <AudioUnit/AudioUnit.h> // AudioUnit
38 #import <CoreAudio/CoreAudio.h> // AudioDeviceID
39 #import <AudioToolbox/AudioFormat.h> // AudioFormatGetProperty
40 #import <CoreServices/CoreServices.h>
42 #import "TPCircularBuffer.h"
45 #pragma mark private declarations
48 # define verify_noerr(a) assert((a) == noErr)
51 #define STREAM_FORMAT_MSG(pre, sfm) \
52 pre "[%f][%4.4s][%u][%u][%u][%u][%u][%u]", \
53 sfm.mSampleRate, (char *)&sfm.mFormatID, \
54 (unsigned int)sfm.mFormatFlags, (unsigned int)sfm.mBytesPerPacket, \
55 (unsigned int)sfm.mFramesPerPacket, (unsigned int)sfm.mBytesPerFrame, \
56 (unsigned int)sfm.mChannelsPerFrame, (unsigned int)sfm.mBitsPerChannel
58 #define AOUT_VAR_SPDIF_FLAG 0xf00000
60 #define AUDIO_BUFFER_SIZE_IN_SECONDS (AOUT_MAX_ADVANCE_TIME / CLOCK_FREQ)
63 #define AOUT_VOLUME_DEFAULT 256
64 #define AOUT_VOLUME_MAX 512
66 #define VOLUME_TEXT N_("Audio volume")
67 #define VOLUME_LONGTEXT VOLUME_TEXT
69 #define DEVICE_TEXT N_("Last audio device")
70 #define DEVICE_LONGTEXT DEVICE_TEXT
72 /*****************************************************************************
73 * aout_sys_t: private audio output method descriptor
74 *****************************************************************************
75 * This structure is part of the audio output thread descriptor.
76 * It describes the CoreAudio specific properties of an output thread.
77 *****************************************************************************/
80 AudioObjectID i_default_dev; /* DeviceID of defaultOutputDevice */
81 AudioObjectID i_selected_dev; /* DeviceID of the selected device */
82 AudioObjectID i_new_selected_dev; /* DeviceID of device which will be selected on start */
83 bool b_selected_dev_is_digital;
84 AudioDeviceIOProcID i_procID; /* DeviceID of current device */
85 bool b_digital; /* Are we running in digital mode? */
86 mtime_t clock_diff; /* Difference between VLC clock and Device clock */
88 uint8_t chans_to_reorder; /* do we need channel reordering */
89 uint8_t chan_table[AOUT_CHAN_MAX];
91 UInt32 i_numberOfChannels;
92 TPCircularBuffer circular_buffer; /* circular buffer to swap the audio data */
95 AudioComponent au_component; /* The AudioComponent we use */
96 AudioUnit au_unit; /* The AudioUnit we use */
98 /* CoreAudio SPDIF mode specific */
99 pid_t i_hog_pid; /* The keep the pid of our hog status */
100 AudioStreamID i_stream_id; /* The StreamID that has a cac3 streamformat */
101 int i_stream_index; /* The index of i_stream_id in an AudioBufferList */
102 AudioStreamBasicDescription stream_format; /* The format we changed the stream to */
103 AudioStreamBasicDescription sfmt_revert; /* The original format of the stream */
104 bool b_revert; /* Whether we need to revert the stream format */
105 bool b_changed_mixing; /* Whether we need to set the mixing mode back */
108 bool b_got_first_sample; /* did the aout core provide something to render? */
110 int i_rate; /* media sample rate */
111 int i_bytes_per_sample;
113 CFArrayRef device_list;
123 #pragma mark local prototypes & module descriptor
125 static int Open (vlc_object_t *);
126 static void Close (vlc_object_t *);
127 static int Start (audio_output_t *, audio_sample_format_t *);
128 static int StartAnalog (audio_output_t *, audio_sample_format_t *);
129 static int StartSPDIF (audio_output_t *, audio_sample_format_t *);
130 static void Stop (audio_output_t *);
132 static void RebuildDeviceList (audio_output_t *);
133 static int SwitchAudioDevice (audio_output_t *p_aout, const char *name);
134 static int VolumeSet (audio_output_t *, float);
135 static int MuteSet (audio_output_t *, bool);
137 static void Play (audio_output_t *, block_t *);
138 static void Pause (audio_output_t *, bool, mtime_t);
139 static void Flush (audio_output_t *, bool);
140 static int TimeGet (audio_output_t *, mtime_t *);
141 static OSStatus RenderCallbackAnalog (vlc_object_t *, AudioUnitRenderActionFlags *, const AudioTimeStamp *,
142 UInt32 , UInt32, AudioBufferList *);
144 static OSStatus RenderCallbackSPDIF (AudioDeviceID, const AudioTimeStamp *, const void *, const AudioTimeStamp *,
145 AudioBufferList *, const AudioTimeStamp *, void *);
147 static OSStatus HardwareListener (AudioObjectID, UInt32, const AudioObjectPropertyAddress *, void *);
148 static OSStatus StreamListener (AudioObjectID, UInt32, const AudioObjectPropertyAddress *, void *);
150 static int ManageAudioStreamsCallback(audio_output_t *p_aout, AudioDeviceID i_dev_id, bool b_register);
151 static int AudioDeviceHasOutput (AudioDeviceID);
152 static int AudioDeviceSupportsDigital(audio_output_t *, AudioDeviceID);
153 static int AudioStreamSupportsDigital(audio_output_t *, AudioStreamID);
154 static int AudioStreamChangeFormat (audio_output_t *, AudioStreamID, AudioStreamBasicDescription);
158 set_shortname("auhal")
159 set_description(N_("HAL AudioUnit output"))
160 set_capability("audio output", 101)
161 set_category(CAT_AUDIO)
162 set_subcategory(SUBCAT_AUDIO_AOUT)
163 set_callbacks(Open, Close)
164 add_integer("auhal-volume", AOUT_VOLUME_DEFAULT,
165 VOLUME_TEXT, VOLUME_LONGTEXT, true)
166 change_integer_range(0, AOUT_VOLUME_MAX)
167 add_string("auhal-audio-device", "", DEVICE_TEXT, DEVICE_LONGTEXT, true)
168 add_obsolete_integer("macosx-audio-device") /* since 2.1.0 */
172 #pragma mark initialization
174 static int Open(vlc_object_t *obj)
176 audio_output_t *p_aout = (audio_output_t *)obj;
177 aout_sys_t *p_sys = malloc(sizeof (*p_sys));
178 if (unlikely(p_sys == NULL))
181 OSStatus err = noErr;
183 vlc_mutex_init(&p_sys->lock);
184 vlc_cond_init(&p_sys->cond);
185 p_sys->b_digital = false;
188 p_aout->start = Start;
190 p_aout->volume_set = VolumeSet;
191 p_aout->mute_set = MuteSet;
192 p_aout->device_select = SwitchAudioDevice;
193 p_sys->device_list = CFArrayCreate(kCFAllocatorDefault, NULL, 0, NULL);
195 /* Attach a Listener so that we are notified of a change in the Device setup */
196 AudioObjectPropertyAddress audioDevicesAddress = { kAudioHardwarePropertyDevices, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
197 err = AudioObjectAddPropertyListener(kAudioObjectSystemObject, &audioDevicesAddress, HardwareListener, (void *)p_aout);
199 msg_Warn(p_aout, "failed to add listener for audio device configuration [%4.4s]", (char *)&err);
201 RebuildDeviceList(p_aout);
203 /* remember the volume */
204 p_sys->f_volume = var_InheritInteger(p_aout, "auhal-volume") / (float)AOUT_VOLUME_DEFAULT;
205 aout_VolumeReport(p_aout, p_sys->f_volume);
206 p_sys->b_mute = var_InheritBool(p_aout, "mute");
207 aout_MuteReport(p_aout, p_sys->b_mute);
209 char *psz_audio_device = config_GetPsz(p_aout, "auhal-audio-device");
210 SwitchAudioDevice(p_aout, psz_audio_device);
211 free(psz_audio_device);
216 static void Close(vlc_object_t *obj)
218 audio_output_t *p_aout = (audio_output_t *)obj;
219 aout_sys_t *p_sys = p_aout->sys;
221 OSStatus err = noErr;
223 /* remove audio devices callback */
224 AudioObjectPropertyAddress audioDevicesAddress = { kAudioHardwarePropertyDevices, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
225 err = AudioObjectRemovePropertyListener(kAudioObjectSystemObject, &audioDevicesAddress, HardwareListener, (void *)p_aout);
227 msg_Err(p_aout, "AudioHardwareRemovePropertyListener failed [%4.4s]", (char *)&err);
229 /* remove streams callbacks */
230 CFIndex count = CFArrayGetCount(p_sys->device_list);
232 for (CFIndex x = 0; x < count; x++) {
233 AudioDeviceID deviceId = 0;
234 CFNumberRef cfn_device_id = CFArrayGetValueAtIndex(p_sys->device_list, x);
238 CFNumberGetValue(cfn_device_id, kCFNumberSInt32Type, &deviceId);
239 if (!(deviceId & AOUT_VAR_SPDIF_FLAG)) {
240 ManageAudioStreamsCallback(p_aout, deviceId, false);
245 config_PutPsz(p_aout, "auhal-audio-device", aout_DeviceGet(p_aout));
247 CFRelease(p_sys->device_list);
249 vlc_mutex_destroy(&p_sys->lock);
250 vlc_cond_destroy(&p_sys->cond);
255 static int Start(audio_output_t *p_aout, audio_sample_format_t *restrict fmt)
257 OSStatus err = noErr;
258 UInt32 i_param_size = 0;
259 struct aout_sys_t *p_sys = NULL;
261 /* Use int here, to match kAudioDevicePropertyDeviceIsAlive
265 bool b_start_digital = false;
268 p_sys->b_digital = false;
269 p_sys->au_component = NULL;
270 p_sys->au_unit = NULL;
271 p_sys->clock_diff = (mtime_t) 0;
272 p_sys->i_hog_pid = -1;
273 p_sys->i_stream_id = 0;
274 p_sys->i_stream_index = -1;
275 p_sys->b_revert = false;
276 p_sys->b_changed_mixing = false;
277 p_sys->i_bytes_per_sample = 0;
279 p_sys->i_selected_dev = p_sys->i_new_selected_dev;
281 aout_FormatPrint(p_aout, "VLC is looking for:", fmt);
283 msg_Dbg(p_aout, "attempting to use device %i", p_sys->i_selected_dev);
285 AudioObjectPropertyAddress audioDeviceAliveAddress = { kAudioDevicePropertyDeviceIsAlive, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
286 if (p_sys->i_selected_dev > 0) {
287 /* Check if the desired device is alive and usable */
288 i_param_size = sizeof(b_alive);
289 err = AudioObjectGetPropertyData(p_sys->i_selected_dev, &audioDeviceAliveAddress, 0, NULL, &i_param_size, &b_alive);
291 /* Be tolerant, only give a warning here */
292 msg_Warn(p_aout, "could not check whether device [0x%x] is alive [%4.4s]",
293 (unsigned int)p_sys->i_selected_dev, (char *)&err);
298 msg_Warn(p_aout, "selected audio device is not alive, switching to default device");
301 if (!b_alive || p_sys->i_selected_dev == 0) {
302 AudioObjectID defaultDeviceID = 0;
303 UInt32 propertySize = 0;
304 AudioObjectPropertyAddress defaultDeviceAddress = { kAudioHardwarePropertyDefaultOutputDevice, kAudioDevicePropertyScopeOutput, kAudioObjectPropertyElementMaster };
305 propertySize = sizeof(AudioObjectID);
306 err = AudioObjectGetPropertyData(kAudioObjectSystemObject, &defaultDeviceAddress, 0, NULL, &propertySize, &defaultDeviceID);
308 msg_Err(p_aout, "could not get default audio device [%4.4s]", (char *)&err);
312 msg_Dbg(p_aout, "using default audio device %i", defaultDeviceID);
314 p_sys->i_selected_dev = defaultDeviceID;
315 p_sys->b_selected_dev_is_digital = var_InheritBool(p_aout, "spdif");
318 // recheck if device still supports digital
319 b_start_digital = p_sys->b_selected_dev_is_digital;
320 if(!AudioDeviceSupportsDigital(p_aout, p_sys->i_selected_dev))
321 b_start_digital = false;
324 msg_Dbg(p_aout, "Using audio device for digital output");
326 msg_Dbg(p_aout, "Audio device supports PCM mode only");
328 /* add a callback to see if the device dies later on */
329 err = AudioObjectAddPropertyListener(p_sys->i_selected_dev, &audioDeviceAliveAddress, HardwareListener, (void *)p_aout);
331 /* Be tolerant, only give a warning here */
332 msg_Warn(p_aout, "could not set alive check callback on device [0x%x] [%4.4s]",
333 (unsigned int)p_sys->i_selected_dev, (char *)&err);
336 AudioObjectPropertyAddress audioDeviceHogModeAddress = { kAudioDevicePropertyHogMode,
337 kAudioDevicePropertyScopeOutput,
338 kAudioObjectPropertyElementMaster };
339 i_param_size = sizeof(p_sys->i_hog_pid);
340 err = AudioObjectGetPropertyData(p_sys->i_selected_dev, &audioDeviceHogModeAddress, 0, NULL, &i_param_size, &p_sys->i_hog_pid);
342 /* This is not a fatal error. Some drivers simply don't support this property */
343 msg_Warn(p_aout, "could not check whether device is hogged [%4.4s]",
345 p_sys->i_hog_pid = -1;
348 if (p_sys->i_hog_pid != -1 && p_sys->i_hog_pid != getpid()) {
349 msg_Err(p_aout, "Selected audio device is exclusively in use by another program.");
350 dialog_Fatal(p_aout, _("Audio output failed"), "%s",
351 _("The selected audio output device is exclusively in "
352 "use by another program."));
356 bool b_success = false;
358 /* Check for Digital mode or Analog output mode */
359 if (AOUT_FMT_SPDIF (fmt) && b_start_digital) {
360 if (StartSPDIF (p_aout, fmt)) {
361 msg_Dbg(p_aout, "digital output successfully opened");
365 if (StartAnalog(p_aout, fmt)) {
366 msg_Dbg(p_aout, "analog output successfully opened");
373 p_aout->flush = Flush;
374 p_aout->time_get = TimeGet;
375 p_aout->pause = Pause;
380 /* If we reach this, this aout has failed */
381 msg_Err(p_aout, "opening auhal output failed");
386 * StartAnalog: open and setup a HAL AudioUnit to do PCM audio output
388 static int StartAnalog(audio_output_t *p_aout, audio_sample_format_t *fmt)
390 struct aout_sys_t *p_sys = p_aout->sys;
391 OSStatus err = noErr;
392 UInt32 i_param_size = 0;
394 AudioComponentDescription desc;
395 AudioStreamBasicDescription DeviceFormat;
396 AudioChannelLayout *layout;
397 AudioChannelLayout new_layout;
398 AURenderCallbackStruct input;
399 p_aout->sys->chans_to_reorder = 0;
401 SInt32 currentMinorSystemVersion;
402 if(Gestalt(gestaltSystemVersionMinor, ¤tMinorSystemVersion) != noErr)
403 msg_Err(p_aout, "failed to check OSX version");
405 /* Lets go find our Component */
406 desc.componentType = kAudioUnitType_Output;
407 desc.componentSubType = kAudioUnitSubType_HALOutput;
408 desc.componentManufacturer = kAudioUnitManufacturer_Apple;
409 desc.componentFlags = 0;
410 desc.componentFlagsMask = 0;
412 p_sys->au_component = AudioComponentFindNext(NULL, &desc);
413 if (p_sys->au_component == NULL) {
414 msg_Err(p_aout, "cannot find any HAL component, PCM output failed");
418 err = AudioComponentInstanceNew(p_sys->au_component, &p_sys->au_unit);
420 msg_Err(p_aout, "cannot open HAL component, PCM output failed [%4.4s]", (char *)&err);
424 /* Set the device we will use for this output unit */
425 err = AudioUnitSetProperty(p_sys->au_unit,
426 kAudioOutputUnitProperty_CurrentDevice,
427 kAudioUnitScope_Global,
429 &p_sys->i_selected_dev,
430 sizeof(AudioObjectID));
433 msg_Err(p_aout, "cannot select audio output device, PCM output failed [%4.4s]", (char *)&err);
437 /* Get the current format */
438 i_param_size = sizeof(AudioStreamBasicDescription);
440 err = AudioUnitGetProperty(p_sys->au_unit,
441 kAudioUnitProperty_StreamFormat,
442 kAudioUnitScope_Output,
448 msg_Err(p_aout, "failed to detect supported stream formats [%4.4s]", (char *)&err);
451 msg_Dbg(p_aout, STREAM_FORMAT_MSG("current format is: ", DeviceFormat));
453 /* Get the channel layout of the device side of the unit (vlc -> unit -> device) */
454 err = AudioUnitGetPropertyInfo(p_sys->au_unit,
455 kAudioDevicePropertyPreferredChannelLayout,
456 kAudioUnitScope_Output,
462 layout = (AudioChannelLayout *)malloc(i_param_size);
464 verify_noerr(AudioUnitGetProperty(p_sys->au_unit,
465 kAudioDevicePropertyPreferredChannelLayout,
466 kAudioUnitScope_Output,
471 /* We need to "fill out" the ChannelLayout, because there are multiple ways that it can be set */
472 if (layout->mChannelLayoutTag == kAudioChannelLayoutTag_UseChannelBitmap) {
473 /* bitmap defined channellayout */
474 verify_noerr(AudioFormatGetProperty(kAudioFormatProperty_ChannelLayoutForBitmap,
475 sizeof(UInt32), &layout->mChannelBitmap,
478 } else if (layout->mChannelLayoutTag != kAudioChannelLayoutTag_UseChannelDescriptions)
480 /* layouttags defined channellayout */
481 verify_noerr(AudioFormatGetProperty(kAudioFormatProperty_ChannelLayoutForTag,
482 sizeof(AudioChannelLayoutTag), &layout->mChannelLayoutTag,
487 msg_Dbg(p_aout, "layout of AUHAL has %i channels" , layout->mNumberChannelDescriptions);
489 if (layout->mNumberChannelDescriptions == 0) {
490 msg_Err(p_aout, "insufficient number of output channels");
494 /* Initialize the VLC core channel count */
495 fmt->i_physical_channels = 0;
496 i_original = fmt->i_original_channels & AOUT_CHAN_PHYSMASK;
498 if (i_original == AOUT_CHAN_CENTER || layout->mNumberChannelDescriptions < 2) {
499 /* We only need Mono or cannot output more than 1 channel */
500 fmt->i_physical_channels = AOUT_CHAN_CENTER;
501 } else if (i_original == (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT) || layout->mNumberChannelDescriptions < 3) {
502 /* We only need Stereo or cannot output more than 2 channels */
503 fmt->i_physical_channels = AOUT_CHANS_STEREO;
505 /* We want more than stereo and we can do that */
506 for (unsigned int i = 0; i < layout->mNumberChannelDescriptions; i++) {
508 msg_Dbg(p_aout, "this is channel: %d", (int)layout->mChannelDescriptions[i].mChannelLabel);
511 switch(layout->mChannelDescriptions[i].mChannelLabel) {
512 case kAudioChannelLabel_Left:
513 fmt->i_physical_channels |= AOUT_CHAN_LEFT;
515 case kAudioChannelLabel_Right:
516 fmt->i_physical_channels |= AOUT_CHAN_RIGHT;
518 case kAudioChannelLabel_Center:
519 fmt->i_physical_channels |= AOUT_CHAN_CENTER;
521 case kAudioChannelLabel_LFEScreen:
522 fmt->i_physical_channels |= AOUT_CHAN_LFE;
524 case kAudioChannelLabel_LeftSurround:
525 fmt->i_physical_channels |= AOUT_CHAN_REARLEFT;
527 case kAudioChannelLabel_RightSurround:
528 fmt->i_physical_channels |= AOUT_CHAN_REARRIGHT;
530 case kAudioChannelLabel_RearSurroundLeft:
531 fmt->i_physical_channels |= AOUT_CHAN_MIDDLELEFT;
533 case kAudioChannelLabel_RearSurroundRight:
534 fmt->i_physical_channels |= AOUT_CHAN_MIDDLERIGHT;
536 case kAudioChannelLabel_CenterSurround:
537 fmt->i_physical_channels |= AOUT_CHAN_REARCENTER;
540 msg_Warn(p_aout, "unrecognized channel form provided by driver: %d", (int)layout->mChannelDescriptions[i].mChannelLabel);
543 if (fmt->i_physical_channels == 0) {
544 fmt->i_physical_channels = AOUT_CHANS_STEREO;
545 msg_Err(p_aout, "You should configure your speaker layout with Audio Midi Setup in /Applications/Utilities. VLC will output Stereo only.");
546 dialog_Fatal(p_aout, _("Audio device is not configured"), "%s",
547 _("You should configure your speaker layout with "
548 "\"Audio Midi Setup\" in /Applications/"
549 "Utilities. VLC will output Stereo only."));
554 msg_Warn(p_aout, "device driver does not support kAudioDevicePropertyPreferredChannelLayout - using stereo fallback [%4.4s]", (char *)&err);
555 fmt->i_physical_channels = AOUT_CHANS_STEREO;
558 msg_Dbg(p_aout, "selected %d physical channels for device output", aout_FormatNbChannels(fmt));
559 msg_Dbg(p_aout, "VLC will output: %s", aout_FormatPrintChannels(fmt));
560 p_sys->i_numberOfChannels = aout_FormatNbChannels(fmt);
562 memset (&new_layout, 0, sizeof(new_layout));
563 uint32_t chans_out[AOUT_CHAN_MAX];
565 /* Some channel abbreviations used below:
570 * Rs - right surround
571 * Cs - center surround
572 * Rls - rear left surround
573 * Rrs - rear right surround
576 * Lsd - left surround direct
577 * Rsd - right surround direct
581 * Vhl - vertical height left
582 * Vhc - vertical height center
583 * Vhr - vertical height right
584 * Lt - left matrix total. for matrix encoded stereo.
585 * Rt - right matrix total. for matrix encoded stereo. */
587 switch(aout_FormatNbChannels(fmt)) {
589 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_Mono;
592 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_Stereo;
595 if (fmt->i_physical_channels & AOUT_CHAN_CENTER)
596 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_7; // L R C
597 else if (fmt->i_physical_channels & AOUT_CHAN_LFE)
598 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_4; // L R LFE
601 if (fmt->i_physical_channels & (AOUT_CHAN_CENTER | AOUT_CHAN_LFE))
602 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_10; // L R C LFE
603 else if (fmt->i_physical_channels & (AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT))
604 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_3; // L R Ls Rs
605 else if (fmt->i_physical_channels & (AOUT_CHAN_CENTER | AOUT_CHAN_REARCENTER))
606 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_3; // L R C Cs
609 if (fmt->i_physical_channels & (AOUT_CHAN_CENTER))
610 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_19; // L R Ls Rs C
611 else if (fmt->i_physical_channels & (AOUT_CHAN_LFE))
612 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_18; // L R Ls Rs LFE
615 if (fmt->i_physical_channels & (AOUT_CHAN_LFE)) {
616 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_20; // L R Ls Rs C LFE
618 chans_out[0] = AOUT_CHAN_LEFT;
619 chans_out[1] = AOUT_CHAN_RIGHT;
620 chans_out[2] = AOUT_CHAN_REARLEFT;
621 chans_out[3] = AOUT_CHAN_REARRIGHT;
622 chans_out[4] = AOUT_CHAN_CENTER;
623 chans_out[5] = AOUT_CHAN_LFE;
625 p_aout->sys->chans_to_reorder = aout_CheckChannelReorder(NULL, chans_out, fmt->i_physical_channels, p_aout->sys->chan_table);
626 if (p_aout->sys->chans_to_reorder)
627 msg_Dbg(p_aout, "channel reordering needed for 5.1 output");
629 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_AudioUnit_6_0; // L R Ls Rs C Cs
631 chans_out[0] = AOUT_CHAN_LEFT;
632 chans_out[1] = AOUT_CHAN_RIGHT;
633 chans_out[2] = AOUT_CHAN_REARLEFT;
634 chans_out[3] = AOUT_CHAN_REARRIGHT;
635 chans_out[4] = AOUT_CHAN_CENTER;
636 chans_out[5] = AOUT_CHAN_REARCENTER;
638 p_aout->sys->chans_to_reorder = aout_CheckChannelReorder(NULL, chans_out, fmt->i_physical_channels, p_aout->sys->chan_table);
639 if (p_aout->sys->chans_to_reorder)
640 msg_Dbg(p_aout, "channel reordering needed for 6.0 output");
644 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_MPEG_6_1_A; // L R C LFE Ls Rs Cs
646 chans_out[0] = AOUT_CHAN_LEFT;
647 chans_out[1] = AOUT_CHAN_RIGHT;
648 chans_out[2] = AOUT_CHAN_CENTER;
649 chans_out[3] = AOUT_CHAN_LFE;
650 chans_out[4] = AOUT_CHAN_REARLEFT;
651 chans_out[5] = AOUT_CHAN_REARRIGHT;
652 chans_out[6] = AOUT_CHAN_REARCENTER;
654 p_aout->sys->chans_to_reorder = aout_CheckChannelReorder(NULL, chans_out, fmt->i_physical_channels, p_aout->sys->chan_table);
655 if (p_aout->sys->chans_to_reorder)
656 msg_Dbg(p_aout, "channel reordering needed for 6.1 output");
660 if (fmt->i_physical_channels & (AOUT_CHAN_LFE) || currentMinorSystemVersion < 7) {
661 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_MPEG_7_1_A; // L R C LFE Ls Rs Lc Rc
663 chans_out[0] = AOUT_CHAN_LEFT;
664 chans_out[1] = AOUT_CHAN_RIGHT;
665 chans_out[2] = AOUT_CHAN_CENTER;
666 chans_out[3] = AOUT_CHAN_LFE;
667 chans_out[4] = AOUT_CHAN_MIDDLELEFT;
668 chans_out[5] = AOUT_CHAN_MIDDLERIGHT;
669 chans_out[6] = AOUT_CHAN_REARLEFT;
670 chans_out[7] = AOUT_CHAN_REARRIGHT;
672 if (!(fmt->i_physical_channels & (AOUT_CHAN_LFE)))
673 msg_Warn(p_aout, "8.0 audio output not supported on OS X 10.%i, layout will be incorrect", currentMinorSystemVersion);
675 #ifdef MAC_OS_X_VERSION_10_7
677 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DTS_8_0_B; // Lc C Rc L R Ls Cs Rs
679 chans_out[0] = AOUT_CHAN_MIDDLELEFT;
680 chans_out[1] = AOUT_CHAN_CENTER;
681 chans_out[2] = AOUT_CHAN_MIDDLERIGHT;
682 chans_out[3] = AOUT_CHAN_LEFT;
683 chans_out[4] = AOUT_CHAN_RIGHT;
684 chans_out[5] = AOUT_CHAN_REARLEFT;
685 chans_out[6] = AOUT_CHAN_REARCENTER;
686 chans_out[7] = AOUT_CHAN_REARRIGHT;
689 p_aout->sys->chans_to_reorder = aout_CheckChannelReorder(NULL, chans_out, fmt->i_physical_channels, p_aout->sys->chan_table);
690 if (p_aout->sys->chans_to_reorder)
691 msg_Dbg(p_aout, "channel reordering needed for 7.1 / 8.0 output");
695 if (currentMinorSystemVersion < 7) {
696 msg_Warn(p_aout, "8.1 audio output not supported on OS X 10.%i", currentMinorSystemVersion);
700 #ifdef MAC_OS_X_VERSION_10_7
701 new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DTS_8_1_B; // Lc C Rc L R Ls Cs Rs LFE
702 chans_out[0] = AOUT_CHAN_MIDDLELEFT;
703 chans_out[1] = AOUT_CHAN_CENTER;
704 chans_out[2] = AOUT_CHAN_MIDDLERIGHT;
705 chans_out[3] = AOUT_CHAN_LEFT;
706 chans_out[4] = AOUT_CHAN_RIGHT;
707 chans_out[5] = AOUT_CHAN_REARLEFT;
708 chans_out[6] = AOUT_CHAN_REARCENTER;
709 chans_out[7] = AOUT_CHAN_REARRIGHT;
710 chans_out[8] = AOUT_CHAN_LFE;
712 p_aout->sys->chans_to_reorder = aout_CheckChannelReorder(NULL, chans_out, fmt->i_physical_channels, p_aout->sys->chan_table);
713 if (p_aout->sys->chans_to_reorder)
714 msg_Dbg(p_aout, "channel reordering needed for 8.1 output");
719 /* Set up the format to be used */
720 DeviceFormat.mSampleRate = fmt->i_rate;
721 DeviceFormat.mFormatID = kAudioFormatLinearPCM;
722 p_sys->i_rate = fmt->i_rate;
724 /* We use float 32 since this is VLC's endorsed format */
725 fmt->i_format = VLC_CODEC_FL32;
726 DeviceFormat.mFormatFlags = kAudioFormatFlagsNativeFloatPacked;
727 DeviceFormat.mBitsPerChannel = 32;
728 DeviceFormat.mChannelsPerFrame = aout_FormatNbChannels(fmt);
730 /* Calculate framesizes and stuff */
731 DeviceFormat.mFramesPerPacket = 1;
732 DeviceFormat.mBytesPerFrame = DeviceFormat.mBitsPerChannel * DeviceFormat.mChannelsPerFrame / 8;
733 DeviceFormat.mBytesPerPacket = DeviceFormat.mBytesPerFrame * DeviceFormat.mFramesPerPacket;
735 /* Set the desired format */
736 i_param_size = sizeof(AudioStreamBasicDescription);
737 verify_noerr(AudioUnitSetProperty(p_sys->au_unit,
738 kAudioUnitProperty_StreamFormat,
739 kAudioUnitScope_Input,
744 msg_Dbg(p_aout, STREAM_FORMAT_MSG("we set the AU format: " , DeviceFormat));
746 /* Retrieve actual format */
747 verify_noerr(AudioUnitGetProperty(p_sys->au_unit,
748 kAudioUnitProperty_StreamFormat,
749 kAudioUnitScope_Input,
754 msg_Dbg(p_aout, STREAM_FORMAT_MSG("the actual set AU format is " , DeviceFormat));
756 /* Do the last VLC aout setups */
757 aout_FormatPrepare(fmt);
759 /* set the IOproc callback */
760 input.inputProc = (AURenderCallback) RenderCallbackAnalog;
761 input.inputProcRefCon = p_aout;
763 verify_noerr(AudioUnitSetProperty(p_sys->au_unit,
764 kAudioUnitProperty_SetRenderCallback,
765 kAudioUnitScope_Input,
766 0, &input, sizeof(input)));
768 /* Set the new_layout as the layout VLC will use to feed the AU unit */
769 verify_noerr(AudioUnitSetProperty(p_sys->au_unit,
770 kAudioUnitProperty_AudioChannelLayout,
771 kAudioUnitScope_Output,
772 0, &new_layout, sizeof(new_layout)));
774 if (new_layout.mNumberChannelDescriptions > 0)
775 free(new_layout.mChannelDescriptions);
778 verify_noerr(AudioUnitInitialize(p_sys->au_unit));
780 /* Find the difference between device clock and mdate clock */
781 p_sys->clock_diff = - (mtime_t)
782 AudioConvertHostTimeToNanos(AudioGetCurrentHostTime()) / 1000;
783 p_sys->clock_diff += mdate();
785 /* setup circular buffer */
786 TPCircularBufferInit(&p_sys->circular_buffer, AUDIO_BUFFER_SIZE_IN_SECONDS *
787 fmt->i_rate * fmt->i_bytes_per_frame);
789 p_sys->b_got_first_sample = false;
791 /* Set volume for output unit */
792 VolumeSet(p_aout, p_sys->f_volume);
793 MuteSet(p_aout, p_sys->b_mute);
799 * StartSPDIF: Setup an encoded digital stream (SPDIF) output
801 static int StartSPDIF(audio_output_t * p_aout, audio_sample_format_t *fmt)
803 struct aout_sys_t *p_sys = p_aout->sys;
804 OSStatus err = noErr;
805 UInt32 i_param_size = 0, b_mix = 0;
806 Boolean b_writeable = false;
807 AudioStreamID *p_streams = NULL;
808 unsigned i_streams = 0;
810 /* Start doing the SPDIF setup proces */
811 p_sys->b_digital = true;
814 AudioObjectPropertyAddress audioDeviceHogModeAddress = { kAudioDevicePropertyHogMode, kAudioDevicePropertyScopeOutput, kAudioObjectPropertyElementMaster };
815 i_param_size = sizeof(p_sys->i_hog_pid);
816 p_sys->i_hog_pid = getpid() ;
818 err = AudioObjectSetPropertyData(p_sys->i_selected_dev, &audioDeviceHogModeAddress, 0, NULL, i_param_size, &p_sys->i_hog_pid);
821 msg_Err(p_aout, "failed to set hogmode [%4.4s]", (char *)&err);
825 AudioObjectPropertyAddress audioDeviceSupportsMixingAddress = { kAudioDevicePropertySupportsMixing , kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
827 if (AudioObjectHasProperty(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress)) {
828 /* Set mixable to false if we are allowed to */
829 err = AudioObjectIsPropertySettable(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress, &b_writeable);
830 err = AudioObjectGetPropertyDataSize(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress, 0, NULL, &i_param_size);
831 err = AudioObjectGetPropertyData(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress, 0, NULL, &i_param_size, &b_mix);
833 if (err == noErr && b_writeable) {
835 err = AudioObjectSetPropertyData(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress, 0, NULL, i_param_size, &b_mix);
836 p_sys->b_changed_mixing = true;
840 msg_Err(p_aout, "failed to set mixmode [%4.4s]", (char *)&err);
845 /* Get a list of all the streams on this device */
846 AudioObjectPropertyAddress streamsAddress = { kAudioDevicePropertyStreams, kAudioDevicePropertyScopeOutput, kAudioObjectPropertyElementMaster };
847 err = AudioObjectGetPropertyDataSize(p_sys->i_selected_dev, &streamsAddress, 0, NULL, &i_param_size);
849 msg_Err(p_aout, "could not get size of stream description packet [%4.4s]", (char *)&err);
853 i_streams = i_param_size / sizeof(AudioStreamID);
854 p_streams = (AudioStreamID *)malloc(i_param_size);
855 if (p_streams == NULL)
858 err = AudioObjectGetPropertyData(p_sys->i_selected_dev, &streamsAddress, 0, NULL, &i_param_size, p_streams);
861 msg_Err(p_aout, "could not fetch stream descriptions [%4.4s]", (char *)&err);
866 AudioObjectPropertyAddress physicalFormatsAddress = { kAudioStreamPropertyAvailablePhysicalFormats, kAudioObjectPropertyScopeGlobal, 0 };
867 for (unsigned i = 0; i < i_streams && p_sys->i_stream_index < 0 ; i++) {
868 /* Find a stream with a cac3 stream */
869 AudioStreamRangedDescription *p_format_list = NULL;
871 bool b_digital = false;
873 /* Retrieve all the stream formats supported by each output stream */
874 err = AudioObjectGetPropertyDataSize(p_streams[i], &physicalFormatsAddress, 0, NULL, &i_param_size);
876 msg_Err(p_aout, "could not get number of streamformats: [%4.4s] (%i)", (char *)&err, (int32_t)err);
880 i_formats = i_param_size / sizeof(AudioStreamRangedDescription);
881 p_format_list = (AudioStreamRangedDescription *)malloc(i_param_size);
882 if (p_format_list == NULL)
885 err = AudioObjectGetPropertyData(p_streams[i], &physicalFormatsAddress, 0, NULL, &i_param_size, p_format_list);
887 msg_Err(p_aout, "could not get the list of streamformats: [%4.4s]", (char *)&err);
892 /* Check if one of the supported formats is a digital format */
893 for (int j = 0; j < i_formats; j++) {
894 if (p_format_list[j].mFormat.mFormatID == 'IAC3' ||
895 p_format_list[j].mFormat.mFormatID == 'iac3' ||
896 p_format_list[j].mFormat.mFormatID == kAudioFormat60958AC3 ||
897 p_format_list[j].mFormat.mFormatID == kAudioFormatAC3) {
904 /* if this stream supports a digital (cac3) format, then go set it. */
905 int i_requested_rate_format = -1;
906 int i_current_rate_format = -1;
907 int i_backup_rate_format = -1;
909 p_sys->i_stream_id = p_streams[i];
910 p_sys->i_stream_index = i;
912 if (!p_sys->b_revert) {
913 AudioObjectPropertyAddress currentPhysicalFormatAddress = { kAudioStreamPropertyPhysicalFormat, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
914 /* Retrieve the original format of this stream first if not done so already */
915 i_param_size = sizeof(p_sys->sfmt_revert);
916 err = AudioObjectGetPropertyData(p_sys->i_stream_id, ¤tPhysicalFormatAddress, 0, NULL, &i_param_size, &p_sys->sfmt_revert);
918 msg_Err(p_aout, "could not retrieve the original streamformat [%4.4s]", (char *)&err);
921 p_sys->b_revert = true;
924 for (int j = 0; j < i_formats; j++) {
925 if (p_format_list[j].mFormat.mFormatID == 'IAC3' ||
926 p_format_list[j].mFormat.mFormatID == 'iac3' ||
927 p_format_list[j].mFormat.mFormatID == kAudioFormat60958AC3 ||
928 p_format_list[j].mFormat.mFormatID == kAudioFormatAC3) {
929 if (p_format_list[j].mFormat.mSampleRate == fmt->i_rate) {
930 i_requested_rate_format = j;
932 } else if (p_format_list[j].mFormat.mSampleRate == p_sys->sfmt_revert.mSampleRate)
933 i_current_rate_format = j;
935 if (i_backup_rate_format < 0 || p_format_list[j].mFormat.mSampleRate > p_format_list[i_backup_rate_format].mFormat.mSampleRate)
936 i_backup_rate_format = j;
942 if (i_requested_rate_format >= 0) /* We prefer to output at the samplerate of the original audio */
943 p_sys->stream_format = p_format_list[i_requested_rate_format].mFormat;
944 else if (i_current_rate_format >= 0) /* If not possible, we will try to use the current samplerate of the device */
945 p_sys->stream_format = p_format_list[i_current_rate_format].mFormat;
947 p_sys->stream_format = p_format_list[i_backup_rate_format].mFormat; /* And if we have to, any digital format will be just fine (highest rate possible) */
953 msg_Dbg(p_aout, STREAM_FORMAT_MSG("original stream format: ", p_sys->sfmt_revert));
955 if (!AudioStreamChangeFormat(p_aout, p_sys->i_stream_id, p_sys->stream_format)) {
956 msg_Err(p_aout, "failed to change stream format for SPDIF output");
960 /* Set the format flags */
961 if (p_sys->stream_format.mFormatFlags & kAudioFormatFlagIsBigEndian)
962 fmt->i_format = VLC_CODEC_SPDIFB;
964 fmt->i_format = VLC_CODEC_SPDIFL;
965 fmt->i_bytes_per_frame = AOUT_SPDIF_SIZE;
966 fmt->i_frame_length = A52_FRAME_NB;
967 fmt->i_rate = (unsigned int)p_sys->stream_format.mSampleRate;
968 p_sys->i_rate = fmt->i_rate;
969 aout_FormatPrepare(fmt);
971 /* Add IOProc callback */
972 err = AudioDeviceCreateIOProcID(p_sys->i_selected_dev,
973 (AudioDeviceIOProc)RenderCallbackSPDIF,
977 msg_Err(p_aout, "Failed to create Process ID [%4.4s]", (char *)&err);
981 /* Check for the difference between the Device clock and mdate */
982 p_sys->clock_diff = - (mtime_t)
983 AudioConvertHostTimeToNanos(AudioGetCurrentHostTime()) / 1000;
984 p_sys->clock_diff += mdate();
987 err = AudioDeviceStart(p_sys->i_selected_dev, p_sys->i_procID);
989 msg_Err(p_aout, "Failed to start audio device [%4.4s]", (char *)&err);
991 err = AudioDeviceDestroyIOProcID(p_sys->i_selected_dev, p_sys->i_procID);
993 msg_Err(p_aout, "Failed to destroy process ID [%4.4s]", (char *)&err);
998 /* setup circular buffer */
999 TPCircularBufferInit(&p_sys->circular_buffer, 200 * AOUT_SPDIF_SIZE);
1004 static void Stop(audio_output_t *p_aout)
1006 struct aout_sys_t *p_sys = p_aout->sys;
1007 OSStatus err = noErr;
1008 UInt32 i_param_size = 0;
1010 if (p_sys->au_unit) {
1011 verify_noerr(AudioOutputUnitStop(p_sys->au_unit));
1012 verify_noerr(AudioUnitUninitialize(p_sys->au_unit));
1013 verify_noerr(AudioComponentInstanceDispose(p_sys->au_unit));
1016 if (p_sys->b_digital) {
1018 err = AudioDeviceStop(p_sys->i_selected_dev,
1021 msg_Err(p_aout, "Failed to stop audio device [%4.4s]", (char *)&err);
1023 /* Remove IOProc callback */
1024 err = AudioDeviceDestroyIOProcID(p_sys->i_selected_dev,
1027 msg_Err(p_aout, "Failed to destroy Process ID [%4.4s]", (char *)&err);
1029 if (p_sys->b_revert)
1030 AudioStreamChangeFormat(p_aout, p_sys->i_stream_id, p_sys->sfmt_revert);
1032 if (p_sys->b_changed_mixing && p_sys->sfmt_revert.mFormatID != kAudioFormat60958AC3) {
1034 Boolean b_writeable = false;
1035 /* Revert mixable to true if we are allowed to */
1036 AudioObjectPropertyAddress audioDeviceSupportsMixingAddress = { kAudioDevicePropertySupportsMixing , kAudioDevicePropertyScopeOutput, kAudioObjectPropertyElementMaster };
1037 err = AudioObjectIsPropertySettable(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress, &b_writeable);
1038 err = AudioObjectGetPropertyData(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress, 0, NULL, &i_param_size, &b_mix);
1040 if (err == noErr && b_writeable) {
1041 msg_Dbg(p_aout, "mixable is: %d", b_mix);
1043 err = AudioObjectSetPropertyData(p_sys->i_selected_dev, &audioDeviceSupportsMixingAddress, 0, NULL, i_param_size, &b_mix);
1047 msg_Err(p_aout, "failed to re-set mixmode [%4.4s]", (char *)&err);
1051 if (p_sys->i_hog_pid == getpid()) {
1052 p_sys->i_hog_pid = -1;
1053 i_param_size = sizeof(p_sys->i_hog_pid);
1054 AudioObjectPropertyAddress audioDeviceHogModeAddress = { kAudioDevicePropertyHogMode,
1055 kAudioDevicePropertyScopeOutput,
1056 kAudioObjectPropertyElementMaster };
1057 err = AudioObjectSetPropertyData(p_sys->i_selected_dev, &audioDeviceHogModeAddress, 0, NULL, i_param_size, &p_sys->i_hog_pid);
1059 msg_Err(p_aout, "Failed to release hogmode [%4.4s]", (char *)&err);
1062 /* remove audio device alive callback */
1063 AudioObjectPropertyAddress deviceAliveAddress = { kAudioDevicePropertyDeviceIsAlive, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
1064 err = AudioObjectRemovePropertyListener(p_sys->i_selected_dev, &deviceAliveAddress, HardwareListener, (void *)p_aout);
1066 /* Be tolerant, only give a warning here */
1067 msg_Warn(p_aout, "failed to remove audio device life checker [%4.4s]", (char *)&err);
1072 p_sys->i_bytes_per_sample = 0;
1073 p_sys->b_digital = false;
1075 /* clean-up circular buffer */
1076 TPCircularBufferCleanup(&p_sys->circular_buffer);
1080 #pragma mark core interaction
1082 static void ReportDevice(audio_output_t *p_aout, UInt32 i_id, char *name)
1085 sprintf(deviceid, "%i", i_id);
1087 aout_HotplugReport(p_aout, deviceid, name);
1090 static void RebuildDeviceList(audio_output_t * p_aout)
1092 OSStatus err = noErr;
1093 UInt32 propertySize = 0;
1094 AudioObjectID *deviceIDs;
1095 UInt32 numberOfDevices;
1096 CFMutableArrayRef currentListOfDevices;
1098 struct aout_sys_t *p_sys = p_aout->sys;
1100 ReportDevice(p_aout, 0, _("System Sound Output Device"));
1102 /* setup local array */
1103 currentListOfDevices = CFArrayCreateMutable(kCFAllocatorDefault, 0, NULL);
1105 /* Get number of devices */
1106 AudioObjectPropertyAddress audioDevicesAddress = { kAudioHardwarePropertyDevices, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
1107 err = AudioObjectGetPropertyDataSize(kAudioObjectSystemObject, &audioDevicesAddress, 0, NULL, &propertySize);
1109 msg_Err(p_aout, "Could not get number of devices: [%4.4s]", (char *)&err);
1113 numberOfDevices = propertySize / sizeof(AudioDeviceID);
1115 if (numberOfDevices < 1) {
1116 msg_Err(p_aout, "No audio output devices found.");
1119 msg_Dbg(p_aout, "found %i audio device(s)", numberOfDevices);
1121 /* Allocate DeviceID array */
1122 deviceIDs = (AudioDeviceID *)calloc(numberOfDevices, sizeof(AudioDeviceID));
1123 if (deviceIDs == NULL)
1126 /* Populate DeviceID array */
1127 err = AudioObjectGetPropertyData(kAudioObjectSystemObject, &audioDevicesAddress, 0, NULL, &propertySize, deviceIDs);
1129 msg_Err(p_aout, "could not get the device IDs [%4.4s]", (char *)&err);
1133 AudioObjectPropertyAddress deviceNameAddress = { kAudioObjectPropertyName, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
1135 for (unsigned int i = 0; i < numberOfDevices; i++) {
1136 CFStringRef device_name_ref;
1139 bool b_digital = false;
1140 UInt32 i_id = deviceIDs[i];
1142 /* Retrieve the length of the device name */
1143 err = AudioObjectGetPropertyDataSize(deviceIDs[i], &deviceNameAddress, 0, NULL, &propertySize);
1145 msg_Dbg(p_aout, "failed to get name size for device %i", deviceIDs[i]);
1149 /* Retrieve the name of the device */
1150 err = AudioObjectGetPropertyData(deviceIDs[i], &deviceNameAddress, 0, NULL, &propertySize, &device_name_ref);
1152 msg_Dbg(p_aout, "failed to get name for device %i", deviceIDs[i]);
1155 length = CFStringGetLength(device_name_ref);
1157 psz_name = (char *)malloc(length);
1158 CFStringGetCString(device_name_ref, psz_name, length, kCFStringEncodingUTF8);
1160 msg_Dbg(p_aout, "DevID: %i DevName: %s", deviceIDs[i], psz_name);
1162 if (!AudioDeviceHasOutput(deviceIDs[i])) {
1163 msg_Dbg(p_aout, "this '%s' is INPUT only. skipping...", psz_name);
1168 ReportDevice(p_aout, i_id, psz_name);
1169 CFArrayAppendValue(currentListOfDevices, CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt32Type, &i_id));
1171 if (AudioDeviceSupportsDigital(p_aout, deviceIDs[i])) {
1173 msg_Dbg(p_aout, "'%s' supports digital output", psz_name);
1174 char *psz_encoded_name = nil;
1175 asprintf(&psz_encoded_name, _("%s (Encoded Output)"), psz_name);
1176 i_id = i_id | AOUT_VAR_SPDIF_FLAG;
1177 ReportDevice(p_aout, i_id, psz_encoded_name);
1178 CFArrayAppendValue(currentListOfDevices, CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt32Type, &i_id));
1179 free(psz_encoded_name);
1182 // TODO: only register once for each device
1183 ManageAudioStreamsCallback(p_aout, deviceIDs[i], true);
1185 CFRelease(device_name_ref);
1190 if (p_sys->device_list)
1191 count = CFArrayGetCount(p_sys->device_list);
1194 CFNumberRef cfn_device_id;
1195 int i_device_id = 0;
1196 for (CFIndex x = 0; x < count; x++) {
1197 if (!CFArrayContainsValue(currentListOfDevices, CFRangeMake(0, count), CFArrayGetValueAtIndex(p_sys->device_list, x))) {
1198 cfn_device_id = CFArrayGetValueAtIndex(p_sys->device_list, x);
1200 if (cfn_device_id) {
1201 CFNumberGetValue(cfn_device_id, kCFNumberSInt32Type, &i_device_id);
1202 ReportDevice(p_aout, i_device_id, NULL);
1207 CFRelease(p_sys->device_list);
1208 p_sys->device_list = CFArrayCreateCopy(kCFAllocatorDefault, currentListOfDevices);
1209 CFRelease(currentListOfDevices);
1211 if(!CFArrayContainsValue(p_sys->device_list, CFRangeMake(0, CFArrayGetCount(p_sys->device_list)),CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt32Type, &p_sys->i_selected_dev)))
1212 aout_RestartRequest(p_aout, AOUT_RESTART_OUTPUT);
1217 static int SwitchAudioDevice(audio_output_t *p_aout, const char *name)
1219 struct aout_sys_t *p_sys = p_aout->sys;
1222 p_sys->i_new_selected_dev = atoi(name);
1224 p_sys->i_new_selected_dev = 0;
1226 bool b_supports_digital = (p_sys->i_new_selected_dev & AOUT_VAR_SPDIF_FLAG);
1227 if (b_supports_digital)
1228 p_sys->b_selected_dev_is_digital = true;
1230 p_sys->b_selected_dev_is_digital = false;
1232 p_sys->i_new_selected_dev = p_sys->i_new_selected_dev & ~AOUT_VAR_SPDIF_FLAG;
1234 aout_DeviceReport(p_aout, name);
1235 aout_RestartRequest(p_aout, AOUT_RESTART_OUTPUT);
1240 static int VolumeSet(audio_output_t * p_aout, float volume)
1242 struct aout_sys_t *p_sys = p_aout->sys;
1245 if(p_sys->b_digital)
1246 return VLC_EGENERIC;
1248 p_sys->f_volume = volume;
1249 aout_VolumeReport(p_aout, volume);
1251 /* Set volume for output unit */
1252 ostatus = AudioUnitSetParameter(p_sys->au_unit,
1253 kHALOutputParam_Volume,
1254 kAudioUnitScope_Global,
1256 volume * volume * volume,
1259 if (var_InheritBool(p_aout, "volume-save"))
1260 config_PutInt(p_aout, "auhal-volume", lroundf(volume * AOUT_VOLUME_DEFAULT));
1265 static int MuteSet(audio_output_t * p_aout, bool mute)
1267 struct aout_sys_t *p_sys = p_aout->sys;
1270 if(p_sys->b_digital)
1271 return VLC_EGENERIC;
1273 p_sys->b_mute = mute;
1274 aout_MuteReport(p_aout, mute);
1278 volume = p_sys->f_volume;
1280 ostatus = AudioUnitSetParameter(p_sys->au_unit,
1281 kHALOutputParam_Volume,
1282 kAudioUnitScope_Global,
1284 volume * volume * volume,
1291 #pragma mark actual playback
1293 static void Play(audio_output_t * p_aout, block_t * p_block)
1295 struct aout_sys_t *p_sys = p_aout->sys;
1297 if (p_block->i_nb_samples > 0) {
1298 if (!p_sys->b_got_first_sample) {
1300 verify_noerr(AudioOutputUnitStart(p_sys->au_unit));
1301 p_sys->b_got_first_sample = true;
1304 /* Do the channel reordering */
1305 if (p_sys->chans_to_reorder && !p_sys->b_digital) {
1306 aout_ChannelReorder(p_block->p_buffer,
1308 p_sys->chans_to_reorder,
1313 /* move data to buffer */
1314 if (unlikely(!TPCircularBufferProduceBytes(&p_sys->circular_buffer, p_block->p_buffer, p_block->i_buffer)))
1315 msg_Warn(p_aout, "dropped buffer");
1317 if (!p_sys->i_bytes_per_sample)
1318 p_sys->i_bytes_per_sample = p_block->i_buffer / p_block->i_nb_samples;
1321 block_Release(p_block);
1324 static void Pause(audio_output_t *p_aout, bool pause, mtime_t date)
1326 struct aout_sys_t * p_sys = p_aout->sys;
1329 if (p_aout->sys->b_digital) {
1331 AudioDeviceStop(p_sys->i_selected_dev, p_sys->i_procID);
1333 AudioDeviceStart(p_sys->i_selected_dev, p_sys->i_procID);
1336 AudioOutputUnitStop(p_sys->au_unit);
1338 AudioOutputUnitStart(p_sys->au_unit);
1342 static void Flush(audio_output_t *p_aout, bool wait)
1344 struct aout_sys_t *p_sys = p_aout->sys;
1347 int32_t availableBytes;
1348 vlc_mutex_lock(&p_sys->lock);
1349 TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
1350 while (availableBytes > 0) {
1351 vlc_cond_wait(&p_sys->cond, &p_sys->lock);
1352 TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
1354 vlc_mutex_unlock(&p_sys->lock);
1357 p_sys->b_got_first_sample = false;
1359 /* flush circular buffer */
1360 AudioOutputUnitStop(p_aout->sys->au_unit);
1361 TPCircularBufferClear(&p_aout->sys->circular_buffer);
1365 static int TimeGet(audio_output_t *p_aout, mtime_t *delay)
1367 struct aout_sys_t * p_sys = p_aout->sys;
1369 if (!p_sys->i_bytes_per_sample)
1372 int32_t availableBytes;
1373 TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
1375 *delay = (availableBytes / p_sys->i_bytes_per_sample) * CLOCK_FREQ / p_sys->i_rate;
1380 /*****************************************************************************
1381 * RenderCallbackAnalog: This function is called everytime the AudioUnit wants
1382 * us to provide some more audio data.
1383 * Don't print anything during normal playback, calling blocking function from
1384 * this callback is not allowed.
1385 *****************************************************************************/
1386 static OSStatus RenderCallbackAnalog(vlc_object_t *p_obj,
1387 AudioUnitRenderActionFlags *ioActionFlags,
1388 const AudioTimeStamp *inTimeStamp,
1390 UInt32 inNumberFrames,
1391 AudioBufferList *ioData) {
1392 VLC_UNUSED(ioActionFlags);
1393 VLC_UNUSED(inTimeStamp);
1394 VLC_UNUSED(inBusNumber);
1395 VLC_UNUSED(inNumberFrames);
1397 audio_output_t * p_aout = (audio_output_t *)p_obj;
1398 struct aout_sys_t * p_sys = p_aout->sys;
1400 int bytesRequested = ioData->mBuffers[0].mDataByteSize;
1401 Float32 *targetBuffer = (Float32*)ioData->mBuffers[0].mData;
1403 vlc_mutex_lock(&p_sys->lock);
1404 /* Pull audio from buffer */
1405 int32_t availableBytes;
1406 Float32 *buffer = TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
1408 /* check if we have enough data */
1409 if (!availableBytes) {
1410 /* return an empty buffer so silence is played until we have data */
1411 memset(targetBuffer, 0, ioData->mBuffers[0].mDataByteSize);
1413 int32_t bytesToCopy = __MIN(bytesRequested, availableBytes);
1415 memcpy(targetBuffer, buffer, bytesToCopy);
1416 TPCircularBufferConsume(&p_sys->circular_buffer, bytesToCopy);
1417 ioData->mBuffers[0].mDataByteSize = bytesToCopy;
1420 vlc_cond_signal(&p_sys->cond);
1421 vlc_mutex_unlock(&p_sys->lock);
1427 * RenderCallbackSPDIF: callback for SPDIF audio output
1429 static OSStatus RenderCallbackSPDIF(AudioDeviceID inDevice,
1430 const AudioTimeStamp * inNow,
1431 const void * inInputData,
1432 const AudioTimeStamp * inInputTime,
1433 AudioBufferList * outOutputData,
1434 const AudioTimeStamp * inOutputTime,
1435 void * threadGlobals)
1438 VLC_UNUSED(inDevice);
1439 VLC_UNUSED(inInputData);
1440 VLC_UNUSED(inInputTime);
1441 VLC_UNUSED(inOutputTime);
1443 audio_output_t * p_aout = (audio_output_t *)threadGlobals;
1444 struct aout_sys_t * p_sys = p_aout->sys;
1446 int bytesRequested = outOutputData->mBuffers[p_sys->i_stream_index].mDataByteSize;
1447 char *targetBuffer = outOutputData->mBuffers[p_sys->i_stream_index].mData;
1449 vlc_mutex_lock(&p_sys->lock);
1450 /* Pull audio from buffer */
1451 int32_t availableBytes;
1452 char *buffer = TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
1454 /* check if we have enough data */
1455 if (!availableBytes) {
1456 /* return an empty buffer so silence is played until we have data */
1457 memset(targetBuffer, 0, outOutputData->mBuffers[p_sys->i_stream_index].mDataByteSize);
1459 int32_t bytesToCopy = __MIN(bytesRequested, availableBytes);
1461 memcpy(targetBuffer, buffer, bytesToCopy);
1462 TPCircularBufferConsume(&p_sys->circular_buffer, bytesToCopy);
1463 outOutputData->mBuffers[p_sys->i_stream_index].mDataByteSize = bytesToCopy;
1466 vlc_cond_signal(&p_sys->cond);
1467 vlc_mutex_unlock(&p_sys->lock);
1473 #pragma mark Stream / Hardware Listeners
1476 * HardwareListener: Warns us of changes in the list of registered devices
1478 static OSStatus HardwareListener(AudioObjectID inObjectID, UInt32 inNumberAddresses, const AudioObjectPropertyAddress inAddresses[], void*inClientData)
1480 OSStatus err = noErr;
1481 audio_output_t *p_aout = (audio_output_t *)inClientData;
1482 VLC_UNUSED(inObjectID);
1487 for (unsigned int i = 0; i < inNumberAddresses; i++) {
1488 switch (inAddresses[i].mSelector) {
1489 case kAudioHardwarePropertyDevices:
1490 msg_Dbg(p_aout, "audio device configuration changed, resetting cache");
1493 case kAudioDevicePropertyDeviceIsAlive:
1494 msg_Warn(p_aout, "audio device died, resetting aout");
1497 case kAudioStreamPropertyAvailablePhysicalFormats:
1498 msg_Dbg(p_aout, "available physical formats for audio device changed, resetting aout");
1502 msg_Warn(p_aout, "device reset for unknown reason (%i)", inAddresses[i].mSelector);
1507 RebuildDeviceList(p_aout);
1513 * StreamListener: check whether the device's physical format changes on-the-fly (unlikely)
1515 static OSStatus StreamListener(AudioObjectID inObjectID, UInt32 inNumberAddresses, const AudioObjectPropertyAddress inAddresses[], void*inClientData)
1517 OSStatus err = noErr;
1518 struct { vlc_mutex_t lock; vlc_cond_t cond; } * w = inClientData;
1520 VLC_UNUSED(inObjectID);
1522 for (unsigned int i = 0; i < inNumberAddresses; i++) {
1523 if (inAddresses[i].mSelector == kAudioStreamPropertyPhysicalFormat) {
1524 vlc_mutex_lock(&w->lock);
1525 vlc_cond_signal(&w->cond);
1526 vlc_mutex_unlock(&w->lock);
1534 #pragma mark helpers
1536 static int ManageAudioStreamsCallback(audio_output_t *p_aout, AudioDeviceID i_dev_id, bool b_register)
1538 OSStatus err = noErr;
1539 UInt32 i_param_size = 0;
1540 AudioStreamID *p_streams = NULL;
1543 /* Retrieve all the output streams */
1544 AudioObjectPropertyAddress streamsAddress = { kAudioDevicePropertyStreams, kAudioDevicePropertyScopeOutput, kAudioObjectPropertyElementMaster };
1545 err = AudioObjectGetPropertyDataSize(i_dev_id, &streamsAddress, 0, NULL, &i_param_size);
1547 msg_Err(p_aout, "could not get number of streams for device id %i [%4.4s]", i_dev_id, (char *)&err);
1548 return VLC_EGENERIC;
1551 i_streams = i_param_size / sizeof(AudioStreamID);
1552 p_streams = (AudioStreamID *)malloc(i_param_size);
1553 if (p_streams == NULL)
1556 err = AudioObjectGetPropertyData(i_dev_id, &streamsAddress, 0, NULL, &i_param_size, p_streams);
1558 msg_Err(p_aout, "could not get list of streams [%4.4s]", (char *)&err);
1559 return VLC_EGENERIC;
1562 for (int i = 0; i < i_streams; i++) {
1563 /* get notified when physical formats change */
1564 AudioObjectPropertyAddress physicalFormatsAddress = { kAudioStreamPropertyAvailablePhysicalFormats, kAudioObjectPropertyScopeGlobal, 0 };
1567 err = AudioObjectAddPropertyListener(p_streams[i], &physicalFormatsAddress, HardwareListener, (void *)p_aout);
1569 // nope just means that we already have a callback
1570 if (err == kAudioHardwareIllegalOperationError) {
1571 msg_Warn(p_aout, "could not set audio stream formats property callback on stream id %i, callback already set? [%4.4s]", p_streams[i],
1574 msg_Err(p_aout, "could not set audio stream formats property callback on stream id %i [%4.4s]", p_streams[i],
1579 } else { /* unregister callback */
1580 err = AudioObjectRemovePropertyListener(p_streams[i], &physicalFormatsAddress, HardwareListener, (void *)p_aout);
1582 msg_Err(p_aout, "failed to remove audio device property streams callback [%4.4s]", (char *)&err);
1592 * AudioDeviceHasOutput: Checks if the device is actually an output device
1594 static int AudioDeviceHasOutput(AudioDeviceID i_dev_id)
1596 UInt32 dataSize = 0;
1599 AudioObjectPropertyAddress streamsAddress = { kAudioDevicePropertyStreams, kAudioDevicePropertyScopeOutput, kAudioObjectPropertyElementMaster };
1600 status = AudioObjectGetPropertyDataSize(i_dev_id, &streamsAddress, 0, NULL, &dataSize);
1602 if (dataSize == 0 || status != noErr)
1609 * AudioDeviceSupportsDigital: Checks if device supports raw bitstreams
1611 static int AudioDeviceSupportsDigital(audio_output_t *p_aout, AudioDeviceID i_dev_id)
1613 OSStatus err = noErr;
1614 UInt32 i_param_size = 0;
1615 AudioStreamID *p_streams = NULL;
1617 bool b_return = false;
1619 /* Retrieve all the output streams */
1620 AudioObjectPropertyAddress streamsAddress = { kAudioDevicePropertyStreams, kAudioDevicePropertyScopeOutput, kAudioObjectPropertyElementMaster };
1621 err = AudioObjectGetPropertyDataSize(i_dev_id, &streamsAddress, 0, NULL, &i_param_size);
1623 msg_Err(p_aout, "could not get number of streams [%4.4s] (%i)", (char *)&err, (int32_t)err);
1627 i_streams = i_param_size / sizeof(AudioStreamID);
1628 p_streams = (AudioStreamID *)malloc(i_param_size);
1629 if (p_streams == NULL)
1632 err = AudioObjectGetPropertyData(i_dev_id, &streamsAddress, 0, NULL, &i_param_size, p_streams);
1634 msg_Err(p_aout, "could not get list of streams [%4.4s]", (char *)&err);
1638 for (int i = 0; i < i_streams; i++) {
1639 if (AudioStreamSupportsDigital(p_aout, p_streams[i]))
1648 * AudioStreamSupportsDigital: Checks if audio stream is compatible with raw bitstreams
1650 static int AudioStreamSupportsDigital(audio_output_t *p_aout, AudioStreamID i_stream_id)
1652 OSStatus err = noErr;
1653 UInt32 i_param_size = 0;
1654 AudioStreamRangedDescription *p_format_list = NULL;
1656 bool b_return = false;
1658 /* Retrieve all the stream formats supported by each output stream */
1659 AudioObjectPropertyAddress physicalFormatsAddress = { kAudioStreamPropertyAvailablePhysicalFormats, kAudioObjectPropertyScopeGlobal, 0 };
1660 err = AudioObjectGetPropertyDataSize(i_stream_id, &physicalFormatsAddress, 0, NULL, &i_param_size);
1662 msg_Err(p_aout, "could not get number of streamformats [%4.4s] (%i)", (char *)&err, (int32_t)err);
1666 i_formats = i_param_size / sizeof(AudioStreamRangedDescription);
1667 msg_Dbg(p_aout, "found %i stream formats for stream id %i", i_formats, i_stream_id);
1669 p_format_list = (AudioStreamRangedDescription *)malloc(i_param_size);
1670 if (p_format_list == NULL)
1673 err = AudioObjectGetPropertyData(i_stream_id, &physicalFormatsAddress, 0, NULL, &i_param_size, p_format_list);
1675 msg_Err(p_aout, "could not get the list of streamformats [%4.4s]", (char *)&err);
1676 free(p_format_list);
1677 p_format_list = NULL;
1681 for (int i = 0; i < i_formats; i++) {
1683 msg_Dbg(p_aout, STREAM_FORMAT_MSG("supported format: ", p_format_list[i].mFormat));
1686 if (p_format_list[i].mFormat.mFormatID == 'IAC3' ||
1687 p_format_list[i].mFormat.mFormatID == 'iac3' ||
1688 p_format_list[i].mFormat.mFormatID == kAudioFormat60958AC3 ||
1689 p_format_list[i].mFormat.mFormatID == kAudioFormatAC3)
1693 free(p_format_list);
1698 * AudioStreamChangeFormat: switch stream format based on the provided description
1700 static int AudioStreamChangeFormat(audio_output_t *p_aout, AudioStreamID i_stream_id, AudioStreamBasicDescription change_format)
1702 OSStatus err = noErr;
1703 UInt32 i_param_size = 0;
1705 AudioObjectPropertyAddress physicalFormatAddress = { kAudioStreamPropertyPhysicalFormat, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
1707 struct { vlc_mutex_t lock; vlc_cond_t cond; } w;
1709 msg_Dbg(p_aout, STREAM_FORMAT_MSG("setting stream format: ", change_format));
1711 /* Condition because SetProperty is asynchronious */
1712 vlc_cond_init(&w.cond);
1713 vlc_mutex_init(&w.lock);
1714 vlc_mutex_lock(&w.lock);
1716 /* Install the callback */
1717 err = AudioObjectAddPropertyListener(i_stream_id, &physicalFormatAddress, StreamListener, (void *)&w);
1719 msg_Err(p_aout, "AudioObjectAddPropertyListener for kAudioStreamPropertyPhysicalFormat failed [%4.4s]", (char *)&err);
1723 /* change the format */
1724 err = AudioObjectSetPropertyData(i_stream_id, &physicalFormatAddress, 0, NULL, sizeof(AudioStreamBasicDescription),
1727 msg_Err(p_aout, "could not set the stream format [%4.4s]", (char *)&err);
1731 /* The AudioStreamSetProperty is not only asynchronious (requiring the locks)
1732 * it is also not atomic in its behaviour.
1733 * Therefore we check 5 times before we really give up.
1734 * FIXME: failing isn't actually implemented yet. */
1735 for (int i = 0; i < 5; i++) {
1736 AudioStreamBasicDescription actual_format;
1737 mtime_t timeout = mdate() + 500000;
1739 if (vlc_cond_timedwait(&w.cond, &w.lock, timeout))
1740 msg_Dbg(p_aout, "reached timeout");
1742 i_param_size = sizeof(AudioStreamBasicDescription);
1743 err = AudioObjectGetPropertyData(i_stream_id, &physicalFormatAddress, 0, NULL, &i_param_size, &actual_format);
1745 msg_Dbg(p_aout, STREAM_FORMAT_MSG("actual format in use: ", actual_format));
1746 if (actual_format.mSampleRate == change_format.mSampleRate &&
1747 actual_format.mFormatID == change_format.mFormatID &&
1748 actual_format.mFramesPerPacket == change_format.mFramesPerPacket) {
1749 /* The right format is now active */
1752 /* We need to check again */
1755 /* Removing the property listener */
1756 err = AudioObjectRemovePropertyListener(i_stream_id, &physicalFormatAddress, StreamListener, (void *)&w);
1758 msg_Err(p_aout, "AudioStreamRemovePropertyListener failed [%4.4s]", (char *)&err);
1762 /* Destroy the lock and condition */
1763 vlc_mutex_unlock(&w.lock);
1764 vlc_mutex_destroy(&w.lock);
1765 vlc_cond_destroy(&w.cond);