Split AudioGain* between fwk and android.media.audio.common
AudioGainMode and AudioGainConfig are moved as is.
The version of AudioGain in a.m.a.c is similar to the one
from Audio HIDL HAL V7. It lacks some bits used only
by the framework. These are carried in AudioGainSys.
AudioGainSys does not contain AudioGain. This is done
to simplify further splitting of other types like AudioPort.
Updated to/from AIDL conversions in libaudiofondation.
They encapsulate the fact that there are two AIDL structures
per AudioGain class instance. The AudioGain class is
simplified by stripping off no more required implementation
of Parcelable, and reusing conversion functions from
AidlConversion.
Bug: 198812639
Test: atest audiofoundation_parcelable_test
Change-Id: Ic8fa34f6d873e026c785497bb48c4a12fa90a442
diff --git a/media/libaudiofoundation/AudioGain.cpp b/media/libaudiofoundation/AudioGain.cpp
index ea0258a..1a8fbf0 100644
--- a/media/libaudiofoundation/AudioGain.cpp
+++ b/media/libaudiofoundation/AudioGain.cpp
@@ -24,22 +24,18 @@
#define ALOGVV(a...) do { } while(0)
#endif
+#include <math.h>
+
#include <algorithm>
#include <android-base/stringprintf.h>
#include <media/AudioGain.h>
#include <utils/Log.h>
-#include <math.h>
-
namespace android {
AudioGain::AudioGain(int index, bool isInput)
-{
- mIndex = index;
- mIsInput = isInput;
- memset(&mGain, 0, sizeof(struct audio_gain));
-}
+ : mIndex(index), mIsInput(isInput) {}
void AudioGain::getDefaultConfig(struct audio_gain_config *config)
{
@@ -123,53 +119,24 @@
mGain.max_ramp_ms == other->mGain.max_ramp_ms;
}
-status_t AudioGain::writeToParcel(android::Parcel *parcel) const {
- media::AudioGain parcelable;
- return writeToParcelable(&parcelable)
- ?: parcelable.writeToParcel(parcel);
+ConversionResult<AudioGain::Aidl> AudioGain::toParcelable() const {
+ media::audio::common::AudioGain aidl = VALUE_OR_RETURN(
+ legacy2aidl_audio_gain_AudioGain(mGain, mIsInput));
+ media::AudioGainSys aidlSys;
+ aidlSys.index = VALUE_OR_RETURN(convertIntegral<int32_t>(mIndex));
+ aidlSys.isInput = mIsInput;
+ aidlSys.useForVolume = mUseForVolume;
+ return std::make_pair(aidl, aidlSys);
}
-status_t AudioGain::writeToParcelable(media::AudioGain* parcelable) const {
- parcelable->index = VALUE_OR_RETURN_STATUS(convertIntegral<int32_t>(mIndex));
- parcelable->isInput = mIsInput;
- parcelable->useForVolume = mUseForVolume;
- parcelable->mode = VALUE_OR_RETURN_STATUS(
- legacy2aidl_audio_gain_mode_t_int32_t_mask(mGain.mode));
- parcelable->channelMask = VALUE_OR_RETURN_STATUS(
- legacy2aidl_audio_channel_mask_t_AudioChannelLayout(
- mGain.channel_mask, mIsInput));
- parcelable->minValue = VALUE_OR_RETURN_STATUS(convertIntegral<int32_t>(mGain.min_value));
- parcelable->maxValue = VALUE_OR_RETURN_STATUS(convertIntegral<int32_t>(mGain.max_value));
- parcelable->defaultValue = VALUE_OR_RETURN_STATUS(
- convertIntegral<int32_t>(mGain.default_value));
- parcelable->stepValue = VALUE_OR_RETURN_STATUS(convertIntegral<int32_t>(mGain.step_value));
- parcelable->minRampMs = VALUE_OR_RETURN_STATUS(convertIntegral<int32_t>(mGain.min_ramp_ms));
- parcelable->maxRampMs = VALUE_OR_RETURN_STATUS(convertIntegral<int32_t>(mGain.max_ramp_ms));
- return OK;
-}
-
-status_t AudioGain::readFromParcel(const android::Parcel *parcel) {
- media::AudioGain parcelable;
- return parcelable.readFromParcel(parcel)
- ?: readFromParcelable(parcelable);
-}
-
-status_t AudioGain::readFromParcelable(const media::AudioGain& parcelable) {
- mIndex = VALUE_OR_RETURN_STATUS(convertIntegral<int>(parcelable.index));
- mIsInput = parcelable.isInput;
- mUseForVolume = parcelable.useForVolume;
- mGain.mode = VALUE_OR_RETURN_STATUS(
- aidl2legacy_int32_t_audio_gain_mode_t_mask(parcelable.mode));
- mGain.channel_mask = VALUE_OR_RETURN_STATUS(
- aidl2legacy_AudioChannelLayout_audio_channel_mask_t(
- parcelable.channelMask, parcelable.isInput));
- mGain.min_value = VALUE_OR_RETURN_STATUS(convertIntegral<int>(parcelable.minValue));
- mGain.max_value = VALUE_OR_RETURN_STATUS(convertIntegral<int>(parcelable.maxValue));
- mGain.default_value = VALUE_OR_RETURN_STATUS(convertIntegral<int>(parcelable.defaultValue));
- mGain.step_value = VALUE_OR_RETURN_STATUS(convertIntegral<unsigned int>(parcelable.stepValue));
- mGain.min_ramp_ms = VALUE_OR_RETURN_STATUS(convertIntegral<unsigned int>(parcelable.minRampMs));
- mGain.max_ramp_ms = VALUE_OR_RETURN_STATUS(convertIntegral<unsigned int>(parcelable.maxRampMs));
- return OK;
+ConversionResult<sp<AudioGain>> AudioGain::fromParcelable(const AudioGain::Aidl& aidl) {
+ const media::AudioGainSys& sys = aidl.second;
+ auto index = VALUE_OR_RETURN(convertIntegral<int>(sys.index));
+ sp<AudioGain> legacy = sp<AudioGain>::make(index, sys.isInput);
+ legacy->mGain = VALUE_OR_RETURN(
+ aidl2legacy_AudioGain_audio_gain(aidl.first, sys.isInput));
+ legacy->mUseForVolume = sys.useForVolume;
+ return legacy;
}
bool AudioGains::equals(const AudioGains &other) const
@@ -180,59 +147,30 @@
});
}
-status_t AudioGains::writeToParcel(android::Parcel *parcel) const {
- status_t status = NO_ERROR;
- if ((status = parcel->writeVectorSize(*this)) != NO_ERROR) return status;
- for (const auto &audioGain : *this) {
- if ((status = parcel->writeParcelable(*audioGain)) != NO_ERROR) {
- break;
- }
- }
- return status;
-}
-
-status_t AudioGains::readFromParcel(const android::Parcel *parcel) {
- status_t status = NO_ERROR;
- this->clear();
- if ((status = parcel->resizeOutVector(this)) != NO_ERROR) return status;
- for (size_t i = 0; i < this->size(); i++) {
- this->at(i) = new AudioGain(0, false);
- if ((status = parcel->readParcelable(this->at(i).get())) != NO_ERROR) {
- this->clear();
- break;
- }
- }
- return status;
-}
-
ConversionResult<sp<AudioGain>>
-aidl2legacy_AudioGain(const media::AudioGain& aidl) {
- sp<AudioGain> legacy = new AudioGain(0, false);
- status_t status = legacy->readFromParcelable(aidl);
- if (status != OK) {
- return base::unexpected(status);
- }
- return legacy;
+aidl2legacy_AudioGain(const AudioGain::Aidl& aidl) {
+ return AudioGain::fromParcelable(aidl);
}
-ConversionResult<media::AudioGain>
+ConversionResult<AudioGain::Aidl>
legacy2aidl_AudioGain(const sp<AudioGain>& legacy) {
- media::AudioGain aidl;
- status_t status = legacy->writeToParcelable(&aidl);
- if (status != OK) {
- return base::unexpected(status);
- }
- return aidl;
+ return legacy->toParcelable();
}
ConversionResult<AudioGains>
-aidl2legacy_AudioGains(const std::vector<media::AudioGain>& aidl) {
- return convertContainer<AudioGains>(aidl, aidl2legacy_AudioGain);
+aidl2legacy_AudioGains(const AudioGains::Aidl& aidl) {
+ return convertContainers<AudioGains>(aidl.first, aidl.second,
+ [](const media::audio::common::AudioGain& g,
+ const media::AudioGainSys& gs) {
+ return aidl2legacy_AudioGain(std::make_pair(g, gs));
+ });
}
-ConversionResult<std::vector<media::AudioGain>>
+ConversionResult<AudioGains::Aidl>
legacy2aidl_AudioGains(const AudioGains& legacy) {
- return convertContainer<std::vector<media::AudioGain>>(legacy, legacy2aidl_AudioGain);
+ return convertContainerSplit<
+ std::vector<media::audio::common::AudioGain>,
+ std::vector<media::AudioGainSys>>(legacy, legacy2aidl_AudioGain);
}
} // namespace android
diff --git a/media/libaudiofoundation/AudioPort.cpp b/media/libaudiofoundation/AudioPort.cpp
index 74c9b10..905a0ca 100644
--- a/media/libaudiofoundation/AudioPort.cpp
+++ b/media/libaudiofoundation/AudioPort.cpp
@@ -210,12 +210,14 @@
parcelable->name = mName;
parcelable->type = VALUE_OR_RETURN_STATUS(legacy2aidl_audio_port_type_t_AudioPortType(mType));
parcelable->role = VALUE_OR_RETURN_STATUS(legacy2aidl_audio_port_role_t_AudioPortRole(mRole));
- auto aidl = VALUE_OR_RETURN_STATUS(
+ auto aidlProfiles = VALUE_OR_RETURN_STATUS(
legacy2aidl_AudioProfileVector(mProfiles, useInputChannelMask()));
- parcelable->profiles = aidl.first;
- parcelable->profilesSys = aidl.second;
+ parcelable->profiles = aidlProfiles.first;
+ parcelable->profilesSys = aidlProfiles.second;
parcelable->extraAudioDescriptors = mExtraAudioDescriptors;
- parcelable->gains = VALUE_OR_RETURN_STATUS(legacy2aidl_AudioGains(mGains));
+ auto aidlGains = VALUE_OR_RETURN_STATUS(legacy2aidl_AudioGains(mGains));
+ parcelable->gains = aidlGains.first;
+ parcelable->gainsSys = aidlGains.second;
return OK;
}
@@ -234,7 +236,8 @@
std::make_pair(parcelable.profiles, parcelable.profilesSys),
useInputChannelMask()));
mExtraAudioDescriptors = parcelable.extraAudioDescriptors;
- mGains = VALUE_OR_RETURN_STATUS(aidl2legacy_AudioGains(parcelable.gains));
+ mGains = VALUE_OR_RETURN_STATUS(
+ aidl2legacy_AudioGains(std::make_pair(parcelable.gains, parcelable.gainsSys)));
return OK;
}
diff --git a/media/libaudiofoundation/include/media/AudioGain.h b/media/libaudiofoundation/include/media/AudioGain.h
index 28769d2..10088f2 100644
--- a/media/libaudiofoundation/include/media/AudioGain.h
+++ b/media/libaudiofoundation/include/media/AudioGain.h
@@ -16,23 +16,23 @@
#pragma once
-#include <android/media/AudioGain.h>
-#include <binder/Parcel.h>
-#include <binder/Parcelable.h>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include <android/media/AudioGainSys.h>
#include <media/AidlConversion.h>
#include <utils/Errors.h>
#include <utils/RefBase.h>
#include <system/audio.h>
-#include <string>
-#include <vector>
namespace android {
-class AudioGain: public RefBase, public Parcelable
+class AudioGain: public RefBase
{
public:
AudioGain(int index, bool isInput);
- virtual ~AudioGain() {}
+ virtual ~AudioGain() = default;
void setMode(audio_gain_mode_t mode) { mGain.mode = mode; }
const audio_gain_mode_t &getMode() const { return mGain.mode; }
@@ -71,26 +71,24 @@
bool equals(const sp<AudioGain>& other) const;
- status_t writeToParcel(Parcel* parcel) const override;
- status_t readFromParcel(const Parcel* parcel) override;
-
- status_t writeToParcelable(media::AudioGain* parcelable) const;
- status_t readFromParcelable(const media::AudioGain& parcelable);
+ using Aidl = std::pair<media::audio::common::AudioGain, media::AudioGainSys>;
+ ConversionResult<Aidl> toParcelable() const;
+ static ConversionResult<sp<AudioGain>> fromParcelable(const Aidl& aidl);
private:
int mIndex;
- struct audio_gain mGain;
bool mIsInput;
+ struct audio_gain mGain = {};
bool mUseForVolume = false;
};
// Conversion routines, according to AidlConversion.h conventions.
ConversionResult<sp<AudioGain>>
-aidl2legacy_AudioGain(const media::AudioGain& aidl);
-ConversionResult<media::AudioGain>
+aidl2legacy_AudioGain(const AudioGain::Aidl& aidl);
+ConversionResult<AudioGain::Aidl>
legacy2aidl_AudioGain(const sp<AudioGain>& legacy);
-class AudioGains : public std::vector<sp<AudioGain> >, public Parcelable
+class AudioGains : public std::vector<sp<AudioGain>>
{
public:
bool canUseForVolume() const
@@ -103,7 +101,7 @@
return false;
}
- int32_t add(const sp<AudioGain> gain)
+ int32_t add(const sp<AudioGain>& gain)
{
push_back(gain);
return 0;
@@ -111,14 +109,15 @@
bool equals(const AudioGains& other) const;
- status_t writeToParcel(Parcel* parcel) const override;
- status_t readFromParcel(const Parcel* parcel) override;
+ using Aidl = std::pair<
+ std::vector<media::audio::common::AudioGain>,
+ std::vector<media::AudioGainSys>>;
};
// Conversion routines, according to AidlConversion.h conventions.
ConversionResult<AudioGains>
-aidl2legacy_AudioGains(const std::vector<media::AudioGain>& aidl);
-ConversionResult<std::vector<media::AudioGain>>
+aidl2legacy_AudioGains(const AudioGains::Aidl& aidl);
+ConversionResult<AudioGains::Aidl>
legacy2aidl_AudioGains(const AudioGains& legacy);
} // namespace android
diff --git a/media/libaudiofoundation/tests/audiofoundation_parcelable_test.cpp b/media/libaudiofoundation/tests/audiofoundation_parcelable_test.cpp
index abafff1..3a7ddd7 100644
--- a/media/libaudiofoundation/tests/audiofoundation_parcelable_test.cpp
+++ b/media/libaudiofoundation/tests/audiofoundation_parcelable_test.cpp
@@ -94,14 +94,21 @@
}
TEST(AudioFoundationParcelableTest, ParcelingAudioGain) {
- Parcel data;
- AudioGains audioGains = getAudioGainsForTest();
+ sp<AudioGain> audioGain = getAudioGainsForTest()[0];
+ auto conv = legacy2aidl_AudioGain(audioGain);
+ ASSERT_TRUE(conv.ok());
+ auto convBack = aidl2legacy_AudioGain(conv.value());
+ ASSERT_TRUE(convBack.ok());
+ ASSERT_TRUE(audioGain->equals(convBack.value()));
+}
- ASSERT_EQ(data.writeParcelable(audioGains), NO_ERROR);
- data.setDataPosition(0);
- AudioGains audioGainsFromParcel;
- ASSERT_EQ(data.readParcelable(&audioGainsFromParcel), NO_ERROR);
- ASSERT_TRUE(audioGainsFromParcel.equals(audioGains));
+TEST(AudioFoundationParcelableTest, ParcelingAudioGains) {
+ AudioGains audioGains = getAudioGainsForTest();
+ auto conv = legacy2aidl_AudioGains(audioGains);
+ ASSERT_TRUE(conv.ok());
+ auto convBack = aidl2legacy_AudioGains(conv.value());
+ ASSERT_TRUE(convBack.ok());
+ ASSERT_TRUE(audioGains.equals(convBack.value()));
}
TEST(AudioFoundationParcelableTest, ParcelingAudioPort) {