AAudio: Add comments about channel masks (1f0ee04d) · Commits · e / os / android_frameworks_av

media/libaaudio/include/aaudio/AAudio.h

+80 −6

Original line number	Diff line number	Diff line
		@@ -623,6 +623,11 @@ typedef int32_t aaudio_session_id_t;
		* (e.g. a USB audio interface, a DAC connected to headphones) to
		* specify allowable configurations of a particular device.
		*
		* Channel masks are for input only, output only, or both input and output.
		* These channel masks are different than those defined in AudioFormat.java.
		* If an app gets a channel mask from Java API and wants to use it in AAudio,
		* conversion should be done by the app.
		*
		* Added in API level 32.
		*/
		enum {
		@@ -630,10 +635,6 @@ enum {
		* Invalid channel mask
		*/
		AAUDIO_CHANNEL_INVALID = -1,

		/**
		* Output audio channel mask
		*/
		AAUDIO_CHANNEL_FRONT_LEFT = 1 << 0,
		AAUDIO_CHANNEL_FRONT_RIGHT = 1 << 1,
		AAUDIO_CHANNEL_FRONT_CENTER = 1 << 2,
		@@ -661,62 +662,112 @@ enum {
		AAUDIO_CHANNEL_FRONT_WIDE_LEFT = 1 << 24,
		AAUDIO_CHANNEL_FRONT_WIDE_RIGHT = 1 << 25,

		/**
		* Supported for Input and Output
		*/
		AAUDIO_CHANNEL_MONO = AAUDIO_CHANNEL_FRONT_LEFT,
		/**
		* Supported for Input and Output
		*/
		AAUDIO_CHANNEL_STEREO = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_2POINT1 = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_LOW_FREQUENCY,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_TRI = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_FRONT_CENTER,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_TRI_BACK = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_BACK_CENTER,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_3POINT1 = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_FRONT_CENTER \|
		AAUDIO_CHANNEL_LOW_FREQUENCY,
		/**
		* Supported for Input and Output
		*/
		AAUDIO_CHANNEL_2POINT0POINT2 = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_TOP_SIDE_LEFT \|
		AAUDIO_CHANNEL_TOP_SIDE_RIGHT,
		/**
		* Supported for Input and Output
		*/
		AAUDIO_CHANNEL_2POINT1POINT2 = AAUDIO_CHANNEL_2POINT0POINT2 \|
		AAUDIO_CHANNEL_LOW_FREQUENCY,
		/**
		* Supported for Input and Output
		*/
		AAUDIO_CHANNEL_3POINT0POINT2 = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_FRONT_CENTER \|
		AAUDIO_CHANNEL_TOP_SIDE_LEFT \|
		AAUDIO_CHANNEL_TOP_SIDE_RIGHT,
		/**
		* Supported for Input and Output
		*/
		AAUDIO_CHANNEL_3POINT1POINT2 = AAUDIO_CHANNEL_3POINT0POINT2 \|
		AAUDIO_CHANNEL_LOW_FREQUENCY,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_QUAD = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_BACK_LEFT \|
		AAUDIO_CHANNEL_BACK_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_QUAD_SIDE = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_SIDE_LEFT \|
		AAUDIO_CHANNEL_SIDE_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_SURROUND = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_FRONT_CENTER \|
		AAUDIO_CHANNEL_BACK_CENTER,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_PENTA = AAUDIO_CHANNEL_QUAD \|
		AAUDIO_CHANNEL_FRONT_CENTER,
		// aka 5POINT1_BACK
		/**
		* Supported for Input and Output. aka 5POINT1_BACK
		*/
		AAUDIO_CHANNEL_5POINT1 = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_FRONT_CENTER \|
		AAUDIO_CHANNEL_LOW_FREQUENCY \|
		AAUDIO_CHANNEL_BACK_LEFT \|
		AAUDIO_CHANNEL_BACK_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_5POINT1_SIDE = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_FRONT_CENTER \|
		AAUDIO_CHANNEL_LOW_FREQUENCY \|
		AAUDIO_CHANNEL_SIDE_LEFT \|
		AAUDIO_CHANNEL_SIDE_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_6POINT1 = AAUDIO_CHANNEL_FRONT_LEFT \|
		AAUDIO_CHANNEL_FRONT_RIGHT \|
		AAUDIO_CHANNEL_FRONT_CENTER \|
		@@ -724,32 +775,55 @@ enum {
		AAUDIO_CHANNEL_BACK_LEFT \|
		AAUDIO_CHANNEL_BACK_RIGHT \|
		AAUDIO_CHANNEL_BACK_CENTER,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_7POINT1 = AAUDIO_CHANNEL_5POINT1 \|
		AAUDIO_CHANNEL_SIDE_LEFT \|
		AAUDIO_CHANNEL_SIDE_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_5POINT1POINT2 = AAUDIO_CHANNEL_5POINT1 \|
		AAUDIO_CHANNEL_TOP_SIDE_LEFT \|
		AAUDIO_CHANNEL_TOP_SIDE_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_5POINT1POINT4 = AAUDIO_CHANNEL_5POINT1 \|
		AAUDIO_CHANNEL_TOP_FRONT_LEFT \|
		AAUDIO_CHANNEL_TOP_FRONT_RIGHT \|
		AAUDIO_CHANNEL_TOP_BACK_LEFT \|
		AAUDIO_CHANNEL_TOP_BACK_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_7POINT1POINT2 = AAUDIO_CHANNEL_7POINT1 \|
		AAUDIO_CHANNEL_TOP_SIDE_LEFT \|
		AAUDIO_CHANNEL_TOP_SIDE_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_7POINT1POINT4 = AAUDIO_CHANNEL_7POINT1 \|
		AAUDIO_CHANNEL_TOP_FRONT_LEFT \|
		AAUDIO_CHANNEL_TOP_FRONT_RIGHT \|
		AAUDIO_CHANNEL_TOP_BACK_LEFT \|
		AAUDIO_CHANNEL_TOP_BACK_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_9POINT1POINT4 = AAUDIO_CHANNEL_7POINT1POINT4 \|
		AAUDIO_CHANNEL_FRONT_WIDE_LEFT \|
		AAUDIO_CHANNEL_FRONT_WIDE_RIGHT,
		/**
		* Supported for only Output
		*/
		AAUDIO_CHANNEL_9POINT1POINT6 = AAUDIO_CHANNEL_9POINT1POINT4 \|
		AAUDIO_CHANNEL_TOP_SIDE_LEFT \|
		AAUDIO_CHANNEL_TOP_SIDE_RIGHT,

		/**
		* Supported for only Input
		*/
		AAUDIO_CHANNEL_FRONT_BACK = AAUDIO_CHANNEL_FRONT_CENTER \|
		AAUDIO_CHANNEL_BACK_CENTER,
		};