blob: 201d14780b7cba18a15aa342ea306d3a9236d0da [file] [log] [blame]
/*
**
** Copyright 2019, The Android Open Source Project
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
** http://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
#define LOG_TAG "DeviceEffectManager"
//#define LOG_NDEBUG 0
#include "DeviceEffectManager.h"
#include "EffectConfiguration.h"
#include <afutils/DumpTryLock.h>
#include <audio_utils/primitives.h>
#include <media/audiohal/EffectsFactoryHalInterface.h>
#include <utils/Log.h>
// ----------------------------------------------------------------------------
namespace android {
using detail::AudioHalVersionInfo;
using media::IEffectClient;
DeviceEffectManager::DeviceEffectManager(
const sp<IAfDeviceEffectManagerCallback>& afDeviceEffectManagerCallback)
: mAfDeviceEffectManagerCallback(afDeviceEffectManagerCallback),
mMyCallback(sp<DeviceEffectManagerCallback>::make(*this)) {}
void DeviceEffectManager::onFirstRef() {
mAfDeviceEffectManagerCallback->getPatchCommandThread()->addListener(this);
}
status_t DeviceEffectManager::addEffectToHal(const struct audio_port_config* device,
const sp<EffectHalInterface>& effect) {
return mAfDeviceEffectManagerCallback->addEffectToHal(device, effect);
};
status_t DeviceEffectManager::removeEffectFromHal(const struct audio_port_config* device,
const sp<EffectHalInterface>& effect) {
return mAfDeviceEffectManagerCallback->removeEffectFromHal(device, effect);
};
void DeviceEffectManager::onCreateAudioPatch(audio_patch_handle_t handle,
const IAfPatchPanel::Patch& patch) {
ALOGV("%s handle %d mHalHandle %d device sink %08x",
__func__, handle, patch.mHalHandle,
patch.mAudioPatch.num_sinks > 0 ? patch.mAudioPatch.sinks[0].ext.device.type : 0);
audio_utils::lock_guard _l(mutex());
for (auto& effectProxies : mDeviceEffects) {
for (auto& effect : effectProxies.second) {
const status_t status = effect->onCreatePatch(handle, patch);
ALOGV("%s Effect onCreatePatch status %d", __func__, status);
ALOGW_IF(status == BAD_VALUE, "%s onCreatePatch error %d", __func__, status);
}
}
}
void DeviceEffectManager::onReleaseAudioPatch(audio_patch_handle_t handle) {
ALOGV("%s", __func__);
audio_utils::lock_guard _l(mutex());
for (auto& effectProxies : mDeviceEffects) {
for (auto& effect : effectProxies.second) {
effect->onReleasePatch(handle);
}
}
}
void DeviceEffectManager::onUpdateAudioPatch(audio_patch_handle_t oldHandle,
audio_patch_handle_t newHandle, const IAfPatchPanel::Patch& patch) {
ALOGV("%s oldhandle %d newHandle %d mHalHandle %d device sink %08x",
__func__, oldHandle, newHandle, patch.mHalHandle,
patch.mAudioPatch.num_sinks > 0 ? patch.mAudioPatch.sinks[0].ext.device.type : 0);
audio_utils::lock_guard _l(mutex());
for (auto& effectProxies : mDeviceEffects) {
for (auto& effect : effectProxies.second) {
const status_t status = effect->onUpdatePatch(oldHandle, newHandle, patch);
ALOGV("%s Effect onUpdatePatch status %d", __func__, status);
ALOGW_IF(status != NO_ERROR, "%s onUpdatePatch error %d", __func__, status);
}
}
}
// DeviceEffectManager::createEffect_l() must be called with AudioFlinger::mutex() held
sp<IAfEffectHandle> DeviceEffectManager::createEffect_l(
effect_descriptor_t *descriptor,
const AudioDeviceTypeAddr& device,
const sp<Client>& client,
const sp<IEffectClient>& effectClient,
const std::map<audio_patch_handle_t, IAfPatchPanel::Patch>& patches,
int *enabled,
status_t *status,
bool probe,
bool notifyFramesProcessed) {
sp<IAfDeviceEffectProxy> effect;
std::vector<sp<IAfDeviceEffectProxy>> effectsForDevice = {};
sp<IAfEffectHandle> handle;
status_t lStatus;
lStatus = checkEffectCompatibility(descriptor);
if (probe || lStatus != NO_ERROR) {
*status = lStatus;
return handle;
}
{
audio_utils::lock_guard _l(mutex());
auto iter = mDeviceEffects.find(device);
if (iter != mDeviceEffects.end()) {
effectsForDevice = iter->second;
for (const auto& iterEffect : effectsForDevice) {
if (memcmp(&iterEffect->desc().uuid, &descriptor->uuid, sizeof(effect_uuid_t)) ==
0) {
effect = iterEffect;
break;
}
}
}
if (effect == nullptr) {
effect = IAfDeviceEffectProxy::create(device, mMyCallback,
descriptor,
mAfDeviceEffectManagerCallback->nextUniqueId(AUDIO_UNIQUE_ID_USE_EFFECT),
notifyFramesProcessed);
effectsForDevice.push_back(effect);
}
// create effect handle and connect it to effect module
handle = IAfEffectHandle::create(
effect, client, effectClient, 0 /*priority*/, notifyFramesProcessed);
lStatus = handle->initCheck();
if (lStatus == NO_ERROR) {
lStatus = effect->addHandle(handle.get());
if (lStatus == NO_ERROR) {
lStatus = effect->init(patches);
if (lStatus == NAME_NOT_FOUND) {
lStatus = NO_ERROR;
}
if (lStatus == NO_ERROR || lStatus == ALREADY_EXISTS) {
mDeviceEffects.erase(device);
mDeviceEffects.emplace(device, effectsForDevice);
}
}
}
}
if (enabled != nullptr) {
*enabled = (int)effect->isEnabled();
}
*status = lStatus;
return handle;
}
/* static */
status_t DeviceEffectManager::checkEffectCompatibility(
const effect_descriptor_t *desc) {
const sp<EffectsFactoryHalInterface> effectsFactory =
audioflinger::EffectConfiguration::getEffectsFactoryHal();
if (effectsFactory == nullptr) {
return BAD_VALUE;
}
static const AudioHalVersionInfo sMinDeviceEffectHalVersion =
AudioHalVersionInfo(AudioHalVersionInfo::Type::HIDL, 6, 0);
static const AudioHalVersionInfo halVersion =
audioflinger::EffectConfiguration::getAudioHalVersionInfo();
// We can trust AIDL generated AudioHalVersionInfo comparison operator (based on std::tie) as
// long as the type, major and minor sequence doesn't change in the definition.
if (((desc->flags & EFFECT_FLAG_TYPE_MASK) != EFFECT_FLAG_TYPE_PRE_PROC
&& (desc->flags & EFFECT_FLAG_TYPE_MASK) != EFFECT_FLAG_TYPE_POST_PROC)
|| halVersion < sMinDeviceEffectHalVersion) {
ALOGW("%s() non pre/post processing device effect %s or incompatible API version %s",
__func__, desc->name, halVersion.toString().c_str());
return BAD_VALUE;
}
return NO_ERROR;
}
/* static */
status_t DeviceEffectManager::createEffectHal(
const effect_uuid_t *pEffectUuid, int32_t sessionId, int32_t deviceId,
sp<EffectHalInterface> *effect) {
status_t status = NO_INIT;
const sp<EffectsFactoryHalInterface> effectsFactory =
audioflinger::EffectConfiguration::getEffectsFactoryHal();
if (effectsFactory != 0) {
status = effectsFactory->createEffect(
pEffectUuid, sessionId, AUDIO_IO_HANDLE_NONE, deviceId, effect);
}
return status;
}
void DeviceEffectManager::dump(int fd)
NO_THREAD_SAFETY_ANALYSIS // conditional try lock
{
const bool locked = afutils::dumpTryLock(mutex());
if (!locked) {
String8 result("DeviceEffectManager may be deadlocked\n");
write(fd, result.c_str(), result.size());
}
String8 heading("\nDevice Effects:\n");
write(fd, heading.c_str(), heading.size());
for (const auto& iter : mDeviceEffects) {
String8 outStr;
outStr.appendFormat("%*sEffect for device %s address %s:\n", 2, "",
::android::toString(iter.first.mType).c_str(), iter.first.getAddress());
for (const auto& effect : iter.second) {
write(fd, outStr.c_str(), outStr.size());
effect->dump2(fd, 4);
}
}
if (locked) {
mutex().unlock();
}
}
size_t DeviceEffectManager::removeEffect(const sp<IAfDeviceEffectProxy>& effect)
{
audio_utils::lock_guard _l(mutex());
const auto& iter = mDeviceEffects.find(effect->device());
if (iter != mDeviceEffects.end()) {
const auto& iterEffect = std::find_if(
iter->second.begin(), iter->second.end(), [&effect](const auto& effectProxy) {
return memcmp(&effectProxy->desc().uuid, &effect->desc().uuid,
sizeof(effect_uuid_t)) == 0;
});
if (iterEffect != iter->second.end()) {
iter->second.erase(iterEffect);
if (iter->second.empty()) {
mDeviceEffects.erase(effect->device());
}
}
}
return mDeviceEffects.size();
}
bool DeviceEffectManagerCallback::disconnectEffectHandle(
IAfEffectHandle *handle, bool unpinIfLast) {
sp<IAfEffectBase> effectBase = handle->effect().promote();
if (effectBase == nullptr) {
return false;
}
sp<IAfDeviceEffectProxy> effect = effectBase->asDeviceEffectProxy();
if (effect == nullptr) {
return false;
}
// restore suspended effects if the disconnected handle was enabled and the last one.
bool remove = (effect->removeHandle(handle) == 0) && (!effect->isPinned() || unpinIfLast);
if (remove) {
mManager.removeEffect(effect);
if (handle->enabled()) {
effectBase->checkSuspendOnEffectEnabled(false, false /*threadLocked*/);
}
}
return true;
}
bool DeviceEffectManagerCallback::isAudioPolicyReady() const {
return mManager.afDeviceEffectManagerCallback()->isAudioPolicyReady();
}
int DeviceEffectManagerCallback::newEffectId() const {
return mManager.afDeviceEffectManagerCallback()->nextUniqueId(AUDIO_UNIQUE_ID_USE_EFFECT);
}
} // namespace android