Merge "Audio: Do not sanitize android.hardware.audio@2.0-service"
[android/platform-hardware-interfaces.git] / audio / effect / all-versions / default / include / effect / all-versions / default / EffectsFactory.impl.h
1 /*
2  * Copyright (C) 2016 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  */
17 #include <common/all-versions/IncludeGuard.h>
19 #include <android/log.h>
20 #include <media/EffectsFactoryApi.h>
21 #include <system/audio_effects/effect_aec.h>
22 #include <system/audio_effects/effect_agc.h>
23 #include <system/audio_effects/effect_bassboost.h>
24 #include <system/audio_effects/effect_downmix.h>
25 #include <system/audio_effects/effect_environmentalreverb.h>
26 #include <system/audio_effects/effect_equalizer.h>
27 #include <system/audio_effects/effect_loudnessenhancer.h>
28 #include <system/audio_effects/effect_ns.h>
29 #include <system/audio_effects/effect_presetreverb.h>
30 #include <system/audio_effects/effect_virtualizer.h>
31 #include <system/audio_effects/effect_visualizer.h>
33 using ::android::hardware::audio::common::AUDIO_HAL_VERSION::HidlUtils;
35 namespace android {
36 namespace hardware {
37 namespace audio {
38 namespace effect {
39 namespace AUDIO_HAL_VERSION {
40 namespace implementation {
42 // static
43 sp<IEffect> EffectsFactory::dispatchEffectInstanceCreation(const effect_descriptor_t& halDescriptor,
44                                                            effect_handle_t handle) {
45     const effect_uuid_t* halUuid = &halDescriptor.type;
46     if (memcmp(halUuid, FX_IID_AEC, sizeof(effect_uuid_t)) == 0) {
47         return new AcousticEchoCancelerEffect(handle);
48     } else if (memcmp(halUuid, FX_IID_AGC, sizeof(effect_uuid_t)) == 0) {
49         return new AutomaticGainControlEffect(handle);
50     } else if (memcmp(halUuid, SL_IID_BASSBOOST, sizeof(effect_uuid_t)) == 0) {
51         return new BassBoostEffect(handle);
52     } else if (memcmp(halUuid, EFFECT_UIID_DOWNMIX, sizeof(effect_uuid_t)) == 0) {
53         return new DownmixEffect(handle);
54     } else if (memcmp(halUuid, SL_IID_ENVIRONMENTALREVERB, sizeof(effect_uuid_t)) == 0) {
55         return new EnvironmentalReverbEffect(handle);
56     } else if (memcmp(halUuid, SL_IID_EQUALIZER, sizeof(effect_uuid_t)) == 0) {
57         return new EqualizerEffect(handle);
58     } else if (memcmp(halUuid, FX_IID_LOUDNESS_ENHANCER, sizeof(effect_uuid_t)) == 0) {
59         return new LoudnessEnhancerEffect(handle);
60     } else if (memcmp(halUuid, FX_IID_NS, sizeof(effect_uuid_t)) == 0) {
61         return new NoiseSuppressionEffect(handle);
62     } else if (memcmp(halUuid, SL_IID_PRESETREVERB, sizeof(effect_uuid_t)) == 0) {
63         return new PresetReverbEffect(handle);
64     } else if (memcmp(halUuid, SL_IID_VIRTUALIZER, sizeof(effect_uuid_t)) == 0) {
65         return new VirtualizerEffect(handle);
66     } else if (memcmp(halUuid, SL_IID_VISUALIZATION, sizeof(effect_uuid_t)) == 0) {
67         return new VisualizerEffect(handle);
68     }
69     return new Effect(handle);
70 }
72 // Methods from ::android::hardware::audio::effect::AUDIO_HAL_VERSION::IEffectsFactory follow.
73 Return<void> EffectsFactory::getAllDescriptors(getAllDescriptors_cb _hidl_cb) {
74     Result retval(Result::OK);
75     hidl_vec<EffectDescriptor> result;
76     uint32_t numEffects;
77     status_t status;
79 restart:
80     numEffects = 0;
81     status = EffectQueryNumberEffects(&numEffects);
82     if (status != OK) {
83         retval = Result::NOT_INITIALIZED;
84         ALOGE("Error querying number of effects: %s", strerror(-status));
85         goto exit;
86     }
87     result.resize(numEffects);
88     for (uint32_t i = 0; i < numEffects; ++i) {
89         effect_descriptor_t halDescriptor;
90         status = EffectQueryEffect(i, &halDescriptor);
91         if (status == OK) {
92             effectDescriptorFromHal(halDescriptor, &result[i]);
93         } else {
94             ALOGE("Error querying effect at position %d / %d: %s", i, numEffects,
95                   strerror(-status));
96             switch (status) {
97                 case -ENOSYS: {
98                     // Effect list has changed.
99                     goto restart;
100                 }
101                 case -ENOENT: {
102                     // No more effects available.
103                     result.resize(i);
104                     break;
105                 }
106                 default: {
107                     result.resize(0);
108                     retval = Result::NOT_INITIALIZED;
109                 }
110             }
111             break;
112         }
113     }
115 exit:
116     _hidl_cb(retval, result);
117     return Void();
120 Return<void> EffectsFactory::getDescriptor(const Uuid& uid, getDescriptor_cb _hidl_cb) {
121     effect_uuid_t halUuid;
122     HidlUtils::uuidToHal(uid, &halUuid);
123     effect_descriptor_t halDescriptor;
124     status_t status = EffectGetDescriptor(&halUuid, &halDescriptor);
125     EffectDescriptor descriptor;
126     effectDescriptorFromHal(halDescriptor, &descriptor);
127     Result retval(Result::OK);
128     if (status != OK) {
129         ALOGE("Error querying effect descriptor for %s: %s", uuidToString(halUuid).c_str(),
130               strerror(-status));
131         if (status == -ENOENT) {
132             retval = Result::INVALID_ARGUMENTS;
133         } else {
134             retval = Result::NOT_INITIALIZED;
135         }
136     }
137     _hidl_cb(retval, descriptor);
138     return Void();
141 Return<void> EffectsFactory::createEffect(const Uuid& uid, int32_t session, int32_t ioHandle,
142                                           createEffect_cb _hidl_cb) {
143     effect_uuid_t halUuid;
144     HidlUtils::uuidToHal(uid, &halUuid);
145     effect_handle_t handle;
146     Result retval(Result::OK);
147     status_t status = EffectCreate(&halUuid, session, ioHandle, &handle);
148     sp<IEffect> effect;
149     uint64_t effectId = EffectMap::INVALID_ID;
150     if (status == OK) {
151         effect_descriptor_t halDescriptor;
152         memset(&halDescriptor, 0, sizeof(effect_descriptor_t));
153         status = (*handle)->get_descriptor(handle, &halDescriptor);
154         if (status == OK) {
155             effect = dispatchEffectInstanceCreation(halDescriptor, handle);
156             effectId = EffectMap::getInstance().add(handle);
157         } else {
158             ALOGE("Error querying effect descriptor for %s: %s", uuidToString(halUuid).c_str(),
159                   strerror(-status));
160             EffectRelease(handle);
161         }
162     }
163     if (status != OK) {
164         ALOGE("Error creating effect %s: %s", uuidToString(halUuid).c_str(), strerror(-status));
165         if (status == -ENOENT) {
166             retval = Result::INVALID_ARGUMENTS;
167         } else {
168             retval = Result::NOT_INITIALIZED;
169         }
170     }
171     _hidl_cb(retval, effect, effectId);
172     return Void();
175 Return<void> EffectsFactory::debugDump(const hidl_handle& fd) {
176     return debug(fd, {} /* options */);
179 Return<void> EffectsFactory::debug(const hidl_handle& fd,
180                                    const hidl_vec<hidl_string>& /* options */) {
181     if (fd.getNativeHandle() != nullptr && fd->numFds == 1) {
182         EffectDumpEffects(fd->data[0]);
183     }
184     return Void();
187 IEffectsFactory* HIDL_FETCH_IEffectsFactory(const char* /* name */) {
188     return new EffectsFactory();
191 }  // namespace implementation
192 }  // namespace AUDIO_HAL_VERSION
193 }  // namespace effect
194 }  // namespace audio
195 }  // namespace hardware
196 }  // namespace android