apps/gui/wps.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Jerome Kuptz
  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 "config.h"
  25
  26 #include "system.h"
  27 #include "file.h"
  28 #include "lcd.h"
  29 #include "font.h"
  30 #include "backlight.h"
  31 #include "action.h"
  32 #include "kernel.h"
  33 #include "filetypes.h"
  34 #include "debug.h"
  35 #include "sprintf.h"
  36 #include "settings.h"
  37 #include "skin_engine/skin_engine.h"
  38 #include "mp3_playback.h"
  39 #include "audio.h"
  40 #include "usb.h"
  41 #include "status.h"
  42 #include "storage.h"
  43 #include "screens.h"
  44 #include "playlist.h"
  45 #ifdef HAVE_LCD_BITMAP
  46 #include "icons.h"
  47 #include "peakmeter.h"
  48 #endif
  49 #include "lang.h"
  50 #include "bookmark.h"
  51 #include "misc.h"
  52 #include "sound.h"
  53 #include "onplay.h"
  54 #include "abrepeat.h"
  55 #include "playback.h"
  56 #include "splash.h"
  57 #include "cuesheet.h"
  58 #include "ata_idle_notify.h"
  59 #include "root_menu.h"
  60 #include "backdrop.h"
  61 #include "quickscreen.h"
  62 #include "pitchscreen.h"
  63 #include "appevents.h"
  64 #include "viewport.h"
  65 #include "pcmbuf.h"
  66 #include "option_select.h"
  67 #include "dsp.h"
  68 #include "playlist_viewer.h"
  69 #include "wps.h"
  70
  71 #define RESTORE_WPS_INSTANTLY       0l
  72 #define RESTORE_WPS_NEXT_SECOND     ((long)(HZ+current_tick))
  73 /* in milliseconds */
  74 #define DEFAULT_SKIP_TRESH          3000l
  75
  76
  77 #define FF_REWIND_MAX_PERCENT 3 /* cap ff/rewind step size at max % of file */
  78                                 /* 3% of 30min file == 54s step size */
  79 #define MIN_FF_REWIND_STEP 500
  80
  81 /* this is for the viewportmanager */
  82 static int wpsbars = 0;
  83
  84 /* currently only one wps_state is needed, initialize to 0 */
  85 static struct wps_state     wps_state               = { .id3 = NULL };
  86 static struct gui_wps       gui_wps[NB_SCREENS]     = {{ .data = NULL }};
  87 static struct wps_data      wps_datas[NB_SCREENS]   = {{ .wps_loaded = 0 }};
  88
  89 /* initial setup of wps_data  */
  90 static void wps_state_init(void);
  91 static void track_changed_callback(void *param);
  92 static void nextid3available_callback(void* param);
  93 #ifdef HAVE_LCD_BITMAP
  94 static void statusbar_toggle_handler(void *data);
  95 #endif
  96
  97 #define WPS_DEFAULTCFG WPS_DIR "/rockbox_default.wps"
  98 #ifdef HAVE_REMOTE_LCD
  99 #define RWPS_DEFAULTCFG WPS_DIR "/rockbox_default.rwps"
 100 #define DEFAULT_WPS(screen) ((screen) == SCREEN_MAIN ? \
 101                             WPS_DEFAULTCFG:RWPS_DEFAULTCFG)
 102 #else
 103 #define DEFAULT_WPS(screen) (WPS_DEFAULTCFG)
 104 #endif
 105
 106 void wps_data_load(enum screen_type screen, const char *buf, bool isfile)
 107 {
 108     bool loaded_ok;
 109
 110     screens[screen].backdrop_unload(BACKDROP_SKIN_WPS);
 111
 112 #ifndef __PCTOOL__
 113     /*
 114      * Hardcode loading WPS_DEFAULTCFG to cause a reset ideally this
 115      * wants to be a virtual file.  Feel free to modify dirbrowse()
 116      * if you're feeling brave.
 117      */
 118
 119     if (buf && ! strcmp(buf, DEFAULT_WPS(screen)) )
 120     {
 121 #ifdef HAVE_REMOTE_LCD
 122         if (screen == SCREEN_REMOTE)
 123             global_settings.rwps_file[0] = '\0';
 124         else
 125 #endif
 126             global_settings.wps_file[0] = '\0';
 127         buf = NULL;
 128     }
 129
 130 #endif /* __PCTOOL__ */
 131
 132     loaded_ok = buf && skin_data_load(gui_wps[screen].data,
 133                                         &screens[screen], buf, isfile);
 134     if (!loaded_ok) /* load the hardcoded default */
 135     {
 136         char *skin_buf[NB_SCREENS] = {
 137 #ifdef HAVE_LCD_BITMAP
 138             "%s%?it<%?in<%in. |>%it|%fn>\n"
 139             "%s%?ia<%ia|%?d2<%d2|(root)>>\n"
 140             "%s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|>\n\n"
 141             "%al%pc/%pt%ar[%pp:%pe]\n"
 142             "%fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>\n"
 143             "%pb\n%pm\n",
 144 #else
 145             "%s%pp/%pe: %?it<%it|%fn> - %?ia<%ia|%d2> - %?id<%id|%d1>\n"
 146             "%pc%?ps<*|/>%pt\n",
 147 #endif
 148 #ifdef HAVE_REMOTE_LCD
 149             "%s%?ia<%ia|%?d2<%d2|(root)>>\n"
 150             "%s%?it<%?in<%in. |>%it|%fn>\n"
 151             "%al%pc/%pt%ar[%pp:%pe]\n"
 152             "%fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>\n"
 153             "%pb\n",
 154 #endif
 155         };
 156         skin_data_load(gui_wps[screen].data, &screens[screen],
 157                         skin_buf[screen], false);
 158     }
 159 #ifdef HAVE_REMOVE_LCD
 160     gui_wps[screen].data->remote_wps = !(screen == SCREEN_MAIN);
 161 #endif
 162 }
 163
 164 static bool wps_fading_out = false;
 165 void fade(bool fade_in, bool updatewps)
 166 {
 167     int fp_global_vol = global_settings.volume << 8;
 168     int fp_min_vol = sound_min(SOUND_VOLUME) << 8;
 169     int fp_step = (fp_global_vol - fp_min_vol) / 30;
 170     int i;
 171     wps_fading_out = !fade_in;
 172     if (fade_in) {
 173         /* fade in */
 174         int fp_volume = fp_min_vol;
 175
 176         /* zero out the sound */
 177         sound_set_volume(fp_min_vol >> 8);
 178
 179         sleep(HZ/10); /* let audio thread run */
 180         audio_resume();
 181
 182         while (fp_volume < fp_global_vol - fp_step) {
 183             fp_volume += fp_step;
 184             sound_set_volume(fp_volume >> 8);
 185             if (updatewps)
 186             {
 187                 FOR_NB_SCREENS(i)
 188                     skin_update(&gui_wps[i], WPS_REFRESH_NON_STATIC);
 189             }
 190             sleep(1);
 191         }
 192         sound_set_volume(global_settings.volume);
 193     }
 194     else {
 195         /* fade out */
 196         int fp_volume = fp_global_vol;
 197
 198         while (fp_volume > fp_min_vol + fp_step) {
 199             fp_volume -= fp_step;
 200             sound_set_volume(fp_volume >> 8);
 201             if (updatewps)
 202             {
 203                 FOR_NB_SCREENS(i)
 204                     skin_update(&gui_wps[i], WPS_REFRESH_NON_STATIC);
 205             }
 206             sleep(1);
 207         }
 208         audio_pause();
 209         wps_fading_out = false;
 210 #if CONFIG_CODEC != SWCODEC
 211 #ifndef SIMULATOR
 212         /* let audio thread run and wait for the mas to run out of data */
 213         while (!mp3_pause_done())
 214 #endif
 215             sleep(HZ/10);
 216 #endif
 217
 218         /* reset volume to what it was before the fade */
 219         sound_set_volume(global_settings.volume);
 220     }
 221 }
 222 bool is_wps_fading(void)
 223 {
 224     return wps_fading_out;
 225 }
 226
 227 static bool update_onvol_change(struct gui_wps * gwps)
 228 {
 229     skin_update(gwps, WPS_REFRESH_NON_STATIC);
 230
 231 #ifdef HAVE_LCD_CHARCELLS
 232     splashf(0, "Vol: %3d dB",
 233                sound_val2phys(SOUND_VOLUME, global_settings.volume));
 234     return true;
 235 #endif
 236     return false;
 237 }
 238
 239
 240 bool ffwd_rew(int button)
 241 {
 242     unsigned int step = 0;     /* current ff/rewind step */
 243     unsigned int max_step = 0; /* maximum ff/rewind step */
 244     int ff_rewind_count = 0;   /* current ff/rewind count (in ticks) */
 245     int direction = -1;         /* forward=1 or backward=-1 */
 246     bool exit = false;
 247     bool usb = false;
 248     int i = 0;
 249     const long ff_rw_accel = (global_settings.ff_rewind_accel + 3);
 250
 251     if (button == ACTION_NONE)
 252     {
 253         status_set_ffmode(0);
 254         return usb;
 255     }
 256     while (!exit)
 257     {
 258         switch ( button )
 259         {
 260             case ACTION_WPS_SEEKFWD:
 261                  direction = 1;
 262             case ACTION_WPS_SEEKBACK:
 263                 if (wps_state.ff_rewind)
 264                 {
 265                     if (direction == 1)
 266                     {
 267                         /* fast forwarding, calc max step relative to end */
 268                         max_step = (wps_state.id3->length -
 269                                     (wps_state.id3->elapsed +
 270                                      ff_rewind_count)) *
 271                                      FF_REWIND_MAX_PERCENT / 100;
 272                     }
 273                     else
 274                     {
 275                         /* rewinding, calc max step relative to start */
 276                         max_step = (wps_state.id3->elapsed + ff_rewind_count) *
 277                                     FF_REWIND_MAX_PERCENT / 100;
 278                     }
 279
 280                     max_step = MAX(max_step, MIN_FF_REWIND_STEP);
 281
 282                     if (step > max_step)
 283                         step = max_step;
 284
 285                     ff_rewind_count += step * direction;
 286
 287                     /* smooth seeking by multiplying step by: 1 + (2 ^ -accel) */
 288                     step += step >> ff_rw_accel;
 289                 }
 290                 else
 291                 {
 292                     if ( (audio_status() & AUDIO_STATUS_PLAY) &&
 293                           wps_state.id3 && wps_state.id3->length )
 294                     {
 295                         if (!wps_state.paused)
 296 #if (CONFIG_CODEC == SWCODEC)
 297                             audio_pre_ff_rewind();
 298 #else
 299                             audio_pause();
 300 #endif
 301 #if CONFIG_KEYPAD == PLAYER_PAD
 302                         FOR_NB_SCREENS(i)
 303                             gui_wps[i].display->stop_scroll();
 304 #endif
 305                         if (direction > 0)
 306                             status_set_ffmode(STATUS_FASTFORWARD);
 307                         else
 308                             status_set_ffmode(STATUS_FASTBACKWARD);
 309
 310                         wps_state.ff_rewind = true;
 311
 312                         step = 1000 * global_settings.ff_rewind_min_step;
 313                     }
 314                     else
 315                         break;
 316                 }
 317
 318                 if (direction > 0) {
 319                     if ((wps_state.id3->elapsed + ff_rewind_count) >
 320                         wps_state.id3->length)
 321                         ff_rewind_count = wps_state.id3->length -
 322                             wps_state.id3->elapsed;
 323                 }
 324                 else {
 325                     if ((int)(wps_state.id3->elapsed + ff_rewind_count) < 0)
 326                         ff_rewind_count = -wps_state.id3->elapsed;
 327                 }
 328
 329                 /* set the wps state ff_rewind_count so the progess info
 330                    displays corectly */
 331                 wps_state.ff_rewind_count = (wps_state.wps_time_countup == false)?
 332                                             ff_rewind_count:-ff_rewind_count;
 333                 FOR_NB_SCREENS(i)
 334                 {
 335                     skin_update(&gui_wps[i],
 336                                 WPS_REFRESH_PLAYER_PROGRESS |
 337                                 WPS_REFRESH_DYNAMIC);
 338                 }
 339
 340                 break;
 341
 342             case ACTION_WPS_STOPSEEK:
 343                 wps_state.id3->elapsed = wps_state.id3->elapsed+ff_rewind_count;
 344                 audio_ff_rewind(wps_state.id3->elapsed);
 345                 wps_state.ff_rewind_count = 0;
 346                 wps_state.ff_rewind = false;
 347                 status_set_ffmode(0);
 348 #if (CONFIG_CODEC != SWCODEC)
 349                 if (!wps_state.paused)
 350                     audio_resume();
 351 #endif
 352 #ifdef HAVE_LCD_CHARCELLS
 353                 FOR_NB_SCREENS(i)
 354                     skin_update(&gui_wps[i], WPS_REFRESH_ALL);
 355 #endif
 356                 exit = true;
 357                 break;
 358
 359             default:
 360                 if(default_event_handler(button) == SYS_USB_CONNECTED) {
 361                     status_set_ffmode(0);
 362                     usb = true;
 363                     exit = true;
 364                 }
 365                 break;
 366         }
 367         if (!exit)
 368         {
 369             button = get_action(CONTEXT_WPS|ALLOW_SOFTLOCK,TIMEOUT_BLOCK);
 370 #ifdef HAVE_TOUCHSCREEN
 371             if (button == ACTION_TOUCHSCREEN)
 372                 button = wps_get_touchaction(gui_wps[SCREEN_MAIN].data);
 373 #endif
 374         }
 375     }
 376     return usb;
 377 }
 378
 379
 380 void display_keylock_text(bool locked)
 381 {
 382     int i;
 383     FOR_NB_SCREENS(i)
 384         gui_wps[i].display->stop_scroll();
 385
 386     splash(HZ, locked ? ID2P(LANG_KEYLOCK_ON) : ID2P(LANG_KEYLOCK_OFF));
 387 }
 388
 389
 390
 391
 392 #if defined(HAVE_BACKLIGHT) || defined(HAVE_REMOTE_LCD)
 393 static void gwps_caption_backlight(struct wps_state *state)
 394 {
 395     if (state && state->id3)
 396     {
 397 #ifdef HAVE_BACKLIGHT
 398         if (global_settings.caption_backlight)
 399         {
 400             /* turn on backlight n seconds before track ends, and turn it off n
 401                seconds into the new track. n == backlight_timeout, or 5s */
 402             int n = global_settings.backlight_timeout * 1000;
 403
 404             if ( n < 1000 )
 405                 n = 5000; /* use 5s if backlight is always on or off */
 406
 407             if (((state->id3->elapsed < 1000) ||
 408                  ((state->id3->length - state->id3->elapsed) < (unsigned)n)) &&
 409                 (state->paused == false))
 410                 backlight_on();
 411         }
 412 #endif
 413 #ifdef HAVE_REMOTE_LCD
 414         if (global_settings.remote_caption_backlight)
 415         {
 416             /* turn on remote backlight n seconds before track ends, and turn it
 417                off n seconds into the new track. n == remote_backlight_timeout,
 418                or 5s */
 419             int n = global_settings.remote_backlight_timeout * 1000;
 420
 421             if ( n < 1000 )
 422                 n = 5000; /* use 5s if backlight is always on or off */
 423
 424             if (((state->id3->elapsed < 1000) ||
 425                  ((state->id3->length - state->id3->elapsed) < (unsigned)n)) &&
 426                 (state->paused == false))
 427                 remote_backlight_on();
 428         }
 429 #endif
 430     }
 431 }
 432 #endif
 433
 434
 435 static void change_dir(int direction)
 436 {
 437     if (global_settings.prevent_skip)
 438         return;
 439
 440     if (direction < 0)
 441         audio_prev_dir();
 442     else if (direction > 0)
 443         audio_next_dir();
 444     /* prevent the next dir to immediatly start being ffw'd */
 445     action_wait_for_release();
 446 }
 447
 448 static void prev_track(unsigned long skip_thresh)
 449 {
 450     if (wps_state.id3->elapsed < skip_thresh)
 451     {
 452         audio_prev();
 453         return;
 454     }
 455     else
 456     {
 457         if (wps_state.id3->cuesheet)
 458         {
 459             curr_cuesheet_skip(wps_state.id3->cuesheet, -1, wps_state.id3->elapsed);
 460             return;
 461         }
 462
 463         if (!wps_state.paused)
 464 #if (CONFIG_CODEC == SWCODEC)
 465             audio_pre_ff_rewind();
 466 #else
 467         audio_pause();
 468 #endif
 469
 470         audio_ff_rewind(0);
 471
 472 #if (CONFIG_CODEC != SWCODEC)
 473         if (!wps_state.paused)
 474             audio_resume();
 475 #endif
 476     }
 477 }
 478
 479 static void next_track(void)
 480 {
 481     /* take care of if we're playing a cuesheet */
 482     if (wps_state.id3->cuesheet)
 483     {
 484         if (curr_cuesheet_skip(wps_state.id3->cuesheet, 1, wps_state.id3->elapsed))
 485         {
 486             /* if the result was false, then we really want
 487                to skip to the next track */
 488             return;
 489         }
 490     }
 491
 492     audio_next();
 493 }
 494
 495 static void play_hop(int direction)
 496 {
 497     long step = global_settings.skip_length*1000;
 498     long elapsed = wps_state.id3->elapsed;
 499     long remaining = wps_state.id3->length - elapsed;
 500
 501     if (step < 0)
 502     {
 503         if (direction < 0)
 504         {
 505             prev_track(DEFAULT_SKIP_TRESH);
 506             return;
 507         }
 508         else if (remaining < DEFAULT_SKIP_TRESH*2)
 509         {
 510             next_track();
 511             return;
 512         }
 513         else
 514             elapsed += (remaining - DEFAULT_SKIP_TRESH*2);
 515     }
 516     else if (!global_settings.prevent_skip &&
 517            (!step ||
 518             (direction > 0 && step >= remaining) ||
 519             (direction < 0 && elapsed < DEFAULT_SKIP_TRESH)))
 520     {   /* Do normal track skipping */
 521         if (direction > 0)
 522             next_track();
 523         else if (direction < 0)
 524             prev_track(DEFAULT_SKIP_TRESH);
 525         return;
 526     }
 527     else if (direction == 1 && step >= remaining)
 528     {
 529 #if CONFIG_CODEC == SWCODEC
 530         if(global_settings.beep)
 531             pcmbuf_beep(1000, 150, 1500*global_settings.beep);
 532 #endif
 533         return;
 534     }
 535     else if ((direction == -1 && elapsed < step))
 536     {
 537         elapsed = 0;
 538     }
 539     else
 540     {
 541         elapsed += step * direction;
 542     }
 543     if((audio_status() & AUDIO_STATUS_PLAY) && !wps_state.paused)
 544     {
 545 #if (CONFIG_CODEC == SWCODEC)
 546         audio_pre_ff_rewind();
 547 #else
 548         audio_pause();
 549 #endif
 550     }
 551     audio_ff_rewind(wps_state.id3->elapsed = elapsed);
 552 #if (CONFIG_CODEC != SWCODEC)
 553     if (!wps_state.paused)
 554         audio_resume();
 555 #endif
 556 }
 557
 558
 559 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
 560 /*
 561  * If the user is unable to see the wps, because the display is deactivated,
 562  * we suppress updates until the wps is activated again (the lcd driver will
 563  * call this hook to issue an instant update)
 564  * */
 565 static void wps_lcd_activation_hook(void)
 566 {
 567     wps_state.do_full_update = true;
 568     /* force timeout in wps main loop, so that the update is instantly */
 569     queue_post(&button_queue, BUTTON_NONE, 0);
 570 }
 571 #endif
 572
 573 static void gwps_leave_wps(void)
 574 {
 575     int i, oldbars = VP_SB_HIDE_ALL;
 576
 577     FOR_NB_SCREENS(i)
 578     {
 579         gui_wps[i].display->stop_scroll();
 580         gui_wps[i].display->backdrop_show(BACKDROP_MAIN);
 581         if (statusbar_position(i) != STATUSBAR_OFF)
 582             oldbars |= VP_SB_ONSCREEN(i);
 583     }
 584
 585     viewportmanager_set_statusbar(oldbars);
 586 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
 587     /* Play safe and unregister the hook */
 588     lcd_activation_set_hook(NULL);
 589 #endif
 590     send_event(GUI_EVENT_REFRESH, NULL);
 591 }
 592
 593 #ifdef HAVE_TOUCHSCREEN
 594 int wps_get_touchaction(struct wps_data *data)
 595 {
 596     short x,y;
 597     short vx, vy;
 598     int type = action_get_touchscreen_press(&x, &y);
 599     static int last_action = ACTION_NONE;
 600     struct touchregion *r;
 601     bool repeated = (type == BUTTON_REPEAT);
 602     bool released = (type == BUTTON_REL);
 603     struct skin_token_list *regions = data->touchregions;
 604     while (regions)
 605     {
 606         r = (struct touchregion *)regions->token->value.data;
 607         /* make sure this region's viewport is visible */
 608         if (r->wvp->hidden_flags&VP_DRAW_HIDDEN)
 609         {
 610             regions = regions->next;
 611             continue;
 612         }
 613         /* check if it's inside this viewport */
 614         if (viewport_point_within_vp(&(r->wvp->vp), x, y))
 615         {   /* reposition the touch inside the viewport since touchregions
 616              * are relative to a preceding viewport */
 617             vx = x - r->wvp->vp.x;
 618             vy = y - r->wvp->vp.y;
 619             /* now see if the point is inside this region */
 620             if (vx >= r->x && vx < r->x+r->width &&
 621                 vy >= r->y && vy < r->y+r->height)
 622             {
 623                 /* reposition the touch within the area */
 624                 vx -= r->x;
 625                 vy -= r->y;
 626
 627                 switch(r->type)
 628                 {
 629                     case WPS_TOUCHREGION_ACTION:
 630                         if ((repeated && r->repeat) || (released && !r->repeat))
 631                         {
 632                             last_action = r->action;
 633                             return r->action;
 634                         }
 635                         break;
 636                     case WPS_TOUCHREGION_SCROLLBAR:
 637                         if(r->width > r->height)
 638                             /* landscape */
 639                             wps_state.id3->elapsed = (vx *
 640                                     wps_state.id3->length) / r->width;
 641                         else
 642                             /* portrait */
 643                             wps_state.id3->elapsed = (vy *
 644                                     wps_state.id3->length) / r->height;
 645
 646                         if (!wps_state.paused)
 647 #if (CONFIG_CODEC == SWCODEC)
 648                             audio_pre_ff_rewind();
 649 #else
 650                             audio_pause();
 651 #endif
 652                         audio_ff_rewind(wps_state.id3->elapsed);
 653 #if (CONFIG_CODEC != SWCODEC)
 654                         if (!wps_state.paused)
 655                             audio_resume();
 656 #endif
 657                         break;
 658                     case WPS_TOUCHREGION_VOLUME:
 659                     {
 660                         int i;
 661                         const int min_vol = sound_min(SOUND_VOLUME);
 662                         const int max_vol = sound_max(SOUND_VOLUME);
 663                         if(r->width > r->height)
 664                             /* landscape */
 665                             global_settings.volume = (vx *
 666                                             (max_vol - min_vol)) / r->width;
 667                         else
 668                             /* portrait */
 669                             global_settings.volume = (vy *
 670                                                 (max_vol-min_vol)) / r->height;
 671
 672                         global_settings.volume += min_vol;
 673                         setvol();
 674                         FOR_NB_SCREENS(i)
 675                         {
 676                             gui_wps[i].data->button_time_volume = current_tick;
 677                         }
 678                         return ACTION_REDRAW;
 679                     }
 680                 }
 681             }
 682         }
 683         regions = regions->next;
 684     }
 685
 686     if ((last_action == ACTION_WPS_SEEKBACK || last_action == ACTION_WPS_SEEKFWD))
 687         return ACTION_WPS_STOPSEEK;
 688     last_action = ACTION_TOUCHSCREEN;
 689     return ACTION_TOUCHSCREEN;
 690 }
 691 #endif
 692 /* The WPS can be left in two ways:
 693  *      a)  call a function, which draws over the wps. In this case, the wps
 694  *          will be still active (i.e. the below function didn't return)
 695  *      b)  return with a value evaluated by root_menu.c, in this case the wps
 696  *          is really left, and root_menu will handle the next screen
 697  *
 698  * In either way, call gwps_leave_wps(), in order to restore the correct
 699  * "main screen" backdrops and statusbars
 700  */
 701 long gui_wps_show(void)
 702 {
 703     long button = 0;
 704     bool restore = true;
 705     long restoretimer = RESTORE_WPS_INSTANTLY; /* timer to delay screen redraw temporarily */
 706     bool exit = false;
 707     bool bookmark = false;
 708     bool update = false;
 709     int i;
 710     long last_left = 0, last_right = 0;
 711
 712 #ifdef HAVE_LCD_CHARCELLS
 713     status_set_audio(true);
 714     status_set_param(false);
 715 #else
 716     statusbar_toggle_handler(NULL);
 717 #endif
 718
 719 #ifdef AB_REPEAT_ENABLE
 720     ab_repeat_init();
 721     ab_reset_markers();
 722 #endif
 723     wps_state_init();
 724
 725     while ( 1 )
 726     {
 727         bool audio_paused = (audio_status() & AUDIO_STATUS_PAUSE)?true:false;
 728
 729         /* did someone else (i.e power thread) change audio pause mode? */
 730         if (wps_state.paused != audio_paused) {
 731             wps_state.paused = audio_paused;
 732
 733             /* if another thread paused audio, we are probably in car mode,
 734                about to shut down. lets save the settings. */
 735             if (wps_state.paused) {
 736                 settings_save();
 737 #if !defined(HAVE_RTC_RAM) && !defined(HAVE_SW_POWEROFF)
 738                 call_storage_idle_notifys(true);
 739 #endif
 740             }
 741         }
 742
 743 #ifdef HAVE_LCD_BITMAP
 744         /* when the peak meter is enabled we want to have a
 745             few extra updates to make it look smooth. On the
 746             other hand we don't want to waste energy if it
 747             isn't displayed */
 748         bool pm=false;
 749         FOR_NB_SCREENS(i)
 750         {
 751            if(gui_wps[i].data->peak_meter_enabled)
 752                pm = true;
 753         }
 754
 755         if (pm) {
 756             long next_refresh = current_tick;
 757             long next_big_refresh = current_tick + HZ / 5;
 758             button = BUTTON_NONE;
 759             while (TIME_BEFORE(current_tick, next_big_refresh)) {
 760                 button = get_action(CONTEXT_WPS|ALLOW_SOFTLOCK,TIMEOUT_NOBLOCK);
 761                 if (button != ACTION_NONE) {
 762                     break;
 763                 }
 764                 peak_meter_peek();
 765                 sleep(0);   /* Sleep until end of current tick. */
 766
 767                 if (TIME_AFTER(current_tick, next_refresh)) {
 768                     FOR_NB_SCREENS(i)
 769                     {
 770                         if(gui_wps[i].data->peak_meter_enabled)
 771                             skin_update(&gui_wps[i], WPS_REFRESH_PEAK_METER);
 772                         next_refresh += HZ / PEAK_METER_FPS;
 773                     }
 774                 }
 775             }
 776
 777         }
 778
 779         /* The peak meter is disabled
 780            -> no additional screen updates needed */
 781         else
 782 #endif
 783         {
 784             button = get_action(CONTEXT_WPS|ALLOW_SOFTLOCK,
 785                 restore ? HZ/100 : HZ/5);
 786         }
 787
 788         /* Exit if audio has stopped playing. This happens e.g. at end of
 789            playlist or if using the sleep timer. */
 790         if (!(audio_status() & AUDIO_STATUS_PLAY))
 791             exit = true;
 792 #ifdef HAVE_TOUCHSCREEN
 793         if (button == ACTION_TOUCHSCREEN)
 794             button = wps_get_touchaction(gui_wps[SCREEN_MAIN].data);
 795 #endif
 796 /* The iPods/X5/M5 use a single button for the A-B mode markers,
 797    defined as ACTION_WPSAB_SINGLE in their config files. */
 798 #ifdef ACTION_WPSAB_SINGLE
 799         if (!global_settings.party_mode && ab_repeat_mode_enabled())
 800         {
 801             static int wps_ab_state = 0;
 802             if (button == ACTION_WPSAB_SINGLE)
 803             {
 804                 switch (wps_ab_state)
 805                 {
 806                     case 0: /* set the A spot */
 807                         button = ACTION_WPS_ABSETA_PREVDIR;
 808                         break;
 809                     case 1: /* set the B spot */
 810                         button = ACTION_WPS_ABSETB_NEXTDIR;
 811                         break;
 812                     case 2:
 813                         button = ACTION_WPS_ABRESET;
 814                         break;
 815                 }
 816                 wps_ab_state = (wps_ab_state+1) % 3;
 817             }
 818         }
 819 #endif
 820         switch(button)
 821         {
 822             case ACTION_WPS_CONTEXT:
 823             {
 824                 gwps_leave_wps();
 825                 /* if music is stopped in the context menu we want to exit the wps */
 826                 if (onplay(wps_state.id3->path,
 827                            FILE_ATTR_AUDIO, CONTEXT_WPS) == ONPLAY_MAINMENU
 828                     || !audio_status())
 829                     return GO_TO_ROOT;
 830                 restore = true;
 831             }
 832             break;
 833
 834             case ACTION_WPS_BROWSE:
 835 #ifdef HAVE_LCD_CHARCELLS
 836                 status_set_record(false);
 837                 status_set_audio(false);
 838 #endif
 839                 gwps_leave_wps();
 840                 return GO_TO_PREVIOUS_BROWSER;
 841                 break;
 842
 843                 /* play/pause */
 844             case ACTION_WPS_PLAY:
 845                 if (global_settings.party_mode)
 846                     break;
 847                 if ( wps_state.paused )
 848                 {
 849                     wps_state.paused = false;
 850                     if ( global_settings.fade_on_stop )
 851                         fade(true, true);
 852                     else
 853                         audio_resume();
 854                 }
 855                 else
 856                 {
 857                     wps_state.paused = true;
 858                     if ( global_settings.fade_on_stop )
 859                         fade(false, true);
 860                     else
 861                         audio_pause();
 862                     settings_save();
 863 #if !defined(HAVE_RTC_RAM) && !defined(HAVE_SW_POWEROFF)
 864                     call_storage_idle_notifys(true);   /* make sure resume info is saved */
 865 #endif
 866                 }
 867                 break;
 868
 869             case ACTION_WPS_VOLUP:
 870             {
 871                 FOR_NB_SCREENS(i)
 872                     gui_wps[i].data->button_time_volume = current_tick;
 873                 global_settings.volume++;
 874                 bool res = false;
 875                 setvol();
 876                 FOR_NB_SCREENS(i)
 877                 {
 878                     if(update_onvol_change(&gui_wps[i]))
 879                         res = true;
 880                 }
 881                 if (res) {
 882                     restore = true;
 883                     restoretimer = RESTORE_WPS_NEXT_SECOND;
 884                 }
 885             }
 886             break;
 887             case ACTION_WPS_VOLDOWN:
 888             {
 889                 FOR_NB_SCREENS(i)
 890                     gui_wps[i].data->button_time_volume = current_tick;
 891                 global_settings.volume--;
 892                 setvol();
 893                 bool res = false;
 894                 FOR_NB_SCREENS(i)
 895                 {
 896                     if(update_onvol_change(&gui_wps[i]))
 897                         res = true;
 898                 }
 899                 if (res) {
 900                     restore = true;
 901                     restoretimer = RESTORE_WPS_NEXT_SECOND;
 902                 }
 903             }
 904                 break;
 905             /* fast forward
 906                 OR next dir if this is straight after ACTION_WPS_SKIPNEXT */
 907             case ACTION_WPS_SEEKFWD:
 908                 if (global_settings.party_mode)
 909                     break;
 910                 if (current_tick -last_right < HZ)
 911                 {
 912                     if (wps_state.id3->cuesheet)
 913                     {
 914                         audio_next();
 915                     }
 916                     else
 917                     {
 918                         change_dir(1);
 919                     }
 920                 }
 921                 else
 922                     ffwd_rew(ACTION_WPS_SEEKFWD);
 923                 last_right = last_left = 0;
 924                 break;
 925             /* fast rewind
 926                 OR prev dir if this is straight after ACTION_WPS_SKIPPREV,*/
 927             case ACTION_WPS_SEEKBACK:
 928                 if (global_settings.party_mode)
 929                     break;
 930                 if (current_tick -last_left < HZ)
 931                 {
 932                     if (wps_state.id3->cuesheet)
 933                     {
 934                         if (!wps_state.paused)
 935 #if (CONFIG_CODEC == SWCODEC)
 936                             audio_pre_ff_rewind();
 937 #else
 938                             audio_pause();
 939 #endif
 940                         audio_ff_rewind(0);
 941                     }
 942                     else
 943                     {
 944                         change_dir(-1);
 945                     }
 946                 }
 947                 else
 948                     ffwd_rew(ACTION_WPS_SEEKBACK);
 949                 last_left = last_right = 0;
 950                 break;
 951
 952                 /* prev / restart */
 953             case ACTION_WPS_SKIPPREV:
 954                 if (global_settings.party_mode)
 955                     break;
 956                 last_left = current_tick;
 957 #ifdef AB_REPEAT_ENABLE
 958                 /* if we're in A/B repeat mode and the current position
 959                    is past the A marker, jump back to the A marker... */
 960                 if ( ab_repeat_mode_enabled() )
 961                 {
 962                     if ( ab_after_A_marker(wps_state.id3->elapsed) )
 963                     {
 964                         ab_jump_to_A_marker();
 965                         break;
 966 #if (AB_REPEAT_ENABLE == 2)
 967                     } else {
 968                         ab_reset_markers();
 969 #endif
 970                     }
 971                 }
 972                 else
 973                 /* ...otherwise, do it normally */
 974 #endif
 975                     play_hop(-1);
 976                 break;
 977
 978                 /* next
 979                    OR if skip length set, hop by predetermined amount. */
 980             case ACTION_WPS_SKIPNEXT:
 981                 if (global_settings.party_mode)
 982                     break;
 983                 last_right = current_tick;
 984 #ifdef AB_REPEAT_ENABLE
 985                 /* if we're in A/B repeat mode and the current position is
 986                    before the A marker, jump to the A marker... */
 987                 if ( ab_repeat_mode_enabled() )
 988                 {
 989                     if ( ab_before_A_marker(wps_state.id3->elapsed) )
 990                     {
 991                         ab_jump_to_A_marker();
 992                         break;
 993 #if (AB_REPEAT_ENABLE == 2)
 994                     } else {
 995                         ab_reset_markers();
 996 #endif
 997                     }
 998                 }
 999                 else
1000                 /* ...otherwise, do it normally */
1001 #endif
1002                     play_hop(1);
1003                 break;
1004                 /* next / prev directories */
1005                 /* and set A-B markers if in a-b mode */
1006             case ACTION_WPS_ABSETB_NEXTDIR:
1007                 if (global_settings.party_mode)
1008                     break;
1009 #if defined(AB_REPEAT_ENABLE)
1010                 if (ab_repeat_mode_enabled())
1011                 {
1012                     ab_set_B_marker(wps_state.id3->elapsed);
1013                     ab_jump_to_A_marker();
1014                 }
1015                 else
1016 #endif
1017                 {
1018                     change_dir(1);
1019                 }
1020                 break;
1021             case ACTION_WPS_ABSETA_PREVDIR:
1022                 if (global_settings.party_mode)
1023                     break;
1024 #if defined(AB_REPEAT_ENABLE)
1025                 if (ab_repeat_mode_enabled())
1026                     ab_set_A_marker(wps_state.id3->elapsed);
1027                 else
1028 #endif
1029                 {
1030                     change_dir(-1);
1031                 }
1032                 break;
1033             /* menu key functions */
1034             case ACTION_WPS_MENU:
1035                 gwps_leave_wps();
1036                 return GO_TO_ROOT;
1037                 break;
1038
1039
1040 #ifdef HAVE_QUICKSCREEN
1041             case ACTION_WPS_QUICKSCREEN:
1042             {
1043                 gwps_leave_wps();
1044                 if (quick_screen_quick(button))
1045                     return GO_TO_ROOT;
1046                 restore = true;
1047             }
1048             break;
1049 #endif /* HAVE_QUICKSCREEN */
1050
1051                 /* screen settings */
1052 #ifdef BUTTON_F3
1053             case ACTION_F3:
1054             {
1055                 gwps_leave_wps();
1056                 if (quick_screen_f3(BUTTON_F3))
1057                     return GO_TO_ROOT;
1058                 restore = true;
1059             }
1060             break;
1061 #endif /* BUTTON_F3 */
1062
1063                 /* pitch screen */
1064 #ifdef HAVE_PITCHSCREEN
1065             case ACTION_WPS_PITCHSCREEN:
1066             {
1067                 gwps_leave_wps();
1068                 if (1 == gui_syncpitchscreen_run())
1069                     return GO_TO_ROOT;
1070                 restore = true;
1071             }
1072             break;
1073 #endif /* HAVE_PITCHSCREEN */
1074
1075 #ifdef AB_REPEAT_ENABLE
1076             /* reset A&B markers */
1077             case ACTION_WPS_ABRESET:
1078                 if (ab_repeat_mode_enabled())
1079                 {
1080                     ab_reset_markers();
1081                     update = true;
1082                 }
1083                 break;
1084 #endif /* AB_REPEAT_ENABLE */
1085
1086                 /* stop and exit wps */
1087             case ACTION_WPS_STOP:
1088                 if (global_settings.party_mode)
1089                     break;
1090                 bookmark = true;
1091                 exit = true;
1092                 break;
1093
1094             case ACTION_WPS_ID3SCREEN:
1095             {
1096                 gwps_leave_wps();
1097                 if (browse_id3())
1098                     return GO_TO_ROOT;
1099                 restore = true;
1100             }
1101             break;
1102 #ifdef HAVE_TOUCHSCREEN
1103             case ACTION_TOUCH_SHUFFLE: /* toggle shuffle mode */
1104             {
1105                 global_settings.playlist_shuffle =
1106                                                 !global_settings.playlist_shuffle;
1107 #if CONFIG_CODEC == SWCODEC
1108                 dsp_set_replaygain();
1109 #endif
1110                 if (global_settings.playlist_shuffle)
1111                     playlist_randomise(NULL, current_tick, true);
1112                 else
1113                     playlist_sort(NULL, true);
1114             }
1115             break;
1116             case ACTION_TOUCH_REPMODE: /* cycle the repeat mode setting */
1117             {
1118                 const struct settings_list *rep_setting =
1119                                 find_setting(&global_settings.repeat_mode, NULL);
1120                 option_select_next_val(rep_setting, false, true);
1121                 audio_flush_and_reload_tracks();
1122             }
1123             break;
1124 #endif /* HAVE_TOUCHSCREEN */
1125              /* this case is used by the softlock feature
1126               * it requests a full update here */
1127             case ACTION_REDRAW:
1128                 wps_state.do_full_update = true;
1129                 break;
1130             case ACTION_NONE: /* Timeout, do a partial update */
1131                 update = true;
1132                 ffwd_rew(button); /* hopefully fix the ffw/rwd bug */
1133                 break;
1134 #ifdef HAVE_RECORDING
1135             case ACTION_WPS_REC:
1136                 exit = true;
1137                 break;
1138 #endif
1139             case SYS_POWEROFF:
1140                 default_event_handler(SYS_POWEROFF);
1141                 break;
1142             case ACTION_WPS_VIEW_PLAYLIST:
1143                 gwps_leave_wps();
1144                 if (playlist_viewer()) /* true if USB connected */
1145                     return GO_TO_ROOT;
1146                 restore = true;
1147                 break;
1148             default:
1149                 if(default_event_handler(button) == SYS_USB_CONNECTED)
1150                 {
1151                     gwps_leave_wps();
1152                     return GO_TO_ROOT;
1153                 }
1154                 update = true;
1155                 break;
1156         }
1157
1158         if (wps_state.do_full_update || update)
1159         {
1160 #if defined(HAVE_BACKLIGHT) || defined(HAVE_REMOTE_LCD)
1161             gwps_caption_backlight(&wps_state);
1162 #endif
1163             FOR_NB_SCREENS(i)
1164             {
1165 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
1166                 if (lcd_active()
1167 #ifdef HAVE_REMOTE_LCD
1168                 /* currently, all remotes are readable without backlight
1169                  * so still update those */
1170                             || (i == SCREEN_REMOTE)
1171 #endif
1172                                                 )
1173 #endif
1174                 {
1175                     skin_update(&gui_wps[i], WPS_REFRESH_NON_STATIC);
1176                 }
1177             }
1178             wps_state.do_full_update = false;
1179             update = false;
1180         }
1181
1182         if (restore && wps_state.id3 &&
1183             ((restoretimer == RESTORE_WPS_INSTANTLY) ||
1184              TIME_AFTER(current_tick, restoretimer)))
1185         {
1186             restore = false;
1187             restoretimer = RESTORE_WPS_INSTANTLY;
1188 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
1189             lcd_activation_set_hook(wps_lcd_activation_hook);
1190 #endif
1191             FOR_NB_SCREENS(i)
1192             {
1193                 screens[i].stop_scroll();
1194                 gui_wps_display(&gui_wps[i]);
1195             }
1196         }
1197
1198         if (exit) {
1199 #ifdef HAVE_LCD_CHARCELLS
1200             status_set_record(false);
1201             status_set_audio(false);
1202 #endif
1203             if (global_settings.fade_on_stop)
1204                 fade(false, true);
1205
1206             if (bookmark)
1207                 bookmark_autobookmark();
1208             audio_stop();
1209 #ifdef AB_REPEAT_ENABLE
1210             ab_reset_markers();
1211 #endif
1212             gwps_leave_wps();
1213 #ifdef HAVE_RECORDING
1214             if (button == ACTION_WPS_REC)
1215                 return GO_TO_RECSCREEN;
1216 #endif
1217             if (global_settings.browse_current)
1218                 return GO_TO_PREVIOUS_BROWSER;
1219             return GO_TO_PREVIOUS;
1220         }
1221
1222         if (button && !IS_SYSEVENT(button) )
1223             storage_spin();
1224     }
1225     return GO_TO_ROOT; /* unreachable - just to reduce compiler warnings */
1226 }
1227
1228 /* this is called from the playback thread so NO DRAWING! */
1229 static void track_changed_callback(void *param)
1230 {
1231     wps_state.id3 = (struct mp3entry*)param;
1232     wps_state.nid3 = audio_next_track();
1233     if (wps_state.id3->cuesheet)
1234     {
1235         cue_find_current_track(wps_state.id3->cuesheet, wps_state.id3->elapsed);
1236         cue_spoof_id3(wps_state.id3->cuesheet, wps_state.id3);
1237     }
1238     wps_state.do_full_update = true;
1239 }
1240 static void nextid3available_callback(void* param)
1241 {
1242     (void)param;
1243     wps_state.nid3 = audio_next_track();
1244     wps_state.do_full_update = true;
1245 }
1246
1247
1248 static void wps_state_init(void)
1249 {
1250     wps_state.ff_rewind = false;
1251     wps_state.paused = false;
1252     if(audio_status() & AUDIO_STATUS_PLAY)
1253     {
1254         wps_state.id3 = audio_current_track();
1255         wps_state.nid3 = audio_next_track();
1256     }
1257     else
1258     {
1259         wps_state.id3 = NULL;
1260         wps_state.nid3 = NULL;
1261     }
1262     /* We'll be updating due to restore initialized with true */
1263     wps_state.do_full_update = false;
1264     /* add the WPS track event callbacks */
1265     add_event(PLAYBACK_EVENT_TRACK_CHANGE, false, track_changed_callback);
1266     add_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, false, nextid3available_callback);
1267 }
1268
1269
1270 #ifdef HAVE_LCD_BITMAP
1271 static void statusbar_toggle_handler(void *data)
1272 {
1273     (void)data;
1274     int i;
1275
1276     wpsbars = VP_SB_HIDE_ALL;
1277     FOR_NB_SCREENS(i)
1278     {   /* fix viewports if needed */
1279         skin_statusbar_changed(&gui_wps[i]);
1280
1281         bool draw = false;
1282
1283         /* fix up gui_wps::statusbars, so that the viewportmanager accepts it*/
1284         if (gui_wps[i].data->wps_sb_tag)
1285             draw = gui_wps[i].data->show_sb_on_wps;
1286         else if (statusbar_position(i) != STATUSBAR_OFF)
1287             draw = true;
1288         if (draw)
1289             wpsbars |=
1290                     (VP_SB_ONSCREEN(i) | VP_SB_IGNORE_SETTING(i));
1291     }
1292 }
1293 #endif
1294
1295
1296 void gui_sync_wps_init(void)
1297 {
1298     int i;
1299     FOR_NB_SCREENS(i)
1300     {
1301 #ifdef HAVE_ALBUMART
1302         wps_datas[i].albumart = NULL;
1303         wps_datas[i].playback_aa_slot = -1;
1304 #endif
1305 #ifdef HAVE_REMOTE_LCD
1306         wps_datas[i].remote_wps = (i == SCREEN_REMOTE);
1307 #endif
1308         gui_wps[i].data = &wps_datas[i];
1309         gui_wps[i].display = &screens[i];
1310         /* Currently no seperate wps_state needed/possible
1311            so use the only available ( "global" ) one */
1312         gui_wps[i].state = &wps_state;
1313         gui_wps[i].display->backdrop_unload(BACKDROP_SKIN_WPS);
1314         /* only one wpsbars needed/wanted */
1315         gui_wps[i].statusbars = &wpsbars;
1316     }
1317     *(gui_wps[SCREEN_MAIN].statusbars) =VP_SB_ALLSCREENS;
1318 #ifdef HAVE_LCD_BITMAP
1319     add_event(GUI_EVENT_STATUSBAR_TOGGLE, false, statusbar_toggle_handler);
1320 #endif
1321 }
1322
1323
1324 #ifdef IPOD_ACCESSORY_PROTOCOL
1325 int wps_get_ff_rewind_count(void)
1326 {
1327     return wps_state.ff_rewind_count;
1328 }
1329 #endif