Introduce Audio V6 (2a515e1c) · Commits · e / os / android_hardware_interfaces

audio/6.0/Android.bp

0 → 100644

+27 −0

Original line number	Diff line number	Diff line
		// This file is autogenerated by hidl-gen -Landroidbp.

		hidl_interface {
		name: "android.hardware.audio@6.0",
		root: "android.hardware",
		vndk: {
		enabled: true,
		},
		srcs: [
		"types.hal",
		"IDevice.hal",
		"IDevicesFactory.hal",
		"IPrimaryDevice.hal",
		"IStream.hal",
		"IStreamIn.hal",
		"IStreamOut.hal",
		"IStreamOutCallback.hal",
		],
		interfaces: [
		"android.hardware.audio.common@6.0",
		"android.hardware.audio.effect@6.0",
		"android.hidl.base@1.0",
		"android.hidl.safe_union@1.0",
		],
		gen_java: false,
		gen_java_constants: true,
		}

audio/6.0/IDevice.hal

0 → 100644

+282 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.
		*/

		package android.hardware.audio@6.0;

		import android.hardware.audio.common@6.0;
		import IStreamIn;
		import IStreamOut;

		interface IDevice {
		/**
		* Returns whether the audio hardware interface has been initialized.
		*
		* @return retval OK on success, NOT_INITIALIZED on failure.
		*/
		initCheck() generates (Result retval);

		/**
		* Sets the audio volume for all audio activities other than voice call. If
		* NOT_SUPPORTED is returned, the software mixer will emulate this
		* capability.
		*
		* @param volume 1.0f means unity, 0.0f is zero.
		* @return retval operation completion status.
		*/
		setMasterVolume(float volume) generates (Result retval);

		/**
		* Get the current master volume value for the HAL, if the HAL supports
		* master volume control. For example, AudioFlinger will query this value
		* from the primary audio HAL when the service starts and use the value for
		* setting the initial master volume across all HALs. HALs which do not
		* support this method must return NOT_SUPPORTED in 'retval'.
		*
		* @return retval operation completion status.
		* @return volume 1.0f means unity, 0.0f is zero.
		*/
		getMasterVolume() generates (Result retval, float volume);

		/**
		* Sets microphone muting state.
		*
		* @param mute whether microphone is muted.
		* @return retval operation completion status.
		*/
		setMicMute(bool mute) generates (Result retval);

		/**
		* Gets whether microphone is muted.
		*
		* @return retval operation completion status.
		* @return mute whether microphone is muted.
		*/
		getMicMute() generates (Result retval, bool mute);

		/**
		* Set the audio mute status for all audio activities. If the return value
		* is NOT_SUPPORTED, the software mixer will emulate this capability.
		*
		* @param mute whether audio is muted.
		* @return retval operation completion status.
		*/
		setMasterMute(bool mute) generates (Result retval);

		/**
		* Get the current master mute status for the HAL, if the HAL supports
		* master mute control. AudioFlinger will query this value from the primary
		* audio HAL when the service starts and use the value for setting the
		* initial master mute across all HALs. HAL must indicate that the feature
		* is not supported by returning NOT_SUPPORTED status.
		*
		* @return retval operation completion status.
		* @return mute whether audio is muted.
		*/
		getMasterMute() generates (Result retval, bool mute);

		/**
		* Returns audio input buffer size according to parameters passed or
		* INVALID_ARGUMENTS if one of the parameters is not supported.
		*
		* @param config audio configuration.
		* @return retval operation completion status.
		* @return bufferSize input buffer size in bytes.
		*/
		getInputBufferSize(AudioConfig config)
		generates (Result retval, uint64_t bufferSize);

		/**
		* This method creates and opens the audio hardware output stream.
		* If the stream can not be opened with the proposed audio config,
		* HAL must provide suggested values for the audio config.
		*
		* @param ioHandle handle assigned by AudioFlinger.
		* @param device device type and (if needed) address.
		* @param config stream configuration.
		* @param flags additional flags.
		* @param sourceMetadata Description of the audio that will be played.
		May be used by implementations to configure hardware effects.
		* @return retval operation completion status.
		* @return outStream created output stream.
		* @return suggestedConfig in case of invalid parameters, suggested config.
		*/
		openOutputStream(
		AudioIoHandle ioHandle,
		DeviceAddress device,
		AudioConfig config,
		bitfield<AudioOutputFlag> flags,
		SourceMetadata sourceMetadata) generates (
		Result retval,
		IStreamOut outStream,
		AudioConfig suggestedConfig);

		/**
		* This method creates and opens the audio hardware input stream.
		* If the stream can not be opened with the proposed audio config,
		* HAL must provide suggested values for the audio config.
		*
		* @param ioHandle handle assigned by AudioFlinger.
		* @param device device type and (if needed) address.
		* @param config stream configuration.
		* @param flags additional flags.
		* @param sinkMetadata Description of the audio that is suggested by the client.
		* May be used by implementations to configure processing effects.
		* @return retval operation completion status.
		* @return inStream in case of success, created input stream.
		* @return suggestedConfig in case of invalid parameters, suggested config.
		*/
		openInputStream(
		AudioIoHandle ioHandle,
		DeviceAddress device,
		AudioConfig config,
		bitfield<AudioInputFlag> flags,
		SinkMetadata sinkMetadata) generates (
		Result retval,
		IStreamIn inStream,
		AudioConfig suggestedConfig);

		/**
		* Returns whether HAL supports audio patches.
		*
		* @return supports true if audio patches are supported.
		*/
		supportsAudioPatches() generates (bool supports);

		/**
		* Creates an audio patch between several source and sink ports. The handle
		* is allocated by the HAL and must be unique for this audio HAL module.
		*
		* @param sources patch sources.
		* @param sinks patch sinks.
		* @return retval operation completion status.
		* @return patch created patch handle.
		*/
		createAudioPatch(vec<AudioPortConfig> sources, vec<AudioPortConfig> sinks)
		generates (Result retval, AudioPatchHandle patch);

		/**
		* Release an audio patch.
		*
		* @param patch patch handle.
		* @return retval operation completion status.
		*/
		releaseAudioPatch(AudioPatchHandle patch) generates (Result retval);

		/**
		* Returns the list of supported attributes for a given audio port.
		*
		* As input, 'port' contains the information (type, role, address etc...)
		* needed by the HAL to identify the port.
		*
		* As output, 'resultPort' contains possible attributes (sampling rates,
		* formats, channel masks, gain controllers...) for this port.
		*
		* @param port port identifier.
		* @return retval operation completion status.
		* @return resultPort port descriptor with all parameters filled up.
		*/
		getAudioPort(AudioPort port)
		generates (Result retval, AudioPort resultPort);

		/**
		* Set audio port configuration.
		*
		* @param config audio port configuration.
		* @return retval operation completion status.
		*/
		setAudioPortConfig(AudioPortConfig config) generates (Result retval);

		/**
		* Gets the HW synchronization source of the device. Calling this method is
		* equivalent to getting AUDIO_PARAMETER_HW_AV_SYNC on the legacy HAL.
		* Optional method
		*
		* @return retval operation completion status: OK or NOT_SUPPORTED.
		* @return hwAvSync HW synchronization source
		*/
		getHwAvSync() generates (Result retval, AudioHwSync hwAvSync);

		/**
		* Sets whether the screen is on. Calling this method is equivalent to
		* setting AUDIO_PARAMETER_KEY_SCREEN_STATE on the legacy HAL.
		* Optional method
		*
		* @param turnedOn whether the screen is turned on.
		* @return retval operation completion status.
		*/
		setScreenState(bool turnedOn) generates (Result retval);

		/**
		* Generic method for retrieving vendor-specific parameter values.
		* The framework does not interpret the parameters, they are passed
		* in an opaque manner between a vendor application and HAL.
		*
		* Multiple parameters can be retrieved at the same time.
		* The implementation should return as many requested parameters
		* as possible, even if one or more is not supported
		*
		* @param context provides more information about the request
		* @param keys keys of the requested parameters
		* @return retval operation completion status.
		* OK must be returned if keys is empty.
		* NOT_SUPPORTED must be returned if at least one key is unknown.
		* @return parameters parameter key value pairs.
		* Must contain the value of all requested keys if retval == OK
		*/
		getParameters(vec<ParameterValue> context, vec<string> keys)
		generates (Result retval, vec<ParameterValue> parameters);

		/**
		* Generic method for setting vendor-specific parameter values.
		* The framework does not interpret the parameters, they are passed
		* in an opaque manner between a vendor application and HAL.
		*
		* Multiple parameters can be set at the same time though this is
		* discouraged as it make failure analysis harder.
		*
		* If possible, a failed setParameters should not impact the platform state.
		*
		* @param context provides more information about the request
		* @param parameters parameter key value pairs.
		* @return retval operation completion status.
		* All parameters must be successfully set for OK to be returned
		*/
		setParameters(vec<ParameterValue> context, vec<ParameterValue> parameters)
		generates (Result retval);

		/**
		* Returns an array with available microphones in device.
		*
		* @return retval INVALID_STATE if the call is not successful,
		* OK otherwise.
		*
		* @return microphones array with microphones info
		*/
		getMicrophones()
		generates(Result retval, vec<MicrophoneInfo> microphones);

		/**
		* Notifies the device module about the connection state of an input/output
		* device attached to it. Calling this method is equivalent to setting
		* AUDIO_PARAMETER_DEVICE_[DIS]CONNECT on the legacy HAL.
		*
		* @param address audio device specification.
		* @param connected whether the device is connected.
		* @return retval operation completion status.
		*/
		setConnectedState(DeviceAddress address, bool connected)
		generates (Result retval);
		};

