auhal.c 58.1 KB
Newer Older
1
/*****************************************************************************
hartman's avatar
hartman committed
2
 * auhal.c: AUHAL and Coreaudio output plugin
3
 *****************************************************************************
4
 * Copyright (C) 2005 the VideoLAN team
hartman's avatar
hartman committed
5
 * $Id$
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 *
 * Authors: Derk-Jan Hartman <hartman at videolan dot org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22
23
24
25
26
27
28
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <string.h>
#include <stdlib.h>
29
#include <unistd.h>
30
31
32
33
34
35
36
37
38
39
40
41
42

#include <vlc/vlc.h>
#include <vlc/aout.h>

#include "aout_internal.h"

#include <CoreAudio/CoreAudio.h>
#include <AudioUnit/AudioUnitProperties.h>
#include <AudioUnit/AudioUnitParameters.h>
#include <AudioUnit/AudioOutputUnit.h>
#include <AudioToolbox/AudioFormat.h>

#define STREAM_FORMAT_MSG( pre, sfm ) \
43
44
45
46
47
48
49
    pre "[%ld][%4.4s][%ld][%ld][%ld][%ld][%ld][%ld]", \
    (UInt32)sfm.mSampleRate, (char *)&sfm.mFormatID, \
    sfm.mFormatFlags, sfm.mBytesPerPacket, \
    sfm.mFramesPerPacket, sfm.mBytesPerFrame, \
    sfm.mChannelsPerFrame, sfm.mBitsPerChannel

#define STREAM_FORMAT_MSG_FULL( pre, sfm ) \
50
51
52
53
54
55
    pre ":\nsamplerate: [%ld]\nFormatID: [%4.4s]\nFormatFlags: [%ld]\nBypesPerPacket: [%ld]\nFramesPerPacket: [%ld]\nBytesPerFrame: [%ld]\nChannelsPerFrame: [%ld]\nBitsPerChannel[%ld]", \
    (UInt32)sfm.mSampleRate, (char *)&sfm.mFormatID, \
    sfm.mFormatFlags, sfm.mBytesPerPacket, \
    sfm.mFramesPerPacket, sfm.mBytesPerFrame, \
    sfm.mChannelsPerFrame, sfm.mBitsPerChannel

56
#define BUFSIZE 0xffffff
57
#define AOUT_VAR_SPDIF_FLAG 0xf00000
58

59
60
61
62
63
/*
 * TODO:
 * - clean up the debug info
 * - clean up C99'isms
 * - be better at changing stream setup or devices setup changes while playing.
hartman's avatar
hartman committed
64
 * - fix 6.1 and 7.1
65
66
 */

67
68
69
70
71
72
73
74
75
76
77
78
79
/*****************************************************************************
 * aout_sys_t: private audio output method descriptor
 *****************************************************************************
 * This structure is part of the audio output thread descriptor.
 * It describes the CoreAudio specific properties of an output thread.
 *****************************************************************************/
struct aout_sys_t
{
    AudioDeviceID               i_default_dev;  /* Keeps DeviceID of defaultOutputDevice */
    AudioDeviceID               i_selected_dev; /* Keeps DeviceID of the selected device */
    UInt32                      i_devices;      /* Number of CoreAudio Devices */
    vlc_bool_t                  b_supports_digital;/* Does the currently selected device support digital mode? */
    vlc_bool_t                  b_digital;      /* Are we running in digital mode? */
80
    mtime_t                     clock_diff;     /* Difference between VLC clock and Device clock */
hartman's avatar
hartman committed
81

82
    /* AUHAL specific */
83
84
    Component                   au_component;   /* The Audiocomponent we use */
    AudioUnit                   au_unit;        /* The AudioUnit we use */
85
    uint8_t                     p_remainder_buffer[BUFSIZE];
86
87
    uint32_t                    i_read_bytes;
    uint32_t                    i_total_bytes;
hartman's avatar
hartman committed
88

89
90
91
92
    /* CoreAudio SPDIF mode specific */
    pid_t                       i_hog_pid;      /* The keep the pid of our hog status */
    AudioStreamID               i_stream_id;    /* The StreamID that has a cac3 streamformat */
    int                         i_stream_index; /* The index of i_stream_id in an AudioBufferList */
hartman's avatar
hartman committed
93
    AudioStreamBasicDescription stream_format;  /* The format we changed the stream to */
94
95
96
    AudioStreamBasicDescription sfmt_revert;    /* The original format of the stream */
    vlc_bool_t                  b_revert;       /* Wether we need to revert the stream format */
    vlc_bool_t                  b_changed_mixing;/* Wether we need to set the mixing mode back */
97
98
99
100
101
102
};

/*****************************************************************************
 * Local prototypes.
 *****************************************************************************/
static int      Open                    ( vlc_object_t * );
103
104
static int      OpenAnalog              ( aout_instance_t * );
static int      OpenSPDIF               ( aout_instance_t * );
105
106
static void     Close                   ( vlc_object_t * );

107
108
static void     Play                    ( aout_instance_t * );
static void     Probe                   ( aout_instance_t * );
109

110
111
112
static int      AudioDeviceHasOutput    ( AudioDeviceID );
static int      AudioDeviceSupportsDigital( aout_instance_t *, AudioDeviceID );
static int      AudioStreamSupportsDigital( aout_instance_t *, AudioStreamID );
hartman's avatar
hartman committed
113
static int      AudioStreamChangeFormat ( aout_instance_t *, AudioStreamID, AudioStreamBasicDescription );
114
115
116

static OSStatus RenderCallbackAnalog    ( vlc_object_t *, AudioUnitRenderActionFlags *, const AudioTimeStamp *,
                                          unsigned int, unsigned int, AudioBufferList *);
