apps/root_menu.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 Jonathan Gordon
  11  *
  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.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <stdbool.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"
  40
  41 #ifdef HAVE_HOTSWAP
  42 #include "storage.h"
  43 #include "hotswap.h"
  44 #include "dir.h"
  45 #endif
  46 /* gui api */
  47 #include "list.h"
  48 #include "splash.h"
  49 #include "action.h"
  50 #include "yesno.h"
  51 #include "viewport.h"
  52
  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 "wps.h"
  61 #include "bookmark.h"
  62 #include "playlist.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
  72 struct root_items {
  73     int (*function)(void* param);
  74     void* param;
  75     const struct menu_item_ex *context_menu;
  76 };
  77 static int next_screen = GO_TO_ROOT; /* holding info about the upcoming screen
  78                                         * which is the current screen for the
  79                                         * rest of the code after load_screen
  80                                         * is called */
  81 static int last_screen = GO_TO_ROOT; /* unfortunatly needed so we can resume
  82                                         or goto current track based on previous
  83                                         screen */
  84
  85
  86 static char current_track_path[MAX_PATH];
  87 static void rootmenu_track_changed_callback(void* param)
  88 {
  89     struct mp3entry *id3 = (struct mp3entry *)param;
  90     strlcpy(current_track_path, id3->path, MAX_PATH);
  91 }
  92 static int browser(void* param)
  93 {
  94     int ret_val;
  95 #ifdef HAVE_TAGCACHE
  96     struct tree_context* tc = tree_get_context();
  97 #endif
  98     int filter = SHOW_SUPPORTED;
  99     char folder[MAX_PATH] = "/";
 100     /* stuff needed to remember position in file browser */
 101     static char last_folder[MAX_PATH] = "/";
 102     /* and stuff for the database browser */
 103 #ifdef HAVE_TAGCACHE
 104     static int last_db_dirlevel = 0, last_db_selection = 0;
 105 #endif
 106
 107     switch ((intptr_t)param)
 108     {
 109         case GO_TO_FILEBROWSER:
 110             filter = global_settings.dirfilter;
 111             if (global_settings.browse_current &&
 112                     last_screen == GO_TO_WPS &&
 113                     current_track_path[0])
 114             {
 115                 strcpy(folder, current_track_path);
 116             }
 117             else
 118             {
 119 #ifdef HAVE_HOTSWAP
 120                 bool in_hotswap = false;
 121                 /* handle entering an ejected drive */
 122                 int i;
 123                 for (i = 0; i < NUM_VOLUMES; i++)
 124                 {
 125                     char vol_string[VOL_ENUM_POS + 8];
 126                     if (!storage_removable(i))
 127                         continue;
 128                     /* VOL_NAMES contains a %d */
 129                     snprintf(vol_string, sizeof(vol_string), "/"VOL_NAMES, i);
 130                     /* test whether we would browse the external card */
 131                     if (!storage_present(i) &&
 132                             (strstr(last_folder, vol_string)
 133 #ifdef HAVE_HOTSWAP_STORAGE_AS_MAIN
 134                                                                 || (i == 0)
 135 #endif
 136                                                                 ))
 137                     {   /* leave folder as "/" to avoid crash when trying
 138                          * to access an ejected drive */
 139                         strcpy(folder, "/");
 140                         in_hotswap = true;
 141                         break;
 142                     }
 143                 }
 144             if (!in_hotswap)
 145 #endif
 146                 strcpy(folder, last_folder);
 147             }
 148         break;
 149 #ifdef HAVE_TAGCACHE
 150         case GO_TO_DBBROWSER:
 151             if (!tagcache_is_usable())
 152             {
 153                 bool reinit_attempted = false;
 154
 155                 /* Now display progress until it's ready or the user exits */
 156                 while(!tagcache_is_usable())
 157                 {
 158                     struct tagcache_stat *stat = tagcache_get_stat();
 159
 160                     /* Allow user to exit */
 161                     if (action_userabort(HZ/2))
 162                         break;
 163
 164                     /* Maybe just needs to reboot due to delayed commit */
 165                     if (stat->commit_delayed)
 166                     {
 167                         splash(HZ*2, ID2P(LANG_PLEASE_REBOOT));
 168                         break;
 169                     }
 170
 171                     /* Check if ready status is known */
 172                     if (!stat->readyvalid)
 173                     {
 174                         splash(0, str(LANG_TAGCACHE_BUSY));
 175                         continue;
 176                     }
 177
 178                     /* Re-init if required */
 179                     if (!reinit_attempted && !stat->ready &&
 180                         stat->processed_entries == 0 && stat->commit_step == 0)
 181                     {
 182                         /* Prompt the user */
 183                         reinit_attempted = true;
 184                         static const char *lines[]={
 185                             ID2P(LANG_TAGCACHE_BUSY), ID2P(LANG_TAGCACHE_FORCE_UPDATE)};
 186                         static const struct text_message message={lines, 2};
 187                         if(gui_syncyesno_run(&message, NULL, NULL) == YESNO_NO)
 188                             break;
 189                         int i;
 190                         FOR_NB_SCREENS(i)
 191                             screens[i].clear_display();
 192
 193                         /* Start initialisation */
 194                         tagcache_rebuild();
 195                     }
 196
 197                     /* Display building progress */
 198                     static long talked_tick = 0;
 199                     if(global_settings.talk_menu &&
 200                        (talked_tick == 0
 201                         || TIME_AFTER(current_tick, talked_tick+7*HZ)))
 202                     {
 203                         talked_tick = current_tick;
 204                         if (stat->commit_step > 0)
 205                         {
 206                             talk_id(LANG_TAGCACHE_INIT, false);
 207                             talk_number(stat->commit_step, true);
 208                             talk_id(VOICE_OF, true);
 209                             talk_number(tagcache_get_max_commit_step(), true);
 210                         } else if(stat->processed_entries)
 211                         {
 212                             talk_number(stat->processed_entries, false);
 213                             talk_id(LANG_BUILDING_DATABASE, true);
 214                         }
 215                     }
 216                     if (stat->commit_step > 0)
 217                     {
 218                         if (lang_is_rtl())
 219                         {
 220                             splashf(0, "[%d/%d] %s", stat->commit_step,
 221                                 tagcache_get_max_commit_step(),
 222                                 str(LANG_TAGCACHE_INIT));
 223                         }
 224                         else
 225                         {
 226                             splashf(0, "%s [%d/%d]", str(LANG_TAGCACHE_INIT),
 227                                 stat->commit_step,
 228                                 tagcache_get_max_commit_step());
 229                         }
 230                     }
 231                     else
 232                     {
 233                         splashf(0, str(LANG_BUILDING_DATABASE),
 234                                    stat->processed_entries);
 235                     }
 236                 }
 237             }
 238             send_event(GUI_EVENT_REFRESH, NULL);
 239             if (!tagcache_is_usable())
 240                 return GO_TO_PREVIOUS;
 241             filter = SHOW_ID3DB;
 242             tc->dirlevel = last_db_dirlevel;
 243             tc->selected_item = last_db_selection;
 244         break;
 245 #endif
 246         case GO_TO_BROWSEPLUGINS:
 247             filter = SHOW_PLUGINS;
 248             strlcpy(folder, PLUGIN_DIR, MAX_PATH);
 249         break;
 250     }
 251     ret_val = rockbox_browse(folder, filter);
 252     switch ((intptr_t)param)
 253     {
 254         case GO_TO_FILEBROWSER:
 255             get_current_file(last_folder, MAX_PATH);
 256         break;
 257 #ifdef HAVE_TAGCACHE
 258         case GO_TO_DBBROWSER:
 259             last_db_dirlevel = tc->dirlevel;
 260             last_db_selection = tc->selected_item;
 261         break;
 262 #endif
 263     }
 264     return ret_val;
 265 }
 266
 267 static int menu(void* param)
 268 {
 269     (void)param;
 270     return do_menu(NULL, 0, NULL, false);
 271
 272 }
 273 #ifdef HAVE_RECORDING
 274 static int recscrn(void* param)
 275 {
 276     (void)param;
 277     recording_screen(false);
 278     return GO_TO_ROOT;
 279 }
 280 #endif
 281 static int wpsscrn(void* param)
 282 {
 283     int ret_val = GO_TO_PREVIOUS;
 284     (void)param;
 285     if (audio_status())
 286     {
 287         talk_shutup();
 288         ret_val = gui_wps_show();
 289     }
 290     else if ( global_status.resume_index != -1 )
 291     {
 292         DEBUGF("Resume index %X offset %lX\n",
 293                global_status.resume_index,
 294                (unsigned long)global_status.resume_offset);
 295         if (playlist_resume() != -1)
 296         {
 297             playlist_start(global_status.resume_index,
 298                 global_status.resume_offset);
 299             ret_val = gui_wps_show();
 300         }
 301     }
 302     else
 303     {
 304         splash(HZ*2, ID2P(LANG_NOTHING_TO_RESUME));
 305     }
 306     return ret_val;
 307 }
 308 #if CONFIG_TUNER
 309 static int radio(void* param)
 310 {
 311     (void)param;
 312     radio_screen();
 313     return GO_TO_ROOT;
 314 }
 315 #endif
 316
 317 static int load_bmarks(void* param)
 318 {
 319     (void)param;
 320     if(bookmark_mrb_load())
 321         return GO_TO_WPS;
 322     return GO_TO_PREVIOUS;
 323 }
 324 static int plugins_menu(void* param)
 325 {
 326     (void)param;
 327     MENUITEM_STRINGLIST(plugins_menu_items, ID2P(LANG_PLUGINS), NULL,
 328                         ID2P(LANG_PLUGIN_GAMES),
 329                         ID2P(LANG_PLUGIN_APPS), ID2P(LANG_PLUGIN_DEMOS));
 330     char *folder;
 331     int retval = GO_TO_PREVIOUS;
 332     int selection = 0, current = 0;
 333     while (retval == GO_TO_PREVIOUS)
 334     {
 335         selection = do_menu(&plugins_menu_items, &current, NULL, false);
 336         switch (selection)
 337         {
 338             case 0:
 339                 folder = PLUGIN_GAMES_DIR;
 340                 break;
 341             case 1:
 342                 folder = PLUGIN_APPS_DIR;
 343                 break;
 344             case 2:
 345                 folder = PLUGIN_DEMOS_DIR;
 346                 break;
 347             default:
 348                 return selection;
 349         }
 350         retval = rockbox_browse(folder, SHOW_PLUGINS);
 351     }
 352     return retval;
 353 }
 354 int time_screen(void* ignored);
 355
 356 /* These are all static const'd from apps/menus/ *.c
 357    so little hack so we can use them */
 358 extern struct menu_item_ex
 359         file_menu,
 360 #ifdef HAVE_TAGCACHE
 361         tagcache_menu,
 362 #endif
 363         manage_settings,
 364         recording_settings_menu,
 365         radio_settings_menu,
 366         bookmark_settings_menu,
 367         system_menu;
 368 static const struct root_items items[] = {
 369     [GO_TO_FILEBROWSER] =   { browser, (void*)GO_TO_FILEBROWSER, &file_menu},
 370 #ifdef HAVE_TAGCACHE
 371     [GO_TO_DBBROWSER] =     { browser, (void*)GO_TO_DBBROWSER, &tagcache_menu },
 372 #endif
 373     [GO_TO_WPS] =           { wpsscrn, NULL, &playback_settings },
 374     [GO_TO_MAINMENU] =      { menu, NULL, &manage_settings },
 375
 376 #ifdef HAVE_RECORDING
 377     [GO_TO_RECSCREEN] =     {  recscrn, NULL, &recording_settings_menu },
 378 #endif
 379
 380 #if CONFIG_TUNER
 381     [GO_TO_FM] =            { radio, NULL, &radio_settings_menu },
 382 #endif
 383
 384     [GO_TO_RECENTBMARKS] =  { load_bmarks, NULL, &bookmark_settings_menu },
 385     [GO_TO_BROWSEPLUGINS] = { plugins_menu, NULL, NULL },
 386
 387 };
 388 static const int nb_items = sizeof(items)/sizeof(*items);
 389
 390 static int item_callback(int action, const struct menu_item_ex *this_item) ;
 391
 392 MENUITEM_RETURNVALUE(file_browser, ID2P(LANG_DIR_BROWSER), GO_TO_FILEBROWSER,
 393                         NULL, Icon_file_view_menu);
 394 #ifdef HAVE_TAGCACHE
 395 MENUITEM_RETURNVALUE(db_browser, ID2P(LANG_TAGCACHE), GO_TO_DBBROWSER,
 396                         NULL, Icon_Audio);
 397 #endif
 398 MENUITEM_RETURNVALUE(rocks_browser, ID2P(LANG_PLUGINS), GO_TO_BROWSEPLUGINS,
 399                         NULL, Icon_Plugin);
 400 static char *get_wps_item_name(int selected_item, void * data, char *buffer)
 401 {
 402     (void)selected_item; (void)data; (void)buffer;
 403     if (audio_status())
 404         return ID2P(LANG_NOW_PLAYING);
 405     return ID2P(LANG_RESUME_PLAYBACK);
 406 }
 407 MENUITEM_RETURNVALUE_DYNTEXT(wps_item, GO_TO_WPS, NULL, get_wps_item_name,
 408                                 NULL, NULL, Icon_Playback_menu);
 409 #ifdef HAVE_RECORDING
 410 MENUITEM_RETURNVALUE(rec, ID2P(LANG_RECORDING), GO_TO_RECSCREEN,
 411                         NULL, Icon_Recording);
 412 #endif
 413 #if CONFIG_TUNER
 414 MENUITEM_RETURNVALUE(fm, ID2P(LANG_FM_RADIO), GO_TO_FM,
 415                         item_callback, Icon_Radio_screen);
 416 #endif
 417 MENUITEM_RETURNVALUE(menu_, ID2P(LANG_SETTINGS), GO_TO_MAINMENU,
 418                         NULL, Icon_Submenu_Entered);
 419 MENUITEM_RETURNVALUE(bookmarks, ID2P(LANG_BOOKMARK_MENU_RECENT_BOOKMARKS),
 420                         GO_TO_RECENTBMARKS,  item_callback,
 421                         Icon_Bookmark);
 422 #ifdef HAVE_LCD_CHARCELLS
 423 static int do_shutdown(void)
 424 {
 425 #if CONFIG_CHARGING
 426     if (charger_inserted())
 427         charging_splash();
 428     else
 429 #endif
 430         sys_poweroff();
 431     return 0;
 432 }
 433 MENUITEM_FUNCTION(do_shutdown_item, 0, ID2P(LANG_SHUTDOWN),
 434                   do_shutdown, NULL, NULL, Icon_NOICON);
 435 #endif
 436 MAKE_MENU(root_menu_, ID2P(LANG_ROCKBOX_TITLE),
 437             item_callback, Icon_Rockbox,
 438             &bookmarks, &file_browser,
 439 #ifdef HAVE_TAGCACHE
 440             &db_browser,
 441 #endif
 442             &wps_item, &menu_,
 443 #ifdef HAVE_RECORDING
 444             &rec,
 445 #endif
 446 #if CONFIG_TUNER
 447             &fm,
 448 #endif
 449             &playlist_options, &rocks_browser,  &info_menu
 450
 451 #ifdef HAVE_LCD_CHARCELLS
 452             ,&do_shutdown_item
 453 #endif
 454         );
 455
 456 static int item_callback(int action, const struct menu_item_ex *this_item)
 457 {
 458     switch (action)
 459     {
 460         case ACTION_TREE_STOP:
 461             return ACTION_REDRAW;
 462         case ACTION_REQUEST_MENUITEM:
 463 #if CONFIG_TUNER
 464             if (this_item == &fm)
 465             {
 466                 if (radio_hardware_present() == 0)
 467                     return ACTION_EXIT_MENUITEM;
 468             }
 469             else
 470 #endif
 471                 if (this_item == &bookmarks)
 472             {
 473                 if (global_settings.usemrb == 0)
 474                     return ACTION_EXIT_MENUITEM;
 475             }
 476         break;
 477     }
 478     return action;
 479 }
 480 static int get_selection(int last_screen)
 481 {
 482     int i;
 483     int len = ARRAYLEN(root_menu__);
 484     for(i=0; i < len; i++)
 485     {
 486         if (((root_menu__[i]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE) &&
 487             (root_menu__[i]->value == last_screen))
 488         {
 489             return i;
 490         }
 491     }
 492     return 0;
 493 }
 494
 495 static inline int load_screen(int screen)
 496 {
 497     /* set the global_status.last_screen before entering,
 498         if we dont we will always return to the wrong screen on boot */
 499     int old_previous = last_screen;
 500     int ret_val;
 501     if (screen <= GO_TO_ROOT)
 502         return screen;
 503     if (screen == old_previous)
 504         old_previous = GO_TO_ROOT;
 505     global_status.last_screen = (char)screen;
 506     status_save();
 507     ret_val = items[screen].function(items[screen].param);
 508     last_screen = screen;
 509     if (ret_val == GO_TO_PREVIOUS)
 510         last_screen = old_previous;
 511     return ret_val;
 512 }
 513 static int load_context_screen(int selection)
 514 {
 515     const struct menu_item_ex *context_menu = NULL;
 516     if ((root_menu__[selection]->flags&MENU_TYPE_MASK) == MT_RETURN_VALUE)
 517     {
 518         int item = root_menu__[selection]->value;
 519         context_menu = items[item].context_menu;
 520     }
 521     /* special cases */
 522     else if (root_menu__[selection] == &info_menu)
 523     {
 524         context_menu = &system_menu;
 525     }
 526
 527     if (context_menu)
 528         return do_menu(context_menu, NULL, NULL, false);
 529     else
 530         return GO_TO_PREVIOUS;
 531 }
 532
 533 static int previous_music = GO_TO_WPS;
 534
 535 void previous_music_is_wps(void)
 536 {
 537     previous_music = GO_TO_WPS;
 538 }
 539
 540 int current_screen(void)
 541 {
 542     return next_screen;
 543 }
 544
 545 void root_menu(void)
 546 {
 547     int previous_browser = GO_TO_FILEBROWSER;
 548     int selected = 0;
 549
 550     if (global_settings.start_in_screen == 0)
 551         next_screen = (int)global_status.last_screen;
 552     else next_screen = global_settings.start_in_screen - 2;
 553     add_event(PLAYBACK_EVENT_TRACK_CHANGE, false, rootmenu_track_changed_callback);
 554 #ifdef HAVE_RTC_ALARM
 555     if ( rtc_check_alarm_started(true) )
 556     {
 557         rtc_enable_alarm(false);
 558         next_screen = GO_TO_WPS;
 559 #if CONFIG_TUNER
 560         if (global_settings.alarm_wake_up_screen == ALARM_START_FM)
 561             next_screen = GO_TO_FM;
 562 #endif
 563 #ifdef HAVE_RECORDING
 564         if (global_settings.alarm_wake_up_screen == ALARM_START_REC)
 565         {
 566             recording_start_automatic = true;
 567             next_screen = GO_TO_RECSCREEN;
 568         }
 569 #endif
 570     }
 571 #endif /* HAVE_RTC_ALARM */
 572
 573 #ifdef HAVE_HEADPHONE_DETECTION
 574     if (next_screen == GO_TO_WPS &&
 575         (global_settings.unplug_autoresume && !headphones_inserted() ))
 576             next_screen = GO_TO_ROOT;
 577 #endif
 578
 579     while (true)
 580     {
 581         switch (next_screen)
 582         {
 583             case MENU_ATTACHED_USB:
 584             case MENU_SELECTED_EXIT:
 585                 /* fall through */
 586             case GO_TO_ROOT:
 587                 if (last_screen != GO_TO_ROOT)
 588                     selected = get_selection(last_screen);
 589                 next_screen = do_menu(&root_menu_, &selected, NULL, false);
 590                 if (next_screen != GO_TO_PREVIOUS)
 591                     last_screen = GO_TO_ROOT;
 592                 break;
 593
 594             case GO_TO_PREVIOUS:
 595                 next_screen = last_screen;
 596                 break;
 597
 598             case GO_TO_PREVIOUS_BROWSER:
 599                 next_screen = previous_browser;
 600                 break;
 601
 602             case GO_TO_PREVIOUS_MUSIC:
 603                 next_screen = previous_music;
 604                 break;
 605             case GO_TO_ROOTITEM_CONTEXT:
 606                 next_screen = load_context_screen(selected);
 607                 break;
 608             default:
 609                 if (next_screen == GO_TO_FILEBROWSER
 610 #ifdef HAVE_TAGCACHE
 611                     || next_screen == GO_TO_DBBROWSER
 612 #endif
 613                    )
 614                     previous_browser = next_screen;
 615                 if (next_screen == GO_TO_WPS
 616 #if CONFIG_TUNER
 617                     || next_screen == GO_TO_FM
 618 #endif
 619                    )
 620                     previous_music = next_screen;
 621                 next_screen = load_screen(next_screen);
 622                 break;
 623         } /* switch() */
 624     }
 625 }