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