117
118
static OSStatus RenderCallbackSPDIF     ( AudioDeviceID, const AudioTimeStamp *, const void *, const AudioTimeStamp *,
                                          AudioBufferList *, const AudioTimeStamp *, void * );
119
static OSStatus HardwareListener        ( AudioHardwarePropertyID, void *);
120
121
122
123
124
static OSStatus StreamListener          ( AudioStreamID, UInt32,
                                          AudioDevicePropertyID, void * );
static int      AudioDeviceCallback     ( vlc_object_t *, const char *,
                                          vlc_value_t, vlc_value_t, void * );

125
126
127
128
129
130
131
132
133
134
135
136

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
#define ADEV_TEXT N_("Audio Device")
#define ADEV_LONGTEXT N_("Choose a number corresponding to the number of an " \
    "audio device, as listed in your 'Audio Device' menu. This device will " \
    "then be used by default for audio playback.")

vlc_module_begin();
    set_shortname( "auhal" );
    set_description( _("HAL AudioUnit output") );
137
    set_capability( "audio output", 101 );
138
139
140
    set_category( CAT_AUDIO );
    set_subcategory( SUBCAT_AUDIO_AOUT );
    set_callbacks( Open, Close );
141
    add_integer( "macosx-audio-device", 0, NULL, ADEV_TEXT, ADEV_LONGTEXT, VLC_FALSE ); 
142
143
144
vlc_module_end();

/*****************************************************************************
145
 * Open: open macosx audio output
146
147
148
149
 *****************************************************************************/
static int Open( vlc_object_t * p_this )
{
    OSStatus                err = noErr;
150
    UInt32                  i_param_size = 0;
151
152
    struct aout_sys_t       *p_sys = NULL;
    vlc_bool_t              b_alive = VLC_FALSE;
153
154
155
156
    vlc_value_t             val;
    aout_instance_t         *p_aout = (aout_instance_t *)p_this;

    /* Allocate structure */
157
158
    p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
    if( p_aout->output.p_sys == NULL )
159
160
161
162
163
    {
        msg_Err( p_aout, "out of memory" );
        return( VLC_ENOMEM );
    }

164
165
166
167
168
169
170
171
172
173
174
    p_sys = p_aout->output.p_sys;
    p_sys->i_default_dev = 0;
    p_sys->i_selected_dev = 0;
    p_sys->i_devices = 0;
    p_sys->b_supports_digital = VLC_FALSE;
    p_sys->b_digital = VLC_FALSE;
    p_sys->au_component = NULL;
    p_sys->au_unit = NULL;
    p_sys->clock_diff = (mtime_t) 0;
    p_sys->i_read_bytes = 0;
    p_sys->i_total_bytes = 0;
175
176
    p_sys->i_hog_pid = -1;
    p_sys->i_stream_id = 0;
177
    p_sys->i_stream_index = -1;
178
179
    p_sys->b_revert = VLC_FALSE;
    p_sys->b_changed_mixing = VLC_FALSE;
180
    memset( p_sys->p_remainder_buffer, 0, sizeof(uint8_t) * BUFSIZE );
181
182
183

    p_aout->output.pf_play = Play;
    
184
    aout_FormatPrint( p_aout, "VLC is looking for:", (audio_sample_format_t *)&p_aout->output.output );
185
    
186
187
188
189
190
191
    /* Persistent device variable */
    if( var_Type( p_aout->p_vlc, "macosx-audio-device" ) == 0 )
    {
        var_Create( p_aout->p_vlc, "macosx-audio-device", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    }

192
193
194
    /* Build a list of devices */
    if( var_Type( p_aout, "audio-device" ) == 0 )
    {
195
        Probe( p_aout );
196
    }
197

198
199
200
    /* What device do we want? */
    if( var_Get( p_aout, "audio-device", &val ) < 0 )
    {
201
        msg_Err( p_aout, "audio-device var does not exist. device probe failed." );
hartman's avatar
hartman committed
202
        goto error;
203
204
    }

hartman's avatar
hartman committed
205
    p_sys->i_selected_dev = val.i_int & ~AOUT_VAR_SPDIF_FLAG; /* remove SPDIF flag to get the true DeviceID */
206
207
208
    p_sys->b_supports_digital = ( val.i_int & AOUT_VAR_SPDIF_FLAG ) ? VLC_TRUE : VLC_FALSE;

    /* Check if the desired device is alive and usable */
hartman's avatar
hartman committed
209
    /* TODO: add a callback to the device to alert us if the device dies */
210
211
212
213
214
215
216
    i_param_size = sizeof( b_alive );
    err = AudioDeviceGetProperty( p_sys->i_selected_dev, 0, FALSE,
                                  kAudioDevicePropertyDeviceIsAlive,
                                  &i_param_size, &b_alive );

    if( err != noErr )
    {
hartman's avatar
hartman committed
217
218
        msg_Err( p_aout, "could not check whether device is alive: %4.4s", (char *)&err );
        goto error;
219
220
221
    }

    if( b_alive == VLC_FALSE )
222
    {
hartman's avatar
hartman committed
223
        msg_Warn( p_aout, "selected audio device is not alive, switching to default device" ); 
224
        p_sys->i_selected_dev = p_sys->i_default_dev;
225
    }
226

227
    i_param_size = sizeof( p_sys->i_hog_pid );
228
229
    err = AudioDeviceGetProperty( p_sys->i_selected_dev, 0, FALSE,
                                  kAudioDevicePropertyHogMode,
230
                                  &i_param_size, &p_sys->i_hog_pid );
231
232
233

    if( err != noErr )
    {
234
        /* This is not a fatal error. Some drivers simply don't support this property */
hartman's avatar
hartman committed
235
        msg_Warn( p_aout, "could not check whether device is hogged: %4.4s",
236
                 (char *)&err );
237
        p_sys->i_hog_pid = -1;
238
239
    }

240
    if( p_sys->i_hog_pid != -1 && p_sys->i_hog_pid != getpid() )
241
    {
hartman's avatar
hartman committed
242
243
        msg_Err( p_aout, "Selected audio device is exclusively in use by another program." );
        goto error;
244
245
246
    }

    /* Check for Digital mode or Analog output mode */
247
248
    if( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) && p_sys->b_supports_digital )
    {
249
250
251
252
253
254
255
        if( OpenSPDIF( p_aout ) )
            return VLC_SUCCESS;
    }
    else
    {
        if( OpenAnalog( p_aout ) )
            return VLC_SUCCESS;
256
    }
hartman's avatar
hartman committed
257
258
259

error:
    /* If we reach this, this aout has failed */
260
    var_Destroy( p_aout, "audio-device" );
hartman's avatar
hartman committed
261
    if( p_sys ) free( p_sys );
262
263
264
    return VLC_EGENERIC;
}

