apps/gui/skin_engine/skin_tokens.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id: wps_internals.h 22223 2009-08-09 17:30:05Z jdgordon $
   9  *
  10  * Copyright (C) 2007 Nicolas Pennequin
  11  *
  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.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #ifndef _SKIN_TOKENS_H_
  23 #define _SKIN_TOKENS_H_
  24
  25 #include <stdbool.h>
  26
  27
  28 enum wps_token_type {
  29     WPS_NO_TOKEN,   /* for WPS tags we don't want to save as tokens */
  30     WPS_TOKEN_UNKNOWN,
  31
  32     /* Markers */
  33     WPS_TOKEN_CHARACTER,
  34     WPS_TOKEN_STRING,
  35     WPS_TOKEN_TRANSLATEDSTRING,
  36
  37     /* Alignment */
  38     WPS_TOKEN_ALIGN_LEFT,
  39     WPS_TOKEN_ALIGN_CENTER,
  40     WPS_TOKEN_ALIGN_RIGHT,
  41
  42     /* Sublines */
  43     WPS_TOKEN_SUBLINE_TIMEOUT,
  44
  45     /* Battery */
  46     WPS_TOKEN_BATTERY_PERCENT,
  47     WPS_TOKEN_BATTERY_VOLTS,
  48     WPS_TOKEN_BATTERY_TIME,
  49     WPS_TOKEN_BATTERY_CHARGER_CONNECTED,
  50     WPS_TOKEN_BATTERY_CHARGING,
  51     WPS_TOKEN_BATTERY_SLEEPTIME,
  52
  53     /* Sound */
  54 #if (CONFIG_CODEC != MAS3507D)
  55     WPS_TOKEN_SOUND_PITCH,
  56 #endif
  57 #if (CONFIG_CODEC == SWCODEC)
  58     WPS_TOKEN_REPLAYGAIN,
  59     WPS_TOKEN_CROSSFADE,
  60 #endif
  61
  62     /* Time */
  63
  64     WPS_TOKEN_RTC_PRESENT,
  65
  66     /* The begin/end values allow us to know if a token is an RTC one.
  67        New RTC tokens should be added between the markers. */
  68
  69     WPS_TOKENS_RTC_BEGIN, /* just the start marker, not an actual token */
  70
  71     WPS_TOKEN_RTC_DAY_OF_MONTH,
  72     WPS_TOKEN_RTC_DAY_OF_MONTH_BLANK_PADDED,
  73     WPS_TOKEN_RTC_12HOUR_CFG,
  74     WPS_TOKEN_RTC_HOUR_24_ZERO_PADDED,
  75     WPS_TOKEN_RTC_HOUR_24,
  76     WPS_TOKEN_RTC_HOUR_12_ZERO_PADDED,
  77     WPS_TOKEN_RTC_HOUR_12,
  78     WPS_TOKEN_RTC_MONTH,
  79     WPS_TOKEN_RTC_MINUTE,
  80     WPS_TOKEN_RTC_SECOND,
  81     WPS_TOKEN_RTC_YEAR_2_DIGITS,
  82     WPS_TOKEN_RTC_YEAR_4_DIGITS,
  83     WPS_TOKEN_RTC_AM_PM_UPPER,
  84     WPS_TOKEN_RTC_AM_PM_LOWER,
  85     WPS_TOKEN_RTC_WEEKDAY_NAME,
  86     WPS_TOKEN_RTC_MONTH_NAME,
  87     WPS_TOKEN_RTC_DAY_OF_WEEK_START_MON,
  88     WPS_TOKEN_RTC_DAY_OF_WEEK_START_SUN,
  89
  90     WPS_TOKENS_RTC_END,     /* just the end marker, not an actual token */
  91
  92     /* Conditional */
  93     WPS_TOKEN_CONDITIONAL,
  94     WPS_TOKEN_CONDITIONAL_START,
  95     WPS_TOKEN_CONDITIONAL_OPTION,
  96     WPS_TOKEN_CONDITIONAL_END,
  97
  98     /* Database */
  99 #ifdef HAVE_TAGCACHE
 100     WPS_TOKEN_DATABASE_PLAYCOUNT,
 101     WPS_TOKEN_DATABASE_RATING,
 102     WPS_TOKEN_DATABASE_AUTOSCORE,
 103 #endif
 104
 105     /* File */
 106     WPS_TOKEN_FILE_BITRATE,
 107     WPS_TOKEN_FILE_CODEC,
 108     WPS_TOKEN_FILE_FREQUENCY,
 109     WPS_TOKEN_FILE_FREQUENCY_KHZ,
 110     WPS_TOKEN_FILE_NAME,
 111     WPS_TOKEN_FILE_NAME_WITH_EXTENSION,
 112     WPS_TOKEN_FILE_PATH,
 113     WPS_TOKEN_FILE_SIZE,
 114     WPS_TOKEN_FILE_VBR,
 115     WPS_TOKEN_FILE_DIRECTORY,
 116
 117 #ifdef HAVE_LCD_BITMAP
 118     /* Image */
 119     WPS_TOKEN_IMAGE_BACKDROP,
 120     WPS_TOKEN_IMAGE_PROGRESS_BAR,
 121     WPS_TOKEN_IMAGE_PRELOAD,
 122     WPS_TOKEN_IMAGE_PRELOAD_DISPLAY,
 123     WPS_TOKEN_IMAGE_DISPLAY,
 124 #endif
 125
 126 #ifdef HAVE_ALBUMART
 127     /* Albumart */
 128     WPS_TOKEN_ALBUMART_DISPLAY,
 129     WPS_TOKEN_ALBUMART_FOUND,
 130 #endif
 131
 132     /* Metadata */
 133     WPS_TOKEN_METADATA_ARTIST,
 134     WPS_TOKEN_METADATA_COMPOSER,
 135     WPS_TOKEN_METADATA_ALBUM_ARTIST,
 136     WPS_TOKEN_METADATA_GROUPING,
 137     WPS_TOKEN_METADATA_ALBUM,
 138     WPS_TOKEN_METADATA_GENRE,
 139     WPS_TOKEN_METADATA_DISC_NUMBER,
 140     WPS_TOKEN_METADATA_TRACK_NUMBER,
 141     WPS_TOKEN_METADATA_TRACK_TITLE,
 142     WPS_TOKEN_METADATA_VERSION,
 143     WPS_TOKEN_METADATA_YEAR,
 144     WPS_TOKEN_METADATA_COMMENT,
 145
 146     /* Mode */
 147     WPS_TOKEN_REPEAT_MODE,
 148     WPS_TOKEN_PLAYBACK_STATUS,
 149
 150     WPS_TOKEN_MAIN_HOLD,
 151
 152 #ifdef HAS_REMOTE_BUTTON_HOLD
 153     WPS_TOKEN_REMOTE_HOLD,
 154 #endif
 155
 156     /* Progressbar */
 157     WPS_TOKEN_PROGRESSBAR,
 158 #ifdef HAVE_LCD_CHARCELLS
 159     WPS_TOKEN_PLAYER_PROGRESSBAR,
 160 #endif
 161
 162 #ifdef HAVE_LCD_BITMAP
 163     /* Peakmeter */
 164     WPS_TOKEN_PEAKMETER,
 165 #endif
 166
 167     /* Volume level */
 168     WPS_TOKEN_VOLUME,
 169
 170     /* Current track */
 171     WPS_TOKEN_TRACK_ELAPSED_PERCENT,
 172     WPS_TOKEN_TRACK_TIME_ELAPSED,
 173     WPS_TOKEN_TRACK_TIME_REMAINING,
 174     WPS_TOKEN_TRACK_LENGTH,
 175
 176     /* Playlist */
 177     WPS_TOKEN_PLAYLIST_ENTRIES,
 178     WPS_TOKEN_PLAYLIST_NAME,
 179     WPS_TOKEN_PLAYLIST_POSITION,
 180     WPS_TOKEN_PLAYLIST_SHUFFLE,
 181 #if (CONFIG_LED == LED_VIRTUAL) || defined(HAVE_REMOTE_LCD)
 182     /* Virtual LED */
 183     WPS_TOKEN_VLED_HDD,
 184 #endif
 185
 186     /* Viewport display */
 187     WPS_VIEWPORT_ENABLE,
 188
 189     /* buttons */
 190     WPS_TOKEN_BUTTON_VOLUME,
 191     WPS_TOKEN_LASTTOUCH,
 192
 193     /* Setting option */
 194     WPS_TOKEN_SETTING,
 195     WPS_TOKEN_CURRENT_SCREEN,
 196 };
 197
 198 struct wps_token {
 199     unsigned char type; /* enough to store the token type */
 200
 201     /* Whether the tag (e.g. track name or the album) refers the
 202        current or the next song (false=current, true=next) */
 203     bool next;
 204
 205     union {
 206         char c;
 207         unsigned short i;
 208                 void* data;
 209     } value;
 210 };
 211
 212 struct skin_token_list {
 213     struct wps_token *token;
 214     struct skin_token_list *next;
 215 };
 216
 217
 218 #endif
 219