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 ****************************************************************************/
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! */
25 #ifndef _WPS_ENGINE_INTERNALS_
26 #define _WPS_ENGINE_INTERNALS_
29 /* Timeout unit expressed in HZ. In WPS, all timeouts are given in seconds
30 (possibly with a decimal fraction) but stored as integer values.
31 E.g. 2.5 is stored as 25. This means 25 tenth of a second, i.e. 25 units.
33 #define TIMEOUT_UNIT (HZ/10) /* I.e. 0.1 sec */
34 #define DEFAULT_SUBLINE_TIME_MULTIPLIER 20 /* In TIMEOUT_UNIT's */
36 #include "skin_tokens.h"
37 #include "tag_table.h"
38 #include "skin_parser.h"
41 /* TODO: sort this mess out */
43 #include "screen_access.h"
44 #include "statusbar.h"
48 #define WPS_ALIGN_RIGHT 32
49 #define WPS_ALIGN_CENTER 64
50 #define WPS_ALIGN_LEFT 128
53 #define TOKEN_VALUE_ONLY 0x0DEADC0D
57 /* albumart definitions */
58 #define WPS_ALBUMART_NONE 0 /* WPS does not contain AA tag */
59 #define WPS_ALBUMART_CHECK 1 /* WPS contains AA conditional tag */
60 #define WPS_ALBUMART_LOAD 2 /* WPS contains AA tag */
62 #define WPS_ALBUMART_ALIGN_RIGHT 1 /* x align: right */
63 #define WPS_ALBUMART_ALIGN_CENTER 2 /* x/y align: center */
64 #define WPS_ALBUMART_ALIGN_LEFT 4 /* x align: left */
65 #define WPS_ALBUMART_ALIGN_TOP 1 /* y align: top */
66 #define WPS_ALBUMART_ALIGN_BOTTOM 4 /* y align: bottom */
68 #endif /* HAVE_ALBUMART */
72 #ifdef HAVE_LCD_BITMAP
74 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 */
81 bool loaded
; /* load state */
82 bool always_display
; /* not using the preload/display mechanism */
84 bool using_preloaded_icons
; /* using the icon system instead of a bmp */
87 struct image_display
{
90 struct wps_token
*token
; /* the token to get the subimage number from */
91 int offset
; /* offset into the bitmap strip to start */
95 enum skin_token_type type
;
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 */
105 bool follow_lang_direction
;
107 struct gui_img
*image
;
109 bool invert_fill_direction
;
112 struct gui_img
*slider
;
114 struct gui_img
*backdrop
;
126 #ifdef HAVE_LCD_BITMAP
128 #define MAX_IMAGES (26*2) /* a-z and A-Z */
129 #define MAX_PROGRESSBARS 3
131 /* The image buffer is big enough to store one full-screen native bitmap,
132 plus two full-screen mono bitmaps. */
134 #define WPS_MAX_VIEWPORTS 24
135 #define WPS_MAX_LINES ((LCD_HEIGHT/5+1) * 2)
136 #define WPS_MAX_SUBLINES (WPS_MAX_LINES*3)
137 #define WPS_MAX_TOKENS 1024
138 #define WPS_MAX_STRINGS 128
139 #define STRING_BUFFER_SIZE 1024
140 #define WPS_MAX_COND_LEVEL 10
144 #define WPS_MAX_VIEWPORTS 2
145 #define WPS_MAX_LINES 2
146 #define WPS_MAX_SUBLINES 12
147 #define WPS_MAX_TOKENS 64
148 #define WPS_MAX_STRINGS 32
149 #define STRING_BUFFER_SIZE 64
150 #define WPS_MAX_COND_LEVEL 5
154 #define SUBLINE_RESET -1
156 enum wps_parse_error
{
158 PARSE_FAIL_UNCLOSED_COND
,
159 PARSE_FAIL_INVALID_CHAR
,
160 PARSE_FAIL_COND_SYNTAX_ERROR
,
161 PARSE_FAIL_COND_INVALID_PARAM
,
162 PARSE_FAIL_LIMITS_EXCEEDED
,
165 #define VP_DRAW_HIDEABLE 0x1
166 #define VP_DRAW_HIDDEN 0x2
167 #define VP_DRAW_WASHIDDEN 0x4
168 /* these are never drawn, nor cleared, i.e. just ignored */
169 #define VP_NEVER_VISIBLE 0x8
170 #define VP_DEFAULT_LABEL "|"
171 struct skin_viewport
{
172 struct viewport vp
; /* The LCD viewport struct */
176 unsigned start_fgcolour
;
177 unsigned start_bgcolour
;
179 struct viewport_colour
{
183 #ifdef HAVE_TOUCHSCREEN
185 struct skin_viewport
* wvp
;/* The viewport this region is in */
186 short int x
; /* x-pos */
187 short int y
; /* y-pos */
188 short int width
; /* width */
189 short int height
; /* height */
191 WPS_TOUCHREGION_ACTION
,
192 WPS_TOUCHREGION_SCROLLBAR
,
193 WPS_TOUCHREGION_VOLUME
194 } type
; /* type of touch region */
195 bool reverse_bar
; /* if true 0% is the left or top */
196 bool repeat
; /* requires the area be held for the action */
197 int action
; /* action this button will return */
198 bool armed
; /* A region is armed on press. Only armed regions are triggered
199 on repeat or release. */
200 union { /* Extra data, action dependant */
207 struct playlistviewer
{
211 struct skin_element
*line
;
216 struct skin_albumart
{
217 /* Album art support */
223 unsigned char xalign
; /* WPS_ALBUMART_ALIGN_LEFT, _CENTER, _RIGHT */
224 unsigned char yalign
; /* WPS_ALBUMART_ALIGN_TOP, _CENTER, _BOTTOM */
225 unsigned char state
; /* WPS_ALBUMART_NONE, _CHECK, _LOAD */
234 unsigned update_mode
;
237 struct line_alternator
{
239 unsigned long next_change_tick
;
244 struct wps_token
*token
;
248 struct wps_token
*token
;
251 IF_NOTEQUALS
, /* != */
253 IF_LESSTHAN_EQ
, /* <= */
254 IF_GREATERTHAN
, /* > */
255 IF_GREATERTHAN_EQ
/* >= */
257 struct skin_tag_parameter operand
;
262 this struct holds all necessary data which describes the
263 viewable content of a wps */
266 struct skin_element
*tree
;
267 #ifdef HAVE_LCD_BITMAP
268 struct skin_token_list
*images
;
270 #if LCD_DEPTH > 1 || defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
277 #ifdef HAVE_TOUCHSCREEN
278 struct skin_token_list
*touchregions
;
281 struct skin_albumart
*albumart
;
282 int playback_aa_slot
;
285 #ifdef HAVE_LCD_BITMAP
286 bool peak_meter_enabled
;
289 #else /*HAVE_LCD_CHARCELLS */
290 unsigned short wps_progress_pat
[8];
291 bool full_line_progressbar
;
299 holds the data which belongs to the current played track,
300 the track which will be played afterwards, current path to the track
301 and some status infos */
304 struct mp3entry
* id3
;
305 struct mp3entry
* nid3
;
312 /* change the ff/rew-status
313 if ff_rew = true then we are in skipping mode
314 else we are in normal mode */
315 /* void wps_state_update_ff_rew(bool ff_rew); Currently unused */
317 /* change the tag-information of the current played track
318 and the following track */
319 /* void wps_state_update_id3_nid3(struct mp3entry *id3, struct mp3entry *nid3); Currently unused */
323 defines a wps with its data, state,
324 and the screen on which the wps-content should be drawn */
327 struct screen
*display
;
328 struct wps_data
*data
;
333 char *get_image_filename(const char *start
, const char* bmpdir
,
334 char *buf
, int buf_size
);
335 /***** wps_tokens.c ******/
337 const char *get_token_value(struct gui_wps
*gwps
,
338 struct wps_token
*token
, int offset
,
339 char *buf
, int buf_size
,
342 /* Get the id3 fields from the cuesheet */
343 const char *get_cuesheetid3_token(struct wps_token
*token
, struct mp3entry
*id3
,
344 int offset_tracks
, char *buf
, int buf_size
);
345 const char *get_id3_token(struct wps_token
*token
, struct mp3entry
*id3
,
346 char *filename
, char *buf
, int buf_size
, int limit
, int *intval
);
348 const char *get_radio_token(struct wps_token
*token
, int preset_offset
,
349 char *buf
, int buf_size
, int limit
, int *intval
);
352 struct gui_img
* find_image(const char *label
, struct wps_data
*data
);
353 struct skin_viewport
* find_viewport(const char *label
, bool uivp
, struct wps_data
*data
);
357 #define DEBUG_SKIN_ENGINE
358 extern bool debug_wps
;