265
/*****************************************************************************
hartman's avatar
hartman committed
266
 * Open: open and setup a HAL AudioUnit to do analog (multichannel) audio output
267
268
 *****************************************************************************/
static int OpenAnalog( aout_instance_t *p_aout )
269
{
hartman's avatar
hartman committed
270
271
272
273
274
275
276
277
278
    struct aout_sys_t           *p_sys = p_aout->output.p_sys;
    OSStatus                    err = noErr;
    UInt32                      i_param_size = 0, i = 0;
    int                         i_original; 
    ComponentDescription        desc;
    AudioStreamBasicDescription DeviceFormat;
    AudioChannelLayout          *layout;
    AudioChannelLayout          new_layout;
    AURenderCallbackStruct      input;
279
280
281
282
283
284
285
286
287
288
289

    /* Lets go find our Component */
    desc.componentType = kAudioUnitType_Output;
    desc.componentSubType = kAudioUnitSubType_HALOutput;
    desc.componentManufacturer = kAudioUnitManufacturer_Apple;
    desc.componentFlags = 0;
    desc.componentFlagsMask = 0;

    p_sys->au_component = FindNextComponent( NULL, &desc );
    if( p_sys->au_component == NULL )
    {
hartman's avatar
hartman committed
290
        msg_Warn( p_aout, "we cannot find our HAL component" );
291
        return VLC_FALSE;
292
293
294
295
296
    }

    err = OpenAComponent( p_sys->au_component, &p_sys->au_unit );
    if( err )
    {
hartman's avatar
hartman committed
297
        msg_Warn( p_aout, "we cannot open our HAL component" );
298
        return VLC_FALSE;
299
300
    }
    
hartman's avatar
hartman committed
301
    /* Set the device we will use for this output unit */
302
303
304
305
306
    verify_noerr( AudioUnitSetProperty( p_sys->au_unit,
                         kAudioOutputUnitProperty_CurrentDevice,
                         kAudioUnitScope_Global,
                         0,
                         &p_sys->i_selected_dev,
307
                         sizeof( AudioDeviceID )));
308
309
310
311
312
313
314
315
316
317
318
                         
    /* Get the current format */
    i_param_size = sizeof(AudioStreamBasicDescription);

    verify_noerr( AudioUnitGetProperty( p_sys->au_unit,
                                   kAudioUnitProperty_StreamFormat,
                                   kAudioUnitScope_Input,
                                   0,
                                   &DeviceFormat,
                                   &i_param_size ));
                                   
hartman's avatar
hartman committed
319
    msg_Dbg( p_aout, STREAM_FORMAT_MSG( "current format is: ", DeviceFormat ) );
320

hartman's avatar
hartman committed
321
    /* Get the channel layout of the device side of the unit (vlc -> unit -> device) */
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
    verify_noerr( AudioUnitGetPropertyInfo( p_sys->au_unit,
                                   kAudioDevicePropertyPreferredChannelLayout,
                                   kAudioUnitScope_Output,
                                   0,
                                   &i_param_size,
                                   NULL ));

    layout = (AudioChannelLayout *)malloc( i_param_size);

    verify_noerr( AudioUnitGetProperty( p_sys->au_unit,
                                   kAudioDevicePropertyPreferredChannelLayout,
                                   kAudioUnitScope_Output,
                                   0,
                                   layout,
                                   &i_param_size ));
                                   
hartman's avatar
hartman committed
338
    /* We need to "fill out" the ChannelLayout, because there are multiple ways that it can be set */
339
340
    if( layout->mChannelLayoutTag == kAudioChannelLayoutTag_UseChannelBitmap)
    {
hartman's avatar
hartman committed
341
        /* bitmap defined channellayout */
342
343
344
345
346
347
348
        verify_noerr( AudioFormatGetProperty( kAudioFormatProperty_ChannelLayoutForBitmap,
                                sizeof( UInt32), &layout->mChannelBitmap,
                                &i_param_size,
                                layout ));
    }
    else if( layout->mChannelLayoutTag != kAudioChannelLayoutTag_UseChannelDescriptions )
    {
hartman's avatar
hartman committed
349
        /* layouttags defined channellayout */
350
351
352
353
354
        verify_noerr( AudioFormatGetProperty( kAudioFormatProperty_ChannelLayoutForTag,
                                sizeof( AudioChannelLayoutTag ), &layout->mChannelLayoutTag,
                                &i_param_size,
                                layout ));
    }
355

hartman's avatar
hartman committed
356
    msg_Dbg( p_aout, "layout of AUHAL has %d channels" , (int)layout->mNumberChannelDescriptions );
357
    
hartman's avatar
hartman committed
358
    /* Initialize the VLC core channel count */
359
    p_aout->output.output.i_physical_channels = 0;
hartman's avatar
hartman committed
360
    i_original = p_aout->output.output.i_original_channels & AOUT_CHAN_PHYSMASK;
361
362
    
    if( i_original == AOUT_CHAN_CENTER || layout->mNumberChannelDescriptions < 2 )
363
    {
hartman's avatar
hartman committed
364
365
        /* We only need Mono or cannot output more than 1 channel */
        p_aout->output.output.i_physical_channels = AOUT_CHAN_CENTER;
366
367
368
    }
    else if( i_original == (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT) || layout->mNumberChannelDescriptions < 3 )
    {
hartman's avatar
hartman committed
369
370
        /* We only need Stereo or cannot output more than 2 channels */
        p_aout->output.output.i_physical_channels = AOUT_CHAN_RIGHT | AOUT_CHAN_LEFT;
371
372
373
    }
    else
    {
hartman's avatar
hartman committed
374
        /* We want more than stereo and we can do that */
375
        for( i = 0; i < layout->mNumberChannelDescriptions; i++ )
376
        {
hartman's avatar
hartman committed
377
            msg_Dbg( p_aout, "this is channel: %d", (int)layout->mChannelDescriptions[i].mChannelLabel );
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410

            switch( layout->mChannelDescriptions[i].mChannelLabel )
            {
                case kAudioChannelLabel_Left:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_LEFT;
                    continue;
                case kAudioChannelLabel_Right:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_RIGHT;
                    continue;
                case kAudioChannelLabel_Center:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_CENTER;
                    continue;
                case kAudioChannelLabel_LFEScreen:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_LFE;
                    continue;
                case kAudioChannelLabel_LeftSurround:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_REARLEFT;
                    continue;
                case kAudioChannelLabel_RightSurround:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_REARRIGHT;
                    continue;
                case kAudioChannelLabel_RearSurroundLeft:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_MIDDLELEFT;
                    continue;
                case kAudioChannelLabel_RearSurroundRight:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_MIDDLERIGHT;
                    continue;
                case kAudioChannelLabel_CenterSurround:
                    p_aout->output.output.i_physical_channels |= AOUT_CHAN_REARCENTER;
                    continue;
                default:
                    msg_Warn( p_aout, "Unrecognized channel form provided by driver: %d", (int)layout->mChannelDescriptions[i].mChannelLabel );
            }
411
        }
hartman's avatar
hartman committed
412
413
414
415
416
        if( p_aout->output.output.i_physical_channels == 0 )
        {
            p_aout->output.output.i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
            msg_Err( p_aout, "You should configure your speaker layout with Audio Midi Setup Utility in /Applications/Utilities. Now using Stereo mode." );
        }
417
    }
418
    if( layout ) free( layout );
419

420
    msg_Dbg( p_aout, "selected %d physical channels for device output", aout_FormatNbChannels( &p_aout->output.output ) );
hartman's avatar
hartman committed
421
    msg_Dbg( p_aout, "VLC will output: %s", aout_FormatPrintChannels( &p_aout->output.output ));
422

423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
    memset (&new_layout, 0, sizeof(new_layout));
    switch( aout_FormatNbChannels( &p_aout->output.output ) )
    {
        case 1:
            new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_Mono;
            break;
        case 2:
            new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_Stereo;
            break;
        case 3:
            if( p_aout->output.output.i_physical_channels & AOUT_CHAN_CENTER )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_7; // L R C
            }
            else if( p_aout->output.output.i_physical_channels & AOUT_CHAN_LFE )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_4; // L R LFE
            }
            break;
        case 4:
            if( p_aout->output.output.i_physical_channels & ( AOUT_CHAN_CENTER | AOUT_CHAN_LFE ) )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_10; // L R C LFE
            }
            else if( p_aout->output.output.i_physical_channels & ( AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT ) )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_3; // L R Ls Rs
            }
            else if( p_aout->output.output.i_physical_channels & ( AOUT_CHAN_CENTER | AOUT_CHAN_REARCENTER ) )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_3; // L R C Cs
            }
            break;
        case 5:
            if( p_aout->output.output.i_physical_channels & ( AOUT_CHAN_CENTER ) )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_19; // L R Ls Rs C
            }
            else if( p_aout->output.output.i_physical_channels & ( AOUT_CHAN_LFE ) )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_18; // L R Ls Rs LFE
            }
            break;
        case 6:
