platform_hardware_interfaces/audio/effect/2.0/default/AutomaticGainControlEffect.h
Mikhail Naganov f4f2ff3974 audiohal: Fix volume changes handling
Some legacy implementations of the effects HAL use the condition
of the reply buffer being NULL as an indication that they shouldn't
apply attenuation to the input audio data. Therefore, separate
methods are needed to distinguish the use cases of delegating the
volume control to the effect, and just informing the effect of the
volume changes.

A new method added to IEffect: volumeChangeNotification that implements
the second use case. The contract of setAndGetVolume method has been
updated to indicate that it is only called in the first use case.

Also updated the wrapper for a generic IEffect commands to pass NULL
pointers to the command and reply buffers in case when the size
of the input or output data is 0, to preserve compatibility with
direct calls from the framework.

Bug: 34368451
Test: volume control works when both Bass Boost and Equalizer are
      enabled in the NXP implementation of the effects

Change-Id: I3c9a5bbdff561802bc94080c51703385a8903282
2017-01-19 12:52:27 -08:00

133 lines
5.7 KiB
C++

/*
* Copyright (C) 2016 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.
*/
#ifndef ANDROID_HARDWARE_AUDIO_EFFECT_V2_0_AUTOMATICGAINCONTROLEFFECT_H
#define ANDROID_HARDWARE_AUDIO_EFFECT_V2_0_AUTOMATICGAINCONTROLEFFECT_H
#include <system/audio_effects/effect_agc.h>
#include <android/hardware/audio/effect/2.0/IAutomaticGainControlEffect.h>
#include <hidl/Status.h>
#include <hidl/MQDescriptor.h>
#include "Effect.h"
namespace android {
namespace hardware {
namespace audio {
namespace effect {
namespace V2_0 {
namespace implementation {
using ::android::hardware::audio::effect::V2_0::IAutomaticGainControlEffect;
using ::android::hardware::audio::effect::V2_0::Result;
using ::android::hardware::Return;
using ::android::hardware::Void;
using ::android::hardware::hidl_vec;
using ::android::hardware::hidl_string;
using ::android::sp;
struct AutomaticGainControlEffect : public IAutomaticGainControlEffect {
explicit AutomaticGainControlEffect(effect_handle_t handle);
// Methods from ::android::hardware::audio::effect::V2_0::IEffect follow.
Return<Result> init() override;
Return<Result> setConfig(
const EffectConfig& config,
const sp<IEffectBufferProviderCallback>& inputBufferProvider,
const sp<IEffectBufferProviderCallback>& outputBufferProvider) override;
Return<Result> reset() override;
Return<Result> enable() override;
Return<Result> disable() override;
Return<Result> setDevice(AudioDevice device) override;
Return<void> setAndGetVolume(
const hidl_vec<uint32_t>& volumes, setAndGetVolume_cb _hidl_cb) override;
Return<Result> volumeChangeNotification(const hidl_vec<uint32_t>& volumes) override;
Return<Result> setAudioMode(AudioMode mode) override;
Return<Result> setConfigReverse(
const EffectConfig& config,
const sp<IEffectBufferProviderCallback>& inputBufferProvider,
const sp<IEffectBufferProviderCallback>& outputBufferProvider) override;
Return<Result> setInputDevice(AudioDevice device) override;
Return<void> getConfig(getConfig_cb _hidl_cb) override;
Return<void> getConfigReverse(getConfigReverse_cb _hidl_cb) override;
Return<void> getSupportedAuxChannelsConfigs(
uint32_t maxConfigs, getSupportedAuxChannelsConfigs_cb _hidl_cb) override;
Return<void> getAuxChannelsConfig(getAuxChannelsConfig_cb _hidl_cb) override;
Return<Result> setAuxChannelsConfig(const EffectAuxChannelsConfig& config) override;
Return<Result> setAudioSource(AudioSource source) override;
Return<Result> offload(const EffectOffloadParameter& param) override;
Return<void> getDescriptor(getDescriptor_cb _hidl_cb) override;
Return<void> prepareForProcessing(prepareForProcessing_cb _hidl_cb) override;
Return<Result> setProcessBuffers(
const AudioBuffer& inBuffer, const AudioBuffer& outBuffer) override;
Return<void> command(
uint32_t commandId,
const hidl_vec<uint8_t>& data,
uint32_t resultMaxSize,
command_cb _hidl_cb) override;
Return<Result> setParameter(
const hidl_vec<uint8_t>& parameter, const hidl_vec<uint8_t>& value) override;
Return<void> getParameter(
const hidl_vec<uint8_t>& parameter,
uint32_t valueMaxSize,
getParameter_cb _hidl_cb) override;
Return<void> getSupportedConfigsForFeature(
uint32_t featureId,
uint32_t maxConfigs,
uint32_t configSize,
getSupportedConfigsForFeature_cb _hidl_cb) override;
Return<void> getCurrentConfigForFeature(
uint32_t featureId,
uint32_t configSize,
getCurrentConfigForFeature_cb _hidl_cb) override;
Return<Result> setCurrentConfigForFeature(
uint32_t featureId, const hidl_vec<uint8_t>& configData) override;
Return<Result> close() override;
// Methods from ::android::hardware::audio::effect::V2_0::IAutomaticGainControlEffect follow.
Return<Result> setTargetLevel(int16_t targetLevelMb) override;
Return<void> getTargetLevel(getTargetLevel_cb _hidl_cb) override;
Return<Result> setCompGain(int16_t compGainMb) override;
Return<void> getCompGain(getCompGain_cb _hidl_cb) override;
Return<Result> setLimiterEnabled(bool enabled) override;
Return<void> isLimiterEnabled(isLimiterEnabled_cb _hidl_cb) override;
Return<Result> setAllProperties(
const IAutomaticGainControlEffect::AllProperties& properties) override;
Return<void> getAllProperties(getAllProperties_cb _hidl_cb) override;
private:
sp<Effect> mEffect;
virtual ~AutomaticGainControlEffect();
void propertiesFromHal(
const t_agc_settings& halProperties,
IAutomaticGainControlEffect::AllProperties* properties);
void propertiesToHal(
const IAutomaticGainControlEffect::AllProperties& properties,
t_agc_settings* halProperties);
};
} // namespace implementation
} // namespace V2_0
} // namespace effect
} // namespace audio
} // namespace hardware
} // namespace android
#endif // ANDROID_HARDWARE_AUDIO_EFFECT_V2_0_AUTOMATICGAINCONTROLEFFECT_H