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