blob: 3a3a04dfc821e3862cb99af764fab7d17fcdd8a2 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "media/audio/win/device_enumeration_win.h"
#include <MMDeviceAPI.h>
#include <mmsystem.h>
#include <objbase.h>
#include <Functiondiscoverykeys_devpkey.h> // MMDeviceAPI.h must come first
#include <stddef.h>
#include <wrl/client.h>
#include "base/logging.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/win/scoped_co_mem.h"
#include "base/win/scoped_propvariant.h"
#include "media/audio/win/audio_manager_win.h"
#include "media/audio/win/core_audio_util_win.h"
using base::win::ScopedCoMem;
// Taken from Mmddk.h.
#define DRV_RESERVED 0x0800
#define DRV_QUERYFUNCTIONINSTANCEID (DRV_RESERVED + 17)
#define DRV_QUERYFUNCTIONINSTANCEIDSIZE (DRV_RESERVED + 18)
namespace media {
static bool GetDeviceNamesWinImpl(EDataFlow data_flow,
AudioDeviceNames* device_names) {
// It is assumed that this method is called from a COM thread, i.e.,
// CoInitializeEx() is not called here again to avoid STA/MTA conflicts.
Microsoft::WRL::ComPtr<IMMDeviceEnumerator> enumerator;
HRESULT hr =
::CoCreateInstance(__uuidof(MMDeviceEnumerator), NULL,
CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&enumerator));
DCHECK_NE(CO_E_NOTINITIALIZED, hr);
if (FAILED(hr)) {
LOG(WARNING) << "Failed to create IMMDeviceEnumerator: " << std::hex << hr;
return false;
}
// Generate a collection of active audio endpoint devices.
// This method will succeed even if all devices are disabled.
Microsoft::WRL::ComPtr<IMMDeviceCollection> collection;
hr = enumerator->EnumAudioEndpoints(data_flow, DEVICE_STATE_ACTIVE,
collection.GetAddressOf());
if (FAILED(hr))
return false;
// Retrieve the number of active devices.
UINT number_of_active_devices = 0;
collection->GetCount(&number_of_active_devices);
if (number_of_active_devices == 0)
return true;
AudioDeviceName device;
// Loop over all active devices and add friendly name and
// unique ID to the |device_names| list.
for (UINT i = 0; i < number_of_active_devices; ++i) {
// Retrieve unique name of endpoint device.
// Example: "{0.0.1.00000000}.{8db6020f-18e3-4f25-b6f5-7726c9122574}".
Microsoft::WRL::ComPtr<IMMDevice> audio_device;
hr = collection->Item(i, audio_device.GetAddressOf());
if (FAILED(hr))
continue;
// Store the unique name.
ScopedCoMem<WCHAR> endpoint_device_id;
audio_device->GetId(&endpoint_device_id);
device.unique_id =
base::WideToUTF8(static_cast<WCHAR*>(endpoint_device_id));
// Retrieve user-friendly name of endpoint device.
// Example: "Microphone (Realtek High Definition Audio)".
Microsoft::WRL::ComPtr<IPropertyStore> properties;
hr = audio_device->OpenPropertyStore(STGM_READ, properties.GetAddressOf());
if (SUCCEEDED(hr)) {
base::win::ScopedPropVariant friendly_name;
hr = properties->GetValue(PKEY_Device_FriendlyName,
friendly_name.Receive());
// Store the user-friendly name.
if (SUCCEEDED(hr) && friendly_name.get().vt == VT_LPWSTR &&
friendly_name.get().pwszVal) {
device.device_name = base::WideToUTF8(friendly_name.get().pwszVal);
}
// Append VID/PID to USB devices.
std::string controller_id = CoreAudioUtil::GetAudioControllerID(
audio_device.Get(), enumerator.Get());
std::string vid_pid_suffix = GetUsbVidPidSuffixWin(controller_id);
if (!vid_pid_suffix.empty())
device.device_name += vid_pid_suffix;
}
// Add combination of user-friendly and unique name to the output list.
device_names->push_back(device);
}
return true;
}
// The waveform API is weird in that it has completely separate but
// almost identical functions and structs for input devices vs. output
// devices. We deal with this by implementing the logic as a templated
// function that takes the functions and struct type to use as
// template parameters.
template <UINT(__stdcall* NumDevsFunc)(),
typename CAPSSTRUCT,
MMRESULT(__stdcall* DevCapsFunc)(UINT_PTR, CAPSSTRUCT*, UINT)>
static bool GetDeviceNamesWinXPImpl(AudioDeviceNames* device_names) {
// Retrieve the number of active waveform input devices.
UINT number_of_active_devices = NumDevsFunc();
if (number_of_active_devices == 0)
return true;
AudioDeviceName device;
CAPSSTRUCT capabilities;
MMRESULT err = MMSYSERR_NOERROR;
// Loop over all active capture devices and add friendly name and
// unique ID to the |device_names| list. Note that, for Wave on XP,
// the "unique" name will simply be a copy of the friendly name since
// there is no safe method to retrieve a unique device name on XP.
for (UINT i = 0; i < number_of_active_devices; ++i) {
// Retrieve the capabilities of the specified waveform-audio input device.
err = DevCapsFunc(i, &capabilities, sizeof(capabilities));
if (err != MMSYSERR_NOERROR)
continue;
// Store the user-friendly name. Max length is MAXPNAMELEN(=32)
// characters and the name cane be truncated on XP.
// Example: "Microphone (Realtek High Defini".
device.device_name = base::WideToUTF8(capabilities.szPname);
// Store the "unique" name (we use same as friendly name on Windows XP).
device.unique_id = device.device_name;
// Add combination of user-friendly and unique name to the output list.
device_names->push_back(device);
}
return true;
}
bool GetInputDeviceNamesWin(AudioDeviceNames* device_names) {
return GetDeviceNamesWinImpl(eCapture, device_names);
}
bool GetOutputDeviceNamesWin(AudioDeviceNames* device_names) {
return GetDeviceNamesWinImpl(eRender, device_names);
}
bool GetInputDeviceNamesWinXP(AudioDeviceNames* device_names) {
return GetDeviceNamesWinXPImpl<waveInGetNumDevs, WAVEINCAPSW,
waveInGetDevCapsW>(device_names);
}
bool GetOutputDeviceNamesWinXP(AudioDeviceNames* device_names) {
return GetDeviceNamesWinXPImpl<waveOutGetNumDevs, WAVEOUTCAPSW,
waveOutGetDevCapsW>(device_names);
}
std::string GetUsbVidPidSuffixWin(const std::string& controller_id) {
std::string vid_pid;
if (controller_id.size() >= 21 && controller_id.substr(0, 8) == "USB\\VID_" &&
controller_id.substr(12, 5) == "&PID_") {
vid_pid = " (" + base::ToLowerASCII(controller_id.substr(8, 4)) + ":" +
base::ToLowerASCII(controller_id.substr(17, 4)) + ")";
}
return vid_pid;
}
} // namespace media