FS#11808 - Major playlist handling changes (on disk playlists)
[kugel-rb.git] / apps / root_menu.c
blob573ea9415cc5f7ae7893a338994690d6f03c9bcc
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 "playlist_catalog.h"
64 #include "menus/exported_menus.h"
65 #ifdef HAVE_RTC_ALARM
66 #include "rtc.h"
67 #endif
68 #ifdef HAVE_TAGCACHE
69 #include "tagcache.h"
70 #endif
71 #include "language.h"
72 #include "plugin.h"
74 struct root_items {
75 int (*function)(void* param);
76 void* param;
77 const struct menu_item_ex *context_menu;
79 static int next_screen = GO_TO_ROOT; /* holding info about the upcoming screen
80 * which is the current screen for the
81 * rest of the code after load_screen
82 * is called */
83 static int last_screen = GO_TO_ROOT; /* unfortunatly needed so we can resume
84 or goto current track based on previous
85 screen */
88 static char current_track_path[MAX_PATH];
89 static void rootmenu_track_changed_callback(void* param)
91 struct mp3entry *id3 = (struct mp3entry *)param;
92 strlcpy(current_track_path, id3->path, MAX_PATH);
94 static int browser(void* param)
96 int ret_val;
97 #ifdef HAVE_TAGCACHE
98 struct tree_context* tc = tree_get_context();
99 #endif
100 struct browse_context browse;
101 int filter = SHOW_SUPPORTED;
102 char folder[MAX_PATH] = "/";
103 /* stuff needed to remember position in file browser */
104 static char last_folder[MAX_PATH] = "/";
105 /* and stuff for the database browser */
106 #ifdef HAVE_TAGCACHE
107 static int last_db_dirlevel = 0, last_db_selection = 0;
108 #endif
110 switch ((intptr_t)param)
112 case GO_TO_FILEBROWSER:
113 filter = global_settings.dirfilter;
114 if (global_settings.browse_current &&
115 last_screen == GO_TO_WPS &&
116 current_track_path[0])
118 strcpy(folder, current_track_path);
120 else if (!strcmp(last_folder, "/"))
122 strcpy(folder, global_settings.start_directory);
124 else
126 #ifdef HAVE_HOTSWAP
127 bool in_hotswap = false;
128 /* handle entering an ejected drive */
129 int i;
130 for (i = 0; i < NUM_VOLUMES; i++)
132 char vol_string[VOL_ENUM_POS + 8];
133 if (!storage_removable(i))
134 continue;
135 /* VOL_NAMES contains a %d */
136 snprintf(vol_string, sizeof(vol_string), "/"VOL_NAMES, i);
137 /* test whether we would browse the external card */
138 if (!storage_present(i) &&
139 (strstr(last_folder, vol_string)
140 #ifdef HAVE_HOTSWAP_STORAGE_AS_MAIN
141 || (i == 0)
142 #endif
144 { /* leave folder as "/" to avoid crash when trying
145 * to access an ejected drive */
146 strcpy(folder, "/");
147 in_hotswap = true;
148 break;
151 if (!in_hotswap)
152 #endif
153 strcpy(folder, last_folder);
155 push_current_activity(ACTIVITY_FILEBROWSER);
156 break;
157 #ifdef HAVE_TAGCACHE
158 case GO_TO_DBBROWSER:
159 if (!tagcache_is_usable())
161 bool reinit_attempted = false;
163 /* Now display progress until it's ready or the user exits */
164 while(!tagcache_is_usable())
166 struct tagcache_stat *stat = tagcache_get_stat();
168 /* Allow user to exit */
169 if (action_userabort(HZ/2))
170 break;
172 /* Maybe just needs to reboot due to delayed commit */
173 if (stat->commit_delayed)
175 splash(HZ*2, ID2P(LANG_PLEASE_REBOOT));
176 break;
179 /* Check if ready status is known */
180 if (!stat->readyvalid)
182 splash(0, str(LANG_TAGCACHE_BUSY));
183 continue;
186 /* Re-init if required */
187 if (!reinit_attempted && !stat->ready &&
188 stat->processed_entries == 0 && stat->commit_step == 0)
190 /* Prompt the user */
191 reinit_attempted = true;
192 static const char *lines[]={
193 ID2P(LANG_TAGCACHE_BUSY), ID2P(LANG_TAGCACHE_FORCE_UPDATE)};
194 static const struct text_message message={lines, 2};
195 if(gui_syncyesno_run(&message, NULL, NULL) == YESNO_NO)
196 break;
197 int i;
198 FOR_NB_SCREENS(i)
199 screens[i].clear_display();
201 /* Start initialisation */
202 tagcache_rebuild();
205 /* Display building progress */
206 static long talked_tick = 0;
207 if(global_settings.talk_menu &&
208 (talked_tick == 0
209 || TIME_AFTER(current_tick, talked_tick+7*HZ)))
211 talked_tick = current_tick;
212 if (stat->commit_step > 0)
214 talk_id(LANG_TAGCACHE_INIT, false);
215 talk_number(stat->commit_step, true);
216 talk_id(VOICE_OF, true);
217 talk_number(tagcache_get_max_commit_step(), true);
218 } else if(stat->processed_entries)
220 talk_number(stat->processed_entries, false);
221 talk_id(LANG_BUILDING_DATABASE, true);
224 if (stat->commit_step > 0)
226 if (lang_is_rtl())
228 splashf(0, "[%d/%d] %s", stat->commit_step,
229 tagcache_get_max_commit_step(),
230 str(LANG_TAGCACHE_INIT));
232 else
234 splashf(0, "%s [%d/%d]", str(LANG_TAGCACHE_INIT),
235 stat->commit_step,
236 tagcache_get_max_commit_step());
239 else
241 splashf(0, str(LANG_BUILDING_DATABASE),
242 stat->processed_entries);
246 if (!tagcache_is_usable())
247 return GO_TO_PREVIOUS;
248 filter = SHOW_ID3DB;
249 tc->dirlevel = last_db_dirlevel;
250 tc->selected_item = last_db_selection;
251 push_current_activity(ACTIVITY_DATABASEBROWSER);
252 break;
253 #endif
256 browse_context_init(&browse, filter, 0, NULL, NOICON, folder, NULL);
257 ret_val = rockbox_browse(&browse);
258 pop_current_activity();
259 switch ((intptr_t)param)
261 case GO_TO_FILEBROWSER:
262 if (!get_current_file(last_folder, MAX_PATH) ||
263 (!strchr(&last_folder[1], '/') &&
264 global_settings.start_directory[1] != '\0'))
266 last_folder[0] = '/';
267 last_folder[1] = '\0';
269 break;
270 #ifdef HAVE_TAGCACHE
271 case GO_TO_DBBROWSER:
272 last_db_dirlevel = tc->dirlevel;
273 last_db_selection = tc->selected_item;
274 break;
275 #endif
277 return ret_val;
280 #ifdef HAVE_RECORDING
281 static int recscrn(void* param)
283 (void)param;
284 recording_screen(false);
285 return GO_TO_ROOT;
287 #endif
288 static int wpsscrn(void* param)
290 int ret_val = GO_TO_PREVIOUS;
291 (void)param;
292 push_current_activity(ACTIVITY_WPS);
293 if (audio_status())
295 talk_shutup();
296 ret_val = gui_wps_show();
298 else if ( global_status.resume_index != -1 )
300 DEBUGF("Resume index %X offset %lX\n",
301 global_status.resume_index,
302 (unsigned long)global_status.resume_offset);
303 if (playlist_resume() != -1)
305 playlist_start(global_status.resume_index,
306 global_status.resume_offset);
307 ret_val = gui_wps_show();
310 else
312 splash(HZ*2, ID2P(LANG_NOTHING_TO_RESUME));
314 pop_current_activity();
315 return ret_val;
317 #if CONFIG_TUNER
318 static int radio(void* param)
320 (void)param;
321 radio_screen();
322 return GO_TO_ROOT;
324 #endif
326 static int miscscrn(void * param)
328 const struct menu_item_ex *menu = (const struct menu_item_ex*)param;
329 int result = do_menu(menu, NULL, NULL, false);
330 switch (result)
332 case GO_TO_PLAYLIST_VIEWER:
333 case GO_TO_WPS:
334 return result;
335 default:
336 return GO_TO_ROOT;
341 static int playlist_view_catalog(void * param)
343 /* kludge untill catalog_view_playlists() returns something useful */
344 int old_playstatus = audio_status();
345 (void)param;
346 push_current_activity(ACTIVITY_PLAYLISTBROWSER);
347 catalog_view_playlists();
348 pop_current_activity();
349 if (!old_playstatus && audio_status())
350 return GO_TO_WPS;
351 return GO_TO_PREVIOUS;
354 static int playlist_view(void * param)
356 (void)param;
357 int val;
359 push_current_activity(ACTIVITY_PLAYLISTVIEWER);
360 val = playlist_viewer();
361 pop_current_activity();
362 switch (val)
364 case PLAYLIST_VIEWER_MAINMENU:
365 case PLAYLIST_VIEWER_USB:
366 return GO_TO_ROOT;
367 case PLAYLIST_VIEWER_OK:
368 return GO_TO_PREVIOUS;
370 return GO_TO_PREVIOUS;
373 static int load_bmarks(void* param)
375 (void)param;
376 if(bookmark_mrb_load())
377 return GO_TO_WPS;
378 return GO_TO_PREVIOUS;
381 int time_screen(void* ignored);
383 /* These are all static const'd from apps/menus/ *.c
384 so little hack so we can use them */
385 extern struct menu_item_ex
386 file_menu,
387 #ifdef HAVE_TAGCACHE
388 tagcache_menu,
389 #endif
390 main_menu_,
391 manage_settings,
392 plugin_menu,
393 playlist_options,
394 info_menu,
395 system_menu;
396 static const struct root_items items[] = {
397 [GO_TO_FILEBROWSER] = { browser, (void*)GO_TO_FILEBROWSER, &file_menu},
398 #ifdef HAVE_TAGCACHE
399 [GO_TO_DBBROWSER] = { browser, (void*)GO_TO_DBBROWSER, &tagcache_menu },
400 #endif
401 [GO_TO_WPS] = { wpsscrn, NULL, &playback_settings },
402 [GO_TO_MAINMENU] = { miscscrn, (struct menu_item_ex*)&main_menu_,
403 &manage_settings },
405 #ifdef HAVE_RECORDING
406 [GO_TO_RECSCREEN] = { recscrn, NULL, &recording_settings_menu },
407 #endif
409 #if CONFIG_TUNER
410 [GO_TO_FM] = { radio, NULL, &radio_settings_menu },
411 #endif
413 [GO_TO_RECENTBMARKS] = { load_bmarks, NULL, &bookmark_settings_menu },
414 [GO_TO_BROWSEPLUGINS] = { miscscrn, &plugin_menu, NULL },
415 [GO_TO_PLAYLISTS_SCREEN] = { playlist_view_catalog, NULL,
416 &playlist_options },
417 [GO_TO_PLAYLIST_VIEWER] = { playlist_view, NULL, &playlist_options },
418 [GO_TO_SYSTEM_SCREEN] = { miscscrn, &info_menu, &system_menu },
421 static const int nb_items = sizeof(items)/sizeof(*items);
423 static int item_callback(int action, const struct menu_item_ex *this_item) ;
425 MENUITEM_RETURNVALUE(file_browser, ID2P(LANG_DIR_BROWSER), GO_TO_FILEBROWSER,
426 NULL, Icon_file_view_menu);
427 #ifdef HAVE_TAGCACHE
428 MENUITEM_RETURNVALUE(db_browser, ID2P(LANG_TAGCACHE), GO_TO_DBBROWSER,
429 NULL, Icon_Audio);
430 #endif
431 MENUITEM_RETURNVALUE(rocks_browser, ID2P(LANG_PLUGINS), GO_TO_BROWSEPLUGINS,
432 NULL, Icon_Plugin);
434 MENUITEM_RETURNVALUE(playlist_browser, ID2P(LANG_CATALOG), GO_TO_PLAYLIST_VIEWER,
435 NULL, Icon_Playlist);
437 static char *get_wps_item_name(int selected_item, void * data, char *buffer)
439 (void)selected_item; (void)data; (void)buffer;
440 if (audio_status())
441 return ID2P(LANG_NOW_PLAYING);
442 return ID2P(LANG_RESUME_PLAYBACK);
444 MENUITEM_RETURNVALUE_DYNTEXT(wps_item, GO_TO_WPS, NULL, get_wps_item_name,
445 NULL, NULL, Icon_Playback_menu);
446 #ifdef HAVE_RECORDING
447 MENUITEM_RETURNVALUE(rec, ID2P(LANG_RECORDING), GO_TO_RECSCREEN,
448 NULL, Icon_Recording);
449 #endif
450 #if CONFIG_TUNER
451 MENUITEM_RETURNVALUE(fm, ID2P(LANG_FM_RADIO), GO_TO_FM,
452 item_callback, Icon_Radio_screen);
453 #endif
454 MENUITEM_RETURNVALUE(menu_, ID2P(LANG_SETTINGS), GO_TO_MAINMENU,
455 NULL, Icon_Submenu_Entered);
456 MENUITEM_RETURNVALUE(bookmarks, ID2P(LANG_BOOKMARK_MENU_RECENT_BOOKMARKS),
457 GO_TO_RECENTBMARKS, item_callback,
458 Icon_Bookmark);
459 MENUITEM_RETURNVALUE(playlists, ID2P(LANG_CATALOG), GO_TO_PLAYLISTS_SCREEN,
460 NULL, Icon_Playlist);
461 MENUITEM_RETURNVALUE(system_menu_, ID2P(LANG_SYSTEM), GO_TO_SYSTEM_SCREEN,
462 NULL, Icon_System_menu);
464 #if CONFIG_KEYPAD == PLAYER_PAD
465 static int do_shutdown(void)
467 #if CONFIG_CHARGING
468 if (charger_inserted())
469 charging_splash();
470 else
471 #endif
472 sys_poweroff();
473 return 0;
475 MENUITEM_FUNCTION(do_shutdown_item, 0, ID2P(LANG_SHUTDOWN),
476 do_shutdown, NULL, NULL, Icon_NOICON);
477 #endif
478 MAKE_MENU(root_menu_, ID2P(LANG_ROCKBOX_TITLE),
479 item_callback, Icon_Rockbox,
480 &bookmarks, &file_browser,
481 #ifdef HAVE_TAGCACHE
482 &db_browser,
483 #endif
484 &wps_item, &menu_,
485 #ifdef HAVE_RECORDING
486 &rec,
487 #endif
488 #if CONFIG_TUNER
489 &fm,
490 #endif
491 &playlists, &rocks_browser, &system_menu_
493 #if CONFIG_KEYPAD == PLAYER_PAD
494 ,&do_shutdown_item
495 #endif
498 static int item_callback(int action, const struct menu_item_ex *this_item)
500 switch (action)
502 case ACTION_TREE_STOP:
503 return ACTION_REDRAW;
504 case ACTION_REQUEST_MENUITEM:
505 #if CONFIG_TUNER
506 if (this_item == &fm)
508 if (radio_hardware_present() == 0)
509 return ACTION_EXIT_MENUITEM;
511 else
512 #endif
513 if (this_item == &bookmarks)
515 if (global_settings.usemrb == 0)
516 return ACTION_EXIT_MENUITEM;
518 break;
520 return action;
522 static int get_selection(int last_screen)
524 int i;
525 int len = ARRAYLEN(root_menu__);
526 for(i=0; i < len; i++)
528 if (((root_menu__[i]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE) &&
529 (root_menu__[i]->value == last_screen))
531 return i;
534 return 0;
537 static inline int load_screen(int screen)
539 /* set the global_status.last_screen before entering,
540 if we dont we will always return to the wrong screen on boot */
541 int old_previous = last_screen;
542 int ret_val;
543 enum current_activity activity = ACTIVITY_UNKNOWN;
544 if (screen <= GO_TO_ROOT)
545 return screen;
546 if (screen == old_previous)
547 old_previous = GO_TO_ROOT;
548 global_status.last_screen = (char)screen;
549 status_save();
551 if (screen == GO_TO_BROWSEPLUGINS)
552 activity = ACTIVITY_PLUGINBROWSER;
553 else if (screen == GO_TO_MAINMENU)
554 activity = ACTIVITY_SETTINGS;
556 if (activity != ACTIVITY_UNKNOWN)
557 push_current_activity(activity);
559 ret_val = items[screen].function(items[screen].param);
561 if (activity != ACTIVITY_UNKNOWN)
562 pop_current_activity();
564 last_screen = screen;
565 if (ret_val == GO_TO_PREVIOUS)
566 last_screen = old_previous;
567 return ret_val;
569 static int load_context_screen(int selection)
571 const struct menu_item_ex *context_menu = NULL;
572 if ((root_menu__[selection]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE)
574 int item = root_menu__[selection]->value;
575 context_menu = items[item].context_menu;
577 /* special cases */
578 else if (root_menu__[selection] == &info_menu)
580 context_menu = &system_menu;
583 if (context_menu)
584 return do_menu(context_menu, NULL, NULL, false);
585 else
586 return GO_TO_PREVIOUS;
589 #ifdef HAVE_PICTUREFLOW_INTEGRATION
590 static int load_plugin_screen(char *plug_path)
592 int ret_val;
593 int old_previous = last_screen;
594 last_screen = next_screen;
595 global_status.last_screen = (char)next_screen;
596 status_save();
598 switch (plugin_load(plug_path, NULL))
600 case PLUGIN_GOTO_WPS:
601 ret_val = GO_TO_WPS;
602 break;
603 case PLUGIN_OK:
604 ret_val = audio_status() ? GO_TO_PREVIOUS : GO_TO_ROOT;
605 break;
606 default:
607 ret_val = GO_TO_PREVIOUS;
608 break;
611 if (ret_val == GO_TO_PREVIOUS)
612 last_screen = (old_previous == next_screen) ? GO_TO_ROOT : old_previous;
613 return ret_val;
615 #endif
617 static int previous_music = GO_TO_WPS;
619 void previous_music_is_wps(void)
621 previous_music = GO_TO_WPS;
624 void root_menu(void)
626 int previous_browser = GO_TO_FILEBROWSER;
627 int selected = 0;
629 push_current_activity(ACTIVITY_MAINMENU);
631 if (global_settings.start_in_screen == 0)
632 next_screen = (int)global_status.last_screen;
633 else next_screen = global_settings.start_in_screen - 2;
634 add_event(PLAYBACK_EVENT_TRACK_CHANGE, false, rootmenu_track_changed_callback);
635 #ifdef HAVE_RTC_ALARM
636 if ( rtc_check_alarm_started(true) )
638 rtc_enable_alarm(false);
639 next_screen = GO_TO_WPS;
640 #if CONFIG_TUNER
641 if (global_settings.alarm_wake_up_screen == ALARM_START_FM)
642 next_screen = GO_TO_FM;
643 #endif
644 #ifdef HAVE_RECORDING
645 if (global_settings.alarm_wake_up_screen == ALARM_START_REC)
647 recording_start_automatic = true;
648 next_screen = GO_TO_RECSCREEN;
650 #endif
652 #endif /* HAVE_RTC_ALARM */
654 #ifdef HAVE_HEADPHONE_DETECTION
655 if (next_screen == GO_TO_WPS &&
656 (global_settings.unplug_autoresume && !headphones_inserted() ))
657 next_screen = GO_TO_ROOT;
658 #endif
660 while (true)
662 switch (next_screen)
664 case MENU_ATTACHED_USB:
665 case MENU_SELECTED_EXIT:
666 /* fall through */
667 case GO_TO_ROOT:
668 if (last_screen != GO_TO_ROOT)
669 selected = get_selection(last_screen);
670 #if (CONFIG_PLATFORM&PLATFORM_ANDROID)
671 /* When we are in the main menu we want the hardware BACK
672 * button to be handled by Android instead of rockbox */
673 android_ignore_back_button(true);
674 #endif
675 next_screen = do_menu(&root_menu_, &selected, NULL, false);
676 #if (CONFIG_PLATFORM&PLATFORM_ANDROID)
677 android_ignore_back_button(false);
678 #endif
679 if (next_screen != GO_TO_PREVIOUS)
680 last_screen = GO_TO_ROOT;
681 break;
683 case GO_TO_PREVIOUS:
684 next_screen = last_screen;
685 break;
687 case GO_TO_PREVIOUS_BROWSER:
688 next_screen = previous_browser;
689 break;
691 case GO_TO_PREVIOUS_MUSIC:
692 next_screen = previous_music;
693 break;
694 case GO_TO_ROOTITEM_CONTEXT:
695 next_screen = load_context_screen(selected);
696 break;
697 #ifdef HAVE_PICTUREFLOW_INTEGRATION
698 case GO_TO_PICTUREFLOW:
699 while ( !tagcache_is_usable() )
701 splash(0, str(LANG_TAGCACHE_BUSY));
702 if ( action_userabort(HZ/5) )
703 break;
706 char pf_path[MAX_PATH];
707 snprintf(pf_path, sizeof(pf_path),
708 "%s/pictureflow.rock",
709 PLUGIN_DEMOS_DIR);
710 next_screen = load_plugin_screen(pf_path);
712 previous_browser = GO_TO_PICTUREFLOW;
713 break;
714 #endif
715 default:
716 if (next_screen == GO_TO_FILEBROWSER
717 #ifdef HAVE_TAGCACHE
718 || next_screen == GO_TO_DBBROWSER
719 #endif
721 previous_browser = next_screen;
722 if (next_screen == GO_TO_WPS
723 #if CONFIG_TUNER
724 || next_screen == GO_TO_FM
725 #endif
727 previous_music = next_screen;
728 next_screen = load_screen(next_screen);
729 break;
730 } /* switch() */