| /* |
| * Copyright 2022 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_NDEBUG 0 |
| #define LOG_TAG "audio_utils_MelProcessor" |
| // #define VERY_VERY_VERBOSE_LOGGING |
| #ifdef VERY_VERY_VERBOSE_LOGGING |
| #define ALOGVV ALOGV |
| #else |
| #define ALOGVV(a...) do { } while(0) |
| #endif |
| |
| #include <audio_utils/MelProcessor.h> |
| |
| #include <audio_utils/format.h> |
| #include <audio_utils/power.h> |
| #include <log/log.h> |
| #include <sstream> |
| #include <utils/threads.h> |
| |
| namespace android::audio_utils { |
| |
| constexpr int32_t kSecondsPerMelValue = 1; |
| constexpr float kMelAdjustmentDb = -3.f; |
| |
| // Estimated offset defined in Table39 of IEC62368-1 3rd edition |
| // -30dBFS, -10dBFS should correspond to 80dBSPL, 100dBSPL |
| constexpr float kMeldBFSTodBSPLOffset = 110.f; |
| |
| constexpr float kRs1OutputdBFS = 80.f; // dBA |
| |
| constexpr float kRs2LowerBound = 80.f; // dBA |
| constexpr float kRs2UpperBound = 100.f; // dBA |
| |
| // The following arrays contain the IIR biquad filter coefficients for performing A-weighting as |
| // described in IEC 61672:2003 for samples with 44.1kHz and 48kHz. |
| constexpr std::array<std::array<float, kBiquadNumCoefs>, 2> kBiquadCoefs1 = |
| {{/* 44.1kHz= */{0.95616638497, -1.31960414122, 0.36343775625, -1.31861375911, 0.32059452332}, |
| /* 48kHz= */{0.96525096525, -1.34730163086, 0.38205066561, -1.34730722798, 0.34905752979}}}; |
| constexpr std::array<std::array<float, kBiquadNumCoefs>, 2> kBiquadCoefs2 = |
| {{/* 44.1kHz= */{0.94317138580, -1.88634277160, 0.94317138580, -1.88558607420, 0.88709946900}, |
| /* 48kHz= */{0.94696969696, -1.89393939393, 0.94696969696, -1.89387049481, 0.89515976917}}}; |
| constexpr std::array<std::array<float, kBiquadNumCoefs>, 2> kBiquadCoefs3 = |
| {{/* 44.1kHz= */{0.69736775447, -0.42552769920, -0.27184005527, -1.31859445445, 0.32058831623}, |
| /* 48kHz= */{0.64666542810, -0.38362237137, -0.26304305672, -1.34730722798, 0.34905752979}}}; |
| |
| MelProcessor::MelProcessor(uint32_t sampleRate, |
| uint32_t channelCount, |
| audio_format_t format, |
| const sp<MelCallback>& callback, |
| audio_port_handle_t deviceId, |
| float rs2Value, |
| size_t maxMelsCallback) |
| : mCallback(callback), |
| mMelWorker("MelWorker#" + pointerString(), mCallback), |
| mSampleRate(sampleRate), |
| mFramesPerMelValue(sampleRate * kSecondsPerMelValue), |
| mChannelCount(channelCount), |
| mFormat(format), |
| mAWeightSamples(mFramesPerMelValue * mChannelCount), |
| mFloatSamples(mFramesPerMelValue * mChannelCount), |
| mCurrentChannelEnergy(channelCount, 0.0f), |
| mMelValues(maxMelsCallback), |
| mCurrentIndex(0), |
| mDeviceId(deviceId), |
| mRs2UpperBound(rs2Value), |
| mCurrentSamples(0) |
| { |
| createBiquads_l(); |
| |
| mMelWorker.run(); |
| } |
| |
| bool MelProcessor::isSampleRateSupported_l() const { |
| // For now only support 44.1 and 48kHz for Mel calculation |
| if (mSampleRate != 44100 && mSampleRate != 48000) { |
| return false; |
| } |
| |
| return true; |
| } |
| |
| void MelProcessor::createBiquads_l() { |
| if (!isSampleRateSupported_l()) { |
| return; |
| } |
| |
| int coefsIndex = mSampleRate == 44100 ? 0 : 1; |
| mCascadedBiquads = |
| {std::make_unique<DefaultBiquadFilter>(mChannelCount, kBiquadCoefs1.at(coefsIndex)), |
| std::make_unique<DefaultBiquadFilter>(mChannelCount, kBiquadCoefs2.at(coefsIndex)), |
| std::make_unique<DefaultBiquadFilter>(mChannelCount, kBiquadCoefs3.at(coefsIndex))}; |
| } |
| |
| status_t MelProcessor::setOutputRs2UpperBound(float rs2Value) |
| { |
| if (rs2Value < kRs2LowerBound || rs2Value > kRs2UpperBound) { |
| return BAD_VALUE; |
| } |
| |
| mRs2UpperBound = rs2Value; |
| |
| return NO_ERROR; |
| } |
| |
| float MelProcessor::getOutputRs2UpperBound() const |
| { |
| return mRs2UpperBound; |
| } |
| |
| void MelProcessor::setDeviceId(audio_port_handle_t deviceId) |
| { |
| mDeviceId = deviceId; |
| } |
| |
| audio_port_handle_t MelProcessor::getDeviceId() { |
| return mDeviceId; |
| } |
| |
| void MelProcessor::pause() |
| { |
| ALOGV("%s", __func__); |
| mPaused = true; |
| } |
| |
| void MelProcessor::resume() |
| { |
| ALOGV("%s", __func__); |
| mPaused = false; |
| } |
| |
| void MelProcessor::updateAudioFormat(uint32_t sampleRate, |
| uint32_t channelCount, |
| audio_format_t format) { |
| ALOGV("%s: update audio format %u, %u, %d", __func__, sampleRate, channelCount, format); |
| |
| std::lock_guard l(mLock); |
| |
| bool differentSampleRate = (mSampleRate != sampleRate); |
| bool differentChannelCount = (mChannelCount != channelCount); |
| |
| mSampleRate = sampleRate; |
| mFramesPerMelValue = sampleRate * kSecondsPerMelValue; |
| mChannelCount = channelCount; |
| mFormat = format; |
| |
| if (differentSampleRate || differentChannelCount) { |
| mAWeightSamples.resize(mFramesPerMelValue * mChannelCount); |
| mFloatSamples.resize(mFramesPerMelValue * mChannelCount); |
| } |
| if (differentChannelCount) { |
| mCurrentChannelEnergy.resize(channelCount); |
| } |
| |
| createBiquads_l(); |
| } |
| |
| void MelProcessor::applyAWeight_l(const void* buffer, size_t samples) |
| { |
| memcpy_by_audio_format(mFloatSamples.data(), AUDIO_FORMAT_PCM_FLOAT, buffer, mFormat, samples); |
| |
| float* tempFloat[2] = { mFloatSamples.data(), mAWeightSamples.data() }; |
| int inIdx = 1, outIdx = 0; |
| const size_t frames = samples / mChannelCount; |
| for (const auto& biquad : mCascadedBiquads) { |
| outIdx ^= 1; |
| inIdx ^= 1; |
| biquad->process(tempFloat[outIdx], tempFloat[inIdx], frames); |
| } |
| |
| // should not be the case since the size is odd |
| if (!(mCascadedBiquads.size() & 1)) { |
| std::swap(mFloatSamples, mAWeightSamples); |
| } |
| } |
| |
| float MelProcessor::getCombinedChannelEnergy_l() { |
| float combinedEnergy = 0.0f; |
| for (auto& energy: mCurrentChannelEnergy) { |
| combinedEnergy += energy; |
| energy = 0; |
| } |
| |
| combinedEnergy /= (float) mFramesPerMelValue; |
| return combinedEnergy; |
| } |
| |
| void MelProcessor::addMelValue_l(float mel) { |
| mMelValues[mCurrentIndex] = mel; |
| ALOGV("%s: writing MEL %f at index %d for device %d", |
| __func__, |
| mel, |
| mCurrentIndex, |
| mDeviceId.load()); |
| |
| bool notifyWorker = false; |
| |
| if (mel > mRs2UpperBound) { |
| mMelWorker.momentaryExposure(mel, mDeviceId); |
| notifyWorker = true; |
| } |
| |
| bool reportContinuousValues = false; |
| if ((mMelValues[mCurrentIndex] < kRs1OutputdBFS && mCurrentIndex > 0)) { |
| reportContinuousValues = true; |
| } else if (mMelValues[mCurrentIndex] >= kRs1OutputdBFS) { |
| // only store MEL that are above RS1 |
| ++mCurrentIndex; |
| } |
| |
| if (reportContinuousValues || (mCurrentIndex > mMelValues.size() - 1)) { |
| mMelWorker.newMelValues(mMelValues, mCurrentIndex, mDeviceId); |
| notifyWorker = true; |
| mCurrentIndex = 0; |
| } |
| |
| if (notifyWorker) { |
| mMelWorker.mCondVar.notify_one(); |
| } |
| } |
| |
| int32_t MelProcessor::process(const void* buffer, size_t bytes) { |
| if (mPaused) { |
| return 0; |
| } |
| |
| // should be uncontested and not block if process method is called from a single thread |
| std::lock_guard<std::mutex> guard(mLock); |
| |
| if (!isSampleRateSupported_l()) { |
| return 0; |
| } |
| |
| const size_t bytes_per_sample = audio_bytes_per_sample(mFormat); |
| size_t samples = bytes_per_sample > 0 ? bytes / bytes_per_sample : 0; |
| while (samples > 0) { |
| const size_t requiredSamples = |
| mFramesPerMelValue * mChannelCount - mCurrentSamples; |
| size_t processSamples = std::min(requiredSamples, samples); |
| processSamples -= processSamples % mChannelCount; |
| |
| applyAWeight_l(buffer, processSamples); |
| |
| audio_utils_accumulate_energy(mAWeightSamples.data(), |
| AUDIO_FORMAT_PCM_FLOAT, |
| processSamples, |
| mChannelCount, |
| mCurrentChannelEnergy.data()); |
| mCurrentSamples += processSamples; |
| |
| ALOGVV( |
| "required:%zu, process:%zu, mCurrentChannelEnergy[0]:%f, mCurrentSamples:%zu", |
| requiredSamples, |
| processSamples, |
| mCurrentChannelEnergy[0], |
| mCurrentSamples.load()); |
| if (processSamples < requiredSamples) { |
| return static_cast<int32_t>(bytes); |
| } |
| |
| addMelValue_l(fmaxf( |
| audio_utils_power_from_energy(getCombinedChannelEnergy_l()) |
| + kMelAdjustmentDb |
| + kMeldBFSTodBSPLOffset |
| + mAttenuationDB, 0.0f)); |
| |
| samples -= processSamples; |
| buffer = |
| (const uint8_t*) buffer + processSamples * bytes_per_sample; |
| mCurrentSamples = 0; |
| } |
| |
| return static_cast<int32_t>(bytes); |
| } |
| |
| void MelProcessor::setAttenuation(float attenuationDB) { |
| ALOGV("%s: setting the attenuation %f", __func__, attenuationDB); |
| mAttenuationDB = attenuationDB; |
| } |
| |
| void MelProcessor::onLastStrongRef(const void* id __attribute__((unused))) { |
| mMelWorker.stop(); |
| ALOGV("%s: Stopped thread: %s for device %d", __func__, mMelWorker.mThreadName.c_str(), |
| mDeviceId.load()); |
| } |
| |
| std::string MelProcessor::pointerString() const { |
| const void * address = static_cast<const void*>(this); |
| std::stringstream aStream; |
| aStream << address; |
| return aStream.str(); |
| } |
| |
| void MelProcessor::MelWorker::run() { |
| mThread = std::thread([&]{ |
| // name the thread to help identification |
| androidSetThreadName(mThreadName.c_str()); |
| ALOGV("%s::run(): Started thread", mThreadName.c_str()); |
| |
| while (true) { |
| std::unique_lock l(mCondVarMutex); |
| if (mStopRequested) { |
| return; |
| } |
| mCondVar.wait(l, [&] { return (mRbReadPtr != mRbWritePtr) || mStopRequested; }); |
| |
| while (mRbReadPtr != mRbWritePtr && !mStopRequested) { |
| ALOGV("%s::run(): new callbacks, rb idx read=%zu, write=%zu", |
| mThreadName.c_str(), |
| mRbReadPtr.load(), |
| mRbWritePtr.load()); |
| auto callback = mCallback.promote(); |
| if (callback == nullptr) { |
| ALOGW("%s::run(): MelCallback is null, quitting MelWorker", |
| mThreadName.c_str()); |
| return; |
| } |
| |
| MelCallbackData data = mCallbackRingBuffer[mRbReadPtr]; |
| if (data.mMel != 0.f) { |
| callback->onMomentaryExposure(data.mMel, data.mPort); |
| } else if (data.mMelsSize != 0) { |
| callback->onNewMelValues(data.mMels, 0, data.mMelsSize, data.mPort); |
| } else { |
| ALOGE("%s::run(): Invalid MEL data. Skipping callback", mThreadName.c_str()); |
| } |
| incRingBufferIndex(mRbReadPtr); |
| } |
| } |
| }); |
| } |
| |
| void MelProcessor::MelWorker::stop() { |
| bool oldValue; |
| { |
| std::lock_guard l(mCondVarMutex); |
| oldValue = mStopRequested; |
| mStopRequested = true; |
| } |
| if (!oldValue) { |
| mCondVar.notify_one(); |
| mThread.join(); |
| } |
| } |
| |
| void MelProcessor::MelWorker::momentaryExposure(float mel, audio_port_handle_t port) { |
| ALOGV("%s", __func__); |
| |
| if (ringBufferIsFull()) { |
| ALOGW("%s: cannot add momentary exposure for port %d, MelWorker buffer is full", __func__, |
| port); |
| return; |
| } |
| |
| // worker is thread-safe, no lock since there is only one writer and we take into account |
| // spurious wake-ups |
| mCallbackRingBuffer[mRbWritePtr].mMel = mel; |
| mCallbackRingBuffer[mRbWritePtr].mMelsSize = 0; |
| mCallbackRingBuffer[mRbWritePtr].mPort = port; |
| |
| incRingBufferIndex(mRbWritePtr); |
| } |
| |
| void MelProcessor::MelWorker::newMelValues(const std::vector<float>& mels, |
| size_t melsSize, |
| audio_port_handle_t port) { |
| ALOGV("%s", __func__); |
| |
| if (ringBufferIsFull()) { |
| ALOGW("%s: cannot add %zu mel values for port %d, MelWorker buffer is full", __func__, |
| melsSize, port); |
| return; |
| } |
| |
| // worker is thread-safe, no lock since there is only one writer and we take into account |
| // spurious wake-ups |
| std::copy_n(std::begin(mels), melsSize, mCallbackRingBuffer[mRbWritePtr].mMels.begin()); |
| mCallbackRingBuffer[mRbWritePtr].mMelsSize = melsSize; |
| mCallbackRingBuffer[mRbWritePtr].mMel = 0.f; |
| mCallbackRingBuffer[mRbWritePtr].mPort = port; |
| |
| incRingBufferIndex(mRbWritePtr); |
| } |
| |
| bool MelProcessor::MelWorker::ringBufferIsFull() const { |
| size_t curIdx = mRbWritePtr.load(); |
| size_t nextIdx = curIdx >= kRingBufferSize - 1 ? 0 : curIdx + 1; |
| |
| return nextIdx == mRbReadPtr; |
| } |
| |
| void MelProcessor::MelWorker::incRingBufferIndex(std::atomic_size_t& idx) { |
| size_t nextIdx; |
| size_t expected; |
| do { |
| expected = idx.load(); |
| nextIdx = expected >= kRingBufferSize - 1 ? 0 : expected + 1; |
| } while (!idx.compare_exchange_strong(expected, nextIdx)); |
| } |
| |
| } // namespace android |