manual/plugins/lrcplayer.tex

   1 % $Id$ %
   2 \subsection{Lrcplayer}
   3 % \screenshot{plugins/images/ss-lrcplayer}{Lrcplayer}{}
   4 This plugin displays lyrics in .lrc file (and some other formats) synchronized
   5 with the song being played.
   6
   7 \subsubsection{Supproted file types}
   8 \begin{enumerate}
   9 \item .lrc
  10 \item .lrc8
  11 \item .snc
  12 \item .txt
  13 \item id3v2 SYLT or USLT tag in mp3 file
  14 \end{enumerate}
  15
  16 .lrc8 file is equivalent to .lrc files except it is read that
  17 encoded by UTF-8 nevertheless the encoding setting.
  18
  19 Lyrics3 tag is not supported.
  20
  21 \subsubsection{Supported tags and formats for .lrc files}
  22 following tags are supported:
  23 \begin{verbatim}
  24 [ti:title]
  25 [ar:artist]
  26 [offset:offset (msec)]
  27 \end{verbatim}
  28
  29 each line should look like one of these:
  30 \begin{verbatim}
  31 [time tag]line
  32 [time tag]...[time tag]line
  33 [time tag]<word time tag>word<word time tag>...<word time tag>
  34 \end{verbatim}
  35
  36 time tag must be in one of the formats: [mm:ss], [mm:ss.xx], or [mm:ss.xxx]
  37
  38 where mm is minuts, ss is seconds, xx is tenth of millisecounds, xxx is millisecounds.
  39
  40 e.g. [01:23], [01:23.45].
  41
  42 any other tags and lines without time tags are ignored.
  43
  44 \subsubsection{Searching lyrics file}
  45 the plugin checks following directories for lyrics file.
  46 \opt{swcodec}{if no lyrics file is found and the audio file is a mp3,
  47   it also checks SYLT or USLT tag in id3v2.}
  48
  49 \begin{enumerate}
  50 \item the directory of the audio file and it's parent directories.
  51 \item subdirecory named ``Lylics'' of each directory in 1.
  52 \item almost same as 1, but ``/Lylics'' is prepended to the path.
  53 \end{enumerate}
  54 ``Lylics'' can be customized.
  55
  56 e.g.
  57
  58 if the audio file currently playing is /Musics/Artist/Album/Title.mp3,
  59 then following files will be tried in this order.
  60
  61 ext is one in supproted file types list, tried in same order of the list.
  62
  63 \begin{verbatim}
  64 /Musics/Artist/Album/Title.ext
  65 /Musics/Artist/Title.ext
  66 /Musics/Title.ext
  67 /Title.ext
  68 /Musics/Artist/Album/Lyrics/Title.ext
  69 /Musics/Artist/Lyrics/Title.ext
  70 /Musics/Lyrics/Title.ext
  71 /Lyrics/Title.ext
  72 /Lyrics/Musics/Artist/Album/Title.ext
  73 /Lyrics/Musics/Artist/Title.ext
  74 /Lyrics/Musics/Title.ext
  75 /Lyrics/Title.ext
  76 \end{verbatim}
  77
  78 \subsubsection{Controls}
  79 \begin{table}
  80   \begin{btnmap}{}{}
  81     \ActionWpsVolUp{} / \ActionWpsVolDown
  82     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsVolUp{} / \ActionRCWpsVolDown}
  83     & Volume up/down.\\
  84     %
  85     \ActionWpsSkipPrev
  86     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSkipPrev}
  87     & Go to beginning of track, or if pressed while in the
  88       first seconds of a track, go to the previous track.\\
  89     %
  90     \ActionWpsSeekBack
  91     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekBack}
  92     & Rewind in track.\\
  93     %
  94     \ActionWpsSkipNext
  95     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSkipNext}
  96     & Go to the next track.\\
  97     %
  98     \ActionWpsSeekFwd
  99     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekFwd}
 100     & Fast forward in track.\\
 101     %
 102     \ActionWpsPlay
 103     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPlay}
 104     & Toggle play/pause.\\
 105     %
 106     \ActionWpsStop \nopt{ONDIO_PAD}{or \ActionWpsBrowse}
 107     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsStop or \ActionRCWpsBrowse}
 108     & Exit the plugin.\\
 109     %
 110     \ActionWpsContext
 111     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext}
 112     & Enter timetag editor.\\
 113     %
 114     \opt{ONDIO_PAD}{\ActionWpsBrowse}%
 115     \nopt{ONDIO_PAD}{\ActionWpsMenu}%
 116     \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsMenu}
 117     & Enter \setting{Lrcplayer Menu}.\\
 118     %
 119   \end{btnmap}
 120 \end{table}
 121
 122 \subsubsection{Lrcplayer Menu}
 123
 124 \begin{description}
 125   \item[Theme settings.] change theme related settings.
 126   \begin{description}
 127     \opt{lcd_bitmap}{%
 128       \item[Show Statusbar.] show / hide statusbar.
 129       \item[Display Title.] show / hide title of track.
 130     }%
 131     \item[Display Time.] show / hide current time.
 132     \opt{lcd_color}{%
 133       \item[Inactive Color.] set color of inactive part of lyrics.
 134     }%
 135     \item[Backlight Force On.] don't turn off backlight while in displaying
 136         lyrics screen.
 137   \end{description}
 138   \opt{lcd_bitmap}{%
 139     \item[Display Settings.] change displaying of lyrics.
 140     \begin{description}
 141       \item[Wrap.] breaks lines at white space.
 142       \item[Wipe.] wipe text.
 143       \item[Align.] align text to left, center, or right.
 144       \item[Activate Only Current Line.]
 145           activate only current line or current line and previous lines.
 146     \end{description}
 147   }%
 148   \item[Lyrics Settings.] change loading of lyrics.
 149   \begin{description}
 150     \item[Encoding.] sets the codepage in the plugin.
 151     \opt{swcodec}{%
 152       \item[Read ID3 tag.] read lyrics from id3 tag in mp3 file.
 153     }%
 154     \item[Lrc Directry.] set name of a directory where lyrics files are sotred,
 155       63 bytes at maximum.
 156   \end{description}
 157   \item[Playback Control.] Show playback control menu.
 158   \item[Time Offset.] set offset for time tags of the lyrics currently loaded.
 159   \item[Timetag Editor.] Enter timetag editor.
 160   \item[Quit.] Exit the plugin.
 161 \end{description}
 162
 163 \subsubsection{Editing time tag}
 164
 165 The time when to dispaly the line can be edited with timetag editor.
 166 Selecting line changes its time to current position of the song.
 167 To set a specific time or to adjust the time, press \ActionStdContext to
 168  bring up a screen for adjusting the time.
 169 Changes will be saved automatically when the song is changed.
 170
 171 Edting words in lyrics is not supported.
 172