hartman's avatar
hartman committed
467
468
469
470
471
472
473
474
            if( p_aout->output.output.i_physical_channels & ( AOUT_CHAN_LFE ) )
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_DVD_20; // L R Ls Rs C LFE
            }
            else
            {
                new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_AudioUnit_6_0; // L R Ls Rs C Cs
            }
475
476
477
478
479
480
481
482
483
484
            break;
        case 7:
            /* FIXME: This is incorrect. VLC uses the internal ordering: L R Lm Rm Lr Rr C LFE but this is wrong */
            new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_MPEG_6_1_A; // L R C LFE Ls Rs Cs
            break;
        case 8:
            /* FIXME: This is incorrect. VLC uses the internal ordering: L R Lm Rm Lr Rr C LFE but this is wrong */
            new_layout.mChannelLayoutTag = kAudioChannelLayoutTag_MPEG_7_1_A; // L R C LFE Ls Rs Lc Rc
            break;
    }
485
486
487
488
489
490
491
492
493
494
495
496

    /* Set up the format to be used */
    DeviceFormat.mSampleRate = p_aout->output.output.i_rate;
    DeviceFormat.mFormatID = kAudioFormatLinearPCM;

    /* We use float 32. It's the best supported format by both VLC and Coreaudio */
    p_aout->output.output.i_format = VLC_FOURCC( 'f','l','3','2');
    DeviceFormat.mFormatFlags = kAudioFormatFlagsNativeFloatPacked;
    DeviceFormat.mBitsPerChannel = 32;
    DeviceFormat.mChannelsPerFrame = aout_FormatNbChannels( &p_aout->output.output );
    
    /* Calculate framesizes and stuff */
