1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "media/audio/audio_io.h"
8 #include <objbase.h> // This has to be before initguid.h
13 #include "base/bind.h"
14 #include "base/bind_helpers.h"
15 #include "base/command_line.h"
16 #include "base/files/file_path.h"
17 #include "base/memory/scoped_ptr.h"
18 #include "base/message_loop/message_loop.h"
19 #include "base/path_service.h"
20 #include "base/process/launch.h"
21 #include "base/strings/string_number_conversions.h"
22 #include "base/strings/string_util.h"
23 #include "base/win/windows_version.h"
24 #include "media/audio/audio_parameters.h"
25 #include "media/audio/win/audio_device_listener_win.h"
26 #include "media/audio/win/audio_low_latency_input_win.h"
27 #include "media/audio/win/audio_low_latency_output_win.h"
28 #include "media/audio/win/audio_manager_win.h"
29 #include "media/audio/win/core_audio_util_win.h"
30 #include "media/audio/win/device_enumeration_win.h"
31 #include "media/audio/win/wavein_input_win.h"
32 #include "media/audio/win/waveout_output_win.h"
33 #include "media/base/bind_to_current_loop.h"
34 #include "media/base/channel_layout.h"
35 #include "media/base/limits.h"
36 #include "media/base/media_switches.h"
38 // Libraries required for the SetupAPI and Wbem APIs used here.
39 #pragma comment(lib, "setupapi.lib")
41 // The following are defined in various DDK headers, and we (re)define them here
42 // to avoid adding the DDK as a chrome dependency.
43 #define DRV_QUERYDEVICEINTERFACE 0x80c
44 #define DRVM_MAPPER_PREFERRED_GET 0x2015
45 #define DRV_QUERYDEVICEINTERFACESIZE 0x80d
46 DEFINE_GUID(AM_KSCATEGORY_AUDIO
, 0x6994ad04, 0x93ef, 0x11d0,
47 0xa3, 0xcc, 0x00, 0xa0, 0xc9, 0x22, 0x31, 0x96);
51 // Maximum number of output streams that can be open simultaneously.
52 static const int kMaxOutputStreams
= 50;
54 // Up to 8 channels can be passed to the driver. This should work, given the
55 // right drivers, but graceful error handling is needed.
56 static const int kWinMaxChannels
= 8;
58 // We use 3 buffers for recording audio so that if a recording callback takes
59 // some time to return we won't lose audio. More buffers while recording are
60 // ok because they don't introduce any delay in recording, unlike in playback
61 // where you first need to fill in that number of buffers before starting to
63 static const int kNumInputBuffers
= 3;
65 // Buffer size to use for input and output stream when a proper size can't be
66 // determined from the system
67 static const int kFallbackBufferSize
= 2048;
69 static int GetVersionPartAsInt(DWORDLONG num
) {
70 return static_cast<int>(num
& 0xffff);
73 // Returns a string containing the given device's description and installed
75 static base::string16
GetDeviceAndDriverInfo(HDEVINFO device_info
,
76 SP_DEVINFO_DATA
* device_data
) {
77 // Save the old install params setting and set a flag for the
78 // SetupDiBuildDriverInfoList below to return only the installed drivers.
79 SP_DEVINSTALL_PARAMS old_device_install_params
;
80 old_device_install_params
.cbSize
= sizeof(old_device_install_params
);
81 SetupDiGetDeviceInstallParams(device_info
, device_data
,
82 &old_device_install_params
);
83 SP_DEVINSTALL_PARAMS device_install_params
= old_device_install_params
;
84 device_install_params
.FlagsEx
|= DI_FLAGSEX_INSTALLEDDRIVER
;
85 SetupDiSetDeviceInstallParams(device_info
, device_data
,
86 &device_install_params
);
88 SP_DRVINFO_DATA driver_data
;
89 driver_data
.cbSize
= sizeof(driver_data
);
90 base::string16 device_and_driver_info
;
91 if (SetupDiBuildDriverInfoList(device_info
, device_data
,
92 SPDIT_COMPATDRIVER
)) {
93 if (SetupDiEnumDriverInfo(device_info
, device_data
, SPDIT_COMPATDRIVER
, 0,
95 DWORDLONG version
= driver_data
.DriverVersion
;
96 device_and_driver_info
= base::string16(driver_data
.Description
) + L
" v" +
97 base::IntToString16(GetVersionPartAsInt((version
>> 48))) + L
"." +
98 base::IntToString16(GetVersionPartAsInt((version
>> 32))) + L
"." +
99 base::IntToString16(GetVersionPartAsInt((version
>> 16))) + L
"." +
100 base::IntToString16(GetVersionPartAsInt(version
));
102 SetupDiDestroyDriverInfoList(device_info
, device_data
, SPDIT_COMPATDRIVER
);
105 SetupDiSetDeviceInstallParams(device_info
, device_data
,
106 &old_device_install_params
);
108 return device_and_driver_info
;
111 static int NumberOfWaveOutBuffers() {
112 // Use the user provided buffer count if provided.
114 std::string
buffers_str(CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
115 switches::kWaveOutBuffers
));
116 if (base::StringToInt(buffers_str
, &buffers
) && buffers
> 0) {
120 // Use 4 buffers for Vista, 3 for everyone else:
121 // - The entire Windows audio stack was rewritten for Windows Vista and wave
122 // out performance was degraded compared to XP.
123 // - The regression was fixed in Windows 7 and most configurations will work
124 // with 2, but some (e.g., some Sound Blasters) still need 3.
125 // - Some XP configurations (even multi-processor ones) also need 3.
126 return (base::win::GetVersion() == base::win::VERSION_VISTA
) ? 4 : 3;
129 AudioManagerWin::AudioManagerWin(AudioLogFactory
* audio_log_factory
)
130 : AudioManagerBase(audio_log_factory
),
131 // |CoreAudioUtil::IsSupported()| uses static variables to avoid doing
132 // multiple initializations. This is however not thread safe.
133 // So, here we call it explicitly before we kick off the audio thread
134 // or do any other work.
135 enumeration_type_(CoreAudioUtil::IsSupported() ?
136 kMMDeviceEnumeration
: kWaveEnumeration
) {
137 SetMaxOutputStreamsAllowed(kMaxOutputStreams
);
139 // WARNING: This is executed on the UI loop, do not add any code here which
140 // loads libraries or attempts to call out into the OS. Instead add such code
141 // to the InitializeOnAudioThread() method below.
143 // Task must be posted last to avoid races from handing out "this" to the
145 GetTaskRunner()->PostTask(FROM_HERE
, base::Bind(
146 &AudioManagerWin::InitializeOnAudioThread
, base::Unretained(this)));
149 AudioManagerWin::~AudioManagerWin() {
150 // It's safe to post a task here since Shutdown() will wait for all tasks to
151 // complete before returning.
152 GetTaskRunner()->PostTask(FROM_HERE
, base::Bind(
153 &AudioManagerWin::ShutdownOnAudioThread
, base::Unretained(this)));
157 bool AudioManagerWin::HasAudioOutputDevices() {
158 return (::waveOutGetNumDevs() != 0);
161 bool AudioManagerWin::HasAudioInputDevices() {
162 return (::waveInGetNumDevs() != 0);
165 void AudioManagerWin::InitializeOnAudioThread() {
166 DCHECK(GetTaskRunner()->BelongsToCurrentThread());
168 if (core_audio_supported()) {
169 // AudioDeviceListenerWin must be initialized on a COM thread and should
170 // only be used if WASAPI / Core Audio is supported.
171 output_device_listener_
.reset(new AudioDeviceListenerWin(BindToCurrentLoop(
172 base::Bind(&AudioManagerWin::NotifyAllOutputDeviceChangeListeners
,
173 base::Unretained(this)))));
177 void AudioManagerWin::ShutdownOnAudioThread() {
178 DCHECK(GetTaskRunner()->BelongsToCurrentThread());
179 output_device_listener_
.reset();
182 base::string16
AudioManagerWin::GetAudioInputDeviceModel() {
183 // Get the default audio capture device and its device interface name.
185 waveInMessage(reinterpret_cast<HWAVEIN
>(WAVE_MAPPER
),
186 DRVM_MAPPER_PREFERRED_GET
,
187 reinterpret_cast<DWORD_PTR
>(&device_id
), NULL
);
188 ULONG device_interface_name_size
= 0;
189 waveInMessage(reinterpret_cast<HWAVEIN
>(device_id
),
190 DRV_QUERYDEVICEINTERFACESIZE
,
191 reinterpret_cast<DWORD_PTR
>(&device_interface_name_size
), 0);
192 size_t bytes_in_char16
= sizeof(base::string16::value_type
);
193 DCHECK_EQ(0u, device_interface_name_size
% bytes_in_char16
);
194 if (device_interface_name_size
<= bytes_in_char16
)
195 return base::string16(); // No audio capture device.
197 base::string16 device_interface_name
;
198 base::string16::value_type
* name_ptr
= WriteInto(&device_interface_name
,
199 device_interface_name_size
/ bytes_in_char16
);
200 waveInMessage(reinterpret_cast<HWAVEIN
>(device_id
),
201 DRV_QUERYDEVICEINTERFACE
,
202 reinterpret_cast<DWORD_PTR
>(name_ptr
),
203 static_cast<DWORD_PTR
>(device_interface_name_size
));
205 // Enumerate all audio devices and find the one matching the above device
207 HDEVINFO device_info
= SetupDiGetClassDevs(
208 &AM_KSCATEGORY_AUDIO
, 0, 0, DIGCF_DEVICEINTERFACE
| DIGCF_PRESENT
);
209 if (device_info
== INVALID_HANDLE_VALUE
)
210 return base::string16();
212 DWORD interface_index
= 0;
213 SP_DEVICE_INTERFACE_DATA interface_data
;
214 interface_data
.cbSize
= sizeof(interface_data
);
215 while (SetupDiEnumDeviceInterfaces(device_info
, 0, &AM_KSCATEGORY_AUDIO
,
216 interface_index
++, &interface_data
)) {
217 // Query the size of the struct, allocate it and then query the data.
218 SP_DEVINFO_DATA device_data
;
219 device_data
.cbSize
= sizeof(device_data
);
220 DWORD interface_detail_size
= 0;
221 SetupDiGetDeviceInterfaceDetail(device_info
, &interface_data
, 0, 0,
222 &interface_detail_size
, &device_data
);
223 if (!interface_detail_size
)
226 scoped_ptr
<char[]> interface_detail_buffer(new char[interface_detail_size
]);
227 SP_DEVICE_INTERFACE_DETAIL_DATA
* interface_detail
=
228 reinterpret_cast<SP_DEVICE_INTERFACE_DETAIL_DATA
*>(
229 interface_detail_buffer
.get());
230 interface_detail
->cbSize
= interface_detail_size
;
231 if (!SetupDiGetDeviceInterfaceDetail(device_info
, &interface_data
,
233 interface_detail_size
, NULL
,
235 return base::string16();
237 bool device_found
= (device_interface_name
== interface_detail
->DevicePath
);
240 return GetDeviceAndDriverInfo(device_info
, &device_data
);
243 return base::string16();
246 void AudioManagerWin::ShowAudioInputSettings() {
247 std::wstring program
;
248 std::string argument
;
249 if (!core_audio_supported()) {
250 program
= L
"sndvol32.exe";
253 program
= L
"control.exe";
254 argument
= "mmsys.cpl,,1";
258 PathService::Get(base::DIR_SYSTEM
, &path
);
259 path
= path
.Append(program
);
260 CommandLine
command_line(path
);
261 command_line
.AppendArg(argument
);
262 base::LaunchProcess(command_line
, base::LaunchOptions(), NULL
);
265 void AudioManagerWin::GetAudioDeviceNamesImpl(
267 AudioDeviceNames
* device_names
) {
268 DCHECK(device_names
->empty());
269 // Enumerate all active audio-endpoint capture devices.
270 if (enumeration_type() == kWaveEnumeration
) {
271 // Utilize the Wave API for Windows XP.
273 GetInputDeviceNamesWinXP(device_names
);
275 GetOutputDeviceNamesWinXP(device_names
);
277 // Utilize the MMDevice API (part of Core Audio) for Vista and higher.
279 GetInputDeviceNamesWin(device_names
);
281 GetOutputDeviceNamesWin(device_names
);
284 // Always add default device parameters as first element.
285 if (!device_names
->empty()) {
286 AudioDeviceName name
;
287 name
.device_name
= AudioManagerBase::kDefaultDeviceName
;
288 name
.unique_id
= AudioManagerBase::kDefaultDeviceId
;
289 device_names
->push_front(name
);
293 void AudioManagerWin::GetAudioInputDeviceNames(AudioDeviceNames
* device_names
) {
294 GetAudioDeviceNamesImpl(true, device_names
);
297 void AudioManagerWin::GetAudioOutputDeviceNames(
298 AudioDeviceNames
* device_names
) {
299 GetAudioDeviceNamesImpl(false, device_names
);
302 AudioParameters
AudioManagerWin::GetInputStreamParameters(
303 const std::string
& device_id
) {
304 AudioParameters parameters
;
305 if (!core_audio_supported()) {
306 // Windows Wave implementation is being used.
307 parameters
= AudioParameters(
308 AudioParameters::AUDIO_PCM_LINEAR
, CHANNEL_LAYOUT_STEREO
, 48000,
309 16, kFallbackBufferSize
, AudioParameters::NO_EFFECTS
);
311 parameters
= WASAPIAudioInputStream::GetInputStreamParameters(device_id
);
314 int user_buffer_size
= GetUserBufferSize();
315 if (user_buffer_size
) {
316 parameters
.Reset(parameters
.format(), parameters
.channel_layout(),
317 parameters
.channels(), parameters
.sample_rate(),
318 parameters
.bits_per_sample(), user_buffer_size
);
324 std::string
AudioManagerWin::GetAssociatedOutputDeviceID(
325 const std::string
& input_device_id
) {
326 if (!core_audio_supported()) {
328 << "GetAssociatedOutputDeviceID is not supported on this OS";
329 return std::string();
331 return CoreAudioUtil::GetMatchingOutputDeviceID(input_device_id
);
334 // Factory for the implementations of AudioOutputStream for AUDIO_PCM_LINEAR
336 // - PCMWaveOutAudioOutputStream: Based on the waveOut API.
337 AudioOutputStream
* AudioManagerWin::MakeLinearOutputStream(
338 const AudioParameters
& params
) {
339 DCHECK_EQ(AudioParameters::AUDIO_PCM_LINEAR
, params
.format());
340 if (params
.channels() > kWinMaxChannels
)
343 return new PCMWaveOutAudioOutputStream(this,
345 NumberOfWaveOutBuffers(),
349 // Factory for the implementations of AudioOutputStream for
350 // AUDIO_PCM_LOW_LATENCY mode. Two implementations should suffice most
351 // windows user's needs.
352 // - PCMWaveOutAudioOutputStream: Based on the waveOut API.
353 // - WASAPIAudioOutputStream: Based on Core Audio (WASAPI) API.
354 AudioOutputStream
* AudioManagerWin::MakeLowLatencyOutputStream(
355 const AudioParameters
& params
,
356 const std::string
& device_id
) {
357 DCHECK_EQ(AudioParameters::AUDIO_PCM_LOW_LATENCY
, params
.format());
358 if (params
.channels() > kWinMaxChannels
)
361 if (!core_audio_supported()) {
362 // Fall back to Windows Wave implementation on Windows XP or lower.
363 DLOG_IF(ERROR
, !device_id
.empty() &&
364 device_id
!= AudioManagerBase::kDefaultDeviceId
)
365 << "Opening by device id not supported by PCMWaveOutAudioOutputStream";
366 DVLOG(1) << "Using WaveOut since WASAPI requires at least Vista.";
367 return new PCMWaveOutAudioOutputStream(
368 this, params
, NumberOfWaveOutBuffers(), WAVE_MAPPER
);
371 // Pass an empty string to indicate that we want the default device
372 // since we consistently only check for an empty string in
373 // WASAPIAudioOutputStream.
374 return new WASAPIAudioOutputStream(this,
375 device_id
== AudioManagerBase::kDefaultDeviceId
?
376 std::string() : device_id
,
378 params
.effects() & AudioParameters::DUCKING
? eCommunications
: eConsole
);
381 // Factory for the implementations of AudioInputStream for AUDIO_PCM_LINEAR
383 AudioInputStream
* AudioManagerWin::MakeLinearInputStream(
384 const AudioParameters
& params
, const std::string
& device_id
) {
385 DCHECK_EQ(AudioParameters::AUDIO_PCM_LINEAR
, params
.format());
386 return CreatePCMWaveInAudioInputStream(params
, device_id
);
389 // Factory for the implementations of AudioInputStream for
390 // AUDIO_PCM_LOW_LATENCY mode.
391 AudioInputStream
* AudioManagerWin::MakeLowLatencyInputStream(
392 const AudioParameters
& params
, const std::string
& device_id
) {
393 DCHECK_EQ(AudioParameters::AUDIO_PCM_LOW_LATENCY
, params
.format());
394 DVLOG(1) << "MakeLowLatencyInputStream: " << device_id
;
395 AudioInputStream
* stream
= NULL
;
396 if (!core_audio_supported()) {
397 // Fall back to Windows Wave implementation on Windows XP or lower.
398 DVLOG(1) << "Using WaveIn since WASAPI requires at least Vista.";
399 stream
= CreatePCMWaveInAudioInputStream(params
, device_id
);
401 stream
= new WASAPIAudioInputStream(this, params
, device_id
);
407 std::string
AudioManagerWin::GetDefaultOutputDeviceID() {
408 if (!core_audio_supported())
409 return std::string();
410 return CoreAudioUtil::GetDefaultOutputDeviceID();
413 AudioParameters
AudioManagerWin::GetPreferredOutputStreamParameters(
414 const std::string
& output_device_id
,
415 const AudioParameters
& input_params
) {
416 DLOG_IF(ERROR
, !core_audio_supported() && !output_device_id
.empty())
417 << "CoreAudio is required to open non-default devices.";
419 const CommandLine
* cmd_line
= CommandLine::ForCurrentProcess();
420 ChannelLayout channel_layout
= CHANNEL_LAYOUT_STEREO
;
421 int sample_rate
= 48000;
422 int buffer_size
= kFallbackBufferSize
;
423 int bits_per_sample
= 16;
424 int effects
= AudioParameters::NO_EFFECTS
;
425 bool use_input_params
= !core_audio_supported();
426 if (core_audio_supported()) {
427 if (cmd_line
->HasSwitch(switches::kEnableExclusiveAudio
)) {
428 // TODO(rtoy): tune these values for best possible WebAudio
429 // performance. WebRTC works well at 48kHz and a buffer size of 480
430 // samples will be used for this case. Note that exclusive mode is
431 // experimental. This sample rate will be combined with a buffer size of
432 // 256 samples, which corresponds to an output delay of ~5.33ms.
435 if (input_params
.IsValid())
436 channel_layout
= input_params
.channel_layout();
438 AudioParameters params
;
439 HRESULT hr
= CoreAudioUtil::GetPreferredAudioParameters(
440 output_device_id
.empty() ?
441 GetDefaultOutputDeviceID() : output_device_id
,
444 bits_per_sample
= params
.bits_per_sample();
445 buffer_size
= params
.frames_per_buffer();
446 channel_layout
= params
.channel_layout();
447 sample_rate
= params
.sample_rate();
448 effects
= params
.effects();
450 // TODO(tommi): This should never happen really and I'm not sure that
451 // setting use_input_params is the right thing to do since WASAPI i
452 // definitely supported (see core_audio_supported() above) and
453 // |use_input_params| is only for cases when it isn't supported.
454 DLOG(ERROR
) << "GetPreferredAudioParameters failed: " << std::hex
<< hr
;
455 use_input_params
= true;
460 if (input_params
.IsValid()) {
461 // If the user has enabled checking supported channel layouts or we don't
462 // have a valid channel layout yet, try to use the input layout. See bugs
463 // http://crbug.com/259165 and http://crbug.com/311906 for more details.
464 if (core_audio_supported() &&
465 (cmd_line
->HasSwitch(switches::kTrySupportedChannelLayouts
) ||
466 channel_layout
== CHANNEL_LAYOUT_UNSUPPORTED
)) {
467 // Check if it is possible to open up at the specified input channel
468 // layout but avoid checking if the specified layout is the same as the
469 // hardware (preferred) layout. We do this extra check to avoid the
470 // CoreAudioUtil::IsChannelLayoutSupported() overhead in most cases.
471 if (input_params
.channel_layout() != channel_layout
) {
472 // TODO(henrika): Internally, IsChannelLayoutSupported does many of the
473 // operations that have already been done such as opening up a client
474 // and fetching the WAVEFORMATPCMEX format. Ideally we should only do
475 // that once. Then here, we can check the layout from the data we
477 if (CoreAudioUtil::IsChannelLayoutSupported(
478 output_device_id
, eRender
, eConsole
,
479 input_params
.channel_layout())) {
480 // Open up using the same channel layout as the source if it is
481 // supported by the hardware.
482 channel_layout
= input_params
.channel_layout();
483 DVLOG(1) << "Hardware channel layout is not used; using same layout"
484 << " as the source instead (" << channel_layout
<< ")";
489 effects
|= input_params
.effects();
490 if (use_input_params
) {
491 // If WASAPI isn't supported we'll fallback to WaveOut, which will take
492 // care of resampling and bits per sample changes. By setting these
493 // equal to the input values, AudioOutputResampler will skip resampling
494 // and bit per sample differences (since the input parameters will match
495 // the output parameters).
496 bits_per_sample
= input_params
.bits_per_sample();
497 buffer_size
= input_params
.frames_per_buffer();
498 channel_layout
= input_params
.channel_layout();
499 sample_rate
= input_params
.sample_rate();
503 int user_buffer_size
= GetUserBufferSize();
504 if (user_buffer_size
)
505 buffer_size
= user_buffer_size
;
507 return AudioParameters(
508 AudioParameters::AUDIO_PCM_LOW_LATENCY
, channel_layout
,
509 sample_rate
, bits_per_sample
, buffer_size
, effects
);
512 AudioInputStream
* AudioManagerWin::CreatePCMWaveInAudioInputStream(
513 const AudioParameters
& params
,
514 const std::string
& device_id
) {
515 std::string xp_device_id
= device_id
;
516 if (device_id
!= AudioManagerBase::kDefaultDeviceId
&&
517 enumeration_type_
== kMMDeviceEnumeration
) {
518 xp_device_id
= ConvertToWinXPInputDeviceId(device_id
);
519 if (xp_device_id
.empty()) {
520 DLOG(ERROR
) << "Cannot find a waveIn device which matches the device ID "
526 return new PCMWaveInAudioInputStream(this, params
, kNumInputBuffers
,
531 AudioManager
* CreateAudioManager(AudioLogFactory
* audio_log_factory
) {
532 return new AudioManagerWin(audio_log_factory
);