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

Commit a2c71412 authored by Mikhail Naganov's avatar Mikhail Naganov Committed by Lorena Torres-Huerta
Browse files

audio: Add StreamDescriptor.frameSizeBytes 

This field indicates the frame size and is filled by
the HAL module, so that the client does not have
to calculate it.

As a side effect, in the VTS code, a StreamContext can
now be created solely from a StreamDescriptor.

Added unit tests for the functions from Utils.

Bug: 205884982
Test: atest libaudioaidlcommon_test
Test: atest VtsHalAudioCoreTargetTest
Merged-In: Ief836b8b2d35bacb1f9778e2462d540554149d7f
Change-Id: Ief836b8b2d35bacb1f9778e2462d540554149d7f
(cherry picked from commit 5862c1e3)
parent 4f5d3f12

audio/aidl/aidl_api/android.hardware.audio.core/current/android/hardware/audio/core/StreamDescriptor.aidl

+1 −0
Original line number Original line Diff line number Diff line
@@ -36,6 +36,7 @@ package android.hardware.audio.core; 
parcelable StreamDescriptor {

parcelable StreamDescriptor {

  android.hardware.common.fmq.MQDescriptor<android.hardware.audio.core.StreamDescriptor.Command,android.hardware.common.fmq.SynchronizedReadWrite> command;

  android.hardware.common.fmq.MQDescriptor<android.hardware.audio.core.StreamDescriptor.Command,android.hardware.common.fmq.SynchronizedReadWrite> command;

  android.hardware.common.fmq.MQDescriptor<android.hardware.audio.core.StreamDescriptor.Reply,android.hardware.common.fmq.SynchronizedReadWrite> reply;

  android.hardware.common.fmq.MQDescriptor<android.hardware.audio.core.StreamDescriptor.Reply,android.hardware.common.fmq.SynchronizedReadWrite> reply;

  int frameSizeBytes;

  long bufferSizeFrames;

  long bufferSizeFrames;

  android.hardware.audio.core.StreamDescriptor.AudioBuffer audio;

  android.hardware.audio.core.StreamDescriptor.AudioBuffer audio;

  const int COMMAND_BURST = 1;

  const int COMMAND_BURST = 1;

audio/aidl/android/hardware/audio/core/StreamDescriptor.aidl

+8 −0
Original line number Original line Diff line number Diff line
@@ -144,6 +144,14 @@ parcelable StreamDescriptor { 
    }

    }

    MQDescriptor<Reply, SynchronizedReadWrite> reply;

    MQDescriptor<Reply, SynchronizedReadWrite> reply;





    /**

     * The size of one frame of audio data in bytes. For PCM formats this is

     * usually equal to the size of a sample multiplied by the number of

     * channels used. For encoded bitstreams encapsulated into PCM the sample

     * size of the underlying PCM stream is used. For encoded bitstreams that

     * are passed without encapsulation, the frame size is usually 1 byte.

     */

    int frameSizeBytes;

    /**

    /**

     * Total buffer size in frames. This applies both to the size of the 'audio.fmq'

     * Total buffer size in frames. This applies both to the size of the 'audio.fmq'

     * queue and to the size of the shared memory buffer for MMap No IRQ streams.

     * queue and to the size of the shared memory buffer for MMap No IRQ streams.

audio/aidl/common/Android.bp

+2 −0
Original line number Original line Diff line number Diff line
@@ -46,6 +46,7 @@ cc_test { 
    host_supported: true,

    host_supported: true,

    vendor_available: true,

    vendor_available: true,

    static_libs: [

    static_libs: [

        "android.media.audio.common.types-V1-ndk",

        "libaudioaidlcommon",

        "libaudioaidlcommon",

    ],

    ],

    shared_libs: [

    shared_libs: [
@@ -59,6 +60,7 @@ cc_test { 
    ],

    ],

    srcs: [

    srcs: [

        "tests/streamworker_tests.cpp",

        "tests/streamworker_tests.cpp",

        "tests/utils_tests.cpp",

    ],

    ],

    test_suites: [

    test_suites: [

        "general-tests",

        "general-tests",

audio/aidl/common/include/Utils.h

+10 −2
Original line number Original line Diff line number Diff line
@@ -62,12 +62,20 @@ constexpr size_t getChannelCount( 
constexpr size_t getFrameSizeInBytes(

constexpr size_t getFrameSizeInBytes(

        const ::aidl::android::media::audio::common::AudioFormatDescription& format,

        const ::aidl::android::media::audio::common::AudioFormatDescription& format,

        const ::aidl::android::media::audio::common::AudioChannelLayout& layout) {

        const ::aidl::android::media::audio::common::AudioChannelLayout& layout) {

    if (format == ::aidl::android::media::audio::common::AudioFormatDescription{}) {

        // Unspecified format.

        return 0;

    }

    using ::aidl::android::media::audio::common::AudioFormatType;

    using ::aidl::android::media::audio::common::AudioFormatType;

    if (format.type == AudioFormatType::PCM) {

    if (format.type == AudioFormatType::PCM) {

        return getPcmSampleSizeInBytes(format.pcm) * getChannelCount(layout);

        return getPcmSampleSizeInBytes(format.pcm) * getChannelCount(layout);

    } else if (format.type == AudioFormatType::NON_PCM) {

        // For non-PCM formats always use the underlying PCM size. The default value for

        // PCM is "UINT_8_BIT", thus non-encapsulated streams have the frame size of 1.

        return getPcmSampleSizeInBytes(format.pcm);

    }

    }

    // For non-PCM formats always use frame size of 1.

    // Something unexpected.

    return 1;

    return 0;

}

}





}  // namespace android::hardware::audio::common
 
}  // namespace android::hardware::audio::common

audio/aidl/common/tests/utils_tests.cpp

0 → 100644
+190 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2022 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.

 */



#include <cstdint>

#include <limits>

#include <type_traits>

#include <utility>

#include <vector>



#include <Utils.h>



#include <gtest/gtest.h>

#define LOG_TAG "Utils_Test"

#include <log/log.h>



using aidl::android::media::audio::common::AudioChannelLayout;

using aidl::android::media::audio::common::AudioFormatDescription;

using aidl::android::media::audio::common::AudioFormatType;

using aidl::android::media::audio::common::PcmType;

using android::hardware::audio::common::getChannelCount;

using android::hardware::audio::common::getFrameSizeInBytes;

using android::hardware::audio::common::getPcmSampleSizeInBytes;



TEST(UtilsTest, ChannelCountOddCases) {

    using Tag = AudioChannelLayout::Tag;

    EXPECT_EQ(0UL, getChannelCount(AudioChannelLayout{}));

    EXPECT_EQ(0UL, getChannelCount(AudioChannelLayout::make<Tag::invalid>(0)));

    EXPECT_EQ(0UL, getChannelCount(AudioChannelLayout::make<Tag::invalid>(-1)));

}



TEST(UtilsTest, ChannelCountForIndexMask) {

    using Tag = AudioChannelLayout::Tag;

    EXPECT_EQ(0UL, getChannelCount(AudioChannelLayout::make<Tag::indexMask>(0)));

#define VERIFY_INDEX_MASK(N)                                                                  \

    {                                                                                         \

        const auto l =                                                                        \

                AudioChannelLayout::make<Tag::indexMask>(AudioChannelLayout::INDEX_MASK_##N); \

        EXPECT_EQ(N##UL, getChannelCount(l)) << l.toString();                                 \

    }

    VERIFY_INDEX_MASK(1);

    VERIFY_INDEX_MASK(2);

    VERIFY_INDEX_MASK(3);

    VERIFY_INDEX_MASK(4);

    VERIFY_INDEX_MASK(5);

    VERIFY_INDEX_MASK(6);

    VERIFY_INDEX_MASK(7);

    VERIFY_INDEX_MASK(8);

    VERIFY_INDEX_MASK(9);

    VERIFY_INDEX_MASK(10);

    VERIFY_INDEX_MASK(11);

    VERIFY_INDEX_MASK(12);

    VERIFY_INDEX_MASK(13);

    VERIFY_INDEX_MASK(14);

    VERIFY_INDEX_MASK(15);

    VERIFY_INDEX_MASK(16);

    VERIFY_INDEX_MASK(17);

    VERIFY_INDEX_MASK(18);

    VERIFY_INDEX_MASK(19);

    VERIFY_INDEX_MASK(20);

    VERIFY_INDEX_MASK(21);

    VERIFY_INDEX_MASK(22);

    VERIFY_INDEX_MASK(23);

    VERIFY_INDEX_MASK(24);

#undef VERIFY_INDEX_MASK

}



TEST(UtilsTest, ChannelCountForLayoutMask) {

    using Tag = AudioChannelLayout::Tag;

    const std::vector<std::pair<size_t, int32_t>> kTestLayouts = {

            std::make_pair(0UL, 0),

            std::make_pair(1UL, AudioChannelLayout::LAYOUT_MONO),

            std::make_pair(2UL, AudioChannelLayout::LAYOUT_STEREO),

            std::make_pair(6UL, AudioChannelLayout::LAYOUT_5POINT1),

            std::make_pair(8UL, AudioChannelLayout::LAYOUT_7POINT1),

            std::make_pair(16UL, AudioChannelLayout::LAYOUT_9POINT1POINT6),

            std::make_pair(13UL, AudioChannelLayout::LAYOUT_13POINT_360RA),

            std::make_pair(24UL, AudioChannelLayout::LAYOUT_22POINT2),

            std::make_pair(3UL, AudioChannelLayout::LAYOUT_STEREO_HAPTIC_A),

            std::make_pair(4UL, AudioChannelLayout::LAYOUT_STEREO_HAPTIC_AB)};

    for (const auto& [expected_count, layout] : kTestLayouts) {

        const auto l = AudioChannelLayout::make<Tag::layoutMask>(layout);

        EXPECT_EQ(expected_count, getChannelCount(l)) << l.toString();

    }

}



TEST(UtilsTest, ChannelCountForVoiceMask) {

    using Tag = AudioChannelLayout::Tag;

    // clang-format off

    const std::vector<std::pair<size_t, int32_t>> kTestLayouts = {

            std::make_pair(0UL, 0),

            std::make_pair(1UL, AudioChannelLayout::VOICE_UPLINK_MONO),

            std::make_pair(1UL, AudioChannelLayout::VOICE_DNLINK_MONO),

            std::make_pair(2UL, AudioChannelLayout::VOICE_CALL_MONO)};

    // clang-format on

    for (const auto& [expected_count, layout] : kTestLayouts) {

        const auto l = AudioChannelLayout::make<Tag::voiceMask>(layout);

        EXPECT_EQ(expected_count, getChannelCount(l)) << l.toString();

    }

}



namespace {



AudioChannelLayout make_AudioChannelLayout_Mono() {

    return AudioChannelLayout::make<AudioChannelLayout::Tag::layoutMask>(

            AudioChannelLayout::LAYOUT_MONO);

}



AudioChannelLayout make_AudioChannelLayout_Stereo() {

    return AudioChannelLayout::make<AudioChannelLayout::Tag::layoutMask>(

            AudioChannelLayout::LAYOUT_STEREO);

}



AudioFormatDescription make_AudioFormatDescription(AudioFormatType type) {

    AudioFormatDescription result;

    result.type = type;

    return result;

}



AudioFormatDescription make_AudioFormatDescription(PcmType pcm) {

    auto result = make_AudioFormatDescription(AudioFormatType::PCM);

    result.pcm = pcm;

    return result;

}



AudioFormatDescription make_AudioFormatDescription(const std::string& encoding) {

    AudioFormatDescription result;

    result.encoding = encoding;

    return result;

}



AudioFormatDescription make_AudioFormatDescription(PcmType transport, const std::string& encoding) {

    auto result = make_AudioFormatDescription(encoding);

    result.pcm = transport;

    return result;

}



}  // namespace



TEST(UtilsTest, FrameSize) {

    EXPECT_EQ(0UL, getFrameSizeInBytes(AudioFormatDescription{}, AudioChannelLayout{}));

    EXPECT_EQ(sizeof(int16_t), getFrameSizeInBytes(make_AudioFormatDescription(PcmType::INT_16_BIT),

                                                   make_AudioChannelLayout_Mono()));

    EXPECT_EQ(2 * sizeof(int16_t),

              getFrameSizeInBytes(make_AudioFormatDescription(PcmType::INT_16_BIT),

                                  make_AudioChannelLayout_Stereo()));

    EXPECT_EQ(sizeof(int32_t), getFrameSizeInBytes(make_AudioFormatDescription(PcmType::INT_32_BIT),

                                                   make_AudioChannelLayout_Mono()));

    EXPECT_EQ(2 * sizeof(int32_t),

              getFrameSizeInBytes(make_AudioFormatDescription(PcmType::INT_32_BIT),

                                  make_AudioChannelLayout_Stereo()));

    EXPECT_EQ(sizeof(float), getFrameSizeInBytes(make_AudioFormatDescription(PcmType::FLOAT_32_BIT),

                                                 make_AudioChannelLayout_Mono()));

    EXPECT_EQ(2 * sizeof(float),

              getFrameSizeInBytes(make_AudioFormatDescription(PcmType::FLOAT_32_BIT),

                                  make_AudioChannelLayout_Stereo()));

    EXPECT_EQ(sizeof(uint8_t),

              getFrameSizeInBytes(make_AudioFormatDescription("bitstream"), AudioChannelLayout{}));

    EXPECT_EQ(sizeof(int16_t),

              getFrameSizeInBytes(make_AudioFormatDescription(PcmType::INT_16_BIT, "encapsulated"),

                                  AudioChannelLayout{}));

}



TEST(UtilsTest, PcmSampleSize) {

    EXPECT_EQ(1UL, getPcmSampleSizeInBytes(PcmType{}));

    EXPECT_EQ(sizeof(uint8_t), getPcmSampleSizeInBytes(PcmType::UINT_8_BIT));

    EXPECT_EQ(sizeof(int16_t), getPcmSampleSizeInBytes(PcmType::INT_16_BIT));

    EXPECT_EQ(sizeof(int32_t), getPcmSampleSizeInBytes(PcmType::INT_32_BIT));

    EXPECT_EQ(sizeof(int32_t), getPcmSampleSizeInBytes(PcmType::FIXED_Q_8_24));

    EXPECT_EQ(sizeof(float), getPcmSampleSizeInBytes(PcmType::FLOAT_32_BIT));

    EXPECT_EQ(3UL, getPcmSampleSizeInBytes(PcmType::INT_24_BIT));

    EXPECT_EQ(0UL, getPcmSampleSizeInBytes(PcmType(-1)));

    using PcmTypeUnderlyingType = std::underlying_type_t<PcmType>;

    EXPECT_EQ(0UL,

              getPcmSampleSizeInBytes(PcmType(std::numeric_limits<PcmTypeUnderlyingType>::min())));

    EXPECT_EQ(0UL,

              getPcmSampleSizeInBytes(PcmType(std::numeric_limits<PcmTypeUnderlyingType>::max())));

}