audio: Factor out IStream operations into a helper class (422afc13) · Commits · e / os / android_hardware_interfaces

audio/core/all-versions/vts/functional/4.0/AudioPrimaryHidlHalTest.cpp

+9 −19

Original line number	Diff line number	Diff line
		@@ -52,7 +52,6 @@ TEST_P(AudioHidlDeviceTest, GetMicrophonesTest) {
		doc::test(
		"Make sure getMicrophones always succeeds"
		"and getActiveMicrophones always succeeds when recording from these microphones.");
		AudioIoHandle ioHandle = (AudioIoHandle)AudioHandleConsts::AUDIO_IO_HANDLE_NONE;
		AudioConfig config{};
		config.channelMask = mkEnumBitfield(AudioChannelMask::IN_MONO);
		config.sampleRateHz = 8000;
		@@ -65,18 +64,14 @@ TEST_P(AudioHidlDeviceTest, GetMicrophonesTest) {
		continue;
		}
		sp<IStreamIn> stream;
		StreamHelper<IStreamIn> helper(stream);
		AudioConfig suggestedConfig{};
		ASSERT_OK(getDevice()->openInputStream(ioHandle, microphone.deviceAddress, config,
		flags, initMetadata,
		returnIn(res, stream, suggestedConfig)));
		if (res != Result::OK) {
		ASSERT_TRUE(stream == nullptr);
		AudioConfig suggestedConfigRetry{};
		ASSERT_OK(getDevice()->openInputStream(
		ioHandle, microphone.deviceAddress, suggestedConfig, flags, initMetadata,
		returnIn(res, stream, suggestedConfigRetry)));
		}
		ASSERT_OK(res);
		ASSERT_NO_FATAL_FAILURE(helper.open(
		[&](AudioIoHandle handle, AudioConfig config, auto cb) {
		return getDevice()->openInputStream(handle, microphone.deviceAddress,
		config, flags, initMetadata, cb);
		},
		config, &res, &suggestedConfig));
		hidl_vec<MicrophoneInfo> activeMicrophones;
		Result readRes;
		typedef MessageQueue<IStreamIn::ReadParameters, kSynchronizedReadWrite> CommandMQ;
		@@ -110,13 +105,8 @@ TEST_P(AudioHidlDeviceTest, GetMicrophonesTest) {
		ASSERT_OK(res);
		ASSERT_NE(0U, activeMicrophones.size());
		}
		stream->close();
		#if MAJOR_VERSION <= 5
		// Workaround for b/139329877. Ensures the stream gets closed on the audio hal side.
		stream.clear();
		IPCThreadState::self()->flushCommands();
		usleep(1000);
		#endif
		helper.close(true /clear/, &res);
		ASSERT_OK(res);
		if (efGroup) {
		EventFlag::deleteEventFlag(&efGroup);
		}

audio/core/all-versions/vts/functional/AudioPrimaryHidlHalTest.h

+62 −42

Original line number	Diff line number	Diff line
		@@ -809,50 +809,50 @@ TEST_P(AudioHidlDeviceTest, DebugDumpInvalidArguments) {
		////////////////////////// open{Output,Input}Stream //////////////////////////
		//////////////////////////////////////////////////////////////////////////////

		// This class is also used by some device tests.
		template <class Stream>
		class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter {
		protected:
		class StreamHelper {
		public:
		// StreamHelper doesn't own the stream, this is for simpler stream lifetime management.
		explicit StreamHelper(sp<Stream>& stream) : mStream(stream) {}
		template <class Open>
		void testOpen(Open openStream, const AudioConfig& config) {
		void open(Open openStream, const AudioConfig& config, Result* res,
		AudioConfig* suggestedConfigPtr) {
		// FIXME: Open a stream without an IOHandle
		// This is not required to be accepted by hal implementations
		AudioIoHandle ioHandle = (AudioIoHandle)AudioHandleConsts::AUDIO_IO_HANDLE_NONE;
		AudioConfig suggestedConfig{};
		ASSERT_OK(openStream(ioHandle, config, returnIn(res, stream, suggestedConfig)));

		// TODO: only allow failure for RecommendedPlaybackAudioConfig
		switch (res) {
		bool retryWithSuggestedConfig = true;
		if (suggestedConfigPtr == nullptr) {
		suggestedConfigPtr = &suggestedConfig;
		retryWithSuggestedConfig = false;
		}
		ASSERT_OK(openStream(ioHandle, config, returnIn(res, mStream, suggestedConfigPtr)));
		switch (*res) {
		case Result::OK:
		ASSERT_TRUE(stream != nullptr);
		audioConfig = config;
		ASSERT_TRUE(mStream != nullptr);
		*suggestedConfigPtr = config;
		break;
		case Result::INVALID_ARGUMENTS:
		ASSERT_TRUE(stream == nullptr);
		ASSERT_TRUE(mStream == nullptr);
		if (retryWithSuggestedConfig) {
		AudioConfig suggestedConfigRetry;
		// Could not open stream with config, try again with the
		// suggested one
		ASSERT_OK(openStream(ioHandle, suggestedConfig,
		returnIn(res, stream, suggestedConfigRetry)));
		// This time it must succeed
		ASSERT_OK(res);
		ASSERT_TRUE(stream != nullptr);
		audioConfig = suggestedConfig;
		ASSERT_OK(openStream(ioHandle, *suggestedConfigPtr,
		returnIn(*res, mStream, suggestedConfigRetry)));
		ASSERT_OK(*res);
		ASSERT_TRUE(mStream != nullptr);
		}
		break;
		default:
		FAIL() << "Invalid return status: " << ::testing::PrintToString(res);
		FAIL() << "Invalid return status: " << ::testing::PrintToString(*res);
		}
		open = true;
		}

		Return<Result> closeStream() {
		open = false;
		auto res = stream->close();
		stream.clear();
		waitForStreamDestruction();
		return res;
		}

		static void waitForStreamDestruction() {
		void close(bool clear, Result* res) {
		auto ret = mStream->close();
		EXPECT_TRUE(ret.isOk());
		*res = ret;
		if (clear) {
		mStream.clear();
		#if MAJOR_VERSION <= 5
		// FIXME: there is no way to know when the remote IStream is being destroyed
		// Binder does not support testing if an object is alive, thus
		@@ -864,6 +864,28 @@ class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter {
		usleep(100 * 1000);
		#endif
		}
		}

		private:
		sp<Stream>& mStream;
		};

		template <class Stream>
		class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter {
		protected:
		OpenStreamTest() : AudioHidlTestWithDeviceConfigParameter(), helper(stream) {}
		template <class Open>
		void testOpen(Open openStream, const AudioConfig& config) {
		// TODO: only allow failure for RecommendedPlaybackAudioConfig
		ASSERT_NO_FATAL_FAILURE(helper.open(openStream, config, &res, &audioConfig));
		open = true;
		}

		Result closeStream(bool clear = true) {
		open = false;
		helper.close(clear, &res);
		return res;
		}

		private:
		void TearDown() override {
		@@ -877,6 +899,7 @@ class OpenStreamTest : public AudioHidlTestWithDeviceConfigParameter {
		AudioConfig audioConfig;
		DeviceAddress address = {};
		sp<Stream> stream;
		StreamHelper<Stream> helper;
		bool open = false;
		};

		@@ -1178,11 +1201,8 @@ TEST_IO_STREAM(getMmapPositionNoMmap, "Get a stream Mmap position before mapping
		TEST_IO_STREAM(close, "Make sure a stream can be closed", ASSERT_OK(closeStream()))
		// clang-format off
		TEST_IO_STREAM(closeTwice, "Make sure a stream can not be closed twice",
		auto streamCopy = stream;
		ASSERT_OK(closeStream());
		ASSERT_RESULT(Result::INVALID_STATE, streamCopy->close());
		streamCopy.clear();
		waitForStreamDestruction())
		ASSERT_OK(closeStream(false /clear/));
		ASSERT_EQ(Result::INVALID_STATE, closeStream()))
		// clang-format on

		static void testMmapBufferOfInvalidSize(IStream* stream) {