audio/6.0/IDevicesFactory.hal

0 → 100644

+70 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.
		*/

		package android.hardware.audio@6.0;

		import android.hardware.audio.common@6.0;
		import IDevice;
		import IPrimaryDevice;

		/** This factory allows a HAL implementation to be split in multiple independent
		* devices (called module in the pre-treble API).
		* Note that this division is arbitrary and implementation are free
		* to only have a Primary.
		* The framework will query the devices according to audio_policy_configuration.xml
		*
		* Each device name is arbitrary, provided by the vendor's audio_policy_configuration.xml
		* and only used to identify a device in this factory.
		* The framework must not interpret the name, treating it as a vendor opaque data
		* with the following exception:
		* - the "r_submix" device that must be present to support policyMixes (Eg: Android projected).
		* Note that this Device is included by default in a build derived from AOSP.
		*
		* Note that on AOSP Oreo (including MR1) the "a2dp" module is not using this API
		* but is loaded directly from the system partition using the legacy API
		* due to limitations with the Bluetooth framework.
		*/
		interface IDevicesFactory {

		/**
		* Opens an audio device. To close the device, it is necessary to release
		* references to the returned device object.
		*
		* @param device device name.
		* @return retval operation completion status. Returns INVALID_ARGUMENTS
		* if there is no corresponding hardware module found,
		* NOT_INITIALIZED if an error occurred while opening the hardware
		* module.
		* @return result the interface for the created device.
		*/
		openDevice(string device) generates (Result retval, IDevice result);

		/**
		* Opens the Primary audio device that must be present.
		* This function is not optional and must return successfully the primary device.
		*
		* This device must have the name "primary".
		*
		* The telephony stack uses this device to control the audio during a voice call.
		*
		* @return retval operation completion status. Must be SUCCESS.
		* For debugging, return INVALID_ARGUMENTS if there is no corresponding
		* hardware module found, NOT_INITIALIZED if an error occurred
		* while opening the hardware module.
		* @return result the interface for the created device.
		*/
		openPrimaryDevice() generates (Result retval, IPrimaryDevice result);
		};

