1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2007 Nicolas Pennequin
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.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
24 #include "screen_access.h"
25 #include "statusbar.h"
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)
39 #define WPS_ALIGN_RIGHT 32
40 #define WPS_ALIGN_CENTER 64
41 #define WPS_ALIGN_LEFT 128
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 */
50 #define WPS_ALBUMART_ALIGN_RIGHT WPS_ALIGN_RIGHT /* x align: right */
51 #define WPS_ALBUMART_ALIGN_CENTER WPS_ALIGN_CENTER /* x/y align: center */
52 #define WPS_ALBUMART_ALIGN_LEFT WPS_ALIGN_LEFT /* x align: left */
53 #define WPS_ALBUMART_ALIGN_TOP WPS_ALIGN_RIGHT /* y align: top */
54 #define WPS_ALBUMART_ALIGN_BOTTOM WPS_ALIGN_LEFT /* y align: bottom */
55 #define WPS_ALBUMART_INCREASE 8 /* increase if smaller */
56 #define WPS_ALBUMART_DECREASE 16 /* decrease if larger */
58 #endif /* HAVE_ALBUMART */
62 #ifdef HAVE_LCD_BITMAP
65 struct viewport
* vp
; /* The viewport to display this image in */
66 short int x
; /* x-pos */
67 short int y
; /* y-pos */
68 short int num_subimages
; /* number of sub-images */
69 short int subimage_height
; /* height of each sub-image */
70 short int display
; /* -1 for no display, 0..n to display a subimage */
71 bool loaded
; /* load state */
72 bool always_display
; /* not using the preload/display mechanism */
93 #ifdef HAVE_LCD_BITMAP
95 #define MAX_IMAGES (26*2) /* a-z and A-Z */
96 #define MAX_PROGRESSBARS 3
98 /* The image buffer is big enough to store one full-screen native bitmap,
99 plus two full-screen mono bitmaps. */
101 #define IMG_BUFSIZE ((LCD_HEIGHT*LCD_WIDTH*LCD_DEPTH/8) \
102 + (2*LCD_HEIGHT*LCD_WIDTH/8))
104 #define WPS_MAX_VIEWPORTS 24
105 #define WPS_MAX_LINES ((LCD_HEIGHT/5+1) * 2)
106 #define WPS_MAX_SUBLINES (WPS_MAX_LINES*3)
107 #define WPS_MAX_TOKENS 1024
108 #define WPS_MAX_STRINGS 128
109 #define STRING_BUFFER_SIZE 1024
110 #define WPS_MAX_COND_LEVEL 10
114 #define WPS_MAX_VIEWPORTS 2
115 #define WPS_MAX_LINES 2
116 #define WPS_MAX_SUBLINES 12
117 #define WPS_MAX_TOKENS 64
118 #define WPS_MAX_STRINGS 32
119 #define STRING_BUFFER_SIZE 64
120 #define WPS_MAX_COND_LEVEL 5
124 #define SUBLINE_RESET -1
126 enum wps_parse_error
{
128 PARSE_FAIL_UNCLOSED_COND
,
129 PARSE_FAIL_INVALID_CHAR
,
130 PARSE_FAIL_COND_SYNTAX_ERROR
,
131 PARSE_FAIL_COND_INVALID_PARAM
,
132 PARSE_FAIL_LIMITS_EXCEEDED
,
135 enum wps_token_type
{
136 WPS_NO_TOKEN
, /* for WPS tags we don't want to save as tokens */
144 WPS_TOKEN_ALIGN_LEFT
,
145 WPS_TOKEN_ALIGN_CENTER
,
146 WPS_TOKEN_ALIGN_RIGHT
,
149 WPS_TOKEN_SUBLINE_TIMEOUT
,
152 WPS_TOKEN_BATTERY_PERCENT
,
153 WPS_TOKEN_BATTERY_VOLTS
,
154 WPS_TOKEN_BATTERY_TIME
,
155 WPS_TOKEN_BATTERY_CHARGER_CONNECTED
,
156 WPS_TOKEN_BATTERY_CHARGING
,
157 WPS_TOKEN_BATTERY_SLEEPTIME
,
160 #if (CONFIG_CODEC != MAS3507D)
161 WPS_TOKEN_SOUND_PITCH
,
163 #if (CONFIG_CODEC == SWCODEC)
164 WPS_TOKEN_REPLAYGAIN
,
170 /* The begin/end values allow us to know if a token is an RTC one.
171 New RTC tokens should be added between the markers. */
173 WPS_TOKENS_RTC_BEGIN
, /* just the start marker, not an actual token */
175 WPS_TOKEN_RTC_DAY_OF_MONTH
,
176 WPS_TOKEN_RTC_DAY_OF_MONTH_BLANK_PADDED
,
177 WPS_TOKEN_RTC_12HOUR_CFG
,
178 WPS_TOKEN_RTC_HOUR_24_ZERO_PADDED
,
179 WPS_TOKEN_RTC_HOUR_24
,
180 WPS_TOKEN_RTC_HOUR_12_ZERO_PADDED
,
181 WPS_TOKEN_RTC_HOUR_12
,
183 WPS_TOKEN_RTC_MINUTE
,
184 WPS_TOKEN_RTC_SECOND
,
185 WPS_TOKEN_RTC_YEAR_2_DIGITS
,
186 WPS_TOKEN_RTC_YEAR_4_DIGITS
,
187 WPS_TOKEN_RTC_AM_PM_UPPER
,
188 WPS_TOKEN_RTC_AM_PM_LOWER
,
189 WPS_TOKEN_RTC_WEEKDAY_NAME
,
190 WPS_TOKEN_RTC_MONTH_NAME
,
191 WPS_TOKEN_RTC_DAY_OF_WEEK_START_MON
,
192 WPS_TOKEN_RTC_DAY_OF_WEEK_START_SUN
,
194 WPS_TOKENS_RTC_END
, /* just the end marker, not an actual token */
197 WPS_TOKEN_CONDITIONAL
,
198 WPS_TOKEN_CONDITIONAL_START
,
199 WPS_TOKEN_CONDITIONAL_OPTION
,
200 WPS_TOKEN_CONDITIONAL_END
,
204 WPS_TOKEN_DATABASE_PLAYCOUNT
,
205 WPS_TOKEN_DATABASE_RATING
,
206 WPS_TOKEN_DATABASE_AUTOSCORE
,
210 WPS_TOKEN_FILE_BITRATE
,
211 WPS_TOKEN_FILE_CODEC
,
212 WPS_TOKEN_FILE_FREQUENCY
,
213 WPS_TOKEN_FILE_FREQUENCY_KHZ
,
215 WPS_TOKEN_FILE_NAME_WITH_EXTENSION
,
219 WPS_TOKEN_FILE_DIRECTORY
,
221 #ifdef HAVE_LCD_BITMAP
223 WPS_TOKEN_IMAGE_BACKDROP
,
224 WPS_TOKEN_IMAGE_PROGRESS_BAR
,
225 WPS_TOKEN_IMAGE_PRELOAD
,
226 WPS_TOKEN_IMAGE_PRELOAD_DISPLAY
,
227 WPS_TOKEN_IMAGE_DISPLAY
,
232 WPS_TOKEN_ALBUMART_DISPLAY
,
233 WPS_TOKEN_ALBUMART_FOUND
,
237 WPS_TOKEN_METADATA_ARTIST
,
238 WPS_TOKEN_METADATA_COMPOSER
,
239 WPS_TOKEN_METADATA_ALBUM_ARTIST
,
240 WPS_TOKEN_METADATA_GROUPING
,
241 WPS_TOKEN_METADATA_ALBUM
,
242 WPS_TOKEN_METADATA_GENRE
,
243 WPS_TOKEN_METADATA_DISC_NUMBER
,
244 WPS_TOKEN_METADATA_TRACK_NUMBER
,
245 WPS_TOKEN_METADATA_TRACK_TITLE
,
246 WPS_TOKEN_METADATA_VERSION
,
247 WPS_TOKEN_METADATA_YEAR
,
248 WPS_TOKEN_METADATA_COMMENT
,
251 WPS_TOKEN_REPEAT_MODE
,
252 WPS_TOKEN_PLAYBACK_STATUS
,
256 #ifdef HAS_REMOTE_BUTTON_HOLD
257 WPS_TOKEN_REMOTE_HOLD
,
261 WPS_TOKEN_PROGRESSBAR
,
262 #ifdef HAVE_LCD_CHARCELLS
263 WPS_TOKEN_PLAYER_PROGRESSBAR
,
266 #ifdef HAVE_LCD_BITMAP
275 WPS_TOKEN_TRACK_ELAPSED_PERCENT
,
276 WPS_TOKEN_TRACK_TIME_ELAPSED
,
277 WPS_TOKEN_TRACK_TIME_REMAINING
,
278 WPS_TOKEN_TRACK_LENGTH
,
281 WPS_TOKEN_PLAYLIST_ENTRIES
,
282 WPS_TOKEN_PLAYLIST_NAME
,
283 WPS_TOKEN_PLAYLIST_POSITION
,
284 WPS_TOKEN_PLAYLIST_SHUFFLE
,
286 #if (CONFIG_LED == LED_VIRTUAL) || defined(HAVE_REMOTE_LCD)
291 /* Viewport display */
295 WPS_TOKEN_BUTTON_VOLUME
299 unsigned char type
; /* enough to store the token type */
301 /* Whether the tag (e.g. track name or the album) refers the
302 current or the next song (false=current, true=next) */
311 /* Description of a subline on the WPS */
314 /* Index of the first token for this subline in the token array.
315 Tokens of this subline end where tokens for the next subline
317 unsigned short first_token_idx
;
319 /* Bit or'ed WPS_REFRESH_xxx */
320 unsigned char line_type
;
322 /* How long the subline should be displayed, in 10ths of sec */
323 unsigned char time_mult
;
326 /* Description of a line on the WPS. A line is a set of sublines.
327 A subline is displayed for a certain amount of time. After that,
328 the next subline of the line is displayed. And so on. */
331 /* Number of sublines in this line */
332 signed char num_sublines
;
334 /* Number (0-based) of the subline within this line currently being displayed */
335 signed char curr_subline
;
337 /* Index of the first subline of this line in the subline array.
338 Sublines for this line end where sublines for the next line begin. */
339 unsigned short first_subline_idx
;
341 /* When the next subline of this line should be displayed
342 (absolute time value in ticks) */
343 long subline_expire_time
;
346 #define VP_DRAW_HIDEABLE 0x1
347 #define VP_DRAW_HIDDEN 0x2
348 #define VP_DRAW_WASHIDDEN 0x4
349 struct wps_viewport
{
350 struct viewport vp
; /* The LCD viewport struct */
351 struct progressbar
*pb
;
352 /* Indexes of the first and last lines belonging to this viewport in the
354 int first_line
, last_line
;
360 this struct holds all necessary data which describes the
361 viewable content of a wps */
364 #ifdef HAVE_LCD_BITMAP
365 struct gui_img img
[MAX_IMAGES
];
366 unsigned char img_buf
[IMG_BUFSIZE
];
367 unsigned char* img_buf_ptr
;
372 struct progressbar progressbar
[MAX_PROGRESSBARS
];
373 short progressbar_count
;
375 bool peak_meter_enabled
;
378 /* Album art support */
379 unsigned char wps_uses_albumart
; /* WPS_ALBUMART_NONE, _CHECK, _LOAD */
382 unsigned short albumart_xalign
; /* WPS_ALBUMART_ALIGN_LEFT, _CENTER, _RIGHT,
383 + .._INCREASE, + .._DECREASE */
384 unsigned short albumart_yalign
; /* WPS_ALBUMART_ALIGN_TOP, _CENTER, _BOTTOM,
385 + .._INCREASE, + .._DECREASE */
386 short albumart_max_width
;
387 short albumart_max_height
;
389 int albumart_cond_index
;
392 #else /*HAVE_LCD_CHARCELLS */
393 unsigned short wps_progress_pat
[8];
394 bool full_line_progressbar
;
397 #ifdef HAVE_REMOTE_LCD
401 /* Number of lines in the WPS. During WPS parsing, this is
402 the index of the line being parsed. */
405 /* Number of viewports in the WPS */
407 struct wps_viewport viewports
[WPS_MAX_VIEWPORTS
];
409 struct wps_line lines
[WPS_MAX_LINES
];
411 /* Total number of sublines in the WPS. During WPS parsing, this is
412 the index of the subline where the parsed tokens are added to. */
414 struct wps_subline sublines
[WPS_MAX_SUBLINES
];
416 /* Total number of tokens in the WPS. During WPS parsing, this is
417 the index of the token being parsed. */
419 struct wps_token tokens
[WPS_MAX_TOKENS
];
421 char string_buffer
[STRING_BUFFER_SIZE
];
422 char *strings
[WPS_MAX_STRINGS
];
427 /* tick the volume button was last pressed */
428 unsigned int button_time_volume
;
431 /* initial setup of wps_data */
432 void wps_data_init(struct wps_data
*wps_data
);
434 /* to setup up the wps-data from a format-buffer (isfile = false)
435 from a (wps-)file (isfile = true)*/
436 bool wps_data_load(struct wps_data
*wps_data
,
437 struct screen
*display
,
441 /* Returns the index of the subline in the subline array
442 line - 0-based line number
443 subline - 0-based subline number within the line
445 int wps_subline_index(struct wps_data
*wps_data
, int line
, int subline
);
447 /* Returns the index of the first subline's token in the token array
448 line - 0-based line number
449 subline - 0-based subline number within the line
451 int wps_first_token_index(struct wps_data
*data
, int line
, int subline
);
453 /* Returns the index of the last subline's token in the token array.
454 line - 0-based line number
455 subline - 0-based subline number within the line
457 int wps_last_token_index(struct wps_data
*data
, int line
, int subline
);
462 holds the data which belongs to the current played track,
463 the track which will be played afterwards, current path to the track
464 and some status infos */
470 bool wps_time_countup
;
471 struct mp3entry
* id3
;
472 struct mp3entry
* nid3
;
473 char current_track_path
[MAX_PATH
];
477 /* change the ff/rew-status
478 if ff_rew = true then we are in skipping mode
479 else we are in normal mode */
480 /* void wps_state_update_ff_rew(bool ff_rew); Currently unused */
482 /* change the tag-information of the current played track
483 and the following track */
484 /* void wps_state_update_id3_nid3(struct mp3entry *id3, struct mp3entry *nid3); Currently unused */
488 defines a wps with its data, state,
489 and the screen on which the wps-content should be drawn */
492 struct screen
*display
;
493 struct wps_data
*data
;
494 struct wps_state
*state
;
495 struct gui_statusbar
*statusbar
;
500 long gui_wps_show(void);
502 /* currently only on wps_state is needed */
503 extern struct wps_state wps_state
;
504 extern struct gui_wps gui_wps
[NB_SCREENS
];
506 void gui_sync_wps_init(void);
507 void gui_sync_wps_screen_init(void);
510 /* gives back if WPS contains an albumart tag */
511 bool gui_sync_wps_uses_albumart(void);