blob: e859a0e083f8dea67a3ecf102438492abb86afe2 [file] [log] [blame]
Shunkai Yao60b34b72022-11-10 17:16:50 +00001<?xml version="1.0" encoding="UTF-8"?>
2<audio_effects_conf version="2.0" xmlns="http://schemas.android.com/audio/audio_effects_conf/v2_0">
3 <!-- Overview.
4 This example config file was copy from existing one: frameworks/av/media/libeffects/data/
5 audio_effects.xml, with effect library names updated to AIDL libraries we currently have.
6
7 All "library" attributes in "effect" element must must match a "library" element with the
8 same value of the "name" attribute.
9 All "effect" attributes in "preprocess" and "postprocess" element must match an "effect"
10 element with the same value of the "name" attribute.
11
12 AIDL EffectFactory are relying on the "name" attribute in "effect" element to identify the
13 effect type, so it's necessary to have the mapping from name to effect type UUID. Make
14 sure to either use existing effect name as key of
15 ::android::hardware::audio::effect::kUuidNameTypeMap, or add a new {name, typeUUID} map
16 item to the kUuidNameTypeMap.
17
18 Existing audio_effects.xml should working without any change as long as:
19 1. "path" attribute of "library" element matches with the actual effect library name.
20 2. "name" attribute of "effect" and "effectProxy" element correctly added as key of
21 kUuidNameTypeMap, with value matches Identity.type in Descriptor.aidl.
22 3. "uuid" attribute of "effect" element matches Identity.uuid in Descriptor.aidl.
23 4. "uuid" attribute of "effectProxy" element matches Identity.proxy in Descriptor.aidl.
24 -->
25
26 <!-- List of effect libraries to load.
27 Each library element must contain a "name" attribute and a "path" attribute giving the
28 name of a library .so file on the target device.
29 -->
30 <libraries>
Shunkai Yaobd862b82022-12-20 00:11:41 +000031 <library name="aecsw" path="libaecsw.so"/>
Shraddha Basantwanicac2e682023-02-15 18:03:58 +053032 <library name="agc1sw" path="libagc1sw.so"/>
Shraddha Basantwani84ea32e2023-02-01 16:22:37 +053033 <library name="agc2sw" path="libagc2sw.so"/>
Shunkai Yao60b34b72022-11-10 17:16:50 +000034 <library name="bassboostsw" path="libbassboostsw.so"/>
35 <library name="bundle" path="libbundleaidl.so"/>
Shraddha Basantwani4ff86982022-12-13 16:31:49 +053036 <library name="downmix" path="libdownmixaidl.so"/>
Ram Mohane4064ce2022-12-20 18:05:14 +053037 <library name="dynamics_processing" path="libdynamicsprocessingaidl.so"/>
Shunkai Yao60b34b72022-11-10 17:16:50 +000038 <library name="equalizersw" path="libequalizersw.so"/>
Shraddha Basantwaniae7dde52022-12-18 15:01:14 +053039 <library name="haptic_generator" path="libhapticgeneratoraidl.so"/>
Shraddha Basantwani22834ea2022-12-08 16:09:05 +053040 <library name="loudness_enhancer" path="libloudnessenhanceraidl.so"/>
Shunkai Yaobd862b82022-12-20 00:11:41 +000041 <library name="nssw" path="libnssw.so"/>
Shunkai Yao812d5b42022-11-16 18:08:50 +000042 <library name="env_reverbsw" path="libenvreverbsw.so"/>
Shraddha Basantwani9b5893a2023-01-20 23:51:23 +053043 <library name="pre_processing" path="libpreprocessingaidl.so"/>
Shunkai Yao812d5b42022-11-16 18:08:50 +000044 <library name="preset_reverbsw" path="libpresetreverbsw.so"/>
Shraddha Basantwanib83ec072022-12-29 19:43:38 +053045 <library name="reverb" path="libreverbaidl.so"/>
Shunkai Yao60b34b72022-11-10 17:16:50 +000046 <library name="virtualizersw" path="libvirtualizersw.so"/>
Shunkai Yaoe39cd362022-12-22 00:23:34 +000047 <library name="visualizer" path="libvisualizeraidl.so"/>
Shunkai Yao60b34b72022-11-10 17:16:50 +000048 <library name="volumesw" path="libvolumesw.so"/>
Shunkai Yao85b01692023-02-15 22:04:57 +000049 <library name="extensioneffect" path="libextensioneffect.so"/>
Shunkai Yaof60fc372023-12-12 17:48:18 +000050 <library name="spatializersw" path="libspatializersw.so"/>
Shunkai Yao60b34b72022-11-10 17:16:50 +000051 </libraries>
52
53 <!-- list of effects to load.
Shunkai Yao80e58502023-07-14 22:10:46 +000054 Each "effect" element must contain a "name", "library" and a "uuid" attribute, an optional
55 "type" attribute can be used to add any customized effect type.
Shunkai Yao60b34b72022-11-10 17:16:50 +000056 The value of the "library" attribute must correspond to the name of one library element in
57 the "libraries" element.
58 The "name" attribute used to specific effect type, and should be mapping to a key of
59 aidl::android::hardware::audio::effect::kUuidNameTypeMap.
60 The "uuid" attribute is the implementation specific UUID as specified by the effect vendor.
61
62 Effect proxy can be supported with "effectProxy" element, each sub-element should contain
63 "library" and "uuid" attribute, all other attributes were ignored. Framework side use
64 result of IFactory.queryEffects() to decide which effect implementation should be part of
65 proxy and which not.
66
Shunkai Yao80e58502023-07-14 22:10:46 +000067 Only "name", "library", "uuid", and "type" attributes in "effects" element are meaningful
68 and parsed out by EffectConfig class, all other attributes are ignored.
Shunkai Yao60b34b72022-11-10 17:16:50 +000069 Only "name" and "uuid" attributes in "effectProxy" element are meaningful and parsed out
70 by EffectConfig class, all other attributes are ignored.
71 -->
72
73 <effects>
Shraddha Basantwani9b5893a2023-01-20 23:51:23 +053074 <effect name="automatic_gain_control_v2" library="pre_processing" uuid="89f38e65-d4d2-4d64-ad0e-2b3e799ea886"/>
Shunkai Yao7a0eb7b2024-03-07 20:15:51 +000075 <effect name="bassboost" library="bundle" uuid="8631f300-72e2-11df-b57e-0002a5d5c51b"/>
Shraddha Basantwani4ff86982022-12-13 16:31:49 +053076 <effect name="downmix" library="downmix" uuid="93f04452-e4fe-41cc-91f9-e475b6d1d69f"/>
Ram Mohane4064ce2022-12-20 18:05:14 +053077 <effect name="dynamics_processing" library="dynamics_processing" uuid="e0e6539b-1781-7261-676f-6d7573696340"/>
Shraddha Basantwaniae7dde52022-12-18 15:01:14 +053078 <effect name="haptic_generator" library="haptic_generator" uuid="97c4acd1-8b82-4f2f-832e-c2fe5d7a9931"/>
Shraddha Basantwani22834ea2022-12-08 16:09:05 +053079 <effect name="loudness_enhancer" library="loudness_enhancer" uuid="fa415329-2034-4bea-b5dc-5b381c8d1e2c"/>
Shunkai Yao812d5b42022-11-16 18:08:50 +000080 <effect name="env_reverb" library="env_reverbsw" uuid="fa819886-588b-11ed-9b6a-0242ac120002"/>
81 <effect name="preset_reverb" library="preset_reverbsw" uuid="fa8199c6-588b-11ed-9b6a-0242ac120002"/>
Shraddha Basantwanib83ec072022-12-29 19:43:38 +053082 <effect name="reverb_env_aux" library="reverb" uuid="4a387fc0-8ab3-11df-8bad-0002a5d5c51b"/>
83 <effect name="reverb_env_ins" library="reverb" uuid="c7a511a0-a3bb-11df-860e-0002a5d5c51b"/>
84 <effect name="reverb_pre_aux" library="reverb" uuid="f29a1400-a3bb-11df-8ddc-0002a5d5c51b"/>
85 <effect name="reverb_pre_ins" library="reverb" uuid="172cdf00-a3bc-11df-a72f-0002a5d5c51b"/>
Shunkai Yao7a0eb7b2024-03-07 20:15:51 +000086 <effect name="virtualizer" library="bundle" uuid="1d4033c0-8557-11df-9f2d-0002a5d5c51b"/>
Shunkai Yaoe39cd362022-12-22 00:23:34 +000087 <effect name="visualizer" library="visualizer" uuid="d069d9e0-8329-11df-9168-0002a5d5c51b"/>
Sham Rathod51d16c62022-12-19 17:21:59 +053088 <effect name="volume" library="bundle" uuid="119341a0-8469-11df-81f9-0002a5d5c51b"/>
Shunkai Yao7a0eb7b2024-03-07 20:15:51 +000089 <effect name="equalizer" library="bundle" uuid="ce772f20-847d-11df-bb17-0002a5d5c51b"/>
Shunkai Yao80e58502023-07-14 22:10:46 +000090 <effect name="extension_effect" library="extensioneffect" uuid="fa81dd00-588b-11ed-9b6a-0242ac120002" type="fa81de0e-588b-11ed-9b6a-0242ac120002"/>
Sneha Patil71b814c2023-12-08 14:33:34 +053091 <effect name="acoustic_echo_canceler" library="pre_processing" uuid="bb392ec0-8d4d-11e0-a896-0002a5d5c51b"/>
92 <effect name="noise_suppression" library="pre_processing" uuid="c06c8400-8e06-11e0-9cb6-0002a5d5c51b"/>
Shunkai Yaof60fc372023-12-12 17:48:18 +000093 <effect name="spatializer" library="spatializersw" uuid="fa81a880-588b-11ed-9b6a-0242ac120002"/>
Shunkai Yao60b34b72022-11-10 17:16:50 +000094 </effects>
95
Shunkai Yao5824efb2023-05-08 21:16:13 +000096 <preprocess>
97 <stream type="voice_communication">
98 <apply effect="acoustic_echo_canceler"/>
99 <apply effect="noise_suppression"/>
100 </stream>
101 </preprocess>
102
Shunkai Yao60b34b72022-11-10 17:16:50 +0000103 <!-- Audio pre processor configurations.
104 The pre processor configuration is described in a "preprocess" element and consists in a
105 list of elements each describing pre processor settings for a given use case or "stream".
106 Each stream element has a "type" attribute corresponding to the input source used.
107 Valid types are these defined in system/hardware/interfaces/media/aidl/android/media/audio/
108 common/AudioSource.aidl.
109 Each "stream" element contains a list of "apply" elements indicating one effect to apply.
110 The effect to apply is designated by its name in the "effects" elements.
111 If there are more than one effect apply to one stream, the audio framework will apply them
112 in the same equence as they listed in "stream" element.
113
114 <preprocess>
115 <stream type="voice_communication">
116 <apply effect="aec"/>
117 <apply effect="ns"/>
118 </stream>
119 </preprocess>
120 -->
121
122 <!-- Audio post processor configurations.
123 The post processor configuration is described in a "postprocess" element and consists in a
124 list of elements each describing post processor settings for a given use case or "stream".
125 Each stream element has a "type" attribute corresponding to the stream type used.
126 Valid types are these defined in system/hardware/interfaces/media/aidl/android/media/audio/
127 common/AudioStreamType.aidl.
128 Each "stream" element contains a list of "apply" elements indicating one effect to apply.
129 The effect to apply is designated by its name in the "effects" elements.
130 If there are more than one effect apply to one stream, the audio framework will apply them
131 in the same equence as they listed in "stream" element.
132
133 <postprocess>
134 <stream type="music">
135 <apply effect="music_post_proc"/>
136 </stream>
137 <stream type="voice_call">
138 <apply effect="voice_post_proc"/>
139 </stream>
140 <stream type="notification">
141 <apply effect="notification_post_proc"/>
142 </stream>
143 </postprocess>
144 -->
145
146</audio_effects_conf>