cmhw: Add stubs for SRE support

 * Add support for Sunlight Readability Enhancement, aka Facemelt Mode.
 * Optional dependency on adaptive backlight support, which is required
   in all current implementations.

Change-Id: Id25bb5fd384f3935383a5c7f5795ce17afc73b00

1 files changed, 58 insertions, 0 deletions

diff --git a/src/org/cyanogenmod/hardware/SunlightEnhancement.java b/src/org/cyanogenmod/hardware/SunlightEnhancement.java
new file mode 100644
index 0000000..0045eed
--- /dev/null
+++ b/src/org/cyanogenmod/hardware/SunlightEnhancement.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2014 The CyanogenMod 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.
+ */
+
+package org.cyanogenmod.hardware;
+
+/**
+ * Sunlight Readability Enhancement support, aka Facemelt Mode.
+ *
+ * Brightens up the screen via image processing or other tricks when
+ * under aggressive lighting conditions. Usually depends on CABC
+ * support.
+ */
+public class SunlightEnhancement {
+
+    /**
+     * Whether device supports SRE
+     *
+     * @return boolean Supported devices must return always true
+     */
+    public static boolean isSupported() { return false; }
+
+    /**
+     * This method return the current activation status of SRE
+     *
+     * @return boolean Must be false when SRE is not supported or not activated, or
+     * the operation failed while reading the status; true in any other case.
+     */
+    public static boolean isEnabled() { return false; }
+
+    /**
+     * This method allows to setup SRE.
+     *
+     * @param status The new SRE status
+     * @return boolean Must be false if SRE is not supported or the operation
+     * failed; true in any other case.
+     */
+    public static boolean setEnabled(boolean status) { return false; }
+
+    /**
+     * Whether adaptive backlight (CABL / CABC) is required to be enabled
+     *
+     * @return boolean False if adaptive backlight is not a dependency
+     */
+    public static boolean isAdaptiveBacklightRequired() { return true; }
+}