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     /* the special redraw button should result in a screen refresh */
 237     if (button == BUTTON_REDRAW)
 238         return ACTION_REDRAW;
 239
 240     /* Don't send any buttons through untill we see the release event */
 241     if (wait_for_release)
 242     {
 243         if (button&BUTTON_REL)
 244         {
 245             /* remember the button for the below button eating on context
 246              * change */
 247             last_button = button;
 248             wait_for_release = false;
 249         }
 250         return ACTION_NONE;
 251     }
 252
 253     if ((context != last_context) && ((last_button & BUTTON_REL) == 0)
 254 #ifdef HAVE_SCROLLWHEEL
 255         /* Scrollwheel doesn't generate release events  */
 256         && !(last_button & (BUTTON_SCROLL_BACK | BUTTON_SCROLL_FWD))
 257 #endif
 258         )
 259     {
 260         if (button & BUTTON_REL)
 261         {
 262             last_button = button;
 263             last_action = ACTION_NONE;
 264         }
 265         /* eat all buttons until the previous button was |BUTTON_REL
 266            (also eat the |BUTTON_REL button) */
 267         return ACTION_NONE; /* "safest" return value */
 268     }
 269     last_context = context;
 270 #ifndef HAS_BUTTON_HOLD
 271     screen_has_lock = ((context & ALLOW_SOFTLOCK) == ALLOW_SOFTLOCK);
 272     if (is_keys_locked())
 273     {
 274         if (button == unlock_combo)
 275         {
 276             last_button = BUTTON_NONE;
 277             keys_locked = false;
 278             splash(HZ/2, str(LANG_KEYLOCK_OFF));
 279             return ACTION_REDRAW;
 280         }
 281         else
 282 #if (BUTTON_REMOTE != 0)
 283             if ((button & BUTTON_REMOTE) == 0)
 284 #endif
 285         {
 286             if ((button & BUTTON_REL))
 287                 splash(HZ/2, str(LANG_KEYLOCK_ON));
 288             return ACTION_REDRAW;
 289         }
 290     }
 291     context &= ~ALLOW_SOFTLOCK;
 292 #endif /* HAS_BUTTON_HOLD */
 293
 294 #ifdef HAVE_TOUCHSCREEN
 295     if (button & BUTTON_TOUCHSCREEN)
 296     {
 297         repeated = false;
 298         short_press = false;
 299         if (last_button & BUTTON_TOUCHSCREEN)
 300         {
 301             if ((button & BUTTON_REL) &&
 302                 ((last_button & BUTTON_REPEAT)==0))
 303             {
 304                 short_press = true;
 305             }
 306             else if (button & BUTTON_REPEAT)
 307                 repeated = true;
 308         }
 309         last_button = button;
 310         return ACTION_TOUCHSCREEN;
 311     }
 312 #endif
 313
 314 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
 315     button = button_flip_horizontally(context, button);
 316 #endif
 317
 318     /*   logf("%x,%x",last_button,button); */
 319     while (1)
 320     {
 321         /*     logf("context = %x",context); */
 322 #if (BUTTON_REMOTE != 0)
 323         if (button & BUTTON_REMOTE)
 324             context |= CONTEXT_REMOTE;
 325 #endif
 326         if ((context & CONTEXT_PLUGIN) && get_context_map)
 327             items = get_context_map(context);
 328         else
 329             items = get_context_mapping(context);
 330
 331         if (items == NULL)
 332             break;
 333
 334         ret = do_button_check(items,button,last_button,&i);
 335
 336         if (ret == ACTION_UNKNOWN)
 337         {
 338             context = get_next_context(items,i);
 339
 340             if (context != (int)CONTEXT_STOPSEARCHING)
 341             {
 342                 i = 0;
 343                 continue;
 344             }
 345         }
 346
 347         /* Action was found or STOPSEARCHING was specified */
 348         break;
 349     }
 350     /* DEBUGF("ret = %x\n",ret); */
 351 #ifndef HAS_BUTTON_HOLD
 352     if (screen_has_lock && (ret == ACTION_STD_KEYLOCK))
 353     {
 354         unlock_combo = button;
 355         keys_locked = true;
 356         splash(HZ/2, str(LANG_KEYLOCK_ON));
 357
 358         button_clear_queue();
 359         return ACTION_REDRAW;
 360     }
 361 #endif
 362     if ((current_tick - last_action_tick < REPEAT_WINDOW_TICKS)
 363          && (ret == last_action))
 364         repeated = true;
 365     else
 366         repeated = false;
 367
 368     last_button = button;
 369     last_action = ret;
 370     last_data   = button_get_data();
 371     last_action_tick = current_tick;
 372
 373 #if CONFIG_CODEC == SWCODEC
 374     /* Produce keyclick */
 375     keyclick_click(false, ret);
 376 #endif
 377
 378     return ret;
 379 }
 380
 381 int get_action(int context, int timeout)
 382 {
 383     int button = get_action_worker(context,timeout,NULL);
 384 #ifdef HAVE_TOUCHSCREEN
 385     if (button == ACTION_TOUCHSCREEN)
 386         button = sb_touch_to_button(context);
 387 #endif
 388     return button;
 389 }
 390
 391 int get_custom_action(int context,int timeout,
 392                       const struct button_mapping* (*get_context_map)(int))
 393 {
 394     return get_action_worker(context,timeout,get_context_map);
 395 }
 396
 397 bool action_userabort(int timeout)
 398 {
 399     int action = get_action_worker(CONTEXT_STD,timeout,NULL);
 400     bool ret = (action == ACTION_STD_CANCEL);
 401     if(!ret)
 402     {
 403         default_event_handler(action);
 404     }
 405     return ret;
 406 }
 407
 408 #ifndef HAS_BUTTON_HOLD
 409 bool is_keys_locked(void)
 410 {
 411     return (screen_has_lock && keys_locked);
 412 }
 413 #endif
 414
 415 intptr_t get_action_data(void)
 416 {
 417     return last_data;
 418 }
 419
 420 int get_action_statuscode(int *button)
 421 {
 422     int ret = 0;
 423     if (button)
 424         *button = last_button;
 425
 426     if (last_button & BUTTON_REMOTE)
 427         ret |= ACTION_REMOTE;
 428     if (repeated)
 429         ret |= ACTION_REPEAT;
 430     return ret;
 431 }
 432
 433 #ifdef HAVE_TOUCHSCREEN
 434 /* return BUTTON_NONE               on error
 435  *        BUTTON_REPEAT             if repeated press
 436  *        BUTTON_REPEAT|BUTTON_REL  if release after repeated press
 437  *        BUTTON_REL                if it's a short press = release after press
 438  *        BUTTON_TOUCHSCREEN        if press
 439  */
 440 int action_get_touchscreen_press(short *x, short *y)
 441 {
 442     static int last_data = 0;
 443     int data;
 444     if ((last_button & BUTTON_TOUCHSCREEN) == 0)
 445         return BUTTON_NONE;
 446     data = button_get_data();
 447     if (last_button & BUTTON_REL)
 448     {
 449         *x = (last_data&0xffff0000)>>16;
 450         *y = (last_data&0xffff);
 451     }
 452     else
 453     {
 454         *x = (data&0xffff0000)>>16;
 455         *y = (data&0xffff);
 456     }
 457     last_data = data;
 458     if (repeated)
 459         return BUTTON_REPEAT;
 460     if (short_press)
 461         return BUTTON_REL;
 462     /* This is to return a BUTTON_REL after a BUTTON_REPEAT. */
 463     if (last_button & BUTTON_REL)
 464         return BUTTON_REPEAT|BUTTON_REL;
 465     return BUTTON_TOUCHSCREEN;
 466 }
 467
 468 int action_get_touchscreen_press_in_vp(short *x1, short *y1, struct viewport *vp)
 469 {
 470     short x, y;
 471     int ret;
 472
 473     ret = action_get_touchscreen_press(&x, &y);
 474
 475     if (ret != BUTTON_NONE && viewport_point_within_vp(vp, x, y))
 476     {
 477         *x1 = x - vp->x;
 478         *y1 = y - vp->y;
 479         return ret;
 480     }
 481     if (ret & BUTTON_TOUCHSCREEN)
 482         return ACTION_UNKNOWN;
 483     return BUTTON_NONE;
 484 }
 485 #endif
 486
 487 /* Don't let get_action*() return any ACTION_* values until the current buttons
 488  * have been released. SYS_* and BUTTON_NONE will go through.
 489  * Any actions relying on _RELEASE won't get seen.
 490  */
 491 void action_wait_for_release(void)
 492 {
 493     wait_for_release = true;
 494 }
 495