diff options
author | Björn Stenberg <bjorn@haxx.se> | 2002-09-01 20:00:05 +0000 |
---|---|---|
committer | Björn Stenberg <bjorn@haxx.se> | 2002-09-01 20:00:05 +0000 |
commit | 862813d37b74b7afb5437a8f5368493cdec2cb3b (patch) | |
tree | e6d4e0acf0324d07962f2dc1e538e765642d2075 /docs | |
parent | 26964fd95760ed0a5c9db94f9ba60a843a094c36 (diff) | |
download | rockbox-862813d37b74b7afb5437a8f5368493cdec2cb3b.tar.gz rockbox-862813d37b74b7afb5437a8f5368493cdec2cb3b.zip |
Updated with new tags
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@2112 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'docs')
-rw-r--r-- | docs/CUSTOM_WPS_FORMAT | 101 |
1 files changed, 41 insertions, 60 deletions
diff --git a/docs/CUSTOM_WPS_FORMAT b/docs/CUSTOM_WPS_FORMAT index 551b13e077..329a1c082a 100644 --- a/docs/CUSTOM_WPS_FORMAT +++ b/docs/CUSTOM_WPS_FORMAT | |||
@@ -1,7 +1,6 @@ | |||
1 | Custom WPS Display | 1 | Custom WPS Display |
2 | wps.config File Format Specifications | 2 | wps.config File Format Specifications |
3 | 3 | ||
4 | |||
5 | Description / General Info | 4 | Description / General Info |
6 | -------------------------- | 5 | -------------------------- |
7 | * The Custom WPS Display is used on both the Rockbox Player and Recorder, | 6 | * The Custom WPS Display is used on both the Rockbox Player and Recorder, |
@@ -10,89 +9,71 @@ Description / General Info | |||
10 | * The file may be 2 lines long for the Player, and 6 lines for the Recorder. | 9 | * The file may be 2 lines long for the Player, and 6 lines for the Recorder. |
11 | * The line that has the time displayed on it MUST NOT be the line that | 10 | * The line that has the time displayed on it MUST NOT be the line that |
12 | is scrolled, or the time will not be updated. | 11 | is scrolled, or the time will not be updated. |
13 | * All tags except for %%, %?, and %: contain 3 characters (%xx). Remember | ||
14 | to type the tags correctly, or you will get unexpected output, or even | ||
15 | possibly no output at all. | ||
16 | * All characters not preceded by % are displayed as typed. | 12 | * All characters not preceded by % are displayed as typed. |
17 | 13 | ||
18 | |||
19 | File Location | 14 | File Location |
20 | ------------- | 15 | ------------- |
21 | The configuration file must be located in the root folder of the | 16 | The configuration file must be located in the /.rockbox folder of the |
22 | device and must be named wps.config (lowercase) | 17 | device and must be named wps.config (lowercase) |
23 | 18 | ||
24 | |||
25 | Tags | 19 | Tags |
26 | ---- | 20 | ---- |
27 | ID3 Info Tags: | 21 | ID3 Info Tags: |
28 | %it : ID3 Title | ||
29 | %ia : ID3 Artist | 22 | %ia : ID3 Artist |
23 | %it : ID3 Track Title | ||
30 | %in : ID3 Track Number | 24 | %in : ID3 Track Number |
31 | %id : ID3 Album | 25 | %id : ID3 Album Name |
26 | |||
32 | File Info Tags: | 27 | File Info Tags: |
33 | %fc : Conditional Title/Filename | 28 | %fb : File Bitrate (in kbps) |
34 | Displays "Artist - Title" *or* | 29 | %ff : File Frequency (in Hz) |
35 | Displays Filename if no ID3 Artist/Title | ||
36 | %fd : Conditional Title/Filename | ||
37 | Displays "Title - Artist" *or* | ||
38 | Displays Filename if no ID3 Artist/Title | ||
39 | %fb : File Bitrate | ||
40 | %ff : File Frequency | ||
41 | %fp : File Path | 30 | %fp : File Path |
42 | %fn : File Name | 31 | %fn : File Name |
32 | %fm : File Name (without extension) | ||
43 | %fs : File Size (In Kilobytes) | 33 | %fs : File Size (In Kilobytes) |
34 | %fv : "(vbr)" if variable bit rate or "" if constant bit rate | ||
35 | %d1 : First directory from end of file path. | ||
36 | %d2 : Second directory from end of file path. | ||
37 | %d2 : Third directory from end of file path. | ||
38 | |||
39 | Example for the the %dN commands: If the path is "/Rock/Kent/Isola/11 - | ||
40 | 747.mp3", %d1 is "Isola", %d2 is "Kent"... You get the picture. | ||
41 | |||
44 | Playlist/Song Info Tags: | 42 | Playlist/Song Info Tags: |
45 | %pb : Progress Bar (Player ONLY) | 43 | %pb : Progress Bar (Player ONLY) |
46 | This will display a 1 character "cup" that empties as the song goes | 44 | This will display a 1 character "cup" that empties as the song goes |
47 | forward. | 45 | forward. |
48 | %pp : Playlist Position | 46 | %pp : Playlist Position |
49 | %pe : Playlist Total Entries | 47 | %pe : Total Number of Playlist Entries |
50 | %pc : Current Time In Song | 48 | %pc : Current Time In Song |
51 | %pr : Remaining Time In Song | 49 | %pr : Remaining Time In Song |
52 | %pt : Total Track Time | 50 | %pt : Total Track Time |
53 | Other Tags: | ||
54 | %% : Displays a % | ||
55 | %s : Define the line to scroll | ||
56 | This MUST be the first tag in the line you want to scroll. It can | ||
57 | ONLY be used for one line. Currently, this feature only works in | ||
58 | the PLAYER. | ||
59 | Conditional ID3/File Tags (If/Else block): | ||
60 | The following two tags are completely optional, and meant only for those | ||
61 | that wish to go crazy with customization. It lets you specify what to | ||
62 | do when it finds an ID3 tag, and also when it doesn't find one. It can | ||
63 | be placed anywhere within the wps.config file. | ||
64 | The first condition of the If/Else block is what to do when it DOES find | ||
65 | valid ID3 tags. The second condition is what to do when there are no | ||
66 | valid ID3 tags available. | ||
67 | %? : Start/End an If/Else block | ||
68 | %: : Seperator between If and Else | ||
69 | Example: | ||
70 | To display "Title - Artist" if there is ID3 available, or "Filename" | ||
71 | if there is no ID3, the following string would be used: | ||
72 | %?%it - %ia%:%fn%? | ||
73 | Yes, you are not going crazy (although I may be)... This *IS* more | ||
74 | confusing then Perl :-) | ||
75 | 51 | ||
52 | Conditional Tags (If/Else block): | ||
53 | %?xx<|> : Conditional: if the tag specified by "xx" has a value, the | ||
54 | text between the "<" and the "|" is displayed, else the text | ||
55 | between the "|" and the ">" is displayed. | ||
56 | The else part is optional, so the "|" does not have to be | ||
57 | specified if no else part is desired. The conditionals nest, | ||
58 | so the text in the if and else part can contain all % | ||
59 | commands, including conditionals. | ||
76 | 60 | ||
77 | Example wps.config File (Without If/Else) | 61 | Other Tags: |
78 | ----------------------- | 62 | %% : Display a '%' |
79 | %s%pp/%pe: %fc * %fsKB | 63 | %< : Display a '<' |
80 | %pc/%pt | 64 | %| : Display a '|' |
65 | %> : Display a '>' | ||
66 | %s : Indicate that the line should scroll. Can occur anywhere in | ||
67 | a line (given that the text is displayed; see conditional | ||
68 | below). Only the first line with a %s will actually scroll. | ||
69 | %s is ignored if combined with %pb, %pc or %pr on the same | ||
70 | line (the result wouldn't be good anyway). | ||
81 | 71 | ||
72 | Example wps.config | ||
73 | ------------------ | ||
74 | %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]> | ||
75 | %pb%pc/%pt | ||
82 | 76 | ||
83 | Example Output | 77 | That is, "tracknum - title [artist, album]", where most fields are only |
84 | -------------- | 78 | displayed if available. Could also be rendered as "filename" or |
85 | ID3 Title: None | 79 | "tracknum - title [artist]". |
86 | ID3 Artist: None | ||
87 | Playlist Position: 5 | ||
88 | Playlist Total Entries: 10 | ||
89 | Filename: My Song.mp3 | ||
90 | File Size: 3500 | ||
91 | Elapsed Track Time: 2:23 | ||
92 | Total Track Time: 3:01 | ||
93 | The output of this on the player would be: | ||
94 | --------------------------- | ||
95 | | 5/10: My Song.mp3 * 3500KB| | ||
96 | | 2:23/3:01 | | ||
97 | --------------------------- | ||
98 | Of course, the whole first line wouldn't fit, so it scrolls it. | ||