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  * int get_action_worker(int context, struct button_mapping *user_mappings,
 154    int timeout)
 155    This function searches the button list for the given context for the just
 156    pressed button.
 157    If there is a match it returns the value from the list.
 158    If there is no match..
 159         the last item in the list "points" to the next context in a chain
 160         so the "chain" is followed until the button is found.
 161         putting ACTION_NONE will get CONTEXT_STD which is always the last list checked.
 162
 163    Timeout can be TIMEOUT_NOBLOCK to return immediatly
 164                   TIMEOUT_BLOCK   to wait for a button press
 165    Any number >0   to wait that many ticks for a press
 166  */
 167 static int get_action_worker(int context, int timeout,
 168                              const struct button_mapping* (*get_context_map)(int) )
 169 {
 170     const struct button_mapping *items = NULL;
 171     int button;
 172     int i=0;
 173     int ret = ACTION_UNKNOWN;
 174     static int last_context = CONTEXT_STD;
 175
 176
 177     send_event(GUI_EVENT_ACTIONUPDATE, NULL);
 178
 179     if (timeout == TIMEOUT_NOBLOCK)
 180         button = button_get(false);
 181     else if  (timeout == TIMEOUT_BLOCK)
 182         button = button_get(true);
 183     else
 184         button = button_get_w_tmo(timeout);
 185
 186     /* Data from sys events can be pulled with button_get_data
 187      * multimedia button presses don't go through the action system */
 188     if (button == BUTTON_NONE || button & (SYS_EVENT|BUTTON_MULTIMEDIA))
 189         return button;
 190     /* Don't send any buttons through untill we see the release event */
 191     if (wait_for_release)
 192     {
 193         if (button&BUTTON_REL)
 194         {
 195             /* remember the button for the below button eating on context
 196              * change */
 197             last_button = button;
 198             wait_for_release = false;
 199         }
 200         return ACTION_NONE;
 201     }
 202
 203
 204 #if CONFIG_CODEC == SWCODEC
 205     /* Produce keyclick */
 206     if (global_settings.keyclick && !(button & BUTTON_REL))
 207         if (!(button & BUTTON_REPEAT) || global_settings.keyclick_repeats)
 208             pcmbuf_beep(4000, KEYCLICK_DURATION, 2500*global_settings.keyclick);
 209 #endif
 210
 211     if ((context != last_context) && ((last_button & BUTTON_REL) == 0)
 212 #ifdef HAVE_SCROLLWHEEL
 213         /* Scrollwheel doesn't generate release events  */
 214         && !(last_button & (BUTTON_SCROLL_BACK | BUTTON_SCROLL_FWD))
 215 #endif
 216         )
 217     {
 218         if (button & BUTTON_REL)
 219         {
 220             last_button = button;
 221             last_action = ACTION_NONE;
 222         }
 223         /* eat all buttons until the previous button was |BUTTON_REL
 224            (also eat the |BUTTON_REL button) */
 225         return ACTION_NONE; /* "safest" return value */
 226     }
 227     last_context = context;
 228 #ifndef HAS_BUTTON_HOLD
 229     screen_has_lock = ((context & ALLOW_SOFTLOCK) == ALLOW_SOFTLOCK);
 230     if (screen_has_lock && keys_locked)
 231     {
 232         if (button == unlock_combo)
 233         {
 234             last_button = BUTTON_NONE;
 235             keys_locked = false;
 236             splash(HZ/2, str(LANG_KEYLOCK_OFF));
 237             return ACTION_REDRAW;
 238         }
 239         else
 240 #if (BUTTON_REMOTE != 0)
 241             if ((button & BUTTON_REMOTE) == 0)
 242 #endif
 243         {
 244             if ((button & BUTTON_REL))
 245                 splash(HZ/2, str(LANG_KEYLOCK_ON));
 246             return ACTION_REDRAW;
 247         }
 248     }
 249     context &= ~ALLOW_SOFTLOCK;
 250 #endif /* HAS_BUTTON_HOLD */
 251
 252 #ifdef HAVE_TOUCHSCREEN
 253     if (button & BUTTON_TOUCHSCREEN)
 254     {
 255         repeated = false;
 256         short_press = false;
 257         if (last_button & BUTTON_TOUCHSCREEN)
 258         {
 259             if ((button & BUTTON_REL) &&
 260                 ((last_button & BUTTON_REPEAT)==0))
 261             {
 262                 short_press = true;
 263             }
 264             else if (button & BUTTON_REPEAT)
 265                 repeated = true;
 266         }
 267         last_button = button;
 268         return ACTION_TOUCHSCREEN;
 269     }
 270 #endif
 271
 272 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
 273     button = button_flip_horizontally(context, button);
 274 #endif
 275
 276     /*   logf("%x,%x",last_button,button); */
 277     while (1)
 278     {
 279         /*     logf("context = %x",context); */
 280 #if (BUTTON_REMOTE != 0)
 281         if (button & BUTTON_REMOTE)
 282             context |= CONTEXT_REMOTE;
 283 #endif
 284         if ((context & CONTEXT_PLUGIN) && get_context_map)
 285             items = get_context_map(context);
 286         else
 287             items = get_context_mapping(context);
 288
 289         if (items == NULL)
 290             break;
 291
 292         ret = do_button_check(items,button,last_button,&i);
 293
 294         if (ret == ACTION_UNKNOWN)
 295         {
 296             context = get_next_context(items,i);
 297
 298             if (context != (int)CONTEXT_STOPSEARCHING)
 299             {
 300                 i = 0;
 301                 continue;
 302             }
 303         }
 304
 305         /* Action was found or STOPSEARCHING was specified */
 306         break;
 307     }
 308     /* DEBUGF("ret = %x\n",ret); */
 309 #ifndef HAS_BUTTON_HOLD
 310     if (screen_has_lock && (ret == ACTION_STD_KEYLOCK))
 311     {
 312         unlock_combo = button;
 313         keys_locked = true;
 314         splash(HZ/2, str(LANG_KEYLOCK_ON));
 315
 316         button_clear_queue();
 317         return ACTION_REDRAW;
 318     }
 319 #endif
 320     if ((current_tick - last_action_tick < REPEAT_WINDOW_TICKS)
 321          && (ret == last_action))
 322         repeated = true;
 323     else
 324         repeated = false;
 325
 326     last_button = button;
 327     last_action = ret;
 328     last_data   = button_get_data();
 329     last_action_tick = current_tick;
 330     return ret;
 331 }
 332
 333 int get_action(int context, int timeout)
 334 {
 335     int button = get_action_worker(context,timeout,NULL);
 336 #ifdef HAVE_TOUCHSCREEN
 337     if (button == ACTION_TOUCHSCREEN)
 338         button = sb_touch_to_button(context);
 339 #endif
 340     return button;
 341 }
 342
 343 int get_custom_action(int context,int timeout,
 344                       const struct button_mapping* (*get_context_map)(int))
 345 {
 346     return get_action_worker(context,timeout,get_context_map);
 347 }
 348
 349 bool action_userabort(int timeout)
 350 {
 351     int action = get_action_worker(CONTEXT_STD,timeout,NULL);
 352     bool ret = (action == ACTION_STD_CANCEL);
 353     if(!ret)
 354     {
 355         default_event_handler(action);
 356     }
 357     return ret;
 358 }
 359
 360 #ifndef HAS_BUTTON_HOLD
 361 bool is_keys_locked(void)
 362 {
 363     return (screen_has_lock && keys_locked);
 364 }
 365 #endif
 366
 367 intptr_t get_action_data(void)
 368 {
 369     return last_data;
 370 }
 371
 372 int get_action_statuscode(int *button)
 373 {
 374     int ret = 0;
 375     if (button)
 376         *button = last_button;
 377
 378     if (last_button & BUTTON_REMOTE)
 379         ret |= ACTION_REMOTE;
 380     if (repeated)
 381         ret |= ACTION_REPEAT;
 382     return ret;
 383 }
 384
 385 #ifdef HAVE_TOUCHSCREEN
 386 /* return BUTTON_NONE               on error
 387  *        BUTTON_REPEAT             if repeated press
 388  *        BUTTON_REPEAT|BUTTON_REL  if release after repeated press
 389  *        BUTTON_REL                if it's a short press = release after press
 390  *        BUTTON_TOUCHSCREEN        if press
 391  */
 392 int action_get_touchscreen_press(short *x, short *y)
 393 {
 394     static int last_data = 0;
 395     int data;
 396     if ((last_button & BUTTON_TOUCHSCREEN) == 0)
 397         return BUTTON_NONE;
 398     data = button_get_data();
 399     if (last_button & BUTTON_REL)
 400     {
 401         *x = (last_data&0xffff0000)>>16;
 402         *y = (last_data&0xffff);
 403     }
 404     else
 405     {
 406         *x = (data&0xffff0000)>>16;
 407         *y = (data&0xffff);
 408     }
 409     last_data = data;
 410     if (repeated)
 411         return BUTTON_REPEAT;
 412     if (short_press)
 413         return BUTTON_REL;
 414     /* This is to return a BUTTON_REL after a BUTTON_REPEAT. */
 415     if (last_button & BUTTON_REL)
 416         return BUTTON_REPEAT|BUTTON_REL;
 417     return BUTTON_TOUCHSCREEN;
 418 }
 419
 420 int action_get_touchscreen_press_in_vp(short *x1, short *y1, struct viewport *vp)
 421 {
 422     short x, y;
 423     int ret;
 424
 425     ret = action_get_touchscreen_press(&x, &y);
 426
 427     if (ret != BUTTON_NONE && viewport_point_within_vp(vp, x, y))
 428     {
 429         *x1 = x - vp->x;
 430         *y1 = y - vp->y;
 431         return ret;
 432     }
 433     if (ret & BUTTON_TOUCHSCREEN)
 434         return ACTION_UNKNOWN;
 435     return BUTTON_NONE;
 436 }
 437 #endif
 438
 439 /* Don't let get_action*() return any ACTION_* values until the current buttons
 440  * have been released. SYS_* and BUTTON_NONE will go through.
 441  * Any actions relying on _RELEASE won't get seen.
 442  */
 443 void action_wait_for_release(void)
 444 {
 445     wait_for_release = true;
 446 }
 447