manual/rockbox_interface/wps.tex

   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.
   5 %
   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 items 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.
  17     }
  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.
  22     }
  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}
  32 }
  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}
  40   }
  41 }
  42 %
  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}
  49   }
  50 }
  51
  52 See \reference{ref:ConfiguringtheWPS} for details of customising
  53 your WPS (While Playing Screen).
  54
  55
  56 \subsection{\label{ref:WPS_Key_Controls}WPS Key Controls}
  57
  58 \begin{table}
  59   \begin{btnmap}{}{}
  60       \ActionWpsVolUp{} / \ActionWpsVolDown
  61       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsVolUp{} / \ActionRCWpsVolDown}
  62       & Volume up/down.\\
  63       %
  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 the previous track.\\
  68       %
  69       \ActionWpsSeekBack
  70       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekBack}
  71       & Rewind in track.\\
  72       %
  73       \ActionWpsSkipNext
  74       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSkipNext}
  75       & Go to the next track.\\
  76       %
  77       \ActionWpsSeekFwd
  78       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsSeekFwd}
  79       & Fast forward in track.\\
  80       %
  81       \ActionWpsPlay
  82       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsPlay}
  83       & Toggle play/pause.\\
  84       %
  85       \ActionWpsStop
  86       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsStop}
  87       & Stop playback.\\
  88       %
  89       \ActionWpsBrowse
  90       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsBrowse}
  91       & Return to the \setting{File Browser} / \setting{Database}.\\
  92       %
  93       \ActionWpsContext
  94       \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsContext}
  95       & Enter \setting{WPS Context Menu}.\\
  96       %
  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}}.\\%
 102       %
 103       \opt{quickscreen}{%
 104         \ActionWpsQuickScreen
 105         \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsQuickScreen}
 106           & Switch to the \setting{Quick Screen}
 107           (see \reference{ref:QuickScreen}). \\}%
 108       %
 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.\\
 115       }%
 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.\\%
 120       }%
 121       \opt{PLAYER_PAD}{%
 122         \ButtonMenu+\ButtonPlay & Mute on/off.\\%
 123       }%
 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}).\\%
 132       }%
 133       \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_CLIP_PAD,MROBE100_PAD,PBELL_VIBE500_PAD}{%
 134         \ActionWpsPlaylist
 135           & Show current \setting{Playlist}.\\%
 136       }%
 137       \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD%
 138           ,SANSA_E200_PAD,SANSA_C200_PAD}{%
 139         \ActionWpsIdThreeScreen
 140           \opt{HAVEREMOTEKEYMAP}{& \ActionRCWpsIdThreeScreen}
 141           & Enter \setting{ID3 Viewer}.\\%
 142       }%
 143       \opt{hotkey}{%
 144         \ActionWpsHotkey \opt{HAVEREMOTEKEYMAP}{& }
 145         & Activate the \setting{Hotkey} function (see \reference{ref:Hotkeys}).\\
 146       }
 147       \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,MROBE100_PAD%
 148           ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{%
 149          \ActionWpsAbSetBNextDir{} or }%
 150          % not all targets have the above action defined but the one below works on all
 151       Short \ActionWpsSkipNext{} + Long \ActionWpsSkipNext
 152       \opt{HAVEREMOTEKEYMAP}{
 153         &
 154           \opt{IRIVER_RC_H100_PAD}{\ActionRCWpsAbSetBNextDir{} or}
 155         Short \ActionRCWpsSkipNext{} + Long \ActionRCWpsSkipNext}
 156       & Skip to the next directory.\\
 157       %
 158       \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD%
 159          ,MROBE100_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{%
 160          \ActionWpsAbSetAPrevDir{} or }%
 161       Short \ActionWpsSkipPrev{} + Long \ActionWpsSkipPrev
 162       \opt{HAVEREMOTEKEYMAP}{
 163         &
 164           \opt{IRIVER_RC_H100_PAD}{\ActionRCWpsAbSetAPrevDir{} or}
 165         Short \ActionRCWpsSkipPrev{} + Long \ActionRCWpsSkipPrev}
 166       & Skip to the previous directory.\\
 167       %
 168       \opt{SANSA_E200_PAD,SANSA_C200_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{
 169         \ActionStdRec
 170           \opt{HAVEREMOTEKEYMAP}{&}
 171           & Switch to the \setting{Recording Screen}.\\
 172       }%
 173     \end{btnmap}
 174 \end{table}
 175
 176
 177 \opt{lcd_bitmap}{
 178   \subsection{\label{ref:peak_meter}Peak Meter}
 179   The peak meter can be displayed on the While Playing Screen and consists of
 180   several indicators.
 181   \opt{recording}{
 182     For a picture of the peak meter, please see the While
 183     Recording Screen in \reference{ref:while_recording_screen}.
 184   }
 185
 186   \begin{description}
 187   \item [The bar:]
 188     This is the wide horizontal bar. It represents the current volume value.
 189   \item [The peak indicator:]
 190     This is a little vertical line at the right end of the bar. It indicates
 191     the peak volume value that occurred recently.
 192   \item [The clip indicator:]
 193     This is a little black block that is displayed at the very right of the
 194     scale when an overflow occurs. It usually does not show up during normal
 195     playback unless you play an audio file that is distorted heavily.
 196     \opt{recording}{
 197       If you encounter clipping while recording, your recording will sound distorted.
 198       You should lower the gain.
 199     }
 200     \note{Note that the clip detection is not very precise.
 201      Clipping might occur without being indicated.}
 202   \item [The scale:]
 203     Between the indicators of the right and left channel there are little dots.
 204     These dots represent important volume values. In linear mode each dot is a
 205     10\% mark. In dBFS mode the dots represent the following values (from right
 206     to left): 0~dB, {}-3~dB, {}-6~dB, {}-9~dB, {}-12~dB, {}-18~dB, {}-24~dB, {}-30~dB,
 207     {}-40~dB, {}-50~dB, {}-60~dB.
 208   \end{description}
 209 }
 210 \subsection{\label{sec:contextmenu}The WPS Context Menu}
 211 Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu}
 212 allows you quick access to some often used functions.
 213
 214 \subsubsection{Playlist}
 215 The \setting{Playlist} submenu allows you to view, save, search and
 216 reshuffle the current playlist. To change settings for the
 217 \setting{Playlist Viewer} press \ActionStdContext{} while viewing the current
 218 playlist to bring up the \setting{Playlist Viewer Menu}. In this menu, you
 219 can find the \setting{Playlist Viewer Settings}.
 220
 221 \subsubsection{Playlist Viewer Settings}
 222   \begin{description}
 223     \item[Show Icons.] This toggles display of the icon for the currently
 224     selected playlist entry and the icon for moving a playlist entry
 225     \item[Show Indicies.] This toggles display of the line numbering for
 226        the playlist
 227     \item[Track Display.] This toggles between filename only and full path
 228        for playlist entries
 229     \item[Save Current Playlist.] Allows the current playlist to be saved as
 230        a \fname{.m3u8} playlist file
 231   \end{description}
 232
 233
 234 \subsubsection{Playlist catalog}
 235   \begin{description}
 236     \item [View catalog.] This lists all playlists that are part of the
 237     Playlist catalog. You can load a new playlist directly from this list.
 238     \item [Add to playlist.] Adds the currently playing file to a playlist.
 239     Select the playlist you want the file to be added to and it will get
 240     appended to that playlist.
 241     \item [Add to new playlist.] Similar to the previous entry this will
 242     add the currently playing track to a playlist. You need to enter a name
 243     for the new playlist first.
 244   \end{description}
 245
 246 \subsubsection{Sound Settings}
 247 This is a shortcut to the \setting{Sound Settings Menu}, where you can configure volume,
 248 bass, treble, and other settings affecting the sound of your music.
 249 See \reference{ref:configure_rockbox_sound} for more information.
 250
 251 \subsubsection{Playback Settings}
 252 This is a shortcut to the \setting{Playback Settings Menu}, where you can configure shuffle,
 253 repeat, party mode, skip length and other settings affecting the playback of your music.
 254
 255 \subsubsection{Rating}
 256 The menu entry is only shown if \setting{Gather Runtime Information} is
 257 enabled. It allows the asignment of a personal rating value (0 -- 10)
 258 to a track which can be displayed in the WPS and used in the Database
 259 browser. The value wraps at 10.
 260
 261 \subsubsection{Bookmarks}
 262 This allows you to create a bookmark in the currently-playing track.
 263
 264 \subsubsection{\label{ref:trackinfoviewer}Show Track Info}
 265 \screenshot{rockbox_interface/images/ss-id3-viewer}{The track info viewer}{}
 266 This screen is accessible from the WPS screen, and provides a detailed view of
 267 all the identity information about the current track. This info is known as
 268 meta data and is stored in audio file formats to keep information on artist,
 269 album etc. To access this screen, %
 270 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,%
 271       SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD}{
 272   press \ActionWpsIdThreeScreen. }%
 273 \opt{PLAYER_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IAUDIO_M3_PAD,%
 274       GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_CLIP_PAD,PBELL_VIBE500_PAD}{press
 275   \ActionWpsContext{} to access the \setting{WPS Context Menu} and select
 276   \setting{Show Track Info}. }%
 277 \opt{RECORDER_PAD,PLAYER_PAD,ONDIO_PAD}{Use \ButtonLeft\ and \ButtonRight\
 278   to move through the information.}%
 279
 280 \subsubsection{Open With...}
 281 This \setting{Open With} function is the same as the \setting{Open With}
 282 function in the file browser's \setting{Context Menu}.
 283
 284 \subsubsection{Delete}
 285 Delete the currently playing file. The file will be deleted but the playback
 286 of the file will not stop immediately. Instead, the part of the file that
 287 has already been buffered (i.e. read into the \daps\ memory) will be played.
 288 This may even be the whole track.
 289
 290 \opt{pitchscreen}{
 291   \subsubsection{\label{sec:pitchscreen}Pitch}
 292
 293   The \setting{Pitch Screen} allows you to change the rate of playback
 294   (i.e. the playback speed and at the same time the pitch) of your
 295   \dap.  The rate value can be adjusted
 296   between 50\% and 200\%. 50\% means half the normal playback speed and a
 297   pitch that is an octave lower than the normal pitch. 200\% means double
 298   playback speed and a pitch that is an octave higher than the normal pitch.
 299
 300   The rate can be changed in two modes: procentual and semitone.
 301   Initially, procentual mode is active.
 302
 303   \opt{swcodec}{
 304     If you've enabled the \setting{Timestretch} option in
 305     \setting{Sound Settings} and have since rebooted, you can also use
 306     timestretch mode. This allows you to change the playback speed
 307     without affecting the pitch, and vice versa.
 308
 309     In timestretch mode there are separate displays for pitch and
 310     speed, and each can be altered independently.  Due to the
 311     limitations of the algorithm, speed is limited to be between 35\%
 312     and 250\% of the current pitch value.  Pitch must maintain the
 313     same ratio as well as remain between 50\% and 200\%.
 314   }
 315
 316   The value of the \opt{swcodec}{rate, pitch and speed}\nopt{swcodec}{rate}
 317   is not persistent, i.e. after the \dap\ is turned on it will
 318   always be set to 100\%.  \opt{swcodec}{ However, the rate, pitch and speed
 319   information will be stored in any bookmarks you may create
 320   (see \reference{ref:Bookmarkconfigactual}) and will be restored upon
 321   playing back those bookmarks.}
 322
 323   \nopt{swcodec}{
 324     \begin{table}
 325       \begin{btnmap}{}{}
 326         \ActionPsToggleMode
 327         & Toggle pitch changing mode. \\
 328         %
 329         \ActionPsIncSmall{} / \ActionPsDecSmall
 330         & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or by 0.1
 331           semitone (in semitone mode).\\
 332         %
 333         \ActionPsIncBig{} / \ActionPsDecBig
 334         & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
 335           (in semitone mode).\\
 336         %
 337         \ActionPsNudgeLeft{} / \ActionPsNudgeRight
 338         & Temporarily change pitch by 2\% (beatmatch). \\
 339         %
 340         \ActionPsReset
 341         & Reset rate to 100\%. \\
 342         %
 343         \ActionPsExit
 344         & Leave the \setting{Pitch Screen}. \\
 345         %
 346       \end{btnmap}
 347     \end{table}
 348
 349     \warn{Changing the pitch can cause audible 'Artifacts' or 'Dropouts'.}
 350   }
 351
 352   \opt{swcodec}{
 353     \begin{table}
 354       \begin{btnmap}{}{}
 355         \ActionPsToggleMode
 356         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsToggleMode}
 357         & Toggle pitch changing mode (cycle through all available modes).\\
 358         %
 359         \ActionPsIncSmall{} / \ActionPsDecSmall
 360         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncSmall{} / \ActionRCPsDecSmall}
 361         & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or 0.1
 362           semitone (in semitone mode).\\
 363         %
 364         \nopt{PBELL_VIBE500_PAD}{ % ther is no long scroll up or down because of slide
 365         \ActionPsIncBig{} / \ActionPsDecBig
 366         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncBig{} / \ActionRCPsDecBig}
 367         & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
 368           (in semitone mode).\\
 369         }
 370         %
 371         \ActionPsNudgeLeft{} / \ActionPsNudgeRight
 372         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsNudgeLeft{} / \ActionPsNudgeRight}
 373         & Temporarily change pitch by 2\% (beatmatch), or modify speed (in timestretch mode).\\
 374         %
 375         \ActionPsReset
 376         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsReset}
 377         & Reset pitch and speed to 100\%. \\
 378         %
 379         \ActionPsExit
 380         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsExit}
 381         & Leave the \setting{Pitch Screen}. \\
 382         %
 383       \end{btnmap}
 384     \end{table}
 385   }
 386
 387 }
 388
 389 %********************QUICKSCREENS***********************************************
 390 \opt{RECORDER_PAD}{
 391   \section{\label{ref:QuickScreens}Quick Screens}
 392   \screenshot{rockbox_interface/images/ss-quick-screen-112x64x1.png}{The F2 quick screen}{}
 393   \screenshot{rockbox_interface/images/ss-quick-screen2-112x64x1.png}{The F3 quick screen}{}
 394   Rockbox handles function buttons in a different way to the Archos software.
 395   \ButtonFOne\ is always bound to the menu function, while \ButtonFTwo\ and
 396   \ButtonFThree\ enable two quick screens.
 397
 398   \ButtonFTwo\ displays some browse and play settings which are likely to be
 399   changed frequently. This settings are Shuffle mode, Repeat mode and the Show
 400   files options
 401
 402   Shuffle mode plays each track in the currently playing list in a random order
 403   rather than in the order shown in the browser.
 404
 405   Repeat mode repeats either a single track (One) or the entire playlist (All).
 406
 407   Show files determines what type files can be seen in the browser.  This can be
 408   just MP3 files and directories (Music), Playlists, MP3 files and directories
 409   (Playlists), any files that Rockbox supports (Supported) or all files on the
 410   disk (All).
 411
 412   See \reference{ref:PlaybackOptions} for more information about these
 413   settings.
 414
 415   \begin{table}
 416     \begin{btnmap}{}{}
 417       \ButtonLeft & Control Shuffle mode setting. \\
 418       \ButtonRight & Control Repeat mode setting. \\
 419       \ButtonDown & Control Show file setting. \\
 420     \end{btnmap}
 421   \end{table}
 422
 423   \ButtonFThree\ controls frequently used display options.
 424
 425   Scroll bar turns the display of the Scroll bar on the left of the screen on
 426   or off.
 427
 428   Status bar turns the status display at the top of the screen on or off.
 429   Upside down inverts the screen so that the top of the display appears nearest
 430   to the buttons. This is sometimes useful when storing the \dap\ in a pocket.
 431   Key assignments swap over with the display orientation where it is logical
 432   for them to do so.
 433
 434   See \reference{ref:Displayoptions} for more information about these
 435   settings.
 436
 437   \begin{table}
 438     \begin{btnmap}{}{}
 439       \ButtonLeft & Control scroll bar display. \\
 440       \ButtonRight & Control status bar display. \\
 441       \ButtonDown & Control upside down screen setting. \\
 442     \end{btnmap}
 443   \end{table}
 444 }