blob: 03de74f43cb844fe25c356ee4ce95beab555c85e [file] [log] [blame]
Shunkai Yao6afc8552022-10-26 22:47:20 +00001/*
2 * Copyright (C) 2022 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Shunkai Yao65c7c702024-01-09 20:50:53 +000017#include <memory>
Mikhail Naganov89a6bb72024-01-31 13:55:08 -080018#define ATRACE_TAG ATRACE_TAG_AUDIO
Shunkai Yao6afc8552022-10-26 22:47:20 +000019#define LOG_TAG "AHAL_EffectImpl"
Mikhail Naganov89a6bb72024-01-31 13:55:08 -080020#include <utils/Trace.h>
Shunkai Yao6afc8552022-10-26 22:47:20 +000021#include "effect-impl/EffectImpl.h"
22#include "effect-impl/EffectTypes.h"
23#include "include/effect-impl/EffectTypes.h"
24
Shunkai Yaoc12e0822022-12-12 07:13:58 +000025using aidl::android::hardware::audio::effect::IEffect;
26using aidl::android::hardware::audio::effect::State;
Shunkai Yaoe39cd362022-12-22 00:23:34 +000027using aidl::android::media::audio::common::PcmType;
Shunkai Yao65c7c702024-01-09 20:50:53 +000028using ::android::hardware::EventFlag;
Shunkai Yaoc12e0822022-12-12 07:13:58 +000029
30extern "C" binder_exception_t destroyEffect(const std::shared_ptr<IEffect>& instanceSp) {
31 State state;
32 ndk::ScopedAStatus status = instanceSp->getState(&state);
33 if (!status.isOk() || State::INIT != state) {
34 LOG(ERROR) << __func__ << " instance " << instanceSp.get()
35 << " in state: " << toString(state) << ", status: " << status.getDescription();
36 return EX_ILLEGAL_STATE;
37 }
Shunkai Yaoc12e0822022-12-12 07:13:58 +000038 return EX_NONE;
39}
40
Shunkai Yao6afc8552022-10-26 22:47:20 +000041namespace aidl::android::hardware::audio::effect {
42
43ndk::ScopedAStatus EffectImpl::open(const Parameter::Common& common,
44 const std::optional<Parameter::Specific>& specific,
45 OpenEffectReturn* ret) {
Shunkai Yaof8be1ac2023-03-06 18:41:27 +000046 LOG(DEBUG) << getEffectName() << __func__;
Shunkai Yaoe39cd362022-12-22 00:23:34 +000047 // effect only support 32bits float
48 RETURN_IF(common.input.base.format.pcm != common.output.base.format.pcm ||
49 common.input.base.format.pcm != PcmType::FLOAT_32_BIT,
50 EX_ILLEGAL_ARGUMENT, "dataMustBe32BitsFloat");
Shunkai Yao7e2c3712024-02-03 06:47:18 +000051
Shunkai Yao65c7c702024-01-09 20:50:53 +000052 std::lock_guard lg(mImplMutex);
Shraddha Basantwanif627d802022-11-08 14:45:07 +053053 RETURN_OK_IF(mState != State::INIT);
Shunkai Yao65c7c702024-01-09 20:50:53 +000054 mImplContext = createContext(common);
55 RETURN_IF(!mImplContext, EX_NULL_POINTER, "nullContext");
Shunkai Yao7e2c3712024-02-03 06:47:18 +000056
57 int version = 0;
58 RETURN_IF(!getInterfaceVersion(&version).isOk(), EX_UNSUPPORTED_OPERATION,
59 "FailedToGetInterfaceVersion");
60 mImplContext->setVersion(version);
Shunkai Yao65c7c702024-01-09 20:50:53 +000061 mEventFlag = mImplContext->getStatusEventFlag();
Shunkai Yao6afc8552022-10-26 22:47:20 +000062
Shunkai Yao6afc8552022-10-26 22:47:20 +000063 if (specific.has_value()) {
64 RETURN_IF_ASTATUS_NOT_OK(setParameterSpecific(specific.value()), "setSpecParamErr");
65 }
66
Shraddha Basantwanif627d802022-11-08 14:45:07 +053067 mState = State::IDLE;
Shunkai Yao65c7c702024-01-09 20:50:53 +000068 mImplContext->dupeFmq(ret);
69 RETURN_IF(createThread(getEffectName()) != RetCode::SUCCESS, EX_UNSUPPORTED_OPERATION,
Shunkai Yao6afc8552022-10-26 22:47:20 +000070 "FailedToCreateWorker");
Shunkai Yao6afc8552022-10-26 22:47:20 +000071 return ndk::ScopedAStatus::ok();
72}
73
Shunkai Yao5b15e002024-01-05 02:33:47 +000074ndk::ScopedAStatus EffectImpl::reopen(OpenEffectReturn* ret) {
Shunkai Yao65c7c702024-01-09 20:50:53 +000075 std::lock_guard lg(mImplMutex);
Shunkai Yao5b15e002024-01-05 02:33:47 +000076 RETURN_IF(mState == State::INIT, EX_ILLEGAL_STATE, "alreadyClosed");
77
78 // TODO: b/302036943 add reopen implementation
Shunkai Yao65c7c702024-01-09 20:50:53 +000079 RETURN_IF(!mImplContext, EX_NULL_POINTER, "nullContext");
80 mImplContext->dupeFmqWithReopen(ret);
Shunkai Yao5b15e002024-01-05 02:33:47 +000081 return ndk::ScopedAStatus::ok();
82}
83
Shunkai Yao6afc8552022-10-26 22:47:20 +000084ndk::ScopedAStatus EffectImpl::close() {
Shunkai Yao65c7c702024-01-09 20:50:53 +000085 {
86 std::lock_guard lg(mImplMutex);
87 RETURN_OK_IF(mState == State::INIT);
88 RETURN_IF(mState == State::PROCESSING, EX_ILLEGAL_STATE, "closeAtProcessing");
89 mState = State::INIT;
90 }
Shunkai Yao6afc8552022-10-26 22:47:20 +000091
Shunkai Yao65c7c702024-01-09 20:50:53 +000092 RETURN_IF(notifyEventFlag(kEventFlagNotEmpty) != RetCode::SUCCESS, EX_ILLEGAL_STATE,
Shunkai Yaobb35eff2024-03-14 22:04:02 +000093 "notifyEventFlagNotEmptyFailed");
Shunkai Yao6afc8552022-10-26 22:47:20 +000094 // stop the worker thread, ignore the return code
95 RETURN_IF(destroyThread() != RetCode::SUCCESS, EX_UNSUPPORTED_OPERATION,
96 "FailedToDestroyWorker");
Shunkai Yao65c7c702024-01-09 20:50:53 +000097
98 {
99 std::lock_guard lg(mImplMutex);
100 releaseContext();
101 mImplContext.reset();
102 }
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530103
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000104 LOG(DEBUG) << getEffectName() << __func__;
Shunkai Yao6afc8552022-10-26 22:47:20 +0000105 return ndk::ScopedAStatus::ok();
106}
107
108ndk::ScopedAStatus EffectImpl::setParameter(const Parameter& param) {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000109 std::lock_guard lg(mImplMutex);
Shunkai Yao074cf232023-07-14 21:08:31 +0000110 LOG(VERBOSE) << getEffectName() << __func__ << " with: " << param.toString();
Shunkai Yao6afc8552022-10-26 22:47:20 +0000111
Shunkai Yao65c7c702024-01-09 20:50:53 +0000112 const auto& tag = param.getTag();
Shunkai Yao6afc8552022-10-26 22:47:20 +0000113 switch (tag) {
114 case Parameter::common:
115 case Parameter::deviceDescription:
116 case Parameter::mode:
117 case Parameter::source:
118 FALLTHROUGH_INTENDED;
119 case Parameter::volumeStereo:
120 return setParameterCommon(param);
121 case Parameter::specific: {
122 return setParameterSpecific(param.get<Parameter::specific>());
123 }
124 default: {
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000125 LOG(ERROR) << getEffectName() << __func__ << " unsupportedParameterTag "
126 << toString(tag);
Shunkai Yao6afc8552022-10-26 22:47:20 +0000127 return ndk::ScopedAStatus::fromExceptionCodeWithMessage(EX_ILLEGAL_ARGUMENT,
128 "ParameterNotSupported");
129 }
130 }
131}
132
133ndk::ScopedAStatus EffectImpl::getParameter(const Parameter::Id& id, Parameter* param) {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000134 std::lock_guard lg(mImplMutex);
135 switch (id.getTag()) {
Shunkai Yao6afc8552022-10-26 22:47:20 +0000136 case Parameter::Id::commonTag: {
137 RETURN_IF_ASTATUS_NOT_OK(getParameterCommon(id.get<Parameter::Id::commonTag>(), param),
138 "CommonParamNotSupported");
139 break;
140 }
Shunkai Yao85b01692023-02-15 22:04:57 +0000141 case Parameter::Id::vendorEffectTag:
142 FALLTHROUGH_INTENDED;
Shunkai Yao6afc8552022-10-26 22:47:20 +0000143 default: {
144 Parameter::Specific specific;
145 RETURN_IF_ASTATUS_NOT_OK(getParameterSpecific(id, &specific), "SpecParamNotSupported");
146 param->set<Parameter::specific>(specific);
147 break;
148 }
149 }
Shunkai Yao074cf232023-07-14 21:08:31 +0000150 LOG(VERBOSE) << getEffectName() << __func__ << id.toString() << param->toString();
Shunkai Yao6afc8552022-10-26 22:47:20 +0000151 return ndk::ScopedAStatus::ok();
152}
153
154ndk::ScopedAStatus EffectImpl::setParameterCommon(const Parameter& param) {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000155 RETURN_IF(!mImplContext, EX_NULL_POINTER, "nullContext");
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530156
Shunkai Yao65c7c702024-01-09 20:50:53 +0000157 const auto& tag = param.getTag();
Shunkai Yao6afc8552022-10-26 22:47:20 +0000158 switch (tag) {
159 case Parameter::common:
Shunkai Yao65c7c702024-01-09 20:50:53 +0000160 RETURN_IF(mImplContext->setCommon(param.get<Parameter::common>()) != RetCode::SUCCESS,
Shunkai Yao6afc8552022-10-26 22:47:20 +0000161 EX_ILLEGAL_ARGUMENT, "setCommFailed");
162 break;
163 case Parameter::deviceDescription:
Shunkai Yao65c7c702024-01-09 20:50:53 +0000164 RETURN_IF(mImplContext->setOutputDevice(param.get<Parameter::deviceDescription>()) !=
Shunkai Yao6afc8552022-10-26 22:47:20 +0000165 RetCode::SUCCESS,
166 EX_ILLEGAL_ARGUMENT, "setDeviceFailed");
167 break;
168 case Parameter::mode:
Shunkai Yao65c7c702024-01-09 20:50:53 +0000169 RETURN_IF(mImplContext->setAudioMode(param.get<Parameter::mode>()) != RetCode::SUCCESS,
Shunkai Yao6afc8552022-10-26 22:47:20 +0000170 EX_ILLEGAL_ARGUMENT, "setModeFailed");
171 break;
172 case Parameter::source:
Shunkai Yao65c7c702024-01-09 20:50:53 +0000173 RETURN_IF(mImplContext->setAudioSource(param.get<Parameter::source>()) !=
174 RetCode::SUCCESS,
Shunkai Yao6afc8552022-10-26 22:47:20 +0000175 EX_ILLEGAL_ARGUMENT, "setSourceFailed");
176 break;
177 case Parameter::volumeStereo:
Shunkai Yao65c7c702024-01-09 20:50:53 +0000178 RETURN_IF(mImplContext->setVolumeStereo(param.get<Parameter::volumeStereo>()) !=
Shunkai Yao6afc8552022-10-26 22:47:20 +0000179 RetCode::SUCCESS,
180 EX_ILLEGAL_ARGUMENT, "setVolumeStereoFailed");
181 break;
182 default: {
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000183 LOG(ERROR) << getEffectName() << __func__ << " unsupportedParameterTag "
184 << toString(tag);
Shunkai Yao6afc8552022-10-26 22:47:20 +0000185 return ndk::ScopedAStatus::fromExceptionCodeWithMessage(EX_ILLEGAL_ARGUMENT,
186 "commonParamNotSupported");
187 }
188 }
189 return ndk::ScopedAStatus::ok();
190}
191
192ndk::ScopedAStatus EffectImpl::getParameterCommon(const Parameter::Tag& tag, Parameter* param) {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000193 RETURN_IF(!mImplContext, EX_NULL_POINTER, "nullContext");
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530194
Shunkai Yao6afc8552022-10-26 22:47:20 +0000195 switch (tag) {
196 case Parameter::common: {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000197 param->set<Parameter::common>(mImplContext->getCommon());
Shunkai Yao6afc8552022-10-26 22:47:20 +0000198 break;
199 }
200 case Parameter::deviceDescription: {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000201 param->set<Parameter::deviceDescription>(mImplContext->getOutputDevice());
Shunkai Yao6afc8552022-10-26 22:47:20 +0000202 break;
203 }
204 case Parameter::mode: {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000205 param->set<Parameter::mode>(mImplContext->getAudioMode());
Shunkai Yao6afc8552022-10-26 22:47:20 +0000206 break;
207 }
208 case Parameter::source: {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000209 param->set<Parameter::source>(mImplContext->getAudioSource());
Shunkai Yao6afc8552022-10-26 22:47:20 +0000210 break;
211 }
212 case Parameter::volumeStereo: {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000213 param->set<Parameter::volumeStereo>(mImplContext->getVolumeStereo());
Shunkai Yao6afc8552022-10-26 22:47:20 +0000214 break;
215 }
216 default: {
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000217 LOG(DEBUG) << getEffectName() << __func__ << " unsupported tag " << toString(tag);
Shunkai Yao6afc8552022-10-26 22:47:20 +0000218 return ndk::ScopedAStatus::fromExceptionCodeWithMessage(EX_ILLEGAL_ARGUMENT,
219 "tagNotSupported");
220 }
221 }
222 return ndk::ScopedAStatus::ok();
223}
224
Shunkai Yao65c7c702024-01-09 20:50:53 +0000225ndk::ScopedAStatus EffectImpl::getState(State* state) NO_THREAD_SAFETY_ANALYSIS {
Shunkai Yao6afc8552022-10-26 22:47:20 +0000226 *state = mState;
227 return ndk::ScopedAStatus::ok();
228}
229
230ndk::ScopedAStatus EffectImpl::command(CommandId command) {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000231 std::lock_guard lg(mImplMutex);
232 RETURN_IF(mState == State::INIT, EX_ILLEGAL_STATE, "instanceNotOpen");
Shunkai Yao6afc8552022-10-26 22:47:20 +0000233
234 switch (command) {
235 case CommandId::START:
Shunkai Yao6afc8552022-10-26 22:47:20 +0000236 RETURN_OK_IF(mState == State::PROCESSING);
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530237 RETURN_IF_ASTATUS_NOT_OK(commandImpl(command), "commandImplFailed");
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530238 mState = State::PROCESSING;
Shunkai Yao65c7c702024-01-09 20:50:53 +0000239 RETURN_IF(notifyEventFlag(kEventFlagNotEmpty) != RetCode::SUCCESS, EX_ILLEGAL_STATE,
Shunkai Yaobb35eff2024-03-14 22:04:02 +0000240 "notifyEventFlagNotEmptyFailed");
Shunkai Yao65c7c702024-01-09 20:50:53 +0000241 startThread();
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530242 break;
Shunkai Yao6afc8552022-10-26 22:47:20 +0000243 case CommandId::STOP:
Shunkai Yao6afc8552022-10-26 22:47:20 +0000244 case CommandId::RESET:
245 RETURN_OK_IF(mState == State::IDLE);
Shunkai Yao65c7c702024-01-09 20:50:53 +0000246 mState = State::IDLE;
247 RETURN_IF(notifyEventFlag(kEventFlagNotEmpty) != RetCode::SUCCESS, EX_ILLEGAL_STATE,
Shunkai Yaobb35eff2024-03-14 22:04:02 +0000248 "notifyEventFlagNotEmptyFailed");
Shunkai Yao6afc8552022-10-26 22:47:20 +0000249 stopThread();
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530250 RETURN_IF_ASTATUS_NOT_OK(commandImpl(command), "commandImplFailed");
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530251 break;
Shunkai Yao6afc8552022-10-26 22:47:20 +0000252 default:
Shunkai Yaof8be1ac2023-03-06 18:41:27 +0000253 LOG(ERROR) << getEffectName() << __func__ << " instance still processing";
Shunkai Yao6afc8552022-10-26 22:47:20 +0000254 return ndk::ScopedAStatus::fromExceptionCodeWithMessage(EX_ILLEGAL_ARGUMENT,
255 "CommandIdNotSupported");
256 }
Shunkai Yaobb35eff2024-03-14 22:04:02 +0000257 LOG(VERBOSE) << getEffectName() << __func__ << " transfer to state: " << toString(mState);
Shunkai Yao6afc8552022-10-26 22:47:20 +0000258 return ndk::ScopedAStatus::ok();
259}
260
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530261ndk::ScopedAStatus EffectImpl::commandImpl(CommandId command) {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000262 RETURN_IF(!mImplContext, EX_NULL_POINTER, "nullContext");
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530263 if (command == CommandId::RESET) {
Shunkai Yao65c7c702024-01-09 20:50:53 +0000264 mImplContext->resetBuffer();
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530265 }
266 return ndk::ScopedAStatus::ok();
267}
268
Shunkai Yao65c7c702024-01-09 20:50:53 +0000269std::shared_ptr<EffectContext> EffectImpl::createContext(const Parameter::Common& common) {
270 return std::make_shared<EffectContext>(1 /* statusMqDepth */, common);
271}
272
273RetCode EffectImpl::releaseContext() {
274 if (mImplContext) {
275 mImplContext.reset();
276 }
277 return RetCode::SUCCESS;
278}
279
Shunkai Yao6afc8552022-10-26 22:47:20 +0000280void EffectImpl::cleanUp() {
281 command(CommandId::STOP);
282 close();
283}
284
Shunkai Yao65c7c702024-01-09 20:50:53 +0000285RetCode EffectImpl::notifyEventFlag(uint32_t flag) {
286 if (!mEventFlag) {
287 LOG(ERROR) << getEffectName() << __func__ << ": StatusEventFlag invalid";
288 return RetCode::ERROR_EVENT_FLAG_ERROR;
289 }
290 if (const auto ret = mEventFlag->wake(flag); ret != ::android::OK) {
291 LOG(ERROR) << getEffectName() << __func__ << ": wake failure with ret " << ret;
292 return RetCode::ERROR_EVENT_FLAG_ERROR;
293 }
Shunkai Yaobb35eff2024-03-14 22:04:02 +0000294 LOG(VERBOSE) << getEffectName() << __func__ << ": " << std::hex << mEventFlag;
Shunkai Yao65c7c702024-01-09 20:50:53 +0000295 return RetCode::SUCCESS;
296}
297
Shunkai Yao6afc8552022-10-26 22:47:20 +0000298IEffect::Status EffectImpl::status(binder_status_t status, size_t consumed, size_t produced) {
299 IEffect::Status ret;
300 ret.status = status;
301 ret.fmqConsumed = consumed;
302 ret.fmqProduced = produced;
303 return ret;
304}
305
Shunkai Yao65c7c702024-01-09 20:50:53 +0000306void EffectImpl::process() {
Shunkai Yaobb35eff2024-03-14 22:04:02 +0000307 ATRACE_NAME(getEffectName().c_str());
Shunkai Yao65c7c702024-01-09 20:50:53 +0000308 /**
309 * wait for the EventFlag without lock, it's ok because the mEfGroup pointer will not change
310 * in the life cycle of workerThread (threadLoop).
311 */
312 uint32_t efState = 0;
313 if (!mEventFlag ||
314 ::android::OK != mEventFlag->wait(kEventFlagNotEmpty, &efState, 0 /* no timeout */,
315 true /* retry */) ||
316 !(efState & kEventFlagNotEmpty)) {
317 LOG(ERROR) << getEffectName() << __func__ << ": StatusEventFlag - " << mEventFlag
318 << " efState - " << std::hex << efState;
319 return;
320 }
321
322 {
323 std::lock_guard lg(mImplMutex);
324 if (mState != State::PROCESSING) {
325 LOG(DEBUG) << getEffectName() << " skip process in state: " << toString(mState);
326 return;
327 }
328 RETURN_VALUE_IF(!mImplContext, void(), "nullContext");
329 auto statusMQ = mImplContext->getStatusFmq();
330 auto inputMQ = mImplContext->getInputDataFmq();
331 auto outputMQ = mImplContext->getOutputDataFmq();
332 auto buffer = mImplContext->getWorkBuffer();
333 if (!inputMQ || !outputMQ) {
334 return;
335 }
336
Shunkai Yao08c05dd2024-01-25 00:45:55 +0000337 assert(mImplContext->getWorkBufferSize() >=
338 std::max(inputMQ->availableToRead(), outputMQ->availableToWrite()));
339 auto processSamples = std::min(inputMQ->availableToRead(), outputMQ->availableToWrite());
Shunkai Yao65c7c702024-01-09 20:50:53 +0000340 if (processSamples) {
341 inputMQ->read(buffer, processSamples);
342 IEffect::Status status = effectProcessImpl(buffer, buffer, processSamples);
343 outputMQ->write(buffer, status.fmqProduced);
344 statusMQ->writeBlocking(&status, 1);
Shunkai Yao65c7c702024-01-09 20:50:53 +0000345 }
346 }
347}
348
Shunkai Yao6afc8552022-10-26 22:47:20 +0000349// A placeholder processing implementation to copy samples from input to output
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530350IEffect::Status EffectImpl::effectProcessImpl(float* in, float* out, int samples) {
351 for (int i = 0; i < samples; i++) {
Shunkai Yao6afc8552022-10-26 22:47:20 +0000352 *out++ = *in++;
353 }
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530354 return {STATUS_OK, samples, samples};
Shunkai Yao6afc8552022-10-26 22:47:20 +0000355}
Shraddha Basantwanif627d802022-11-08 14:45:07 +0530356
Shunkai Yao6afc8552022-10-26 22:47:20 +0000357} // namespace aidl::android::hardware::audio::effect