Selective Backlight/Advanced Softlock - Selective actions based on context

Selective backlight allows the user to choose actions that will not
enable the backlight when pressed.

Advanced softlock allows user to choose actions that  will not be
blocked by screenlock on devices without a hold button.

Both only occur in FM and WPS Contexts.

Update:
Back from the dead
-Cleaned up code, removed unnecessary calls, re-arranged last filter action
  timeout conditional to work in case last_filtered_action_tick was never set
-Added entries to the manual
-Fixed back button on some menus not activating backlight
-Made menus more intuitive, no actions selected now changes menu item to off.
-Added talk fuctionality.
-Added option to disable selective backlight while on external power.
-Rewrote backlight and softlock handling code to fix issue with scrollwheels
-Menu changed to have toggle(yes/no) and settings
-Optimized selective actions lookup
-Added option to disable notification of 'buttons locked' while softlocked
-Removed uneeded code, consolidated action lookup to single function
-Fixed incorrect name on selective softlock menu
-Added option to disable touch on touchscreen devices
-Fixed backlight on original screenlock without selective screenlock active
-Added text selection in mask_select for when show_icons is off
-Fixed voice in mask_select to speak if voice is defined instead of spelling
-Added more lang defines (play skip seek)
-Added option to disable unknown keys turning on backlight
-Fixed Conditional argument In wrong place causing players without
	backlight to fail to build
-Fixed Disable Unknown blocking detection of context change
-Fixed canceling menu didn't update new settings
-Added Autolock on backlight off
-Removed backlight_on_force from backlight.c, Now sets ignore next to false
	and uses backlight_on
-Cleaned up autolock code added strings to lang file
-Fixed issue where rapid presses would bypass softlock
-Removed old softlock code, Cleaned selective actions code
-Changed menu to match existing RB menus
-Fixed Backlight_on_Hold blocked by backlight_ignore_next
-Fixed ignore_next for ipod
-Fixed bug allowing context with softlock to bypass selective backlight
-Changed mask_select to no longer prompt for changes to be saved
-Changed menu names
-Added ignore timeout to allow ipod scroll wheel to work properly and other
 players to still work properly, removed some previous code including
 ignore_event
-Increased ignore timeout to prevent sd card accesses from interrupting action
 code and turning on backlight
-Changed Unknown action to unmapped action in menu, changed handling code
-Removed unneeded logic and variables for handling unfiltered actions
-Reverted unmapped action code to previous functionality
-Added manual entries (thanks JohnB)
-Removed elusive unhandled unicode character from manual, changed formatting slightly

Actions:
Volume,Play,Seek,Skip

Extras:
Disable unmapped actions
Disable selective backlight on external power
Disable touch during softlock on touchscreen devices
Disable softlock notifications (power button still notifies)
Autolock on backlight off

Method:
Adds a function to ignore backlight on next call
 If selected action occurs backlight is forced on,
 Filter_first_keypress stays intact.

Selective softlock allows selected actions through, bypasses the normal
 softlock routine.

ToDo:
DONE

previous commit (#1) has attribution for folder_select.c which mask_select
is based from.

Change-Id: I08132ddcfd64c81751ef23b720f3ec6d68695fe4

1 files changed, 47 insertions, 7 deletions

diff --git a/firmware/backlight.c b/firmware/backlight.c
index 19a1d21eb5..25c295197f 100644
--- a/firmware/backlight.c
+++ b/firmware/backlight.c
@@ -103,6 +103,8 @@ static void backlight_thread(void);
 static long backlight_stack[DEFAULT_STACK_SIZE/sizeof(long)];
 static const char backlight_thread_name[] = "backlight";
 static struct event_queue backlight_queue SHAREDBSS_ATTR;
+static bool ignore_backlight_on = false;
+static int backlight_ignored_timer = 0;
 #ifdef BACKLIGHT_DRIVER_CLOSE
 static unsigned int backlight_thread_id = 0;
 #endif
@@ -123,6 +125,8 @@ static void backlight_timeout_handler(void);
 #ifdef HAVE_BUTTON_LIGHT
 static int buttonlight_timer;
 static int buttonlight_timeout = 5*HZ;
+static bool ignore_buttonlight_on = false;
+static int buttonlight_ignored_timer = 0;
 
 /* Update state of buttonlight according to timeout setting */
 static void buttonlight_update_state(void)
@@ -140,10 +144,20 @@ static void buttonlight_update_state(void)
 }
 
 /* external interface */
