Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ff611980 authored by Mikhail Naganov's avatar Mikhail Naganov
Browse files

audio: Update common types to better match legacy structs 

HAL V7 types were updated to better match data structure
definitions from the legacy HAL:

 - Added 'AudioConfigBaseOptional' struct to match
   legacy structs that have 'mask' field to specify
   initialized fields.

 - All fields in 'AudioConfigBase' made mandatory.

 - Removed 'EffectConfigParameters' in favor of
   'AudioConfigBaseOptional' and safe_unions.

 - Added missing enum string values to ensure that round-trip
   conversions from the legacy HAL to HIDL and back to legacy
   preserve enum values.

Bug: 142480271
Test: atest android.hardware.audio.common@7.0-util_tests
Test: atest VtsHalAudioV6_0TargetTest
Test: atest VtsHalAudioV7_0TargetTest
Test: atest VtsHalAudioEffectV7_0TargetTest
Change-Id: If02a81b3f6790a8eb315fa57123141aad2419132
parent 31f2eb37

audio/7.0/IStream.hal

+2 −2
Original line number Diff line number Diff line
@@ -73,14 +73,14 @@ interface IStream { 


    /**

     * Sets stream parameters. Only sets parameters that are specified.

     * See the description of AudioConfigBase for the details.

     *

     * Optional method. If implemented, only called on a stopped stream.

     *

     * @param config basic stream configuration.

     * @return retval operation completion status.

     */

    setAudioProperties(AudioConfigBase config) generates (Result retval);

    setAudioProperties(AudioConfigBaseOptional config)

            generates (Result retval);



    /**

     * Applies audio effect to the stream.

audio/7.0/config/api/current.txt

+1 −0
Original line number Diff line number Diff line
@@ -198,6 +198,7 @@ package android.audio.policy.configuration.V7_0 { 
    enum_constant public static final android.audio.policy.configuration.V7_0.AudioFormat AUDIO_FORMAT_APTX_HD;

    enum_constant public static final android.audio.policy.configuration.V7_0.AudioFormat AUDIO_FORMAT_APTX_TWSP;

    enum_constant public static final android.audio.policy.configuration.V7_0.AudioFormat AUDIO_FORMAT_CELT;

    enum_constant public static final android.audio.policy.configuration.V7_0.AudioFormat AUDIO_FORMAT_DEFAULT;

    enum_constant public static final android.audio.policy.configuration.V7_0.AudioFormat AUDIO_FORMAT_DOLBY_TRUEHD;

    enum_constant public static final android.audio.policy.configuration.V7_0.AudioFormat AUDIO_FORMAT_DSD;

    enum_constant public static final android.audio.policy.configuration.V7_0.AudioFormat AUDIO_FORMAT_DTS;

audio/7.0/config/audio_policy_configuration.xsd

+1 −0
Original line number Diff line number Diff line
@@ -329,6 +329,7 @@ 
    </xs:simpleType>

    <xs:simpleType name="audioFormat">

        <xs:restriction base="xs:string">

            <xs:enumeration value="AUDIO_FORMAT_DEFAULT" />

            <xs:enumeration value="AUDIO_FORMAT_PCM_16_BIT" />

            <xs:enumeration value="AUDIO_FORMAT_PCM_8_BIT"/>

            <xs:enumeration value="AUDIO_FORMAT_PCM_32_BIT"/>

audio/common/7.0/example/Effect.cpp

+7 −8
Original line number Diff line number Diff line
@@ -107,14 +107,13 @@ Return<Result> Effect::setInputDevice(const DeviceAddress& device) { 
}



Return<void> Effect::getConfig(getConfig_cb _hidl_cb) {

    const EffectConfig config = {

            {} /* inputCfg */,

            // outputCfg

            {{} /* buffer */,

             {toString(xsd::AudioFormat::AUDIO_FORMAT_PCM_16_BIT), 48000 /* samplingRateHz */,

              toString(xsd::AudioChannelMask::AUDIO_CHANNEL_OUT_STEREO)}, /* base */

             EffectBufferAccess::ACCESS_ACCUMULATE,

             0 /* mask */}};

    EffectConfig config;

    // inputCfg left unspecified.

    config.outputCfg.base.format.value(toString(xsd::AudioFormat::AUDIO_FORMAT_PCM_16_BIT));

    config.outputCfg.base.sampleRateHz.value(48000);

    config.outputCfg.base.channelMask.value(

            toString(xsd::AudioChannelMask::AUDIO_CHANNEL_OUT_STEREO));

    config.outputCfg.accessMode.value(EffectBufferAccess::ACCESS_ACCUMULATE);

    _hidl_cb(Result::OK, config);

    return Void();

}

audio/common/7.0/types.hal

+24 −7
Original line number Diff line number Diff line
@@ -118,9 +118,28 @@ typedef string AudioChannelMask; 
 * Base configuration attributes applicable to any stream of audio.

 */

struct AudioConfigBase {

    AudioFormat format;                 // empty means 'unspecified'

    uint32_t sampleRateHz;              // 0 means 'unspecified'

    AudioChannelMask channelMask;       // empty means 'unspecified'

    AudioFormat format;

    uint32_t sampleRateHz;

    AudioChannelMask channelMask;

};



/**

 * Base configuration attributes applicable to any stream of audio.

 * Any attribute may be left unspecified.

 */

struct AudioConfigBaseOptional {

    safe_union Format {

        Monostate unspecified;

        AudioFormat value;

    } format;

    safe_union SampleRate {

        Monostate unspecified;

        uint32_t value;

    } sampleRateHz;

    safe_union ChannelMask {

        Monostate unspecified;

        AudioChannelMask value;

    } channelMask;

};



/**
@@ -439,11 +458,9 @@ struct AudioPortConfig { 
     */

    AudioPortHandle id;

    /**

     * Basic parameters: sampling rate, format, channel mask. Only some of the

     * parameters (or none) may be set. See the documentation of the

     * AudioConfigBase struct.

     * Basic parameters: sampling rate, format, channel mask.

     */

    AudioConfigBase base;

    AudioConfigBaseOptional base;

    /** Associated gain control. */

    safe_union OptionalGain {

        Monostate unspecified;