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