1 /*
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
17 #define LOG_TAG "AHAL_VisualizerLibEffects"
18
19 #include <android-base/logging.h>
20 #include <system/audio_effects/effect_uuid.h>
21
22 #include "Visualizer.h"
23
24 using aidl::android::hardware::audio::effect::Descriptor;
25 using aidl::android::hardware::audio::effect::getEffectImplUuidVisualizer;
26 using aidl::android::hardware::audio::effect::getEffectTypeUuidVisualizer;
27 using aidl::android::hardware::audio::effect::IEffect;
28 using aidl::android::hardware::audio::effect::State;
29 using aidl::android::hardware::audio::effect::VisualizerImpl;
30 using aidl::android::media::audio::common::AudioUuid;
31
createEffect(const AudioUuid * in_impl_uuid,std::shared_ptr<IEffect> * instanceSpp)32 extern "C" binder_exception_t createEffect(const AudioUuid* in_impl_uuid,
33 std::shared_ptr<IEffect>* instanceSpp) {
34 if (!in_impl_uuid || *in_impl_uuid != getEffectImplUuidVisualizer()) {
35 LOG(ERROR) << __func__ << "uuid not supported";
36 return EX_ILLEGAL_ARGUMENT;
37 }
38 if (instanceSpp) {
39 *instanceSpp = ndk::SharedRefBase::make<VisualizerImpl>();
40 return EX_NONE;
41 } else {
42 LOG(ERROR) << __func__ << " invalid input parameter!";
43 return EX_ILLEGAL_ARGUMENT;
44 }
45 }
46
queryEffect(const AudioUuid * in_impl_uuid,Descriptor * _aidl_return)47 extern "C" binder_exception_t queryEffect(const AudioUuid* in_impl_uuid, Descriptor* _aidl_return) {
48 if (!in_impl_uuid || *in_impl_uuid != getEffectImplUuidVisualizer()) {
49 LOG(ERROR) << __func__ << "uuid not supported";
50 return EX_ILLEGAL_ARGUMENT;
51 }
52 *_aidl_return = VisualizerImpl::kDescriptor;
53 return EX_NONE;
54 }
55
56 namespace aidl::android::hardware::audio::effect {
57
58 const std::string VisualizerImpl::kEffectName = "Visualizer";
59 const std::vector<Range::VisualizerRange> VisualizerImpl::kRanges = {
60 MAKE_RANGE(Visualizer, latencyMs, 0, VisualizerContext::kMaxLatencyMs),
61 MAKE_RANGE(Visualizer, captureSamples, VisualizerContext::kMinCaptureBufSize,
62 VisualizerContext::kMaxCaptureBufSize),
63 /* get only parameters, set invalid range (min > max) to indicate not support set */
64 MAKE_RANGE(Visualizer, measurement, Visualizer::Measurement({.rms = 1, .peak = 1}),
65 Visualizer::Measurement({.rms = 0, .peak = 0})),
66 MAKE_RANGE(Visualizer, captureSampleBuffer, std::vector<uint8_t>({1}),
67 std::vector<uint8_t>({0}))};
68 const Capability VisualizerImpl::kCapability = {
69 .range = Range::make<Range::visualizer>(VisualizerImpl::kRanges)};
70 const Descriptor VisualizerImpl::kDescriptor = {
71 .common = {.id = {.type = getEffectTypeUuidVisualizer(),
72 .uuid = getEffectImplUuidVisualizer(),
73 .proxy = std::nullopt},
74 .flags = {.type = Flags::Type::INSERT,
75 .insert = Flags::Insert::FIRST,
76 .volume = Flags::Volume::NONE},
77 .name = VisualizerImpl::kEffectName,
78 .implementor = "The Android Open Source Project"},
79 .capability = VisualizerImpl::kCapability};
80
getDescriptor(Descriptor * _aidl_return)81 ndk::ScopedAStatus VisualizerImpl::getDescriptor(Descriptor* _aidl_return) {
82 RETURN_IF(!_aidl_return, EX_ILLEGAL_ARGUMENT, "Parameter:nullptr");
83 LOG(DEBUG) << __func__ << kDescriptor.toString();
84 *_aidl_return = kDescriptor;
85 return ndk::ScopedAStatus::ok();
86 }
87
setParameterSpecific(const Parameter::Specific & specific)88 ndk::ScopedAStatus VisualizerImpl::setParameterSpecific(const Parameter::Specific& specific) {
89 RETURN_IF(Parameter::Specific::visualizer != specific.getTag(), EX_ILLEGAL_ARGUMENT,
90 "EffectNotSupported");
91 RETURN_IF(!mContext, EX_NULL_POINTER, "nullContext");
92
93 auto& param = specific.get<Parameter::Specific::visualizer>();
94 RETURN_IF(!inRange(param, kRanges), EX_ILLEGAL_ARGUMENT, "outOfRange");
95 const auto tag = param.getTag();
96 switch (tag) {
97 case Visualizer::captureSamples: {
98 RETURN_IF(mContext->setCaptureSamples(param.get<Visualizer::captureSamples>()) !=
99 RetCode::SUCCESS,
100 EX_ILLEGAL_ARGUMENT, "setCaptureSizeFailed");
101 return ndk::ScopedAStatus::ok();
102 }
103 case Visualizer::scalingMode: {
104 RETURN_IF(mContext->setScalingMode(param.get<Visualizer::scalingMode>()) !=
105 RetCode::SUCCESS,
106 EX_ILLEGAL_ARGUMENT, "setScalingModeFailed");
107 return ndk::ScopedAStatus::ok();
108 }
109 case Visualizer::measurementMode: {
110 RETURN_IF(mContext->setMeasurementMode(param.get<Visualizer::measurementMode>()) !=
111 RetCode::SUCCESS,
112 EX_ILLEGAL_ARGUMENT, "setMeasurementModeFailed");
113 return ndk::ScopedAStatus::ok();
114 }
115 case Visualizer::latencyMs: {
116 RETURN_IF(mContext->setDownstreamLatency(param.get<Visualizer::latencyMs>()) !=
117 RetCode::SUCCESS,
118 EX_ILLEGAL_ARGUMENT, "setLatencyFailed");
119 return ndk::ScopedAStatus::ok();
120 }
121 default: {
122 LOG(ERROR) << __func__ << " unsupported tag: " << toString(tag);
123 return ndk::ScopedAStatus::fromExceptionCodeWithMessage(
124 EX_ILLEGAL_ARGUMENT, "VisualizerTagNotSupported");
125 }
126 }
127 }
128
getParameterSpecific(const Parameter::Id & id,Parameter::Specific * specific)129 ndk::ScopedAStatus VisualizerImpl::getParameterSpecific(const Parameter::Id& id,
130 Parameter::Specific* specific) {
131 RETURN_IF(!specific, EX_NULL_POINTER, "nullPtr");
132 auto tag = id.getTag();
133 RETURN_IF(Parameter::Id::visualizerTag != tag, EX_ILLEGAL_ARGUMENT, "wrongIdTag");
134 auto specificId = id.get<Parameter::Id::visualizerTag>();
135 auto specificTag = specificId.getTag();
136 switch (specificTag) {
137 case Visualizer::Id::commonTag: {
138 return getParameterVisualizer(specificId.get<Visualizer::Id::commonTag>(), specific);
139 }
140 default: {
141 LOG(ERROR) << __func__ << " unsupported tag: " << toString(specificTag);
142 return ndk::ScopedAStatus::fromExceptionCodeWithMessage(EX_ILLEGAL_ARGUMENT,
143 "VisualizerTagNotSupported");
144 }
145 }
146 return ndk::ScopedAStatus::ok();
147 }
148
getParameterVisualizer(const Visualizer::Tag & tag,Parameter::Specific * specific)149 ndk::ScopedAStatus VisualizerImpl::getParameterVisualizer(const Visualizer::Tag& tag,
150 Parameter::Specific* specific) {
151 RETURN_IF(!mContext, EX_NULL_POINTER, "nullContext");
152
153 Visualizer param;
154 switch (tag) {
155 case Visualizer::captureSamples: {
156 param.set<Visualizer::captureSamples>(mContext->getCaptureSamples());
157 break;
158 }
159 case Visualizer::scalingMode: {
160 param.set<Visualizer::scalingMode>(mContext->getScalingMode());
161 break;
162 }
163 case Visualizer::measurementMode: {
164 param.set<Visualizer::measurementMode>(mContext->getMeasurementMode());
165 break;
166 }
167 case Visualizer::measurement: {
168 param.set<Visualizer::measurement>(mContext->getMeasure());
169 break;
170 }
171 case Visualizer::captureSampleBuffer: {
172 param.set<Visualizer::captureSampleBuffer>(mContext->capture());
173 break;
174 }
175 case Visualizer::latencyMs: {
176 param.set<Visualizer::latencyMs>(mContext->getDownstreamLatency());
177 break;
178 }
179 default: {
180 LOG(ERROR) << __func__ << " unsupported tag: " << toString(tag);
181 return ndk::ScopedAStatus::fromExceptionCodeWithMessage(
182 EX_ILLEGAL_ARGUMENT, "VisualizerTagNotSupported");
183 }
184 }
185
186 specific->set<Parameter::Specific::visualizer>(param);
187 return ndk::ScopedAStatus::ok();
188 }
189
createContext(const Parameter::Common & common)190 std::shared_ptr<EffectContext> VisualizerImpl::createContext(const Parameter::Common& common) {
191 if (mContext) {
192 LOG(DEBUG) << __func__ << " context already exist";
193 return mContext;
194 }
195
196 mContext = std::make_shared<VisualizerContext>(1 /* statusFmqDepth */, common);
197 mContext->initParams(common);
198 return mContext;
199 }
200
releaseContext()201 RetCode VisualizerImpl::releaseContext() {
202 if (mContext) {
203 mContext->disable();
204 mContext->reset();
205 mContext->resetBuffer();
206 }
207 return RetCode::SUCCESS;
208 }
209
210 // Processing method running in EffectWorker thread.
effectProcessImpl(float * in,float * out,int samples)211 IEffect::Status VisualizerImpl::effectProcessImpl(float* in, float* out, int samples) {
212 IEffect::Status status = {EX_NULL_POINTER, 0, 0};
213 RETURN_VALUE_IF(!mContext, status, "nullContext");
214 return mContext->process(in, out, samples);
215 }
216
217 } // namespace aidl::android::hardware::audio::effect
218