Merge changes from topics "fix-b-133526565-setters-getters", "fix-b-133526565-setters-getters-2" (6f3fdba6) · Commits · e / os / android_hardware_interfaces

audio/6.0/IStreamOut.hal

+86 −0

Original line number	Diff line number	Diff line
		@@ -276,4 +276,90 @@ interface IStreamOut extends IStream {
		*/
		selectPresentation(int32_t presentationId, int32_t programId)
		generates (Result retval);

		/**
		* Returns the Dual Mono mode presentation setting.
		*
		* Optional method
		*
		* @return retval operation completion status.
		* @return mode current setting of Dual Mono mode.
		*/
		getDualMonoMode() generates (Result retval, DualMonoMode mode);

		/**
		* Sets the Dual Mono mode presentation on the output device.
		*
		* The Dual Mono mode is generally applied to stereo audio streams
		* where the left and right channels come from separate sources.
		*
		* Optional method
		*
		* @param mode selected Dual Mono mode.
		* @return retval operation completion status.
		*/
		setDualMonoMode(DualMonoMode mode) generates (Result retval);

		/**
		* Returns the Audio Description Mix level in dB.
		*
		* The level is applied to streams incorporating a secondary Audio
		* Description stream. It specifies the relative level of mixing for
		* the Audio Description with a reference to the Main Audio.
		*
		* Optional method
		*
		* The value of the relative level is in the range from negative infinity
		* to +48.
		*
		* @return retval operation completion status.
		* @return leveldB the current Audio Description Mix Level in dB.
		*/
		getAudioDescriptionMixLevel() generates (Result retval, float leveldB);

		/**
		* Sets the Audio Description Mix level in dB.
		*
		* For streams incorporating a secondary Audio Description stream
		* the relative level of mixing of the Audio Description to the Main Audio
		* is controlled by this method.
		*
		* Optional method
		*
		* The value of the relative level must be in the range from negative
		* infinity to +48.
		*
		* @param leveldB Audio Description Mix Level in dB
		* @return retval operation completion status.
		*/
		setAudioDescriptionMixLevel(float leveldB) generates (Result retval);

		/**
		* Retrieves current playback rate parameters.
		*
		* Optional method
		*
		* @return retval operation completion status.
		* @return playbackRate current playback parameters
		*/
		getPlaybackRateParameters()
		generates (Result retval, PlaybackRate playbackRate);

		/**
		* Sets the playback rate parameters that control playback behavior.
		* This is normally used when playing encoded content and decoding
		* is performed in hardware. Otherwise, the framework can apply
		* necessary transformations.
		*
		* Optional method
		*
		* If the HAL supports setting the playback rate, it is recommended
		* to support speed and pitch values at least in the range
		* from 0.5f to 2.0f, inclusive (see the definition of PlaybackRate struct).
		*
		* @param playbackRate playback parameters
		* @return retval operation completion status.
		*/
		setPlaybackRateParameters(PlaybackRate playbackRate)
		generates (Result retval);
		};

audio/6.0/types.hal

+108 −0

