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

7 files changed, 173 insertions, 3 deletions

diff --git a/parameter/Android.mk b/parameter/Android.mk
index 8592c52..6f1f61d 100644
--- a/parameter/Android.mk
+++ b/parameter/Android.mk
@@ -79,6 +79,7 @@ common_src_files := \
         InstanceDefinition.cpp \
         IntegerParameterType.cpp \
         LinearParameterAdaptation.cpp \
+        LogarithmicParameterAdaptation.cpp \
         MappingContext.cpp \
         MappingData.cpp \
         ParameterAccessContext.cpp \
diff --git a/parameter/CMakeLists.txt b/parameter/CMakeLists.txt
index 9f93da7..94369fb 100644
--- a/parameter/CMakeLists.txt
+++ b/parameter/CMakeLists.txt
@@ -64,6 +64,7 @@ add_library(parameter SHARED
     InstanceDefinition.cpp
     IntegerParameterType.cpp
     LinearParameterAdaptation.cpp
+    LogarithmicParameterAdaptation.cpp
     MappingContext.cpp
     MappingData.cpp
     ParameterAccessContext.cpp
diff --git a/parameter/LinearParameterAdaptation.cpp b/parameter/LinearParameterAdaptation.cpp
index 4be92a9..ea833b3 100644
--- a/parameter/LinearParameterAdaptation.cpp
+++ b/parameter/LinearParameterAdaptation.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2014, Intel Corporation
+ * Copyright (c) 2011-2015, Intel Corporation
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification,
@@ -37,6 +37,11 @@ CLinearParameterAdaptation::CLinearParameterAdaptation() : base("Linear"), _dSlo
 {
 }
 
+CLinearParameterAdaptation::CLinearParameterAdaptation(const string& strType) :
+    base(strType), _dSlopeNumerator(1), _dSlopeDenominator(1)
+{
+}
+
 // Element properties
 void CLinearParameterAdaptation::showProperties(string& strResult) const
 {
diff --git a/parameter/LinearParameterAdaptation.h b/parameter/LinearParameterAdaptation.h
index f72f27b..8037c31 100644
--- a/parameter/LinearParameterAdaptation.h
+++ b/parameter/LinearParameterAdaptation.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2014, Intel Corporation
+ * Copyright (c) 2011-2015, Intel Corporation
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification,
@@ -37,6 +37,7 @@ class CLinearParameterAdaptation : public CParameterAdaptation
 {
 public:
     CLinearParameterAdaptation();
+    CLinearParameterAdaptation(const std::string& strType);
 
     // Conversions
     virtual int64_t fromUserValue(double dValue) const;
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));
+}
diff --git a/parameter/LogarithmicParameterAdaptation.h b/parameter/LogarithmicParameterAdaptation.h
new file mode 100644
index 0000000..3b7fd4d
--- /dev/null
+++ b/parameter/LogarithmicParameterAdaptation.h
@@ -0,0 +1,71 @@
+/*
+ * 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.
+ */
+
+#pragma once
+
+#include "LinearParameterAdaptation.h"
+
+/**
+ * This class is used to perform a logarithmic adapation of type:
+ * (slopeNumerator / slopeDenominator) * log(parameter) + offset
+ * Since log(x) == -INFINITY , we can define FloorValue as a
+ *       x -> 0
+ * a lower bound limit for the adaptation
+ */
+class CLogarithmicParameterAdaptation : public CLinearParameterAdaptation
+{
+public:
+    CLogarithmicParameterAdaptation();
+
+    /**
+     * Conversions must satisfy the following: f(f'(a)) = a
+     * Let f=fromUserValue and f'=toUserValue
+     * if y = f(log(x)/log(base)), then
+     * f'(y) * log(base) = log (x)
+     * exp(f'(y)*log(base)) = x
+     */
+    virtual int64_t fromUserValue(double dValue) const;
+    virtual double toUserValue(int64_t iValue) const;
+
+    virtual void showProperties(std::string& strResult) const;
+
+    virtual bool fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
+private:
+    /**
+     * _dLogarithmBase characterizes the new logarithm logB(x) with
+     * the following property: logB(x) = log(x) / log(_dLogarithmBase).
+     * log being the base-e logarithm.
+     */
+    double _dLogarithmBase;
+    /**
+     * _dFloorValue reflects the lower bound for volume attenuation
+     */
+    double _dFloorValue;
+};
diff --git a/parameter/ParameterMgr.cpp b/parameter/ParameterMgr.cpp
index e11b1ad..fb09a7f 100644
--- a/parameter/ParameterMgr.cpp
+++ b/parameter/ParameterMgr.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2014, Intel Corporation
+ * Copyright (c) 2011-2015, Intel Corporation
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification,
@@ -79,6 +79,7 @@
 #include <assert.h>
 #include "ParameterHandle.h"
 #include "LinearParameterAdaptation.h"
+#include "LogarithmicParameterAdaptation.h"
 #include "EnumValuePair.h"
 #include "Subsystem.h"
 #include "XmlFileDocSink.h"
@@ -2447,6 +2448,7 @@ void CParameterMgr::feedElementLibraries()
     pParameterCreationLibrary->addElementBuilder("BooleanParameter", new TNamedElementBuilderTemplate<CBooleanParameterType>());
     pParameterCreationLibrary->addElementBuilder("IntegerParameter", new TNamedElementBuilderTemplate<CIntegerParameterType>());
     pParameterCreationLibrary->addElementBuilder("LinearAdaptation", new TElementBuilderTemplate<CLinearParameterAdaptation>());
+    pParameterCreationLibrary->addElementBuilder("LogarithmicAdaptation", new TElementBuilderTemplate<CLogarithmicParameterAdaptation>());
     pParameterCreationLibrary->addElementBuilder("EnumParameter", new TNamedElementBuilderTemplate<CEnumParameterType>());
     pParameterCreationLibrary->addElementBuilder("ValuePair", new TElementBuilderTemplate<CEnumValuePair>());
     pParameterCreationLibrary->addElementBuilder("FixedPointParameter", new TNamedElementBuilderTemplate<CFixedPointParameterType>());