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 *****************************************************************************/
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,
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,
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,
198 SPEAKER_SIDE_LEFT, SPEAKER_SIDE_RIGHT, 0 };
200 /*****************************************************************************
202 *****************************************************************************/
203 static int OpenAudio ( vlc_object_t * );
204 static void CloseAudio ( vlc_object_t * );
205 static void Play ( aout_instance_t * );
207 /* local functions */
208 static void Probe ( aout_instance_t * );
209 static int InitDirectSound ( aout_instance_t * );
210 static int CreateDSBuffer ( aout_instance_t *, int, int, int, int, int, bool );
211 static int CreateDSBufferPCM ( aout_instance_t *, int*, int, int, int, bool );
212 static void DestroyDSBuffer ( aout_instance_t * );
213 static void DirectSoundThread ( notification_thread_t * );
214 static int FillBuffer ( aout_instance_t *, int, aout_buffer_t * );
216 /*****************************************************************************
218 *****************************************************************************/
219 #define DEVICE_TEXT N_("Output device")
220 #define DEVICE_LONGTEXT N_( \
221 "DirectX device number: 0 default device, 1..N device by number" \
222 "(Note that the default device appears as 0 AND another number)." )
223 #define FLOAT_TEXT N_("Use float32 output")
224 #define FLOAT_LONGTEXT N_( \
225 "The option allows you to enable or disable the high-quality float32 " \
226 "audio output mode (which is not well supported by some soundcards)." )
229 set_description( N_("DirectX audio output") );
230 set_shortname( "DirectX" );
231 set_capability( "audio output", 100 );
232 set_category( CAT_AUDIO );
233 set_subcategory( SUBCAT_AUDIO_AOUT );
234 add_shortcut( "directx" );
235 add_integer( "directx-audio-device", 0, NULL, DEVICE_TEXT,
236 DEVICE_LONGTEXT, true );
237 add_bool( "directx-audio-float32", 0, 0, FLOAT_TEXT,
238 FLOAT_LONGTEXT, true );
239 set_callbacks( OpenAudio, CloseAudio );
242 /*****************************************************************************
243 * OpenAudio: open the audio device
244 *****************************************************************************
245 * This function opens and setups Direct Sound.
246 *****************************************************************************/
247 static int OpenAudio( vlc_object_t *p_this )
249 aout_instance_t * p_aout = (aout_instance_t *)p_this;
252 msg_Dbg( p_aout, "OpenAudio" );
254 /* Allocate structure */
255 p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
256 if( p_aout->output.p_sys == NULL )
258 msg_Err( p_aout, "out of memory" );
262 /* Initialize some variables */
263 p_aout->output.p_sys->p_dsobject = NULL;
264 p_aout->output.p_sys->p_dsbuffer = NULL;
265 p_aout->output.p_sys->p_notif = NULL;
266 p_aout->output.p_sys->b_playing = 0;
268 p_aout->output.pf_play = Play;
269 aout_VolumeSoftInit( p_aout );
271 /* Retrieve config values */
272 var_Create( p_aout, "directx-audio-float32",
273 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
274 var_Create( p_aout, "directx-audio-device",
275 VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
276 var_Get( p_aout, "directx-audio-device", &val );
277 p_aout->output.p_sys->i_device_id = val.i_int;
278 p_aout->output.p_sys->p_device_guid = 0;
280 /* Initialise DirectSound */
281 if( InitDirectSound( p_aout ) )
283 msg_Err( p_aout, "cannot initialize DirectSound" );
287 if( var_Type( p_aout, "audio-device" ) == 0 )
292 if( var_Get( p_aout, "audio-device", &val ) < 0 )
294 /* Probe() has failed. */
298 /* Open the device */
299 if( val.i_int == AOUT_VAR_SPDIF )
301 p_aout->output.output.i_format = VLC_FOURCC('s','p','d','i');
303 /* Calculate the frame size in bytes */
304 p_aout->output.i_nb_samples = A52_FRAME_NB;
305 p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
306 p_aout->output.output.i_frame_length = A52_FRAME_NB;
307 p_aout->output.p_sys->i_frame_size =
308 p_aout->output.output.i_bytes_per_frame;
310 if( CreateDSBuffer( p_aout, VLC_FOURCC('s','p','d','i'),
311 p_aout->output.output.i_physical_channels,
312 aout_FormatNbChannels( &p_aout->output.output ),
313 p_aout->output.output.i_rate,
314 p_aout->output.p_sys->i_frame_size, false )
317 msg_Err( p_aout, "cannot open directx audio device" );
318 free( p_aout->output.p_sys );
322 aout_VolumeNoneInit( p_aout );
326 if( val.i_int == AOUT_VAR_5_1 )
328 p_aout->output.output.i_physical_channels
329 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
330 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
333 else if( val.i_int == AOUT_VAR_7_1 )
335 p_aout->output.output.i_physical_channels
336 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
337 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
338 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT
341 else if( val.i_int == AOUT_VAR_3F2R )
343 p_aout->output.output.i_physical_channels
344 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
345 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
347 else if( val.i_int == AOUT_VAR_2F2R )
349 p_aout->output.output.i_physical_channels
350 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
351 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
353 else if( val.i_int == AOUT_VAR_MONO )
355 p_aout->output.output.i_physical_channels = AOUT_CHAN_CENTER;
359 p_aout->output.output.i_physical_channels
360 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
363 if( CreateDSBufferPCM( p_aout, &p_aout->output.output.i_format,
364 p_aout->output.output.i_physical_channels,
365 aout_FormatNbChannels( &p_aout->output.output ),
366 p_aout->output.output.i_rate, false )
369 msg_Err( p_aout, "cannot open directx audio device" );
370 free( p_aout->output.p_sys );
374 /* Calculate the frame size in bytes */
375 p_aout->output.i_nb_samples = FRAME_SIZE;
376 aout_FormatPrepare( &p_aout->output.output );
377 aout_VolumeSoftInit( p_aout );
380 /* Now we need to setup our DirectSound play notification structure */
381 p_aout->output.p_sys->p_notif =
382 vlc_object_create( p_aout, sizeof(notification_thread_t) );
383 p_aout->output.p_sys->p_notif->p_aout = p_aout;
385 p_aout->output.p_sys->p_notif->event = CreateEvent( 0, FALSE, FALSE, 0 );
386 p_aout->output.p_sys->p_notif->i_frame_size =
387 p_aout->output.p_sys->i_frame_size;
389 /* then launch the notification thread */
390 msg_Dbg( p_aout, "creating DirectSoundThread" );
391 if( vlc_thread_create( p_aout->output.p_sys->p_notif,
392 "DirectSound Notification Thread",
394 VLC_THREAD_PRIORITY_HIGHEST, false ) )
396 msg_Err( p_aout, "cannot create DirectSoundThread" );
397 CloseHandle( p_aout->output.p_sys->p_notif->event );
398 vlc_object_release( p_aout->output.p_sys->p_notif );
399 p_aout->output.p_sys->p_notif = NULL;
403 vlc_object_attach( p_aout->output.p_sys->p_notif, p_aout );
408 CloseAudio( VLC_OBJECT(p_aout) );
412 /*****************************************************************************
413 * Probe: probe the audio device for available formats and channels
414 *****************************************************************************/
415 static void Probe( aout_instance_t * p_aout )
417 vlc_value_t val, text;
419 unsigned int i_physical_channels;
420 DWORD ui_speaker_config;
421 bool is_default_output_set = false;
423 var_Create( p_aout, "audio-device", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
424 text.psz_string = _("Audio Device");
425 var_Change( p_aout, "audio-device", VLC_VAR_SETTEXT, &text, NULL );
427 /* Test for 5.1 support */
428 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
429 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
430 AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE;
431 if( p_aout->output.output.i_physical_channels == i_physical_channels )
433 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 6,
434 p_aout->output.output.i_rate, true )
437 val.i_int = AOUT_VAR_5_1;
438 text.psz_string = "5.1";
439 var_Change( p_aout, "audio-device",
440 VLC_VAR_ADDCHOICE, &val, &text );
441 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
442 is_default_output_set = true;
443 msg_Dbg( p_aout, "device supports 5.1 channels" );
447 /* Test for 7.1 support */
448 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
449 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
450 AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT |
451 AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE;
452 if( p_aout->output.output.i_physical_channels == i_physical_channels )
454 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 8,
455 p_aout->output.output.i_rate, true )
458 val.i_int = AOUT_VAR_7_1;
459 text.psz_string = "7.1";
460 var_Change( p_aout, "audio-device",
461 VLC_VAR_ADDCHOICE, &val, &text );
462 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
463 is_default_output_set = true;
464 msg_Dbg( p_aout, "device supports 7.1 channels" );
468 /* Test for 3 Front 2 Rear support */
469 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
470 AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT |
472 if( p_aout->output.output.i_physical_channels == i_physical_channels )
474 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 5,
475 p_aout->output.output.i_rate, true )
478 val.i_int = AOUT_VAR_3F2R;
479 text.psz_string = N_("3 Front 2 Rear");
480 var_Change( p_aout, "audio-device",
481 VLC_VAR_ADDCHOICE, &val, &text );
482 if(!is_default_output_set)
484 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
485 is_default_output_set = true;
487 msg_Dbg( p_aout, "device supports 5 channels" );
491 /* Test for 2 Front 2 Rear support */
492 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
493 AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
494 if( ( p_aout->output.output.i_physical_channels & i_physical_channels )
495 == i_physical_channels )
497 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 4,
498 p_aout->output.output.i_rate, true )
501 val.i_int = AOUT_VAR_2F2R;
502 text.psz_string = N_("2 Front 2 Rear");
503 var_Change( p_aout, "audio-device",
504 VLC_VAR_ADDCHOICE, &val, &text );
505 if(!is_default_output_set)
507 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
508 is_default_output_set = true;
510 msg_Dbg( p_aout, "device supports 4 channels" );
514 /* Test for stereo support */
515 i_physical_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
516 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 2,
517 p_aout->output.output.i_rate, true )
520 val.i_int = AOUT_VAR_STEREO;
521 text.psz_string = N_("Stereo");
522 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
523 if(!is_default_output_set)
525 var_Change( p_aout, "audio-device", VLC_VAR_SETDEFAULT, &val, NULL );
526 is_default_output_set = true;
527 msg_Dbg( p_aout, "device supports 2 channels (DEFAULT!)" );
529 msg_Dbg( p_aout, "device supports 2 channels" );
532 /* Test for mono support */
533 i_physical_channels = AOUT_CHAN_CENTER;
534 if( CreateDSBufferPCM( p_aout, &i_format, i_physical_channels, 1,
535 p_aout->output.output.i_rate, true )
538 val.i_int = AOUT_VAR_MONO;
539 text.psz_string = N_("Mono");
540 var_Change( p_aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text );
541 msg_Dbg( p_aout, "device supports 1 channel" );
544 /* Check the speaker configuration to determine which channel config should
546 if FAILED( IDirectSound_GetSpeakerConfig( p_aout->output.p_sys->p_dsobject,
547 &ui_speaker_config ) )
549 ui_speaker_config = DSSPEAKER_STEREO;
550 msg_Dbg( p_aout, "GetSpeakerConfig failed" );
552 switch( DSSPEAKER_CONFIG(ui_speaker_config) )
554 case DSSPEAKER_7POINT1:
555 msg_Dbg( p_aout, "Windows says your SpeakerConfig is 7.1" );
556 val.i_int = AOUT_VAR_7_1;
558 case DSSPEAKER_5POINT1:
559 msg_Dbg( p_aout, "Windows says your SpeakerConfig is 5.1" );
560 val.i_int = AOUT_VAR_5_1;
563 msg_Dbg( p_aout, "Windows says your SpeakerConfig is Quad" );
564 val.i_int = AOUT_VAR_2F2R;
566 #if 0 /* Lots of people just get their settings wrong and complain that
567 * this is a problem with VLC so just don't ever set mono by default. */
569 val.i_int = AOUT_VAR_MONO;
572 case DSSPEAKER_SURROUND:
573 msg_Dbg( p_aout, "Windows says your SpeakerConfig is surround" );
574 case DSSPEAKER_STEREO:
575 msg_Dbg( p_aout, "Windows says your SpeakerConfig is stereo" );
577 /* If nothing else is found, choose stereo output */
578 val.i_int = AOUT_VAR_STEREO;
581 var_Set( p_aout, "audio-device", val );
583 /* Test for SPDIF support */
584 if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
586 if( CreateDSBuffer( p_aout, VLC_FOURCC('s','p','d','i'),
587 p_aout->output.output.i_physical_channels,
588 aout_FormatNbChannels( &p_aout->output.output ),
589 p_aout->output.output.i_rate,
590 AOUT_SPDIF_SIZE, true )
593 msg_Dbg( p_aout, "device supports A/52 over S/PDIF" );
594 val.i_int = AOUT_VAR_SPDIF;
595 text.psz_string = N_("A/52 over S/PDIF");
596 var_Change( p_aout, "audio-device",
597 VLC_VAR_ADDCHOICE, &val, &text );
598 if( config_GetInt( p_aout, "spdif" ) )
599 var_Set( p_aout, "audio-device", val );
603 var_Change( p_aout, "audio-device", VLC_VAR_CHOICESCOUNT, &val, NULL );
606 /* Probe() has failed. */
607 var_Destroy( p_aout, "audio-device" );
611 var_AddCallback( p_aout, "audio-device", aout_ChannelsRestart, NULL );
614 var_Set( p_aout, "intf-change", val );
617 /*****************************************************************************
618 * Play: we'll start playing the directsound buffer here because at least here
619 * we know the first buffer has been put in the aout fifo and we also
621 *****************************************************************************/
622 static void Play( aout_instance_t *p_aout )
624 if( !p_aout->output.p_sys->b_playing )
626 aout_buffer_t *p_buffer;
629 p_aout->output.p_sys->b_playing = 1;
631 /* get the playing date of the first aout buffer */
632 p_aout->output.p_sys->p_notif->start_date =
633 aout_FifoFirstDate( p_aout, &p_aout->output.fifo );
635 /* fill in the first samples */
636 for( i = 0; i < FRAMES_NUM; i++ )
638 p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
639 if( !p_buffer ) break;
640 FillBuffer( p_aout, i, p_buffer );
643 /* wake up the audio output thread */
644 SetEvent( p_aout->output.p_sys->p_notif->event );
648 /*****************************************************************************
649 * CloseAudio: close the audio device
650 *****************************************************************************/
651 static void CloseAudio( vlc_object_t *p_this )
653 aout_instance_t * p_aout = (aout_instance_t *)p_this;
654 aout_sys_t *p_sys = p_aout->output.p_sys;
656 msg_Dbg( p_aout, "closing audio device" );
658 /* kill the position notification thread, if any */
661 vlc_object_detach( p_sys->p_notif );
662 vlc_object_kill( p_sys->p_notif );
663 /* wake up the audio thread if needed */
664 if( !p_sys->b_playing ) SetEvent( p_sys->p_notif->event );
666 vlc_thread_join( p_sys->p_notif );
667 vlc_object_release( p_sys->p_notif );
670 /* release the secondary buffer */
671 DestroyDSBuffer( p_aout );
673 /* finally release the DirectSound object */
674 if( p_sys->p_dsobject ) IDirectSound_Release( p_sys->p_dsobject );
676 /* free DSOUND.DLL */
677 if( p_sys->hdsound_dll ) FreeLibrary( p_sys->hdsound_dll );
679 free( p_aout->output.p_sys->p_device_guid );
683 /*****************************************************************************
684 * CallBackDirectSoundEnum: callback to enumerate available devices
685 *****************************************************************************/
686 static int CALLBACK CallBackDirectSoundEnum( LPGUID p_guid, LPCSTR psz_desc,
687 LPCSTR psz_mod, LPVOID _p_aout )
689 aout_instance_t *p_aout = (aout_instance_t *)_p_aout;
691 msg_Dbg( p_aout, "found device: %s", psz_desc );
693 if( p_aout->output.p_sys->i_device_id == 0 && p_guid )
695 p_aout->output.p_sys->p_device_guid = malloc( sizeof( GUID ) );
696 *p_aout->output.p_sys->p_device_guid = *p_guid;
697 msg_Dbg( p_aout, "using device: %s", psz_desc );
700 p_aout->output.p_sys->i_device_id--;
704 /*****************************************************************************
705 * InitDirectSound: handle all the gory details of DirectSound initialisation
706 *****************************************************************************/
707 static int InitDirectSound( aout_instance_t *p_aout )
709 HRESULT (WINAPI *OurDirectSoundCreate)(LPGUID, LPDIRECTSOUND *, LPUNKNOWN);
710 HRESULT (WINAPI *OurDirectSoundEnumerate)(LPDSENUMCALLBACK, LPVOID);
712 p_aout->output.p_sys->hdsound_dll = LoadLibrary("DSOUND.DLL");
713 if( p_aout->output.p_sys->hdsound_dll == NULL )
715 msg_Warn( p_aout, "cannot open DSOUND.DLL" );
719 OurDirectSoundCreate = (void *)
720 GetProcAddress( p_aout->output.p_sys->hdsound_dll,
721 "DirectSoundCreate" );
722 if( OurDirectSoundCreate == NULL )
724 msg_Warn( p_aout, "GetProcAddress FAILED" );
728 /* Get DirectSoundEnumerate */
729 OurDirectSoundEnumerate = (void *)
730 GetProcAddress( p_aout->output.p_sys->hdsound_dll,
731 "DirectSoundEnumerateA" );
732 if( OurDirectSoundEnumerate )
734 /* Attempt enumeration */
735 if( FAILED( OurDirectSoundEnumerate( CallBackDirectSoundEnum,
738 msg_Dbg( p_aout, "enumeration of DirectSound devices failed" );
742 /* Create the direct sound object */
743 if FAILED( OurDirectSoundCreate( p_aout->output.p_sys->p_device_guid,
744 &p_aout->output.p_sys->p_dsobject,
747 msg_Warn( p_aout, "cannot create a direct sound device" );
751 /* Set DirectSound Cooperative level, ie what control we want over Windows
752 * sound device. In our case, DSSCL_EXCLUSIVE means that we can modify the
753 * settings of the primary buffer, but also that only the sound of our
754 * application will be hearable when it will have the focus.
755 * !!! (this is not really working as intended yet because to set the
756 * cooperative level you need the window handle of your application, and
757 * I don't know of any easy way to get it. Especially since we might play
758 * sound without any video, and so what window handle should we use ???
759 * The hack for now is to use the Desktop window handle - it seems to be
761 if( IDirectSound_SetCooperativeLevel( p_aout->output.p_sys->p_dsobject,
765 msg_Warn( p_aout, "cannot set direct sound cooperative level" );
771 p_aout->output.p_sys->p_dsobject = NULL;
772 if( p_aout->output.p_sys->hdsound_dll )
774 FreeLibrary( p_aout->output.p_sys->hdsound_dll );
775 p_aout->output.p_sys->hdsound_dll = NULL;
781 /*****************************************************************************
782 * CreateDSBuffer: Creates a direct sound buffer of the required format.
783 *****************************************************************************
784 * This function creates the buffer we'll use to play audio.
785 * In DirectSound there are two kinds of buffers:
786 * - the primary buffer: which is the actual buffer that the soundcard plays
787 * - the secondary buffer(s): these buffers are the one actually used by
788 * applications and DirectSound takes care of mixing them into the primary.
790 * Once you create a secondary buffer, you cannot change its format anymore so
791 * you have to release the current one and create another.
792 *****************************************************************************/
793 static int CreateDSBuffer( aout_instance_t *p_aout, int i_format,
794 int i_channels, int i_nb_channels, int i_rate,
795 int i_bytes_per_frame, bool b_probe )
797 WAVEFORMATEXTENSIBLE waveformat;
798 DSBUFFERDESC dsbdesc;
801 /* First set the sound buffer format */
802 waveformat.dwChannelMask = 0;
803 for( i = 0; i < sizeof(pi_channels_src)/sizeof(uint32_t); i++ )
805 if( i_channels & pi_channels_src[i] )
806 waveformat.dwChannelMask |= pi_channels_in[i];
811 case VLC_FOURCC('s','p','d','i'):
813 /* To prevent channel re-ordering */
814 waveformat.dwChannelMask = SPEAKER_FRONT_LEFT | SPEAKER_FRONT_RIGHT;
815 waveformat.Format.wBitsPerSample = 16;
816 waveformat.Samples.wValidBitsPerSample =
817 waveformat.Format.wBitsPerSample;
818 waveformat.Format.wFormatTag = WAVE_FORMAT_DOLBY_AC3_SPDIF;
819 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_DOLBY_AC3_SPDIF;
822 case VLC_FOURCC('f','l','3','2'):
823 waveformat.Format.wBitsPerSample = sizeof(float) * 8;
824 waveformat.Samples.wValidBitsPerSample =
825 waveformat.Format.wBitsPerSample;
826 waveformat.Format.wFormatTag = WAVE_FORMAT_IEEE_FLOAT;
827 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_IEEE_FLOAT;
830 case VLC_FOURCC('s','1','6','l'):
831 waveformat.Format.wBitsPerSample = 16;
832 waveformat.Samples.wValidBitsPerSample =
833 waveformat.Format.wBitsPerSample;
834 waveformat.Format.wFormatTag = WAVE_FORMAT_PCM;
835 waveformat.SubFormat = _KSDATAFORMAT_SUBTYPE_PCM;
839 waveformat.Format.nChannels = i_nb_channels;
840 waveformat.Format.nSamplesPerSec = i_rate;
841 waveformat.Format.nBlockAlign =
842 waveformat.Format.wBitsPerSample / 8 * i_nb_channels;
843 waveformat.Format.nAvgBytesPerSec =
844 waveformat.Format.nSamplesPerSec * waveformat.Format.nBlockAlign;
846 p_aout->output.p_sys->i_bits_per_sample = waveformat.Format.wBitsPerSample;
847 p_aout->output.p_sys->i_channels = i_nb_channels;
849 /* Then fill in the direct sound descriptor */
850 memset(&dsbdesc, 0, sizeof(DSBUFFERDESC));
851 dsbdesc.dwSize = sizeof(DSBUFFERDESC);
852 dsbdesc.dwFlags = DSBCAPS_GETCURRENTPOSITION2/* Better position accuracy */
853 | DSBCAPS_GLOBALFOCUS; /* Allows background playing */
855 /* Only use the new WAVE_FORMAT_EXTENSIBLE format for multichannel audio */
856 if( i_nb_channels <= 2 )
858 waveformat.Format.cbSize = 0;
862 waveformat.Format.wFormatTag = WAVE_FORMAT_EXTENSIBLE;
863 waveformat.Format.cbSize =
864 sizeof(WAVEFORMATEXTENSIBLE) - sizeof(WAVEFORMATEX);
866 /* Needed for 5.1 on emu101k */
867 dsbdesc.dwFlags |= DSBCAPS_LOCHARDWARE;
870 dsbdesc.dwBufferBytes = FRAMES_NUM * i_bytes_per_frame; /* buffer size */
871 dsbdesc.lpwfxFormat = (WAVEFORMATEX *)&waveformat;
873 if FAILED( IDirectSound_CreateSoundBuffer(
874 p_aout->output.p_sys->p_dsobject, &dsbdesc,
875 &p_aout->output.p_sys->p_dsbuffer, NULL) )
877 if( dsbdesc.dwFlags & DSBCAPS_LOCHARDWARE )
879 /* Try without DSBCAPS_LOCHARDWARE */
880 dsbdesc.dwFlags &= ~DSBCAPS_LOCHARDWARE;
881 if FAILED( IDirectSound_CreateSoundBuffer(
882 p_aout->output.p_sys->p_dsobject, &dsbdesc,
883 &p_aout->output.p_sys->p_dsbuffer, NULL) )
888 msg_Dbg( p_aout, "couldn't use hardware sound buffer" );
896 /* Stop here if we were just probing */
899 IDirectSoundBuffer_Release( p_aout->output.p_sys->p_dsbuffer );
900 p_aout->output.p_sys->p_dsbuffer = NULL;
904 p_aout->output.p_sys->i_frame_size = i_bytes_per_frame;
905 p_aout->output.p_sys->i_channel_mask = waveformat.dwChannelMask;
906 p_aout->output.p_sys->b_chan_reorder =
907 aout_CheckChannelReorder( pi_channels_in, pi_channels_out,
908 waveformat.dwChannelMask, i_nb_channels,
909 p_aout->output.p_sys->pi_chan_table );
911 if( p_aout->output.p_sys->b_chan_reorder )
913 msg_Dbg( p_aout, "channel reordering needed" );
919 /*****************************************************************************
920 * CreateDSBufferPCM: creates a PCM direct sound buffer.
921 *****************************************************************************
922 * We first try to create a WAVE_FORMAT_IEEE_FLOAT buffer if supported by
923 * the hardware, otherwise we create a WAVE_FORMAT_PCM buffer.
924 ****************************************************************************/
925 static int CreateDSBufferPCM( aout_instance_t *p_aout, int *i_format,
926 int i_channels, int i_nb_channels, int i_rate,
931 var_Get( p_aout, "directx-audio-float32", &val );
933 /* Float32 audio samples are not supported for 5.1 output on the emu101k */
935 if( !val.b_bool || i_nb_channels > 2 ||
936 CreateDSBuffer( p_aout, VLC_FOURCC('f','l','3','2'),
937 i_channels, i_nb_channels, i_rate,
938 FRAME_SIZE * 4 * i_nb_channels, b_probe )
941 if ( CreateDSBuffer( p_aout, VLC_FOURCC('s','1','6','l'),
942 i_channels, i_nb_channels, i_rate,
943 FRAME_SIZE * 2 * i_nb_channels, b_probe )
950 *i_format = VLC_FOURCC('s','1','6','l');
956 *i_format = VLC_FOURCC('f','l','3','2');
961 /*****************************************************************************
963 *****************************************************************************
964 * This function destroys the secondary buffer.
965 *****************************************************************************/
966 static void DestroyDSBuffer( aout_instance_t *p_aout )
968 if( p_aout->output.p_sys->p_dsbuffer )
970 IDirectSoundBuffer_Release( p_aout->output.p_sys->p_dsbuffer );
971 p_aout->output.p_sys->p_dsbuffer = NULL;
975 /*****************************************************************************
976 * FillBuffer: Fill in one of the direct sound frame buffers.
977 *****************************************************************************
978 * Returns VLC_SUCCESS on success.
979 *****************************************************************************/
980 static int FillBuffer( aout_instance_t *p_aout, int i_frame,
981 aout_buffer_t *p_buffer )
983 notification_thread_t *p_notif = p_aout->output.p_sys->p_notif;
984 aout_sys_t *p_sys = p_aout->output.p_sys;
985 void *p_write_position, *p_wrap_around;
986 long l_bytes1, l_bytes2;
989 /* Before copying anything, we have to lock the buffer */
990 dsresult = IDirectSoundBuffer_Lock(
991 p_sys->p_dsbuffer, /* DS buffer */
992 i_frame * p_notif->i_frame_size, /* Start offset */
993 p_notif->i_frame_size, /* Number of bytes */
994 &p_write_position, /* Address of lock start */
995 &l_bytes1, /* Count of bytes locked before wrap around */
996 &p_wrap_around, /* Buffer adress (if wrap around) */
997 &l_bytes2, /* Count of bytes after wrap around */
999 if( dsresult == DSERR_BUFFERLOST )
1001 IDirectSoundBuffer_Restore( p_sys->p_dsbuffer );
1002 dsresult = IDirectSoundBuffer_Lock(
1004 i_frame * p_notif->i_frame_size,
1005 p_notif->i_frame_size,
1012 if( dsresult != DS_OK )
1014 msg_Warn( p_notif, "cannot lock buffer" );
1015 if( p_buffer ) aout_BufferFree( p_buffer );
1016 return VLC_EGENERIC;
1019 if( p_buffer == NULL )
1021 memset( p_write_position, 0, l_bytes1 );
1025 if( p_sys->b_chan_reorder )
1027 /* Do the channel reordering here */
1028 aout_ChannelReorder( p_buffer->p_buffer, p_buffer->i_nb_bytes,
1029 p_sys->i_channels, p_sys->pi_chan_table,
1030 p_sys->i_bits_per_sample );
1033 vlc_memcpy( p_write_position, p_buffer->p_buffer, l_bytes1 );
1034 aout_BufferFree( p_buffer );
1037 /* Now the data has been copied, unlock the buffer */
1038 IDirectSoundBuffer_Unlock( p_sys->p_dsbuffer, p_write_position, l_bytes1,
1039 p_wrap_around, l_bytes2 );
1041 p_notif->i_write_slot = (i_frame + 1) % FRAMES_NUM;
1045 /*****************************************************************************
1046 * DirectSoundThread: this thread will capture play notification events.
1047 *****************************************************************************
1048 * We use this thread to emulate a callback mechanism. The thread probes for
1049 * event notification and fills up the DS secondary buffer when needed.
1050 *****************************************************************************/
1051 static void DirectSoundThread( notification_thread_t *p_notif )
1053 aout_instance_t *p_aout = p_notif->p_aout;
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 /* Tell the main thread that we are ready */
1063 vlc_thread_ready( p_notif );
1065 msg_Dbg( p_notif, "DirectSoundThread ready" );
1067 /* Wait here until Play() is called */
1068 WaitForSingleObject( p_notif->event, INFINITE );
1070 if( !p_notif->b_die )
1072 mwait( p_notif->start_date - AOUT_PTS_TOLERANCE / 2 );
1074 /* start playing the buffer */
1075 dsresult = IDirectSoundBuffer_Play( p_aout->output.p_sys->p_dsbuffer,
1078 DSBPLAY_LOOPING ); /* Flags */
1079 if( dsresult == DSERR_BUFFERLOST )
1081 IDirectSoundBuffer_Restore( p_aout->output.p_sys->p_dsbuffer );
1082 dsresult = IDirectSoundBuffer_Play(
1083 p_aout->output.p_sys->p_dsbuffer,
1086 DSBPLAY_LOOPING ); /* Flags */
1088 if( dsresult != DS_OK )
1090 msg_Err( p_aout, "cannot start playing buffer" );
1093 last_time = mdate();
1095 while( !p_notif->b_die )
1097 long l_read, l_free_slots;
1098 mtime_t mtime = mdate();
1102 * Fill in as much audio data as we can in our circular buffer
1105 /* Find out current play position */
1106 if FAILED( IDirectSoundBuffer_GetCurrentPosition(
1107 p_aout->output.p_sys->p_dsbuffer, &l_read, NULL ) )
1109 msg_Err( p_aout, "GetCurrentPosition() failed!" );
1113 /* Detect underruns */
1114 if( l_queued && mtime - last_time >
1115 INT64_C(1000000) * l_queued / p_aout->output.output.i_rate )
1117 msg_Dbg( p_aout, "detected underrun!" );
1121 /* Try to fill in as many frame buffers as possible */
1122 l_read /= p_aout->output.output.i_bytes_per_frame;
1123 l_queued = p_notif->i_write_slot * FRAME_SIZE - l_read;
1124 if( l_queued < 0 ) l_queued += (FRAME_SIZE * FRAMES_NUM);
1125 l_free_slots = (FRAMES_NUM * FRAME_SIZE - l_queued) / FRAME_SIZE;
1127 for( i = 0; i < l_free_slots; i++ )
1129 aout_buffer_t *p_buffer = aout_OutputNextBuffer( p_aout,
1130 mtime + INT64_C(1000000) * (i * FRAME_SIZE + l_queued) /
1131 p_aout->output.output.i_rate, b_sleek );
1133 /* If there is no audio data available and we have some buffered
1134 * already, then just wait for the next time */
1135 if( !p_buffer && (i || l_queued / FRAME_SIZE) ) break;
1137 if( FillBuffer( p_aout, p_notif->i_write_slot % FRAMES_NUM,
1138 p_buffer ) != VLC_SUCCESS ) break;
1141 /* Sleep a reasonable amount of time */
1142 l_queued += (i * FRAME_SIZE);
1143 msleep( INT64_C(1000000) * l_queued / p_aout->output.output.i_rate / 2 );
1146 /* make sure the buffer isn't playing */
1147 IDirectSoundBuffer_Stop( p_aout->output.p_sys->p_dsbuffer );
1149 /* free the event */
1150 CloseHandle( p_notif->event );
1152 msg_Dbg( p_notif, "DirectSoundThread exiting" );