+
 void buttonlight_on(void)
 {
-    queue_remove_from_head(&backlight_queue, BUTTON_LIGHT_ON);
-    queue_post(&backlight_queue, BUTTON_LIGHT_ON, 0);
+    if(!ignore_buttonlight_on)
+    {
+        queue_remove_from_head(&backlight_queue, BUTTON_LIGHT_ON);
+        queue_post(&backlight_queue, BUTTON_LIGHT_ON, 0);
+    }
+}
+
+void buttonlight_on_ignore(bool value, int timeout)
+{
+    ignore_buttonlight_on = value;
+    buttonlight_ignored_timer = timeout;
 }
 
 void buttonlight_off(void)
@@ -232,7 +246,7 @@ static int backlight_fading_state = NOT_FADING;
 /* s15.16 fixed point variables */
 static int32_t bl_fade_in_step  = ((BL_PWM_INTERVAL*BL_PWM_COUNT)<<16)/300;
 static int32_t bl_fade_out_step = ((BL_PWM_INTERVAL*BL_PWM_COUNT)<<16)/2000;
-static int32_t bl_dim_fraction  = 0;     
+static int32_t bl_dim_fraction  = 0;
 
 static int bl_dim_target  = 0;
 static int bl_dim_current = 0;
@@ -642,7 +656,7 @@ void backlight_thread(void)
                 buttonlight_hw_off();
                 break;
 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
-            case BUTTON_LIGHT_BRIGHTNESS_CHANGED:                
+            case BUTTON_LIGHT_BRIGHTNESS_CHANGED:
                 buttonlight_hw_brightness((int)ev.data);
                 break;
 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
@@ -723,7 +737,19 @@ static void backlight_timeout_handler(void)
             buttonlight_hw_off();
         }
     }
+    if (buttonlight_ignored_timer > 0)
+    {
+        buttonlight_ignored_timer -= BACKLIGHT_THREAD_TIMEOUT;
+        if (buttonlight_ignored_timer <= 0)
+            ignore_buttonlight_on = false;
+    }
 #endif /* HAVE_BUTTON_LIGHT */
+    if (backlight_ignored_timer > 0)
+    {
+        backlight_ignored_timer -= BACKLIGHT_THREAD_TIMEOUT;
+        if (backlight_ignored_timer <= 0)
+            ignore_backlight_on = false;
+    }
 }
 
 void backlight_init(void)
@@ -768,8 +794,17 @@ void backlight_close(void)
 
 void backlight_on(void)
 {
-    queue_remove_from_head(&backlight_queue, BACKLIGHT_ON);
-    queue_post(&backlight_queue, BACKLIGHT_ON, 0);
+    if(!ignore_backlight_on)
+    {
+        queue_remove_from_head(&backlight_queue, BACKLIGHT_ON);
+        queue_post(&backlight_queue, BACKLIGHT_ON, 0);
+    }
+}
+
+void backlight_on_ignore(bool value, int timeout)
+{
+    ignore_backlight_on = value;
+    backlight_ignored_timer = timeout;
 }
 
 void backlight_off(void)
@@ -829,8 +864,13 @@ void backlight_set_timeout_plugged(int value)
 void backlight_hold_changed(bool hold_button)
 {
     if (!hold_button || (backlight_on_button_hold > 0))
+    {
         /* if unlocked or override in effect */
-        backlight_on();
+
+        /*backlight_on(); REMOVED*/
+        queue_remove_from_head(&backlight_queue, BACKLIGHT_ON);
+        queue_post(&backlight_queue, BACKLIGHT_ON, 0);
+    }
 }
 
 void backlight_set_on_button_hold(int index)