Gitiles
Code Review Sign In
gerrit.rockbox.org / rockbox / bb572c44121e48d9d54411dff9e0f8dce015e550 / . / docs / CUSTOM_WPS_FORMAT
blob: cecb4af169bb09705311d221a7c1e6248cd75927 [file] [log] [blame]
Justin Heiner43e7cb82002-08-22 02:26:08 +0000[diff] [blame]1Custom WPS Display
Justin Heiner52681472002-09-05 16:52:47 +0000[diff] [blame]2File Format Specifications
Justin Heiner43e7cb82002-08-22 02:26:08 +0000[diff] [blame]3
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]4Description / General Info
5--------------------------
Justin Heiner7189bf22002-08-29 05:58:23 +0000[diff] [blame]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.
Björn Stenberg3e92ef42002-09-06 23:25:24 +0000[diff] [blame]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.
Justin Heiner7189bf22002-08-29 05:58:23 +0000[diff] [blame]10* The line that has the time displayed on it MUST NOT be the line that
11 is scrolled, or the time will not be updated.
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]12* All characters not preceded by % are displayed as typed.
13
Justin Heiner43e7cb82002-08-22 02:26:08 +0000[diff] [blame]14File Location
15-------------
Justin Heiner52681472002-09-05 16:52:47 +0000[diff] [blame]16The default configuration file must be located in the /.rockbox folder
17of the evice and must be named default.wps (lowercase). Any other Custom
18WPS files may be located anywhere on the drive. The only restriction
19is that they must end in .wps
Justin Heiner43e7cb82002-08-22 02:26:08 +0000[diff] [blame]20
21Tags
22----
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]23ID3 Info Tags:
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]24 %ia : ID3 Artist
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]25 %it : ID3 Track Title
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]26 %in : ID3 Track Number
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]27 %id : ID3 Album Name
28
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]29File Info Tags:
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]30 %fb : File Bitrate (in kbps)
31 %ff : File Frequency (in Hz)
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]32 %fp : File Path
Mats Lidell09ae8cb2002-09-01 21:13:07 +0000[diff] [blame]33 %fn : File Name (without extension)
34 %fm : File Name
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]35 %fs : File Size (In Kilobytes)
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]36 %fv : "(vbr)" if variable bit rate or "" if constant bit rate
37 %d1 : First directory from end of file path.
38 %d2 : Second directory from end of file path.
Björn Stenbergef413702002-09-06 23:57:09 +0000[diff] [blame]39 %d3 : Third directory from end of file path.
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]40
41Example for the the %dN commands: If the path is "/Rock/Kent/Isola/11 -
42747.mp3", %d1 is "Isola", %d2 is "Kent"... You get the picture.
43
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]44Playlist/Song Info Tags:
Björn Stenberg3e92ef42002-09-06 23:25:24 +0000[diff] [blame]45 %pb : Progress Bar
46 Player: This will display a 1 character "cup" that empties as the
47 progresses.
48 Recorder: This will replace the entire line with a progress bar.
Linus Nielsen Feltzingbb572c42002-09-27 09:31:31 +0000[diff] [blame^]49 %pm : Peak Meter (Recorder only)
50 The entire line is used as volume peak meter.
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]51 %pp : Playlist Position
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]52 %pe : Total Number of Playlist Entries
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]53 %pc : Current Time In Song
Justin Heiner87f53242002-08-30 03:08:02 +0000[diff] [blame]54 %pr : Remaining Time In Song
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]55 %pt : Total Track Time
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]56
57Conditional Tags (If/Else block):
58 %?xx<|> : Conditional: if the tag specified by "xx" has a value, the
59 text between the "<" and the "|" is displayed, else the text
60 between the "|" and the ">" is displayed.
61 The else part is optional, so the "|" does not have to be
62 specified if no else part is desired. The conditionals nest,
63 so the text in the if and else part can contain all %
64 commands, including conditionals.
65
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]66Other Tags:
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]67 %% : Display a '%'
68 %< : Display a '<'
69 %| : Display a '|'
70 %> : Display a '>'
71 %s : Indicate that the line should scroll. Can occur anywhere in
72 a line (given that the text is displayed; see conditional
73 below). Only the first line with a %s will actually scroll.
74 %s is ignored if combined with %pb, %pc or %pr on the same
75 line (the result wouldn't be good anyway).
Justin Heiner43e7cb82002-08-22 02:26:08 +0000[diff] [blame]76
Justin Heinereb94e0b2002-09-06 06:14:52 +0000[diff] [blame]77Example File
78------------
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]79%s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]>
80%pb%pc/%pt
Justin Heinera7a46c72002-08-27 01:05:19 +0000[diff] [blame]81
Björn Stenberg862813d2002-09-01 20:00:05 +0000[diff] [blame]82That is, "tracknum - title [artist, album]", where most fields are only
83displayed if available. Could also be rendered as "filename" or
84"tracknum - title [artist]".
Björn Stenberg2042c502002-09-23 05:19:11 +0000[diff] [blame]85
86Default
87-------
88If you don't use a default.wps file, you get the hardcoded wps layout.
89The default WPS screen is for player:
90
91%s%pp/%pe: %?ia<%ia - >%?it<%it|%fm>
92%pc/%pt
93
94and for recorder:
95
96%s%fp
97%it
98%id
99%ia
100%fb kbit %fv
101Time: %pc / %pt
102%pb