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