1 /*****************************************************************************
2 * directx.c: Windows DirectX audio output method
3 *****************************************************************************
4 * Copyright (C) 2001-2009 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
35 #include <vlc_charset.h>
37 #include "windows_audio_common.h"
41 #define FRAME_SIZE ((int)p_aout->output.output.i_rate/20) /* Size in samples */
43 /*****************************************************************************
44 * notification_thread_t: DirectX event thread
45 *****************************************************************************/
46 typedef struct notification_thread_t
50 aout_instance_t *p_aout;
51 int i_frame_size; /* size in bytes of one frame */
52 int i_write_slot; /* current write position in our circular buffer */
57 } notification_thread_t;
59 /*****************************************************************************
60 * aout_sys_t: directx audio output method descriptor
61 *****************************************************************************
62 * This structure is part of the audio output thread descriptor.
63 * It describes the direct sound specific properties of an audio device.
64 *****************************************************************************/
67 HINSTANCE hdsound_dll; /* handle of the opened dsound dll */
69 char * psz_device; /* user defined device name */
72 LPDIRECTSOUND p_dsobject; /* main Direct Sound object */
73 LPDIRECTSOUNDBUFFER p_dsbuffer; /* the sound buffer we use (direct sound
74 * takes care of mixing all the
75 * secondary buffers into the primary) */
77 notification_thread_t *p_notif; /* DirectSoundThread id */
79 int b_playing; /* playing status */
81 int i_frame_size; /* Size in bytes of one frame */
83 int i_speaker_setup; /* Speaker setup override */
85 bool b_chan_reorder; /* do we need channel reordering */
86 int pi_chan_table[AOUT_CHAN_MAX];
87 uint32_t i_channel_mask;
88 uint32_t i_bits_per_sample;
92 /*****************************************************************************
94 *****************************************************************************/
95 static int OpenAudio ( vlc_object_t * );
96 static void CloseAudio ( vlc_object_t * );
97 static void Play ( aout_instance_t * );
100 static void Probe ( aout_instance_t * );
101 static int InitDirectSound ( aout_instance_t * );
102 static int CreateDSBuffer ( aout_instance_t *, int, int, int, int, int, bool );
103 static int CreateDSBufferPCM ( aout_instance_t *, vlc_fourcc_t*, int, int, int, bool );
104 static void DestroyDSBuffer ( aout_instance_t * );
105 static void* DirectSoundThread( vlc_object_t * );
106 static int FillBuffer ( aout_instance_t *, int, aout_buffer_t * );
108 static int ReloadDirectXDevices( vlc_object_t *, char const *,
109 vlc_value_t, vlc_value_t, void * );
111 /* Speaker setup override options list */
112 static const char *const speaker_list[] = { "Windows default", "Mono", "Stereo",
113 "Quad", "5.1", "7.1" };
114 static const char *const ppsz_adev[] = {"default", };
115 static const char *const ppsz_adev_text[] = {"default", };
117 /*****************************************************************************
119 *****************************************************************************/
120 #define DEVICE_TEXT N_("Output device")
121 #define DEVICE_LONGTEXT N_("Select your audio output device")
123 #define SPEAKER_TEXT N_("Speaker configuration")
124 #define SPEAKER_LONGTEXT N_("Select speaker configuration you want to use. " \
125 "This option doesn't upmix! So NO e.g. Stereo -> 5.1 conversion." )
128 set_description( N_("DirectX audio output") )
129 set_shortname( "DirectX" )
130 set_capability( "audio output", 100 )
131 set_category( CAT_AUDIO )
132 set_subcategory( SUBCAT_AUDIO_AOUT )
133 add_shortcut( "directx", "directsound" )
135 add_string( "directx-audio-device-name", "default",
136 DEVICE_TEXT, DEVICE_LONGTEXT, false )
137 add_deprecated_alias( "directx-audio-device" ) /* Since 1.1.0 */
138 change_string_list( ppsz_adev, ppsz_adev_text, ReloadDirectXDevices )
139 change_action_add( ReloadDirectXDevices, N_("Refresh list") )
140 change_need_restart ()
141 add_bool( "directx-audio-float32", false, FLOAT_TEXT,
142 FLOAT_LONGTEXT, true )
143 add_string( "directx-audio-speaker", "Windows default",
144 SPEAKER_TEXT, SPEAKER_LONGTEXT, true )
145 change_string_list( speaker_list, 0, 0 )
146 change_need_restart ()
148 set_callbacks( OpenAudio, CloseAudio )
151 /*****************************************************************************
152 * OpenAudio: open the audio device
153 *****************************************************************************
154 * This function opens and setups Direct Sound.
155 *****************************************************************************/
156 static int OpenAudio( vlc_object_t *p_this )
158 aout_instance_t * p_aout = (aout_instance_t *)p_this;
163 const char * const * ppsz_compare = speaker_list;
165 msg_Dbg( p_aout, "Opening DirectSound Audio Output" );
167 /* Allocate structure */
168 p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
169 if( p_aout->output.p_sys == NULL )
172 /* Initialize some variables */
173 p_aout->output.p_sys->p_dsobject = NULL;
174 p_aout->output.p_sys->p_dsbuffer = NULL;
175 p_aout->output.p_sys->p_notif = NULL;
176 p_aout->output.p_sys->b_playing = 0;
178 p_aout->output.pf_play = Play;
179 aout_VolumeSoftInit( p_aout );
181 /* Retrieve config values */
182 var_Create( p_aout, "directx-audio-float32",
183 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
184 psz_speaker = var_CreateGetString( p_aout, "directx-audio-speaker" );
186 while ( *ppsz_compare != NULL )
188 if ( !strncmp( *ppsz_compare, psz_speaker, strlen(*ppsz_compare) ) )
195 if ( *ppsz_compare == NULL )
197 msg_Err( p_aout, "(%s) isn't valid speaker setup option", psz_speaker );
198 msg_Err( p_aout, "Defaulting to Windows default speaker config");
202 p_aout->output.p_sys->i_speaker_setup = i;
204 p_aout->output.p_sys->p_device_guid = 0;
206 /* Initialise DirectSound */
207 if( InitDirectSound( p_aout ) )
209 msg_Err( p_aout, "cannot initialize DirectSound" );
213 if( var_Type( p_aout, "audio-device" ) == 0 )
218 if( var_Get( p_aout, "audio-device", &val ) < 0 )
220 /* Probe() has failed. */
224 /* Open the device */
225 if( val.i_int == AOUT_VAR_SPDIF )
227 p_aout->output.output.i_format = VLC_CODEC_SPDIFL;
229 /* Calculate the frame size in bytes */
230 p_aout->output.i_nb_samples = A52_FRAME_NB;
231 p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
232 p_aout->output.output.i_frame_length = A52_FRAME_NB;
233 p_aout->output.p_sys->i_frame_size =
234 p_aout->output.output.i_bytes_per_frame;
236 if( CreateDSBuffer( p_aout, VLC_CODEC_SPDIFL,
237 p_aout->output.output.i_physical_channels,
238 aout_FormatNbChannels( &p_aout->output.output ),
239 p_aout->output.output.i_rate,
240 p_aout->output.p_sys->i_frame_size, false )
243 msg_Err( p_aout, "cannot open directx audio device" );
244 free( p_aout->output.p_sys );
248 aout_VolumeNoneInit( p_aout );
252 if( val.i_int == AOUT_VAR_5_1 )
254 p_aout->output.output.i_physical_channels
255 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
256 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
259 else if( val.i_int == AOUT_VAR_7_1 )
261 p_aout->output.output.i_physical_channels
262 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
263 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
264 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT
267 else if( val.i_int == AOUT_VAR_3F2R )
269 p_aout->output.output.i_physical_channels
270 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
271 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
273 else if( val.i_int == AOUT_VAR_2F2R )
275 p_aout->output.output.i_physical_channels
276 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
277 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
279 else if( val.i_int == AOUT_VAR_MONO )
281 p_aout->output.output.i_physical_channels = AOUT_CHAN_CENTER;
285 p_aout->output.output.i_physical_channels
286 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
289 if( CreateDSBufferPCM( p_aout, &p_aout->output.output.i_format,
290 p_aout->output.output.i_physical_channels,
291 aout_FormatNbChannels( &p_aout->output.output ),
292 p_aout->output.output.i_rate, false )
295 msg_Err( p_aout, "cannot open directx audio device" );
296 free( p_aout->output.p_sys );
300 /* Calculate the frame size in bytes */
301 p_aout->output.i_nb_samples = FRAME_SIZE;
302 aout_FormatPrepare( &p_aout->output.output );
303 aout_VolumeSoftInit( p_aout );
306 /* Now we need to setup our DirectSound play notification structure */
307 p_aout->output.p_sys->p_notif =
308 vlc_object_create( p_aout, sizeof(notification_thread_t) );
309 p_aout->output.p_sys->p_notif->p_aout = p_aout;
311 p_aout->output.p_sys->p_notif->event = CreateEvent( 0, FALSE, FALSE, 0 );
312 p_aout->output.p_sys->p_notif->i_frame_size =
313 p_aout->output.p_sys->i_frame_size;
315 /* then launch the notification thread */
316 msg_Dbg( p_aout, "creating DirectSoundThread" );
317 if( vlc_thread_create( p_aout->output.p_sys->p_notif,
319 VLC_THREAD_PRIORITY_HIGHEST ) )
321 msg_Err( p_aout, "cannot create DirectSoundThread" );
322 CloseHandle( p_aout->output.p_sys->p_notif->event );
323 vlc_object_release( p_aout->output.p_sys->p_notif );
324 p_aout->output.p_sys->p_notif = NULL;
328 vlc_object_attach( p_aout->output.p_sys->p_notif, p_aout );
333 CloseAudio( VLC_OBJECT(p_aout) );
337 /*****************************************************************************
338 * Probe: probe the audio device for available formats and channels
339 *****************************************************************************/
340 static void Probe( aout_instance_t * p_aout )
342 vlc_value_t val, text;
343 vlc_fourcc_t i_format;
344 unsigned int i_physical_channels;
345 DWORD ui_speaker_config;
346 bool is_default_output_set = false;
348 var_Create( p_aout, "audio-device", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
349 text.psz_string = _("Audio Device");
350 var_Change( p_aout, "audio-device", VLC_VAR_SETTEXT, &text, NULL );
352 /* Test for 5.1 support */
353 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
354 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
355 AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE;
356 if( p_aout->output.output.i_physical_channels == i_physical_channels )
358 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 6,
359 p_aout->output.output.i_rate, true )
362 val.i_int = AOUT_VAR_5_1;
363 text.psz_string = (char*) "5.1";
364 var_Change( p_aout, "audio-device",
365 VLC_VAR_ADDCHOICE, &val, &text );
366 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
367 is_default_output_set = true;
368 msg_Dbg( p_aout, "device supports 5.1 channels" );
372 /* Test for 7.1 support */
373 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
374 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
375 AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT |
376 AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE;
377 if( p_aout->output.output.i_physical_channels == i_physical_channels )
379 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 8,
380 p_aout->output.output.i_rate, true )
383 val.i_int = AOUT_VAR_7_1;
384 text.psz_string = (char*) "7.1";
385 var_Change( p_aout, "audio-device",
386 VLC_VAR_ADDCHOICE, &val, &text );
387 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
388 is_default_output_set = true;
389 msg_Dbg( p_aout, "device supports 7.1 channels" );
393 /* Test for 3 Front 2 Rear support */
394 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
395 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
397 if( p_aout->output.output.i_physical_channels == i_physical_channels )
399 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 5,
400 p_aout->output.output.i_rate, true )
403 val.i_int = AOUT_VAR_3F2R;
404 text.psz_string = _("3 Front 2 Rear");
405 var_Change( p_aout, "audio-device",
406 VLC_VAR_ADDCHOICE, &val, &text );
407 if(!is_default_output_set)
409 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
410 is_default_output_set = true;
412 msg_Dbg( p_aout, "device supports 5 channels" );
416 /* Test for 2 Front 2 Rear support */
417 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
418 AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
419 if( ( p_aout->output.output.i_physical_channels & i_physical_channels )
420 == i_physical_channels )
422 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 4,
423 p_aout->output.output.i_rate, true )
426 val.i_int = AOUT_VAR_2F2R;
427 text.psz_string = _("2 Front 2 Rear");
428 var_Change( p_aout, "audio-device",
429 VLC_VAR_ADDCHOICE, &val, &text );
430 if(!is_default_output_set)
432 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
433 is_default_output_set = true;
435 msg_Dbg( p_aout, "device supports 4 channels" );
439 /* Test for stereo support */
440 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
441 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 2,
442 p_aout->output.output.i_rate, true )
445 val.i_int = AOUT_VAR_STEREO;
446 text.psz_string = _("Stereo");
447 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
448 if(!is_default_output_set)
450 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
451 is_default_output_set = true;
452 msg_Dbg( p_aout, "device supports 2 channels (DEFAULT!)" );
454 else msg_Dbg( p_aout, "device supports 2 channels" );
457 /* Test for mono support */
458 i_physical_channels = AOUT_CHAN_CENTER;
459 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 1,
460 p_aout->output.output.i_rate, true )
463 val.i_int = AOUT_VAR_MONO;
464 text.psz_string = _("Mono");
465 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
466 msg_Dbg( p_aout, "device supports 1 channel" );
469 /* Check the speaker configuration to determine which channel config should
471 if FAILED( IDirectSound_GetSpeakerConfig( p_aout->output.p_sys->p_dsobject,
472 &ui_speaker_config ) )
474 ui_speaker_config = DSSPEAKER_STEREO;
475 msg_Dbg( p_aout, "GetSpeakerConfig failed" );
477 switch( DSSPEAKER_CONFIG(ui_speaker_config) )
479 case DSSPEAKER_7POINT1:
480 msg_Dbg( p_aout, "Windows says your SpeakerConfig is 7.1" );
481 val.i_int = AOUT_VAR_7_1;
483 case DSSPEAKER_5POINT1:
484 msg_Dbg( p_aout, "Windows says your SpeakerConfig is 5.1" );
485 val.i_int = AOUT_VAR_5_1;
488 msg_Dbg( p_aout, "Windows says your SpeakerConfig is Quad" );
489 val.i_int = AOUT_VAR_2F2R;
491 #if 0 /* Lots of people just get their settings wrong and complain that
492 * this is a problem with VLC so just don't ever set mono by default. */
494 val.i_int = AOUT_VAR_MONO;
497 case DSSPEAKER_SURROUND:
498 msg_Dbg( p_aout, "Windows says your SpeakerConfig is surround" );
499 case DSSPEAKER_STEREO:
500 msg_Dbg( p_aout, "Windows says your SpeakerConfig is stereo" );
502 /* If nothing else is found, choose stereo output */
503 val.i_int = AOUT_VAR_STEREO;
507 /* Check if we want to override speaker config */
508 switch( p_aout->output.p_sys->i_speaker_setup )
510 case 0: /* Default value aka Windows default speaker setup */
513 msg_Dbg( p_aout, "SpeakerConfig is forced to Mono" );
514 val.i_int = AOUT_VAR_MONO;
517 msg_Dbg( p_aout, "SpeakerConfig is forced to Stereo" );
518 val.i_int = AOUT_VAR_STEREO;
521 msg_Dbg( p_aout, "SpeakerConfig is forced to Quad" );
522 val.i_int = AOUT_VAR_2F2R;
525 msg_Dbg( p_aout, "SpeakerConfig is forced to 5.1" );
526 val.i_int = AOUT_VAR_5_1;
529 msg_Dbg( p_aout, "SpeakerConfig is forced to 7.1" );
530 val.i_int = AOUT_VAR_7_1;
533 msg_Dbg( p_aout, "SpeakerConfig is forced to non-existing value" );
537 var_Set( p_aout, "audio-device", val );
539 /* Test for SPDIF support */
540 if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
542 if( CreateDSBuffer( p_aout, VLC_CODEC_SPDIFL,
543 p_aout->output.output.i_physical_channels,
544 aout_FormatNbChannels( &p_aout->output.output ),
545 p_aout->output.output.i_rate,
546 AOUT_SPDIF_SIZE, true )
549 msg_Dbg( p_aout, "device supports A/52 over S/PDIF" );
550 val.i_int = AOUT_VAR_SPDIF;
551 text.psz_string = _("A/52 over S/PDIF");
552 var_Change( p_aout, "audio-device",
553 VLC_VAR_ADDCHOICE, &val, &text );
554 if( var_InheritBool( p_aout, "spdif" ) )
555 var_Set( p_aout, "audio-device", val );
559 var_Change( p_aout, "audio-device", VLC_VAR_CHOICESCOUNT, &val, NULL );
562 /* Probe() has failed. */
563 var_Destroy( p_aout, "audio-device" );
567 var_AddCallback( p_aout, "audio-device", aout_ChannelsRestart, NULL );
568 var_TriggerCallback( p_aout, "intf-change" );
571 /*****************************************************************************
572 * Play: we'll start playing the directsound buffer here because at least here
573 * we know the first buffer has been put in the aout fifo and we also
575 *****************************************************************************/
576 static void Play( aout_instance_t *p_aout )
578 if( !p_aout->output.p_sys->b_playing )
580 aout_buffer_t *p_buffer;
582 p_aout->output.p_sys->b_playing = 1;
584 /* get the playing date of the first aout buffer */
585 p_aout->output.p_sys->p_notif->start_date =
586 aout_FifoFirstDate( p_aout, &p_aout->output.fifo );
588 /* fill in the first samples */
589 for( int i = 0; i < FRAMES_NUM; i++ )
591 p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
592 if( !p_buffer ) break;
593 FillBuffer( p_aout, i, p_buffer );
596 /* wake up the audio output thread */
597 SetEvent( p_aout->output.p_sys->p_notif->event );
601 /*****************************************************************************
602 * CloseAudio: close the audio device
603 *****************************************************************************/
604 static void CloseAudio( vlc_object_t *p_this )
606 aout_instance_t * p_aout = (aout_instance_t *)p_this;
607 aout_sys_t *p_sys = p_aout->output.p_sys;
609 msg_Dbg( p_aout, "closing audio device" );
611 /* kill the position notification thread, if any */
614 vlc_object_kill( p_sys->p_notif );
615 /* wake up the audio thread if needed */
616 if( !p_sys->b_playing ) SetEvent( p_sys->p_notif->event );
618 vlc_thread_join( p_sys->p_notif );
619 vlc_object_release( p_sys->p_notif );
622 /* release the secondary buffer */
623 DestroyDSBuffer( p_aout );
625 /* finally release the DirectSound object */
626 if( p_sys->p_dsobject ) IDirectSound_Release( p_sys->p_dsobject );
628 /* free DSOUND.DLL */
629 if( p_sys->hdsound_dll ) FreeLibrary( p_sys->hdsound_dll );
631 free( p_aout->output.p_sys->p_device_guid );
635 /*****************************************************************************
636 * CallBackDirectSoundEnum: callback to enumerate available devices
637 *****************************************************************************/
638 static int CALLBACK CallBackDirectSoundEnum( LPGUID p_guid, LPCWSTR psz_desc,
639 LPCWSTR psz_mod, LPVOID _p_aout )
641 VLC_UNUSED( psz_mod );
643 aout_instance_t *p_aout = (aout_instance_t *)_p_aout;
645 char *psz_device = FromWide( psz_desc );
646 msg_Dbg( p_aout, "found device: %s", psz_device );
648 if( p_aout->output.p_sys->psz_device &&
649 !strcmp(p_aout->output.p_sys->psz_device, psz_device) && p_guid )
651 /* Use the device corresponding to psz_device */
652 p_aout->output.p_sys->p_device_guid = malloc( sizeof( GUID ) );
653 *p_aout->output.p_sys->p_device_guid = *p_guid;
654 msg_Dbg( p_aout, "using device: %s", psz_device );
658 /* If no default device has been selected, chose the first one */
659 if( !p_aout->output.p_sys->psz_device && p_guid )
661 p_aout->output.p_sys->psz_device = strdup( psz_device );
662 p_aout->output.p_sys->p_device_guid = malloc( sizeof( GUID ) );
663 *p_aout->output.p_sys->p_device_guid = *p_guid;
664 msg_Dbg( p_aout, "using device: %s", psz_device );
672 /*****************************************************************************
673 * InitDirectSound: handle all the gory details of DirectSound initialisation
674 *****************************************************************************/
675 static int InitDirectSound( aout_instance_t *p_aout )
677 HRESULT (WINAPI *OurDirectSoundCreate)(LPGUID, LPDIRECTSOUND *, LPUNKNOWN);
678 HRESULT (WINAPI *OurDirectSoundEnumerate)(LPDSENUMCALLBACKW, LPVOID);
680 p_aout->output.p_sys->hdsound_dll = LoadLibrary("DSOUND.DLL");
681 if( p_aout->output.p_sys->hdsound_dll == NULL )
683 msg_Warn( p_aout, "cannot open DSOUND.DLL" );
687 OurDirectSoundCreate = (void *)
688 GetProcAddress( p_aout->output.p_sys->hdsound_dll,
689 "DirectSoundCreate" );
690 if( OurDirectSoundCreate == NULL )
692 msg_Warn( p_aout, "GetProcAddress FAILED" );
696 /* Get DirectSoundEnumerate */
697 OurDirectSoundEnumerate = (void *)
698 GetProcAddress( p_aout->output.p_sys->hdsound_dll,
699 "DirectSoundEnumerateW" );
700 if( OurDirectSoundEnumerate )
702 p_aout->output.p_sys->psz_device = var_InheritString(p_aout, "directx-audio-device-name");
703 /* Attempt enumeration */
704 if( FAILED( OurDirectSoundEnumerate( CallBackDirectSoundEnum,
707 msg_Dbg( p_aout, "enumeration of DirectSound devices failed" );
711 /* Create the direct sound object */
712 if FAILED( OurDirectSoundCreate( p_aout->output.p_sys->p_device_guid,
713 &p_aout->output.p_sys->p_dsobject,
716 msg_Warn( p_aout, "cannot create a direct sound device" );
720 /* Set DirectSound Cooperative level, ie what control we want over Windows
721 * sound device. In our case, DSSCL_EXCLUSIVE means that we can modify the
722 * settings of the primary buffer, but also that only the sound of our
723 * application will be hearable when it will have the focus.
724 * !!! (this is not really working as intended yet because to set the
725 * cooperative level you need the window handle of your application, and
726 * I don't know of any easy way to get it. Especially since we might play
727 * sound without any video, and so what window handle should we use ???
728 * The hack for now is to use the Desktop window handle - it seems to be
730 if( IDirectSound_SetCooperativeLevel( p_aout->output.p_sys->p_dsobject,
734 msg_Warn( p_aout, "cannot set direct sound cooperative level" );
740 p_aout->output.p_sys->p_dsobject = NULL;
741 if( p_aout->output.p_sys->hdsound_dll )
743 FreeLibrary( p_aout->output.p_sys->hdsound_dll );
744 p_aout->output.p_sys->hdsound_dll = NULL;
750 /*****************************************************************************
751 * CreateDSBuffer: Creates a direct sound buffer of the required format.
752 *****************************************************************************
753 * This function creates the buffer we'll use to play audio.
754 * In DirectSound there are two kinds of buffers:
755 * - the primary buffer: which is the actual buffer that the soundcard plays
756 * - the secondary buffer(s): these buffers are the one actually used by
757 * applications and DirectSound takes care of mixing them into the primary.
759 * Once you create a secondary buffer, you cannot change its format anymore so
760 * you have to release the current one and create another.
761 *****************************************************************************/
762 static int CreateDSBuffer( aout_instance_t *p_aout, int i_format,
763 int i_channels, int i_nb_channels, int i_rate,
764 int i_bytes_per_frame, bool b_probe )
766 WAVEFORMATEXTENSIBLE waveformat;
767 DSBUFFERDESC dsbdesc;
770 /* First set the sound buffer format */
771 waveformat.dwChannelMask = 0;
772 for( i = 0; i < sizeof(pi_channels_src)/sizeof(uint32_t); i++ )
774 if( i_channels & pi_channels_src[i] )
775 waveformat.dwChannelMask |= pi_channels_in[i];
780 case VLC_CODEC_SPDIFL:
782 /* To prevent channel re-ordering */
783 waveformat.dwChannelMask = SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT;
784 waveformat.Format.wBitsPerSample = 16;
785 waveformat.Samples.wValidBitsPerSample =
786 waveformat.Format.wBitsPerSample;
787 waveformat.Format.wFormatTag = WAVE_FORMAT_DOLBY_AC3_SPDIF;
788 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_DOLBY_AC3_SPDIF;
792 waveformat.Format.wBitsPerSample = sizeof(float) * 8;
793 waveformat.Samples.wValidBitsPerSample =
794 waveformat.Format.wBitsPerSample;
795 waveformat.Format.wFormatTag = WAVE_FORMAT_IEEE_FLOAT;
796 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_IEEE_FLOAT;
800 waveformat.Format.wBitsPerSample = 16;
801 waveformat.Samples.wValidBitsPerSample =
802 waveformat.Format.wBitsPerSample;
803 waveformat.Format.wFormatTag = WAVE_FORMAT_PCM;
804 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_PCM;
808 waveformat.Format.nChannels = i_nb_channels;
809 waveformat.Format.nSamplesPerSec = i_rate;
810 waveformat.Format.nBlockAlign =
811 waveformat.Format.wBitsPerSample / 8 * i_nb_channels;
812 waveformat.Format.nAvgBytesPerSec =
813 waveformat.Format.nSamplesPerSec * waveformat.Format.nBlockAlign;
815 p_aout->output.p_sys->i_bits_per_sample = waveformat.Format.wBitsPerSample;
816 p_aout->output.p_sys->i_channels = i_nb_channels;
818 /* Then fill in the direct sound descriptor */
819 memset(&dsbdesc, 0, sizeof(DSBUFFERDESC));
820 dsbdesc.dwSize = sizeof(DSBUFFERDESC);
821 dsbdesc.dwFlags = DSBCAPS_GETCURRENTPOSITION2/* Better position accuracy */
822 | DSBCAPS_GLOBALFOCUS; /* Allows background playing */
824 /* Only use the new WAVE_FORMAT_EXTENSIBLE format for multichannel audio */
825 if( i_nb_channels <= 2 )
827 waveformat.Format.cbSize = 0;
831 waveformat.Format.wFormatTag = WAVE_FORMAT_EXTENSIBLE;
832 waveformat.Format.cbSize =
833 sizeof(WAVEFORMATEXTENSIBLE) - sizeof(WAVEFORMATEX);
835 /* Needed for 5.1 on emu101k */
836 dsbdesc.dwFlags |= DSBCAPS_LOCHARDWARE;
839 dsbdesc.dwBufferBytes = FRAMES_NUM * i_bytes_per_frame; /* buffer size */
840 dsbdesc.lpwfxFormat = (WAVEFORMATEX *)&waveformat;
842 if FAILED( IDirectSound_CreateSoundBuffer(
843 p_aout->output.p_sys->p_dsobject, &dsbdesc,
844 &p_aout->output.p_sys->p_dsbuffer, NULL) )
846 if( dsbdesc.dwFlags & DSBCAPS_LOCHARDWARE )
848 /* Try without DSBCAPS_LOCHARDWARE */
849 dsbdesc.dwFlags &= ~DSBCAPS_LOCHARDWARE;
850 if FAILED( IDirectSound_CreateSoundBuffer(
851 p_aout->output.p_sys->p_dsobject, &dsbdesc,
852 &p_aout->output.p_sys->p_dsbuffer, NULL) )
857 msg_Dbg( p_aout, "couldn't use hardware sound buffer" );
865 /* Stop here if we were just probing */
868 IDirectSoundBuffer_Release( p_aout->output.p_sys->p_dsbuffer );
869 p_aout->output.p_sys->p_dsbuffer = NULL;
873 p_aout->output.p_sys->i_frame_size = i_bytes_per_frame;
874 p_aout->output.p_sys->i_channel_mask = waveformat.dwChannelMask;
875 p_aout->output.p_sys->b_chan_reorder =
876 aout_CheckChannelReorder( pi_channels_in, pi_channels_out,
877 waveformat.dwChannelMask, i_nb_channels,
878 p_aout->output.p_sys->pi_chan_table );
880 if( p_aout->output.p_sys->b_chan_reorder )
882 msg_Dbg( p_aout, "channel reordering needed" );
888 /*****************************************************************************
889 * CreateDSBufferPCM: creates a PCM direct sound buffer.
890 *****************************************************************************
891 * We first try to create a WAVE_FORMAT_IEEE_FLOAT buffer if supported by
892 * the hardware, otherwise we create a WAVE_FORMAT_PCM buffer.
893 ****************************************************************************/
894 static int CreateDSBufferPCM( aout_instance_t *p_aout, vlc_fourcc_t *i_format,
895 int i_channels, int i_nb_channels, int i_rate,
898 /* Float32 audio samples are not supported for 5.1 output on the emu101k */
899 if( !var_GetBool( p_aout, "directx-audio-float32" ) ||
901 CreateDSBuffer( p_aout, VLC_CODEC_FL32,
902 i_channels, i_nb_channels, i_rate,
903 FRAME_SIZE * 4 * i_nb_channels, b_probe )
906 if ( CreateDSBuffer( p_aout, VLC_CODEC_S16L,
907 i_channels, i_nb_channels, i_rate,
908 FRAME_SIZE * 2 * i_nb_channels, b_probe )
915 *i_format = VLC_CODEC_S16L;
921 *i_format = VLC_CODEC_FL32;
926 /*****************************************************************************
928 *****************************************************************************
929 * This function destroys the secondary buffer.
930 *****************************************************************************/
931 static void DestroyDSBuffer( aout_instance_t *p_aout )
933 if( p_aout->output.p_sys->p_dsbuffer )
935 IDirectSoundBuffer_Release( p_aout->output.p_sys->p_dsbuffer );
936 p_aout->output.p_sys->p_dsbuffer = NULL;
940 /*****************************************************************************
941 * FillBuffer: Fill in one of the direct sound frame buffers.
942 *****************************************************************************
943 * Returns VLC_SUCCESS on success.
944 *****************************************************************************/
945 static int FillBuffer( aout_instance_t *p_aout, int i_frame,
946 aout_buffer_t *p_buffer )
948 notification_thread_t *p_notif = p_aout->output.p_sys->p_notif;
949 aout_sys_t *p_sys = p_aout->output.p_sys;
950 void *p_write_position, *p_wrap_around;
951 unsigned long l_bytes1, l_bytes2;
954 /* Before copying anything, we have to lock the buffer */
955 dsresult = IDirectSoundBuffer_Lock(
956 p_sys->p_dsbuffer, /* DS buffer */
957 i_frame * p_notif->i_frame_size, /* Start offset */
958 p_notif->i_frame_size, /* Number of bytes */
959 &p_write_position, /* Address of lock start */
960 &l_bytes1, /* Count of bytes locked before wrap around */
961 &p_wrap_around, /* Buffer address (if wrap around) */
962 &l_bytes2, /* Count of bytes after wrap around */
964 if( dsresult == DSERR_BUFFERLOST )
966 IDirectSoundBuffer_Restore( p_sys->p_dsbuffer );
967 dsresult = IDirectSoundBuffer_Lock(
969 i_frame * p_notif->i_frame_size,
970 p_notif->i_frame_size,
977 if( dsresult != DS_OK )
979 msg_Warn( p_notif, "cannot lock buffer" );
980 if( p_buffer ) aout_BufferFree( p_buffer );
984 if( p_buffer == NULL )
986 memset( p_write_position, 0, l_bytes1 );
990 if( p_sys->b_chan_reorder )
992 /* Do the channel reordering here */
993 aout_ChannelReorder( p_buffer->p_buffer, p_buffer->i_buffer,
994 p_sys->i_channels, p_sys->pi_chan_table,
995 p_sys->i_bits_per_sample );
998 vlc_memcpy( p_write_position, p_buffer->p_buffer, l_bytes1 );
999 aout_BufferFree( p_buffer );
1002 /* Now the data has been copied, unlock the buffer */
1003 IDirectSoundBuffer_Unlock( p_sys->p_dsbuffer, p_write_position, l_bytes1,
1004 p_wrap_around, l_bytes2 );
1006 p_notif->i_write_slot = (i_frame + 1) % FRAMES_NUM;
1010 /*****************************************************************************
1011 * DirectSoundThread: this thread will capture play notification events.
1012 *****************************************************************************
1013 * We use this thread to emulate a callback mechanism. The thread probes for
1014 * event notification and fills up the DS secondary buffer when needed.
1015 *****************************************************************************/
1016 static void* DirectSoundThread( vlc_object_t *p_this )
1018 notification_thread_t *p_notif = (notification_thread_t*)p_this;
1019 aout_instance_t *p_aout = p_notif->p_aout;
1021 int canc = vlc_savecancel ();
1023 /* We don't want any resampling when using S/PDIF output */
1024 bool b_sleek = (p_aout->output.output.i_format == VLC_CODEC_SPDIFL);
1026 msg_Dbg( p_notif, "DirectSoundThread ready" );
1028 /* Wait here until Play() is called */
1029 WaitForSingleObject( p_notif->event, INFINITE );
1031 if( vlc_object_alive (p_notif) )
1034 mwait( p_notif->start_date - AOUT_PTS_TOLERANCE / 2 );
1036 /* start playing the buffer */
1037 dsresult = IDirectSoundBuffer_Play( p_aout->output.p_sys->p_dsbuffer,
1040 DSBPLAY_LOOPING ); /* Flags */
1041 if( dsresult == DSERR_BUFFERLOST )
1043 IDirectSoundBuffer_Restore( p_aout->output.p_sys->p_dsbuffer );
1044 dsresult = IDirectSoundBuffer_Play(
1045 p_aout->output.p_sys->p_dsbuffer,
1048 DSBPLAY_LOOPING ); /* Flags */
1050 if( dsresult != DS_OK )
1052 msg_Err( p_aout, "cannot start playing buffer" );
1055 last_time = mdate();
1057 while( vlc_object_alive (p_notif) )
1060 int l_queued = 0, l_free_slots;
1061 unsigned i_frame_siz = p_aout->output.i_nb_samples;
1062 mtime_t mtime = mdate();
1066 * Fill in as much audio data as we can in our circular buffer
1069 /* Find out current play position */
1070 if FAILED( IDirectSoundBuffer_GetCurrentPosition(
1071 p_aout->output.p_sys->p_dsbuffer, &l_read, NULL ) )
1073 msg_Err( p_aout, "GetCurrentPosition() failed!" );
1077 /* Detect underruns */
1078 if( l_queued && mtime - last_time >
1079 INT64_C(1000000) * l_queued / p_aout->output.output.i_rate )
1081 msg_Dbg( p_aout, "detected underrun!" );
1085 /* Try to fill in as many frame buffers as possible */
1086 l_read /= (p_aout->output.output.i_bytes_per_frame /
1087 p_aout->output.output.i_frame_length);
1088 l_queued = p_notif->i_write_slot * i_frame_siz - l_read;
1089 if( l_queued < 0 ) l_queued += (i_frame_siz * FRAMES_NUM);
1090 l_free_slots = (FRAMES_NUM * i_frame_siz - l_queued) / i_frame_siz;
1092 for( i = 0; i < l_free_slots; i++ )
1094 aout_buffer_t *p_buffer = aout_OutputNextBuffer( p_aout,
1095 mtime + INT64_C(1000000) * (i * i_frame_siz + l_queued) /
1096 p_aout->output.output.i_rate, b_sleek );
1098 /* If there is no audio data available and we have some buffered
1099 * already, then just wait for the next time */
1100 if( !p_buffer && (i || l_queued / i_frame_siz) ) break;
1102 if( FillBuffer( p_aout, p_notif->i_write_slot % FRAMES_NUM,
1103 p_buffer ) != VLC_SUCCESS ) break;
1106 /* Sleep a reasonable amount of time */
1107 l_queued += (i * i_frame_siz);
1108 msleep( INT64_C(1000000) * l_queued / p_aout->output.output.i_rate / 2 );
1111 /* make sure the buffer isn't playing */
1112 IDirectSoundBuffer_Stop( p_aout->output.p_sys->p_dsbuffer );
1114 /* free the event */
1115 CloseHandle( p_notif->event );
1117 vlc_restorecancel (canc);
1118 msg_Dbg( p_notif, "DirectSoundThread exiting" );
1122 /*****************************************************************************
1123 * CallBackConfigNBEnum: callback to get the number of available devices
1124 *****************************************************************************/
1125 static int CALLBACK CallBackConfigNBEnum( LPGUID p_guid, LPCWSTR psz_desc,
1126 LPCWSTR psz_mod, LPVOID p_nb )
1128 VLC_UNUSED( psz_mod ); VLC_UNUSED( psz_desc ); VLC_UNUSED( p_guid );
1130 int * a = (int *)p_nb;
1135 /*****************************************************************************
1136 * CallBackConfigEnum: callback to add available devices to the preferences list
1137 *****************************************************************************/
1138 static int CALLBACK CallBackConfigEnum( LPGUID p_guid, LPCWSTR psz_desc,
1139 LPCWSTR psz_mod, LPVOID _p_item )
1141 VLC_UNUSED( psz_mod ); VLC_UNUSED( p_guid );
1143 module_config_t *p_item = (module_config_t *) _p_item;
1145 p_item->ppsz_list[p_item->i_list] = FromWide( psz_desc );
1146 p_item->ppsz_list_text[p_item->i_list] = FromWide( psz_desc );
1151 /*****************************************************************************
1152 * ReloadDirectXDevices: store the list of devices in preferences
1153 *****************************************************************************/
1154 static int ReloadDirectXDevices( vlc_object_t *p_this, char const *psz_name,
1155 vlc_value_t newval, vlc_value_t oldval, void *data )
1157 VLC_UNUSED( newval ); VLC_UNUSED( oldval ); VLC_UNUSED( data );
1159 module_config_t *p_item = config_FindConfig( p_this, psz_name );
1160 if( !p_item ) return VLC_SUCCESS;
1162 /* Clear-up the current list */
1163 if( p_item->i_list )
1165 for( int i = 0; i < p_item->i_list; i++ )
1167 free((char *)(p_item->ppsz_list[i]) );
1168 free((char *)(p_item->ppsz_list_text[i]) );
1172 HRESULT (WINAPI *OurDirectSoundEnumerate)(LPDSENUMCALLBACKW, LPVOID);
1174 HANDLE hdsound_dll = LoadLibrary("DSOUND.DLL");
1175 if( hdsound_dll == NULL )
1177 msg_Warn( p_this, "cannot open DSOUND.DLL" );
1181 /* Get DirectSoundEnumerate */
1182 OurDirectSoundEnumerate = (void *)
1183 GetProcAddress( hdsound_dll, "DirectSoundEnumerateW" );
1185 if( OurDirectSoundEnumerate == NULL )
1189 OurDirectSoundEnumerate(CallBackConfigNBEnum, &nb_devices);
1190 msg_Dbg(p_this,"found %d devices", nb_devices);
1192 p_item->ppsz_list = xrealloc( p_item->ppsz_list,
1193 nb_devices * sizeof(char *) );
1194 p_item->ppsz_list_text = xrealloc( p_item->ppsz_list_text,
1195 nb_devices * sizeof(char *) );
1198 OurDirectSoundEnumerate(CallBackConfigEnum, p_item);
1200 /* Signal change to the interface */
1201 p_item->b_dirty = true;
1204 FreeLibrary(hdsound_dll);