497
498
499
    DeviceFormat.mFramesPerPacket = 1;
    DeviceFormat.mBytesPerFrame = DeviceFormat.mBitsPerChannel * DeviceFormat.mChannelsPerFrame / 8;
    DeviceFormat.mBytesPerPacket = DeviceFormat.mBytesPerFrame * DeviceFormat.mFramesPerPacket;
500
 
hartman's avatar
hartman committed
501
    /* Set the desired format */
502
503
504
505
506
507
508
509
510
511
    i_param_size = sizeof(AudioStreamBasicDescription);
    verify_noerr( AudioUnitSetProperty( p_sys->au_unit,
                                   kAudioUnitProperty_StreamFormat,
                                   kAudioUnitScope_Input,
                                   0,
                                   &DeviceFormat,
                                   i_param_size ));
                                   
    msg_Dbg( p_aout, STREAM_FORMAT_MSG( "we set the AU format: " , DeviceFormat ) );
    
hartman's avatar
hartman committed
512
    /* Retrieve actual format */
513
514
515
516
517
518
519
520
    verify_noerr( AudioUnitGetProperty( p_sys->au_unit,
                                   kAudioUnitProperty_StreamFormat,
                                   kAudioUnitScope_Input,
                                   0,
                                   &DeviceFormat,
                                   &i_param_size ));
                                   
    msg_Dbg( p_aout, STREAM_FORMAT_MSG( "the actual set AU format is " , DeviceFormat ) );
521

hartman's avatar
hartman committed
522
523
    /* Do the last VLC aout setups */
    aout_FormatPrepare( &p_aout->output.output );
524
    p_aout->output.i_nb_samples = 2048;
525
526
527
528
529
530
531
532
533
534
    aout_VolumeSoftInit( p_aout );

    /* set the IOproc callback */
    input.inputProc = (AURenderCallback) RenderCallbackAnalog;
    input.inputProcRefCon = p_aout;
    
    verify_noerr( AudioUnitSetProperty( p_sys->au_unit,
                            kAudioUnitProperty_SetRenderCallback,
                            kAudioUnitScope_Input,
                            0, &input, sizeof( input ) ) );
535
536
537

    input.inputProc = (AURenderCallback) RenderCallbackAnalog;
    input.inputProcRefCon = p_aout;
538
    
hartman's avatar
hartman committed
539
    /* Set the new_layout as the layout VLC will use to feed the AU unit */
540
541
542
543
    verify_noerr( AudioUnitSetProperty( p_sys->au_unit,
                            kAudioUnitProperty_AudioChannelLayout,
                            kAudioUnitScope_Input,
                            0, &new_layout, sizeof(new_layout) ) );
hartman's avatar
hartman committed
544
545
546
                            
    if( new_layout.mNumberChannelDescriptions > 0 )
        free( new_layout.mChannelDescriptions );
547
    
548
549
550
    /* AU initiliaze */
    verify_noerr( AudioUnitInitialize(p_sys->au_unit) );

hartman's avatar
hartman committed
551
552
553
554
555
556
    /* Find the difference between device clock and mdate clock */
    p_sys->clock_diff = - (mtime_t)
        AudioConvertHostTimeToNanos( AudioGetCurrentHostTime() ) / 1000; 
    p_sys->clock_diff += mdate();

    /* Start the AU */
557
    verify_noerr( AudioOutputUnitStart(p_sys->au_unit) );
558
559
    
    return VLC_TRUE;
560
561
}

562
563
564
/*****************************************************************************
 * Setup a encoded digital stream (SPDIF)
 *****************************************************************************/
