fix red.
[kugel-rb/myfork.git] / manual / rockbox_interface / wps.tex
blob2c8ecfa17dabe63e944b8908fe081f266077b29c
1 % $Id$ %
2 \section{\label{ref:WPS}While Playing Screen}
3 The While Playing Screen (WPS) displays various pieces of information about the
4 currently playing audio file.
6 \opt{lcd_bitmap}{%
7 The appearance of the WPS can be configured using WPS configuration files.
8 The items shown depend on your configuration -- all item can be turned on
9 or off independently. Refer to \reference{ref:wps_tags} for details on how
10 to change the display of the WPS.
11 \begin{itemize}
12 \nopt{ondio}{
13 \item Status bar: The Status bar shows Battery level, charger status,
14 volume, play mode, repeat mode, shuffle mode\opt{rtc}{ and clock}.
15 In contrast to all other items, the status bar is always at the top of
16 the screen.
18 \opt{ondio}{
19 \item Status bar: The Status bar shows Battery level, USB power mode, key
20 lock status, memory access indicator. In contrast to all other items, the
21 status bar is always at the top of the screen.
23 \item (Scrolling) path and filename of the current song.
24 \item The ID3 track name.
25 \item The ID3 album name.
26 \item The ID3 artist name.
27 \item Bit rate. VBR files display average bitrate and ``(avg)''
28 \item Elapsed and total time.
29 \item A slidebar progress meter representing where in the song you are.
30 \item Peak meter.
31 \end{itemize}
33 \opt{recorder,recorderv2fm,ondio}{
34 \note{
35 \begin{itemize}
36 \item The number of lines shown depends on the size of the font used.
37 \item The peak meter is only visible if you turn off the status bar or if
38 using a small font that gives 8 or more display lines.
39 \end{itemize}
43 \opt{player}{
44 \note{
45 \begin{itemize}
46 \item Playlist index/Playlist size: Artist {}- Title.
47 \item Current{}-time Progress{}-indicator Left.
48 \end{itemize}
52 See \reference{ref:ConfiguringtheWPS} for details of customising
53 your WPS (While Playing Screen).
56 \subsection{\label{ref:WPS_Key_Controls}WPS Key Controls}
58 \begin{table}
59 \begin{btnmap}{}{}
60 \ActionWpsVolUp{} / \ActionWpsVolDown
61 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsVolUp{} / \ActionRCWpsVolDown}
62 & Volume up/down.\\
64 \ActionWpsSkipPrev
65 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSkipPrev}
66 & Go to beginning of track, or if pressed while in the
67 first seconds of a track, go to previous track.\\
69 \ActionWpsSeekBack
70 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekBack}
71 & Rewind in track.\\
73 \ActionWpsSkipNext
74 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSkipNext}
75 & Go to next track.\\
77 \ActionWpsSeekFwd
78 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekFwd}
79 & Fast forward in track.\\
81 \ActionWpsPlay
82 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPlay}
83 & Toggle play/pause.\\
85 \ActionWpsStop
86 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsStop}
87 & Stop playback.\\
89 \ActionWpsBrowse
90 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsBrowse}
91 & Return to the \setting{File Browser}.\\
93 \ActionWpsContext
94 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext}
95 & Enter \setting{WPS Context Menu}.\\
97 \opt{ONDIO_PAD}{\ActionWpsContext{} twice}%
98 \nopt{ONDIO_PAD}{\ActionWpsMenu}%
99 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsMenu}
100 & Enter \setting{Main Menu}%
101 \opt{ONDIO_PAD}{ via the \setting{WPS Context Menu}}.\\%
103 \opt{quickscreen}{%
104 \ActionWpsQuickScreen
105 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsQuickScreen}
106 & Switches to the \setting{Quick Screen}.
107 (see \reference{ref:QuickScreen}) \\}%
109 % software hold targets (currently Archos only)
110 \nopt{hold_button}{%
111 \opt{RECORDER_PAD}{\ButtonFOne+\ButtonDown}
112 \opt{PLAYER_PAD}{\ButtonMenu+\ButtonStop}
113 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown}
114 & Key lock on/off.\\
116 %These actions need definitions for the other targets
117 \opt{RECORDER_PAD}{%
118 \ButtonFThree & Toggles Display quick screen.\\%
119 \ButtonFOne+\ButtonPlay & Mute on/off.\\%
121 \opt{PLAYER_PAD}{%
122 \ButtonMenu+\ButtonPlay & Mute on/off.\\%
124 % We explicitly list all the appropriate targets here and do no condition
125 % on the 'pitchscreen' feature since some players have the feature but do
126 % not have the button to go from the WPS to the pitch screen.
127 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,MROBE100_PAD%
128 ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{%
129 \ActionWpsPitchScreen
130 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPitchScreen}
131 & Show \setting{Pitch Screen} (see \reference{sec:pitchscreen}).\\%
133 \opt{PLAYER_PAD,RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD%
134 ,MROBE100_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{%
135 \ActionWpsIdThreeScreen
136 \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsIdThreeScreen}
137 & Enter \setting{ID3 Viewer}.\\%
139 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,MROBE100_PAD%
140 ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{%
141 \ActionWpsAbSetBNextDir{} or }%
142 % not all targets have the above action defined but the one below works on all
143 Short \ActionWpsSkipNext{} + Long \ActionWpsSkipNext
144 \opt{HAVEREMOTEKEYMAP}{
146 \opt{IRIVER_RC_H100_PAD}{\ActionRCWpsAbSetBNextDir{} or}
147 Short \ActionRCWpsSkipNext{} + Long \ActionRCWpsSkipNext}
148 & Skip to the next directory.\\
150 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD%
151 ,MROBE100_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{%
152 \ActionWpsAbSetAPrevDir{} or }%
153 Short \ActionWpsSkipPrev{} + Long \ActionWpsSkipPrev
154 \opt{HAVEREMOTEKEYMAP}{
156 \opt{IRIVER_RC_H100_PAD}{\ActionRCWpsAbSetAPrevDir{} or}
157 Short \ActionRCWpsSkipPrev{} + Long \ActionRCWpsSkipPrev}
158 & Skip to the previous directory.\\
160 \opt{SANSA_E200_PAD,SANSA_C200_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{
161 \ActionStdRec
162 \opt{HAVEREMOTEKEYMAP}{&}
163 & Switches to the Recording screen \\
165 \end{btnmap}
166 \end{table}
169 \opt{lcd_bitmap}{
170 \subsection{\label{ref:peak_meter}Peak Meter}
171 The peak meter can be displayed on the While Playing Screen and consists of
172 several indicators.
173 \opt{recording}{
174 For a picture of the peak meter, please see the While
175 Recording Screen in \reference{ref:while_recording_screen}.
178 \begin{description}
179 \item [The bar:]
180 This is the wide horizontal bar. It represents the current volume value.
181 \item [The peak indicator:]
182 This is a little vertical line at the right end of the bar. It indicates
183 the peak volume value that occurred recently.
184 \item [The clip indicator:]
185 This is a little black block that is displayed at the very right of the
186 scale when an overflow occurs. It usually does not show up during normal
187 playback unless you play an audio file that is distorted heavily.
188 \opt{recording}{
189 If you encounter clipping while recording, your recording will sound distorted.
190 You should lower the gain.
192 \note{Note that the clip detection is not very precise.
193 Clipping might occur without being indicated.}
194 \item [The scale:]
195 Between the indicators of the right and left channel there are little dots.
196 These dots represent important volume values. In linear mode each dot is a
197 10\% mark. In dbfs mode the dots represent the following values (from right
198 to left): 0db, {}-3db, {}-6db, {}-9db, {}-12db, {}-18db, {}-24db, {}-30db,
199 {}-40db, {}-50db, {}-60db.
200 \end{description}
202 \subsection{\label{sec:contextmenu}The WPS Context Menu}
203 Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu}
204 allows you quick access to some often used functions:
206 \subsubsection{Playlist}
207 The \setting{Playlist} submenu allows you to view, save, search and
208 reshuffle the current playlist. To change settings for the
209 \setting{Playlist Viewer} press \ActionStdMenu{} while viewing the playlist
210 to bring up the \setting{Playlist Viewer Menu}.
212 \subsubsection{Playlist Viewer Menu}
213 \begin{description}
214 \item[Show Icons.] This toggles display of the icon for the currently
215 selected playlist entry and the icon for moving a playlist entry
216 \item[Show Indicies.] This toggles display of the line numbering for
217 the playlist
218 \item[Track Display.] This toggles between filename only and full path
219 for playlist entries
220 \item[Save Current Playlist.] Allows the current playlist to be saved as
221 a \fname{.m3u8} playlist file
222 \end{description}
225 \subsubsection{Playlist catalog}
226 \begin{description}
227 \item [View catalog.] This lists all playlists that are part of the
228 Playlist catalog. You can load a new playlist directly from this list.
229 \item [Add to playlist.] Adds the currently playing file to a playlist.
230 Select the playlist you want the file to be added to and it will get
231 appended to that playlist.
232 \item [Add to new playlist.] Similar to the previous entry this will
233 add the currently playing track to a playlist. You need to enter a name
234 for the new playlist first.
235 \end{description}
237 \subsubsection{Sound Settings}
238 This is a shortcut to the \setting{Sound Settings Menu}, where you can configure volume,
239 bass, treble, and other settings affecting the sound of your music.
240 See \reference{ref:configure_rockbox_sound} for more information.
242 \subsubsection{Playback Settings}
243 This is a shortcut to the \setting{Playback Settings Menu}, where you can configure shuffle,
244 repeat, party mode, study mode and other settings affecting the playback of your music.
246 \subsubsection{Rating}
247 The menu entry is only shown if \setting{Gather Runtime Information} is
248 enabled. It allows the asignment of a personal rating value (0 -- 10)
249 to a track which can be displayed in the WPS and used in the Database
250 browser. Press \ButtonRight{} to increment the value. The value wraps at 10.
252 \subsubsection{Bookmarks}
253 This allows you to create a bookmark in the currently-playing track.
255 \subsubsection{\label{ref:trackinfoviewer}Show Track Info}
256 \screenshot{rockbox_interface/images/ss-id3-viewer}{The track info viewer}{}
257 This screen is accessible from the WPS screen, and provides a detailed view of
258 all the identity information about the current track. This info is known as
259 meta data and is stored in audio file formats to keep information on artist,
260 album etc. To access this screen, %
261 \opt{PLAYER_PAD,RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD}{
262 press \ActionWpsIdThreeScreen. }%
263 \opt{ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD}{press \ActionWpsContext{}
264 to access the \setting{WPS Context Menu} and select
265 \setting{Show Track Info}. }%
266 \opt{RECORDER_PAD,PLAYER_PAD,ONDIO_PAD}{Use \ButtonLeft\ and \ButtonRight\
267 to move through the information.}%
269 \subsubsection{Open With...}
270 This \setting{Open With} function is the same as the \setting{Open With}
271 function in the file browser's \setting{Context Menu}.
273 \subsubsection{Delete}
274 Delete the currently playing file.
276 \opt{pitchscreen}{
277 \subsubsection{\label{sec:pitchscreen}Pitch}
279 The \setting{Pitch Screen} allows you to change the rate of playback
280 (i.e. the playback speed and at the same time the pitch) of your
281 \dap. The rate value can be adjusted between 50\% and 200\%. 50\%
282 means half the normal playback speed and a pitch that is an octave
283 lower than the normal pitch. 200\% means double playback speed and a
284 pitch that is an octave higher than the normal pitch.
286 The rate can be changed in two modes: procentual and semitone.
287 Initially, procentual mode is active.
289 \opt{swcodec}{
290 If you've enabled the \setting{Timestretch} option in
291 \setting{Sound Settings} and have since rebooted, you can also use
292 timestretch mode. This allows you to change the playback speed
293 without affecting the pitch, and vice versa.
295 In timestretch mode there are separate displays for pitch and
296 speed, and each can be altered independently. Due to the
297 limitations of the algorithm, speed is limited to be between 35\%
298 and 250\% of the current pitch value. Pitch must maintain the
299 same ratio as well as remain between 50\% and 200\%.
302 The value of the \opt{swcodec}{rate, pitch and speed}\nopt{swcodec}{rate}
303 is not persisted, i.e. after the \dap\ is turned on it will
304 always be set to 100\%.
306 \nopt{swcodec}{
307 \begin{table}
308 \begin{btnmap}{}{}
309 \ActionPsToggleMode
310 & Toggle pitch changing mode \\
312 \ActionPsIncSmall{} / \ActionPsDecSmall
313 & Increase / Decrease pitch by 0.1\% (in procentual mode) or by 0.1
314 semitone (in semitone mode)\\
316 \ActionPsIncBig{} / \ActionPsDecBig
317 & Increase / Decrease pitch by 1\% (in procentual mode) or a semitone
318 (in semitone mode)\\
320 \ActionPsNudgeLeft{} / \ActionPsNudgeRight
321 & Temporarily change pitch by 2\% (beatmatch) \\
323 \ActionPsReset
324 & Reset rate to 100\% \\
326 \ActionPsExit
327 & Leave the Pitch Screen \\
329 \end{btnmap}
330 \end{table}
332 \warn{Changing the pitch can cause audible 'Artifacts' or 'Dropouts'.}
335 \opt{swcodec}{
336 \begin{table}
337 \begin{btnmap}{}{}
338 \ActionPsToggleMode
339 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsToggleMode}
340 & Toggle pitch changing mode (cycles through all available modes)\\
342 \ActionPsIncSmall{} / \ActionPsDecSmall
343 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncSmall{} / \ActionRCPsDecSmall}
344 & Increase / Decrease pitch by 0.1\% (in procentual mode) or 0.1
345 semitone (in semitone mode)\\
347 \ActionPsIncBig{} / \ActionPsDecBig
348 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncBig{} / \ActionRCPsDecBig}
349 & Increase / Decrease pitch by 1\% (in procentual mode) or a semitone
350 (in semitone mode)\\
352 \ActionPsNudgeLeft{} / \ActionPsNudgeRight
353 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsNudgeLeft{} / \ActionPsNudgeRight}
354 & Temporarily change pitch by 2\% (beatmatch), or modify speed (in timestretch mode) \\
356 \ActionPsReset
357 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsReset}
358 & Reset pitch and speed to 100\% \\
360 \ActionPsExit
361 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsExit}
362 & Leave the Pitch Screen \\
364 \end{btnmap}
365 \end{table}
370 %********************QUICKSCREENS***********************************************
371 \opt{RECORDER_PAD}{
372 \section{\label{ref:QuickScreens}Quick Screens}
373 \screenshot{rockbox_interface/images/ss-quick-screen-112x64x1.png}{The F2 quick screen}{}
374 \screenshot{rockbox_interface/images/ss-quick-screen2-112x64x1.png}{The F3 quick screen}{}
375 Rockbox handles function buttons in a different way to the Archos software.
376 \ButtonFOne\ is always bound to the menu function, while \ButtonFTwo\ and
377 \ButtonFThree\ enable two quick screens.
379 \ButtonFTwo\ displays some browse and play settings which are likely to be
380 changed frequently. This settings are Shuffle mode, Repeat mode and the Show
381 files options
383 Shuffle mode plays each track in the currently playing list in a random order
384 rather than in the order shown in the browser.
386 Repeat mode repeats either a single track (One) or the entire playlist (All).
388 Show files determines what type files can be seen in the browser. This can be
389 just MP3 files and directories (Music), Playlists, MP3 files and directories
390 (Playlists), any files that Rockbox supports (Supported) or all files on the
391 disk (All).
393 See \reference{ref:PlaybackOptions} for more information about these
394 settings.
396 \begin{table}
397 \begin{btnmap}{}{}
398 \ButtonLeft & Controls Shuffle mode setting \\
399 \ButtonRight & Controls Repeat mode setting \\
400 \ButtonDown & Controls Show file setting \\
401 \end{btnmap}
402 \end{table}
404 \ButtonFThree\ controls frequently used display options.
406 Scroll bar turns the display of the Scroll bar on the left of the screen on
407 or off.
409 Status bar turns the status display at the top of the screen on or off.
410 Upside down inverts the screen so that the top of the display appears nearest
411 to the buttons. This is sometimes useful when storing the \dap\ in a pocket.
412 Key assignments swap over with the display orientation where it is logical
413 for them to do so.
415 See \reference{ref:Displayoptions} for more information about these
416 settings.
418 \begin{table}
419 \begin{btnmap}{}{}
420 \ButtonLeft & Controls scroll bar display \\
421 \ButtonRight & Controls status bar display \\
422 \ButtonDown & Controls upside down screen setting \\
423 \end{btnmap}
424 \end{table}