New Touchscreen region type... 'mute' which un/mutes volume without pausing playback
[maemo-rb.git] / apps / gui / skin_engine / wps_internals.h
blob02585f22b2e7d8a11d7e8382805c76172b5ae1cb
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
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"
45 #include "metadata.h"
47 /* alignments */
48 #define WPS_ALIGN_RIGHT 32
49 #define WPS_ALIGN_CENTER 64
50 #define WPS_ALIGN_LEFT 128
53 #define TOKEN_VALUE_ONLY 0x0DEADC0D
55 #ifdef HAVE_ALBUMART
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 */
70 /* wps_data*/
72 #ifdef HAVE_LCD_BITMAP
73 struct gui_img {
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 */
79 struct bitmap bm;
80 const char *label;
81 bool loaded; /* load state */
82 bool always_display; /* not using the preload/display mechanism */
83 int display;
84 bool using_preloaded_icons; /* using the icon system instead of a bmp */
87 struct image_display {
88 const char *label;
89 int subimage;
90 struct wps_token *token; /* the token to get the subimage number from */
91 int offset; /* offset into the bitmap strip to start */
94 struct progressbar {
95 enum skin_token_type type;
96 struct viewport *vp;
97 /* regular pb */
98 short x;
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 */
102 short y;
103 short width;
104 short height;
105 bool follow_lang_direction;
107 struct gui_img *image;
109 bool invert_fill_direction;
110 bool nofill;
111 bool nobar;
112 struct gui_img *slider;
113 bool horizontal;
115 #endif
119 struct align_pos {
120 char* left;
121 char* center;
122 char* right;
125 #ifdef HAVE_LCD_BITMAP
127 #define MAX_IMAGES (26*2) /* a-z and A-Z */
128 #define MAX_PROGRESSBARS 3
130 /* The image buffer is big enough to store one full-screen native bitmap,
131 plus two full-screen mono bitmaps. */
133 #define WPS_MAX_VIEWPORTS 24
134 #define WPS_MAX_LINES ((LCD_HEIGHT/5+1) * 2)
135 #define WPS_MAX_SUBLINES (WPS_MAX_LINES*3)
136 #define WPS_MAX_TOKENS 1024
137 #define WPS_MAX_STRINGS 128
138 #define STRING_BUFFER_SIZE 1024
139 #define WPS_MAX_COND_LEVEL 10
141 #else
143 #define WPS_MAX_VIEWPORTS 2
144 #define WPS_MAX_LINES 2
145 #define WPS_MAX_SUBLINES 12
146 #define WPS_MAX_TOKENS 64
147 #define WPS_MAX_STRINGS 32
148 #define STRING_BUFFER_SIZE 64
149 #define WPS_MAX_COND_LEVEL 5
151 #endif
153 #define SUBLINE_RESET -1
155 enum wps_parse_error {
156 PARSE_OK,
157 PARSE_FAIL_UNCLOSED_COND,
158 PARSE_FAIL_INVALID_CHAR,
159 PARSE_FAIL_COND_SYNTAX_ERROR,
160 PARSE_FAIL_COND_INVALID_PARAM,
161 PARSE_FAIL_LIMITS_EXCEEDED,
164 #define VP_DRAW_HIDEABLE 0x1
165 #define VP_DRAW_HIDDEN 0x2
166 #define VP_DRAW_WASHIDDEN 0x4
167 /* these are never drawn, nor cleared, i.e. just ignored */
168 #define VP_NEVER_VISIBLE 0x8
169 #define VP_DEFAULT_LABEL "|"
170 struct skin_viewport {
171 struct viewport vp; /* The LCD viewport struct */
172 char hidden_flags;
173 bool is_infovp;
174 char* label;
175 unsigned start_fgcolour;
176 unsigned start_bgcolour;
178 struct viewport_colour {
179 struct viewport *vp;
180 unsigned colour;
182 #ifdef HAVE_TOUCHSCREEN
183 struct touchregion {
184 struct skin_viewport* wvp;/* The viewport this region is in */
185 short int x; /* x-pos */
186 short int y; /* y-pos */
187 short int width; /* width */
188 short int height; /* height */
189 enum {
190 WPS_TOUCHREGION_ACTION,
191 WPS_TOUCHREGION_SCROLLBAR,
192 WPS_TOUCHREGION_VOLUME
193 } type; /* type of touch region */
194 bool reverse_bar; /* if true 0% is the left or top */
195 bool repeat; /* requires the area be held for the action */
196 int action; /* action this button will return */
197 bool armed; /* A region is armed on press. Only armed regions are triggered
198 on repeat or release. */
199 union { /* Extra data, action dependant */
200 void* data;
201 int value;
204 #endif
206 struct playlistviewer {
207 struct viewport *vp;
208 bool show_icons;
209 int start_offset;
210 struct skin_element *line;
214 #ifdef HAVE_ALBUMART
215 struct skin_albumart {
216 /* Album art support */
217 int x;
218 int y;
219 int width;
220 int height;
222 unsigned char xalign; /* WPS_ALBUMART_ALIGN_LEFT, _CENTER, _RIGHT */
223 unsigned char yalign; /* WPS_ALBUMART_ALIGN_TOP, _CENTER, _BOTTOM */
224 unsigned char state; /* WPS_ALBUMART_NONE, _CHECK, _LOAD */
226 struct viewport *vp;
227 int draw_handle;
229 #endif
232 struct line {
233 unsigned update_mode;
236 struct line_alternator {
237 int current_line;
238 unsigned long next_change_tick;
241 struct conditional {
242 int last_value;
243 struct wps_token *token;
246 struct logical_if {
247 struct wps_token *token;
248 enum {
249 IF_EQUALS, /* == */
250 IF_NOTEQUALS, /* != */
251 IF_LESSTHAN, /* < */
252 IF_LESSTHAN_EQ, /* <= */
253 IF_GREATERTHAN, /* > */
254 IF_GREATERTHAN_EQ /* >= */
255 } op;
256 struct skin_tag_parameter operand;
257 int num_options;
260 /* wps_data
261 this struct holds all necessary data which describes the
262 viewable content of a wps */
263 struct wps_data
265 struct skin_element *tree;
266 #ifdef HAVE_LCD_BITMAP
267 struct skin_token_list *images;
268 #endif
269 #if LCD_DEPTH > 1 || defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
270 struct {
271 char *backdrop;
272 int backdrop_id;
274 #endif
276 #ifdef HAVE_TOUCHSCREEN
277 struct skin_token_list *touchregions;
278 #endif
279 #ifdef HAVE_ALBUMART
280 struct skin_albumart *albumart;
281 int playback_aa_slot;
282 #endif
284 #ifdef HAVE_LCD_BITMAP
285 bool peak_meter_enabled;
286 bool wps_sb_tag;
287 bool show_sb_on_wps;
288 #else /*HAVE_LCD_CHARCELLS */
289 unsigned short wps_progress_pat[8];
290 bool full_line_progressbar;
291 #endif
292 bool wps_loaded;
295 /* wps_data end */
297 /* wps_state
298 holds the data which belongs to the current played track,
299 the track which will be played afterwards, current path to the track
300 and some status infos */
301 struct wps_state
303 struct mp3entry* id3;
304 struct mp3entry* nid3;
305 int ff_rewind_count;
306 bool ff_rewind;
307 bool paused;
308 bool wps_time_countup;
309 bool is_fading;
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 */
320 /* wps_state end*/
322 /* gui_wps
323 defines a wps with its data, state,
324 and the screen on which the wps-content should be drawn */
325 struct gui_wps
327 struct screen *display;
328 struct wps_data *data;
331 /* gui_wps end */
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,
340 int *intval);
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);
347 #if CONFIG_TUNER
348 const char *get_radio_token(struct wps_token *token, int preset_offset,
349 char *buf, int buf_size, int limit, int *intval);
350 #endif
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);
356 #ifdef SIMULATOR
357 #define DEBUG_SKIN_ENGINE
358 extern bool debug_wps;
359 #endif
361 #endif