565
static int OpenSPDIF( aout_instance_t * p_aout )
566
{
567
568
569
570
571
572
    struct aout_sys_t       *p_sys = p_aout->output.p_sys;
    OSStatus                err = noErr;
    UInt32                  i_param_size = 0, b_mix = 0;
    Boolean                 b_writeable = VLC_FALSE;
    AudioStreamID           *p_streams = NULL;
    int                     i = 0, i_streams = 0;
573
574
575

    /* Start doing the SPDIF setup proces */
    p_sys->b_digital = VLC_TRUE;
576
577
578
579
580
581
582

    /* Hog the device */
    i_param_size = sizeof( p_sys->i_hog_pid );
    p_sys->i_hog_pid = getpid() ;
    
    err = AudioDeviceSetProperty( p_sys->i_selected_dev, 0, 0, FALSE,
                                  kAudioDevicePropertyHogMode, i_param_size, &p_sys->i_hog_pid );
583
    
584
585
    if( err != noErr )
    {
hartman's avatar
hartman committed
586
        msg_Err( p_aout, "failed to set hogmode: [%4.4s]", (char *)&err );
587
588
        return VLC_FALSE;
    }
589

590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
    /* Set mixable to false if we are allowed to */
    err = AudioDeviceGetPropertyInfo( p_sys->i_selected_dev, 0, FALSE, kAudioDevicePropertySupportsMixing,
                                    &i_param_size, &b_writeable );

    err = AudioDeviceGetProperty( p_sys->i_selected_dev, 0, FALSE, kAudioDevicePropertySupportsMixing,
                                    &i_param_size, &b_mix );
                                    
    if( !err && b_writeable )
    {
        b_mix = 0;
        err = AudioDeviceSetProperty( p_sys->i_selected_dev, 0, 0, FALSE,
                            kAudioDevicePropertySupportsMixing, i_param_size, &b_mix );
        p_sys->b_changed_mixing = VLC_TRUE;
    }
    
    if( err != noErr )
    {
        msg_Err( p_aout, "failed to set mixmode: [%4.4s]", (char *)&err );
        return VLC_FALSE;
    }

hartman's avatar
hartman committed
611
    /* Get a list of all the streams on this device */
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
    err = AudioDeviceGetPropertyInfo( p_sys->i_selected_dev, 0, FALSE,
                                      kAudioDevicePropertyStreams,
                                      &i_param_size, NULL );
    if( err != noErr )
    {
        msg_Err( p_aout, "could not get number of streams: [%4.4s]", (char *)&err );
        return VLC_FALSE;
    }
    
    i_streams = i_param_size / sizeof( AudioStreamID );
    p_streams = (AudioStreamID *)malloc( i_param_size );
    if( p_streams == NULL )
    {
        msg_Err( p_aout, "Out of memory" );
        return VLC_FALSE;
    }
    
    err = AudioDeviceGetProperty( p_sys->i_selected_dev, 0, FALSE,
                                    kAudioDevicePropertyStreams,
                                    &i_param_size, p_streams );
    
    if( err != noErr )
    {
        msg_Err( p_aout, "could not get number of streams: [%4.4s]", (char *)&err );
        if( p_streams ) free( p_streams );
        return VLC_FALSE;
    }

640
    for( i = 0; i < i_streams && p_sys->i_stream_index < 0 ; i++ )
641
    {
hartman's avatar
hartman committed
642
        /* Find a stream with a cac3 stream */
643
644
        AudioStreamBasicDescription *p_format_list = NULL;
        int                         i_formats = 0, j = 0;
645
        vlc_bool_t                  b_digital = VLC_FALSE;
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
        
        /* Retrieve all the stream formats supported by each output stream */
        err = AudioStreamGetPropertyInfo( p_streams[i], 0,
                                          kAudioStreamPropertyPhysicalFormats,
                                          &i_param_size, NULL );
        if( err != noErr )
        {
            msg_Err( p_aout, "could not get number of streamformats: [%4.4s]", (char *)&err );
            continue;
        }
        
        i_formats = i_param_size / sizeof( AudioStreamBasicDescription );
        p_format_list = (AudioStreamBasicDescription *)malloc( i_param_size );
        if( p_format_list == NULL )
        {
hartman's avatar
hartman committed
661
            msg_Err( p_aout, "could not malloc the memory" );
662
663
664
665
666
667
668
669
670
671
672
673
674
            continue;
        }
        
        err = AudioStreamGetProperty( p_streams[i], 0,
                                          kAudioStreamPropertyPhysicalFormats,
                                          &i_param_size, p_format_list );
        if( err != noErr )
        {
            msg_Err( p_aout, "could not get the list of streamformats: [%4.4s]", (char *)&err );
            if( p_format_list) free( p_format_list);
            continue;
        }

hartman's avatar
hartman committed
675
        /* Check if one of the supported formats is a digital format */
676
677
678
679
680
        for( j = 0; j < i_formats; j++ )
        {
            if( p_format_list[j].mFormatID == 'IAC3' ||
                  p_format_list[j].mFormatID == kAudioFormat60958AC3 )
            {
681
682
683
684
685
686
687
                b_digital = VLC_TRUE;
                break;
            }
        }
        
        if( b_digital )
        {
hartman's avatar
hartman committed
688
689
690
691
692
            /* if this stream supports a digital (cac3) format, then go set it. */
            int i_requested_rate_format = -1;
            int i_current_rate_format = -1;
            int i_backup_rate_format = -1;

693
694
695
696
697
            p_sys->i_stream_id = p_streams[i];
            p_sys->i_stream_index = i;

            if( p_sys->b_revert == VLC_FALSE )
            {
hartman's avatar
hartman committed
698
                /* Retrieve the original format of this stream first if not done so already */
699
700
701
702
703
704
                i_param_size = sizeof( p_sys->sfmt_revert );
                err = AudioStreamGetProperty( p_sys->i_stream_id, 0,
                                              kAudioStreamPropertyPhysicalFormat,
                                              &i_param_size, 
                                              &p_sys->sfmt_revert );
                if( err != noErr )
705
                {
706
707
                    msg_Err( p_aout, "could not retrieve the original streamformat: [%4.4s]", (char *)&err );
                    continue; 
708
                }
709
710
                p_sys->b_revert = VLC_TRUE;
            }
hartman's avatar
hartman committed
711

712
713
714
715
            for( j = 0; j < i_formats; j++ )
            {
                if( p_format_list[j].mFormatID == 'IAC3' ||
                      p_format_list[j].mFormatID == kAudioFormat60958AC3 )
716
                {
717
718
                    if( p_format_list[j].mSampleRate == p_aout->output.output.i_rate )
                    {
hartman's avatar
hartman committed
719
                        i_requested_rate_format = j;
720
721
722
723
                        break;
                    }
                    else if( p_format_list[j].mSampleRate == p_sys->sfmt_revert.mSampleRate )
                    {
hartman's avatar
hartman committed
724
                        i_current_rate_format = j;
725
726
727
                    }
                    else
                    {
hartman's avatar
hartman committed
728
729
                        if( i_backup_rate_format < 0 || p_format_list[j].mSampleRate > p_format_list[i_backup_rate_format].mSampleRate )
                            i_backup_rate_format = j;
730
                    }
731
                }
732
                    
733
            }
hartman's avatar
hartman committed
734
735
736
737
738
739
            
            if( i_requested_rate_format >= 0 ) /* We prefer to output at the samplerate of the original audio */
                p_sys->stream_format = p_format_list[i_requested_rate_format];
            else if( i_current_rate_format >= 0 ) /* If not possible, we will try to use the current samplerate of the device */
                p_sys->stream_format = p_format_list[i_current_rate_format];
            else p_sys->stream_format = p_format_list[i_backup_rate_format]; /* And if we have to, any digital format will be just fine (highest rate possible) */
740
741
742
743
744
745
746
        }
        if( p_format_list ) free( p_format_list );
    }
    if( p_streams ) free( p_streams );

    msg_Dbg( p_aout, STREAM_FORMAT_MSG( "original stream format: ", p_sys->sfmt_revert ) );

hartman's avatar
hartman committed
747
    if( !AudioStreamChangeFormat( p_aout, p_sys->i_stream_id, p_sys->stream_format ) )
748
749
        return VLC_FALSE;

hartman's avatar
hartman committed
750
    /* Set the format flags */
751
752
753
754
755
756
757
758
    if( p_sys->stream_format.mFormatFlags & kAudioFormatFlagIsBigEndian )
        p_aout->output.output.i_format = VLC_FOURCC('s','p','d','b');
    else
        p_aout->output.output.i_format = VLC_FOURCC('s','p','d','i');
    p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
    p_aout->output.output.i_frame_length = A52_FRAME_NB;
    p_aout->output.i_nb_samples = p_aout->output.output.i_frame_length;
    p_aout->output.output.i_rate = (unsigned int)p_sys->stream_format.mSampleRate;
hartman's avatar
hartman committed
759
    aout_FormatPrepare( &p_aout->output.output );
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
    aout_VolumeNoneInit( p_aout );

    /* Add IOProc callback */
    err = AudioDeviceAddIOProc( p_sys->i_selected_dev,
                                (AudioDeviceIOProc)RenderCallbackSPDIF,
                                (void *)p_aout );
    if( err != noErr )
    {
        msg_Err( p_aout, "AudioDeviceAddIOProc failed: [%4.4s]", (char *)&err );
        return VLC_FALSE;
    }

    /* Check for the difference between the Device clock and mdate */
    p_sys->clock_diff = - (mtime_t)
        AudioConvertHostTimeToNanos( AudioGetCurrentHostTime() ) / 1000; 
    p_sys->clock_diff += mdate();
 
    /* Start device */
    err = AudioDeviceStart( p_sys->i_selected_dev, (AudioDeviceIOProc)RenderCallbackSPDIF ); 
    if( err != noErr )
    {
        msg_Err( p_aout, "AudioDeviceStart failed: [%4.4s]", (char *)&err );

        err = AudioDeviceRemoveIOProc( p_sys->i_selected_dev, 
                                       (AudioDeviceIOProc)RenderCallbackSPDIF );
        if( err != noErr )
        {
            msg_Err( p_aout, "AudioDeviceRemoveIOProc failed: [%4.4s]", (char *)&err );
        }
        return VLC_FALSE;
    }

    return VLC_TRUE;
793
794
795
}


