audio/aidl/default/audio_effects_config.xml - platform/hardware/interfaces - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <audio_effects_conf version="2.0" xmlns="http://schemas.android.com/audio/audio_effects_conf/v2_0">
     <!-- Overview.
          This example config file was copy from existing one: frameworks/av/media/libeffects/data/
          audio_effects.xml, with effect library names updated to AIDL libraries we currently have.

          All "library" attributes in "effect" element must must match a "library" element with the
          same value of the "name" attribute.
          All "effect" attributes in "preprocess" and "postprocess" element must match an "effect"
          element with the same value of the "name" attribute.

          AIDL EffectFactory are relying on the "name" attribute in "effect" element to identify the
          effect type, so it's necessary to have the mapping from name to effect type UUID. Make
          sure to either use existing effect name as key of
          ::android::hardware::audio::effect::kUuidNameTypeMap, or add a new {name, typeUUID} map
          item to the kUuidNameTypeMap.

          Existing audio_effects.xml should working without any change as long as:
          1. "path" attribute of "library" element matches with the actual effect library name.
          2. "name" attribute of "effect" and "effectProxy" element correctly added as key of
             kUuidNameTypeMap, with value matches Identity.type in Descriptor.aidl.
          3. "uuid" attribute of "effect" element matches Identity.uuid in Descriptor.aidl.
          4. "uuid" attribute of "effectProxy" element matches Identity.proxy in Descriptor.aidl.
     -->

     <!-- List of effect libraries to load.
          Each library element must contain a "name" attribute and a "path" attribute giving the
          name of a library .so file on the target device.
     -->
     <libraries>
         <library name="aecsw" path="libaecsw.so"/>
         <library name="agcsw" path="libagcsw.so"/>
         <library name="bassboostsw" path="libbassboostsw.so"/>
         <library name="bundle" path="libbundleaidl.so"/>
         <library name="downmix" path="libdownmixaidl.so"/>
         <library name="dynamics_processing" path="libdynamicsprocessingaidl.so"/>
         <library name="equalizersw" path="libequalizersw.so"/>
         <library name="haptic_generator" path="libhapticgeneratoraidl.so"/>
         <library name="loudness_enhancer" path="libloudnessenhanceraidl.so"/>
         <library name="nssw" path="libnssw.so"/>
         <library name="env_reverbsw" path="libenvreverbsw.so"/>
         <library name="preset_reverbsw" path="libpresetreverbsw.so"/>
         <library name="reverb" path="libreverbaidl.so"/>
         <library name="virtualizersw" path="libvirtualizersw.so"/>
         <library name="visualizer" path="libvisualizeraidl.so"/>
         <library name="volumesw" path="libvolumesw.so"/>
     </libraries>

     <!-- list of effects to load.
          Each "effect" element must contain a "name", "library" and a "uuid" attribute.
          The value of the "library" attribute must correspond to the name of one library element in
          the "libraries" element.
          The "name" attribute used to specific effect type, and should be mapping to a key of
          aidl::android::hardware::audio::effect::kUuidNameTypeMap.
          The "uuid" attribute is the implementation specific UUID as specified by the effect vendor.

          Effect proxy can be supported with "effectProxy" element, each sub-element should contain
          "library" and "uuid" attribute, all other attributes were ignored. Framework side use
          result of IFactory.queryEffects() to decide which effect implementation should be part of
          proxy and which not.

          Only "name", "library", and "uuid" attributes in "effects" element are meaningful and
          parsed out by EffectConfig class, all other attributes are ignored.
          Only "name" and "uuid" attributes in "effectProxy" element are meaningful and parsed out
          by EffectConfig class, all other attributes are ignored.
     -->

     <effects>
         <effect name="acoustic_echo_canceler" library="aecsw" uuid="bb392ec0-8d4d-11e0-a896-0002a5d5c51b"/>
         <effect name="automatic_gain_control" library="agcsw" uuid="89f38e65-d4d2-4d64-ad0e-2b3e799ea886"/>
         <effectProxy name="bassboost" uuid="14804144-a5ee-4d24-aa88-0002a5d5c51b">
             <libsw library="bassboostsw" uuid="fa8181f2-588b-11ed-9b6a-0242ac120002"/>
             <libsw library="bundle" uuid="8631f300-72e2-11df-b57e-0002a5d5c51b"/>
         </effectProxy>
         <effect name="downmix" library="downmix" uuid="93f04452-e4fe-41cc-91f9-e475b6d1d69f"/>
         <effect name="dynamics_processing" library="dynamics_processing" uuid="e0e6539b-1781-7261-676f-6d7573696340"/>
         <effect name="haptic_generator" library="haptic_generator" uuid="97c4acd1-8b82-4f2f-832e-c2fe5d7a9931"/>
         <effect name="loudness_enhancer" library="loudness_enhancer" uuid="fa415329-2034-4bea-b5dc-5b381c8d1e2c"/>
         <effect name="env_reverb" library="env_reverbsw" uuid="fa819886-588b-11ed-9b6a-0242ac120002"/>
         <effect name="noise_suppression" library="nssw" uuid="c06c8400-8e06-11e0-9cb6-0002a5d5c51b"/>
         <effect name="preset_reverb" library="preset_reverbsw" uuid="fa8199c6-588b-11ed-9b6a-0242ac120002"/>
         <effect name="reverb_env_aux" library="reverb" uuid="4a387fc0-8ab3-11df-8bad-0002a5d5c51b"/>
         <effect name="reverb_env_ins" library="reverb" uuid="c7a511a0-a3bb-11df-860e-0002a5d5c51b"/>
         <effect name="reverb_pre_aux" library="reverb" uuid="f29a1400-a3bb-11df-8ddc-0002a5d5c51b"/>
         <effect name="reverb_pre_ins" library="reverb" uuid="172cdf00-a3bc-11df-a72f-0002a5d5c51b"/>
         <effectProxy name="virtualizer" uuid="d3467faa-acc7-4d34-acaf-0002a5d5c51b">
             <libsw library="virtualizersw" uuid="fa819d86-588b-11ed-9b6a-0242ac120002"/>
             <libsw library="bundle" uuid="1d4033c0-8557-11df-9f2d-0002a5d5c51b"/>
         </effectProxy>
         <effect name="visualizer" library="visualizer" uuid="d069d9e0-8329-11df-9168-0002a5d5c51b"/>
         <effect name="volume" library="bundle" uuid="119341a0-8469-11df-81f9-0002a5d5c51b"/>
         <effectProxy name="equalizer" uuid="c8e70ecd-48ca-456e-8a4f-0002a5d5c51b">
             <libsw library="equalizersw" uuid="0bed4300-847d-11df-bb17-0002a5d5c51b"/>
             <libsw library="bundle" uuid="ce772f20-847d-11df-bb17-0002a5d5c51b"/>
         </effectProxy>
     </effects>

     <!-- Audio pre processor configurations.
          The pre processor configuration is described in a "preprocess" element and consists in a
          list of elements each describing pre processor settings for a given use case or "stream".
          Each stream element has a "type" attribute corresponding to the input source used.
          Valid types are these defined in system/hardware/interfaces/media/aidl/android/media/audio/
          common/AudioSource.aidl.
          Each "stream" element contains a list of "apply" elements indicating one effect to apply.
          The effect to apply is designated by its name in the "effects" elements.
          If there are more than one effect apply to one stream, the audio framework will apply them
          in the same equence as they listed in "stream" element.

         <preprocess>
             <stream type="voice_communication">
                 <apply effect="aec"/>
                 <apply effect="ns"/>
             </stream>
         </preprocess>
     -->

     <!-- Audio post processor configurations.
          The post processor configuration is described in a "postprocess" element and consists in a
          list of elements each describing post processor settings for a given use case or "stream".
          Each stream element has a "type" attribute corresponding to the stream type used.
          Valid types are these defined in system/hardware/interfaces/media/aidl/android/media/audio/
          common/AudioStreamType.aidl.
          Each "stream" element contains a list of "apply" elements indicating one effect to apply.
          The effect to apply is designated by its name in the "effects" elements.
          If there are more than one effect apply to one stream, the audio framework will apply them
          in the same equence as they listed in "stream" element.

         <postprocess>
             <stream type="music">
                 <apply effect="music_post_proc"/>
             </stream>
             <stream type="voice_call">
                 <apply effect="voice_post_proc"/>
             </stream>
             <stream type="notification">
                 <apply effect="notification_post_proc"/>
             </stream>
         </postprocess>
     -->

 </audio_effects_conf>
	<?xml version="1.0" encoding="UTF-8"?>
	<audio_effects_conf version="2.0" xmlns="http://schemas.android.com/audio/audio_effects_conf/v2_0">
	<!-- Overview.
	This example config file was copy from existing one: frameworks/av/media/libeffects/data/
	audio_effects.xml, with effect library names updated to AIDL libraries we currently have.

	All "library" attributes in "effect" element must must match a "library" element with the
	same value of the "name" attribute.
	All "effect" attributes in "preprocess" and "postprocess" element must match an "effect"
	element with the same value of the "name" attribute.

	AIDL EffectFactory are relying on the "name" attribute in "effect" element to identify the
	effect type, so it's necessary to have the mapping from name to effect type UUID. Make
	sure to either use existing effect name as key of
	::android::hardware::audio::effect::kUuidNameTypeMap, or add a new {name, typeUUID} map
	item to the kUuidNameTypeMap.

	Existing audio_effects.xml should working without any change as long as:
	1. "path" attribute of "library" element matches with the actual effect library name.
	2. "name" attribute of "effect" and "effectProxy" element correctly added as key of
	kUuidNameTypeMap, with value matches Identity.type in Descriptor.aidl.
	3. "uuid" attribute of "effect" element matches Identity.uuid in Descriptor.aidl.
	4. "uuid" attribute of "effectProxy" element matches Identity.proxy in Descriptor.aidl.
	-->

	<!-- List of effect libraries to load.
	Each library element must contain a "name" attribute and a "path" attribute giving the
	name of a library .so file on the target device.
	-->
	<libraries>
	<library name="aecsw" path="libaecsw.so"/>
	<library name="agcsw" path="libagcsw.so"/>
	<library name="bassboostsw" path="libbassboostsw.so"/>
	<library name="bundle" path="libbundleaidl.so"/>
	<library name="downmix" path="libdownmixaidl.so"/>
	<library name="dynamics_processing" path="libdynamicsprocessingaidl.so"/>
	<library name="equalizersw" path="libequalizersw.so"/>
	<library name="haptic_generator" path="libhapticgeneratoraidl.so"/>
	<library name="loudness_enhancer" path="libloudnessenhanceraidl.so"/>
	<library name="nssw" path="libnssw.so"/>
	<library name="env_reverbsw" path="libenvreverbsw.so"/>
	<library name="preset_reverbsw" path="libpresetreverbsw.so"/>
	<library name="reverb" path="libreverbaidl.so"/>
	<library name="virtualizersw" path="libvirtualizersw.so"/>
	<library name="visualizer" path="libvisualizeraidl.so"/>
	<library name="volumesw" path="libvolumesw.so"/>
	</libraries>

	<!-- list of effects to load.
	Each "effect" element must contain a "name", "library" and a "uuid" attribute.
	The value of the "library" attribute must correspond to the name of one library element in
	the "libraries" element.
	The "name" attribute used to specific effect type, and should be mapping to a key of
	aidl::android::hardware::audio::effect::kUuidNameTypeMap.
	The "uuid" attribute is the implementation specific UUID as specified by the effect vendor.

	Effect proxy can be supported with "effectProxy" element, each sub-element should contain
	"library" and "uuid" attribute, all other attributes were ignored. Framework side use
	result of IFactory.queryEffects() to decide which effect implementation should be part of
	proxy and which not.

	Only "name", "library", and "uuid" attributes in "effects" element are meaningful and
	parsed out by EffectConfig class, all other attributes are ignored.
	Only "name" and "uuid" attributes in "effectProxy" element are meaningful and parsed out
	by EffectConfig class, all other attributes are ignored.
	-->

	<effects>
	<effect name="acoustic_echo_canceler" library="aecsw" uuid="bb392ec0-8d4d-11e0-a896-0002a5d5c51b"/>
	<effect name="automatic_gain_control" library="agcsw" uuid="89f38e65-d4d2-4d64-ad0e-2b3e799ea886"/>
	<effectProxy name="bassboost" uuid="14804144-a5ee-4d24-aa88-0002a5d5c51b">
	<libsw library="bassboostsw" uuid="fa8181f2-588b-11ed-9b6a-0242ac120002"/>
	<libsw library="bundle" uuid="8631f300-72e2-11df-b57e-0002a5d5c51b"/>
	</effectProxy>
	<effect name="downmix" library="downmix" uuid="93f04452-e4fe-41cc-91f9-e475b6d1d69f"/>
	<effect name="dynamics_processing" library="dynamics_processing" uuid="e0e6539b-1781-7261-676f-6d7573696340"/>
	<effect name="haptic_generator" library="haptic_generator" uuid="97c4acd1-8b82-4f2f-832e-c2fe5d7a9931"/>
	<effect name="loudness_enhancer" library="loudness_enhancer" uuid="fa415329-2034-4bea-b5dc-5b381c8d1e2c"/>
	<effect name="env_reverb" library="env_reverbsw" uuid="fa819886-588b-11ed-9b6a-0242ac120002"/>
	<effect name="noise_suppression" library="nssw" uuid="c06c8400-8e06-11e0-9cb6-0002a5d5c51b"/>
	<effect name="preset_reverb" library="preset_reverbsw" uuid="fa8199c6-588b-11ed-9b6a-0242ac120002"/>
	<effect name="reverb_env_aux" library="reverb" uuid="4a387fc0-8ab3-11df-8bad-0002a5d5c51b"/>
	<effect name="reverb_env_ins" library="reverb" uuid="c7a511a0-a3bb-11df-860e-0002a5d5c51b"/>
	<effect name="reverb_pre_aux" library="reverb" uuid="f29a1400-a3bb-11df-8ddc-0002a5d5c51b"/>
	<effect name="reverb_pre_ins" library="reverb" uuid="172cdf00-a3bc-11df-a72f-0002a5d5c51b"/>
	<effectProxy name="virtualizer" uuid="d3467faa-acc7-4d34-acaf-0002a5d5c51b">
	<libsw library="virtualizersw" uuid="fa819d86-588b-11ed-9b6a-0242ac120002"/>
	<libsw library="bundle" uuid="1d4033c0-8557-11df-9f2d-0002a5d5c51b"/>
	</effectProxy>
	<effect name="visualizer" library="visualizer" uuid="d069d9e0-8329-11df-9168-0002a5d5c51b"/>
	<effect name="volume" library="bundle" uuid="119341a0-8469-11df-81f9-0002a5d5c51b"/>
	<effectProxy name="equalizer" uuid="c8e70ecd-48ca-456e-8a4f-0002a5d5c51b">
	<libsw library="equalizersw" uuid="0bed4300-847d-11df-bb17-0002a5d5c51b"/>
	<libsw library="bundle" uuid="ce772f20-847d-11df-bb17-0002a5d5c51b"/>
	</effectProxy>
	</effects>

	<!-- Audio pre processor configurations.
	The pre processor configuration is described in a "preprocess" element and consists in a
	list of elements each describing pre processor settings for a given use case or "stream".
	Each stream element has a "type" attribute corresponding to the input source used.
	Valid types are these defined in system/hardware/interfaces/media/aidl/android/media/audio/
	common/AudioSource.aidl.
	Each "stream" element contains a list of "apply" elements indicating one effect to apply.
	The effect to apply is designated by its name in the "effects" elements.
	If there are more than one effect apply to one stream, the audio framework will apply them
	in the same equence as they listed in "stream" element.

	<preprocess>
	<stream type="voice_communication">
	<apply effect="aec"/>
	<apply effect="ns"/>
	</stream>
	</preprocess>
	-->

	<!-- Audio post processor configurations.
	The post processor configuration is described in a "postprocess" element and consists in a
	list of elements each describing post processor settings for a given use case or "stream".
	Each stream element has a "type" attribute corresponding to the stream type used.
	Valid types are these defined in system/hardware/interfaces/media/aidl/android/media/audio/
	common/AudioStreamType.aidl.
	Each "stream" element contains a list of "apply" elements indicating one effect to apply.
	The effect to apply is designated by its name in the "effects" elements.
	If there are more than one effect apply to one stream, the audio framework will apply them
	in the same equence as they listed in "stream" element.

	<postprocess>
	<stream type="music">
	<apply effect="music_post_proc"/>
	</stream>
	<stream type="voice_call">
	<apply effect="voice_post_proc"/>
	</stream>
	<stream type="notification">
	<apply effect="notification_post_proc"/>
	</stream>
	</postprocess>
	-->

	</audio_effects_conf>