audio/6.0/IPrimaryDevice.hal

0 → 100644

+195 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.
		*/

		package android.hardware.audio@6.0;

		import android.hardware.audio.common@6.0;
		import IDevice;

		interface IPrimaryDevice extends IDevice {
		/**
		* Sets the audio volume of a voice call.
		*
		* @param volume 1.0f means unity, 0.0f is zero.
		* @return retval operation completion status.
		*/
		setVoiceVolume(float volume) generates (Result retval);

		/**
		* This method is used to notify the HAL about audio mode changes.
		*
		* @param mode new mode.
		* @return retval operation completion status.
		*/
		setMode(AudioMode mode) generates (Result retval);

		/**
		* Sets the name of the current BT SCO headset. Calling this method
		* is equivalent to setting legacy "bt_headset_name" parameter.
		* The BT SCO headset name must only be used for debugging purposes.
		* Optional method
		*
		* @param name the name of the current BT SCO headset (can be empty).
		* @return retval operation completion status.
		*/
		setBtScoHeadsetDebugName(string name) generates (Result retval);

		/**
		* Gets whether BT SCO Noise Reduction and Echo Cancellation are enabled.
		* Calling this method is equivalent to getting AUDIO_PARAMETER_KEY_BT_NREC
		* on the legacy HAL.
		*
		* @return retval operation completion status.
		* @return enabled whether BT SCO NR + EC are enabled.
		*/
		getBtScoNrecEnabled() generates (Result retval, bool enabled);

		/**
		* Sets whether BT SCO Noise Reduction and Echo Cancellation are enabled.
		* Calling this method is equivalent to setting AUDIO_PARAMETER_KEY_BT_NREC
		* on the legacy HAL.
		* Optional method
		*
		* @param enabled whether BT SCO NR + EC are enabled.
		* @return retval operation completion status.
		*/
		setBtScoNrecEnabled(bool enabled) generates (Result retval);

		/**
		* Gets whether BT SCO Wideband mode is enabled. Calling this method is
		* equivalent to getting AUDIO_PARAMETER_KEY_BT_SCO_WB on the legacy HAL.
		*
		* @return retval operation completion status.
		* @return enabled whether BT Wideband is enabled.
		*/
		getBtScoWidebandEnabled() generates (Result retval, bool enabled);

		/**
		* Sets whether BT SCO Wideband mode is enabled. Calling this method is
		* equivalent to setting AUDIO_PARAMETER_KEY_BT_SCO_WB on the legacy HAL.
		* Optional method
		*
		* @param enabled whether BT Wideband is enabled.
		* @return retval operation completion status.
		*/
		setBtScoWidebandEnabled(bool enabled) generates (Result retval);

		/**
		* Gets whether BT HFP (Hands-Free Profile) is enabled. Calling this method
		* is equivalent to getting "hfp_enable" parameter value on the legacy HAL.
		*
		* @return retval operation completion status.
		* @return enabled whether BT HFP is enabled.
		*/
		getBtHfpEnabled() generates (Result retval, bool enabled);

		/**
		* Sets whether BT HFP (Hands-Free Profile) is enabled. Calling this method
		* is equivalent to setting "hfp_enable" parameter on the legacy HAL.
		* Optional method
		*
		* @param enabled whether BT HFP is enabled.
		* @return retval operation completion status.
		*/
		setBtHfpEnabled(bool enabled) generates (Result retval);

		/**
		* Sets the sampling rate of BT HFP (Hands-Free Profile). Calling this
		* method is equivalent to setting "hfp_set_sampling_rate" parameter
		* on the legacy HAL.
		* Optional method
		*
		* @param sampleRateHz sample rate in Hz.
		* @return retval operation completion status.
		*/
		setBtHfpSampleRate(uint32_t sampleRateHz) generates (Result retval);

		/**
		* Sets the current output volume Hz for BT HFP (Hands-Free Profile).
		* Calling this method is equivalent to setting "hfp_volume" parameter value
		* on the legacy HAL (except that legacy HAL implementations expect
		* an integer value in the range from 0 to 15.)
		* Optional method
		*
		* @param volume 1.0f means unity, 0.0f is zero.
		* @return retval operation completion status.
		*/
		setBtHfpVolume(float volume) generates (Result retval);

		enum TtyMode : int32_t {
		OFF,
		VCO,
		HCO,
		FULL
		};

		/**
		* Gets current TTY mode selection. Calling this method is equivalent to
		* getting AUDIO_PARAMETER_KEY_TTY_MODE on the legacy HAL.
		*
		* @return retval operation completion status.
		* @return mode TTY mode.
		*/
		getTtyMode() generates (Result retval, TtyMode mode);

		/**
		* Sets current TTY mode. Calling this method is equivalent to setting
		* AUDIO_PARAMETER_KEY_TTY_MODE on the legacy HAL.
		*
		* @param mode TTY mode.
		* @return retval operation completion status.
		*/
		setTtyMode(TtyMode mode) generates (Result retval);

		/**
		* Gets whether Hearing Aid Compatibility - Telecoil (HAC-T) mode is
		* enabled. Calling this method is equivalent to getting
		* AUDIO_PARAMETER_KEY_HAC on the legacy HAL.
		*
		* @return retval operation completion status.
		* @return enabled whether HAC mode is enabled.
		*/
		getHacEnabled() generates (Result retval, bool enabled);

		/**
		* Sets whether Hearing Aid Compatibility - Telecoil (HAC-T) mode is
		* enabled. Calling this method is equivalent to setting
		* AUDIO_PARAMETER_KEY_HAC on the legacy HAL.
		* Optional method
		*
		* @param enabled whether HAC mode is enabled.
		* @return retval operation completion status.
		*/
		setHacEnabled(bool enabled) generates (Result retval);

		enum Rotation : int32_t {
		DEG_0,
		DEG_90,
		DEG_180,
		DEG_270
		};

		/**
		* Updates HAL on the current rotation of the device relative to natural
		* orientation. Calling this method is equivalent to setting legacy
		* parameter "rotation".
		*
		* @param rotation rotation in degrees relative to natural device
		* orientation.
		* @return retval operation completion status.
		*/
		updateRotation(Rotation rotation) generates (Result retval);
		};

audio/6.0/IStream.hal

0 → 100644

+310 −0

File added.

Preview size limit exceeded, changes collapsed.