FS#12102 - Manual, "Quick Start" section for AMSv2 players: Clarifies
[kugel-rb.git] / apps / root_menu.c
blob76c081f77566999f720c8041095ad056b05dfcd4
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2007 Jonathan Gordon
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.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <stdbool.h>
24 #include "string-extra.h"
25 #include "config.h"
26 #include "appevents.h"
27 #include "menu.h"
28 #include "root_menu.h"
29 #include "lang.h"
30 #include "settings.h"
31 #include "screens.h"
32 #include "kernel.h"
33 #include "debug.h"
34 #include "misc.h"
35 #include "rolo.h"
36 #include "powermgmt.h"
37 #include "power.h"
38 #include "talk.h"
39 #include "audio.h"
41 #ifdef HAVE_HOTSWAP
42 #include "storage.h"
43 #include "dir.h"
44 #endif
45 /* gui api */
46 #include "list.h"
47 #include "splash.h"
48 #include "action.h"
49 #include "yesno.h"
50 #include "viewport.h"
52 #include "tree.h"
53 #if CONFIG_TUNER
54 #include "radio.h"
55 #endif
56 #ifdef HAVE_RECORDING
57 #include "recording.h"
58 #endif
59 #include "wps.h"
60 #include "bookmark.h"
61 #include "playlist.h"
62 #include "playlist_viewer.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
70 #include "language.h"
71 #include "plugin.h"
73 struct root_items {
74 int (*function)(void* param);
75 void* param;
76 const struct menu_item_ex *context_menu;
78 static int next_screen = GO_TO_ROOT; /* holding info about the upcoming screen
79 * which is the current screen for the
80 * rest of the code after load_screen
81 * is called */
82 static int last_screen = GO_TO_ROOT; /* unfortunatly needed so we can resume
83 or goto current track based on previous
84 screen */
87 static char current_track_path[MAX_PATH];
88 static void rootmenu_track_changed_callback(void* param)
90 struct mp3entry *id3 = (struct mp3entry *)param;
91 strlcpy(current_track_path, id3->path, MAX_PATH);
93 static int browser(void* param)
95 int ret_val;
96 #ifdef HAVE_TAGCACHE
97 struct tree_context* tc = tree_get_context();
98 #endif
99 struct browse_context browse;
100 int filter = SHOW_SUPPORTED;
101 char folder[MAX_PATH] = "/";
102 /* stuff needed to remember position in file browser */
103 static char last_folder[MAX_PATH] = "/";
104 /* and stuff for the database browser */
105 #ifdef HAVE_TAGCACHE
106 static int last_db_dirlevel = 0, last_db_selection = 0;
107 #endif
109 switch ((intptr_t)param)
111 case GO_TO_FILEBROWSER:
112 filter = global_settings.dirfilter;
113 if (global_settings.browse_current &&
114 last_screen == GO_TO_WPS &&
115 current_track_path[0])
117 strcpy(folder, current_track_path);
119 else if (!strcmp(last_folder, "/"))
121 strcpy(folder, global_settings.start_directory);
123 else
125 #ifdef HAVE_HOTSWAP
126 bool in_hotswap = false;
127 /* handle entering an ejected drive */
128 int i;
129 for (i = 0; i < NUM_VOLUMES; i++)
131 char vol_string[VOL_ENUM_POS + 8];
132 if (!storage_removable(i))
133 continue;
134 /* VOL_NAMES contains a %d */
135 snprintf(vol_string, sizeof(vol_string), "/"VOL_NAMES, i);
136 /* test whether we would browse the external card */
137 if (!storage_present(i) &&
138 (strstr(last_folder, vol_string)
139 #ifdef HAVE_HOTSWAP_STORAGE_AS_MAIN
140 || (i == 0)
141 #endif
143 { /* leave folder as "/" to avoid crash when trying
144 * to access an ejected drive */
145 strcpy(folder, "/");
146 in_hotswap = true;
147 break;
150 if (!in_hotswap)
151 #endif
152 strcpy(folder, last_folder);
154 break;
155 #ifdef HAVE_TAGCACHE
156 case GO_TO_DBBROWSER:
157 if (!tagcache_is_usable())
159 bool reinit_attempted = false;
161 /* Now display progress until it's ready or the user exits */
162 while(!tagcache_is_usable())
164 struct tagcache_stat *stat = tagcache_get_stat();
166 /* Allow user to exit */
167 if (action_userabort(HZ/2))
168 break;
170 /* Maybe just needs to reboot due to delayed commit */
171 if (stat->commit_delayed)
173 splash(HZ*2, ID2P(LANG_PLEASE_REBOOT));
174 break;
177 /* Check if ready status is known */
178 if (!stat->readyvalid)
180 splash(0, str(LANG_TAGCACHE_BUSY));
181 continue;
184 /* Re-init if required */
185 if (!reinit_attempted && !stat->ready &&
186 stat->processed_entries == 0 && stat->commit_step == 0)
188 /* Prompt the user */
189 reinit_attempted = true;
190 static const char *lines[]={
191 ID2P(LANG_TAGCACHE_BUSY), ID2P(LANG_TAGCACHE_FORCE_UPDATE)};
192 static const struct text_message message={lines, 2};
193 if(gui_syncyesno_run(&message, NULL, NULL) == YESNO_NO)
194 break;
195 int i;
196 FOR_NB_SCREENS(i)
197 screens[i].clear_display();
199 /* Start initialisation */
200 tagcache_rebuild();
203 /* Display building progress */
204 static long talked_tick = 0;
205 if(global_settings.talk_menu &&
206 (talked_tick == 0
207 || TIME_AFTER(current_tick, talked_tick+7*HZ)))
209 talked_tick = current_tick;
210 if (stat->commit_step > 0)
212 talk_id(LANG_TAGCACHE_INIT, false);
213 talk_number(stat->commit_step, true);
214 talk_id(VOICE_OF, true);
215 talk_number(tagcache_get_max_commit_step(), true);
216 } else if(stat->processed_entries)
218 talk_number(stat->processed_entries, false);
219 talk_id(LANG_BUILDING_DATABASE, true);
222 if (stat->commit_step > 0)
224 if (lang_is_rtl())
226 splashf(0, "[%d/%d] %s", stat->commit_step,
227 tagcache_get_max_commit_step(),
228 str(LANG_TAGCACHE_INIT));
230 else
232 splashf(0, "%s [%d/%d]", str(LANG_TAGCACHE_INIT),
233 stat->commit_step,
234 tagcache_get_max_commit_step());
237 else
239 splashf(0, str(LANG_BUILDING_DATABASE),
240 stat->processed_entries);
244 if (!tagcache_is_usable())
245 return GO_TO_PREVIOUS;
246 filter = SHOW_ID3DB;
247 tc->dirlevel = last_db_dirlevel;
248 tc->selected_item = last_db_selection;
249 break;
250 #endif
253 browse_context_init(&browse, filter, 0, NULL, NOICON, folder, NULL);
254 ret_val = rockbox_browse(&browse);
255 switch ((intptr_t)param)
257 case GO_TO_FILEBROWSER:
258 if (!get_current_file(last_folder, MAX_PATH) ||
259 (!strchr(&last_folder[1], '/') &&
260 global_settings.start_directory[1] != '\0'))
262 last_folder[0] = '/';
263 last_folder[1] = '\0';
265 break;
266 #ifdef HAVE_TAGCACHE
267 case GO_TO_DBBROWSER:
268 last_db_dirlevel = tc->dirlevel;
269 last_db_selection = tc->selected_item;
270 break;
271 #endif
273 return ret_val;
276 #ifdef HAVE_RECORDING
277 static int recscrn(void* param)
279 (void)param;
280 recording_screen(false);
281 return GO_TO_ROOT;
283 #endif
284 static int wpsscrn(void* param)
286 int ret_val = GO_TO_PREVIOUS;
287 (void)param;
288 if (audio_status())
290 talk_shutup();
291 ret_val = gui_wps_show();
293 else if ( global_status.resume_index != -1 )
295 DEBUGF("Resume index %X offset %lX\n",
296 global_status.resume_index,
297 (unsigned long)global_status.resume_offset);
298 if (playlist_resume() != -1)
300 playlist_start(global_status.resume_index,
301 global_status.resume_offset);
302 ret_val = gui_wps_show();
305 else
307 splash(HZ*2, ID2P(LANG_NOTHING_TO_RESUME));
309 return ret_val;
311 #if CONFIG_TUNER
312 static int radio(void* param)
314 (void)param;
315 radio_screen();
316 return GO_TO_ROOT;
318 #endif
320 static int miscscrn(void * param)
322 const struct menu_item_ex *menu = (const struct menu_item_ex*)param;
323 int result = do_menu(menu, NULL, NULL, false);
324 switch (result)
326 case GO_TO_PLAYLIST_VIEWER:
327 case GO_TO_WPS:
328 return result;
329 default:
330 return GO_TO_ROOT;
334 static int playlist_view(void * param)
336 (void)param;
337 switch (playlist_viewer())
339 case PLAYLIST_VIEWER_MAINMENU:
340 case PLAYLIST_VIEWER_USB:
341 return GO_TO_ROOT;
342 case PLAYLIST_VIEWER_OK:
343 return GO_TO_PREVIOUS;
345 return GO_TO_PREVIOUS;
348 static int load_bmarks(void* param)
350 (void)param;
351 if(bookmark_mrb_load())
352 return GO_TO_WPS;
353 return GO_TO_PREVIOUS;
356 int time_screen(void* ignored);
358 /* These are all static const'd from apps/menus/ *.c
359 so little hack so we can use them */
360 extern struct menu_item_ex
361 file_menu,
362 #ifdef HAVE_TAGCACHE
363 tagcache_menu,
364 #endif
365 main_menu_,
366 manage_settings,
367 plugin_menu,
368 playlist_options,
369 info_menu,
370 system_menu;
371 static const struct root_items items[] = {
372 [GO_TO_FILEBROWSER] = { browser, (void*)GO_TO_FILEBROWSER, &file_menu},
373 #ifdef HAVE_TAGCACHE
374 [GO_TO_DBBROWSER] = { browser, (void*)GO_TO_DBBROWSER, &tagcache_menu },
375 #endif
376 [GO_TO_WPS] = { wpsscrn, NULL, &playback_settings },
377 [GO_TO_MAINMENU] = { miscscrn, (struct menu_item_ex*)&main_menu_,
378 &manage_settings },
380 #ifdef HAVE_RECORDING
381 [GO_TO_RECSCREEN] = { recscrn, NULL, &recording_settings_menu },
382 #endif
384 #if CONFIG_TUNER
385 [GO_TO_FM] = { radio, NULL, &radio_settings_menu },
386 #endif
388 [GO_TO_RECENTBMARKS] = { load_bmarks, NULL, &bookmark_settings_menu },
389 [GO_TO_BROWSEPLUGINS] = { miscscrn, &plugin_menu, NULL },
390 [GO_TO_PLAYLISTS_SCREEN] = { miscscrn, &playlist_options,
391 &playlist_settings },
392 [GO_TO_PLAYLIST_VIEWER] = { playlist_view, NULL, NULL },
393 [GO_TO_SYSTEM_SCREEN] = { miscscrn, &info_menu, &system_menu },
396 static const int nb_items = sizeof(items)/sizeof(*items);
398 static int item_callback(int action, const struct menu_item_ex *this_item) ;
400 MENUITEM_RETURNVALUE(file_browser, ID2P(LANG_DIR_BROWSER), GO_TO_FILEBROWSER,
401 NULL, Icon_file_view_menu);
402 #ifdef HAVE_TAGCACHE
403 MENUITEM_RETURNVALUE(db_browser, ID2P(LANG_TAGCACHE), GO_TO_DBBROWSER,
404 NULL, Icon_Audio);
405 #endif
406 MENUITEM_RETURNVALUE(rocks_browser, ID2P(LANG_PLUGINS), GO_TO_BROWSEPLUGINS,
407 NULL, Icon_Plugin);
408 static char *get_wps_item_name(int selected_item, void * data, char *buffer)
410 (void)selected_item; (void)data; (void)buffer;
411 if (audio_status())
412 return ID2P(LANG_NOW_PLAYING);
413 return ID2P(LANG_RESUME_PLAYBACK);
415 MENUITEM_RETURNVALUE_DYNTEXT(wps_item, GO_TO_WPS, NULL, get_wps_item_name,
416 NULL, NULL, Icon_Playback_menu);
417 #ifdef HAVE_RECORDING
418 MENUITEM_RETURNVALUE(rec, ID2P(LANG_RECORDING), GO_TO_RECSCREEN,
419 NULL, Icon_Recording);
420 #endif
421 #if CONFIG_TUNER
422 MENUITEM_RETURNVALUE(fm, ID2P(LANG_FM_RADIO), GO_TO_FM,
423 item_callback, Icon_Radio_screen);
424 #endif
425 MENUITEM_RETURNVALUE(menu_, ID2P(LANG_SETTINGS), GO_TO_MAINMENU,
426 NULL, Icon_Submenu_Entered);
427 MENUITEM_RETURNVALUE(bookmarks, ID2P(LANG_BOOKMARK_MENU_RECENT_BOOKMARKS),
428 GO_TO_RECENTBMARKS, item_callback,
429 Icon_Bookmark);
430 MENUITEM_RETURNVALUE(playlists, ID2P(LANG_PLAYLISTS), GO_TO_PLAYLISTS_SCREEN,
431 NULL, Icon_Playlist);
432 MENUITEM_RETURNVALUE(system_menu_, ID2P(LANG_SYSTEM), GO_TO_SYSTEM_SCREEN,
433 NULL, Icon_System_menu);
435 #if CONFIG_KEYPAD == PLAYER_PAD
436 static int do_shutdown(void)
438 #if CONFIG_CHARGING
439 if (charger_inserted())
440 charging_splash();
441 else
442 #endif
443 sys_poweroff();
444 return 0;
446 MENUITEM_FUNCTION(do_shutdown_item, 0, ID2P(LANG_SHUTDOWN),
447 do_shutdown, NULL, NULL, Icon_NOICON);
448 #endif
449 MAKE_MENU(root_menu_, ID2P(LANG_ROCKBOX_TITLE),
450 item_callback, Icon_Rockbox,
451 &bookmarks, &file_browser,
452 #ifdef HAVE_TAGCACHE
453 &db_browser,
454 #endif
455 &wps_item, &menu_,
456 #ifdef HAVE_RECORDING
457 &rec,
458 #endif
459 #if CONFIG_TUNER
460 &fm,
461 #endif
462 &playlists, &rocks_browser, &system_menu_
464 #if CONFIG_KEYPAD == PLAYER_PAD
465 ,&do_shutdown_item
466 #endif
469 static int item_callback(int action, const struct menu_item_ex *this_item)
471 switch (action)
473 case ACTION_TREE_STOP:
474 return ACTION_REDRAW;
475 case ACTION_REQUEST_MENUITEM:
476 #if CONFIG_TUNER
477 if (this_item == &fm)
479 if (radio_hardware_present() == 0)
480 return ACTION_EXIT_MENUITEM;
482 else
483 #endif
484 if (this_item == &bookmarks)
486 if (global_settings.usemrb == 0)
487 return ACTION_EXIT_MENUITEM;
489 break;
491 return action;
493 static int get_selection(int last_screen)
495 int i;
496 int len = ARRAYLEN(root_menu__);
497 for(i=0; i < len; i++)
499 if (((root_menu__[i]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE) &&
500 (root_menu__[i]->value == last_screen))
502 return i;
505 return 0;
508 static inline int load_screen(int screen)
510 /* set the global_status.last_screen before entering,
511 if we dont we will always return to the wrong screen on boot */
512 int old_previous = last_screen;
513 int ret_val;
514 if (screen <= GO_TO_ROOT)
515 return screen;
516 if (screen == old_previous)
517 old_previous = GO_TO_ROOT;
518 global_status.last_screen = (char)screen;
519 status_save();
520 ret_val = items[screen].function(items[screen].param);
521 last_screen = screen;
522 if (ret_val == GO_TO_PREVIOUS)
523 last_screen = old_previous;
524 return ret_val;
526 static int load_context_screen(int selection)
528 const struct menu_item_ex *context_menu = NULL;
529 if ((root_menu__[selection]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE)
531 int item = root_menu__[selection]->value;
532 context_menu = items[item].context_menu;
534 /* special cases */
535 else if (root_menu__[selection] == &info_menu)
537 context_menu = &system_menu;
540 if (context_menu)
541 return do_menu(context_menu, NULL, NULL, false);
542 else
543 return GO_TO_PREVIOUS;
546 #ifdef HAVE_PICTUREFLOW_INTEGRATION
547 static int load_plugin_screen(char *plug_path)
549 int ret_val;
550 int old_previous = last_screen;
551 last_screen = next_screen;
552 global_status.last_screen = (char)next_screen;
553 status_save();
555 switch (plugin_load(plug_path, NULL))
557 case PLUGIN_GOTO_WPS:
558 ret_val = GO_TO_WPS;
559 break;
560 case PLUGIN_OK:
561 ret_val = audio_status() ? GO_TO_PREVIOUS : GO_TO_ROOT;
562 break;
563 default:
564 ret_val = GO_TO_PREVIOUS;
565 break;
568 if (ret_val == GO_TO_PREVIOUS)
569 last_screen = (old_previous == next_screen) ? GO_TO_ROOT : old_previous;
570 return ret_val;
572 #endif
574 static int previous_music = GO_TO_WPS;
576 void previous_music_is_wps(void)
578 previous_music = GO_TO_WPS;
581 int current_screen(void)
583 return next_screen;
586 void root_menu(void)
588 int previous_browser = GO_TO_FILEBROWSER;
589 int selected = 0;
591 if (global_settings.start_in_screen == 0)
592 next_screen = (int)global_status.last_screen;
593 else next_screen = global_settings.start_in_screen - 2;
594 add_event(PLAYBACK_EVENT_TRACK_CHANGE, false, rootmenu_track_changed_callback);
595 #ifdef HAVE_RTC_ALARM
596 if ( rtc_check_alarm_started(true) )
598 rtc_enable_alarm(false);
599 next_screen = GO_TO_WPS;
600 #if CONFIG_TUNER
601 if (global_settings.alarm_wake_up_screen == ALARM_START_FM)
602 next_screen = GO_TO_FM;
603 #endif
604 #ifdef HAVE_RECORDING
605 if (global_settings.alarm_wake_up_screen == ALARM_START_REC)
607 recording_start_automatic = true;
608 next_screen = GO_TO_RECSCREEN;
610 #endif
612 #endif /* HAVE_RTC_ALARM */
614 #ifdef HAVE_HEADPHONE_DETECTION
615 if (next_screen == GO_TO_WPS &&
616 (global_settings.unplug_autoresume && !headphones_inserted() ))
617 next_screen = GO_TO_ROOT;
618 #endif
620 while (true)
622 switch (next_screen)
624 case MENU_ATTACHED_USB:
625 case MENU_SELECTED_EXIT:
626 /* fall through */
627 case GO_TO_ROOT:
628 if (last_screen != GO_TO_ROOT)
629 selected = get_selection(last_screen);
630 #if (CONFIG_PLATFORM&PLATFORM_ANDROID)
631 /* When we are in the main menu we want the hardware BACK
632 * button to be handled by Android instead of rockbox */
633 android_ignore_back_button(true);
634 #endif
635 next_screen = do_menu(&root_menu_, &selected, NULL, false);
636 #if (CONFIG_PLATFORM&PLATFORM_ANDROID)
637 android_ignore_back_button(false);
638 #endif
639 if (next_screen != GO_TO_PREVIOUS)
640 last_screen = GO_TO_ROOT;
641 break;
643 case GO_TO_PREVIOUS:
644 next_screen = last_screen;
645 break;
647 case GO_TO_PREVIOUS_BROWSER:
648 next_screen = previous_browser;
649 break;
651 case GO_TO_PREVIOUS_MUSIC:
652 next_screen = previous_music;
653 break;
654 case GO_TO_ROOTITEM_CONTEXT:
655 next_screen = load_context_screen(selected);
656 break;
657 #ifdef HAVE_PICTUREFLOW_INTEGRATION
658 case GO_TO_PICTUREFLOW:
659 while ( !tagcache_is_usable() )
661 splash(0, str(LANG_TAGCACHE_BUSY));
662 if ( action_userabort(HZ/5) )
663 break;
666 char pf_path[MAX_PATH];
667 snprintf(pf_path, sizeof(pf_path),
668 "%s/pictureflow.rock",
669 PLUGIN_DEMOS_DIR);
670 next_screen = load_plugin_screen(pf_path);
672 previous_browser = GO_TO_PICTUREFLOW;
673 break;
674 #endif
675 default:
676 if (next_screen == GO_TO_FILEBROWSER
677 #ifdef HAVE_TAGCACHE
678 || next_screen == GO_TO_DBBROWSER
679 #endif
681 previous_browser = next_screen;
682 if (next_screen == GO_TO_WPS
683 #if CONFIG_TUNER
684 || next_screen == GO_TO_FM
685 #endif
687 previous_music = next_screen;
688 next_screen = load_screen(next_screen);
689 break;
690 } /* switch() */