1 /*****************************************************************************
2 * directx.c: Windows DirectX audio output method
3 *****************************************************************************
4 * Copyright (C) 2001 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
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
41 #define FRAME_SIZE ((int)p_aout->output.output.i_rate/20) /* Size in samples */
42 #define FRAMES_NUM 8 /* Needs to be > 3 */
44 /*****************************************************************************
46 * Defining them here allows us to get rid of the dxguid library during
48 *****************************************************************************/
51 /*****************************************************************************
53 *****************************************************************************/
54 #ifndef WAVE_FORMAT_IEEE_FLOAT
55 # define WAVE_FORMAT_IEEE_FLOAT 0x0003
58 #ifndef WAVE_FORMAT_DOLBY_AC3_SPDIF
59 # define WAVE_FORMAT_DOLBY_AC3_SPDIF 0x0092
62 #ifndef WAVE_FORMAT_EXTENSIBLE
63 #define WAVE_FORMAT_EXTENSIBLE 0xFFFE
66 #ifndef SPEAKER_FRONT_LEFT
67 # define SPEAKER_FRONT_LEFT 0x1
68 # define SPEAKER_FRONT_RIGHT 0x2
69 # define SPEAKER_FRONT_CENTER 0x4
70 # define SPEAKER_LOW_FREQUENCY 0x8
71 # define SPEAKER_BACK_LEFT 0x10
72 # define SPEAKER_BACK_RIGHT 0x20
73 # define SPEAKER_FRONT_LEFT_OF_CENTER 0x40
74 # define SPEAKER_FRONT_RIGHT_OF_CENTER 0x80
75 # define SPEAKER_BACK_CENTER 0x100
76 # define SPEAKER_SIDE_LEFT 0x200
77 # define SPEAKER_SIDE_RIGHT 0x400
78 # define SPEAKER_TOP_CENTER 0x800
79 # define SPEAKER_TOP_FRONT_LEFT 0x1000
80 # define SPEAKER_TOP_FRONT_CENTER 0x2000
81 # define SPEAKER_TOP_FRONT_RIGHT 0x4000
82 # define SPEAKER_TOP_BACK_LEFT 0x8000
83 # define SPEAKER_TOP_BACK_CENTER 0x10000
84 # define SPEAKER_TOP_BACK_RIGHT 0x20000
85 # define SPEAKER_RESERVED 0x80000000
88 #ifndef DSSPEAKER_DSSPEAKER_DIRECTOUT
89 # define DSSPEAKER_DSSPEAKER_DIRECTOUT 0x00000000
91 #ifndef DSSPEAKER_HEADPHONE
92 # define DSSPEAKER_HEADPHONE 0x00000001
94 #ifndef DSSPEAKER_MONO
95 # define DSSPEAKER_MONO 0x00000002
97 #ifndef DSSPEAKER_QUAD
98 # define DSSPEAKER_QUAD 0x00000003
100 #ifndef DSSPEAKER_STEREO
101 # define DSSPEAKER_STEREO 0x00000004
103 #ifndef DSSPEAKER_SURROUND
104 # define DSSPEAKER_SURROUND 0x00000005
106 #ifndef DSSPEAKER_5POINT1
107 # define DSSPEAKER_5POINT1 0x00000006
109 #ifndef DSSPEAKER_7POINT1
110 # define DSSPEAKER_7POINT1 0x00000007
112 #ifndef DSSPEAKER_7POINT1_SURROUND
113 # define DSSPEAKER_7POINT1_SURROUND 0x00000008
115 #ifndef DSSPEAKER_7POINT1_WIDE
116 # define DSSPEAKER_7POINT1_WIDE DSSPEAKER_7POINT1
119 #ifndef _WAVEFORMATEXTENSIBLE_
123 WORD wValidBitsPerSample; /* bits of precision */
124 WORD wSamplesPerBlock; /* valid if wBitsPerSample==0 */
125 WORD wReserved; /* If neither applies, set to zero. */
127 DWORD dwChannelMask; /* which channels are */
128 /* present in stream */
130 } WAVEFORMATEXTENSIBLE, *PWAVEFORMATEXTENSIBLE;
133 DEFINE_GUID( _KSDATAFORMAT_SUBTYPE_IEEE_FLOAT, WAVE_FORMAT_IEEE_FLOAT, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 );
134 DEFINE_GUID( _KSDATAFORMAT_SUBTYPE_PCM, WAVE_FORMAT_PCM, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 );
135 DEFINE_GUID( _KSDATAFORMAT_SUBTYPE_DOLBY_AC3_SPDIF, WAVE_FORMAT_DOLBY_AC3_SPDIF, 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 );
137 /*****************************************************************************
138 * notification_thread_t: DirectX event thread
139 *****************************************************************************/
140 typedef struct notification_thread_t
144 aout_instance_t *p_aout;
145 int i_frame_size; /* size in bytes of one frame */
146 int i_write_slot; /* current write position in our circular buffer */
151 } notification_thread_t;
153 /*****************************************************************************
154 * aout_sys_t: directx audio output method descriptor
155 *****************************************************************************
156 * This structure is part of the audio output thread descriptor.
157 * It describes the direct sound specific properties of an audio device.
158 *****************************************************************************/
161 HINSTANCE hdsound_dll; /* handle of the opened dsound dll */
163 int i_device_id; /* user defined device */
164 LPGUID p_device_guid;
166 LPDIRECTSOUND p_dsobject; /* main Direct Sound object */
167 LPDIRECTSOUNDBUFFER p_dsbuffer; /* the sound buffer we use (direct sound
168 * takes care of mixing all the
169 * secondary buffers into the primary) */
171 notification_thread_t *p_notif; /* DirectSoundThread id */
173 int b_playing; /* playing status */
175 int i_frame_size; /* Size in bytes of one frame */
177 bool b_chan_reorder; /* do we need channel reordering */
178 int pi_chan_table[AOUT_CHAN_MAX];
179 uint32_t i_channel_mask;
180 uint32_t i_bits_per_sample;
184 static const uint32_t pi_channels_src[] =
185 { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
186 AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
187 AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
188 AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0 };
189 static const uint32_t pi_channels_in[] =
190 { SPEAKER_FRONT_LEFT, SPEAKER_FRONT_RIGHT,
191 SPEAKER_SIDE_LEFT, SPEAKER_SIDE_RIGHT,
192 SPEAKER_BACK_LEFT, SPEAKER_BACK_RIGHT, SPEAKER_BACK_CENTER,
193 SPEAKER_FRONT_CENTER, SPEAKER_LOW_FREQUENCY, 0 };
194 static const uint32_t pi_channels_out[] =
195 { SPEAKER_FRONT_LEFT, SPEAKER_FRONT_RIGHT,
196 SPEAKER_FRONT_CENTER, SPEAKER_LOW_FREQUENCY,
197 SPEAKER_BACK_LEFT, SPEAKER_BACK_RIGHT,
199 SPEAKER_SIDE_LEFT, SPEAKER_SIDE_RIGHT, 0 };
201 /*****************************************************************************
203 *****************************************************************************/
204 static int OpenAudio ( vlc_object_t * );
205 static void CloseAudio ( vlc_object_t * );
206 static void Play ( aout_instance_t * );
208 /* local functions */
209 static void Probe ( aout_instance_t * );
210 static int InitDirectSound ( aout_instance_t * );
211 static int CreateDSBuffer ( aout_instance_t *, int, int, int, int, int, bool );
212 static int CreateDSBufferPCM ( aout_instance_t *, int*, int, int, int, bool );
213 static void DestroyDSBuffer ( aout_instance_t * );
214 static void* DirectSoundThread( vlc_object_t * );
215 static int FillBuffer ( aout_instance_t *, int, aout_buffer_t * );
217 /*****************************************************************************
219 *****************************************************************************/
220 #define DEVICE_TEXT N_("Output device")
221 #define DEVICE_LONGTEXT N_( \
222 "DirectX device number: 0 default device, 1..N device by number" \
223 "(Note that the default device appears as 0 AND another number)." )
224 #define FLOAT_TEXT N_("Use float32 output")
225 #define FLOAT_LONGTEXT N_( \
226 "The option allows you to enable or disable the high-quality float32 " \
227 "audio output mode (which is not well supported by some soundcards)." )
230 set_description( N_("DirectX audio output") );
231 set_shortname( "DirectX" );
232 set_capability( "audio output", 100 );
233 set_category( CAT_AUDIO );
234 set_subcategory( SUBCAT_AUDIO_AOUT );
235 add_shortcut( "directx" );
236 add_integer( "directx-audio-device", 0, NULL, DEVICE_TEXT,
237 DEVICE_LONGTEXT, true );
238 add_bool( "directx-audio-float32", 0, 0, FLOAT_TEXT,
239 FLOAT_LONGTEXT, true );
240 set_callbacks( OpenAudio, CloseAudio );
243 /*****************************************************************************
244 * OpenAudio: open the audio device
245 *****************************************************************************
246 * This function opens and setups Direct Sound.
247 *****************************************************************************/
248 static int OpenAudio( vlc_object_t *p_this )
250 aout_instance_t * p_aout = (aout_instance_t *)p_this;
253 msg_Dbg( p_aout, "OpenAudio" );
255 /* Allocate structure */
256 p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
257 if( p_aout->output.p_sys == NULL )
260 /* Initialize some variables */
261 p_aout->output.p_sys->p_dsobject = NULL;
262 p_aout->output.p_sys->p_dsbuffer = NULL;
263 p_aout->output.p_sys->p_notif = NULL;
264 p_aout->output.p_sys->b_playing = 0;
266 p_aout->output.pf_play = Play;
267 aout_VolumeSoftInit( p_aout );
269 /* Retrieve config values */
270 var_Create( p_aout, "directx-audio-float32",
271 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
272 var_Create( p_aout, "directx-audio-device",
273 VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
274 var_Get( p_aout, "directx-audio-device", &val );
275 p_aout->output.p_sys->i_device_id = val.i_int;
276 p_aout->output.p_sys->p_device_guid = 0;
278 /* Initialise DirectSound */
279 if( InitDirectSound( p_aout ) )
281 msg_Err( p_aout, "cannot initialize DirectSound" );
285 if( var_Type( p_aout, "audio-device" ) == 0 )
290 if( var_Get( p_aout, "audio-device", &val ) < 0 )
292 /* Probe() has failed. */
296 /* Open the device */
297 if( val.i_int == AOUT_VAR_SPDIF )
299 p_aout->output.output.i_format = VLC_FOURCC('s','p','d','i');
301 /* Calculate the frame size in bytes */
302 p_aout->output.i_nb_samples = A52_FRAME_NB;
303 p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
304 p_aout->output.output.i_frame_length = A52_FRAME_NB;
305 p_aout->output.p_sys->i_frame_size =
306 p_aout->output.output.i_bytes_per_frame;
308 if( CreateDSBuffer( p_aout, VLC_FOURCC('s','p','d','i'),
309 p_aout->output.output.i_physical_channels,
310 aout_FormatNbChannels( &p_aout->output.output ),
311 p_aout->output.output.i_rate,
312 p_aout->output.p_sys->i_frame_size, false )
315 msg_Err( p_aout, "cannot open directx audio device" );
316 free( p_aout->output.p_sys );
320 aout_VolumeNoneInit( p_aout );
324 if( val.i_int == AOUT_VAR_5_1 )
326 p_aout->output.output.i_physical_channels
327 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
328 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
331 else if( val.i_int == AOUT_VAR_7_1 )
333 p_aout->output.output.i_physical_channels
334 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
335 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
336 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT
339 else if( val.i_int == AOUT_VAR_3F2R )
341 p_aout->output.output.i_physical_channels
342 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
343 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
345 else if( val.i_int == AOUT_VAR_2F2R )
347 p_aout->output.output.i_physical_channels
348 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
349 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
351 else if( val.i_int == AOUT_VAR_MONO )
353 p_aout->output.output.i_physical_channels = AOUT_CHAN_CENTER;
357 p_aout->output.output.i_physical_channels
358 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
361 if( CreateDSBufferPCM( p_aout, &p_aout->output.output.i_format,
362 p_aout->output.output.i_physical_channels,
363 aout_FormatNbChannels( &p_aout->output.output ),
364 p_aout->output.output.i_rate, false )
367 msg_Err( p_aout, "cannot open directx audio device" );
368 free( p_aout->output.p_sys );
372 /* Calculate the frame size in bytes */
373 p_aout->output.i_nb_samples = FRAME_SIZE;
374 aout_FormatPrepare( &p_aout->output.output );
375 aout_VolumeSoftInit( p_aout );
378 /* Now we need to setup our DirectSound play notification structure */
379 p_aout->output.p_sys->p_notif =
380 vlc_object_create( p_aout, sizeof(notification_thread_t) );
381 p_aout->output.p_sys->p_notif->p_aout = p_aout;
383 p_aout->output.p_sys->p_notif->event = CreateEvent( 0, FALSE, FALSE, 0 );
384 p_aout->output.p_sys->p_notif->i_frame_size =
385 p_aout->output.p_sys->i_frame_size;
387 /* then launch the notification thread */
388 msg_Dbg( p_aout, "creating DirectSoundThread" );
389 if( vlc_thread_create( p_aout->output.p_sys->p_notif,
390 "DirectSound Notification Thread",
392 VLC_THREAD_PRIORITY_HIGHEST, false ) )
394 msg_Err( p_aout, "cannot create DirectSoundThread" );
395 CloseHandle( p_aout->output.p_sys->p_notif->event );
396 vlc_object_release( p_aout->output.p_sys->p_notif );
397 p_aout->output.p_sys->p_notif = NULL;
401 vlc_object_attach( p_aout->output.p_sys->p_notif, p_aout );
406 CloseAudio( VLC_OBJECT(p_aout) );
410 /*****************************************************************************
411 * Probe: probe the audio device for available formats and channels
412 *****************************************************************************/
413 static void Probe( aout_instance_t * p_aout )
415 vlc_value_t val, text;
417 unsigned int i_physical_channels;
418 DWORD ui_speaker_config;
419 bool is_default_output_set = false;
421 var_Create( p_aout, "audio-device", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
422 text.psz_string = _("Audio Device");
423 var_Change( p_aout, "audio-device", VLC_VAR_SETTEXT, &text, NULL );
425 /* Test for 5.1 support */
426 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
427 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
428 AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE;
429 if( p_aout->output.output.i_physical_channels == i_physical_channels )
431 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 6,
432 p_aout->output.output.i_rate, true )
435 val.i_int = AOUT_VAR_5_1;
436 text.psz_string = "5.1";
437 var_Change( p_aout, "audio-device",
438 VLC_VAR_ADDCHOICE, &val, &text );
439 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
440 is_default_output_set = true;
441 msg_Dbg( p_aout, "device supports 5.1 channels" );
445 /* Test for 7.1 support */
446 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
447 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
448 AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT |
449 AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE;
450 if( p_aout->output.output.i_physical_channels == i_physical_channels )
452 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 8,
453 p_aout->output.output.i_rate, true )
456 val.i_int = AOUT_VAR_7_1;
457 text.psz_string = "7.1";
458 var_Change( p_aout, "audio-device",
459 VLC_VAR_ADDCHOICE, &val, &text );
460 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
461 is_default_output_set = true;
462 msg_Dbg( p_aout, "device supports 7.1 channels" );
466 /* Test for 3 Front 2 Rear support */
467 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
468 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
470 if( p_aout->output.output.i_physical_channels == i_physical_channels )
472 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 5,
473 p_aout->output.output.i_rate, true )
476 val.i_int = AOUT_VAR_3F2R;
477 text.psz_string = N_("3 Front 2 Rear");
478 var_Change( p_aout, "audio-device",
479 VLC_VAR_ADDCHOICE, &val, &text );
480 if(!is_default_output_set)
482 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
483 is_default_output_set = true;
485 msg_Dbg( p_aout, "device supports 5 channels" );
489 /* Test for 2 Front 2 Rear support */
490 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
491 AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
492 if( ( p_aout->output.output.i_physical_channels & i_physical_channels )
493 == i_physical_channels )
495 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 4,
496 p_aout->output.output.i_rate, true )
499 val.i_int = AOUT_VAR_2F2R;
500 text.psz_string = N_("2 Front 2 Rear");
501 var_Change( p_aout, "audio-device",
502 VLC_VAR_ADDCHOICE, &val, &text );
503 if(!is_default_output_set)
505 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
506 is_default_output_set = true;
508 msg_Dbg( p_aout, "device supports 4 channels" );
512 /* Test for stereo support */
513 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
514 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 2,
515 p_aout->output.output.i_rate, true )
518 val.i_int = AOUT_VAR_STEREO;
519 text.psz_string = N_("Stereo");
520 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
521 if(!is_default_output_set)
523 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
524 is_default_output_set = true;
525 msg_Dbg( p_aout, "device supports 2 channels (DEFAULT!)" );
527 msg_Dbg( p_aout, "device supports 2 channels" );
530 /* Test for mono support */
531 i_physical_channels = AOUT_CHAN_CENTER;
532 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 1,
533 p_aout->output.output.i_rate, true )
536 val.i_int = AOUT_VAR_MONO;
537 text.psz_string = N_("Mono");
538 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
539 msg_Dbg( p_aout, "device supports 1 channel" );
542 /* Check the speaker configuration to determine which channel config should
544 if FAILED( IDirectSound_GetSpeakerConfig( p_aout->output.p_sys->p_dsobject,
545 &ui_speaker_config ) )
547 ui_speaker_config = DSSPEAKER_STEREO;
548 msg_Dbg( p_aout, "GetSpeakerConfig failed" );
550 switch( DSSPEAKER_CONFIG(ui_speaker_config) )
552 case DSSPEAKER_7POINT1:
553 msg_Dbg( p_aout, "Windows says your SpeakerConfig is 7.1" );
554 val.i_int = AOUT_VAR_7_1;
556 case DSSPEAKER_5POINT1:
557 msg_Dbg( p_aout, "Windows says your SpeakerConfig is 5.1" );
558 val.i_int = AOUT_VAR_5_1;
561 msg_Dbg( p_aout, "Windows says your SpeakerConfig is Quad" );
562 val.i_int = AOUT_VAR_2F2R;
564 #if 0 /* Lots of people just get their settings wrong and complain that
565 * this is a problem with VLC so just don't ever set mono by default. */
567 val.i_int = AOUT_VAR_MONO;
570 case DSSPEAKER_SURROUND:
571 msg_Dbg( p_aout, "Windows says your SpeakerConfig is surround" );
572 case DSSPEAKER_STEREO:
573 msg_Dbg( p_aout, "Windows says your SpeakerConfig is stereo" );
575 /* If nothing else is found, choose stereo output */
576 val.i_int = AOUT_VAR_STEREO;
579 var_Set( p_aout, "audio-device", val );
581 /* Test for SPDIF support */
582 if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
584 if( CreateDSBuffer( p_aout, VLC_FOURCC('s','p','d','i'),
585 p_aout->output.output.i_physical_channels,
586 aout_FormatNbChannels( &p_aout->output.output ),
587 p_aout->output.output.i_rate,
588 AOUT_SPDIF_SIZE, true )
591 msg_Dbg( p_aout, "device supports A/52 over S/PDIF" );
592 val.i_int = AOUT_VAR_SPDIF;
593 text.psz_string = N_("A/52 over S/PDIF");
594 var_Change( p_aout, "audio-device",
595 VLC_VAR_ADDCHOICE, &val, &text );
596 if( config_GetInt( p_aout, "spdif" ) )
597 var_Set( p_aout, "audio-device", val );
601 var_Change( p_aout, "audio-device", VLC_VAR_CHOICESCOUNT, &val, NULL );
604 /* Probe() has failed. */
605 var_Destroy( p_aout, "audio-device" );
609 var_AddCallback( p_aout, "audio-device", aout_ChannelsRestart, NULL );
612 var_Set( p_aout, "intf-change", val );
615 /*****************************************************************************
616 * Play: we'll start playing the directsound buffer here because at least here
617 * we know the first buffer has been put in the aout fifo and we also
619 *****************************************************************************/
620 static void Play( aout_instance_t *p_aout )
622 if( !p_aout->output.p_sys->b_playing )
624 aout_buffer_t *p_buffer;
627 p_aout->output.p_sys->b_playing = 1;
629 /* get the playing date of the first aout buffer */
630 p_aout->output.p_sys->p_notif->start_date =
631 aout_FifoFirstDate( p_aout, &p_aout->output.fifo );
633 /* fill in the first samples */
634 for( i = 0; i < FRAMES_NUM; i++ )
636 p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
637 if( !p_buffer ) break;
638 FillBuffer( p_aout, i, p_buffer );
641 /* wake up the audio output thread */
642 SetEvent( p_aout->output.p_sys->p_notif->event );
646 /*****************************************************************************
647 * CloseAudio: close the audio device
648 *****************************************************************************/
649 static void CloseAudio( vlc_object_t *p_this )
651 aout_instance_t * p_aout = (aout_instance_t *)p_this;
652 aout_sys_t *p_sys = p_aout->output.p_sys;
654 msg_Dbg( p_aout, "closing audio device" );
656 /* kill the position notification thread, if any */
659 vlc_object_detach( p_sys->p_notif );
660 vlc_object_kill( p_sys->p_notif );
661 /* wake up the audio thread if needed */
662 if( !p_sys->b_playing ) SetEvent( p_sys->p_notif->event );
664 vlc_thread_join( p_sys->p_notif );
665 vlc_object_release( p_sys->p_notif );
668 /* release the secondary buffer */
669 DestroyDSBuffer( p_aout );
671 /* finally release the DirectSound object */
672 if( p_sys->p_dsobject ) IDirectSound_Release( p_sys->p_dsobject );
674 /* free DSOUND.DLL */
675 if( p_sys->hdsound_dll ) FreeLibrary( p_sys->hdsound_dll );
677 free( p_aout->output.p_sys->p_device_guid );
681 /*****************************************************************************
682 * CallBackDirectSoundEnum: callback to enumerate available devices
683 *****************************************************************************/
684 static int CALLBACK CallBackDirectSoundEnum( LPGUID p_guid, LPCSTR psz_desc,
685 LPCSTR psz_mod, LPVOID _p_aout )
687 aout_instance_t *p_aout = (aout_instance_t *)_p_aout;
689 msg_Dbg( p_aout, "found device: %s", psz_desc );
691 if( p_aout->output.p_sys->i_device_id == 0 && p_guid )
693 p_aout->output.p_sys->p_device_guid = malloc( sizeof( GUID ) );
694 *p_aout->output.p_sys->p_device_guid = *p_guid;
695 msg_Dbg( p_aout, "using device: %s", psz_desc );
698 p_aout->output.p_sys->i_device_id--;
702 /*****************************************************************************
703 * InitDirectSound: handle all the gory details of DirectSound initialisation
704 *****************************************************************************/
705 static int InitDirectSound( aout_instance_t *p_aout )
707 HRESULT (WINAPI *OurDirectSoundCreate)(LPGUID, LPDIRECTSOUND *, LPUNKNOWN);
708 HRESULT (WINAPI *OurDirectSoundEnumerate)(LPDSENUMCALLBACK, LPVOID);
710 p_aout->output.p_sys->hdsound_dll = LoadLibrary("DSOUND.DLL");
711 if( p_aout->output.p_sys->hdsound_dll == NULL )
713 msg_Warn( p_aout, "cannot open DSOUND.DLL" );
717 OurDirectSoundCreate = (void *)
718 GetProcAddress( p_aout->output.p_sys->hdsound_dll,
719 "DirectSoundCreate" );
720 if( OurDirectSoundCreate == NULL )
722 msg_Warn( p_aout, "GetProcAddress FAILED" );
726 /* Get DirectSoundEnumerate */
727 OurDirectSoundEnumerate = (void *)
728 GetProcAddress( p_aout->output.p_sys->hdsound_dll,
729 "DirectSoundEnumerateA" );
730 if( OurDirectSoundEnumerate )
732 /* Attempt enumeration */
733 if( FAILED( OurDirectSoundEnumerate( CallBackDirectSoundEnum,
736 msg_Dbg( p_aout, "enumeration of DirectSound devices failed" );
740 /* Create the direct sound object */
741 if FAILED( OurDirectSoundCreate( p_aout->output.p_sys->p_device_guid,
742 &p_aout->output.p_sys->p_dsobject,
745 msg_Warn( p_aout, "cannot create a direct sound device" );
749 /* Set DirectSound Cooperative level, ie what control we want over Windows
750 * sound device. In our case, DSSCL_EXCLUSIVE means that we can modify the
751 * settings of the primary buffer, but also that only the sound of our
752 * application will be hearable when it will have the focus.
753 * !!! (this is not really working as intended yet because to set the
754 * cooperative level you need the window handle of your application, and
755 * I don't know of any easy way to get it. Especially since we might play
756 * sound without any video, and so what window handle should we use ???
757 * The hack for now is to use the Desktop window handle - it seems to be
759 if( IDirectSound_SetCooperativeLevel( p_aout->output.p_sys->p_dsobject,
763 msg_Warn( p_aout, "cannot set direct sound cooperative level" );
769 p_aout->output.p_sys->p_dsobject = NULL;
770 if( p_aout->output.p_sys->hdsound_dll )
772 FreeLibrary( p_aout->output.p_sys->hdsound_dll );
773 p_aout->output.p_sys->hdsound_dll = NULL;
779 /*****************************************************************************
780 * CreateDSBuffer: Creates a direct sound buffer of the required format.
781 *****************************************************************************
782 * This function creates the buffer we'll use to play audio.
783 * In DirectSound there are two kinds of buffers:
784 * - the primary buffer: which is the actual buffer that the soundcard plays
785 * - the secondary buffer(s): these buffers are the one actually used by
786 * applications and DirectSound takes care of mixing them into the primary.
788 * Once you create a secondary buffer, you cannot change its format anymore so
789 * you have to release the current one and create another.
790 *****************************************************************************/
791 static int CreateDSBuffer( aout_instance_t *p_aout, int i_format,
792 int i_channels, int i_nb_channels, int i_rate,
793 int i_bytes_per_frame, bool b_probe )
795 WAVEFORMATEXTENSIBLE waveformat;
796 DSBUFFERDESC dsbdesc;
799 /* First set the sound buffer format */
800 waveformat.dwChannelMask = 0;
801 for( i = 0; i < sizeof(pi_channels_src)/sizeof(uint32_t); i++ )
803 if( i_channels & pi_channels_src[i] )
804 waveformat.dwChannelMask |= pi_channels_in[i];
809 case VLC_FOURCC('s','p','d','i'):
811 /* To prevent channel re-ordering */
812 waveformat.dwChannelMask = SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT;
813 waveformat.Format.wBitsPerSample = 16;
814 waveformat.Samples.wValidBitsPerSample =
815 waveformat.Format.wBitsPerSample;
816 waveformat.Format.wFormatTag = WAVE_FORMAT_DOLBY_AC3_SPDIF;
817 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_DOLBY_AC3_SPDIF;
820 case VLC_FOURCC('f','l','3','2'):
821 waveformat.Format.wBitsPerSample = sizeof(float) * 8;
822 waveformat.Samples.wValidBitsPerSample =
823 waveformat.Format.wBitsPerSample;
824 waveformat.Format.wFormatTag = WAVE_FORMAT_IEEE_FLOAT;
825 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_IEEE_FLOAT;
828 case VLC_FOURCC('s','1','6','l'):
829 waveformat.Format.wBitsPerSample = 16;
830 waveformat.Samples.wValidBitsPerSample =
831 waveformat.Format.wBitsPerSample;
832 waveformat.Format.wFormatTag = WAVE_FORMAT_PCM;
833 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_PCM;
837 waveformat.Format.nChannels = i_nb_channels;
838 waveformat.Format.nSamplesPerSec = i_rate;
839 waveformat.Format.nBlockAlign =
840 waveformat.Format.wBitsPerSample / 8 * i_nb_channels;
841 waveformat.Format.nAvgBytesPerSec =
842 waveformat.Format.nSamplesPerSec * waveformat.Format.nBlockAlign;
844 p_aout->output.p_sys->i_bits_per_sample = waveformat.Format.wBitsPerSample;
845 p_aout->output.p_sys->i_channels = i_nb_channels;
847 /* Then fill in the direct sound descriptor */
848 memset(&dsbdesc, 0, sizeof(DSBUFFERDESC));
849 dsbdesc.dwSize = sizeof(DSBUFFERDESC);
850 dsbdesc.dwFlags = DSBCAPS_GETCURRENTPOSITION2/* Better position accuracy */
851 | DSBCAPS_GLOBALFOCUS; /* Allows background playing */
853 /* Only use the new WAVE_FORMAT_EXTENSIBLE format for multichannel audio */
854 if( i_nb_channels <= 2 )
856 waveformat.Format.cbSize = 0;
860 waveformat.Format.wFormatTag = WAVE_FORMAT_EXTENSIBLE;
861 waveformat.Format.cbSize =
862 sizeof(WAVEFORMATEXTENSIBLE) - sizeof(WAVEFORMATEX);
864 /* Needed for 5.1 on emu101k */
865 dsbdesc.dwFlags |= DSBCAPS_LOCHARDWARE;
868 dsbdesc.dwBufferBytes = FRAMES_NUM * i_bytes_per_frame; /* buffer size */
869 dsbdesc.lpwfxFormat = (WAVEFORMATEX *)&waveformat;
871 if FAILED( IDirectSound_CreateSoundBuffer(
872 p_aout->output.p_sys->p_dsobject, &dsbdesc,
873 &p_aout->output.p_sys->p_dsbuffer, NULL) )
875 if( dsbdesc.dwFlags & DSBCAPS_LOCHARDWARE )
877 /* Try without DSBCAPS_LOCHARDWARE */
878 dsbdesc.dwFlags &= ~DSBCAPS_LOCHARDWARE;
879 if FAILED( IDirectSound_CreateSoundBuffer(
880 p_aout->output.p_sys->p_dsobject, &dsbdesc,
881 &p_aout->output.p_sys->p_dsbuffer, NULL) )
886 msg_Dbg( p_aout, "couldn't use hardware sound buffer" );
894 /* Stop here if we were just probing */
897 IDirectSoundBuffer_Release( p_aout->output.p_sys->p_dsbuffer );
898 p_aout->output.p_sys->p_dsbuffer = NULL;
902 p_aout->output.p_sys->i_frame_size = i_bytes_per_frame;
903 p_aout->output.p_sys->i_channel_mask = waveformat.dwChannelMask;
904 p_aout->output.p_sys->b_chan_reorder =
905 aout_CheckChannelReorder( pi_channels_in, pi_channels_out,
906 waveformat.dwChannelMask, i_nb_channels,
907 p_aout->output.p_sys->pi_chan_table );
909 if( p_aout->output.p_sys->b_chan_reorder )
911 msg_Dbg( p_aout, "channel reordering needed" );
917 /*****************************************************************************
918 * CreateDSBufferPCM: creates a PCM direct sound buffer.
919 *****************************************************************************
920 * We first try to create a WAVE_FORMAT_IEEE_FLOAT buffer if supported by
921 * the hardware, otherwise we create a WAVE_FORMAT_PCM buffer.
922 ****************************************************************************/
923 static int CreateDSBufferPCM( aout_instance_t *p_aout, int *i_format,
924 int i_channels, int i_nb_channels, int i_rate,
929 var_Get( p_aout, "directx-audio-float32", &val );
931 /* Float32 audio samples are not supported for 5.1 output on the emu101k */
933 if( !val.b_bool || i_nb_channels > 2 ||
934 CreateDSBuffer( p_aout, VLC_FOURCC('f','l','3','2'),
935 i_channels, i_nb_channels, i_rate,
936 FRAME_SIZE * 4 * i_nb_channels, b_probe )
939 if ( CreateDSBuffer( p_aout, VLC_FOURCC('s','1','6','l'),
940 i_channels, i_nb_channels, i_rate,
941 FRAME_SIZE * 2 * i_nb_channels, b_probe )
948 *i_format = VLC_FOURCC('s','1','6','l');
954 *i_format = VLC_FOURCC('f','l','3','2');
959 /*****************************************************************************
961 *****************************************************************************
962 * This function destroys the secondary buffer.
963 *****************************************************************************/
964 static void DestroyDSBuffer( aout_instance_t *p_aout )
966 if( p_aout->output.p_sys->p_dsbuffer )
968 IDirectSoundBuffer_Release( p_aout->output.p_sys->p_dsbuffer );
969 p_aout->output.p_sys->p_dsbuffer = NULL;
973 /*****************************************************************************
974 * FillBuffer: Fill in one of the direct sound frame buffers.
975 *****************************************************************************
976 * Returns VLC_SUCCESS on success.
977 *****************************************************************************/
978 static int FillBuffer( aout_instance_t *p_aout, int i_frame,
979 aout_buffer_t *p_buffer )
981 notification_thread_t *p_notif = p_aout->output.p_sys->p_notif;
982 aout_sys_t *p_sys = p_aout->output.p_sys;
983 void *p_write_position, *p_wrap_around;
984 long l_bytes1, l_bytes2;
987 /* Before copying anything, we have to lock the buffer */
988 dsresult = IDirectSoundBuffer_Lock(
989 p_sys->p_dsbuffer, /* DS buffer */
990 i_frame * p_notif->i_frame_size, /* Start offset */
991 p_notif->i_frame_size, /* Number of bytes */
992 &p_write_position, /* Address of lock start */
993 &l_bytes1, /* Count of bytes locked before wrap around */
994 &p_wrap_around, /* Buffer adress (if wrap around) */
995 &l_bytes2, /* Count of bytes after wrap around */
997 if( dsresult == DSERR_BUFFERLOST )
999 IDirectSoundBuffer_Restore( p_sys->p_dsbuffer );
1000 dsresult = IDirectSoundBuffer_Lock(
1002 i_frame * p_notif->i_frame_size,
1003 p_notif->i_frame_size,
1010 if( dsresult != DS_OK )
1012 msg_Warn( p_notif, "cannot lock buffer" );
1013 if( p_buffer ) aout_BufferFree( p_buffer );
1014 return VLC_EGENERIC;
1017 if( p_buffer == NULL )
1019 memset( p_write_position, 0, l_bytes1 );
1023 if( p_sys->b_chan_reorder )
1025 /* Do the channel reordering here */
1026 aout_ChannelReorder( p_buffer->p_buffer, p_buffer->i_nb_bytes,
1027 p_sys->i_channels, p_sys->pi_chan_table,
1028 p_sys->i_bits_per_sample );
1031 vlc_memcpy( p_write_position, p_buffer->p_buffer, l_bytes1 );
1032 aout_BufferFree( p_buffer );
1035 /* Now the data has been copied, unlock the buffer */
1036 IDirectSoundBuffer_Unlock( p_sys->p_dsbuffer, p_write_position, l_bytes1,
1037 p_wrap_around, l_bytes2 );
1039 p_notif->i_write_slot = (i_frame + 1) % FRAMES_NUM;
1043 /*****************************************************************************
1044 * DirectSoundThread: this thread will capture play notification events.
1045 *****************************************************************************
1046 * We use this thread to emulate a callback mechanism. The thread probes for
1047 * event notification and fills up the DS secondary buffer when needed.
1048 *****************************************************************************/
1049 static void* DirectSoundThread( vlc_object_t *p_this )
1051 notification_thread_t *p_notif = (notification_thread_t*)p_this;
1052 aout_instance_t *p_aout = p_notif->p_aout;
1057 int canc = vlc_savecancel ();
1059 /* We don't want any resampling when using S/PDIF output */
1060 b_sleek = p_aout->output.output.i_format == VLC_FOURCC('s','p','d','i');
1062 msg_Dbg( p_notif, "DirectSoundThread ready" );
1064 /* Wait here until Play() is called */
1065 WaitForSingleObject( p_notif->event, INFINITE );
1067 if( vlc_object_alive (p_notif) )
1069 mwait( p_notif->start_date - AOUT_PTS_TOLERANCE / 2 );
1071 /* start playing the buffer */
1072 dsresult = IDirectSoundBuffer_Play( p_aout->output.p_sys->p_dsbuffer,
1075 DSBPLAY_LOOPING ); /* Flags */
1076 if( dsresult == DSERR_BUFFERLOST )
1078 IDirectSoundBuffer_Restore( p_aout->output.p_sys->p_dsbuffer );
1079 dsresult = IDirectSoundBuffer_Play(
1080 p_aout->output.p_sys->p_dsbuffer,
1083 DSBPLAY_LOOPING ); /* Flags */
1085 if( dsresult != DS_OK )
1087 msg_Err( p_aout, "cannot start playing buffer" );
1090 last_time = mdate();
1092 while( vlc_object_alive (p_notif) )
1094 long l_read, l_free_slots;
1095 mtime_t mtime = mdate();
1099 * Fill in as much audio data as we can in our circular buffer
1102 /* Find out current play position */
1103 if FAILED( IDirectSoundBuffer_GetCurrentPosition(
1104 p_aout->output.p_sys->p_dsbuffer, &l_read, NULL ) )
1106 msg_Err( p_aout, "GetCurrentPosition() failed!" );
1110 /* Detect underruns */
1111 if( l_queued && mtime - last_time >
1112 INT64_C(1000000) * l_queued / p_aout->output.output.i_rate )
1114 msg_Dbg( p_aout, "detected underrun!" );
1118 /* Try to fill in as many frame buffers as possible */
1119 l_read /= p_aout->output.output.i_bytes_per_frame;
1120 l_queued = p_notif->i_write_slot * FRAME_SIZE - l_read;
1121 if( l_queued < 0 ) l_queued += (FRAME_SIZE * FRAMES_NUM);
1122 l_free_slots = (FRAMES_NUM * FRAME_SIZE - l_queued) / FRAME_SIZE;
1124 for( i = 0; i < l_free_slots; i++ )
1126 aout_buffer_t *p_buffer = aout_OutputNextBuffer( p_aout,
1127 mtime + INT64_C(1000000) * (i * FRAME_SIZE + l_queued) /
1128 p_aout->output.output.i_rate, b_sleek );
1130 /* If there is no audio data available and we have some buffered
1131 * already, then just wait for the next time */
1132 if( !p_buffer && (i || l_queued / FRAME_SIZE) ) break;
1134 if( FillBuffer( p_aout, p_notif->i_write_slot % FRAMES_NUM,
1135 p_buffer ) != VLC_SUCCESS ) break;
1138 /* Sleep a reasonable amount of time */
1139 l_queued += (i * FRAME_SIZE);
1140 msleep( INT64_C(1000000) * l_queued / p_aout->output.output.i_rate / 2 );
1143 /* make sure the buffer isn't playing */
1144 IDirectSoundBuffer_Stop( p_aout->output.p_sys->p_dsbuffer );
1146 /* free the event */
1147 CloseHandle( p_notif->event );
1149 vlc_restorecancel (canc);
1150 msg_Dbg( p_notif, "DirectSoundThread exiting" );