tsiry-sandratraina.com
A modern Music Player Daemon based on Rockbox open source high quality audio player
libadwaita
audio
rust
zig
deno
mpris
rockbox
mpd
1% $Id$ %
2\subsection{Lrcplayer}
3% \screenshot{plugins/images/ss-lrcplayer}{Lrcplayer}{}
4This plugin displays lyrics in \fname{.lrc} files (and some other formats)
5synchronized with the song being played.
6
7\subsubsection{Supported file types}
8\begin{enumerate}
9\item \fname{.lrc}
10\item \fname{.lrc8}
11\item \fname{.snc}
12\item \fname{.txt}
13\item id3v2 SYLT or USLT tags in mp3 files
14\end{enumerate}
15
16\fname{.lrc8} files are the same as \fname{.lrc} files except that they are UTF8
17encoded. The Lyrics3 tag is not supported.
18
19\subsubsection{Supported tags and formats for \fname{.lrc} files}
20The following tags are supported:
21\begin{verbatim}
22[ti:title]
23[ar:artist]
24[offset:offset (msec)]
25\end{verbatim}
26
27Each line should resemble one of the following:
28\begin{verbatim}
29[time tag]line
30[time tag]...[time tag]line
31[time tag]<word time tag>word<word time tag>...<word time tag>
32\end{verbatim}
33
34The time tag must be in the form [mm:ss], [mm:ss.xx], or [mm:ss.xxx] where mm is
35minutes, ss is seconds, xx is tenth of milliseconds, and xxx is milliseconds.
36Any other tags and lines without time tags are ignored.
37
38\subsubsection{Location of lyrics files}
39The plugin checks the following directories for lyrics files.
40If no lyrics file is found and the audio file is a \fname{.mp3},
41it also checks for SYLT and USLT tags in the id3v2 tags.
42
43\begin{enumerate}
44\item The directory containing the audio file and its parent directories.
45\item For each of the above directories, the plugin searches for a subdirectory
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.
49\end{enumerate}
50
51If the audio file currently playing is \fname{/Music/Artist/Album/Title.mp3},
52then the following files will be searched for, in this order. \fname{.ext} is one
53of the supported extensions from the list above, and will be searched for in the
54same order as in that list.
55
56\begin{verbatim}
57/Music/Artist/Album/Title.ext
58/Music/Artist/Title.ext
59/Music/Title.ext
60/Title.ext
61/Music/Artist/Album/Lyrics/Title.ext
62/Music/Artist/Lyrics/Title.ext
63/Music/Lyrics/Title.ext
64/Lyrics/Title.ext
65/Lyrics/Musics/Artist/Album/Title.ext
66/Lyrics/Musics/Artist/Title.ext
67/Lyrics/Musics/Title.ext
68/Lyrics/Title.ext
69\end{verbatim}
70
71\subsubsection{Controls}
72\begin{table}
73 \begin{btnmap}{}{}
74 \ActionWpsVolUp{} / \ActionWpsVolDown
75 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsVolUp{} / \ActionRCWpsVolDown}
76 & Volume up/down.\\
77 %
78 \ActionWpsSkipPrev
79 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSkipPrev}
80 & Go to beginning of track, or if pressed while in the
81 first seconds of a track, go to the previous track.\\
82 %
83 \ActionWpsSeekBack
84 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekBack}
85 & Rewind in track.\\
86 %
87 \ActionWpsSkipNext
88 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSkipNext}
89 & Go to the next track.\\
90 %
91 \ActionWpsSeekFwd
92 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekFwd}
93 & Fast forward in track.\\
94 %
95 \ActionWpsPlay
96 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPlay}
97 & Toggle play/pause.\\
98 %
99 \ActionWpsStop{} or \ActionWpsBrowse
100 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsStop{} or \ActionRCWpsBrowse}
101 & Exit the plugin.\\
102 %
103 \ActionWpsContext
104 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext}
105 & Enter timetag editor.\\
106 %
107 \ActionWpsMenu%
108 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsMenu}
109 & Enter \setting{Lrcplayer Menu}.\\
110 %
111 \end{btnmap}
112\end{table}
113
114\subsubsection{Lrcplayer Menu}
115
116\begin{description}
117 \item[Theme settings.] Change theme related settings.
118 \begin{description}
119 \item[Show Statusbar.] Show / hide the statusbar.
120 \item[Display Title.] Show / hide the track title.
121 \item[Display Time.] Show / hide the current time.
122 \opt{lcd_color}{%
123 \item[Inactive Colour.] Set the colour of the inactive part of the lyrics.
124 }%
125 \item[Backlight Force On.] Do not turn off the backlight while displaying
126 the lyrics.
127 \end{description}
128 \item[Display Settings.] Change how the lyrics are displayed.
129 \begin{description}
130 \item[Wrap.] Breaks lines at white space.
131 \item[Wipe.] Wipes the text.
132 \item[Alignment.] Align text to the left, centre, or right.
133 \item[Activate Only Current Line.]
134 Activate only the current line, or the current and previous lines.
135 \end{description}
136 \item[Lyrics Settings.] Change how the lyrics files are loaded.
137 \begin{description}
138 \item[Encoding.] Sets the codepage used in the plugin.
139 \item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files.
140 \item[Lrc Directory.] Set the directory where lyrics files are stored,
141 must be a maximum of 63 bytes.
142 \end{description}
143 \item[Playback Control.] Show the playback control menu.
144 \item[Time Offset.] Set an offset for the time tags for the lyrics currently in use.
145 \item[Timetag Editor.] Enter the timetag editor.
146 \item[Quit.] Exit the plugin.
147\end{description}
148
149\subsubsection{Editing the time tags}
150
151The display time for each line can be changed with the timetag editor.
152Selecting a line changes its time to the current position of the track.
153To set a specific time or to adjust the time, press \ActionStdContext{} to
154bring up a screen to adjust the time.
155Changes will be saved automatically when the song is changed.
156Editing words in lyrics is not supported.