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