796
797
798
799
800
801
802
/*****************************************************************************
 * Close: Close HAL AudioUnit
 *****************************************************************************/
static void Close( vlc_object_t * p_this )
{
    aout_instance_t     *p_aout = (aout_instance_t *)p_this;
    struct aout_sys_t   *p_sys = p_aout->output.p_sys;
803
804
    OSStatus            err = noErr;
    UInt32              i_param_size = 0;
805
806
807
808
809
810
811
    
    if( p_sys->au_unit )
    {
        verify_noerr( AudioOutputUnitStop( p_sys->au_unit ) );
        verify_noerr( AudioUnitUninitialize( p_sys->au_unit ) );
        verify_noerr( CloseComponent( p_sys->au_unit ) );
    }
812
813
814
815
816
817
818
819
820
821
822
    
    if( p_sys->b_digital )
    {
        /* Stop device */
        err = AudioDeviceStop( p_sys->i_selected_dev, 
                               (AudioDeviceIOProc)RenderCallbackSPDIF ); 
        if( err != noErr )
        {
            msg_Err( p_aout, "AudioDeviceStop failed: [%4.4s]", (char *)&err );
        }

hartman's avatar
hartman committed
823
        /* Remove IOProc callback */
824
825
826
827
828
829
830
831
832
        err = AudioDeviceRemoveIOProc( p_sys->i_selected_dev,
                                       (AudioDeviceIOProc)RenderCallbackSPDIF );
        if( err != noErr )
        {
            msg_Err( p_aout, "AudioDeviceRemoveIOProc failed: [%4.4s]", (char *)&err );
        }
        
        if( p_sys->b_revert )
        {
hartman's avatar
hartman committed
833
            AudioStreamChangeFormat( p_aout, p_sys->i_stream_id, p_sys->sfmt_revert );
834
        }
hartman's avatar
hartman committed
835

836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
        if( p_sys->b_changed_mixing && p_sys->sfmt_revert.mFormatID != kAudioFormat60958AC3 )
        {
            int b_mix;
            Boolean b_writeable;
            /* Revert mixable to true if we are allowed to */
            err = AudioDeviceGetPropertyInfo( p_sys->i_selected_dev, 0, FALSE, kAudioDevicePropertySupportsMixing,
                                        &i_param_size, &b_writeable );

            err = AudioDeviceGetProperty( p_sys->i_selected_dev, 0, FALSE, kAudioDevicePropertySupportsMixing,
                                        &i_param_size, &b_mix );
                                        
            if( !err && b_writeable )
            {
                msg_Dbg( p_aout, "mixable is: %d", b_mix );
                b_mix = 1;
                err = AudioDeviceSetProperty( p_sys->i_selected_dev, 0, 0, FALSE,
                                    kAudioDevicePropertySupportsMixing, i_param_size, &b_mix );
            }

            if( err != noErr )
            {
                msg_Err( p_aout, "failed to set mixmode: [%4.4s]", (char *)&err );
            }
        }
    }

    err = AudioHardwareRemovePropertyListener( kAudioHardwarePropertyDevices,
                                               HardwareListener );
                                               
    if( err != noErr )
    {
        msg_Err( p_aout, "AudioHardwareRemovePropertyListener failed: [%4.4s]", (char *)&err );
    }
    
    if( p_sys->i_hog_pid == getpid() )
    {
        p_sys->i_hog_pid = -1;
        i_param_size = sizeof( p_sys->i_hog_pid );
        err = AudioDeviceSetProperty( p_sys->i_selected_dev, 0, 0, FALSE,
                                         kAudioDevicePropertyHogMode, i_param_size, &p_sys->i_hog_pid );
        if( err != noErr ) msg_Err( p_aout, "Could not release hogmode: [%4.4s]", (char *)&err );
    }
    
    if( p_sys ) free( p_sys );
880
881
882
883
884
885
886
887
888
889
890
}

