apps/gui/skin_engine/wps_internals.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 Nicolas Pennequin
  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  /* This stuff is for the wps engine only.. anyone caught using this outside
  23   * of apps/gui/wps_engine will be shot on site! */
  24
  25 #ifndef _WPS_ENGINE_INTERNALS_
  26 #define _WPS_ENGINE_INTERNALS_
  27
  28 #include "tag_table.h"
  29 #include "skin_parser.h"
  30 #ifndef __PCTOOL__
  31 #include "core_alloc.h"
  32 #endif
  33
  34 /* Timeout unit expressed in HZ. In WPS, all timeouts are given in seconds
  35    (possibly with a decimal fraction) but stored as integer values.
  36    E.g. 2.5 is stored as 25. This means 25 tenth of a second, i.e. 25 units.
  37 */
  38 #define TIMEOUT_UNIT (HZ/10) /* I.e. 0.1 sec */
  39 #define DEFAULT_SUBLINE_TIME_MULTIPLIER 20 /* In TIMEOUT_UNIT's */
  40
  41 /* TODO: sort this mess out */
  42
  43 #include "screen_access.h"
  44 #include "statusbar.h"
  45 #include "metadata.h"
  46
  47 #define TOKEN_VALUE_ONLY 0x0DEADC0D
  48
  49 /* wps_data*/
  50 struct wps_token {
  51     union {
  52         char c;
  53         unsigned short i;
  54         long l;
  55         OFFSETTYPE(void*) data;
  56     } value;
  57
  58     enum skin_token_type type; /* enough to store the token type */
  59     /* Whether the tag (e.g. track name or the album) refers the
  60        current or the next song (false=current, true=next) */
  61     bool next;
  62 };
  63
  64 char* get_dir(char* buf, int buf_size, const char* path, int level);
  65
  66
  67 struct skin_token_list {
  68     OFFSETTYPE(struct wps_token *) token;
  69     OFFSETTYPE(struct skin_token_list *) next;
  70 };
  71
  72 #ifdef HAVE_LCD_BITMAP
  73 struct gui_img {
  74     OFFSETTYPE(struct viewport*) vp;    /* The viewport to display this image in */
  75     short int x;                  /* x-pos */
  76     short int y;                  /* y-pos */
  77     short int num_subimages;      /* number of sub-images */
  78     short int subimage_height;    /* height of each sub-image */
  79     struct bitmap bm;
  80     int buflib_handle;
  81     OFFSETTYPE(char*) label;
  82     bool loaded;            /* load state */
  83     int display;
  84     bool using_preloaded_icons; /* using the icon system instead of a bmp */
  85 };
  86
  87 struct image_display {
  88     OFFSETTYPE(char*) label;
  89     int subimage;
  90     OFFSETTYPE(struct wps_token*) token; /* the token to get the subimage number from */
  91     int offset; /* offset into the bitmap strip to start */
  92 };
  93
  94 struct progressbar {
  95     enum skin_token_type type;
  96     OFFSETTYPE(struct viewport *) vp;
  97     /* regular pb */
  98     short x;
  99     /* >=0: explicitly set in the tag -> y-coord within the viewport
 100        <0 : not set in the tag -> negated 1-based line number within
 101             the viewport. y-coord will be computed based on the font height */
 102     short y;
 103     short width;
 104     short height;
 105     bool  follow_lang_direction;
 106
 107     OFFSETTYPE(struct gui_img *) image;
 108
 109     bool invert_fill_direction;
 110     bool nofill;
 111     bool nobar;
 112     OFFSETTYPE(struct gui_img *) slider;
 113     bool horizontal;
 114     OFFSETTYPE(struct gui_img *) backdrop;
 115 };
 116
 117 struct draw_rectangle {
 118     int x;
 119     int y;
 120     int width;
 121     int height;
 122     unsigned start_colour;
 123     unsigned end_colour;
 124 };
 125 #endif
 126
 127
 128
 129 struct align_pos {
 130     char* left;
 131     char* center;
 132     char* right;
 133 };
 134
 135 #ifdef HAVE_LCD_BITMAP
 136 #define WPS_MAX_TOKENS      1150
 137 #else
 138 #define WPS_MAX_TOKENS      64
 139 #endif
 140
 141 enum wps_parse_error {
 142     PARSE_OK,
 143     PARSE_FAIL_UNCLOSED_COND,
 144     PARSE_FAIL_INVALID_CHAR,
 145     PARSE_FAIL_COND_SYNTAX_ERROR,
 146     PARSE_FAIL_COND_INVALID_PARAM,
 147     PARSE_FAIL_LIMITS_EXCEEDED,
 148 };
 149 #ifdef HAVE_LCD_COLOR
 150 struct gradient_config {
 151     unsigned start;
 152     unsigned end;
 153     unsigned text;
 154     int lines_count;
 155 };
 156 #endif
 157
 158 #define VP_DRAW_HIDEABLE    0x1
 159 #define VP_DRAW_HIDDEN      0x2
 160 #define VP_DRAW_WASHIDDEN   0x4
 161 /* these are never drawn, nor cleared, i.e. just ignored */
 162 #define VP_NEVER_VISIBLE    0x8
 163 #ifndef __PCTOOL__
 164 #define VP_DEFAULT_LABEL    -200
 165 #else
 166 #define VP_DEFAULT_LABEL    NULL
 167 #endif
 168 #define VP_DEFAULT_LABEL_STRING "|"
 169 struct skin_viewport {
 170     struct viewport vp;   /* The LCD viewport struct */
 171     char hidden_flags;
 172     bool is_infovp;
 173     OFFSETTYPE(char*) label;
 174     int   parsed_fontid;
 175 #if LCD_DEPTH > 1
 176     bool output_to_backdrop_buffer;
 177     unsigned start_fgcolour;
 178     unsigned start_bgcolour;
 179 #ifdef HAVE_LCD_COLOR
 180     struct gradient_config start_gradient;
 181 #endif
 182 #endif
 183 };
 184 struct viewport_colour {
 185     OFFSETTYPE(struct viewport *) vp;
 186     unsigned colour;
 187 };
 188
 189 #ifdef HAVE_TOUCHSCREEN
 190 struct touchregion {
 191     OFFSETTYPE(char*) label;            /* label to identify this region */
 192     OFFSETTYPE(struct skin_viewport*) wvp;/* The viewport this region is in */
 193     short int x;             /* x-pos */
 194     short int y;             /* y-pos */
 195     short int width;         /* width */
 196     short int height;        /* height */
 197     bool reverse_bar;        /* if true 0% is the left or top */
 198     bool allow_while_locked;
 199     enum {
 200         PRESS,               /* quick press only */
 201         LONG_PRESS,          /* Long press without repeat */
 202         REPEAT,              /* long press allowing repeats */
 203     } press_length;
 204     int action;              /* action this button will return */
 205     bool armed;              /* A region is armed on press. Only armed regions are triggered
 206                                 on repeat or release. */
 207     union {                  /* Extra data, action dependant */
 208         struct touchsetting {
 209             const struct settings_list *setting; /* setting being controlled */
 210             union {         /* Value to set the setting to for ACTION_SETTING_SET */
 211                 int number;
 212                 OFFSETTYPE(char*) text;
 213             } value;
 214         } setting_data;
 215         int   value;
 216     };
 217     long last_press;        /* last tick this was pressed */
 218 };
 219
 220
 221
 222 struct touchregion_lastpress {
 223     OFFSETTYPE(struct touchregion *) region;
 224     long timeout;
 225 };
 226 #endif
 227
 228 struct playlistviewer {
 229     OFFSETTYPE(struct viewport *) vp;
 230     bool show_icons;
 231     int start_offset;
 232     OFFSETTYPE(struct skin_element *) line;
 233 };
 234
 235
 236 #ifdef HAVE_ALBUMART
 237
 238 /* albumart definitions */
 239 #define WPS_ALBUMART_NONE           0      /* WPS does not contain AA tag */
 240 #define WPS_ALBUMART_CHECK          1      /* WPS contains AA conditional tag */
 241 #define WPS_ALBUMART_LOAD           2      /* WPS contains AA tag */
 242
 243 #define WPS_ALBUMART_ALIGN_RIGHT    1    /* x align:   right */
 244 #define WPS_ALBUMART_ALIGN_CENTER   2    /* x/y align: center */
 245 #define WPS_ALBUMART_ALIGN_LEFT     4    /* x align:   left */
 246 #define WPS_ALBUMART_ALIGN_TOP      1    /* y align:   top */
 247 #define WPS_ALBUMART_ALIGN_BOTTOM   4    /* y align:   bottom */
 248
 249 struct skin_albumart {
 250     /* Album art support */
 251     int x;
 252     int y;
 253     int width;
 254     int height;
 255
 256     unsigned char xalign; /* WPS_ALBUMART_ALIGN_LEFT, _CENTER, _RIGHT */
 257     unsigned char yalign; /* WPS_ALBUMART_ALIGN_TOP, _CENTER, _BOTTOM */
 258     unsigned char state; /* WPS_ALBUMART_NONE, _CHECK, _LOAD */
 259
 260     OFFSETTYPE(struct viewport *) vp;
 261     int draw_handle;
 262 };
 263 #endif
 264
 265
 266 struct line {
 267     unsigned update_mode;
 268 };
 269
 270 struct line_alternator {
 271     int current_line;
 272     unsigned long next_change_tick;
 273 };
 274
 275 struct conditional {
 276     int last_value;
 277     OFFSETTYPE(struct wps_token *) token;
 278 };
 279
 280 struct logical_if {
 281     OFFSETTYPE(struct wps_token *) token;
 282     enum {
 283         IF_EQUALS, /* == */
 284         IF_NOTEQUALS, /* != */
 285         IF_LESSTHAN, /* < */
 286         IF_LESSTHAN_EQ, /* <= */
 287         IF_GREATERTHAN, /* > */
 288         IF_GREATERTHAN_EQ /* >= */
 289     } op;
 290     struct skin_tag_parameter operand;
 291     int num_options;
 292 };
 293
 294 struct substring {
 295     int start;
 296     int length;
 297     bool expect_number;
 298     OFFSETTYPE(struct wps_token *) token;
 299 };
 300
 301 struct listitem {
 302     bool wrap;
 303     short offset;
 304 };
 305
 306 #ifdef HAVE_SKIN_VARIABLES
 307 struct skin_var {
 308     OFFSETTYPE(const char *) label;
 309     int value;
 310     long last_changed;
 311 };
 312 struct skin_var_lastchange {
 313     OFFSETTYPE(struct skin_var *) var;
 314     long timeout;
 315 };
 316 struct skin_var_changer {
 317     OFFSETTYPE(struct skin_var *) var;
 318     int newval;
 319     bool direct; /* true to make val=newval, false for val += newval */
 320     int max;
 321 };
 322 #endif
 323
 324 /* wps_data
 325    this struct holds all necessary data which describes the
 326    viewable content of a wps */
 327 struct wps_data
 328 {
 329     int buflib_handle;
 330
 331     OFFSETTYPE(struct skin_element *) tree;
 332 #ifdef HAVE_LCD_BITMAP
 333     OFFSETTYPE(struct skin_token_list *) images;
 334     OFFSETTYPE(int *) font_ids;
 335     int font_count;
 336 #endif
 337 #ifdef HAVE_BACKDROP_IMAGE
 338     int backdrop_id;
 339     bool use_extra_framebuffer;
 340 #endif
 341
 342 #ifdef HAVE_TOUCHSCREEN
 343     OFFSETTYPE(struct skin_token_list *) touchregions;
 344     bool touchscreen_locked;
 345 #endif
 346 #ifdef HAVE_ALBUMART
 347     OFFSETTYPE(struct skin_albumart *) albumart;
 348     int    playback_aa_slot;
 349 #endif
 350
 351 #ifdef HAVE_SKIN_VARIABLES
 352     OFFSETTYPE(struct skin_token_list *) skinvars;
 353 #endif
 354
 355 #ifdef HAVE_LCD_BITMAP
 356     bool peak_meter_enabled;
 357     bool wps_sb_tag;
 358     bool show_sb_on_wps;
 359 #else /*HAVE_LCD_CHARCELLS */
 360     unsigned short wps_progress_pat[8];
 361     bool full_line_progressbar;
 362 #endif
 363     bool wps_loaded;
 364 };
 365
 366 #ifndef __PCTOOL__
 367 static inline char* get_skin_buffer(struct wps_data* data)
 368 {
 369     if (data->buflib_handle >= 0)
 370         return core_get_data(data->buflib_handle);
 371     return NULL;
 372 }
 373 #else
 374 #define get_skin_buffer(d) skin_buffer
 375 #endif
 376
 377 /* wps_data end */
 378
 379 /* wps_state
 380    holds the data which belongs to the current played track,
 381    the track which will be played afterwards, current path to the track
 382    and some status infos */
 383 struct wps_state
 384 {
 385     struct mp3entry* id3;
 386     struct mp3entry* nid3;
 387     int  ff_rewind_count;
 388     bool ff_rewind;
 389     bool paused;
 390     bool is_fading;
 391 };
 392
 393 /* change the ff/rew-status
 394    if ff_rew = true then we are in skipping mode
 395    else we are in normal mode */
 396 /* void wps_state_update_ff_rew(bool ff_rew); Currently unused */
 397
 398 /* change the tag-information of the current played track
 399    and the following track */
 400 /* void wps_state_update_id3_nid3(struct mp3entry *id3, struct mp3entry *nid3); Currently unused */
 401 /* wps_state end*/
 402
 403 /* gui_wps
 404    defines a wps with its data, state,
 405    and the screen on which the wps-content should be drawn */
 406 struct gui_wps
 407 {
 408     struct screen *display;
 409     struct wps_data *data;
 410 };
 411
 412 /* gui_wps end */
 413
 414 char *get_image_filename(const char *start, const char* bmpdir,
 415                                 char *buf, int buf_size);
 416 /***** wps_tokens.c ******/
 417
 418 const char *get_token_value(struct gui_wps *gwps,
 419                            struct wps_token *token, int offset,
 420                            char *buf, int buf_size,
 421                            int *intval);
 422
 423 /* Get the id3 fields from the cuesheet */
 424 const char *get_cuesheetid3_token(struct wps_token *token, struct mp3entry *id3,
 425                                   int offset_tracks, char *buf, int buf_size);
 426 const char *get_id3_token(struct wps_token *token, struct mp3entry *id3,
 427                           char *filename, char *buf, int buf_size, int limit, int *intval);
 428 #if CONFIG_TUNER
 429 const char *get_radio_token(struct wps_token *token, int preset_offset,
 430                             char *buf, int buf_size, int limit, int *intval);
 431 #endif
 432
 433 enum skin_find_what {
 434     SKIN_FIND_VP = 0,
 435     SKIN_FIND_UIVP,
 436 #ifdef HAVE_LCD_BITMAP
 437     SKIN_FIND_IMAGE,
 438 #endif
 439 #ifdef HAVE_TOUCHSCREEN
 440     SKIN_FIND_TOUCHREGION,
 441 #endif
 442 #ifdef HAVE_SKIN_VARIABLES
 443     SKIN_VARIABLE,
 444 #endif
 445 };
 446 void *skin_find_item(const char *label, enum skin_find_what what,
 447                      struct wps_data *data);
 448 #ifdef SIMULATOR
 449 #define DEBUG_SKIN_ENGINE
 450 extern bool debug_wps;
 451 #endif
 452
 453 #endif