// 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/mac/audio_manager_mac.h"
#include <CoreAudio/AudioHardware.h>
#include <string>
#include "base/bind.h"
#include "base/command_line.h"
#include "base/mac/mac_logging.h"
#include "base/mac/scoped_cftyperef.h"
#include "base/strings/sys_string_conversions.h"
#include "media/audio/audio_parameters.h"
#include "media/audio/mac/audio_auhal_mac.h"
#include "media/audio/mac/audio_input_mac.h"
#include "media/audio/mac/audio_low_latency_input_mac.h"
#include "media/audio/mac/audio_low_latency_output_mac.h"
#include "media/audio/mac/audio_synchronized_mac.h"
#include "media/audio/mac/audio_unified_mac.h"
#include "media/base/bind_to_loop.h"
#include "media/base/channel_layout.h"
#include "media/base/limits.h"
#include "media/base/media_switches.h"
namespace media {
// Maximum number of output streams that can be open simultaneously.
static const int kMaxOutputStreams = 50;
// Default buffer size in samples for low-latency input and output streams.
static const int kDefaultLowLatencyBufferSize = 128;
// Default sample-rate on most Apple hardware.
static const int kFallbackSampleRate = 44100;
static bool HasAudioHardware(AudioObjectPropertySelector selector) {
AudioDeviceID output_device_id = kAudioObjectUnknown;
const AudioObjectPropertyAddress property_address = {
selector,
kAudioObjectPropertyScopeGlobal, // mScope
kAudioObjectPropertyElementMaster // mElement
};
UInt32 output_device_id_size = static_cast<UInt32>(sizeof(output_device_id));
OSStatus err = AudioObjectGetPropertyData(kAudioObjectSystemObject,
&property_address,
0, // inQualifierDataSize
NULL, // inQualifierData
&output_device_id_size,
&output_device_id);
return err == kAudioHardwareNoError &&
output_device_id != kAudioObjectUnknown;
}
// Returns true if the default input device is the same as
// the default output device.
bool AudioManagerMac::HasUnifiedDefaultIO() {
AudioDeviceID input_id, output_id;
if (!GetDefaultInputDevice(&input_id) || !GetDefaultOutputDevice(&output_id))
return false;
return input_id == output_id;
}
// Retrieves information on audio devices, and prepends the default
// device to the list if the list is non-empty.
static void GetAudioDeviceInfo(bool is_input,
media::AudioDeviceNames* device_names) {
// Query the number of total devices.
AudioObjectPropertyAddress property_address = {
kAudioHardwarePropertyDevices,
kAudioObjectPropertyScopeGlobal,
kAudioObjectPropertyElementMaster
};
UInt32 size = 0;
OSStatus result = AudioObjectGetPropertyDataSize(kAudioObjectSystemObject,
&property_address,
0,
NULL,
&size);
if (result || !size)
return;
int device_count = size / sizeof(AudioDeviceID);
// Get the array of device ids for all the devices, which includes both
// input devices and output devices.
scoped_ptr_malloc<AudioDeviceID>
devices(reinterpret_cast<AudioDeviceID*>(malloc(size)));
AudioDeviceID* device_ids = devices.get();
result = AudioObjectGetPropertyData(kAudioObjectSystemObject,
&property_address,
0,
NULL,
&size,
device_ids);
if (result)
return;
// Iterate over all available devices to gather information.
for (int i = 0; i < device_count; ++i) {
// Get the number of input or output channels of the device.
property_address.mScope = is_input ?
kAudioDevicePropertyScopeInput : kAudioDevicePropertyScopeOutput;
property_address.mSelector = kAudioDevicePropertyStreams;
size = 0;
result = AudioObjectGetPropertyDataSize(device_ids[i],
&property_address,
0,
NULL,
&size);
if (result || !size)
continue;
// Get device UID.
CFStringRef uid = NULL;
size = sizeof(uid);
property_address.mSelector = kAudioDevicePropertyDeviceUID;
property_address.mScope = kAudioObjectPropertyScopeGlobal;
result = AudioObjectGetPropertyData(device_ids[i],
&property_address,
0,
NULL,
&size,
&uid);
if (result)
continue;
// Get device name.
CFStringRef name = NULL;
property_address.mSelector = kAudioObjectPropertyName;
property_address.mScope = kAudioObjectPropertyScopeGlobal;
result = AudioObjectGetPropertyData(device_ids[i],
&property_address,
0,
NULL,
&size,
&name);
if (result) {
if (uid)
CFRelease(uid);
continue;
}
// Store the device name and UID.
media::AudioDeviceName device_name;
device_name.device_name = base::SysCFStringRefToUTF8(name);
device_name.unique_id = base::SysCFStringRefToUTF8(uid);
device_names->push_back(device_name);
// We are responsible for releasing the returned CFObject. See the
// comment in the AudioHardware.h for constant
// kAudioDevicePropertyDeviceUID.
if (uid)
CFRelease(uid);
if (name)
CFRelease(name);
}
if (!device_names->empty()) {
// Prepend the default device to the list since we always want it to be
// on the top of the list for all platforms. There is no duplicate
// counting here since the default device has been abstracted out before.
media::AudioDeviceName name;
name.device_name = AudioManagerBase::kDefaultDeviceName;
name.unique_id = AudioManagerBase::kDefaultDeviceId;
device_names->push_front(name);
}
}
static AudioDeviceID GetAudioDeviceIdByUId(bool is_input,
const std::string& device_id) {
AudioObjectPropertyAddress property_address = {
kAudioHardwarePropertyDevices,
kAudioObjectPropertyScopeGlobal,
kAudioObjectPropertyElementMaster
};
AudioDeviceID audio_device_id = kAudioObjectUnknown;
UInt32 device_size = sizeof(audio_device_id);
OSStatus result = -1;
if (device_id == AudioManagerBase::kDefaultDeviceId || device_id.empty()) {
// Default Device.
property_address.mSelector = is_input ?
kAudioHardwarePropertyDefaultInputDevice :
kAudioHardwarePropertyDefaultOutputDevice;
result = AudioObjectGetPropertyData(kAudioObjectSystemObject,
&property_address,
0,
0,
&device_size,
&audio_device_id);
} else {
// Non-default device.
base::ScopedCFTypeRef<CFStringRef> uid(
base::SysUTF8ToCFStringRef(device_id));
AudioValueTranslation value;
value.mInputData = &uid;
value.mInputDataSize = sizeof(CFStringRef);
value.mOutputData = &audio_device_id;
value.mOutputDataSize = device_size;
UInt32 translation_size = sizeof(AudioValueTranslation);
property_address.mSelector = kAudioHardwarePropertyDeviceForUID;
result = AudioObjectGetPropertyData(kAudioObjectSystemObject,
&property_address,
0,
0,
&translation_size,
&value);
}
if (result) {
OSSTATUS_DLOG(WARNING, result) << "Unable to query device " << device_id
<< " for AudioDeviceID";
}
return audio_device_id;
}
AudioManagerMac::AudioManagerMac(AudioLogFactory* audio_log_factory)
: AudioManagerBase(audio_log_factory),
current_sample_rate_(0) {
current_output_device_ = kAudioDeviceUnknown;
SetMaxOutputStreamsAllowed(kMaxOutputStreams);
// Task must be posted last to avoid races from handing out "this" to the
// audio thread. Always PostTask even if we're on the right thread since
// AudioManager creation is on the startup path and this may be slow.
GetMessageLoop()->PostTask(FROM_HERE, base::Bind(
&AudioManagerMac::CreateDeviceListener, base::Unretained(this)));
}
AudioManagerMac::~AudioManagerMac() {
if (GetMessageLoop()->BelongsToCurrentThread()) {
DestroyDeviceListener();
} else {
// It's safe to post a task here since Shutdown() will wait for all tasks to
// complete before returning.
GetMessageLoop()->PostTask(FROM_HERE, base::Bind(
&AudioManagerMac::DestroyDeviceListener, base::Unretained(this)));
}
Shutdown();
}
bool AudioManagerMac::HasAudioOutputDevices() {
return HasAudioHardware(kAudioHardwarePropertyDefaultOutputDevice);
}
bool AudioManagerMac::HasAudioInputDevices() {
return HasAudioHardware(kAudioHardwarePropertyDefaultInputDevice);
}
// TODO(xians): There are several places on the OSX specific code which
// could benefit from these helper functions.
bool AudioManagerMac::GetDefaultInputDevice(
AudioDeviceID* device) {
return GetDefaultDevice(device, true);
}
bool AudioManagerMac::GetDefaultOutputDevice(
AudioDeviceID* device) {
return GetDefaultDevice(device, false);
}
bool AudioManagerMac::GetDefaultDevice(
AudioDeviceID* device, bool input) {
CHECK(device);
// Obtain the current output device selected by the user.
AudioObjectPropertyAddress pa;
pa.mSelector = input ? kAudioHardwarePropertyDefaultInputDevice :
kAudioHardwarePropertyDefaultOutputDevice;
pa.mScope = kAudioObjectPropertyScopeGlobal;
pa.mElement = kAudioObjectPropertyElementMaster;
UInt32 size = sizeof(*device);
OSStatus result = AudioObjectGetPropertyData(
kAudioObjectSystemObject,
&pa,
0,
0,
&size,
device);
if ((result != kAudioHardwareNoError) || (*device == kAudioDeviceUnknown)) {
DLOG(ERROR) << "Error getting default AudioDevice.";
return false;
}
return true;
}
bool AudioManagerMac::GetDefaultOutputChannels(
int* channels) {
AudioDeviceID device;
if (!GetDefaultOutputDevice(&device))
return false;
return GetDeviceChannels(device,
kAudioDevicePropertyScopeOutput,
channels);
}
bool AudioManagerMac::GetDeviceChannels(
AudioDeviceID device,
AudioObjectPropertyScope scope,
int* channels) {
CHECK(channels);
// Get stream configuration.
AudioObjectPropertyAddress pa;
pa.mSelector = kAudioDevicePropertyStreamConfiguration;
pa.mScope = scope;
pa.mElement = kAudioObjectPropertyElementMaster;
UInt32 size;
OSStatus result = AudioObjectGetPropertyDataSize(device, &pa, 0, 0, &size);
if (result != noErr || !size)
return false;
// Allocate storage.
scoped_ptr<uint8[]> list_storage(new uint8[size]);
AudioBufferList& buffer_list =
*reinterpret_cast<AudioBufferList*>(list_storage.get());
result = AudioObjectGetPropertyData(
device,
&pa,
0,
0,
&size,
&buffer_list);
if (result != noErr)
return false;
// Determine number of input channels.
int channels_per_frame = buffer_list.mNumberBuffers > 0 ?
buffer_list.mBuffers[0].mNumberChannels : 0;
if (channels_per_frame == 1 && buffer_list.mNumberBuffers > 1) {
// Non-interleaved.
*channels = buffer_list.mNumberBuffers;
} else {
// Interleaved.
*channels = channels_per_frame;
}
return true;
}
int AudioManagerMac::HardwareSampleRateForDevice(AudioDeviceID device_id) {
Float64 nominal_sample_rate;
UInt32 info_size = sizeof(nominal_sample_rate);
static const AudioObjectPropertyAddress kNominalSampleRateAddress = {
kAudioDevicePropertyNominalSampleRate,
kAudioObjectPropertyScopeGlobal,
kAudioObjectPropertyElementMaster
};
OSStatus result = AudioObjectGetPropertyData(
device_id,
&kNominalSampleRateAddress,
0,
0,
&info_size,
&nominal_sample_rate);
if (result != noErr) {
OSSTATUS_DLOG(WARNING, result)
<< "Could not get default sample rate for device: " << device_id;
return 0;
}
return static_cast<int>(nominal_sample_rate);
}
int AudioManagerMac::HardwareSampleRate() {
// Determine the default output device's sample-rate.
AudioDeviceID device_id = kAudioObjectUnknown;
if (!GetDefaultOutputDevice(&device_id))
return kFallbackSampleRate;
return HardwareSampleRateForDevice(device_id);
}
void AudioManagerMac::GetAudioInputDeviceNames(
media::AudioDeviceNames* device_names) {
DCHECK(device_names->empty());
GetAudioDeviceInfo(true, device_names);
}
void AudioManagerMac::GetAudioOutputDeviceNames(
media::AudioDeviceNames* device_names) {
DCHECK(device_names->empty());
GetAudioDeviceInfo(false, device_names);
}
AudioParameters AudioManagerMac::GetInputStreamParameters(
const std::string& device_id) {
// Due to the sharing of the input and output buffer sizes, we need to choose
// the input buffer size based on the output sample rate. See
// http://crbug.com/154352.
const int buffer_size = ChooseBufferSize(
AUAudioOutputStream::HardwareSampleRate());
AudioDeviceID device = GetAudioDeviceIdByUId(true, device_id);
if (device == kAudioObjectUnknown) {
DLOG(ERROR) << "Invalid device " << device_id;
return AudioParameters();
}
int channels = 0;
ChannelLayout channel_layout = CHANNEL_LAYOUT_STEREO;
if (GetDeviceChannels(device, kAudioDevicePropertyScopeInput, &channels) &&
channels <= 2) {
channel_layout = GuessChannelLayout(channels);
} else {
DLOG(ERROR) << "Failed to get the device channels, use stereo as default "
<< "for device " << device_id;
}
int sample_rate = HardwareSampleRateForDevice(device);
if (!sample_rate)
sample_rate = kFallbackSampleRate;
// TODO(xians): query the native channel layout for the specific device.
return AudioParameters(
AudioParameters::AUDIO_PCM_LOW_LATENCY, channel_layout,
sample_rate, 16, buffer_size);
}
std::string AudioManagerMac::GetAssociatedOutputDeviceID(
const std::string& input_device_id) {
AudioDeviceID device = GetAudioDeviceIdByUId(true, input_device_id);
if (device == kAudioObjectUnknown)
return std::string();
UInt32 size = 0;
AudioObjectPropertyAddress pa = {
kAudioDevicePropertyRelatedDevices,
kAudioDevicePropertyScopeOutput,
kAudioObjectPropertyElementMaster
};
OSStatus result = AudioObjectGetPropertyDataSize(device, &pa, 0, 0, &size);
if (result || !size)
return std::string();
int device_count = size / sizeof(AudioDeviceID);
scoped_ptr_malloc<AudioDeviceID>
devices(reinterpret_cast<AudioDeviceID*>(malloc(size)));
result = AudioObjectGetPropertyData(
device, &pa, 0, NULL, &size, devices.get());
if (result)
return std::string();
std::vector<std::string> associated_devices;
for (int i = 0; i < device_count; ++i) {
// Get the number of output channels of the device.
pa.mSelector = kAudioDevicePropertyStreams;
size = 0;
result = AudioObjectGetPropertyDataSize(devices.get()[i],
&pa,
0,
NULL,
&size);
if (result || !size)
continue; // Skip if there aren't any output channels.
// Get device UID.
CFStringRef uid = NULL;
size = sizeof(uid);
pa.mSelector = kAudioDevicePropertyDeviceUID;
result = AudioObjectGetPropertyData(devices.get()[i],
&pa,
0,
NULL,
&size,
&uid);
if (result || !uid)
continue;
std::string ret(base::SysCFStringRefToUTF8(uid));
CFRelease(uid);
associated_devices.push_back(ret);
}
// No matching device found.
if (associated_devices.empty())
return std::string();
// Return the device if there is only one associated device.
if (associated_devices.size() == 1)
return associated_devices[0];
// When there are multiple associated devices, we currently do not have a way
// to detect if a device (e.g. a digital output device) is actually connected
// to an endpoint, so we cannot randomly pick a device.
// We pick the device iff the associated device is the default output device.
const std::string default_device = GetDefaultOutputDeviceID();
for (std::vector<std::string>::const_iterator iter =
associated_devices.begin();
iter != associated_devices.end(); ++iter) {
if (default_device == *iter)
return *iter;
}
// Failed to figure out which is the matching device, return an emtpy string.
return std::string();
}
AudioOutputStream* AudioManagerMac::MakeLinearOutputStream(
const AudioParameters& params) {
return MakeLowLatencyOutputStream(params, std::string(), std::string());
}
AudioOutputStream* AudioManagerMac::MakeLowLatencyOutputStream(
const AudioParameters& params,
const std::string& device_id,
const std::string& input_device_id) {
// Handle basic output with no input channels.
if (params.input_channels() == 0) {
AudioDeviceID device = GetAudioDeviceIdByUId(false, device_id);
if (device == kAudioObjectUnknown) {
DLOG(ERROR) << "Failed to open output device: " << device_id;
return NULL;
}
return new AUHALStream(this, params, device);
}
DLOG_IF(ERROR, !device_id.empty()) << "Not implemented!";
// TODO(xians): support more than stereo input.
if (params.input_channels() != 2) {
// WebAudio is currently hard-coded to 2 channels so we should not
// see this case.
NOTREACHED() << "Only stereo input is currently supported!";
return NULL;
}
AudioDeviceID device = kAudioObjectUnknown;
if (HasUnifiedDefaultIO()) {
// For I/O, the simplest case is when the default input and output
// devices are the same.
GetDefaultOutputDevice(&device);
VLOG(0) << "UNIFIED: default input and output devices are identical";
} else {
// Some audio hardware is presented as separate input and output devices
// even though they are really the same physical hardware and
// share the same "clock domain" at the lowest levels of the driver.
// A common of example of this is the "built-in" audio hardware:
// "Built-in Line Input"
// "Built-in Output"
// We would like to use an "aggregate" device for these situations, since
// CoreAudio will make the most efficient use of the shared "clock domain"
// so we get the lowest latency and use fewer threads.
device = aggregate_device_manager_.GetDefaultAggregateDevice();
if (device != kAudioObjectUnknown)
VLOG(0) << "Using AGGREGATE audio device";
}
if (device != kAudioObjectUnknown &&
input_device_id == AudioManagerBase::kDefaultDeviceId)
return new AUHALStream(this, params, device);
// Fallback to AudioSynchronizedStream which will handle completely
// different and arbitrary combinations of input and output devices
// even running at different sample-rates.
// kAudioDeviceUnknown translates to "use default" here.
// TODO(xians): consider tracking UMA stats on AUHALStream
// versus AudioSynchronizedStream.
AudioDeviceID audio_device_id = GetAudioDeviceIdByUId(true, input_device_id);
if (audio_device_id == kAudioObjectUnknown)
return NULL;
return new AudioSynchronizedStream(this,
params,
audio_device_id,
kAudioDeviceUnknown);
}
std::string AudioManagerMac::GetDefaultOutputDeviceID() {
AudioDeviceID device_id = kAudioObjectUnknown;
if (!GetDefaultOutputDevice(&device_id))
return std::string();
const AudioObjectPropertyAddress property_address = {
kAudioDevicePropertyDeviceUID,
kAudioObjectPropertyScopeGlobal,
kAudioObjectPropertyElementMaster
};
CFStringRef device_uid = NULL;
UInt32 size = sizeof(device_uid);
OSStatus status = AudioObjectGetPropertyData(device_id,
&property_address,
0,
NULL,
&size,
&device_uid);
if (status != kAudioHardwareNoError || !device_uid)
return std::string();
std::string ret(base::SysCFStringRefToUTF8(device_uid));
CFRelease(device_uid);
return ret;
}
AudioInputStream* AudioManagerMac::MakeLinearInputStream(
const AudioParameters& params, const std::string& device_id) {
DCHECK_EQ(AudioParameters::AUDIO_PCM_LINEAR, params.format());
return new PCMQueueInAudioInputStream(this, params);
}
AudioInputStream* AudioManagerMac::MakeLowLatencyInputStream(
const AudioParameters& params, const std::string& device_id) {
DCHECK_EQ(AudioParameters::AUDIO_PCM_LOW_LATENCY, params.format());
// Gets the AudioDeviceID that refers to the AudioInputDevice with the device
// unique id. This AudioDeviceID is used to set the device for Audio Unit.
AudioDeviceID audio_device_id = GetAudioDeviceIdByUId(true, device_id);
AudioInputStream* stream = NULL;
if (audio_device_id != kAudioObjectUnknown) {
// AUAudioInputStream needs to be fed the preferred audio output parameters
// of the matching device so that the buffer size of both input and output
// can be matched. See constructor of AUAudioInputStream for more.
const std::string associated_output_device(
GetAssociatedOutputDeviceID(device_id));
const AudioParameters output_params =
GetPreferredOutputStreamParameters(
associated_output_device.empty() ?
AudioManagerBase::kDefaultDeviceId : associated_output_device,
params);
stream = new AUAudioInputStream(this, params, output_params,
audio_device_id);
}
return stream;
}
AudioParameters AudioManagerMac::GetPreferredOutputStreamParameters(
const std::string& output_device_id,
const AudioParameters& input_params) {
AudioDeviceID device = GetAudioDeviceIdByUId(false, output_device_id);
if (device == kAudioObjectUnknown) {
DLOG(ERROR) << "Invalid output device " << output_device_id;
return AudioParameters();
}
int hardware_channels = 2;
if (!GetDeviceChannels(device, kAudioDevicePropertyScopeOutput,
&hardware_channels)) {
// Fallback to stereo.
hardware_channels = 2;
}
ChannelLayout channel_layout = GuessChannelLayout(hardware_channels);
const int hardware_sample_rate = HardwareSampleRateForDevice(device);
const int buffer_size = ChooseBufferSize(hardware_sample_rate);
int input_channels = 0;
if (input_params.IsValid()) {
input_channels = input_params.input_channels();
if (input_channels > 0) {
// TODO(xians): given the limitations of the AudioOutputStream
// back-ends used with synchronized I/O, we hard-code to stereo.
// Specifically, this is a limitation of AudioSynchronizedStream which
// can be removed as part of the work to consolidate these back-ends.
channel_layout = CHANNEL_LAYOUT_STEREO;
}
}
if (channel_layout == CHANNEL_LAYOUT_UNSUPPORTED)
channel_layout = CHANNEL_LAYOUT_DISCRETE;
else
hardware_channels = ChannelLayoutToChannelCount(channel_layout);
AudioParameters params(
AudioParameters::AUDIO_PCM_LOW_LATENCY,
channel_layout,
hardware_channels,
input_channels,
hardware_sample_rate,
16,
buffer_size,
AudioParameters::NO_EFFECTS);
return params;
}
void AudioManagerMac::CreateDeviceListener() {
DCHECK(GetMessageLoop()->BelongsToCurrentThread());
// Get a baseline for the sample-rate and current device,
// so we can intelligently handle device notifications only when necessary.
current_sample_rate_ = HardwareSampleRate();
if (!GetDefaultOutputDevice(¤t_output_device_))
current_output_device_ = kAudioDeviceUnknown;
output_device_listener_.reset(new AudioDeviceListenerMac(base::Bind(
&AudioManagerMac::HandleDeviceChanges, base::Unretained(this))));
}
void AudioManagerMac::DestroyDeviceListener() {
DCHECK(GetMessageLoop()->BelongsToCurrentThread());
output_device_listener_.reset();
}
void AudioManagerMac::HandleDeviceChanges() {
if (!GetMessageLoop()->BelongsToCurrentThread()) {
GetMessageLoop()->PostTask(FROM_HERE, base::Bind(
&AudioManagerMac::HandleDeviceChanges, base::Unretained(this)));
return;
}
int new_sample_rate = HardwareSampleRate();
AudioDeviceID new_output_device;
GetDefaultOutputDevice(&new_output_device);
if (current_sample_rate_ == new_sample_rate &&
current_output_device_ == new_output_device)
return;
current_sample_rate_ = new_sample_rate;
current_output_device_ = new_output_device;
NotifyAllOutputDeviceChangeListeners();
}
int AudioManagerMac::ChooseBufferSize(int output_sample_rate) {
int buffer_size = kDefaultLowLatencyBufferSize;
const int user_buffer_size = GetUserBufferSize();
if (user_buffer_size) {
buffer_size = user_buffer_size;
} else if (output_sample_rate > 48000) {
// The default buffer size is too small for higher sample rates and may lead
// to glitching. Adjust upwards by multiples of the default size.
if (output_sample_rate <= 96000)
buffer_size = 2 * kDefaultLowLatencyBufferSize;
else if (output_sample_rate <= 192000)
buffer_size = 4 * kDefaultLowLatencyBufferSize;
}
return buffer_size;
}
AudioManager* CreateAudioManager(AudioLogFactory* audio_log_factory) {
return new AudioManagerMac(audio_log_factory);
}
} // namespace media