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 #include "misc.h"
  37 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
  38 #include "language.h"
  39 #endif
  40 #include "viewport.h"
  41
  42 static int last_button = BUTTON_NONE|BUTTON_REL; /* allow the ipod wheel to
  43                                                     work on startup */
  44 static intptr_t last_data = 0;
  45 static int last_action = ACTION_NONE;
  46 static bool repeated = false;
  47 static bool wait_for_release = false;
  48
  49 #ifdef HAVE_TOUCHSCREEN
  50 static bool short_press = false;
  51 #endif
  52
  53 #define REPEAT_WINDOW_TICKS HZ/10
  54 static int last_action_tick = 0;
  55
  56 /* software keylock stuff */
  57 #ifndef HAS_BUTTON_HOLD
  58 static bool keys_locked = false;
  59 static int unlock_combo = BUTTON_NONE;
  60 static bool screen_has_lock = false;
  61 #endif /* HAVE_SOFTWARE_KEYLOCK */
  62
  63 /*
  64  * do_button_check is the worker function for get_default_action.
  65  * returns ACTION_UNKNOWN or the requested return value from the list.
  66  */
  67 static inline int do_button_check(const struct button_mapping *items,
  68                                   int button, int last_button, int *start)
  69 {
  70     int i = 0;
  71     int ret = ACTION_UNKNOWN;
  72
  73     while (items[i].button_code != BUTTON_NONE)
  74     {
  75         if (items[i].button_code == button)
  76         {
  77             if ((items[i].pre_button_code == BUTTON_NONE)
  78                 || (items[i].pre_button_code == last_button))
  79             {
  80                 ret = items[i].action_code;
  81                 break;
  82             }
  83         }
  84         i++;
  85     }
  86     *start = i;
  87     return ret;
  88 }
  89
  90 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
  91 /*
  92  * button is horizontally inverted to support RTL language if the given language
  93  * and context combination require that
  94  */
  95 static int button_flip_horizontally(int context, int button)
  96 {
  97     int newbutton;
  98
  99     if (!(lang_is_rtl() && ((context == CONTEXT_STD) ||
 100         (context == CONTEXT_TREE) || (context == CONTEXT_LIST) ||
 101         (context == CONTEXT_MAINMENU))))
 102     {
 103         return button;
 104     }
 105
 106     newbutton = button &
 107         ~(BUTTON_LEFT | BUTTON_RIGHT
 108 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD) && \
 109     !defined(SIMULATOR)
 110         | BUTTON_SCROLL_BACK | BUTTON_SCROLL_FWD
 111 #endif
 112         );
 113
 114     if (button & BUTTON_LEFT)
 115         newbutton |= BUTTON_RIGHT;
 116     if (button & BUTTON_RIGHT)
 117         newbutton |= BUTTON_LEFT;
 118 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD) && \
 119     !defined(SIMULATOR)
 120     if (button & BUTTON_SCROLL_BACK)
 121         newbutton |= BUTTON_SCROLL_FWD;
 122     if (button & BUTTON_SCROLL_FWD)
 123         newbutton |= BUTTON_SCROLL_BACK;
 124 #endif
 125
 126     return newbutton;
 127 }
 128 #endif
 129
 130 static inline int get_next_context(const struct button_mapping *items, int i)
 131 {
 132     while (items[i].button_code != BUTTON_NONE)
 133         i++;
 134     return (items[i].action_code == ACTION_NONE ) ?
 135             CONTEXT_STD :
 136             items[i].action_code;
 137 }
 138 /*
 139  * int get_action_worker(int context, struct button_mapping *user_mappings,
 140    int timeout)
 141    This function searches the button list for the given context for the just
 142    pressed button.
 143    If there is a match it returns the value from the list.
 144    If there is no match..
 145         the last item in the list "points" to the next context in a chain
 146         so the "chain" is followed until the button is found.
 147         putting ACTION_NONE will get CONTEXT_STD which is always the last list checked.
 148
 149    Timeout can be TIMEOUT_NOBLOCK to return immediatly
 150                   TIMEOUT_BLOCK   to wait for a button press
 151    Any number >0   to wait that many ticks for a press
 152  */
 153 static int get_action_worker(int context, int timeout,
 154                              const struct button_mapping* (*get_context_map)(int) )
 155 {
 156     const struct button_mapping *items = NULL;
 157     int button;
 158     int i=0;
 159     int ret = ACTION_UNKNOWN;
 160     static int last_context = CONTEXT_STD;
 161
 162
 163     send_event(GUI_EVENT_ACTIONUPDATE, NULL);
 164
 165     if (timeout == TIMEOUT_NOBLOCK)
 166         button = button_get(false);
 167     else if  (timeout == TIMEOUT_BLOCK)
 168         button = button_get(true);
 169     else
 170         button = button_get_w_tmo(timeout);
 171
 172     /* Data from sys events can be pulled with button_get_data */
 173     if (button == BUTTON_NONE || button & SYS_EVENT)
 174         return button;
 175     /* Don't send any buttons through untill we see the release event */
 176     if (wait_for_release)
 177     {
 178         if (button&BUTTON_REL)
 179         {
 180             wait_for_release = false;
 181         }
 182         return ACTION_NONE;
 183     }
 184
 185
 186 #if CONFIG_CODEC == SWCODEC
 187     /* Produce keyclick */
 188     if (global_settings.keyclick && !(button & BUTTON_REL))
 189         if (!(button & BUTTON_REPEAT) || global_settings.keyclick_repeats)
 190             pcmbuf_beep(4000, KEYCLICK_DURATION, 2500*global_settings.keyclick);
 191 #endif
 192
 193     if ((context != last_context) && ((last_button & BUTTON_REL) == 0))
 194     {
 195         if (button & BUTTON_REL)
 196         {
 197             last_button = button;
 198             last_action = ACTION_NONE;
 199         }
 200         /* eat all buttons until the previous button was |BUTTON_REL
 201            (also eat the |BUTTON_REL button) */
 202         return ACTION_NONE; /* "safest" return value */
 203     }
 204     last_context = context;
 205 #ifndef HAS_BUTTON_HOLD
 206     screen_has_lock = ((context & ALLOW_SOFTLOCK) == ALLOW_SOFTLOCK);
 207     if (screen_has_lock && keys_locked)
 208     {
 209         if (button == unlock_combo)
 210         {
 211             last_button = BUTTON_NONE;
 212             keys_locked = false;
 213             splash(HZ/2, str(LANG_KEYLOCK_OFF));
 214             return ACTION_REDRAW;
 215         }
 216         else
 217 #if (BUTTON_REMOTE != 0)
 218             if ((button & BUTTON_REMOTE) == 0)
 219 #endif
 220         {
 221             if ((button & BUTTON_REL))
 222                 splash(HZ/2, str(LANG_KEYLOCK_ON));
 223             return ACTION_REDRAW;
 224         }
 225     }
 226     context &= ~ALLOW_SOFTLOCK;
 227 #endif /* HAS_BUTTON_HOLD */
 228
 229 #ifdef HAVE_TOUCHSCREEN
 230     if (button & BUTTON_TOUCHSCREEN)
 231     {
 232         repeated = false;
 233         short_press = false;
 234         if (last_button & BUTTON_TOUCHSCREEN)
 235         {
 236             if ((button & BUTTON_REL) &&
 237                 ((last_button & BUTTON_REPEAT)==0))
 238             {
 239                 short_press = true;
 240             }
 241             else if (button & BUTTON_REPEAT)
 242                 repeated = true;
 243         }
 244         last_button = button;
 245         return ACTION_TOUCHSCREEN;
 246     }
 247 #endif
 248
 249 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
 250     button = button_flip_horizontally(context, button);
 251 #endif
 252
 253     /*   logf("%x,%x",last_button,button); */
 254     while (1)
 255     {
 256         /*     logf("context = %x",context); */
 257 #if (BUTTON_REMOTE != 0)
 258         if (button & BUTTON_REMOTE)
 259             context |= CONTEXT_REMOTE;
 260 #endif
 261         if ((context & CONTEXT_PLUGIN) && get_context_map)
 262             items = get_context_map(context);
 263         else
 264             items = get_context_mapping(context);
 265
 266         if (items == NULL)
 267             break;
 268
 269         ret = do_button_check(items,button,last_button,&i);
 270
 271         if (ret == ACTION_UNKNOWN)
 272         {
 273             context = get_next_context(items,i);
 274
 275             if (context != (int)CONTEXT_STOPSEARCHING)
 276             {
 277                 i = 0;
 278                 continue;
 279             }
 280         }
 281
 282         /* Action was found or STOPSEARCHING was specified */
 283         break;
 284     }
 285     /* DEBUGF("ret = %x\n",ret); */
 286 #ifndef HAS_BUTTON_HOLD
 287     if (screen_has_lock && (ret == ACTION_STD_KEYLOCK))
 288     {
 289         unlock_combo = button;
 290         keys_locked = true;
 291         splash(HZ/2, str(LANG_KEYLOCK_ON));
 292
 293         button_clear_queue();
 294         return ACTION_REDRAW;
 295     }
 296 #endif
 297     if ((current_tick - last_action_tick < REPEAT_WINDOW_TICKS)
 298          && (ret == last_action))
 299         repeated = true;
 300     else
 301         repeated = false;
 302
 303     last_button = button;
 304     last_action = ret;
 305     last_data   = button_get_data();
 306     last_action_tick = current_tick;
 307     return ret;
 308 }
 309
 310 int get_action(int context, int timeout)
 311 {
 312     return get_action_worker(context,timeout,NULL);
 313 }
 314
 315 int get_custom_action(int context,int timeout,
 316                       const struct button_mapping* (*get_context_map)(int))
 317 {
 318     return get_action_worker(context,timeout,get_context_map);
 319 }
 320
 321 bool action_userabort(int timeout)
 322 {
 323     int action = get_action_worker(CONTEXT_STD,timeout,NULL);
 324     bool ret = (action == ACTION_STD_CANCEL);
 325     if(!ret)
 326     {
 327         default_event_handler(action);
 328     }
 329     return ret;
 330 }
 331
 332 #ifndef HAS_BUTTON_HOLD
 333 bool is_keys_locked(void)
 334 {
 335     return (screen_has_lock && keys_locked);
 336 }
 337 #endif
 338
 339 intptr_t get_action_data(void)
 340 {
 341     return last_data;
 342 }
 343
 344 int get_action_statuscode(int *button)
 345 {
 346     int ret = 0;
 347     if (button)
 348         *button = last_button;
 349
 350     if (last_button & BUTTON_REMOTE)
 351         ret |= ACTION_REMOTE;
 352     if (repeated)
 353         ret |= ACTION_REPEAT;
 354     return ret;
 355 }
 356
 357 #ifdef HAVE_TOUCHSCREEN
 358 /* return BUTTON_NONE               on error
 359  *        BUTTON_REPEAT             if repeated press
 360  *        BUTTON_REPEAT|BUTTON_REL  if release after repeated press
 361  *        BUTTON_REL                if its a short press = release after press
 362  *        BUTTON_TOUCHSCREEN        if press
 363  */
 364 int action_get_touchscreen_press(short *x, short *y)
 365 {
 366     static int last_data = 0;
 367     int data;
 368     if ((last_button & BUTTON_TOUCHSCREEN) == 0)
 369         return BUTTON_NONE;
 370     data = button_get_data();
 371     if (last_button & BUTTON_REL)
 372     {
 373         *x = (last_data&0xffff0000)>>16;
 374         *y = (last_data&0xffff);
 375     }
 376     else
 377     {
 378         *x = (data&0xffff0000)>>16;
 379         *y = (data&0xffff);
 380     }
 381     last_data = data;
 382     if (repeated)
 383         return BUTTON_REPEAT;
 384     if (short_press)
 385         return BUTTON_REL;
 386     /* This is to return a BUTTON_REL after a BUTTON_REPEAT. */
 387     if (last_button & BUTTON_REL)
 388         return BUTTON_REPEAT|BUTTON_REL;
 389     return BUTTON_TOUCHSCREEN;
 390 }
 391
 392 int action_get_touchscreen_press_in_vp(short *x1, short *y1, struct viewport *vp)
 393 {
 394     short x, y;
 395     int ret;
 396
 397     ret = action_get_touchscreen_press(&x, &y);
 398
 399     if (ret != BUTTON_NONE && viewport_point_within_vp(vp, x, y))
 400     {
 401         *x1 = x - vp->x;
 402         *y1 = y - vp->y;
 403         return ret;
 404     }
 405     if (ret & BUTTON_TOUCHSCREEN)
 406         return ACTION_UNKNOWN;
 407     return BUTTON_NONE;
 408 }
 409 #endif
 410
 411 /* Don't let get_action*() return any ACTION_* values untill the current buttons
 412  * have ben release. SYS_* and BUTTON_NONE will go through.
 413  * Any actions relying on _RELEASE won't get seen
 414  */
 415 void action_wait_for_release(void)
 416 {
 417     wait_for_release = true;
 418 }
 419