1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2010 Robert Bieber
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 ****************************************************************************/
30 #define MAX_TAG_LENGTH 4 /* includes the \0 */
31 #define MAX_TAG_PARAMS 12
33 #define NOBREAK 0x1 /* Flag to tell the renderer not to insert a line break */
34 #define FEATURE_TAG 0x2 /* Parse time conditional for feature checks (e.g HAVE_RTC) */
36 /* constants used in line_type and as refresh_mode for wps_refresh */
37 #define SKIN_REFRESH_SHIFT 16
38 #define SKIN_REFRESH_STATIC (1u<<SKIN_REFRESH_SHIFT) /* line doesn't change over time */
39 #define SKIN_REFRESH_DYNAMIC (1u<<(SKIN_REFRESH_SHIFT+1)) /* line may change (e.g. time flag) */
40 #define SKIN_REFRESH_SCROLL (1u<<(SKIN_REFRESH_SHIFT+2)) /* line scrolls */
41 #define SKIN_REFRESH_PLAYER_PROGRESS (1u<<(SKIN_REFRESH_SHIFT+3)) /* line contains a progress bar */
42 #define SKIN_REFRESH_PEAK_METER (1u<<(SKIN_REFRESH_SHIFT+4)) /* line contains a peak meter */
43 #define SKIN_REFRESH_STATUSBAR (1u<<(SKIN_REFRESH_SHIFT+5)) /* refresh statusbar */
44 #define SKIN_RTC_REFRESH (1u<<(SKIN_REFRESH_SHIFT+6)) /* refresh rtc, convert at parse time */
45 #define SKIN_REFRESH_ALL (0xffffu<<SKIN_REFRESH_SHIFT) /* to refresh all line types */
47 /* to refresh only those lines that change over time */
48 #define SKIN_REFRESH_NON_STATIC (SKIN_REFRESH_DYNAMIC| \
49 SKIN_REFRESH_PLAYER_PROGRESS| \
50 SKIN_REFRESH_PEAK_METER)
52 enum skin_token_type
{
60 SKIN_TOKEN_TRANSLATEDSTRING
,
63 SKIN_TOKEN_ALIGN_LEFT
,
64 SKIN_TOKEN_ALIGN_LEFT_RTL
,
65 SKIN_TOKEN_ALIGN_CENTER
,
66 SKIN_TOKEN_ALIGN_RIGHT
,
67 SKIN_TOKEN_ALIGN_RIGHT_RTL
,
68 SKIN_TOKEN_ALIGN_LANGDIRECTION
,
72 SKIN_TOKEN_SUBLINE_TIMEOUT
,
73 SKIN_TOKEN_SUBLINE_SCROLL
,
76 SKIN_TOKEN_LOGICAL_IF
,
77 SKIN_TOKEN_LOGICAL_AND
,
78 SKIN_TOKEN_LOGICAL_OR
,
79 SKIN_TOKEN_CONDITIONAL
,
80 SKIN_TOKEN_CONDITIONAL_START
,
81 SKIN_TOKEN_CONDITIONAL_OPTION
,
82 SKIN_TOKEN_CONDITIONAL_END
,
84 /* Viewport display */
85 SKIN_TOKEN_VIEWPORT_LOAD
,
86 SKIN_TOKEN_VIEWPORT_CONDITIONAL
,
87 SKIN_TOKEN_VIEWPORT_ENABLE
,
88 SKIN_TOKEN_VIEWPORT_CUSTOMLIST
,
89 SKIN_TOKEN_UIVIEWPORT_ENABLE
,
90 SKIN_TOKEN_UIVIEWPORT_LOAD
,
91 SKIN_TOKEN_VIEWPORT_FGCOLOUR
,
92 SKIN_TOKEN_VIEWPORT_BGCOLOUR
,
93 SKIN_TOKEN_VIEWPORT_TEXTSTYLE
,
94 SKIN_TOKEN_VIEWPORT_GRADIENT_SETUP
,
95 SKIN_TOKEN_VIEWPORT_DRAWONBG
,
98 SKIN_TOKEN_BATTERY_PERCENT
,
99 SKIN_TOKEN_BATTERY_PERCENTBAR
,
100 SKIN_TOKEN_BATTERY_VOLTS
,
101 SKIN_TOKEN_BATTERY_TIME
,
102 SKIN_TOKEN_BATTERY_CHARGER_CONNECTED
,
103 SKIN_TOKEN_BATTERY_CHARGING
,
104 SKIN_TOKEN_BATTERY_SLEEPTIME
,
105 SKIN_TOKEN_USB_POWERED
,
108 SKIN_TOKEN_SOUND_PITCH
,
109 SKIN_TOKEN_SOUND_SPEED
,
110 SKIN_TOKEN_REPLAYGAIN
,
111 SKIN_TOKEN_CROSSFADE
,
114 SKIN_TOKEN_RTC_PRESENT
,
116 /* The begin/end values allow us to know if a token is an RTC one.
117 New RTC tokens should be added between the markers. */
119 SKIN_TOKENS_RTC_BEGIN
, /* just the start marker, not an actual token */
121 SKIN_TOKEN_RTC_DAY_OF_MONTH
,
122 SKIN_TOKEN_RTC_DAY_OF_MONTH_BLANK_PADDED
,
123 SKIN_TOKEN_RTC_12HOUR_CFG
,
124 SKIN_TOKEN_RTC_HOUR_24_ZERO_PADDED
,
125 SKIN_TOKEN_RTC_HOUR_24
,
126 SKIN_TOKEN_RTC_HOUR_12_ZERO_PADDED
,
127 SKIN_TOKEN_RTC_HOUR_12
,
128 SKIN_TOKEN_RTC_MONTH
,
129 SKIN_TOKEN_RTC_MINUTE
,
130 SKIN_TOKEN_RTC_SECOND
,
131 SKIN_TOKEN_RTC_YEAR_2_DIGITS
,
132 SKIN_TOKEN_RTC_YEAR_4_DIGITS
,
133 SKIN_TOKEN_RTC_AM_PM_UPPER
,
134 SKIN_TOKEN_RTC_AM_PM_LOWER
,
135 SKIN_TOKEN_RTC_WEEKDAY_NAME
,
136 SKIN_TOKEN_RTC_MONTH_NAME
,
137 SKIN_TOKEN_RTC_DAY_OF_WEEK_START_MON
,
138 SKIN_TOKEN_RTC_DAY_OF_WEEK_START_SUN
,
140 SKIN_TOKENS_RTC_END
, /* just the end marker, not an actual token */
143 SKIN_TOKEN_DATABASE_PLAYCOUNT
,
144 SKIN_TOKEN_DATABASE_RATING
,
145 SKIN_TOKEN_DATABASE_AUTOSCORE
,
148 SKIN_TOKEN_FILE_BITRATE
,
149 SKIN_TOKEN_FILE_CODEC
,
150 SKIN_TOKEN_FILE_FREQUENCY
,
151 SKIN_TOKEN_FILE_FREQUENCY_KHZ
,
152 SKIN_TOKEN_FILE_NAME
,
153 SKIN_TOKEN_FILE_NAME_WITH_EXTENSION
,
154 SKIN_TOKEN_FILE_PATH
,
155 SKIN_TOKEN_FILE_SIZE
,
157 SKIN_TOKEN_FILE_DIRECTORY
,
160 SKIN_TOKEN_IMAGE_BACKDROP
,
161 SKIN_TOKEN_IMAGE_PROGRESS_BAR
,
162 SKIN_TOKEN_IMAGE_PRELOAD
,
163 SKIN_TOKEN_IMAGE_PRELOAD_DISPLAY
,
164 SKIN_TOKEN_IMAGE_DISPLAY
,
165 SKIN_TOKEN_IMAGE_DISPLAY_LISTICON
,
166 SKIN_TOKEN_IMAGE_DISPLAY_9SEGMENT
,
169 SKIN_TOKEN_ALBUMART_LOAD
,
170 SKIN_TOKEN_ALBUMART_DISPLAY
,
171 SKIN_TOKEN_ALBUMART_FOUND
,
174 SKIN_TOKEN_METADATA_ARTIST
,
175 SKIN_TOKEN_METADATA_COMPOSER
,
176 SKIN_TOKEN_METADATA_ALBUM_ARTIST
,
177 SKIN_TOKEN_METADATA_GROUPING
,
178 SKIN_TOKEN_METADATA_ALBUM
,
179 SKIN_TOKEN_METADATA_GENRE
,
180 SKIN_TOKEN_METADATA_DISC_NUMBER
,
181 SKIN_TOKEN_METADATA_TRACK_NUMBER
,
182 SKIN_TOKEN_METADATA_TRACK_TITLE
,
183 SKIN_TOKEN_METADATA_VERSION
,
184 SKIN_TOKEN_METADATA_YEAR
,
185 SKIN_TOKEN_METADATA_COMMENT
,
188 SKIN_TOKEN_REPEAT_MODE
,
189 SKIN_TOKEN_PLAYBACK_STATUS
,
191 SKIN_TOKEN_PROGRESSBAR
,
192 SKIN_TOKEN_PLAYER_PROGRESSBAR
,
194 SKIN_TOKEN_PEAKMETER
,
195 SKIN_TOKEN_PEAKMETER_LEFT
,
196 SKIN_TOKEN_PEAKMETER_LEFTBAR
,
197 SKIN_TOKEN_PEAKMETER_RIGHT
,
198 SKIN_TOKEN_PEAKMETER_RIGHTBAR
,
201 SKIN_TOKEN_TRACK_ELAPSED_PERCENT
,
202 SKIN_TOKEN_TRACK_TIME_ELAPSED
,
203 SKIN_TOKEN_TRACK_TIME_REMAINING
,
204 SKIN_TOKEN_TRACK_LENGTH
,
205 SKIN_TOKEN_TRACK_STARTING
,
206 SKIN_TOKEN_TRACK_ENDING
,
209 SKIN_TOKEN_PLAYLIST_ENTRIES
,
210 SKIN_TOKEN_PLAYLIST_NAME
,
211 SKIN_TOKEN_PLAYLIST_POSITION
,
212 SKIN_TOKEN_PLAYLIST_SHUFFLE
,
215 SKIN_TOKEN_ENABLE_THEME
,
216 SKIN_TOKEN_DISABLE_THEME
,
217 SKIN_TOKEN_DRAW_INBUILTBAR
,
218 SKIN_TOKEN_LIST_TITLE_TEXT
,
219 SKIN_TOKEN_LIST_TITLE_ICON
,
220 SKIN_TOKEN_LIST_ITEM_CFG
,
221 SKIN_TOKEN_LIST_SELECTED_ITEM_CFG
,
222 SKIN_TOKEN_LIST_ITEM_IS_SELECTED
,
223 SKIN_TOKEN_LIST_ITEM_TEXT
,
224 SKIN_TOKEN_LIST_ITEM_ROW
,
225 SKIN_TOKEN_LIST_ITEM_COLUMN
,
226 SKIN_TOKEN_LIST_ITEM_NUMBER
,
227 SKIN_TOKEN_LIST_ITEM_ICON
,
228 SKIN_TOKEN_LIST_NEEDS_SCROLLBAR
,
229 SKIN_TOKEN_LIST_SCROLLBAR
,
231 SKIN_TOKEN_LOAD_FONT
,
234 SKIN_TOKEN_BUTTON_VOLUME
,
235 SKIN_TOKEN_LASTTOUCH
,
236 SKIN_TOKEN_TOUCHREGION
,
237 SKIN_TOKEN_HAVE_TOUCH
,
243 SKIN_TOKEN_VOLUMEBAR
,
245 SKIN_TOKEN_MAIN_HOLD
,
246 SKIN_TOKEN_REMOTE_HOLD
,
250 SKIN_TOKEN_SETTINGBAR
,
251 SKIN_TOKEN_CURRENT_SCREEN
,
252 SKIN_TOKEN_LANG_IS_RTL
,
254 /* Recording Tokens */
255 SKIN_TOKEN_HAVE_RECORDING
,
256 SKIN_TOKEN_IS_RECORDING
,
258 SKIN_TOKEN_REC_ENCODER
,
259 SKIN_TOKEN_REC_BITRATE
, /* SWCODEC: MP3 bitrate, HWCODEC: MP3 "quality" */
261 SKIN_TOKEN_REC_SECONDS
,
262 SKIN_TOKEN_REC_MINUTES
,
263 SKIN_TOKEN_REC_HOURS
,
267 SKIN_TOKEN_HAVE_TUNER
,
268 SKIN_TOKEN_TUNER_TUNED
,
269 SKIN_TOKEN_TUNER_SCANMODE
,
270 SKIN_TOKEN_TUNER_STEREO
,
271 SKIN_TOKEN_TUNER_MINFREQ
, /* changes based on "region" */
272 SKIN_TOKEN_TUNER_MAXFREQ
, /* changes based on "region" */
273 SKIN_TOKEN_TUNER_CURFREQ
,
274 SKIN_TOKEN_TUNER_RSSI
,
275 SKIN_TOKEN_TUNER_RSSI_MIN
,
276 SKIN_TOKEN_TUNER_RSSI_MAX
,
277 SKIN_TOKEN_TUNER_RSSI_BAR
,
278 SKIN_TOKEN_PRESET_ID
, /* "id" of this preset.. really the array element number */
279 SKIN_TOKEN_PRESET_NAME
,
280 SKIN_TOKEN_PRESET_FREQ
,
281 SKIN_TOKEN_PRESET_COUNT
,
289 SKIN_TOKEN_VAR_GETVAL
,
290 SKIN_TOKEN_VAR_TIMEOUT
,
292 SKIN_TOKEN_SUBSTRING
,
294 SKIN_TOKEN_DRAWRECTANGLE
,
298 * Struct for tag parsing information
299 * name - The name of the tag, i.e. V for %V
300 * params - A string specifying all of the tags parameters, each
301 * character representing a single parameter. Valid
302 * characters for parameters are:
303 * I - Required integer
304 * i - Nullable integer
305 * D - Required decimal
306 * d - Nullable decimal
307 * Decimals are stored as (whole*10)+part
308 * P - Required percentage
309 * p - Nullable percentage
310 * Percentages pestored as permilles (percent*10 + part)
311 * S - Required string
312 * s - Nullable string
313 * F - Required file name
314 * f - Nullable file name
315 * C - Required skin code
316 * T - Required single skin tag
317 * * - Any amonut of the previous tag (or group if after a []
318 * \n - causes the parser to eat everything up to and including the \n
319 * MUST be the last character of the prams string
320 * Any nullable parameter may be replaced in the WPS file
321 * with a '-'. To specify that parameters may be left off
322 * altogether, place a '|' in the parameter string. For
323 * instance, with the parameter string...
325 * one integer must be specified, one integer can be
326 * specified or set to default with '-', and the user can
327 * stop providing parameters at any time after that.
328 * To specify multiple instances of the same type, put a
329 * number before the character. For instance, the string...
331 * will specify two strings. A ? at the beginning of the
332 * string will specify that you may choose to omit all arguments
334 * You may also group param types in [] which will tell the parser to
335 * accept any *one* of those types for that param. i.e [IT] will
336 * accept either an integer or tag type. [ITs] will also accept a string or -
341 enum skin_token_type type
;
348 * Finds a tag by name and returns its parameter list, or an empty
349 * string if the tag is not found in the table
351 const struct tag_info
* find_tag(const char* name
);
354 * Determines whether a character is legal to escape or not. If
355 * lookup is not found in the legal escape characters string, returns
356 * false, otherwise returns true
358 int find_escape_character(char lookup
);
364 #endif /* TAG_TABLE_H */