Makes sure codec API builds correctly if ROCKBOX_HAS_LOGF is defined
[kugel-rb.git] / apps / action.h
blob0738b114da31e86d21b1d099821c8916a3b97a15
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
9 * Copyright (C) 2004 Brent Coutts
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.
16 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
17 * KIND, either express or implied.
19 ****************************************************************************/
20 #ifndef __ACTION_H__
21 #define __ACTION_H__
23 #include "stdbool.h"
24 #include "button.h"
25 #include "viewport.h"
27 #define TIMEOUT_BLOCK -1
28 #define TIMEOUT_NOBLOCK 0
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 */
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 }
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
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,
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 */
75 CONTEXT_YESNOSCREEN, /*NOTE: make sure your target has this and ACTION_YESNO_ACCEPT */
76 CONTEXT_RECSCREEN,
77 CONTEXT_KEYBOARD,
78 CONTEXT_FM,
79 CONTEXT_USB_HID,
80 CONTEXT_USB_HID_MODE_MULTIMEDIA,
81 CONTEXT_USB_HID_MODE_PRESENTATION,
82 CONTEXT_USB_HID_MODE_BROWSER,
83 CONTEXT_USB_HID_MODE_MOUSE,
87 enum {
89 ACTION_NONE = BUTTON_NONE,
90 ACTION_UNKNOWN,
91 ACTION_REDRAW, /* returned if keys are locked and we splash()'ed */
92 ACTION_TOUCHSCREEN,
93 ACTION_TOUCHSCREEN_MODE, /* toggle the touchscreen mode */
95 /* standard actions, use these first */
96 ACTION_STD_PREV,
97 ACTION_STD_PREVREPEAT,
98 ACTION_STD_NEXT,
99 ACTION_STD_NEXTREPEAT,
101 ACTION_STD_OK,
102 ACTION_STD_CANCEL,
103 ACTION_STD_CONTEXT,
104 ACTION_STD_MENU,
105 ACTION_STD_QUICKSCREEN,
106 ACTION_STD_KEYLOCK,
107 ACTION_STD_REC,
109 ACTION_F3, /* just so everything works again, possibly change me */
110 /* code context actions */
112 /* WPS codes */
113 ACTION_WPS_BROWSE,
114 ACTION_WPS_PLAY,
115 ACTION_WPS_SEEKBACK,
116 ACTION_WPS_SEEKFWD,
117 ACTION_WPS_STOPSEEK,
118 ACTION_WPS_SKIPNEXT,
119 ACTION_WPS_SKIPPREV,
120 ACTION_WPS_STOP,
121 ACTION_WPS_VOLDOWN,
122 ACTION_WPS_VOLUP,
123 ACTION_WPS_PITCHSCREEN,/* optional */
124 ACTION_WPS_ID3SCREEN,/* optional */
125 ACTION_WPS_CONTEXT,
126 ACTION_WPS_QUICKSCREEN,/* optional */
127 ACTION_WPS_MENU, /*this should be the same as ACTION_STD_MENU */
128 ACTION_WPS_VIEW_PLAYLIST,
129 ACTION_WPS_REC,
130 #if 0
131 ACTION_WPSAB_SINGLE, /* This needs to be #defined in
132 the config-<target>.h to one of the ACTION_WPS_ actions
133 so it can be used */
134 #endif
135 ACTION_WPS_ABSETA_PREVDIR, /* these should be safe to put together seen as */
136 ACTION_WPS_ABSETB_NEXTDIR, /* you shouldnt want to change dir in ab-mode */
137 ACTION_WPS_ABRESET,
139 /* list and tree page up/down */
140 ACTION_LISTTREE_PGUP,/* optional */
141 ACTION_LISTTREE_PGDOWN,/* optional */
142 #ifdef HAVE_VOLUME_IN_LIST
143 ACTION_LIST_VOLUP,
144 ACTION_LIST_VOLDOWN,
145 #endif
147 /* tree */
148 ACTION_TREE_ROOT_INIT,
149 ACTION_TREE_PGLEFT,/* optional */
150 ACTION_TREE_PGRIGHT,/* optional */
151 ACTION_TREE_STOP,
152 ACTION_TREE_WPS,
154 /* radio */
155 ACTION_FM_MENU,
156 ACTION_FM_PRESET,
157 ACTION_FM_RECORD,
158 ACTION_FM_FREEZE,
159 ACTION_FM_STOP,
160 ACTION_FM_MODE,
161 ACTION_FM_EXIT,
162 ACTION_FM_PLAY,
163 ACTION_FM_RECORD_DBLPRE,
164 ACTION_FM_NEXT_PRESET,
165 ACTION_FM_PREV_PRESET,
167 /* recording screen */
168 ACTION_REC_LCD,
169 ACTION_REC_PAUSE,
170 ACTION_REC_NEWFILE,
171 ACTION_REC_F2,
172 ACTION_REC_F3,
174 /* main menu */
175 /* These are not strictly actions, but must be here
176 so they dont conflict with real actions in the menu code */
177 ACTION_REQUEST_MENUITEM,
178 ACTION_EXIT_MENUITEM,
179 ACTION_EXIT_AFTER_THIS_MENUITEM, /* if a menu returns this the menu will exit
180 once the subitem returns */
181 ACTION_ENTER_MENUITEM,
183 /* id3db */
185 /* list */
187 /* settings */
188 ACTION_SETTINGS_INC,
189 ACTION_SETTINGS_INCREPEAT,
190 ACTION_SETTINGS_INCBIGSTEP,
191 ACTION_SETTINGS_DEC,
192 ACTION_SETTINGS_DECREPEAT,
193 ACTION_SETTINGS_DECBIGSTEP,
194 ACTION_SETTINGS_RESET,
196 /* bookmark screen */
197 ACTION_BMS_DELETE,
199 /* quickscreen */
200 ACTION_QS_LEFT,
201 ACTION_QS_RIGHT,
202 ACTION_QS_DOWN,
203 ACTION_QS_TOP,
205 /* pitchscreen */
206 /* obviously ignore if you dont have thise screen */
207 ACTION_PS_INC_SMALL,
208 ACTION_PS_INC_BIG,
209 ACTION_PS_DEC_SMALL,
210 ACTION_PS_DEC_BIG,
211 ACTION_PS_NUDGE_LEFT,
212 ACTION_PS_NUDGE_RIGHT,
213 ACTION_PS_NUDGE_LEFTOFF,
214 ACTION_PS_NUDGE_RIGHTOFF,
215 ACTION_PS_TOGGLE_MODE,
216 ACTION_PS_RESET,
217 ACTION_PS_EXIT, /* _STD_* isnt going to work here */
218 ACTION_PS_SLOWER,
219 ACTION_PS_FASTER,
221 /* yesno screen */
222 ACTION_YESNO_ACCEPT,
224 /* keyboard screen */
225 ACTION_KBD_LEFT,
226 ACTION_KBD_RIGHT,
227 ACTION_KBD_CURSOR_LEFT,
228 ACTION_KBD_CURSOR_RIGHT,
229 ACTION_KBD_SELECT,
230 ACTION_KBD_SELECT_REM,
231 ACTION_KBD_PAGE_FLIP,
232 ACTION_KBD_DONE,
233 ACTION_KBD_ABORT,
234 ACTION_KBD_BACKSPACE,
235 ACTION_KBD_UP,
236 ACTION_KBD_DOWN,
237 ACTION_KBD_MORSE_INPUT,
238 ACTION_KBD_MORSE_SELECT,
240 #ifdef HAVE_TOUCHSCREEN
241 /* the following are helper actions for touchscreen targets,
242 * These are for actions which are not doable or required if buttons are
243 * being used, but are nice additions if the touchscreen is used */
244 ACTION_TOUCH_SHUFFLE,
245 ACTION_TOUCH_REPMODE,
246 #endif
248 /* USB HID codes */
249 ACTION_USB_HID_FIRST, /* Place holder */
250 ACTION_USB_HID_NONE,
251 ACTION_USB_HID_MODE_SWITCH_NEXT,
252 ACTION_USB_HID_MODE_SWITCH_PREV,
253 ACTION_USB_HID_MULTIMEDIA_VOLUME_UP,
254 ACTION_USB_HID_MULTIMEDIA_VOLUME_DOWN,
255 ACTION_USB_HID_MULTIMEDIA_VOLUME_MUTE,
256 ACTION_USB_HID_MULTIMEDIA_PLAYBACK_PLAY_PAUSE,
257 ACTION_USB_HID_MULTIMEDIA_PLAYBACK_STOP,
258 ACTION_USB_HID_MULTIMEDIA_PLAYBACK_TRACK_PREV,
259 ACTION_USB_HID_MULTIMEDIA_PLAYBACK_TRACK_NEXT,
260 ACTION_USB_HID_PRESENTATION_SLIDESHOW_START,
261 ACTION_USB_HID_PRESENTATION_SLIDESHOW_LEAVE,
262 ACTION_USB_HID_PRESENTATION_SLIDE_PREV,
263 ACTION_USB_HID_PRESENTATION_SLIDE_NEXT,
264 ACTION_USB_HID_PRESENTATION_SLIDE_FIRST,
265 ACTION_USB_HID_PRESENTATION_SLIDE_LAST,
266 ACTION_USB_HID_PRESENTATION_SCREEN_BLACK,
267 ACTION_USB_HID_PRESENTATION_SCREEN_WHITE,
268 ACTION_USB_HID_PRESENTATION_LINK_PREV,
269 ACTION_USB_HID_PRESENTATION_LINK_NEXT,
270 ACTION_USB_HID_PRESENTATION_MOUSE_CLICK,
271 ACTION_USB_HID_PRESENTATION_MOUSE_OVER,
272 ACTION_USB_HID_BROWSER_SCROLL_UP,
273 ACTION_USB_HID_BROWSER_SCROLL_DOWN,
274 ACTION_USB_HID_BROWSER_SCROLL_PAGE_DOWN,
275 ACTION_USB_HID_BROWSER_SCROLL_PAGE_UP,
276 ACTION_USB_HID_BROWSER_ZOOM_IN,
277 ACTION_USB_HID_BROWSER_ZOOM_OUT,
278 ACTION_USB_HID_BROWSER_ZOOM_RESET,
279 ACTION_USB_HID_BROWSER_TAB_PREV,
280 ACTION_USB_HID_BROWSER_TAB_NEXT,
281 ACTION_USB_HID_BROWSER_TAB_CLOSE,
282 ACTION_USB_HID_BROWSER_HISTORY_BACK,
283 ACTION_USB_HID_BROWSER_HISTORY_FORWARD,
284 ACTION_USB_HID_BROWSER_VIEW_FULL_SCREEN,
285 ACTION_USB_HID_MOUSE_UP,
286 ACTION_USB_HID_MOUSE_UP_REP,
287 ACTION_USB_HID_MOUSE_DOWN,
288 ACTION_USB_HID_MOUSE_DOWN_REP,
289 ACTION_USB_HID_MOUSE_LEFT,
290 ACTION_USB_HID_MOUSE_LEFT_REP,
291 ACTION_USB_HID_MOUSE_RIGHT,
292 ACTION_USB_HID_MOUSE_RIGHT_REP,
293 ACTION_USB_HID_MOUSE_LDRAG_UP,
294 ACTION_USB_HID_MOUSE_LDRAG_UP_REP,
295 ACTION_USB_HID_MOUSE_LDRAG_DOWN,
296 ACTION_USB_HID_MOUSE_LDRAG_DOWN_REP,
297 ACTION_USB_HID_MOUSE_LDRAG_LEFT,
298 ACTION_USB_HID_MOUSE_LDRAG_LEFT_REP,
299 ACTION_USB_HID_MOUSE_LDRAG_RIGHT,
300 ACTION_USB_HID_MOUSE_LDRAG_RIGHT_REP,
301 ACTION_USB_HID_MOUSE_RDRAG_UP,
302 ACTION_USB_HID_MOUSE_RDRAG_UP_REP,
303 ACTION_USB_HID_MOUSE_RDRAG_DOWN,
304 ACTION_USB_HID_MOUSE_RDRAG_DOWN_REP,
305 ACTION_USB_HID_MOUSE_RDRAG_LEFT,
306 ACTION_USB_HID_MOUSE_RDRAG_LEFT_REP,
307 ACTION_USB_HID_MOUSE_RDRAG_RIGHT,
308 ACTION_USB_HID_MOUSE_RDRAG_RIGHT_REP,
309 ACTION_USB_HID_MOUSE_BUTTON_LEFT,
310 ACTION_USB_HID_MOUSE_BUTTON_LEFT_REL,
311 ACTION_USB_HID_MOUSE_BUTTON_RIGHT,
312 ACTION_USB_HID_MOUSE_BUTTON_RIGHT_REL,
313 ACTION_USB_HID_MOUSE_WHEEL_SCROLL_UP,
314 ACTION_USB_HID_MOUSE_WHEEL_SCROLL_DOWN,
315 ACTION_USB_HID_LAST, /* Place holder */
317 LAST_ACTION_PLACEHOLDER, /* custom actions should be this + something */
320 struct button_mapping {
321 int action_code;
322 int button_code;
323 int pre_button_code;
325 /* use if you want to supply your own button mappings, PLUGINS ONLY */
326 /* get_context_map is a function which returns a button_mapping* depedning on the given context */
327 /* custom button_mappings may "chain" to inbuilt CONTEXT's */
328 int get_custom_action(int context,int timeout,
329 const struct button_mapping* (*get_context_map)(int));
330 /* use if one of the standard CONTEXT_ mappings will work (ALL the core should be using this! */
331 int get_action(int context, int timeout);
333 /* call this if you need to check for ACTION_STD_CANCEL only (i.e user abort! */
334 bool action_userabort(int timeout);
336 /* no other code should need this apart from action.c */
337 const struct button_mapping* get_context_mapping(int context);
338 #ifndef HAS_BUTTON_HOLD
339 bool is_keys_locked(void);
340 #endif
342 /* returns the status code variable from action.c for the button just pressed
343 If button != NULL it will be set to the actual button code */
344 #define ACTION_REMOTE 0x1 /* remote was pressed */
345 #define ACTION_REPEAT 0x2 /* action was repeated (NOT button) */
346 int get_action_statuscode(int *button);
348 /* returns the data value associated with the last action that is not
349 BUTTON_NONE or flagged with SYS_EVENT */
350 intptr_t get_action_data(void);
352 #ifdef HAVE_TOUCHSCREEN
353 /* return BUTTON_NONE on error
354 * BUTTON_REPEAT if repeated press
355 * BUTTON_REPEAT|BUTTON_REL if release after repeated press
356 * BUTTON_REL if its a short press = release after press
357 * BUTTON_TOUCHSCREEN if press
359 int action_get_touchscreen_press(short *x, short *y);
362 * wrapper action_get_touchscreen_press()
363 * to filter the touchscreen coordinates through a viewport
365 * returns the action and x1, y1 relative to the viewport if
366 * the press was within the viewport,
367 * ACTION_UNKNOWN (and x1, y1 untouched) if the press was outside
368 * BUTTON_NONE else
371 int action_get_touchscreen_press_in_vp(short *x1, short *y1, struct viewport *vp);
372 #endif
374 /* Don't let get_action*() return any ACTION_* values untill the current buttons
375 * have ben release. SYS_* and BUTTON_NONE will go through.
376 * Any actions relying on _RELEASE won't get seen
378 void action_wait_for_release(void);
380 #endif /* __ACTION_H__ */