Effects config: Parse new configuration format
For treble, files shared between vendor and system must have a schema.
As .conf did not support such feature, transition to an xml based
configuration file.
This new format has several changes:
- library path are now relative to the standard effect directories
- effect parameters are no longer supported (nobody used them)
Test: Check that the dumpsys is similar than with the legacy formal
Bug: 37492580
Change-Id: I333db2977280e2e0078815b88affd4ab9b01b8bc
Signed-off-by: Kevin Rocard <krocard@google.com>
diff --git a/media/libeffects/Android.bp b/media/libeffects/Android.bp
index ccaa2b4..0dd3f17 100644
--- a/media/libeffects/Android.bp
+++ b/media/libeffects/Android.bp
@@ -1 +1 @@
-subdirs = ["factory"]
+subdirs = ["factory", "config"]
diff --git a/media/libeffects/config/Android.bp b/media/libeffects/config/Android.bp
new file mode 100644
index 0000000..5666d14
--- /dev/null
+++ b/media/libeffects/config/Android.bp
@@ -0,0 +1,14 @@
+// Effect configuration
+cc_library_shared {
+ name: "libeffectsconfig",
+ vendor_available: true,
+
+ srcs: ["src/EffectsConfig.cpp"],
+
+ shared_libs: [
+ "liblog",
+ "libtinyxml2",
+ ],
+
+ export_include_dirs: ["include"],
+}
diff --git a/media/libeffects/config/include/media/EffectsConfig.h b/media/libeffects/config/include/media/EffectsConfig.h
new file mode 100644
index 0000000..811730c
--- /dev/null
+++ b/media/libeffects/config/include/media/EffectsConfig.h
@@ -0,0 +1,104 @@
+/*
+ * Copyright (C) 2017 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.
+ */
+
+
+#ifndef ANDROID_MEDIA_EFFECTSCONFIG_H
+#define ANDROID_MEDIA_EFFECTSCONFIG_H
+
+/** @file Parses audio effects configuration file to C and C++ structure.
+ * @see audio_effects_conf_V2_0.xsd for documentation on each structure
+ */
+
+#include <system/audio_effect.h>
+
+#include <map>
+#include <memory>
+#include <string>
+#include <vector>
+
+namespace android {
+namespace effectsConfig {
+
+/** Default path of effect configuration file. */
+constexpr char DEFAULT_PATH[] = "/vendor/etc/audio_effects.xml";
+
+/** Directories where the effect libraries will be search for. */
+constexpr const char* LD_EFFECT_LIBRARY_PATH[] =
+#ifdef __LP64__
+ {"/odm/lib64/soundfx", "/vendor/lib64/soundfx", "/system/lib64/soundfx"};
+#else
+ {"/odm/lib/soundfx", "/vendor/lib/soundfx", "/system/lib/soundfx"};
+#endif
+
+struct Library {
+ std::string name;
+ std::string path;
+};
+using Libraries = std::vector<Library>;
+
+struct EffectImpl {
+ Library* library; //< Only valid as long as the associated library vector is unmodified
+ effect_uuid_t uuid;
+};
+
+struct Effect : public EffectImpl {
+ std::string name;
+ bool isProxy;
+ EffectImpl libSw; //< Only valid if isProxy
+ EffectImpl libHw; //< Only valid if isProxy
+};
+
+using Effects = std::vector<Effect>;
+
+template <class Type>
+struct Stream {
+ Type type;
+ std::vector<std::reference_wrapper<Effect>> effects;
+};
+using OutputStream = Stream<audio_stream_type_t>;
+using InputStream = Stream<audio_source_t>;
+
+/** Parsed configuration.
+ * Intended to be a transient structure only used for deserialization.
+ * Note: Everything is copied in the configuration from the xml dom.
+ * If copies needed to be avoided due to performance issue,
+ * consider keeping a private handle on the xml dom and replace all strings by dom pointers.
+ * Or even better, use SAX parsing to avoid the allocations all together.
+ */
+struct Config {
+ float version;
+ Libraries libraries;
+ Effects effects;
+ std::vector<OutputStream> postprocess;
+ std::vector<InputStream> preprocess;
+};
+
+/** Result of `parse(const char*)` */
+struct ParsingResult {
+ /** Parsed config, nullptr if the xml lib could not load the file */
+ std::unique_ptr<Config> parsedConfig;
+ size_t nbSkippedElement; //< Number of skipped invalid library, effect or processing chain
+};
+
+/** Parses the provided effect configuration.
+ * Parsing do not stop of first invalid element, but continues to the next.
+ * @see ParsingResult::nbSkippedElement
+ */
+ParsingResult parse(const char* path = DEFAULT_PATH);
+
+} // namespace effectsConfig
+} // namespace android
+#endif // ANDROID_MEDIA_EFFECTSCONFIG_H
diff --git a/media/libeffects/config/src/EffectsConfig.cpp b/media/libeffects/config/src/EffectsConfig.cpp
new file mode 100644
index 0000000..97462f8
--- /dev/null
+++ b/media/libeffects/config/src/EffectsConfig.cpp
@@ -0,0 +1,302 @@
+/*
+ * Copyright (C) 2017 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.
+ */
+
+#define LOG_TAG "EffectsConfig"
+
+#include <algorithm>
+#include <cstdint>
+#include <functional>
+#include <string>
+
+#include <tinyxml2.h>
+#include <log/log.h>
+
+#include <media/EffectsConfig.h>
+
+using namespace tinyxml2;
+
+namespace android {
+namespace effectsConfig {
+
+/** All functions except `parse(const char*)` are static. */
+namespace {
+
+/** @return all `node`s children that are elements and match the tag if provided. */
+std::vector<std::reference_wrapper<const XMLElement>> getChildren(const XMLNode& node,
+ const char* childTag = nullptr) {
+ std::vector<std::reference_wrapper<const XMLElement>> children;
+ for (auto* child = node.FirstChildElement(childTag); child != nullptr;
+ child = child->NextSiblingElement(childTag)) {
+ children.emplace_back(*child);
+ }
+ return children;
+}
+
+/** @return xml dump of the provided element.
+ * By not providing a printer, it is implicitly created in the caller context.
+ * In such case the return pointer has the same lifetime as the expression containing dump().
+ */
+const char* dump(const XMLElement& element, XMLPrinter&& printer = {}) {
+ element.Accept(&printer);
+ return printer.CStr();
+}
+
+
+bool stringToUuid(const char *str, effect_uuid_t *uuid)
+{
+ uint32_t tmp[10];
+
+ if (sscanf(str, "%08x-%04x-%04x-%04x-%02x%02x%02x%02x%02x%02x",
+ tmp, tmp+1, tmp+2, tmp+3, tmp+4, tmp+5, tmp+6, tmp+7, tmp+8, tmp+9) < 10) {
+ return false;
+ }
+ uuid->timeLow = (uint32_t)tmp[0];
+ uuid->timeMid = (uint16_t)tmp[1];
+ uuid->timeHiAndVersion = (uint16_t)tmp[2];
+ uuid->clockSeq = (uint16_t)tmp[3];
+ uuid->node[0] = (uint8_t)tmp[4];
+ uuid->node[1] = (uint8_t)tmp[5];
+ uuid->node[2] = (uint8_t)tmp[6];
+ uuid->node[3] = (uint8_t)tmp[7];
+ uuid->node[4] = (uint8_t)tmp[8];
+ uuid->node[5] = (uint8_t)tmp[9];
+
+ return true;
+}
+
+/** Map the enum and string representation of a string type.
+ * Intended to be specialized for each enum to deserialize.
+ * The general template is disabled.
+ */
+template <class Enum>
+constexpr std::enable_if<false, Enum> STREAM_NAME_MAP;
+
+/** All output stream types which support effects.
+ * This need to be kept in sink with the xsd streamOutputType.
+ */
+template <>
+constexpr std::pair<audio_stream_type_t, const char*> STREAM_NAME_MAP<audio_stream_type_t>[] = {
+ {AUDIO_STREAM_VOICE_CALL, "voice_call"},
+ {AUDIO_STREAM_SYSTEM, "system"},
+ {AUDIO_STREAM_RING, "ring"},
+ {AUDIO_STREAM_MUSIC, "music"},
+ {AUDIO_STREAM_ALARM, "alarm"},
+ {AUDIO_STREAM_NOTIFICATION, "notification"},
+ {AUDIO_STREAM_BLUETOOTH_SCO, "bluetooth_sco"},
+ {AUDIO_STREAM_ENFORCED_AUDIBLE, "enforced_audible"},
+ {AUDIO_STREAM_DTMF, "dtmf"},
+ {AUDIO_STREAM_TTS, "tts"},
+};
+
+/** All input stream types which support effects.
+ * This need to be kept in sink with the xsd streamOutputType.
+ */
+template <>
+constexpr std::pair<audio_source_t, const char*> STREAM_NAME_MAP<audio_source_t>[] = {
+ {AUDIO_SOURCE_MIC, "mic"},
+ {AUDIO_SOURCE_VOICE_UPLINK, "voice_uplink"},
+ {AUDIO_SOURCE_VOICE_DOWNLINK, "voice_downlink"},
+ {AUDIO_SOURCE_VOICE_CALL, "voice_call"},
+ {AUDIO_SOURCE_CAMCORDER, "camcorder"},
+ {AUDIO_SOURCE_VOICE_RECOGNITION, "voice_recognition"},
+ {AUDIO_SOURCE_VOICE_COMMUNICATION, "voice_communication"},
+ {AUDIO_SOURCE_UNPROCESSED, "unprocessed"},
+};
+
+/** Find the stream type enum corresponding to the stream type name or return false */
+template <class Type>
+bool stringToStreamType(const char *streamName, Type* type)
+{
+ for (auto& streamNamePair : STREAM_NAME_MAP<Type>) {
+ if (strcmp(streamNamePair.second, streamName) == 0) {
+ *type = streamNamePair.first;
+ return true;
+ }
+ }
+ return false;
+}
+
+/** Parse a library xml note and push the result in libraries or return false on failure. */
+bool parseLibrary(const XMLElement& xmlLibrary, Libraries* libraries) {
+ const char* name = xmlLibrary.Attribute("name");
+ const char* path = xmlLibrary.Attribute("path");
+ if (name == nullptr || path == nullptr) {
+ ALOGE("library must have a name and a path: %s", dump(xmlLibrary));
+ return false;
+ }
+ libraries->push_back({name, path});
+ return true;
+}
+
+/** Find an element in a collection by its name.
+ * @return nullptr if not found, the ellements address if found.
+ */
+template <class T>
+T* findByName(const char* name, std::vector<T>& collection) {
+ auto it = find_if(begin(collection), end(collection),
+ [name] (auto& item) { return item.name == name; });
+ return it != end(collection) ? &*it : nullptr;
+}
+
+/** Parse an effect from an xml element describing it.
+ * @return true and pushes the effect in effects on success,
+ * false on failure. */
+bool parseEffect(const XMLElement& xmlEffect, Libraries& libraries, Effects* effects) {
+ Effect effect{};
+
+ const char* name = xmlEffect.Attribute("name");
+ if (name == nullptr) {
+ ALOGE("%s must have a name: %s", xmlEffect.Value(), dump(xmlEffect));
+ return false;
+ }
+ effect.name = name;
+
+ // Function to parse effect.library and effect.uuid from xml
+ auto parseImpl = [&libraries](const XMLElement& xmlImpl, EffectImpl& effect) {
+ // Retrieve library name and uuid from xml
+ const char* libraryName = xmlImpl.Attribute("library");
+ const char* uuid = xmlImpl.Attribute("uuid");
+ if (libraryName == nullptr || uuid == nullptr) {
+ ALOGE("effect must have a library name and a uuid: %s", dump(xmlImpl));
+ return false;
+ }
+
+ // Convert library name to a pointer to the previously loaded library
+ auto* library = findByName(libraryName, libraries);
+ if (library == nullptr) {
+ ALOGE("Could not find library referenced in: %s", dump(xmlImpl));
+ return false;
+ }
+ effect.library = library;
+
+ if (!stringToUuid(uuid, &effect.uuid)) {
+ ALOGE("Invalid uuid in: %s", dump(xmlImpl));
+ return false;
+ }
+ return true;
+ };
+
+ if (!parseImpl(xmlEffect, effect)) {
+ return false;
+ }
+
+ // Handle proxy effects
+ effect.isProxy = false;
+ if (std::strcmp(xmlEffect.Name(), "effectProxy") == 0) {
+ effect.isProxy = true;
+
+ // Function to parse libhw and libsw
+ auto parseProxy = [&xmlEffect, &parseImpl](const char* tag, EffectImpl& proxyLib) {
+ auto* xmlProxyLib = xmlEffect.FirstChildElement(tag);
+ if (xmlProxyLib == nullptr) {
+ ALOGE("effectProxy must contain a <%s>: %s", tag, dump(*xmlProxyLib));
+ return false;
+ }
+ return parseImpl(*xmlProxyLib, proxyLib);
+ };
+ if (!parseProxy("libhw", effect.libHw) || !parseProxy("libsw", effect.libSw)) {
+ return false;
+ }
+ }
+
+ effects->push_back(std::move(effect));
+ return true;
+}
+
+/** Parse an stream from an xml element describing it.
+ * @return true and pushes the stream in streams on success,
+ * false on failure. */
+template <class Stream>
+bool parseStream(const XMLElement& xmlStream, Effects& effects, std::vector<Stream>* streams) {
+ const char* streamType = xmlStream.Attribute("type");
+ if (streamType == nullptr) {
+ ALOGE("stream must have a type: %s", dump(xmlStream));
+ return false;
+ }
+ Stream stream;
+ if (!stringToStreamType(streamType, &stream.type)) {
+ ALOGE("Invalid stream type %s: %s", streamType, dump(xmlStream));
+ return false;
+ }
+
+ for (auto& xmlApply : getChildren(xmlStream, "apply")) {
+ const char* effectName = xmlApply.get().Attribute("effect");
+ if (effectName == nullptr) {
+ ALOGE("stream/apply must have reference an effect: %s", dump(xmlApply));
+ return false;
+ }
+ auto* effect = findByName(effectName, effects);
+ if (effect == nullptr) {
+ ALOGE("Could not find effect referenced in: %s", dump(xmlApply));
+ return false;
+ }
+ stream.effects.emplace_back(*effect);
+ }
+ streams->push_back(std::move(stream));
+ return true;
+}
+
+}; // namespace
+
+ParsingResult parse(const char* path) {
+ XMLDocument doc;
+ doc.LoadFile(path);
+ if (doc.Error()) {
+ ALOGE("Failed to parse %s: Tinyxml2 error (%d): %s %s", path,
+ doc.ErrorID(), doc.GetErrorStr1(), doc.GetErrorStr2());
+ return {nullptr, 0};
+ }
+
+ auto config = std::make_unique<Config>();
+ size_t nbSkippedElements = 0;
+ auto registerFailure = [&nbSkippedElements](bool result) {
+ nbSkippedElements += result ? 0 : 1;
+ };
+ for (auto& xmlConfig : getChildren(doc, "audio_effects_conf")) {
+
+ // Parse library
+ for (auto& xmlLibraries : getChildren(xmlConfig, "libraries")) {
+ for (auto& xmlLibrary : getChildren(xmlLibraries, "library")) {
+ registerFailure(parseLibrary(xmlLibrary, &config->libraries));
+ }
+ }
+
+ // Parse effects
+ for (auto& xmlEffects : getChildren(xmlConfig, "effects")) {
+ for (auto& xmlEffect : getChildren(xmlEffects)) {
+ registerFailure(parseEffect(xmlEffect, config->libraries, &config->effects));
+ }
+ }
+
+ // Parse pre processing chains
+ for (auto& xmlPreprocess : getChildren(xmlConfig, "preprocess")) {
+ for (auto& xmlStream : getChildren(xmlPreprocess, "stream")) {
+ registerFailure(parseStream(xmlStream, config->effects, &config->preprocess));
+ }
+ }
+
+ // Parse post processing chains
+ for (auto& xmlPostprocess : getChildren(xmlConfig, "postprocess")) {
+ for (auto& xmlStream : getChildren(xmlPostprocess, "stream")) {
+ registerFailure(parseStream(xmlStream, config->effects, &config->postprocess));
+ }
+ }
+ }
+ return {std::move(config), nbSkippedElements};
+}
+
+} // namespace effectsConfig
+} // namespace android