/*****************************************************************************
 * Play: nothing to do
 *****************************************************************************/
static void Play( aout_instance_t * p_aout )
{
}


/*****************************************************************************
hartman's avatar
hartman committed
891
 * Probe: Check which devices the OS has, and add them to our audio-device menu
892
 *****************************************************************************/
893
static void Probe( aout_instance_t * p_aout )
894
895
{
    OSStatus            err = noErr;
896
897
    UInt32              i = 0, i_param_size = 0;
    AudioDeviceID       devid_def = 0;
898
899
900
901
902
903
904
905
906
907
    AudioDeviceID       *p_devices = NULL;
    vlc_value_t         val, text;

    struct aout_sys_t   *p_sys = p_aout->output.p_sys;

    /* Get number of devices */
    err = AudioHardwareGetPropertyInfo( kAudioHardwarePropertyDevices,
                                        &i_param_size, NULL );
    if( err != noErr )
    {
hartman's avatar
hartman committed
908
        msg_Err( p_aout, "Could not get number of devices: [%4.4s]", (char *)&err );
909
910
911
912
913
914
915
        goto error;
    }

    p_sys->i_devices = i_param_size / sizeof( AudioDeviceID );

    if( p_sys->i_devices < 1 )
    {
hartman's avatar
hartman committed
916
        msg_Err( p_aout, "No audio output devices were found." );
917
918
919
920
921
922
        goto error;
    }

    msg_Dbg( p_aout, "system has [%ld] device(s)", p_sys->i_devices );

    /* Allocate DeviceID array */
923
    p_devices = (AudioDeviceID*)malloc( sizeof(AudioDeviceID) * p_sys->i_devices );
924
925
926
927
928
929
930
931
    if( p_devices == NULL )
    {
        msg_Err( p_aout, "out of memory" );
        goto error;
    }

    /* Populate DeviceID array */
    err = AudioHardwareGetProperty( kAudioHardwarePropertyDevices,
932
                                    &i_param_size, p_devices );
933
934
    if( err != noErr )
    {
hartman's avatar
hartman committed
935
        msg_Err( p_aout, "could not get the device IDs: [%4.4s]", (char *)&err );
936
937
938
939
940
941
        goto error;
    }

    /* Find the ID of the default Device */
    i_param_size = sizeof( AudioDeviceID );
    err = AudioHardwareGetProperty( kAudioHardwarePropertyDefaultOutputDevice,
942
                                    &i_param_size, &devid_def );
943
944
945
946
947
948
949
950
951
952
953
954
955
    if( err != noErr )
    {
        msg_Err( p_aout, "could not get default audio device: [%4.4s]", (char *)&err );
        goto error;
    }
    p_sys->i_default_dev = devid_def;
    
    var_Create( p_aout, "audio-device", VLC_VAR_INTEGER|VLC_VAR_HASCHOICE );
    text.psz_string = _("Audio Device");
    var_Change( p_aout, "audio-device", VLC_VAR_SETTEXT, &text, NULL );
    
    for( i = 0; i < p_sys->i_devices; i++ )
    {
956
957
        char *psz_name;
        i_param_size = 0;
hartman's avatar
hartman committed
958

959
960
        /* Retrieve the length of the device name */
        err = AudioDeviceGetPropertyInfo(
961
962
                    p_devices[i], 0, VLC_FALSE,
                    kAudioDevicePropertyDeviceName,
963
964
                    &i_param_size, NULL);
        if( err ) goto error;
965

966
967
        /* Retrieve the name of the device */
        psz_name = (char *)malloc( i_param_size );
968
969
        err = AudioDeviceGetProperty(
                    p_devices[i], 0, VLC_FALSE,
970
971
972
                    kAudioDevicePropertyDeviceName,
                    &i_param_size, psz_name);
        if( err ) goto error;
973

hartman's avatar
hartman committed
974
        msg_Dbg( p_aout, "DevID: %#lx DevName: %s", p_devices[i], psz_name );
975

hartman's avatar
hartman committed
976
        if( !AudioDeviceHasOutput( p_devices[i]) )
hartman's avatar
hartman committed
977
978
979
980
981
        {
            msg_Dbg( p_aout, "this device is INPUT only. skipping..." );
            continue;
        }

hartman's avatar
hartman committed
982
        /* Add the menu entries */
983
984
        val.i_int = (int)p_devices[i];
        text.psz_string = strdup( psz_name );
985
        var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
986
        if( p_sys->i_default_dev == p_devices[i] )
987
        {
hartman's avatar
hartman committed
988
            /* The default device is the selected device normally */
989
990
991
            var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
            var_Set( p_aout, "audio-device", val );
        }
992

993
        if( AudioDeviceSupportsDigital( p_aout, p_devices[i] ) )
994
995
        {
            val.i_int = (int)p_devices[i] | AOUT_VAR_SPDIF_FLAG;
hartman's avatar
hartman committed
996
            asprintf( &text.psz_string, _("%s (Encoded Output)"), psz_name );
997
998
999
            var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
            if( p_sys->i_default_dev == p_devices[i] && config_GetInt( p_aout, "spdif" ) )
            {
hartman's avatar
hartman committed
1000
                /* I we selected to prefer SPDIF output if available