apps/gui/viewport.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2008 by Jonathan Gordon
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #include <stdlib.h>
  23 #include "config.h"
  24 #include "lcd.h"
  25 #include "lcd-remote.h"
  26 #include "font.h"
  27 #include "viewport.h"
  28 #include "screen_access.h"
  29 #include "settings.h"
  30 #include "misc.h"
  31
  32 /*some short cuts for fg/bg/line selector handling */
  33 #ifdef HAVE_LCD_COLOR
  34 #define FG_FALLBACK global_settings.fg_color
  35 #define BG_FALLBACK global_settings.bg_color
  36 #else
  37 #define FG_FALLBACK LCD_DEFAULT_FG
  38 #define BG_FALLBACK LCD_DEFAULT_BG
  39 #endif
  40 #ifdef HAVE_REMOTE_LCD
  41 #define REMOTE_FG_FALLBACK LCD_REMOTE_DEFAULT_FG
  42 #define REMOTE_BG_FALLBACK LCD_REMOTE_DEFAULT_BG
  43 #endif
  44
  45
  46 /* all below isn't needed for pc tools (i.e. checkwps/wps editor)
  47  * only viewport_parse_viewport() is */
  48 #ifndef __PCTOOL__
  49 #include "string.h"
  50 #include "kernel.h"
  51 #include "system.h"
  52 #include "statusbar.h"
  53 #include "appevents.h"
  54 #include "panic.h"
  55 #ifdef HAVE_LCD_BITMAP
  56 #include "language.h"
  57 #endif
  58 #include "statusbar-skinned.h"
  59 #include "debug.h"
  60 #include "viewport.h"
  61
  62 #define VPSTACK_DEPTH 16
  63 struct viewport_stack_item
  64 {
  65     struct  viewport* vp;
  66     bool   enabled;
  67 };
  68
  69 #ifdef HAVE_LCD_BITMAP
  70 static void viewportmanager_redraw(void* data);
  71
  72 static int theme_stack_top[NB_SCREENS]; /* the last item added */
  73 static struct viewport_stack_item theme_stack[NB_SCREENS][VPSTACK_DEPTH];
  74 static bool is_theme_enabled(enum screen_type screen);
  75
  76
  77 static void toggle_events(bool enable)
  78 {
  79     if (enable)
  80     {
  81         add_event(GUI_EVENT_ACTIONUPDATE, false, viewportmanager_redraw);
  82 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
  83         add_event(LCD_EVENT_ACTIVATION, false, do_sbs_update_callback);
  84 #endif
  85         add_event(PLAYBACK_EVENT_TRACK_CHANGE, false,
  86                                                 do_sbs_update_callback);
  87         add_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, false,
  88                                                 do_sbs_update_callback);
  89     }
  90     else
  91     {
  92 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
  93         remove_event(LCD_EVENT_ACTIVATION, do_sbs_update_callback);
  94 #endif
  95         remove_event(PLAYBACK_EVENT_TRACK_CHANGE, do_sbs_update_callback);
  96         remove_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, do_sbs_update_callback);
  97         remove_event(GUI_EVENT_ACTIONUPDATE, viewportmanager_redraw);
  98     }
  99 }
 100
 101
 102 static void toggle_theme(enum screen_type screen, bool force)
 103 {
 104     bool enable_event = false;
 105     static bool was_enabled[NB_SCREENS] = {false};
 106     static bool after_boot[NB_SCREENS] = {false};
 107     int i;
 108
 109     FOR_NB_SCREENS(i)
 110     {
 111         enable_event = enable_event || is_theme_enabled(i);
 112         sb_set_title_text(NULL, Icon_NOICON, i);
 113     }
 114     toggle_events(enable_event);
 115
 116     if (is_theme_enabled(screen))
 117     {
 118         bool first_boot = theme_stack_top[screen] == 0;
 119         /* remove the left overs from the previous screen.
 120          * could cause a tiny flicker. Redo your screen code if that happens */
 121 #if LCD_DEPTH > 1 || defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
 122         screens[screen].backdrop_show(sb_get_backdrop(screen));
 123 #endif
 124         if (LIKELY(after_boot[screen]) && (!was_enabled[screen] || force))
 125         {
 126             struct viewport deadspace, user;
 127             viewport_set_defaults(&user, screen);
 128             deadspace = user; /* get colours and everything */
 129             /* above */
 130             deadspace.x = 0;
 131             deadspace.y = 0;
 132             deadspace.width = screens[screen].lcdwidth;
 133             deadspace.height = user.y;
 134             if (deadspace.width && deadspace.height)
 135             {
 136                 screens[screen].set_viewport(&deadspace);
 137                 screens[screen].clear_viewport();
 138                 screens[screen].update_viewport();
 139             }
 140             /* below */
 141             deadspace.y = user.y + user.height;
 142             deadspace.height = screens[screen].lcdheight - deadspace.y;
 143             if (deadspace.width && deadspace.height)
 144             {
 145                 screens[screen].set_viewport(&deadspace);
 146                 screens[screen].clear_viewport();
 147                 screens[screen].update_viewport();
 148             }
 149             /* left */
 150             deadspace.x = 0;
 151             deadspace.y = 0;
 152             deadspace.width = user.x;
 153             deadspace.height = screens[screen].lcdheight;
 154             if (deadspace.width && deadspace.height)
 155             {
 156                 screens[screen].set_viewport(&deadspace);
 157                 screens[screen].clear_viewport();
 158                 screens[screen].update_viewport();
 159             }
 160             /* below */
 161             deadspace.x = user.x + user.width;
 162             deadspace.width = screens[screen].lcdwidth - deadspace.x;
 163             if (deadspace.width && deadspace.height)
 164             {
 165                 screens[screen].set_viewport(&deadspace);
 166                 screens[screen].clear_viewport();
 167                 screens[screen].update_viewport();
 168             }
 169             screens[screen].set_viewport(NULL);
 170         }
 171         intptr_t force = first_boot?0:1;
 172
 173         send_event(GUI_EVENT_ACTIONUPDATE, (void*)force);
 174     }
 175     else
 176     {
 177 #if LCD_DEPTH > 1 || (defined(LCD_REMOTE_DEPTH) && LCD_REMOTE_DEPTH > 1)
 178         screens[screen].backdrop_show(NULL);
 179 #endif
 180         screens[screen].stop_scroll();
 181     }
 182     /* let list initialize viewport in case viewport dimensions is changed. */
 183     send_event(GUI_EVENT_THEME_CHANGED, NULL);
 184     FOR_NB_SCREENS(i)
 185         was_enabled[i] = is_theme_enabled(i);
 186 #ifdef HAVE_TOUCHSCREEN
 187     sb_bypass_touchregions(!is_theme_enabled(SCREEN_MAIN));
 188 #endif
 189     after_boot[screen] = true;
 190 }
 191
 192 void viewportmanager_theme_enable(enum screen_type screen, bool enable,
 193                                  struct viewport *viewport)
 194 {
 195     int top = ++theme_stack_top[screen];
 196     if (top >= VPSTACK_DEPTH-1)
 197         panicf("Stack overflow... viewportmanager");
 198     theme_stack[screen][top].enabled = enable;
 199     theme_stack[screen][top].vp = viewport;
 200     toggle_theme(screen, false);
 201     /* then be nice and set the viewport up */
 202     if (viewport)
 203         viewport_set_defaults(viewport, screen);
 204 }
 205
 206 void viewportmanager_theme_undo(enum screen_type screen, bool force_redraw)
 207 {
 208     int top = --theme_stack_top[screen];
 209     if (top < 0)
 210         panicf("Stack underflow... viewportmanager");
 211
 212     toggle_theme(screen, force_redraw);
 213 }
 214
 215
 216 static bool is_theme_enabled(enum screen_type screen)
 217 {
 218     int top = theme_stack_top[screen];
 219     return theme_stack[screen][top].enabled;
 220 }
 221 #endif /* HAVE_LCD_BITMAP */
 222
 223 int viewport_get_nb_lines(const struct viewport *vp)
 224 {
 225 #ifdef HAVE_LCD_BITMAP
 226     return vp->height/font_get(vp->font)->height;
 227 #else
 228     (void)vp;
 229     return 2;
 230 #endif
 231 }
 232
 233 static void viewportmanager_redraw(void* data)
 234 {
 235     int i;
 236     FOR_NB_SCREENS(i)
 237     {
 238 #ifdef HAVE_LCD_BITMAP
 239         if (is_theme_enabled(i))
 240             sb_skin_update(i, NULL != data);
 241 #else
 242         (void)data;
 243         gui_statusbar_draw(&statusbars.statusbars[i], NULL, NULL);
 244 #endif
 245     }
 246 }
 247
 248 void viewportmanager_init()
 249 {
 250 #ifdef HAVE_LCD_BITMAP
 251     int i;
 252     FOR_NB_SCREENS(i)
 253     {
 254         theme_stack_top[i] = -1; /* the next call fixes this to 0 */
 255         /* We always want the theme enabled by default... */
 256         viewportmanager_theme_enable(i, true, NULL);
 257     }
 258 #else
 259     add_event(GUI_EVENT_ACTIONUPDATE, false, viewportmanager_redraw);
 260 #endif
 261 }
 262
 263 #ifdef HAVE_LCD_BITMAP
 264 void viewportmanager_theme_changed(const int which)
 265 {
 266     int i;
 267 #ifdef HAVE_BUTTONBAR
 268     if (which & THEME_BUTTONBAR)
 269     {   /* don't handle further, the custom ui viewport ignores the buttonbar,
 270          * as does viewport_set_defaults(), since only lists use it*/
 271         screens[SCREEN_MAIN].has_buttonbar = global_settings.buttonbar;
 272     }
 273 #endif
 274     if (which & THEME_UI_VIEWPORT)
 275     {
 276     }
 277     if (which & THEME_LANGUAGE)
 278     {
 279     }
 280     if (which & THEME_STATUSBAR)
 281     {
 282         FOR_NB_SCREENS(i)
 283         {
 284             /* This can probably be done better...
 285              * disable the theme so it's forced to do a full redraw  */
 286             viewportmanager_theme_enable(i, false, NULL);
 287             viewportmanager_theme_undo(i, true);
 288         }
 289     }
 290     send_event(GUI_EVENT_THEME_CHANGED, NULL);
 291 }
 292
 293 #ifdef HAVE_TOUCHSCREEN
 294 /* check if a point (x and y coordinates) are within a viewport */
 295 bool viewport_point_within_vp(const struct viewport *vp,
 296                                const int x, const int y)
 297 {
 298     bool is_x = (x >= vp->x && x < (vp->x + vp->width));
 299     bool is_y = (y >= vp->y && y < (vp->y + vp->height));
 300     return (is_x && is_y);
 301 }
 302 #endif /* HAVE_TOUCHSCREEN */
 303
 304 static void set_default_align_flags(struct viewport *vp)
 305 {
 306     vp->flags &= ~VP_FLAG_ALIGNMENT_MASK;
 307     if (UNLIKELY(lang_is_rtl()))
 308         vp->flags |= VP_FLAG_ALIGN_RIGHT;
 309 }
 310
 311 #endif /* HAVE_LCD_BITMAP */
 312 #endif /* __PCTOOL__ */
 313
 314 #ifdef HAVE_LCD_COLOR
 315 #define ARG_STRING(_depth) ((_depth) == 2 ? "dddddgg":"dddddcc")
 316 #else
 317 #define ARG_STRING(_depth) "dddddgg"
 318 #endif
 319
 320
 321 void viewport_set_fullscreen(struct viewport *vp,
 322                               const enum screen_type screen)
 323 {
 324     vp->x = 0;
 325     vp->y = 0;
 326     vp->width = screens[screen].lcdwidth;
 327     vp->height = screens[screen].lcdheight;
 328
 329 #ifdef HAVE_LCD_BITMAP
 330 #ifndef __PCTOOL__
 331     set_default_align_flags(vp);
 332 #endif
 333     vp->font = FONT_UI + screen; /* default to UI to discourage SYSFONT use */
 334     vp->drawmode = DRMODE_SOLID;
 335 #if LCD_DEPTH > 1
 336 #ifdef HAVE_REMOTE_LCD
 337     /* We only need this test if there is a remote LCD */
 338     if (screen == SCREEN_MAIN)
 339 #endif
 340     {
 341         vp->fg_pattern = FG_FALLBACK;
 342         vp->bg_pattern = BG_FALLBACK;
 343 #ifdef HAVE_LCD_COLOR
 344         vp->lss_pattern = global_settings.lss_color;
 345         vp->lse_pattern = global_settings.lse_color;
 346         vp->lst_pattern = global_settings.lst_color;
 347 #endif
 348     }
 349 #endif
 350
 351 #if defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
 352     if (screen == SCREEN_REMOTE)
 353     {
 354         vp->fg_pattern = LCD_REMOTE_DEFAULT_FG;
 355         vp->bg_pattern = LCD_REMOTE_DEFAULT_BG;
 356     }
 357 #endif
 358 #endif
 359 }
 360
 361 void viewport_set_defaults(struct viewport *vp,
 362                             const enum screen_type screen)
 363 {
 364 #if defined(HAVE_LCD_BITMAP) && !defined(__PCTOOL__)
 365     struct viewport *sbs_area = NULL;
 366     if (!is_theme_enabled(screen))
 367     {
 368         viewport_set_fullscreen(vp, screen);
 369         return;
 370     }
 371     sbs_area = sb_skin_get_info_vp(screen);
 372
 373     if (sbs_area)
 374         *vp = *sbs_area;
 375     else
 376 #endif /* HAVE_LCD_BITMAP */
 377         viewport_set_fullscreen(vp, screen);
 378 }
 379
 380
 381 #ifdef HAVE_LCD_BITMAP
 382
 383 int get_viewport_default_colour(enum screen_type screen, bool fgcolour)
 384 {
 385     (void)screen; (void)fgcolour;
 386 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1)
 387     int colour;
 388     if (fgcolour)
 389     {
 390 #if (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1)
 391         if (screen == SCREEN_REMOTE)
 392             colour = REMOTE_FG_FALLBACK;
 393         else
 394 #endif
 395 #if defined(HAVE_LCD_COLOR)
 396             colour = global_settings.fg_color;
 397 #else
 398             colour = FG_FALLBACK;
 399 #endif
 400     }
 401     else
 402     {
 403 #if (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1)
 404         if (screen == SCREEN_REMOTE)
 405             colour = REMOTE_BG_FALLBACK;
 406         else
 407 #endif
 408 #if defined(HAVE_LCD_COLOR)
 409             colour = global_settings.bg_color;
 410 #else
 411             colour = BG_FALLBACK;
 412 #endif
 413     }
 414     return colour;
 415 #else
 416     return 0;
 417 #endif /* LCD_DEPTH > 1 || LCD_REMOTE_DEPTH > 1 */
 418 }
 419
 420 const char* viewport_parse_viewport(struct viewport *vp,
 421                                     enum screen_type screen,
 422                                     const char *bufptr,
 423                                     const char separator)
 424 {
 425     /* parse the list to the viewport struct */
 426     const char *ptr = bufptr;
 427     uint32_t set = 0;
 428
 429     enum {
 430         PL_X = 0,
 431         PL_Y,
 432         PL_WIDTH,
 433         PL_HEIGHT,
 434         PL_FONT,
 435     };
 436
 437     if (!(ptr = parse_list("ddddd", &set, separator, ptr,
 438                 &vp->x, &vp->y, &vp->width, &vp->height, &vp->font)))
 439         return NULL;
 440
 441     /* X and Y *must* be set */
 442     if (!LIST_VALUE_PARSED(set, PL_X) || !LIST_VALUE_PARSED(set, PL_Y))
 443         return NULL;
 444     /* check for negative values */
 445     if (vp->x < 0)
 446         vp->x += screens[screen].lcdwidth;
 447     if (vp->y < 0)
 448         vp->y += screens[screen].lcdheight;
 449
 450     /* fix defaults,
 451      * and negative width/height which means "extend to edge minus value */
 452     if (!LIST_VALUE_PARSED(set, PL_WIDTH))
 453         vp->width = screens[screen].lcdwidth - vp->x;
 454     else if (vp->width < 0)
 455         vp->width = (vp->width + screens[screen].lcdwidth) - vp->x;
 456     if (!LIST_VALUE_PARSED(set, PL_HEIGHT))
 457         vp->height = screens[screen].lcdheight - vp->y;
 458     else if (vp->height < 0)
 459         vp->height = (vp->height + screens[screen].lcdheight) - vp->y;
 460
 461 #if (LCD_DEPTH > 1) || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1)
 462     vp->fg_pattern = get_viewport_default_colour(screen, true);
 463     vp->bg_pattern = get_viewport_default_colour(screen, false);
 464 #endif /* LCD_DEPTH > 1 || LCD_REMOTE_DEPTH > 1 */
 465
 466 #ifdef HAVE_LCD_COLOR
 467     vp->lss_pattern = global_settings.lss_color;
 468     vp->lse_pattern = global_settings.lse_color;
 469     vp->lst_pattern = global_settings.lst_color;
 470 #endif
 471
 472     /* Validate the viewport dimensions - we know that the numbers are
 473        non-negative integers, ignore bars and assume the viewport takes them
 474        * into account */
 475     if ((vp->x >= screens[screen].lcdwidth) ||
 476         ((vp->x + vp->width) > screens[screen].lcdwidth) ||
 477         (vp->y >= screens[screen].lcdheight) ||
 478         ((vp->y + vp->height) > screens[screen].lcdheight))
 479     {
 480         return NULL;
 481     }
 482
 483     /* Default to using the user font if the font was an invalid number or '-'
 484      * font 1 is *always* the UI font for the current screen
 485      * 2 is always the first extra font    */
 486     if (!LIST_VALUE_PARSED(set, PL_FONT))
 487         vp->font = FONT_UI;
 488
 489     /* Set the defaults for fields not user-specified */
 490     vp->drawmode = DRMODE_SOLID;
 491 #ifndef __PCTOOL__
 492     set_default_align_flags(vp);
 493 #endif
 494
 495     return ptr;
 496 }
 497 #endif