Original line number	Diff line number	Diff line
		@@ -247,3 +247,111 @@ enum MicrophoneDirection : int32_t {
		*/
		EXTERNAL = 3,
		};


		/* Dual Mono handling is used when a stereo audio stream
		* contains separate audio content on the left and right channels.
		* Such information about the content of the stream may be found, for example,
		* in ITU T-REC-J.94-201610 A.6.2.3 Component descriptor.
		*/
		@export(name="audio_dual_mono_mode_t", value_prefix="AUDIO_DUAL_MONO_MODE_")
		enum DualMonoMode : int32_t {
		// Need to be in sync with DUAL_MONO_MODE* constants in
		// frameworks/base/media/java/android/media/AudioTrack.java
		/**
		* Disable any Dual Mono presentation effect.
		*
		*/
		OFF = 0,
		/**
		* This mode indicates that a stereo stream should be presented
		* with the left and right audio channels blended together
		* and delivered to both channels.
		*
		* Behavior for non-stereo streams is implementation defined.
		* A suggested guideline is that the left-right stereo symmetric
		* channels are pairwise blended, the other channels such as center
		* are left alone.
		*/
		LR = 1,
		/**
		* This mode indicates that a stereo stream should be presented
		* with the left audio channel replicated into the right audio channel.
		*
		* Behavior for non-stereo streams is implementation defined.
		* A suggested guideline is that all channels with left-right
		* stereo symmetry will have the left channel position replicated
		* into the right channel position. The center channels (with no
		* left/right symmetry) or unbalanced channels are left alone.
		*/
		LL = 2,
		/**
		* This mode indicates that a stereo stream should be presented
		* with the right audio channel replicated into the left audio channel.
		*
		* Behavior for non-stereo streams is implementation defined.
		* A suggested guideline is that all channels with left-right
		* stereo symmetry will have the right channel position replicated
		* into the left channel position. The center channels (with no
		* left/right symmetry) or unbalanced channels are left alone.
		*/
		RR = 3,
		};

		/**
		* Algorithms used for timestretching (preserving pitch while playing audio
		* content at different speed).
		*/
		@export(name="audio_timestretch_stretch_mode_t", value_prefix="AUDIO_TIMESTRETCH_STRETCH_")
		enum TimestretchMode : int32_t {
		// Need to be in sync with AUDIO_STRETCH_MODE_* constants in
		// frameworks/base/media/java/android/media/PlaybackParams.java
		DEFAULT = 0,
		/** Selects timestretch algorithm best suitable for voice (speech) content. */
		VOICE = 1,
		};

		/**
		* Behavior when the values for speed and / or pitch are out
		* of applicable range.
		*/
		@export(name="audio_timestretch_fallback_mode_t", value_prefix="AUDIO_TIMESTRETCH_FALLBACK_")
		enum TimestretchFallbackMode : int32_t {
		// Need to be in sync with AUDIO_FALLBACK_MODE_* constants in
		// frameworks/base/media/java/android/media/PlaybackParams.java
		/** Play silence for parameter values that are out of range. */
		MUTE = 1,
		/** Return an error while trying to set the parameters. */
		FAIL = 2,
		};

		/**
		* Parameters determining playback behavior. They are used to speed up or
		* slow down playback and / or change the tonal frequency of the audio content
		* (pitch).
		*/
		struct PlaybackRate {
		/**
		* Speed factor (multiplier). Normal speed has the value of 1.0f.
		* Values less than 1.0f slow down playback, value greater than 1.0f
		* speed it up.
		*/
		float speed;
		/**
		* Pitch factor (multiplier). Setting pitch value to 1.0f together
		* with changing playback speed preserves the pitch, this is often
		* called "timestretching." Setting the pitch value equal to speed produces
		* the same effect as playing audio content at different sampling rate.
		*/
		float pitch;
		/**
		* Selects the algorithm used for timestretching (preserving pitch while
		* playing audio at different speed).
		*/
		TimestretchMode timestretchMode;
		/**
		* Selects the behavior when the specified values for speed and / or pitch
		* are out of applicable range.
		*/
		TimestretchFallbackMode fallbackMode;
		};

audio/core/all-versions/default/StreamOut.cpp

+32 −0

Original line number	Diff line number	Diff line
		@@ -582,6 +582,38 @@ Return<Result> StreamOut::selectPresentation(int32_t /presentationId/, int32_t
		}
		#endif

		#if MAJOR_VERSION >= 6
		Return<void> StreamOut::getDualMonoMode(getDualMonoMode_cb _hidl_cb) {
		_hidl_cb(Result::NOT_SUPPORTED, DualMonoMode::OFF);
		return Void();
		}

		Return<Result> StreamOut::setDualMonoMode(DualMonoMode /mode/) {
		return Result::NOT_SUPPORTED;
		}

		Return<void> StreamOut::getAudioDescriptionMixLevel(getAudioDescriptionMixLevel_cb _hidl_cb) {
		_hidl_cb(Result::NOT_SUPPORTED, -std::numeric_limits<float>::infinity());
		return Void();
		}

		Return<Result> StreamOut::setAudioDescriptionMixLevel(float /leveldB/) {
		return Result::NOT_SUPPORTED;
		}

		Return<void> StreamOut::getPlaybackRateParameters(getPlaybackRateParameters_cb _hidl_cb) {
		_hidl_cb(Result::NOT_SUPPORTED,
		// Same as AUDIO_PLAYBACK_RATE_INITIALIZER
		PlaybackRate{1.0f, 1.0f, TimestretchMode::DEFAULT, TimestretchFallbackMode::FAIL});
		return Void();
		}

		Return<Result> StreamOut::setPlaybackRateParameters(const PlaybackRate& /playbackRate/) {
		return Result::NOT_SUPPORTED;
		}

		#endif

		} // namespace implementation
		} // namespace CPP_VERSION
		} // namespace audio

audio/core/all-versions/default/include/core/default/StreamOut.h

+8 −0

