Create a Logarithm Adaptation parameter type

Some parameters need to be converted to
logarithm.
This can be the case for volumes that come
from HAL as mere decimal values.

This patch adds the LogarithmAdaptationParameter
type.

Change-Id: Ic64232816a82c56a6ddffa5fdccda356eb4ec9c7
Tracked-On: https://jira01.devtools.intel.com/browse/IMINAN-16954
Signed-off-by: Piotr Diop <piotrx.diop@intel.com>
Reviewed-on: https://android.intel.com:443/320371

1 files changed, 89 insertions, 0 deletions

diff --git a/parameter/LogarithmicParameterAdaptation.cpp b/parameter/LogarithmicParameterAdaptation.cpp
new file mode 100644
index 0000000..688527d
--- /dev/null
+++ b/parameter/LogarithmicParameterAdaptation.cpp
@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2011-2015, Intel Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "LogarithmicParameterAdaptation.h"
+#include <math.h>
+
+#define base CLinearParameterAdaptation
+
+// M_E is the base of the natural logarithm for 'e' from math.h
+CLogarithmicParameterAdaptation::CLogarithmicParameterAdaptation() : base("Logarithmic"),
+    _dLogarithmBase(M_E), _dFloorValue(-INFINITY)
+{
+}
+
+// Element properties
+void CLogarithmicParameterAdaptation::showProperties(std::string& strResult) const
+{
+    base::showProperties(strResult);
+
+    strResult += " - LogarithmBase: ";
+    strResult += toString(_dLogarithmBase);
+    strResult += "\n";
+    strResult += " - FloorValue: ";
+    strResult += toString(_dFloorValue);
+    strResult += "\n";
+}
+
+bool CLogarithmicParameterAdaptation::fromXml(const CXmlElement& xmlElement,
+                                            CXmlSerializingContext& serializingContext)
+{
+
+    if (xmlElement.hasAttribute("LogarithmBase")) {
+
+        _dLogarithmBase = xmlElement.getAttributeDouble("LogarithmBase");
+
+        // Avoid negative and 1 values
+        if (_dLogarithmBase <= 0 || _dLogarithmBase == 1) {
+            serializingContext.setError("LogarithmBase attribute cannot be negative or 1 on element"
+                                        + xmlElement.getPath());
+
+            return false;
+        }
+    }
+
+    if (xmlElement.hasAttribute("FloorValue")) {
+        _dFloorValue = xmlElement.getAttributeDouble("FloorValue");
+    }
+    // Base
+    return base::fromXml(xmlElement, serializingContext);
+}
+
+
+int64_t CLogarithmicParameterAdaptation::fromUserValue(double dValue) const
+{
+    return fmax(round(base::fromUserValue(log(dValue) / log(_dLogarithmBase))),
+                        _dFloorValue);
+}
+
+double CLogarithmicParameterAdaptation::toUserValue(int64_t iValue) const
+{
+    return exp(base::toUserValue(iValue) * log(_dLogarithmBase));
+}