apps/action.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  *
   9  * Copyright (C) 2004 Brent Coutts
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  17  * KIND, either express or implied.
  18  *
  19  ****************************************************************************/
  20 #ifndef __ACTION_H__
  21 #define __ACTION_H__
  22
  23 #include "stdbool.h"
  24 #include "button.h"
  25 #include "viewport.h"
  26
  27 #define TIMEOUT_BLOCK   -1
  28 #define TIMEOUT_NOBLOCK  0
  29
  30 #define CONTEXT_STOPSEARCHING 0xFFFFFFFF
  31 #define CONTEXT_REMOTE  0x80000000 /* | this against another context to get remote buttons for that context */
  32 #define CONTEXT_CUSTOM  0x40000000 /* | this against anything to get your context number */
  33 #define CONTEXT_CUSTOM2 0x20000000 /* as above */
  34 #define CONTEXT_PLUGIN  0x10000000 /* for plugins using get_custom_action */
  35
  36 #define LAST_ITEM_IN_LIST { CONTEXT_STOPSEARCHING, BUTTON_NONE, BUTTON_NONE }
  37 #define LAST_ITEM_IN_LIST__NEXTLIST(a) { a, BUTTON_NONE, BUTTON_NONE }
  38
  39 #ifndef HAS_BUTTON_HOLD
  40 #define ALLOW_SOFTLOCK 0x08000000 /* will be stripped.. never needed except in calls to get_action() */
  41 #else
  42 #define ALLOW_SOFTLOCK 0
  43 #endif
  44
  45 enum {
  46     CONTEXT_STD = 0,
  47     /* These CONTEXT_ values were here before me,
  48     there values may have significance, so dont touch! */
  49     CONTEXT_WPS = 1,
  50     CONTEXT_TREE = 2,
  51     CONTEXT_RECORD = 3,
  52     CONTEXT_MAINMENU = 4, /* uses CONTEXT_TREE and ACTION_TREE_* */
  53     CONTEXT_ID3DB = 5,
  54     /* Add new contexts here, no need to explicitly define a value for them */
  55     CONTEXT_LIST,
  56     CONTEXT_SETTINGS, /* regular setting screens (and debug screens) */
  57     /* bellow are setting screens which may need to redefine the standard
  58        setting screen keys, targets should return the CONTEXT_SETTINGS
  59        keymap unless they are not adequate for the screen
  60     NOTE: uses ACTION_STD_[NEXT|PREV] so make sure they are there also
  61           and (possibly) ACTION_SETTINGS_[INC|DEC] */
  62     CONTEXT_SETTINGS_EQ,
  63     CONTEXT_SETTINGS_COLOURCHOOSER,
  64     CONTEXT_SETTINGS_TIME,
  65     CONTEXT_SETTINGS_RECTRIGGER,
  66
  67     /* The following contexts should use ACTION_STD_[NEXT|PREV]
  68         and (possibly) ACTION_SETTINGS_[INC|DEC]
  69        Also add any extra actions they need                        */
  70     CONTEXT_BOOKMARKSCREEN, /* uses ACTION_BMS_ defines */
  71     CONTEXT_ALARMSCREEN, /* uses ACTION_AS_ defines */
  72     CONTEXT_QUICKSCREEN, /* uses ACTION_QS_ defines below */
  73     CONTEXT_PITCHSCREEN, /* uses ACTION_PS_ defines below */
  74
  75     CONTEXT_YESNOSCREEN, /*NOTE: make sure your target has this and ACTION_YESNO_ACCEPT */
  76     CONTEXT_RECSCREEN,
  77     CONTEXT_KEYBOARD,
  78     CONTEXT_MORSE_INPUT,
  79     CONTEXT_FM,
  80     CONTEXT_USB_HID,
  81     CONTEXT_USB_HID_MODE_MULTIMEDIA,
  82     CONTEXT_USB_HID_MODE_PRESENTATION,
  83     CONTEXT_USB_HID_MODE_BROWSER,
  84     CONTEXT_USB_HID_MODE_MOUSE,
  85 };
  86
  87
  88 enum {
  89
  90     ACTION_NONE = BUTTON_NONE,
  91     ACTION_UNKNOWN,
  92     ACTION_REDRAW, /* returned if keys are locked and we splash()'ed */
  93     ACTION_TOUCHSCREEN,
  94     ACTION_TOUCHSCREEN_MODE, /* toggle the touchscreen mode */
  95
  96     /* standard actions, use these first */
  97     ACTION_STD_PREV,
  98     ACTION_STD_PREVREPEAT,
  99     ACTION_STD_NEXT,
 100     ACTION_STD_NEXTREPEAT,
 101
 102     ACTION_STD_OK,
 103     ACTION_STD_CANCEL,
 104     ACTION_STD_CONTEXT,
 105     ACTION_STD_MENU,
 106     ACTION_STD_QUICKSCREEN,
 107     ACTION_STD_KEYLOCK,
 108     ACTION_STD_REC,
 109
 110     ACTION_F3, /* just so everything works again, possibly change me */
 111     /* code context actions */
 112
 113     /* WPS codes */
 114     ACTION_WPS_BROWSE,
 115     ACTION_WPS_PLAY,
 116     ACTION_WPS_SEEKBACK,
 117     ACTION_WPS_SEEKFWD,
 118     ACTION_WPS_STOPSEEK,
 119     ACTION_WPS_SKIPNEXT,
 120     ACTION_WPS_SKIPPREV,
 121     ACTION_WPS_STOP,
 122     ACTION_WPS_VOLDOWN,
 123     ACTION_WPS_VOLUP,
 124     ACTION_WPS_PITCHSCREEN,/* optional */
 125     ACTION_WPS_ID3SCREEN,/* optional */
 126     ACTION_WPS_CONTEXT,
 127     ACTION_WPS_QUICKSCREEN,/* optional */
 128     ACTION_WPS_MENU, /*this should be the same as ACTION_STD_MENU */
 129     ACTION_WPS_VIEW_PLAYLIST,
 130     ACTION_WPS_REC,
 131 #if 0
 132     ACTION_WPSAB_SINGLE, /* This needs to be #defined in
 133                             the config-<target>.h to one of the ACTION_WPS_ actions
 134                             so it can be used */
 135 #endif
 136     ACTION_WPS_ABSETA_PREVDIR, /* these should be safe to put together seen as */
 137     ACTION_WPS_ABSETB_NEXTDIR, /* you shouldnt want to change dir in ab-mode */
 138     ACTION_WPS_ABRESET,
 139     ACTION_WPS_HOTKEY,
 140
 141     /* list and tree page up/down */
 142     ACTION_LISTTREE_PGUP,/* optional */
 143     ACTION_LISTTREE_PGDOWN,/* optional */
 144 #ifdef HAVE_VOLUME_IN_LIST
 145     ACTION_LIST_VOLUP,
 146     ACTION_LIST_VOLDOWN,
 147 #endif
 148
 149     /* tree */
 150     ACTION_TREE_ROOT_INIT,
 151     ACTION_TREE_PGLEFT,/* optional */
 152     ACTION_TREE_PGRIGHT,/* optional */
 153     ACTION_TREE_STOP,
 154     ACTION_TREE_WPS,
 155     ACTION_TREE_HOTKEY,
 156
 157     /* radio */
 158     ACTION_FM_MENU,
 159     ACTION_FM_PRESET,
 160     ACTION_FM_QUICKSCREEN,
 161     ACTION_FM_RECORD,
 162     ACTION_FM_FREEZE,
 163     ACTION_FM_STOP,
 164     ACTION_FM_MODE,
 165     ACTION_FM_EXIT,
 166     ACTION_FM_PLAY,
 167     ACTION_FM_RECORD_DBLPRE,
 168     ACTION_FM_NEXT_PRESET,
 169     ACTION_FM_PREV_PRESET,
 170
 171     /* recording screen */
 172     ACTION_REC_LCD,
 173     ACTION_REC_PAUSE,
 174     ACTION_REC_NEWFILE,
 175     ACTION_REC_F2,
 176     ACTION_REC_F3,
 177
 178     /* main menu */
 179     /* These are not strictly actions, but must be here
 180        so they dont conflict with real actions in the menu code */
 181     ACTION_REQUEST_MENUITEM,
 182     ACTION_EXIT_MENUITEM,
 183     ACTION_EXIT_AFTER_THIS_MENUITEM, /* if a menu returns this the menu will exit
 184                                         once the subitem returns */
 185     ACTION_ENTER_MENUITEM,
 186
 187     /* id3db */
 188
 189     /* list */
 190
 191     /* settings */
 192     ACTION_SETTINGS_INC,
 193     ACTION_SETTINGS_INCREPEAT,
 194     ACTION_SETTINGS_INCBIGSTEP,
 195     ACTION_SETTINGS_DEC,
 196     ACTION_SETTINGS_DECREPEAT,
 197     ACTION_SETTINGS_DECBIGSTEP,
 198     ACTION_SETTINGS_RESET,
 199
 200     /* bookmark screen */
 201     ACTION_BMS_DELETE,
 202
 203     /* quickscreen */
 204     ACTION_QS_LEFT,
 205     ACTION_QS_RIGHT,
 206     ACTION_QS_DOWN,
 207     ACTION_QS_TOP,
 208
 209     /* pitchscreen */
 210     /* obviously ignore if you dont have thise screen */
 211     ACTION_PS_INC_SMALL,
 212     ACTION_PS_INC_BIG,
 213     ACTION_PS_DEC_SMALL,
 214     ACTION_PS_DEC_BIG,
 215     ACTION_PS_NUDGE_LEFT,
 216     ACTION_PS_NUDGE_RIGHT,
 217     ACTION_PS_NUDGE_LEFTOFF,
 218     ACTION_PS_NUDGE_RIGHTOFF,
 219     ACTION_PS_TOGGLE_MODE,
 220     ACTION_PS_RESET,
 221     ACTION_PS_EXIT, /* _STD_* isnt going to work here */
 222     ACTION_PS_SLOWER,
 223     ACTION_PS_FASTER,
 224
 225     /* yesno screen */
 226     ACTION_YESNO_ACCEPT,
 227
 228     /* keyboard screen */
 229     ACTION_KBD_LEFT,
 230     ACTION_KBD_RIGHT,
 231     ACTION_KBD_CURSOR_LEFT,
 232     ACTION_KBD_CURSOR_RIGHT,
 233     ACTION_KBD_SELECT,
 234     ACTION_KBD_PAGE_FLIP,
 235     ACTION_KBD_DONE,
 236     ACTION_KBD_ABORT,
 237     ACTION_KBD_BACKSPACE,
 238     ACTION_KBD_UP,
 239     ACTION_KBD_DOWN,
 240     ACTION_KBD_MORSE_INPUT,
 241     ACTION_KBD_MORSE_SELECT,
 242
 243 #ifdef HAVE_TOUCHSCREEN
 244     /* the following are helper actions for touchscreen targets,
 245      * These are for actions which are not doable or required if buttons are
 246      * being used, but are nice additions if the touchscreen is used */
 247     ACTION_TOUCH_SHUFFLE,
 248     ACTION_TOUCH_REPMODE,
 249 #endif
 250
 251     /* USB HID codes */
 252     ACTION_USB_HID_FIRST, /* Place holder */
 253     ACTION_USB_HID_NONE,
 254     ACTION_USB_HID_MODE_SWITCH_NEXT,
 255     ACTION_USB_HID_MODE_SWITCH_PREV,
 256     ACTION_USB_HID_MULTIMEDIA_VOLUME_UP,
 257     ACTION_USB_HID_MULTIMEDIA_VOLUME_DOWN,
 258     ACTION_USB_HID_MULTIMEDIA_VOLUME_MUTE,
 259     ACTION_USB_HID_MULTIMEDIA_PLAYBACK_PLAY_PAUSE,
 260     ACTION_USB_HID_MULTIMEDIA_PLAYBACK_STOP,
 261     ACTION_USB_HID_MULTIMEDIA_PLAYBACK_TRACK_PREV,
 262     ACTION_USB_HID_MULTIMEDIA_PLAYBACK_TRACK_NEXT,
 263     ACTION_USB_HID_PRESENTATION_SLIDESHOW_START,
 264     ACTION_USB_HID_PRESENTATION_SLIDESHOW_LEAVE,
 265     ACTION_USB_HID_PRESENTATION_SLIDE_PREV,
 266     ACTION_USB_HID_PRESENTATION_SLIDE_NEXT,
 267     ACTION_USB_HID_PRESENTATION_SLIDE_FIRST,
 268     ACTION_USB_HID_PRESENTATION_SLIDE_LAST,
 269     ACTION_USB_HID_PRESENTATION_SCREEN_BLACK,
 270     ACTION_USB_HID_PRESENTATION_SCREEN_WHITE,
 271     ACTION_USB_HID_PRESENTATION_LINK_PREV,
 272     ACTION_USB_HID_PRESENTATION_LINK_NEXT,
 273     ACTION_USB_HID_PRESENTATION_MOUSE_CLICK,
 274     ACTION_USB_HID_PRESENTATION_MOUSE_OVER,
 275     ACTION_USB_HID_BROWSER_SCROLL_UP,
 276     ACTION_USB_HID_BROWSER_SCROLL_DOWN,
 277     ACTION_USB_HID_BROWSER_SCROLL_PAGE_DOWN,
 278     ACTION_USB_HID_BROWSER_SCROLL_PAGE_UP,
 279     ACTION_USB_HID_BROWSER_ZOOM_IN,
 280     ACTION_USB_HID_BROWSER_ZOOM_OUT,
 281     ACTION_USB_HID_BROWSER_ZOOM_RESET,
 282     ACTION_USB_HID_BROWSER_TAB_PREV,
 283     ACTION_USB_HID_BROWSER_TAB_NEXT,
 284     ACTION_USB_HID_BROWSER_TAB_CLOSE,
 285     ACTION_USB_HID_BROWSER_HISTORY_BACK,
 286     ACTION_USB_HID_BROWSER_HISTORY_FORWARD,
 287     ACTION_USB_HID_BROWSER_VIEW_FULL_SCREEN,
 288     ACTION_USB_HID_MOUSE_UP,
 289     ACTION_USB_HID_MOUSE_UP_REP,
 290     ACTION_USB_HID_MOUSE_DOWN,
 291     ACTION_USB_HID_MOUSE_DOWN_REP,
 292     ACTION_USB_HID_MOUSE_LEFT,
 293     ACTION_USB_HID_MOUSE_LEFT_REP,
 294     ACTION_USB_HID_MOUSE_RIGHT,
 295     ACTION_USB_HID_MOUSE_RIGHT_REP,
 296     ACTION_USB_HID_MOUSE_LDRAG_UP,
 297     ACTION_USB_HID_MOUSE_LDRAG_UP_REP,
 298     ACTION_USB_HID_MOUSE_LDRAG_DOWN,
 299     ACTION_USB_HID_MOUSE_LDRAG_DOWN_REP,
 300     ACTION_USB_HID_MOUSE_LDRAG_LEFT,
 301     ACTION_USB_HID_MOUSE_LDRAG_LEFT_REP,
 302     ACTION_USB_HID_MOUSE_LDRAG_RIGHT,
 303     ACTION_USB_HID_MOUSE_LDRAG_RIGHT_REP,
 304     ACTION_USB_HID_MOUSE_RDRAG_UP,
 305     ACTION_USB_HID_MOUSE_RDRAG_UP_REP,
 306     ACTION_USB_HID_MOUSE_RDRAG_DOWN,
 307     ACTION_USB_HID_MOUSE_RDRAG_DOWN_REP,
 308     ACTION_USB_HID_MOUSE_RDRAG_LEFT,
 309     ACTION_USB_HID_MOUSE_RDRAG_LEFT_REP,
 310     ACTION_USB_HID_MOUSE_RDRAG_RIGHT,
 311     ACTION_USB_HID_MOUSE_RDRAG_RIGHT_REP,
 312     ACTION_USB_HID_MOUSE_BUTTON_LEFT,
 313     ACTION_USB_HID_MOUSE_BUTTON_LEFT_REL,
 314     ACTION_USB_HID_MOUSE_BUTTON_RIGHT,
 315     ACTION_USB_HID_MOUSE_BUTTON_RIGHT_REL,
 316     ACTION_USB_HID_MOUSE_WHEEL_SCROLL_UP,
 317     ACTION_USB_HID_MOUSE_WHEEL_SCROLL_DOWN,
 318     ACTION_USB_HID_LAST, /* Place holder */
 319
 320     LAST_ACTION_PLACEHOLDER, /* custom actions should be this + something */
 321 };
 322
 323 struct button_mapping {
 324     int action_code;
 325     int button_code;
 326     int pre_button_code;
 327 };
 328 /* use if you want to supply your own button mappings, PLUGINS ONLY */
 329 /* get_context_map is a function which returns a button_mapping* depedning on the given context */
 330 /* custom button_mappings may "chain" to inbuilt CONTEXT's */
 331 int get_custom_action(int context,int timeout,
 332                       const struct button_mapping* (*get_context_map)(int));
 333 /* use if one of the standard CONTEXT_ mappings will work (ALL the core should be using this! */
 334 int get_action(int context, int timeout);
 335
 336 /* call this if you need to check for ACTION_STD_CANCEL only (i.e user abort! */
 337 bool action_userabort(int timeout);
 338
 339 /* no other code should need this apart from action.c */
 340 const struct button_mapping* get_context_mapping(int context);
 341 #ifndef HAS_BUTTON_HOLD
 342 bool is_keys_locked(void);
 343 #endif
 344
 345 /* returns the status code variable from action.c for the button just pressed
 346    If button != NULL it will be set to the actual button code */
 347 #define ACTION_REMOTE   0x1 /* remote was pressed */
 348 #define ACTION_REPEAT   0x2 /* action was repeated (NOT button) */
 349 int get_action_statuscode(int *button);
 350
 351 /* returns the data value associated with the last action that is not
 352    BUTTON_NONE or flagged with SYS_EVENT */
 353 intptr_t get_action_data(void);
 354
 355 #ifdef HAVE_TOUCHSCREEN
 356 /* return BUTTON_NONE               on error
 357  *        BUTTON_REPEAT             if repeated press
 358  *        BUTTON_REPEAT|BUTTON_REL  if release after repeated press
 359  *        BUTTON_REL                if it's a short press = release after press
 360  *        BUTTON_TOUCHSCREEN        if press
 361  */
 362 int action_get_touchscreen_press(short *x, short *y);
 363
 364 /*
 365  * wrapper action_get_touchscreen_press()
 366  * to filter the touchscreen coordinates through a viewport
 367  *
 368  * returns the action and x1, y1 relative to the viewport if
 369  * the press was within the viewport,
 370  * ACTION_UNKNOWN (and x1, y1 untouched) if the press was outside
 371  * BUTTON_NONE else
 372  *
 373  **/
 374 int action_get_touchscreen_press_in_vp(short *x1, short *y1, struct viewport *vp);
 375 #endif
 376
 377 /* Don't let get_action*() return any ACTION_* values until the current buttons
 378  * have been released. SYS_* and BUTTON_NONE will go through.
 379  * Any actions relying on _RELEASE won't get seen.
 380  */
 381 void action_wait_for_release(void);
 382
 383 #endif /* __ACTION_H__ */