Mirrors/BackgroundMusic
2
0
Fork 0
mirror of https://github.com/kyleneideck/BackgroundMusic synced 2024-11-22 20:23:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix exception in Mock_CAHALAudioObject during BGMApp unit tests.

Browse source 
Also, avoid initialising BGMDeviceControlsList in
BGMMockAudioDeviceManager::init.
This commit is contained in:
Kyle Neideck 2017-06-01 20:10:35 +10:00
parent c617d98f9d
commit b986b687ea
No known key found for this signature in database
GPG key ID: CAA8D9B8E39EC18C
3 changed files with 88 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

128
BGMApp/BGMApp/BGMDeviceControlsList.cpp
View file

@ -45,61 +45,11 @@ BGMDeviceControlsList::BGMDeviceControlsList(AudioObjectID inBGMDevice,
CAHALAudioSystemObject inAudioSystem)
:
mBGMDevice(inBGMDevice),
mAudioSystem(inAudioSystem),
mDeviceToggleBlock(CreateDeviceToggleBlock()),
mDeviceToggleBackBlock(CreateDeviceToggleBackBlock()),
mDisableNullDeviceBlock(CreateDisableNullDeviceBlock())
mAudioSystem(inAudioSystem)
{
BGMAssert((mBGMDevice.GetObjectID() == mAudioSystem.GetAudioDeviceForUID(CFSTR(kBGMDeviceUID)) ||
mBGMDevice.GetObjectID() == kAudioObjectUnknown),
"BGMDeviceControlsList::BGMDeviceControlsList: Given device is not BGMDevice");
// Register a listener to find out when the Null Device becomes available/unavailable. See
// ToggleDefaultDevice.
dispatch_queue_attr_t attr =
dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_DEFAULT, 0);
mListenerQueue = dispatch_queue_create("com.bearisdriving.BGM.BGMDeviceControlsList", attr);
mListenerBlock = ^(UInt32 inNumberAddresses, const AudioObjectPropertyAddress* inAddresses) {
// Ignore the notification if we're not toggling the default device, which would just mean
// the default device has been changed for an unrelated reason.
if(mDeviceToggleState == ToggleState::NotToggling)
{
return;
}
for(int i = 0; i < inNumberAddresses; i++)
{
switch(inAddresses[i].mSelector)
{
case kAudioHardwarePropertyDevices:
{
CAMutex::Locker locker(mMutex);
DebugMsg("BGMDeviceControlsList::mListenerBlock: Got "
"kAudioHardwarePropertyDevices");
// Cancel the previous block in case it hasn't run yet.
DestroyBlock(mDeviceToggleBlock);
mDeviceToggleBlock = CreateDeviceToggleBlock();
// Changing the default device too quickly after enabling the Null Device
// seems to cause problems with some programs. Not sure why.
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, kToggleDeviceInitialDelay),
dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0),
mDeviceToggleBlock);
}
break;
}
}
};
BGMLogAndSwallowExceptions("BGMDeviceControlsList::BGMDeviceControlsList", [&] {
mAudioSystem.AddPropertyListenerBlock(CAPropertyAddress(kAudioHardwarePropertyDevices),
mListenerQueue,
mListenerBlock);
});
}
BGMDeviceControlsList::~BGMDeviceControlsList()
@ -143,6 +93,8 @@ BGMDeviceControlsList::~BGMDeviceControlsList()
dispatch_release(mListenerQueue);
}
#pragma mark Accessors
void BGMDeviceControlsList::SetBGMDevice(AudioObjectID inBGMDeviceID)
{
CAMutex::Locker locker(mMutex);
@ -153,10 +105,14 @@ void BGMDeviceControlsList::SetBGMDevice(AudioObjectID inBGMDeviceID)
"BGMDeviceControlsList::SetBGMDevice: Given device is not BGMDevice");
}
#pragma mark Update Controls List
bool BGMDeviceControlsList::MatchControlsListOf(AudioObjectID inDeviceID)
{
CAMutex::Locker locker(mMutex);
LazyInit();
if(mBGMDevice == kAudioObjectUnknown)
{
return false;
@ -272,6 +228,8 @@ void BGMDeviceControlsList::PropagateControlListChange()
{
CAMutex::Locker locker(mMutex);
LazyInit();
if(mBGMDevice == kAudioObjectUnknown)
{
return;
@ -307,7 +265,73 @@ void BGMDeviceControlsList::PropagateControlListChange()
}
}
#pragma mark Toggling the Default Device
#pragma mark Implementation
void BGMDeviceControlsList::LazyInit()
{
CAMutex::Locker locker(mMutex);
if(mInitialised)
{
return;
}
BGMAssert(mBGMDevice.GetObjectID() == mAudioSystem.GetAudioDeviceForUID(CFSTR(kBGMDeviceUID)),
"BGMDeviceControlsList::LazyInit: mBGMDevice device is not set to BGMDevice's ID");
mDeviceToggleBlock = CreateDeviceToggleBlock();
mDeviceToggleBackBlock = CreateDeviceToggleBackBlock();
mDisableNullDeviceBlock = CreateDisableNullDeviceBlock();
// Register a listener to find out when the Null Device becomes available/unavailable. See
// ToggleDefaultDevice.
dispatch_queue_attr_t attr =
dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_DEFAULT, 0);
mListenerQueue = dispatch_queue_create("com.bearisdriving.BGM.BGMDeviceControlsList", attr);
mListenerBlock = ^(UInt32 inNumberAddresses, const AudioObjectPropertyAddress* inAddresses) {
// Ignore the notification if we're not toggling the default device, which would just mean
// the default device has been changed for an unrelated reason.
if(mDeviceToggleState == ToggleState::NotToggling)
{
return;
}
for(int i = 0; i < inNumberAddresses; i++)
{
switch(inAddresses[i].mSelector)
{
case kAudioHardwarePropertyDevices:
{
CAMutex::Locker innerLocker(mMutex);
DebugMsg("BGMDeviceControlsList::LazyInit: Got "
"kAudioHardwarePropertyDevices");
// Cancel the previous block in case it hasn't run yet.
DestroyBlock(mDeviceToggleBlock);
mDeviceToggleBlock = CreateDeviceToggleBlock();
// Changing the default device too quickly after enabling the Null Device
// seems to cause problems with some programs. Not sure why.
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, kToggleDeviceInitialDelay),
dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0),
mDeviceToggleBlock);
}
break;
}
}
};
BGMLogAndSwallowExceptions("BGMDeviceControlsList::LazyInit", [&] {
mAudioSystem.AddPropertyListenerBlock(CAPropertyAddress(kAudioHardwarePropertyDevices),
mListenerQueue,
mListenerBlock);
});
mInitialised = true;
}
void BGMDeviceControlsList::ToggleDefaultDevice()
{

12
BGMApp/BGMApp/BGMDeviceControlsList.h
View file

@ -53,8 +53,13 @@ public:
BGMDeviceControlsList(const BGMDeviceControlsList&) = delete;
BGMDeviceControlsList& operator=(const BGMDeviceControlsList&) = delete;
#pragma mark Accessors
/*! @param inBGMDeviceID The ID of BGMDevice. */
void SetBGMDevice(AudioObjectID inBGMDeviceID);
#pragma mark Update Controls List
/*!
Enable the BGMDevice controls (volume and mute currently) that can be matched to controls of
the given device, and disable the ones that can't.
@ -80,7 +85,11 @@ public:
*/
void PropagateControlListChange();
#pragma mark Implementation
private:
/* This class is lazily initialised, mainly as a convenience for the unit tests. */
void LazyInit();
/*! Changes the OS X default audio device to the Null Device and then back to BGMDevice. */
void ToggleDefaultDevice();
/*!
@ -99,7 +108,8 @@ private:
void DestroyBlock(dispatch_block_t __nullable & block);
private:
CAMutex mMutex { "Device Controls List" };
CAMutex mMutex { "Device Controls List" };
bool mInitialised = false;
BGMAudioDevice mBGMDevice;
CAHALAudioSystemObject mAudioSystem; // Not guarded by the mutex.

2
BGMApp/BGMAppTests/UnitTests/Mock_CAHALAudioObject.cpp
View file

@ -66,7 +66,7 @@ void CAHALAudioObject::SetPropertyData(const AudioObjectPropertyAddress& inAddre
AudioObjectID CAHALAudioObject::GetObjectID() const
{
Throw(new CAException(kAudio_UnimplementedError));
return kAudioObjectUnknown;
}
void CAHALAudioObject::SetObjectID(AudioObjectID inObjectID)