xref: /aosp_15_r20/hardware/interfaces/audio/effect/all-versions/default/EqualizerEffect.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker  * Copyright (C) 2018 The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker  *
4*4d7e907cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker  *
8*4d7e907cSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker  *
10*4d7e907cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker  * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker  */
16*4d7e907cSAndroid Build Coastguard Worker 
17*4d7e907cSAndroid Build Coastguard Worker #ifndef ANDROID_HARDWARE_AUDIO_EFFECT_EQUALIZEREFFECT_H
18*4d7e907cSAndroid Build Coastguard Worker #define ANDROID_HARDWARE_AUDIO_EFFECT_EQUALIZEREFFECT_H
19*4d7e907cSAndroid Build Coastguard Worker 
20*4d7e907cSAndroid Build Coastguard Worker #include PATH(android/hardware/audio/effect/FILE_VERSION/IEqualizerEffect.h)
21*4d7e907cSAndroid Build Coastguard Worker 
22*4d7e907cSAndroid Build Coastguard Worker #include "Effect.h"
23*4d7e907cSAndroid Build Coastguard Worker 
24*4d7e907cSAndroid Build Coastguard Worker #include <vector>
25*4d7e907cSAndroid Build Coastguard Worker 
26*4d7e907cSAndroid Build Coastguard Worker #include <system/audio_effects/effect_equalizer.h>
27*4d7e907cSAndroid Build Coastguard Worker 
28*4d7e907cSAndroid Build Coastguard Worker #include <hidl/Status.h>
29*4d7e907cSAndroid Build Coastguard Worker 
30*4d7e907cSAndroid Build Coastguard Worker #include <hidl/MQDescriptor.h>
31*4d7e907cSAndroid Build Coastguard Worker 
32*4d7e907cSAndroid Build Coastguard Worker #include "VersionUtils.h"
33*4d7e907cSAndroid Build Coastguard Worker 
34*4d7e907cSAndroid Build Coastguard Worker namespace android {
35*4d7e907cSAndroid Build Coastguard Worker namespace hardware {
36*4d7e907cSAndroid Build Coastguard Worker namespace audio {
37*4d7e907cSAndroid Build Coastguard Worker namespace effect {
38*4d7e907cSAndroid Build Coastguard Worker namespace CPP_VERSION {
39*4d7e907cSAndroid Build Coastguard Worker namespace implementation {
40*4d7e907cSAndroid Build Coastguard Worker 
41*4d7e907cSAndroid Build Coastguard Worker using ::android::sp;
42*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_string;
43*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_vec;
44*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Return;
45*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Void;
46*4d7e907cSAndroid Build Coastguard Worker using namespace ::android::hardware::audio::common::COMMON_TYPES_CPP_VERSION;
47*4d7e907cSAndroid Build Coastguard Worker using namespace ::android::hardware::audio::effect::CPP_VERSION;
48*4d7e907cSAndroid Build Coastguard Worker 
49*4d7e907cSAndroid Build Coastguard Worker struct EqualizerEffect : public IEqualizerEffect {
50*4d7e907cSAndroid Build Coastguard Worker     explicit EqualizerEffect(effect_handle_t handle);
51*4d7e907cSAndroid Build Coastguard Worker 
52*4d7e907cSAndroid Build Coastguard Worker     // Methods from ::android::hardware::audio::effect::CPP_VERSION::IEffect follow.
53*4d7e907cSAndroid Build Coastguard Worker     Return<Result> init() override;
54*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setConfig(
55*4d7e907cSAndroid Build Coastguard Worker         const EffectConfig& config, const sp<IEffectBufferProviderCallback>& inputBufferProvider,
56*4d7e907cSAndroid Build Coastguard Worker         const sp<IEffectBufferProviderCallback>& outputBufferProvider) override;
57*4d7e907cSAndroid Build Coastguard Worker     Return<Result> reset() override;
58*4d7e907cSAndroid Build Coastguard Worker     Return<Result> enable() override;
59*4d7e907cSAndroid Build Coastguard Worker     Return<Result> disable() override;
60*4d7e907cSAndroid Build Coastguard Worker #if MAJOR_VERSION <= 6
61*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setAudioSource(AudioSource source) override;
62*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setDevice(AudioDeviceBitfield device) override;
63*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setInputDevice(AudioDeviceBitfield device) override;
64*4d7e907cSAndroid Build Coastguard Worker #else
65*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setAudioSource(const AudioSource& source) override;
66*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setDevice(const DeviceAddress& device) override;
67*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setInputDevice(const DeviceAddress& device) override;
68*4d7e907cSAndroid Build Coastguard Worker #endif
69*4d7e907cSAndroid Build Coastguard Worker     Return<void> setAndGetVolume(const hidl_vec<uint32_t>& volumes,
70*4d7e907cSAndroid Build Coastguard Worker                                  setAndGetVolume_cb _hidl_cb) override;
71*4d7e907cSAndroid Build Coastguard Worker     Return<Result> volumeChangeNotification(const hidl_vec<uint32_t>& volumes) override;
72*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setAudioMode(AudioMode mode) override;
73*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setConfigReverse(
74*4d7e907cSAndroid Build Coastguard Worker         const EffectConfig& config, const sp<IEffectBufferProviderCallback>& inputBufferProvider,
75*4d7e907cSAndroid Build Coastguard Worker         const sp<IEffectBufferProviderCallback>& outputBufferProvider) override;
76*4d7e907cSAndroid Build Coastguard Worker     Return<void> getConfig(getConfig_cb _hidl_cb) override;
77*4d7e907cSAndroid Build Coastguard Worker     Return<void> getConfigReverse(getConfigReverse_cb _hidl_cb) override;
78*4d7e907cSAndroid Build Coastguard Worker     Return<void> getSupportedAuxChannelsConfigs(
79*4d7e907cSAndroid Build Coastguard Worker         uint32_t maxConfigs, getSupportedAuxChannelsConfigs_cb _hidl_cb) override;
80*4d7e907cSAndroid Build Coastguard Worker     Return<void> getAuxChannelsConfig(getAuxChannelsConfig_cb _hidl_cb) override;
81*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setAuxChannelsConfig(const EffectAuxChannelsConfig& config) override;
82*4d7e907cSAndroid Build Coastguard Worker     Return<Result> offload(const EffectOffloadParameter& param) override;
83*4d7e907cSAndroid Build Coastguard Worker     Return<void> getDescriptor(getDescriptor_cb _hidl_cb) override;
84*4d7e907cSAndroid Build Coastguard Worker     Return<void> prepareForProcessing(prepareForProcessing_cb _hidl_cb) override;
85*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setProcessBuffers(const AudioBuffer& inBuffer,
86*4d7e907cSAndroid Build Coastguard Worker                                      const AudioBuffer& outBuffer) override;
87*4d7e907cSAndroid Build Coastguard Worker     Return<void> command(uint32_t commandId, const hidl_vec<uint8_t>& data, uint32_t resultMaxSize,
88*4d7e907cSAndroid Build Coastguard Worker                          command_cb _hidl_cb) override;
89*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setParameter(const hidl_vec<uint8_t>& parameter,
90*4d7e907cSAndroid Build Coastguard Worker                                 const hidl_vec<uint8_t>& value) override;
91*4d7e907cSAndroid Build Coastguard Worker     Return<void> getParameter(const hidl_vec<uint8_t>& parameter, uint32_t valueMaxSize,
92*4d7e907cSAndroid Build Coastguard Worker                               getParameter_cb _hidl_cb) override;
93*4d7e907cSAndroid Build Coastguard Worker     Return<void> getSupportedConfigsForFeature(uint32_t featureId, uint32_t maxConfigs,
94*4d7e907cSAndroid Build Coastguard Worker                                                uint32_t configSize,
95*4d7e907cSAndroid Build Coastguard Worker                                                getSupportedConfigsForFeature_cb _hidl_cb) override;
96*4d7e907cSAndroid Build Coastguard Worker     Return<void> getCurrentConfigForFeature(uint32_t featureId, uint32_t configSize,
97*4d7e907cSAndroid Build Coastguard Worker                                             getCurrentConfigForFeature_cb _hidl_cb) override;
98*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setCurrentConfigForFeature(uint32_t featureId,
99*4d7e907cSAndroid Build Coastguard Worker                                               const hidl_vec<uint8_t>& configData) override;
100*4d7e907cSAndroid Build Coastguard Worker     Return<Result> close() override;
101*4d7e907cSAndroid Build Coastguard Worker     Return<void> debug(const hidl_handle& fd, const hidl_vec<hidl_string>& options) override;
102*4d7e907cSAndroid Build Coastguard Worker 
103*4d7e907cSAndroid Build Coastguard Worker     // Methods from ::android::hardware::audio::effect::CPP_VERSION::IEqualizerEffect follow.
104*4d7e907cSAndroid Build Coastguard Worker     Return<void> getNumBands(getNumBands_cb _hidl_cb) override;
105*4d7e907cSAndroid Build Coastguard Worker     Return<void> getLevelRange(getLevelRange_cb _hidl_cb) override;
106*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setBandLevel(uint16_t band, int16_t level) override;
107*4d7e907cSAndroid Build Coastguard Worker     Return<void> getBandLevel(uint16_t band, getBandLevel_cb _hidl_cb) override;
108*4d7e907cSAndroid Build Coastguard Worker     Return<void> getBandCenterFrequency(uint16_t band, getBandCenterFrequency_cb _hidl_cb) override;
109*4d7e907cSAndroid Build Coastguard Worker     Return<void> getBandFrequencyRange(uint16_t band, getBandFrequencyRange_cb _hidl_cb) override;
110*4d7e907cSAndroid Build Coastguard Worker     Return<void> getBandForFrequency(uint32_t freq, getBandForFrequency_cb _hidl_cb) override;
111*4d7e907cSAndroid Build Coastguard Worker     Return<void> getPresetNames(getPresetNames_cb _hidl_cb) override;
112*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setCurrentPreset(uint16_t preset) override;
113*4d7e907cSAndroid Build Coastguard Worker     Return<void> getCurrentPreset(getCurrentPreset_cb _hidl_cb) override;
114*4d7e907cSAndroid Build Coastguard Worker     Return<Result> setAllProperties(const IEqualizerEffect::AllProperties& properties) override;
115*4d7e907cSAndroid Build Coastguard Worker     Return<void> getAllProperties(getAllProperties_cb _hidl_cb) override;
116*4d7e907cSAndroid Build Coastguard Worker 
117*4d7e907cSAndroid Build Coastguard Worker    private:
118*4d7e907cSAndroid Build Coastguard Worker     sp<Effect> mEffect;
119*4d7e907cSAndroid Build Coastguard Worker 
120*4d7e907cSAndroid Build Coastguard Worker     virtual ~EqualizerEffect() = default;
121*4d7e907cSAndroid Build Coastguard Worker 
122*4d7e907cSAndroid Build Coastguard Worker     void propertiesFromHal(const t_equalizer_settings& halProperties,
123*4d7e907cSAndroid Build Coastguard Worker                            IEqualizerEffect::AllProperties* properties);
124*4d7e907cSAndroid Build Coastguard Worker     std::vector<uint8_t> propertiesToHal(const IEqualizerEffect::AllProperties& properties,
125*4d7e907cSAndroid Build Coastguard Worker                                          t_equalizer_settings** halProperties);
126*4d7e907cSAndroid Build Coastguard Worker };
127*4d7e907cSAndroid Build Coastguard Worker 
128*4d7e907cSAndroid Build Coastguard Worker }  // namespace implementation
129*4d7e907cSAndroid Build Coastguard Worker }  // namespace CPP_VERSION
130*4d7e907cSAndroid Build Coastguard Worker }  // namespace effect
131*4d7e907cSAndroid Build Coastguard Worker }  // namespace audio
132*4d7e907cSAndroid Build Coastguard Worker }  // namespace hardware
133*4d7e907cSAndroid Build Coastguard Worker }  // namespace android
134*4d7e907cSAndroid Build Coastguard Worker 
135*4d7e907cSAndroid Build Coastguard Worker #endif  // ANDROID_HARDWARE_AUDIO_EFFECT_EQUALIZEREFFECT_H
136