Add forgotten manual contributors to the credits for the manual, thanks pixelma ;-)
[Rockbox.git] / apps / root_menu.c
blobad603db8c77e7bab8457694b4e511ad6f2ba3272
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2007 Jonathan Gordon
12 * All files in this archive are subject to the GNU General Public License.
13 * See the file COPYING in the source tree root for full license agreement.
15 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
16 * KIND, either express or implied.
18 ****************************************************************************/
19 #include <stdio.h>
20 #include <string.h>
21 #include <stdlib.h>
22 #include <stdbool.h>
23 #include "config.h"
24 #include "menu.h"
25 #include "root_menu.h"
26 #include "lang.h"
27 #include "settings.h"
28 #include "screens.h"
29 #include "kernel.h"
30 #include "debug.h"
31 #include "misc.h"
32 #include "rolo.h"
33 #include "powermgmt.h"
34 #include "power.h"
35 #include "talk.h"
36 #include "audio.h"
37 #include "hotswap.h"
39 #if (LCD_DEPTH > 1) || (defined(HAVE_LCD_REMOTE) && (LCD_REMOTE_DEPTH > 1))
40 #include "backdrop.h"
41 #endif
44 /* gui api */
45 #include "list.h"
46 #include "statusbar.h"
47 #include "splash.h"
48 #include "buttonbar.h"
49 #include "textarea.h"
50 #include "action.h"
51 #include "yesno.h"
53 #include "tree.h"
54 #if CONFIG_TUNER
55 #include "radio.h"
56 #endif
57 #ifdef HAVE_RECORDING
58 #include "recording.h"
59 #endif
60 #include "gwps-common.h"
61 #include "bookmark.h"
62 #include "tagtree.h"
63 #include "menus/exported_menus.h"
64 #ifdef HAVE_RTC_ALARM
65 #include "rtc.h"
66 #endif
67 #ifdef HAVE_TAGCACHE
68 #include "tagcache.h"
69 #endif
71 struct root_items {
72 int (*function)(void* param);
73 void* param;
74 const struct menu_item_ex *context_menu;
76 static int last_screen = GO_TO_ROOT; /* unfortunatly needed so we can resume
77 or goto current track based on previous
78 screen */
79 static int browser(void* param)
81 int ret_val;
82 #ifdef HAVE_TAGCACHE
83 struct tree_context* tc = tree_get_context();
84 #endif
85 int filter = SHOW_SUPPORTED;
86 char folder[MAX_PATH] = "/";
87 /* stuff needed to remember position in file browser */
88 static char last_folder[MAX_PATH] = "/";
89 /* and stuff for the database browser */
90 #ifdef HAVE_TAGCACHE
91 static int last_db_dirlevel = 0, last_db_selection = 0;
92 #endif
94 switch ((intptr_t)param)
96 case GO_TO_FILEBROWSER:
97 filter = global_settings.dirfilter;
98 if (global_settings.browse_current &&
99 last_screen == GO_TO_WPS && audio_status() &&
100 wps_state.current_track_path[0] != '\0')
102 strcpy(folder, wps_state.current_track_path);
104 #ifdef HAVE_HOTSWAP /* quick hack to stop crashing if you try entering
105 the browser from the menu when you were in the card
106 and it was removed */
107 else if (strchr(last_folder, '<') && (card_detect() == false))
108 strcpy(folder, "/");
109 #endif
110 else
111 strcpy(folder, last_folder);
112 break;
113 #ifdef HAVE_TAGCACHE
114 case GO_TO_DBBROWSER:
115 if (!tagcache_is_usable())
117 bool reinit_attempted = false;
119 /* Now display progress until it's ready or the user exits */
120 while(!tagcache_is_usable())
122 gui_syncstatusbar_draw(&statusbars, false);
123 struct tagcache_stat *stat = tagcache_get_stat();
125 /* Allow user to exit */
126 if (action_userabort(HZ/2))
127 break;
129 /* Maybe just needs to reboot due to delayed commit */
130 if (stat->commit_delayed)
132 gui_syncsplash(HZ*2, ID2P(LANG_PLEASE_REBOOT));
133 break;
136 /* Check if ready status is known */
137 if (!stat->readyvalid)
139 gui_syncsplash(0, str(LANG_TAGCACHE_BUSY));
140 continue;
143 /* Re-init if required */
144 if (!reinit_attempted && !stat->ready &&
145 stat->processed_entries == 0 && stat->commit_step == 0)
147 /* Prompt the user */
148 reinit_attempted = true;
149 char *lines[]={ID2P(LANG_TAGCACHE_BUSY), ID2P(LANG_TAGCACHE_FORCE_UPDATE)};
150 struct text_message message={lines, 2};
151 if(gui_syncyesno_run(&message, NULL, NULL) == YESNO_NO)
152 break;
153 int i;
154 FOR_NB_SCREENS(i)
155 screens[i].clear_display();
157 /* Start initialisation */
158 tagcache_rebuild();
161 /* Display building progress */
162 static long talked_tick = 0;
163 if(talk_menus_enabled() &&
164 (talked_tick == 0
165 || TIME_AFTER(current_tick, talked_tick+7*HZ)))
167 talked_tick = current_tick;
168 if (stat->commit_step > 0)
170 talk_id(LANG_TAGCACHE_INIT, false);
171 talk_number(stat->commit_step, true);
172 talk_id(VOICE_OF, true);
173 talk_number(tagcache_get_max_commit_step(), true);
174 } else if(stat->processed_entries)
176 talk_number(stat->processed_entries, false);
177 talk_id(LANG_BUILDING_DATABASE, true);
180 if (stat->commit_step > 0)
182 gui_syncsplash(0, "%s [%d/%d]",
183 str(LANG_TAGCACHE_INIT), stat->commit_step,
184 tagcache_get_max_commit_step());
186 else
188 gui_syncsplash(0, str(LANG_BUILDING_DATABASE),
189 stat->processed_entries);
193 if (!tagcache_is_usable())
194 return GO_TO_PREVIOUS;
195 filter = SHOW_ID3DB;
196 tc->dirlevel = last_db_dirlevel;
197 tc->selected_item = last_db_selection;
198 break;
199 #endif
200 case GO_TO_BROWSEPLUGINS:
201 filter = SHOW_PLUGINS;
202 snprintf(folder, MAX_PATH, "%s", PLUGIN_DIR);
203 break;
205 ret_val = rockbox_browse(folder, filter);
206 switch ((intptr_t)param)
208 case GO_TO_FILEBROWSER:
209 get_current_file(last_folder, MAX_PATH);
210 break;
211 #ifdef HAVE_TAGCACHE
212 case GO_TO_DBBROWSER:
213 last_db_dirlevel = tc->dirlevel;
214 last_db_selection = tc->selected_item;
215 break;
216 #endif
218 return ret_val;
221 static int menu(void* param)
223 (void)param;
224 return do_menu(NULL, 0);
227 #ifdef HAVE_RECORDING
228 static int recscrn(void* param)
230 (void)param;
231 recording_screen(false);
232 return GO_TO_ROOT;
234 #endif
235 static int wpsscrn(void* param)
237 int ret_val = GO_TO_PREVIOUS;
238 (void)param;
239 if (audio_status())
241 ret_val = gui_wps_show();
243 else if ( global_status.resume_index != -1 )
245 DEBUGF("Resume index %X offset %lX\n",
246 global_status.resume_index,
247 (unsigned long)global_status.resume_offset);
248 if (playlist_resume() != -1)
250 playlist_start(global_status.resume_index,
251 global_status.resume_offset);
252 ret_val = gui_wps_show();
255 else
257 gui_syncsplash(HZ*2, ID2P(LANG_NOTHING_TO_RESUME));
259 #if LCD_DEPTH > 1
260 show_main_backdrop();
261 #endif
262 #if defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
263 show_remote_main_backdrop();
264 #endif
265 return ret_val;
267 #if CONFIG_TUNER
268 static int radio(void* param)
270 (void)param;
271 radio_screen();
272 return GO_TO_ROOT;
274 #endif
276 static int load_bmarks(void* param)
278 (void)param;
279 bookmark_mrb_load();
280 return GO_TO_PREVIOUS;
282 static int plugins_menu(void* param)
284 (void)param;
285 MENUITEM_STRINGLIST(plugins_menu_items, ID2P(LANG_PLUGINS), NULL,
286 ID2P(LANG_PLUGIN_GAMES),
287 ID2P(LANG_PLUGIN_APPS), ID2P(LANG_PLUGIN_DEMOS));
288 char *folder;
289 int retval = GO_TO_PREVIOUS;
290 int selection = 0, current = 0;
291 while (retval == GO_TO_PREVIOUS)
293 selection = do_menu(&plugins_menu_items, &current);
294 switch (selection)
296 case 0:
297 folder = PLUGIN_GAMES_DIR;
298 break;
299 case 1:
300 folder = PLUGIN_APPS_DIR;
301 break;
302 case 2:
303 folder = PLUGIN_DEMOS_DIR;
304 break;
305 default:
306 return selection;
308 retval = rockbox_browse(folder, SHOW_PLUGINS);
310 return retval;
313 /* These are all static const'd from apps/menus/ *.c
314 so little hack so we can use them */
315 extern struct menu_item_ex
316 file_menu,
317 #ifdef HAVE_TAGCACHE
318 tagcache_menu,
319 #endif
320 manage_settings,
321 recording_settings_menu,
322 radio_settings_menu,
323 bookmark_settings_menu,
324 system_menu;
325 static const struct root_items items[] = {
326 [GO_TO_FILEBROWSER] = { browser, (void*)GO_TO_FILEBROWSER, &file_menu},
327 #ifdef HAVE_TAGCACHE
328 [GO_TO_DBBROWSER] = { browser, (void*)GO_TO_DBBROWSER, &tagcache_menu },
329 #endif
330 [GO_TO_WPS] = { wpsscrn, NULL, &playback_menu_item },
331 [GO_TO_MAINMENU] = { menu, NULL, &manage_settings },
333 #ifdef HAVE_RECORDING
334 [GO_TO_RECSCREEN] = { recscrn, NULL, &recording_settings_menu },
335 #endif
337 #if CONFIG_TUNER
338 [GO_TO_FM] = { radio, NULL, &radio_settings_menu },
339 #endif
341 [GO_TO_RECENTBMARKS] = { load_bmarks, NULL, &bookmark_settings_menu },
342 [GO_TO_BROWSEPLUGINS] = { plugins_menu, NULL, NULL },
345 static const int nb_items = sizeof(items)/sizeof(*items);
347 int item_callback(int action, const struct menu_item_ex *this_item) ;
349 MENUITEM_RETURNVALUE(file_browser, ID2P(LANG_DIR_BROWSER), GO_TO_FILEBROWSER,
350 NULL, Icon_file_view_menu);
351 #ifdef HAVE_TAGCACHE
352 MENUITEM_RETURNVALUE(db_browser, ID2P(LANG_TAGCACHE), GO_TO_DBBROWSER,
353 NULL, Icon_Audio);
354 #endif
355 MENUITEM_RETURNVALUE(rocks_browser, ID2P(LANG_PLUGINS), GO_TO_BROWSEPLUGINS,
356 NULL, Icon_Plugin);
357 char *get_wps_item_name(int selected_item, void * data, char *buffer)
359 (void)selected_item; (void)data; (void)buffer;
360 if (audio_status())
361 return ID2P(LANG_NOW_PLAYING);
362 return ID2P(LANG_RESUME_PLAYBACK);
364 MENUITEM_RETURNVALUE_DYNTEXT(wps_item, GO_TO_WPS, NULL, get_wps_item_name,
365 NULL, Icon_Playback_menu);
366 #ifdef HAVE_RECORDING
367 MENUITEM_RETURNVALUE(rec, ID2P(LANG_RECORDING), GO_TO_RECSCREEN,
368 NULL, Icon_Recording);
369 #endif
370 #if CONFIG_TUNER
371 MENUITEM_RETURNVALUE(fm, ID2P(LANG_FM_RADIO), GO_TO_FM,
372 item_callback, Icon_Radio_screen);
373 #endif
374 MENUITEM_RETURNVALUE(menu_, ID2P(LANG_SETTINGS), GO_TO_MAINMENU,
375 NULL, Icon_Submenu_Entered);
376 MENUITEM_RETURNVALUE(bookmarks, ID2P(LANG_BOOKMARK_MENU_RECENT_BOOKMARKS),
377 GO_TO_RECENTBMARKS, item_callback,
378 Icon_Bookmark);
379 #ifdef HAVE_LCD_CHARCELLS
380 static int do_shutdown(void)
382 #if CONFIG_CHARGING
383 if (charger_inserted())
384 charging_splash();
385 else
386 #endif
387 sys_poweroff();
388 return 0;
390 MENUITEM_FUNCTION(do_shutdown_item, 0, ID2P(LANG_SHUTDOWN),
391 do_shutdown, NULL, NULL, Icon_NOICON);
392 #endif
393 MAKE_MENU(root_menu_, ID2P(LANG_ROCKBOX_TITLE),
394 item_callback, Icon_Rockbox,
395 &bookmarks, &file_browser,
396 #ifdef HAVE_TAGCACHE
397 &db_browser,
398 #endif
399 &wps_item, &menu_,
400 #ifdef HAVE_RECORDING
401 &rec,
402 #endif
403 #if CONFIG_TUNER
404 &fm,
405 #endif
406 &playlist_options, &rocks_browser, &info_menu
408 #ifdef HAVE_LCD_CHARCELLS
409 ,&do_shutdown_item
410 #endif
413 int item_callback(int action, const struct menu_item_ex *this_item)
415 switch (action)
417 case ACTION_TREE_STOP:
418 return ACTION_REDRAW;
419 case ACTION_REQUEST_MENUITEM:
420 #if CONFIG_TUNER
421 if (this_item == &fm)
423 if (radio_hardware_present() == 0)
424 return ACTION_EXIT_MENUITEM;
426 else
427 #endif
428 if (this_item == &bookmarks)
430 if (global_settings.usemrb == 0)
431 return ACTION_EXIT_MENUITEM;
433 break;
435 return action;
437 static int get_selection(int last_screen)
439 unsigned int i;
440 for(i=0; i< sizeof(root_menu__)/sizeof(*root_menu__); i++)
442 if (((root_menu__[i]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE) &&
443 (root_menu__[i]->value == last_screen))
445 return i;
448 return 0;
451 static inline int load_screen(int screen)
453 /* set the global_status.last_screen before entering,
454 if we dont we will always return to the wrong screen on boot */
455 int old_previous = last_screen;
456 int ret_val;
457 if (screen <= GO_TO_ROOT)
458 return screen;
459 if (screen == old_previous)
460 old_previous = GO_TO_ROOT;
461 global_status.last_screen = (char)screen;
462 status_save();
463 ret_val = items[screen].function(items[screen].param);
464 last_screen = screen;
465 if (ret_val == GO_TO_PREVIOUS)
466 last_screen = old_previous;
467 return ret_val;
469 static int load_context_screen(int selection)
471 const struct menu_item_ex *context_menu = NULL;
472 if ((root_menu__[selection]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE)
474 int item = root_menu__[selection]->value;
475 context_menu = items[item].context_menu;
477 /* special cases */
478 else if (root_menu__[selection] == &info_menu)
480 context_menu = &system_menu;
483 if (context_menu)
484 return do_menu(context_menu, NULL);
485 else
486 return GO_TO_PREVIOUS;
488 void root_menu(void)
490 int previous_browser = GO_TO_FILEBROWSER;
491 int previous_music = GO_TO_WPS;
492 int next_screen = GO_TO_ROOT;
493 int selected = 0;
495 if (global_settings.start_in_screen == 0)
496 next_screen = (int)global_status.last_screen;
497 else next_screen = global_settings.start_in_screen - 2;
499 #ifdef HAVE_RTC_ALARM
500 if ( rtc_check_alarm_started(true) )
502 rtc_enable_alarm(false);
503 next_screen = GO_TO_WPS;
504 #if CONFIG_TUNER
505 if (global_settings.alarm_wake_up_screen == ALARM_START_FM)
506 next_screen = GO_TO_FM;
507 #endif
508 #ifdef HAVE_RECORDING
509 if (global_settings.alarm_wake_up_screen == ALARM_START_REC)
511 recording_start_automatic = true;
512 next_screen = GO_TO_RECSCREEN;
514 #endif
516 #endif /* HAVE_RTC_ALARM */
518 #ifdef HAVE_HEADPHONE_DETECTION
519 if (next_screen == GO_TO_WPS &&
520 (global_settings.unplug_autoresume && !headphones_inserted() ))
521 next_screen = GO_TO_ROOT;
522 #endif
524 while (true)
526 switch (next_screen)
528 case MENU_ATTACHED_USB:
529 case MENU_SELECTED_EXIT:
530 /* fall through */
531 case GO_TO_ROOT:
532 if (last_screen != GO_TO_ROOT)
533 selected = get_selection(last_screen);
534 next_screen = do_menu(&root_menu_, &selected);
535 if (next_screen != GO_TO_PREVIOUS)
536 last_screen = GO_TO_ROOT;
537 break;
539 case GO_TO_PREVIOUS:
540 next_screen = last_screen;
541 break;
543 case GO_TO_PREVIOUS_BROWSER:
544 next_screen = previous_browser;
545 break;
547 case GO_TO_PREVIOUS_MUSIC:
548 next_screen = previous_music;
549 break;
550 case GO_TO_ROOTITEM_CONTEXT:
551 next_screen = load_context_screen(selected);
552 break;
553 default:
554 if (next_screen == GO_TO_FILEBROWSER
555 #ifdef HAVE_TAGCACHE
556 || next_screen == GO_TO_DBBROWSER
557 #endif
559 previous_browser = next_screen;
560 if (next_screen == GO_TO_WPS
561 #if CONFIG_TUNER
562 || next_screen == GO_TO_FM
563 #endif
565 previous_music = next_screen;
566 next_screen = load_screen(next_screen);
567 break;
568 } /* switch() */
570 return;