apps/gui/gwps.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 #ifndef _WPS_H
  22 #define _WPS_H
  23
  24 #include "screen_access.h"
  25 #include "statusbar.h"
  26 #include "metadata.h"
  27
  28 /* constants used in line_type and as refresh_mode for wps_refresh */
  29 #define WPS_REFRESH_STATIC          1    /* line doesn't change over time */
  30 #define WPS_REFRESH_DYNAMIC         2    /* line may change (e.g. time flag) */
  31 #define WPS_REFRESH_SCROLL          4    /* line scrolls */
  32 #define WPS_REFRESH_PLAYER_PROGRESS 8    /* line contains a progress bar */
  33 #define WPS_REFRESH_PEAK_METER      16   /* line contains a peak meter */
  34 #define WPS_REFRESH_ALL             0xff /* to refresh all line types */
  35 /* to refresh only those lines that change over time */
  36 #define WPS_REFRESH_NON_STATIC (WPS_REFRESH_ALL & ~WPS_REFRESH_STATIC & ~WPS_REFRESH_SCROLL)
  37
  38 /* alignments */
  39 #define WPS_ALIGN_RIGHT 32
  40 #define WPS_ALIGN_CENTER 64
  41 #define WPS_ALIGN_LEFT 128
  42
  43 #ifdef HAVE_ALBUMART
  44
  45 /* albumart definitions */
  46 #define WPS_ALBUMART_NONE           0      /* WPS does not contain AA tag */
  47 #define WPS_ALBUMART_CHECK          1      /* WPS contains AA conditional tag */
  48 #define WPS_ALBUMART_LOAD           2      /* WPS contains AA tag */
  49
  50 #define WPS_ALBUMART_ALIGN_RIGHT    1    /* x align:   right */
  51 #define WPS_ALBUMART_ALIGN_CENTER   2    /* x/y align: center */
  52 #define WPS_ALBUMART_ALIGN_LEFT     4    /* x align:   left */
  53 #define WPS_ALBUMART_ALIGN_TOP      1    /* y align:   top */
  54 #define WPS_ALBUMART_ALIGN_BOTTOM   4    /* y align:   bottom */
  55
  56 #endif /* HAVE_ALBUMART */
  57
  58 /* wps_data*/
  59
  60 #ifdef HAVE_LCD_BITMAP
  61 struct gui_img{
  62     struct bitmap bm;
  63     struct viewport* vp;    /* The viewport to display this image in */
  64     short int x;                  /* x-pos */
  65     short int y;                  /* y-pos */
  66     short int num_subimages;      /* number of sub-images */
  67     short int subimage_height;    /* height of each sub-image */
  68     short int display;            /* -1 for no display, 0..n to display a subimage */
  69     bool loaded;            /* load state */
  70     bool always_display;    /* not using the preload/display mechanism */
  71 };
  72
  73 struct progressbar {
  74     /* regular pb */
  75     short x;
  76     short y;
  77     short width;
  78     short height;
  79     /*progressbar image*/
  80     struct bitmap bm;
  81     bool have_bitmap_pb;
  82 };
  83 #endif
  84
  85 struct align_pos {
  86     char* left;
  87     char* center;
  88     char* right;
  89 };
  90
  91 #ifdef HAVE_LCD_BITMAP
  92
  93 #define MAX_IMAGES (26*2) /* a-z and A-Z */
  94 #define MAX_PROGRESSBARS 3
  95
  96 /* The image buffer is big enough to store one full-screen native bitmap,
  97    plus two full-screen mono bitmaps. */
  98
  99 #define IMG_BUFSIZE ((LCD_HEIGHT*LCD_WIDTH*LCD_DEPTH/8) \
 100                    + (2*LCD_HEIGHT*LCD_WIDTH/8))
 101
 102 #define WPS_MAX_VIEWPORTS   24
 103 #define WPS_MAX_LINES       ((LCD_HEIGHT/5+1) * 2)
 104 #define WPS_MAX_SUBLINES    (WPS_MAX_LINES*3)
 105 #define WPS_MAX_TOKENS      1024
 106 #define WPS_MAX_STRINGS     128
 107 #define STRING_BUFFER_SIZE  1024
 108 #define WPS_MAX_COND_LEVEL  10
 109
 110 #else
 111
 112 #define WPS_MAX_VIEWPORTS   2
 113 #define WPS_MAX_LINES       2
 114 #define WPS_MAX_SUBLINES    12
 115 #define WPS_MAX_TOKENS      64
 116 #define WPS_MAX_STRINGS     32
 117 #define STRING_BUFFER_SIZE  64
 118 #define WPS_MAX_COND_LEVEL  5
 119
 120 #endif
 121
 122 #define SUBLINE_RESET -1
 123
 124 enum wps_parse_error {
 125     PARSE_OK,
 126     PARSE_FAIL_UNCLOSED_COND,
 127     PARSE_FAIL_INVALID_CHAR,
 128     PARSE_FAIL_COND_SYNTAX_ERROR,
 129     PARSE_FAIL_COND_INVALID_PARAM,
 130     PARSE_FAIL_LIMITS_EXCEEDED,
 131 };
 132
 133 enum wps_token_type {
 134     WPS_NO_TOKEN,   /* for WPS tags we don't want to save as tokens */
 135     WPS_TOKEN_UNKNOWN,
 136
 137     /* Markers */
 138     WPS_TOKEN_CHARACTER,
 139     WPS_TOKEN_STRING,
 140
 141     /* Alignment */
 142     WPS_TOKEN_ALIGN_LEFT,
 143     WPS_TOKEN_ALIGN_CENTER,
 144     WPS_TOKEN_ALIGN_RIGHT,
 145
 146     /* Sublines */
 147     WPS_TOKEN_SUBLINE_TIMEOUT,
 148
 149     /* Battery */
 150     WPS_TOKEN_BATTERY_PERCENT,
 151     WPS_TOKEN_BATTERY_VOLTS,
 152     WPS_TOKEN_BATTERY_TIME,
 153     WPS_TOKEN_BATTERY_CHARGER_CONNECTED,
 154     WPS_TOKEN_BATTERY_CHARGING,
 155     WPS_TOKEN_BATTERY_SLEEPTIME,
 156
 157     /* Sound */
 158 #if (CONFIG_CODEC != MAS3507D)
 159     WPS_TOKEN_SOUND_PITCH,
 160 #endif
 161 #if (CONFIG_CODEC == SWCODEC)
 162     WPS_TOKEN_REPLAYGAIN,
 163     WPS_TOKEN_CROSSFADE,
 164 #endif
 165
 166     /* Time */
 167
 168     /* The begin/end values allow us to know if a token is an RTC one.
 169        New RTC tokens should be added between the markers. */
 170
 171     WPS_TOKENS_RTC_BEGIN, /* just the start marker, not an actual token */
 172
 173     WPS_TOKEN_RTC_DAY_OF_MONTH,
 174     WPS_TOKEN_RTC_DAY_OF_MONTH_BLANK_PADDED,
 175     WPS_TOKEN_RTC_12HOUR_CFG,
 176     WPS_TOKEN_RTC_HOUR_24_ZERO_PADDED,
 177     WPS_TOKEN_RTC_HOUR_24,
 178     WPS_TOKEN_RTC_HOUR_12_ZERO_PADDED,
 179     WPS_TOKEN_RTC_HOUR_12,
 180     WPS_TOKEN_RTC_MONTH,
 181     WPS_TOKEN_RTC_MINUTE,
 182     WPS_TOKEN_RTC_SECOND,
 183     WPS_TOKEN_RTC_YEAR_2_DIGITS,
 184     WPS_TOKEN_RTC_YEAR_4_DIGITS,
 185     WPS_TOKEN_RTC_AM_PM_UPPER,
 186     WPS_TOKEN_RTC_AM_PM_LOWER,
 187     WPS_TOKEN_RTC_WEEKDAY_NAME,
 188     WPS_TOKEN_RTC_MONTH_NAME,
 189     WPS_TOKEN_RTC_DAY_OF_WEEK_START_MON,
 190     WPS_TOKEN_RTC_DAY_OF_WEEK_START_SUN,
 191
 192     WPS_TOKENS_RTC_END,     /* just the end marker, not an actual token */
 193
 194     /* Conditional */
 195     WPS_TOKEN_CONDITIONAL,
 196     WPS_TOKEN_CONDITIONAL_START,
 197     WPS_TOKEN_CONDITIONAL_OPTION,
 198     WPS_TOKEN_CONDITIONAL_END,
 199
 200     /* Database */
 201 #ifdef HAVE_TAGCACHE
 202     WPS_TOKEN_DATABASE_PLAYCOUNT,
 203     WPS_TOKEN_DATABASE_RATING,
 204     WPS_TOKEN_DATABASE_AUTOSCORE,
 205 #endif
 206
 207     /* File */
 208     WPS_TOKEN_FILE_BITRATE,
 209     WPS_TOKEN_FILE_CODEC,
 210     WPS_TOKEN_FILE_FREQUENCY,
 211     WPS_TOKEN_FILE_FREQUENCY_KHZ,
 212     WPS_TOKEN_FILE_NAME,
 213     WPS_TOKEN_FILE_NAME_WITH_EXTENSION,
 214     WPS_TOKEN_FILE_PATH,
 215     WPS_TOKEN_FILE_SIZE,
 216     WPS_TOKEN_FILE_VBR,
 217     WPS_TOKEN_FILE_DIRECTORY,
 218
 219 #ifdef HAVE_LCD_BITMAP
 220     /* Image */
 221     WPS_TOKEN_IMAGE_BACKDROP,
 222     WPS_TOKEN_IMAGE_PROGRESS_BAR,
 223     WPS_TOKEN_IMAGE_PRELOAD,
 224     WPS_TOKEN_IMAGE_PRELOAD_DISPLAY,
 225     WPS_TOKEN_IMAGE_DISPLAY,
 226 #endif
 227
 228 #ifdef HAVE_ALBUMART
 229     /* Albumart */
 230     WPS_TOKEN_ALBUMART_DISPLAY,
 231     WPS_TOKEN_ALBUMART_FOUND,
 232 #endif
 233
 234     /* Metadata */
 235     WPS_TOKEN_METADATA_ARTIST,
 236     WPS_TOKEN_METADATA_COMPOSER,
 237     WPS_TOKEN_METADATA_ALBUM_ARTIST,
 238     WPS_TOKEN_METADATA_GROUPING,
 239     WPS_TOKEN_METADATA_ALBUM,
 240     WPS_TOKEN_METADATA_GENRE,
 241     WPS_TOKEN_METADATA_DISC_NUMBER,
 242     WPS_TOKEN_METADATA_TRACK_NUMBER,
 243     WPS_TOKEN_METADATA_TRACK_TITLE,
 244     WPS_TOKEN_METADATA_VERSION,
 245     WPS_TOKEN_METADATA_YEAR,
 246     WPS_TOKEN_METADATA_COMMENT,
 247
 248     /* Mode */
 249     WPS_TOKEN_REPEAT_MODE,
 250     WPS_TOKEN_PLAYBACK_STATUS,
 251
 252     WPS_TOKEN_MAIN_HOLD,
 253
 254 #ifdef HAS_REMOTE_BUTTON_HOLD
 255     WPS_TOKEN_REMOTE_HOLD,
 256 #endif
 257
 258     /* Progressbar */
 259     WPS_TOKEN_PROGRESSBAR,
 260 #ifdef HAVE_LCD_CHARCELLS
 261     WPS_TOKEN_PLAYER_PROGRESSBAR,
 262 #endif
 263
 264 #ifdef HAVE_LCD_BITMAP
 265     /* Peakmeter */
 266     WPS_TOKEN_PEAKMETER,
 267 #endif
 268
 269     /* Volume level */
 270     WPS_TOKEN_VOLUME,
 271
 272     /* Current track */
 273     WPS_TOKEN_TRACK_ELAPSED_PERCENT,
 274     WPS_TOKEN_TRACK_TIME_ELAPSED,
 275     WPS_TOKEN_TRACK_TIME_REMAINING,
 276     WPS_TOKEN_TRACK_LENGTH,
 277
 278     /* Playlist */
 279     WPS_TOKEN_PLAYLIST_ENTRIES,
 280     WPS_TOKEN_PLAYLIST_NAME,
 281     WPS_TOKEN_PLAYLIST_POSITION,
 282     WPS_TOKEN_PLAYLIST_SHUFFLE,
 283
 284 #if (CONFIG_LED == LED_VIRTUAL) || defined(HAVE_REMOTE_LCD)
 285     /* Virtual LED */
 286     WPS_TOKEN_VLED_HDD,
 287 #endif
 288
 289     /* Viewport display */
 290     WPS_VIEWPORT_ENABLE,
 291
 292     /* buttons */
 293     WPS_TOKEN_BUTTON_VOLUME,
 294
 295     /* Setting option */
 296     WPS_TOKEN_SETTING,
 297 };
 298
 299 struct wps_token {
 300     unsigned char type; /* enough to store the token type */
 301
 302     /* Whether the tag (e.g. track name or the album) refers the
 303        current or the next song (false=current, true=next) */
 304     bool next;
 305
 306     union {
 307         char c;
 308         unsigned short i;
 309     } value;
 310 };
 311
 312 /* Description of a subline on the WPS */
 313 struct wps_subline {
 314
 315     /* Index of the first token for this subline in the token array.
 316        Tokens of this subline end where tokens for the next subline
 317        begin. */
 318     unsigned short first_token_idx;
 319
 320     /* Bit or'ed WPS_REFRESH_xxx */
 321     unsigned char line_type;
 322
 323     /* How long the subline should be displayed, in 10ths of sec */
 324     unsigned char time_mult;
 325 };
 326
 327 /* Description of a line on the WPS. A line is a set of sublines.
 328    A subline is displayed for a certain amount of time. After that,
 329    the next subline of the line is displayed. And so on. */
 330 struct wps_line {
 331
 332     /* Number of sublines in this line */
 333     signed char num_sublines;
 334
 335     /* Number (0-based) of the subline within this line currently being displayed */
 336     signed char curr_subline;
 337
 338     /* Index of the first subline of this line in the subline array.
 339        Sublines for this line end where sublines for the next line begin. */
 340     unsigned short first_subline_idx;
 341
 342     /* When the next subline of this line should be displayed
 343        (absolute time value in ticks) */
 344     long subline_expire_time;
 345 };
 346
 347 #define VP_DRAW_HIDEABLE 0x1
 348 #define VP_DRAW_HIDDEN   0x2
 349 #define VP_DRAW_WASHIDDEN  0x4
 350 struct wps_viewport {
 351     struct viewport vp;   /* The LCD viewport struct */
 352     struct progressbar *pb;
 353     /* Indexes of the first and last lines belonging to this viewport in the
 354        lines[] array */
 355     int first_line, last_line;
 356     char hidden_flags;
 357     char label;
 358 };
 359
 360 /* wps_data
 361    this struct holds all necessary data which describes the
 362    viewable content of a wps */
 363 struct wps_data
 364 {
 365 #ifdef HAVE_LCD_BITMAP
 366     struct gui_img img[MAX_IMAGES];
 367     unsigned char img_buf[IMG_BUFSIZE];
 368     unsigned char* img_buf_ptr;
 369     int img_buf_free;
 370     bool wps_sb_tag;
 371     bool show_sb_on_wps;
 372
 373     struct progressbar progressbar[MAX_PROGRESSBARS];
 374     short progressbar_count;
 375
 376     bool peak_meter_enabled;
 377
 378 #ifdef HAVE_ALBUMART
 379     /* Album art support */
 380     unsigned char wps_uses_albumart; /* WPS_ALBUMART_NONE, _CHECK, _LOAD */
 381     short albumart_x;
 382     short albumart_y;
 383     unsigned char albumart_xalign; /* WPS_ALBUMART_ALIGN_LEFT, _CENTER, _RIGHT */
 384     unsigned char albumart_yalign; /* WPS_ALBUMART_ALIGN_TOP, _CENTER, _BOTTOM */
 385     short albumart_max_width;
 386     short albumart_max_height;
 387
 388     int albumart_cond_index;
 389 #endif
 390
 391 #else /*HAVE_LCD_CHARCELLS */
 392     unsigned short wps_progress_pat[8];
 393     bool full_line_progressbar;
 394 #endif
 395
 396 #ifdef HAVE_REMOTE_LCD
 397     bool remote_wps;
 398 #endif
 399
 400     /* Number of lines in the WPS. During WPS parsing, this is
 401        the index of the line being parsed. */
 402     int num_lines;
 403
 404     /* Number of viewports in the WPS */
 405     int num_viewports;
 406     struct wps_viewport viewports[WPS_MAX_VIEWPORTS];
 407
 408     struct wps_line lines[WPS_MAX_LINES];
 409
 410     /* Total number of sublines in the WPS. During WPS parsing, this is
 411        the index of the subline where the parsed tokens are added to. */
 412     int num_sublines;
 413     struct wps_subline sublines[WPS_MAX_SUBLINES];
 414
 415     /* Total number of tokens in the WPS. During WPS parsing, this is
 416        the index of the token being parsed. */
 417     int num_tokens;
 418     struct wps_token tokens[WPS_MAX_TOKENS];
 419
 420     char string_buffer[STRING_BUFFER_SIZE];
 421     char *strings[WPS_MAX_STRINGS];
 422     int num_strings;
 423
 424     bool wps_loaded;
 425
 426     /* tick the volume button was last pressed */
 427     unsigned int button_time_volume;
 428 };
 429
 430 /* initial setup of wps_data */
 431 void wps_data_init(struct wps_data *wps_data);
 432
 433 /* to setup up the wps-data from a format-buffer (isfile = false)
 434    from a (wps-)file (isfile = true)*/
 435 bool wps_data_load(struct wps_data *wps_data,
 436                    struct screen *display,
 437                    const char *buf,
 438                    bool isfile);
 439
 440 /* Returns the index of the subline in the subline array
 441    line - 0-based line number
 442    subline - 0-based subline number within the line
 443  */
 444 int wps_subline_index(struct wps_data *wps_data, int line, int subline);
 445
 446 /* Returns the index of the first subline's token in the token array
 447    line - 0-based line number
 448    subline - 0-based subline number within the line
 449  */
 450 int wps_first_token_index(struct wps_data *data, int line, int subline);
 451
 452 /* Returns the index of the last subline's token in the token array.
 453    line - 0-based line number
 454    subline - 0-based subline number within the line
 455  */
 456 int wps_last_token_index(struct wps_data *data, int line, int subline);
 457
 458 /* wps_data end */
 459
 460 /* wps_state
 461    holds the data which belongs to the current played track,
 462    the track which will be played afterwards, current path to the track
 463    and some status infos */
 464 struct wps_state
 465 {
 466     bool ff_rewind;
 467     bool paused;
 468     int ff_rewind_count;
 469     bool wps_time_countup;
 470     struct mp3entry* id3;
 471     struct mp3entry* nid3;
 472 };
 473
 474
 475 /* change the ff/rew-status
 476    if ff_rew = true then we are in skipping mode
 477    else we are in normal mode */
 478 /* void wps_state_update_ff_rew(bool ff_rew); Currently unused */
 479
 480 /* change the tag-information of the current played track
 481    and the following track */
 482 /* void wps_state_update_id3_nid3(struct mp3entry *id3, struct mp3entry *nid3); Currently unused */
 483 /* wps_state end*/
 484
 485 /* gui_wps
 486    defines a wps with its data, state,
 487    and the screen on which the wps-content should be drawn */
 488 struct gui_wps
 489 {
 490     struct screen *display;
 491     struct wps_data *data;
 492     struct wps_state *state;
 493 };
 494
 495 /* gui_wps end */
 496
 497 long gui_wps_show(void);
 498
 499 /* currently only on wps_state is needed */
 500 extern struct wps_state wps_state;
 501 extern struct gui_wps gui_wps[NB_SCREENS];
 502
 503 void gui_sync_wps_init(void);
 504
 505 #ifdef HAVE_ALBUMART
 506 /* gives back if WPS contains an albumart tag */
 507 bool gui_sync_wps_uses_albumart(void);
 508 #endif
 509
 510 #endif