diff options
Diffstat (limited to 'manual/plugins/lrcplayer.tex')
-rw-r--r-- | manual/plugins/lrcplayer.tex | 129 |
1 files changed, 60 insertions, 69 deletions
diff --git a/manual/plugins/lrcplayer.tex b/manual/plugins/lrcplayer.tex index 7a5be3ece9..604fe8251c 100644 --- a/manual/plugins/lrcplayer.tex +++ b/manual/plugins/lrcplayer.tex | |||
@@ -1,73 +1,66 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \subsection{Lrcplayer} | 2 | \subsection{Lrcplayer} |
3 | % \screenshot{plugins/images/ss-lrcplayer}{Lrcplayer}{} | 3 | % \screenshot{plugins/images/ss-lrcplayer}{Lrcplayer}{} |
4 | This plugin displays lyrics in .lrc file (and some other formats) synchronized | 4 | This plugin displays lyrics in \fname{.lrc} files (and some other formats) |
5 | with the song being played. | 5 | synchronized with the song being played. |
6 | 6 | ||
7 | \subsubsection{Supproted file types} | 7 | \subsubsection{Supported file types} |
8 | \begin{enumerate} | 8 | \begin{enumerate} |
9 | \item .lrc | 9 | \item \fname{.lrc} |
10 | \item .lrc8 | 10 | \item \fname{.lrc8} |
11 | \item .snc | 11 | \item \fname{.snc} |
12 | \item .txt | 12 | \item \fname{.txt} |
13 | \item id3v2 SYLT or USLT tag in mp3 file | 13 | \item id3v2 SYLT or USLT tags in mp3 files |
14 | \end{enumerate} | 14 | \end{enumerate} |
15 | 15 | ||
16 | .lrc8 file is equivalent to .lrc files except it is read that | 16 | \fname{.lrc8} files are the same as \fname{.lrc} files except that they are UTF8 |
17 | encoded by UTF-8 nevertheless the encoding setting. | 17 | encoded. The Lyrics3 tag is not supported. |
18 | 18 | ||
19 | Lyrics3 tag is not supported. | 19 | \subsubsection{Supported tags and formats for \fname{.lrc} files} |
20 | 20 | The following tags are supported: | |
21 | \subsubsection{Supported tags and formats for .lrc files} | ||
22 | following tags are supported: | ||
23 | \begin{verbatim} | 21 | \begin{verbatim} |
24 | [ti:title] | 22 | [ti:title] |
25 | [ar:artist] | 23 | [ar:artist] |
26 | [offset:offset (msec)] | 24 | [offset:offset (msec)] |
27 | \end{verbatim} | 25 | \end{verbatim} |
28 | 26 | ||
29 | each line should look like one of these: | 27 | Each line should resemble one of the following: |
30 | \begin{verbatim} | 28 | \begin{verbatim} |
31 | [time tag]line | 29 | [time tag]line |
32 | [time tag]...[time tag]line | 30 | [time tag]...[time tag]line |
33 | [time tag]<word time tag>word<word time tag>...<word time tag> | 31 | [time tag]<word time tag>word<word time tag>...<word time tag> |
34 | \end{verbatim} | 32 | \end{verbatim} |
35 | 33 | ||
36 | time tag must be in one of the formats: [mm:ss], [mm:ss.xx], or [mm:ss.xxx] | 34 | The time tag must be in the form [mm:ss], [mm:ss.xx], or [mm:ss.xxx] where mm is |
37 | 35 | minutes, ss is seconds, xx is tenth of milliseconds, and xxx is milliseconds. | |
38 | where mm is minuts, ss is seconds, xx is tenth of millisecounds, xxx is millisecounds. | 36 | Any other tags and lines without time tags are ignored. |
39 | |||
40 | e.g. [01:23], [01:23.45]. | ||
41 | |||
42 | any other tags and lines without time tags are ignored. | ||
43 | 37 | ||
44 | \subsubsection{Searching lyrics file} | 38 | \subsubsection{Location of lyrics files} |
45 | the plugin checks following directories for lyrics file. | 39 | The plugin checks the following directories for lyrics files. |
46 | \opt{swcodec}{if no lyrics file is found and the audio file is a mp3, | 40 | \opt{swcodec}{If no lyrics file is found and the audio file is a \fname{.mp3}, |
47 | it also checks SYLT or USLT tag in id3v2.} | 41 | it also checks for SYLT and USLT tags in the id3v2 tags.} |
48 | 42 | ||
49 | \begin{enumerate} | 43 | \begin{enumerate} |
50 | \item the directory of the audio file and it's parent directories. | 44 | \item The directory containing the audio file and its parent directories. |
51 | \item subdirecory named ``Lylics'' of each directory in 1. | 45 | \item For each of the above directories, the plugin searches for a subdirectory |
52 | \item almost same as 1, but ``/Lylics'' is prepended to the path. | 46 | named ``Lyrics''. |
47 | \item Finally, the plugin will search as above, but within a directory called | ||
48 | ``/Lyrics''. The name of this directory can be customized, see below. | ||
53 | \end{enumerate} | 49 | \end{enumerate} |
54 | ``Lylics'' can be customized. | ||
55 | 50 | ||
56 | e.g. | 51 | If the audio file currently playing is \fname{/Music/Artist/Album/Title.mp3}, |
57 | 52 | then the following files will be searched for, in this order. \fname{.ext} is one | |
58 | if the audio file currently playing is /Musics/Artist/Album/Title.mp3, | 53 | of the supported extensions from the list above, and will be searched for in the |
59 | then following files will be tried in this order. | 54 | same order as in that list. |
60 | |||
61 | ext is one in supproted file types list, tried in same order of the list. | ||
62 | 55 | ||
63 | \begin{verbatim} | 56 | \begin{verbatim} |
64 | /Musics/Artist/Album/Title.ext | 57 | /Music/Artist/Album/Title.ext |
65 | /Musics/Artist/Title.ext | 58 | /Music/Artist/Title.ext |
66 | /Musics/Title.ext | 59 | /Music/Title.ext |
67 | /Title.ext | 60 | /Title.ext |
68 | /Musics/Artist/Album/Lyrics/Title.ext | 61 | /Music/Artist/Album/Lyrics/Title.ext |
69 | /Musics/Artist/Lyrics/Title.ext | 62 | /Music/Artist/Lyrics/Title.ext |
70 | /Musics/Lyrics/Title.ext | 63 | /Music/Lyrics/Title.ext |
71 | /Lyrics/Title.ext | 64 | /Lyrics/Title.ext |
72 | /Lyrics/Musics/Artist/Album/Title.ext | 65 | /Lyrics/Musics/Artist/Album/Title.ext |
73 | /Lyrics/Musics/Artist/Title.ext | 66 | /Lyrics/Musics/Artist/Title.ext |
@@ -122,51 +115,49 @@ ext is one in supproted file types list, tried in same order of the list. | |||
122 | \subsubsection{Lrcplayer Menu} | 115 | \subsubsection{Lrcplayer Menu} |
123 | 116 | ||
124 | \begin{description} | 117 | \begin{description} |
125 | \item[Theme settings.] change theme related settings. | 118 | \item[Theme settings.] Change theme related settings. |
126 | \begin{description} | 119 | \begin{description} |
127 | \opt{lcd_bitmap}{% | 120 | \opt{lcd_bitmap}{% |
128 | \item[Show Statusbar.] show / hide statusbar. | 121 | \item[Show Statusbar.] Show / hide the statusbar. |
129 | \item[Display Title.] show / hide title of track. | 122 | \item[Display Title.] Show / hide the track title. |
130 | }% | 123 | }% |
131 | \item[Display Time.] show / hide current time. | 124 | \item[Display Time.] Show / hide the current time. |
132 | \opt{lcd_color}{% | 125 | \opt{lcd_color}{% |
133 | \item[Inactive Color.] set color of inactive part of lyrics. | 126 | \item[Inactive Colour.] Set the colour of the inactive part of the lyrics. |
134 | }% | 127 | }% |
135 | \item[Backlight Force On.] don't turn off backlight while in displaying | 128 | \item[Backlight Force On.] Do not turn off the backlight while displaying |
136 | lyrics screen. | 129 | the lyrics. |
137 | \end{description} | 130 | \end{description} |
138 | \opt{lcd_bitmap}{% | 131 | \opt{lcd_bitmap}{% |
139 | \item[Display Settings.] change displaying of lyrics. | 132 | \item[Display Settings.] Change how the lyrics are displayed. |
140 | \begin{description} | 133 | \begin{description} |
141 | \item[Wrap.] breaks lines at white space. | 134 | \item[Wrap.] Breaks lines at white space. |
142 | \item[Wipe.] wipe text. | 135 | \item[Wipe.] Wipes the text. |
143 | \item[Align.] align text to left, center, or right. | 136 | \item[Alignment.] Align text to the left, centre, or right. |
144 | \item[Activate Only Current Line.] | 137 | \item[Activate Only Current Line.] |
145 | activate only current line or current line and previous lines. | 138 | Activate only the current line, or the current and previous lines. |
146 | \end{description} | 139 | \end{description} |
147 | }% | 140 | }% |
148 | \item[Lyrics Settings.] change loading of lyrics. | 141 | \item[Lyrics Settings.] Change how the lyrics files are loaded. |
149 | \begin{description} | 142 | \begin{description} |
150 | \item[Encoding.] sets the codepage in the plugin. | 143 | \item[Encoding.] Sets the codepage used in the plugin. |
151 | \opt{swcodec}{% | 144 | \opt{swcodec}{% |
152 | \item[Read ID3 tag.] read lyrics from id3 tag in mp3 file. | 145 | \item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files. |
153 | }% | 146 | }% |
154 | \item[Lrc Directry.] set name of a directory where lyrics files are sotred, | 147 | \item[Lrc Directory.] Set the directory where lyrics files are stored, |
155 | 63 bytes at maximum. | 148 | must be a maximum of 63 bytes. |
156 | \end{description} | 149 | \end{description} |
157 | \item[Playback Control.] Show playback control menu. | 150 | \item[Playback Control.] Show the playback control menu. |
158 | \item[Time Offset.] set offset for time tags of the lyrics currently loaded. | 151 | \item[Time Offset.] Set an offset for the time tags for the lyrics currently in use. |
159 | \item[Timetag Editor.] Enter timetag editor. | 152 | \item[Timetag Editor.] Enter the timetag editor. |
160 | \item[Quit.] Exit the plugin. | 153 | \item[Quit.] Exit the plugin. |
161 | \end{description} | 154 | \end{description} |
162 | 155 | ||
163 | \subsubsection{Editing time tag} | 156 | \subsubsection{Editing the time tags} |
164 | 157 | ||
165 | The time when to dispaly the line can be edited with timetag editor. | 158 | The display time for each line can be changed with the timetag editor. |
166 | Selecting line changes its time to current position of the song. | 159 | Selecting a line changes its time to the current position of the track. |
167 | To set a specific time or to adjust the time, press \ActionStdContext to | 160 | To set a specific time or to adjust the time, press \ActionStdContext{} to |
168 | bring up a screen for adjusting the time. | 161 | bring up a screen to adjust the time. |
169 | Changes will be saved automatically when the song is changed. | 162 | Changes will be saved automatically when the song is changed. |
170 | |||
171 | Edting words in lyrics is not supported. | 163 | Edting words in lyrics is not supported. |
172 | |||