apps/action.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2006 Jonathan Gordon
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24
  25 #include "config.h"
  26 #include "lang.h"
  27
  28 #include "appevents.h"
  29 #include "button.h"
  30 #include "action.h"
  31 #include "kernel.h"
  32 #include "debug.h"
  33 #include "splash.h"
  34 #include "settings.h"
  35 #include "pcmbuf.h"
  36
  37 static int last_button = BUTTON_NONE|BUTTON_REL; /* allow the ipod wheel to
  38                                                     work on startup */
  39 static intptr_t last_data = 0;
  40 static int last_action = ACTION_NONE;
  41 static bool repeated = false;
  42
  43 #ifdef HAVE_TOUCHSCREEN
  44 static bool short_press = false;
  45 #endif
  46
  47 #define REPEAT_WINDOW_TICKS HZ/10
  48 static int last_action_tick = 0;
  49
  50 /* software keylock stuff */
  51 #ifndef HAS_BUTTON_HOLD
  52 static bool keys_locked = false;
  53 static int unlock_combo = BUTTON_NONE;
  54 static bool screen_has_lock = false;
  55 #endif /* HAVE_SOFTWARE_KEYLOCK */
  56
  57 /*
  58  * do_button_check is the worker function for get_default_action.
  59  * returns ACTION_UNKNOWN or the requested return value from the list.
  60  */
  61 static inline int do_button_check(const struct button_mapping *items,
  62                                   int button, int last_button, int *start)
  63 {
  64     int i = 0;
  65     int ret = ACTION_UNKNOWN;
  66     if (items == NULL)
  67         return ACTION_UNKNOWN;
  68
  69     while (items[i].button_code != BUTTON_NONE)
  70     {
  71         if (items[i].button_code == button)
  72         {
  73             if ((items[i].pre_button_code == BUTTON_NONE)
  74                 || (items[i].pre_button_code == last_button))
  75             {
  76                 ret = items[i].action_code;
  77                 break;
  78             }
  79         }
  80         i++;
  81     }
  82     *start = i;
  83     return ret;
  84 }
  85
  86 static inline int get_next_context(const struct button_mapping *items, int i)
  87 {
  88     while (items[i].button_code != BUTTON_NONE)
  89         i++;
  90     return (items[i].action_code == ACTION_NONE ) ?
  91             CONTEXT_STD :
  92             items[i].action_code;
  93 }
  94 /*
  95  * int get_action_worker(int context, struct button_mapping *user_mappings,
  96    int timeout)
  97    This function searches the button list for the given context for the just
  98    pressed button.
  99    If there is a match it returns the value from the list.
 100    If there is no match..
 101         the last item in the list "points" to the next context in a chain
 102         so the "chain" is followed until the button is found.
 103         putting ACTION_NONE will get CONTEXT_STD which is always the last list checked.
 104
 105    Timeout can be TIMEOUT_NOBLOCK to return immediatly
 106                   TIMEOUT_BLOCK   to wait for a button press
 107    Any number >0   to wait that many ticks for a press
 108  */
 109 static int get_action_worker(int context, int timeout,
 110                              const struct button_mapping* (*get_context_map)(int) )
 111 {
 112     const struct button_mapping *items = NULL;
 113     int button;
 114     int i=0;
 115     int ret = ACTION_UNKNOWN;
 116     static int last_context = CONTEXT_STD;
 117
 118
 119     send_event(GUI_EVENT_ACTIONUPDATE, NULL);
 120
 121     if (timeout == TIMEOUT_NOBLOCK)
 122         button = button_get(false);
 123     else if  (timeout == TIMEOUT_BLOCK)
 124         button = button_get(true);
 125     else
 126         button = button_get_w_tmo(timeout);
 127
 128     /* Data from sys events can be pulled with button_get_data */
 129     if (button == BUTTON_NONE || button & SYS_EVENT)
 130         return button;
 131
 132 #if CONFIG_CODEC == SWCODEC
 133     /* Produce keyclick */
 134     if (global_settings.keyclick && !(button & BUTTON_REL))
 135         if (!(button & BUTTON_REPEAT) || global_settings.keyclick_repeats)
 136             pcmbuf_beep(4000, KEYCLICK_DURATION, 2500*global_settings.keyclick);
 137 #endif
 138
 139     if ((context != last_context) && ((last_button & BUTTON_REL) == 0))
 140     {
 141         if (button & BUTTON_REL)
 142         {
 143             last_button = button;
 144             last_action = ACTION_NONE;
 145         }
 146         /* eat all buttons until the previous button was |BUTTON_REL
 147            (also eat the |BUTTON_REL button) */
 148         return ACTION_NONE; /* "safest" return value */
 149     }
 150     last_context = context;
 151 #ifdef HAVE_TOUCHSCREEN
 152     if (button & BUTTON_TOUCHSCREEN)
 153     {
 154         repeated = false;
 155         short_press = false;
 156         if (last_button & BUTTON_TOUCHSCREEN)
 157         {
 158             if ((button & BUTTON_REL) &&
 159                 ((last_button & BUTTON_REPEAT)==0))
 160             {
 161                 short_press = true;
 162             }
 163             else if (button & BUTTON_REPEAT)
 164                 repeated = true;
 165         }
 166         last_button = button;
 167         return ACTION_TOUCHSCREEN;
 168     }
 169 #endif
 170 #ifndef HAS_BUTTON_HOLD
 171     screen_has_lock = ((context & ALLOW_SOFTLOCK) == ALLOW_SOFTLOCK);
 172     if (screen_has_lock && (keys_locked == true))
 173     {
 174         if (button == unlock_combo)
 175         {
 176             last_button = BUTTON_NONE;
 177             keys_locked = false;
 178             splash(HZ/2, str(LANG_KEYLOCK_OFF));
 179             return ACTION_REDRAW;
 180         }
 181         else
 182 #if (BUTTON_REMOTE != 0)
 183             if ((button & BUTTON_REMOTE) == 0)
 184 #endif
 185         {
 186             if ((button & BUTTON_REL))
 187                 splash(HZ/2, str(LANG_KEYLOCK_ON));
 188             return ACTION_REDRAW;
 189         }
 190     }
 191     context &= ~ALLOW_SOFTLOCK;
 192 #endif /* HAS_BUTTON_HOLD */
 193
 194     /*   logf("%x,%x",last_button,button); */
 195     do
 196     {
 197         /*     logf("context = %x",context); */
 198 #if (BUTTON_REMOTE != 0)
 199         if (button & BUTTON_REMOTE)
 200             context |= CONTEXT_REMOTE;
 201 #endif
 202         if ((context & CONTEXT_CUSTOM) && get_context_map)
 203             items = get_context_map(context);
 204         else
 205             items = get_context_mapping(context);
 206
 207         ret = do_button_check(items,button,last_button,&i);
 208
 209         if ((context ==(int)CONTEXT_STOPSEARCHING) ||
 210              items == NULL )
 211             break;
 212
 213         if (ret == ACTION_UNKNOWN )
 214         {
 215             context = get_next_context(items,i);
 216             i = 0;
 217         }
 218         else break;
 219     } while (1);
 220     /* DEBUGF("ret = %x\n",ret); */
 221 #ifndef HAS_BUTTON_HOLD
 222     if (screen_has_lock && (ret == ACTION_STD_KEYLOCK))
 223     {
 224         unlock_combo = button;
 225         keys_locked = true;
 226         splash(HZ/2, str(LANG_KEYLOCK_ON));
 227
 228         button_clear_queue();
 229         return ACTION_REDRAW;
 230     }
 231 #endif
 232     if ((current_tick - last_action_tick < REPEAT_WINDOW_TICKS)
 233          && (ret == last_action))
 234         repeated = true;
 235     else
 236         repeated = false;
 237
 238     last_button = button;
 239     last_action = ret;
 240     last_data   = button_get_data();
 241     last_action_tick = current_tick;
 242     return ret;
 243 }
 244
 245 int get_action(int context, int timeout)
 246 {
 247     return get_action_worker(context,timeout,NULL);
 248 }
 249
 250 int get_custom_action(int context,int timeout,
 251                       const struct button_mapping* (*get_context_map)(int))
 252 {
 253     return get_action_worker(context,timeout,get_context_map);
 254 }
 255
 256 bool action_userabort(int timeout)
 257 {
 258     int action = get_action_worker(CONTEXT_STD,timeout,NULL);
 259     bool ret = (action == ACTION_STD_CANCEL);
 260     return ret;
 261 }
 262
 263 #ifndef HAS_BUTTON_HOLD
 264 bool is_keys_locked(void)
 265 {
 266     return (screen_has_lock && (keys_locked == true));
 267 }
 268 #endif
 269
 270 intptr_t get_action_data(void)
 271 {
 272     return last_data;
 273 }
 274
 275 int get_action_statuscode(int *button)
 276 {
 277     int ret = 0;
 278     if (button)
 279         *button = last_button;
 280
 281     if (last_button & BUTTON_REMOTE)
 282         ret |= ACTION_REMOTE;
 283     if (repeated)
 284         ret |= ACTION_REPEAT;
 285     return ret;
 286 }
 287
 288 #ifdef HAVE_TOUCHSCREEN
 289 /* return BUTTON_NONE               on error
 290  *        BUTTON_REPEAT             if repeated press
 291  *        BUTTON_REPEAT|BUTTON_REL  if release after repeated press
 292  *        BUTTON_REL                if its a short press = release after press
 293  *        BUTTON_TOUCHSCREEN        if press
 294  */
 295 int action_get_touchscreen_press(short *x, short *y)
 296 {
 297     static int last_data = 0;
 298     int data;
 299     if ((last_button & BUTTON_TOUCHSCREEN) == 0)
 300         return BUTTON_NONE;
 301     data = button_get_data();
 302     if (last_button & BUTTON_REL)
 303     {
 304         *x = (last_data&0xffff0000)>>16;
 305         *y = (last_data&0xffff);
 306     }
 307     else
 308     {
 309         *x = (data&0xffff0000)>>16;
 310         *y = (data&0xffff);
 311     }
 312     last_data = data;
 313     if (repeated)
 314         return BUTTON_REPEAT;
 315     if (short_press)
 316         return BUTTON_REL;
 317     /* This is to return a BUTTON_REL after a BUTTON_REPEAT. */
 318     if (last_button & BUTTON_REL)
 319         return BUTTON_REPEAT|BUTTON_REL;
 320     return BUTTON_TOUCHSCREEN;
 321 }
 322 #endif