Original line number	Diff line number	Diff line
		@@ -121,6 +121,14 @@ struct StreamOut : public IStreamOut {
		Return<void> updateSourceMetadata(const SourceMetadata& sourceMetadata) override;
		Return<Result> selectPresentation(int32_t presentationId, int32_t programId) override;
		#endif
		#if MAJOR_VERSION >= 6
		Return<void> getDualMonoMode(getDualMonoMode_cb _hidl_cb) override;
		Return<Result> setDualMonoMode(DualMonoMode mode) override;
		Return<void> getAudioDescriptionMixLevel(getAudioDescriptionMixLevel_cb _hidl_cb) override;
		Return<Result> setAudioDescriptionMixLevel(float leveldB) override;
		Return<void> getPlaybackRateParameters(getPlaybackRateParameters_cb _hidl_cb) override;
		Return<Result> setPlaybackRateParameters(const PlaybackRate& playbackRate) override;
		#endif

		static Result getPresentationPositionImpl(audio_stream_out_t* stream, uint64_t* frames,
		TimeSpec* timeStamp);

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

+61 −0

Original line number	Diff line number	Diff line
		@@ -190,3 +190,64 @@ TEST_P(AudioPatchHidlTest, UpdatePatchInvalidHandle) {
		hidl_vec<AudioPortConfig>(), hidl_vec<AudioPortConfig>(), returnIn(res, ignored)));
		ASSERT_RESULT(Result::INVALID_ARGUMENTS, res);
		}

		using DualMonoModeAccessorHidlTest = AccessorHidlTest<DualMonoMode, OutputStreamTest>;
		TEST_P(DualMonoModeAccessorHidlTest, DualMonoModeTest) {
		doc::test("Check that dual mono mode can be set and retrieved");
		testAccessors<OPTIONAL>(&OutputStreamTest::getStream, "dual mono mode",
		Initial{DualMonoMode::OFF},
		{DualMonoMode::LR, DualMonoMode::LL, DualMonoMode::RR},
		&IStreamOut::setDualMonoMode, &IStreamOut::getDualMonoMode);
		}

		INSTANTIATE_TEST_CASE_P(DualMonoModeHidl, DualMonoModeAccessorHidlTest,
		::testing::ValuesIn(getOutputDeviceConfigParameters()),
		&DeviceConfigParameterToString);

		using AudioDescriptionMixLevelHidlTest = AccessorHidlTest<float, OutputStreamTest>;
		TEST_P(AudioDescriptionMixLevelHidlTest, AudioDescriptionMixLevelTest) {
		doc::test("Check that audio description mix level can be set and retrieved");
		testAccessors<OPTIONAL>(
		&OutputStreamTest::getStream, "audio description mix level",
		Initial{-std::numeric_limits<float>::infinity()}, {-48.0f, -1.0f, 0.0f, 1.0f, 48.0f},
		&IStreamOut::setAudioDescriptionMixLevel, &IStreamOut::getAudioDescriptionMixLevel,
		{48.5f, 1000.0f, std::numeric_limits<float>::infinity()});
		}

		INSTANTIATE_TEST_CASE_P(AudioDescriptionMixLevelHidl, AudioDescriptionMixLevelHidlTest,
		::testing::ValuesIn(getOutputDeviceConfigParameters()),
		&DeviceConfigParameterToString);

		using PlaybackRateParametersHidlTest = AccessorHidlTest<PlaybackRate, OutputStreamTest>;
		TEST_P(PlaybackRateParametersHidlTest, PlaybackRateParametersTest) {
		doc::test("Check that playback rate parameters can be set and retrieved");
		testAccessors<OPTIONAL>(
		&OutputStreamTest::getStream, "playback rate parameters",
		Initial{PlaybackRate{1.0f, 1.0f, TimestretchMode::DEFAULT,
		TimestretchFallbackMode::FAIL}},
		{// Speed and pitch values in the range from 0.5f to 2.0f must be supported
		// (see the definition of IStreamOut::setPlaybackRateParameters).
		PlaybackRate{1.0f, 1.0f, TimestretchMode::DEFAULT, TimestretchFallbackMode::MUTE},
		PlaybackRate{2.0f, 2.0f, TimestretchMode::DEFAULT, TimestretchFallbackMode::MUTE},
		PlaybackRate{0.5f, 0.5f, TimestretchMode::DEFAULT, TimestretchFallbackMode::MUTE},
		// Gross speed / pitch values must not be rejected if the fallback mode is "mute"
		PlaybackRate{1000.0f, 1000.0f, TimestretchMode::DEFAULT,
		TimestretchFallbackMode::MUTE},
		// Default speed / pitch values must not be rejected in "fail" fallback mode
		PlaybackRate{1.0f, 1.0f, TimestretchMode::DEFAULT, TimestretchFallbackMode::FAIL},
		// Same for "voice" mode
		PlaybackRate{1.0f, 1.0f, TimestretchMode::VOICE, TimestretchFallbackMode::MUTE},
		PlaybackRate{2.0f, 2.0f, TimestretchMode::VOICE, TimestretchFallbackMode::MUTE},
		PlaybackRate{0.5f, 0.5f, TimestretchMode::VOICE, TimestretchFallbackMode::MUTE},
		PlaybackRate{1000.0f, 1000.0f, TimestretchMode::VOICE, TimestretchFallbackMode::MUTE},
		PlaybackRate{1.0f, 1.0f, TimestretchMode::VOICE, TimestretchFallbackMode::FAIL}},
		&IStreamOut::setPlaybackRateParameters, &IStreamOut::getPlaybackRateParameters,
		{PlaybackRate{1000.0f, 1000.0f, TimestretchMode::DEFAULT,
		TimestretchFallbackMode::FAIL},
		PlaybackRate{1000.0f, 1000.0f, TimestretchMode::VOICE,
		TimestretchFallbackMode::FAIL}});
		}

		INSTANTIATE_TEST_CASE_P(PlaybackRateParametersHidl, PlaybackRateParametersHidlTest,
		::testing::ValuesIn(getOutputDeviceConfigParameters()),
		&DeviceConfigParameterToString);