summaryrefslogtreecommitdiff
path: root/docs/CUSTOM_WPS_FORMAT
diff options
context:
space:
mode:
authorJonathan Gordon <rockbox@jdgordon.info>2010-03-05 20:08:16 +0000
committerJonathan Gordon <rockbox@jdgordon.info>2010-03-05 20:08:16 +0000
commit87ce387f336cf2c57c369bab7b0ee9597da2607a (patch)
tree68b33a1dd660a069f041a977a21ae3e4587a633f /docs/CUSTOM_WPS_FORMAT
parent9c78531aec2259b99bfd930cb58e3d68be421479 (diff)
downloadrockbox-87ce387f336cf2c57c369bab7b0ee9597da2607a.tar.gz
rockbox-87ce387f336cf2c57c369bab7b0ee9597da2607a.zip
remove 2 really old files. CustomWPS in the wiki replaces CUSTOM_WPS_FORMAT, and the manual has both lists also
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25034 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'docs/CUSTOM_WPS_FORMAT')
-rw-r--r--docs/CUSTOM_WPS_FORMAT209
1 files changed, 0 insertions, 209 deletions
diff --git a/docs/CUSTOM_WPS_FORMAT b/docs/CUSTOM_WPS_FORMAT
deleted file mode 100644
index cf327c54a1..0000000000
--- a/docs/CUSTOM_WPS_FORMAT
+++ /dev/null
@@ -1,209 +0,0 @@
1Custom WPS Display
2File Format Specifications
3
4Description / General Info
5--------------------------
6* The Custom WPS Display is used on both the Rockbox Player and Recorder,
7 as a means to customize the WPS to the user's likings.
8* After editing the .wps file, "play" it to make it take effect.
9* The file may be 2 lines long for the Player, and 10 lines for the Recorder.
10* All characters not preceded by % are displayed as typed.
11* A line beginning with # is a comment
12
13File Location
14-------------
15Custom WPS files may be located anywhere on the drive. The only restriction is
16that they must end in .wps. When you PLAY a .wps file, it'll be used for the
17future WPS screens. If the "played" wps file is located in the /.rockbox
18folder, it'll be remembered and used for subsequent restarts. Filenames in the
19/.rockbox folder must be no more than 24 characters long.
20
21Tags
22----
23ID3 Info Tags:
24 %ia : ID3 Artist
25 %ic : ID3 Composer
26 %id : ID3 Album Name
27 %ig : ID3 Genre Name
28 %in : ID3 Track Number
29 %it : ID3 Track Title
30 %iv : ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag)
31 %iy : ID3 Year
32
33
34Battery Info:
35 %bl : Show numeric battery level in percent
36 %bt : Show estimated battery time left
37
38File Info Tags:
39 %fb : File Bitrate (in kbps)
40 %ff : File Frequency (in Hz)
41 %fm : File Name
42 %fn : File Name (without extension)
43 %fp : File Path
44 %fs : File Size (In Kilobytes)
45 %fv : "(vbr)" if variable bit rate or "" if constant bit rate
46 %d1 : First directory from end of file path.
47 %d2 : Second directory from end of file path.
48 %d3 : Third directory from end of file path.
49
50Example for the the %dN commands: If the path is "/Rock/Kent/Isola/11 -
51747.mp3", %d1 is "Isola", %d2 is "Kent"... You get the picture.
52
53Playlist/Song Info Tags:
54 %pb : Progress Bar
55 Player: This will display a 1 character "cup" that empties as the
56 progresses.
57 Recorder: This will replace the entire line with a progress bar.
58 %pf : Player: Full-line progress bar + time display
59 %pc : Current Time In Song
60 %pe : Total Number of Playlist Entries
61 %pm : Peak Meter (Recorder only)
62 The entire line is used as volume peak meter.
63 %pn : Playlist Name (Without path or extension)
64 %pp : Playlist Position
65 %pr : Remaining Time In Song
66 %ps : Shuffle. Shows 's' if shuffle mode is enabled.
67 %pt : Total Track Time
68 %pv : Current volume
69
70Database tags:
71 %rp : Playcount
72 %rr : Rating
73 %ra : Auto score
74
75Repeat mode tags:
76 %mf : repeat off, returns f
77 %ma : repeat all, returns a
78 %mo : repeat one, returns o
79 %ms : repeat shuffle, returns s
80
81Playback mode tags:
82 %mp : play, returns p
83 %mu : pause, returns u
84 %mw : fastforward, returns w
85 %mb : fastbackward, returns b
86
87Conditional Tags (If/Else block):
88 %?xx<|> : Conditional: if the tag specified by "xx" has a value, the
89 text between the "<" and the "|" is displayed, else the text
90 between the "|" and the ">" is displayed.
91 The else part is optional, so the "|" does not have to be
92 specified if no else part is desired. The conditionals nest,
93 so the text in the if and else part can contain all %
94 commands, including conditionals.
95
96Alignment Tags:
97 %al : Text is left aligned
98 %ac : Text is center aligned
99 %ar : Text is right aligned
100
101All alignment tags may be present in on line, but the need to be in the order
102left - center - right. If the aligned texts overlap, they are merged.
103
104Next Song Info
105--------------
106You can display information about the next song - the song that is about to
107play after the one currently playing (unless you change the plan).
108
109If you use the uppercase versions of the three tags: F, I and D, they will
110instead refer to the next song instead of the current one. Example: %Ig is
111the genre name used in the next song and %Ff is the mp3 frequency.
112
113Take note that the next song information WILL NOT be available at all times,
114but will most likely be available at the end of a song. We suggest you use the
115conditional display tag a lot when displaying information about the next song!
116
117Alternating Sublines
118--------------------
119It is possible to group items on each line into 2 or more groups or "sublines".
120Each subline will be displayed in succession on the line for a specified time,
121alternating continuously through each defined subline.
122
123Items on a line are broken into sublines with the semicolon ';' character. The
124display time for each subline defaults to 2 seconds unless modified by using
125the '%t' tag to specify an alternate time (in seconds and optional tenths of a
126second) for the subline to be displayed.
127
128Subline related special characters and tags:
129 ; : Split items on a line into separate sublines
130 %t : Set the subline display time. The '%t' is followed by either integer
131 seconds (%t5), or seconds and tenths of a second (%t3.5).
132
133
134Each alternating subline can still be optionally scrolled while it is being
135displayed, and scrollable formats can be displayed on the same line with
136non-scrollable formats (such as track elapsed time) as long as they are
137separated into different sublines.
138
139 Example subline definition:
140
141 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds,
142 Display id3 title for 2 seconds,
143 Display current and remaining track time
144 for 3 seconds,
145 repeat...
146
147Conditionals can be used with sublines to display a different set and/or number
148of sublines on the line depending on the evaluation of the conditional.
149
150 Example subline with conditionals:
151
152 %?it<%t8%s%it|%s%fn>;%?ia<%t3%s%ia|%t0>
153
154 The format above will do two different things depending if ID3
155 tags are present. If the ID3 artist and title are present :
156
157 Display id3 title for 8 seconds,
158 Display id3 artist for 3 seconds,
159 repeat...
160
161 If the ID3 artist and title are not present :
162 Display the filename continuously.
163
164Note that by using a subline display time of 0 in one branch of a conditional,
165a subline can be skipped (not displayed) when that condition is met.
166
167-----------
168
169Other Tags:
170 %% : Display a '%'
171 %< : Display a '<'
172 %| : Display a '|'
173 %> : Display a '>'
174 %; : Display a ';'
175 %s : Indicate that the line should scroll. Can occur anywhere in
176 a line (given that the text is displayed; see conditionals
177 above). You can specify up to 10 scrolling lines.
178 Scrolling lines can not contain dynamic content such as timers,
179 peak meters or progress bars.
180
181Example File
182------------
183%s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]>
184%pb%pc/%pt
185
186That is, "tracknum - title [artist, album]", where most fields are only
187displayed if available. Could also be rendered as "filename" or
188"tracknum - title [artist]".
189
190Default
191-------
192If you haven't selected a .wps file in the .rockbox directory, you get the
193hardcoded wps layout. The default WPS screen is for player:
194
195# Default WPS for Player
196%s%pp/%pe: %?it<%it|%fn> - %?ia<%ia|%d2> - %?id<%id|%d1>
197%pc%?ps<*|/>%pt
198
199and for recorder:
200
201# Default WPS for Recorder
202%s%?it<%?in<%in. |>%it|%fn>
203%s%?ia<%ia|%?d2<%d2|(root)>>
204%s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|>
205
206%pc/%pt [%pp:%pe]
207%fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>
208%pb
209%pm