Evolution-x/hardware_interfaces
1
0
Fork 0
mirror of https://github.com/Evolution-X/hardware_interfaces synced 2026-02-01 16:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

audio: Provide documentation for enums in 'common' package

Browse Source 
Bug: 148617378
Test: N/A
Change-Id: Ia28c9217527509430f2daf274e14380bfe79f145
This commit is contained in:
Mikhail Naganov
2020-02-04 18:42:09 -08:00
parent f20dd169e2
commit 40549fae50
2 changed files with 132 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
audio/common/6.0/types.hal
View File

@@ -91,37 +91,76 @@ struct Uuid {
enum AudioStreamType : int32_t {
// These values must kept in sync with
// frameworks/base/media/java/android/media/AudioSystem.java
/** Used to identify the default audio stream volume. */
DEFAULT = -1,
/** Specifies the minimum value for use in checks and loops. */
MIN = 0,
/** Used to identify the volume of audio streams for phone calls. */
VOICE_CALL = 0,
/** Used to identify the volume of audio streams for system sounds. */
SYSTEM = 1,
/**
* Used to identify the volume of audio streams for the phone ring
* and message alerts.
*/
RING = 2,
/** Used to identify the volume of audio streams for music playback. */
MUSIC = 3,
/** Used to identify the volume of audio streams for alarms. */
ALARM = 4,
/** Used to identify the volume of audio streams for notifications. */
NOTIFICATION = 5,
/**
* Used to identify the volume of audio streams for phone calls
* when connected on bluetooth.
*/
BLUETOOTH_SCO = 6,
ENFORCED_AUDIBLE = 7, // Sounds that cannot be muted by user and must be
// routed to speaker
/**
* Used to identify the volume of audio streams for enforced system
* sounds in certain countries (e.g camera in Japan). */
ENFORCED_AUDIBLE = 7,
/** Used to identify the volume of audio streams for DTMF tones. */
DTMF = 8,
TTS = 9, // Transmitted Through Speaker. Plays over speaker
// only, silent on other devices
ACCESSIBILITY = 10, // For accessibility talk back prompts
ASSISTANT = 11, // For virtual assistant service
/**
* Used to identify the volume of audio streams exclusively transmitted
* through the speaker (TTS) of the device.
*/
TTS = 9,
/**
* Used to identify the volume of audio streams for accessibility prompts.
*/
ACCESSIBILITY = 10,
/** Used to identify the volume of audio streams for virtual assistant. */
ASSISTANT = 11,
};
@export(name="audio_source_t", value_prefix="AUDIO_SOURCE_")
enum AudioSource : int32_t {
// These values must kept in sync with
// frameworks/base/media/java/android/media/MediaRecorder.java,
// frameworks/av/services/audiopolicy/AudioPolicyService.cpp,
// system/media/audio_effects/include/audio_effects/audio_effects_conf.h
/** Default audio source. */
DEFAULT = 0,
/** Microphone audio source. */
MIC = 1,
/** Voice call uplink (Tx) audio source. */
VOICE_UPLINK = 2,
/** Voice call downlink (Rx) audio source. */
VOICE_DOWNLINK = 3,
/** Voice call uplink + downlink audio source. */
VOICE_CALL = 4,
/**
* Microphone audio source tuned for video recording, with the same
* orientation as the camera if available.
*/
CAMCORDER = 5,
/** Microphone audio source tuned for voice recognition. */
VOICE_RECOGNITION = 6,
/**
* Microphone audio source tuned for voice communications such as VoIP. It
* will for instance take advantage of echo cancellation or automatic gain
* control if available.
*/
VOICE_COMMUNICATION = 7,
/**
* Source for the mix to be presented remotely. An example of remote
@@ -146,7 +185,9 @@ enum AudioSource : int32_t {
* to include all post processing applied to the playback path.
*/
ECHO_REFERENCE = 1997,
/** Virtual source for the built-in FM tuner. */
FM_TUNER = 1998,
/** Virtual source for the last captured hotword. */
HOTWORD = 1999,
};
@@ -562,7 +603,7 @@ enum AudioMode : int32_t {
IN_CALL = 2,
/** Calls handled by apps (Eg: Hangout). */
IN_COMMUNICATION = 3,
/** Call screening in progress */
/** Call screening in progress. */
CALL_SCREEN = 4,
};
@@ -748,23 +789,85 @@ enum AudioUsage : int32_t {
// These values must kept in sync with
// frameworks/base/media/java/android/media/AudioAttributes.java
// Note that not all framework values are exposed
/**
* Usage value to use when the usage is unknown.
*/
UNKNOWN = 0,
/**
* Usage value to use when the usage is media, such as music, or movie
* soundtracks.
*/
MEDIA = 1,
/**
* Usage value to use when the usage is voice communications, such as
* telephony or VoIP.
*/
VOICE_COMMUNICATION = 2,
/**
* Usage value to use when the usage is in-call signalling, such as with
* a "busy" beep, or DTMF tones.
*/
VOICE_COMMUNICATION_SIGNALLING = 3,
/**
* Usage value to use when the usage is an alarm (e.g. wake-up alarm).
*/
ALARM = 4,
/**
* Usage value to use when the usage is a generic notification.
*/
NOTIFICATION = 5,
/**
* Usage value to use when the usage is telephony ringtone.
*/
NOTIFICATION_TELEPHONY_RINGTONE = 6,
/**
* Usage value to use when the usage is for accessibility, such as with
* a screen reader.
*/
ASSISTANCE_ACCESSIBILITY = 11,
/**
* Usage value to use when the usage is driving or navigation directions.
*/
ASSISTANCE_NAVIGATION_GUIDANCE = 12,
/**
* Usage value to use when the usage is sonification, such as with user
* interface sounds.
*/
ASSISTANCE_SONIFICATION = 13,
/**
* Usage value to use when the usage is for game audio.
*/
GAME = 14,
/**
* Usage value to use when feeding audio to the platform and replacing
* "traditional" audio source, such as audio capture devices.
*/
VIRTUAL_SOURCE = 15,
/**
* Usage value to use for audio responses to user queries, audio
* instructions or help utterances.
*/
ASSISTANT = 16,
/**
* Usage value to use for assistant voice interaction with remote caller
* on Cell and VoIP calls.
*/
CALL_ASSISTANT = 17,
/**
* Usage value to use when the usage is an emergency.
*/
EMERGENCY = 1000,
/**
* Usage value to use when the usage is a safety sound.
*/
SAFETY = 1001,
/**
* Usage value to use when the usage is a vehicle status.
*/
VEHICLE_STATUS = 1002,
/**
* Usage value to use when the usage is an announcement.
*/
ANNOUNCEMENT = 1003,
};
@@ -773,10 +876,30 @@ enum AudioUsage : int32_t {
enum AudioContentType : uint32_t {
// Do not change these values without updating their counterparts
// in frameworks/base/media/java/android/media/AudioAttributes.java
/**
* Content type value to use when the content type is unknown, or other than
* the ones defined.
*/
UNKNOWN = 0,
/**
* Content type value to use when the content type is speech.
*/
SPEECH = 1,
/**
* Content type value to use when the content type is music.
*/
MUSIC = 2,
/**
* Content type value to use when the content type is a soundtrack,
* typically accompanying a movie or TV program.
*/
MOVIE = 3,
/**
* Content type value to use when the content type is a sound used to
* accompany a user action, such as a beep or sound effect expressing a key
* click, or event, such as the type of a sound for a bonus being received
* in a game. These sounds are mostly synthesized or short Foley sounds.
*/
SONIFICATION = 4,
};

2
current.txt
View File

@@ -612,7 +612,7 @@ fd1f1b29f26b42e886220f04a08086c00e5ade9d7b53f095438e578ab9d42a93 android.hardwar
2df5d5866b37776f25079c0e54b54350a2abe4e025a59c9e02a7d3abe8ca00e8 android.hardware.audio@6.0::IStreamIn
78e4138cc8307c11fc777c3bd376e581ba4ba48196b05ca1d7cdfa515c87b48a android.hardware.audio@6.0::IStreamOut
997fdaad7a9d17ee7e01feb7031a753e2365e72ad30b11d950e9183fabdf3844 android.hardware.audio@6.0::IStreamOutCallback
43a3303378f5b9852c2da9ac2c1d440965aab7ba02a800229e7b3c84e2167e06 android.hardware.audio.common@6.0::types
167ed5cfb7d91db2e2bf20f1320c1a9004eeb768e26f535e0f7db94a21867d21 android.hardware.audio.common@6.0::types
817930d58412d662cb45e641c50cb62c727e4a3e3ffe7029a53cad9677b97d58 android.hardware.audio.effect@6.0::types
525bec6b44f1103869c269a128d51b8dccd73af5340ba863c8886c68357c7faf android.hardware.audio.effect@6.0::IAcousticEchoCancelerEffect
8d76bbe3719d051a8e9a1dcf9244f37f5b0a491feb249fa48391edf7cb4f3131 android.hardware.audio.effect@6.0::IAutomaticGainControlEffect