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{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}.\\%
 138       }%
 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}{
 145         &
 146           \opt{IRIVER_RC_H100_PAD}{\ActionRCWpsAbSetBNextDir{} or}
 147         Short \ActionRCWpsSkipNext{} + Long \ActionRCWpsSkipNext}
 148       & Skip to the next directory.\\
 149       %
 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}{
 155         &
 156           \opt{IRIVER_RC_H100_PAD}{\ActionRCWpsAbSetAPrevDir{} or}
 157         Short \ActionRCWpsSkipPrev{} + Long \ActionRCWpsSkipPrev}
 158       & Skip to the previous directory.\\
 159       %
 160       \opt{SANSA_E200_PAD,SANSA_C200_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{
 161         \ActionStdRec
 162           \opt{HAVEREMOTEKEYMAP}{&}
 163           & Switch to the \setting{Recording Screen}.\\
 164       }%
 165     \end{btnmap}
 166 \end{table}
 167
 168
 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}.
 176   }
 177
 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.
 191     }
 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}
 201 }
 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:
 205
 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 \ActionStdContext{} while viewing the current
 210 playlist to bring up the \setting{Playlist Viewer Menu}. In this menu, you
 211 can find the \setting{Playlist Viewer Settings}.
 212
 213 \subsubsection{Playlist Viewer Settings}
 214   \begin{description}
 215     \item[Show Icons.] This toggles display of the icon for the currently
 216     selected playlist entry and the icon for moving a playlist entry
 217     \item[Show Indicies.] This toggles display of the line numbering for
 218        the playlist
 219     \item[Track Display.] This toggles between filename only and full path
 220        for playlist entries
 221     \item[Save Current Playlist.] Allows the current playlist to be saved as
 222        a \fname{.m3u8} playlist file
 223   \end{description}
 224
 225
 226 \subsubsection{Playlist catalog}
 227   \begin{description}
 228     \item [View catalog.] This lists all playlists that are part of the
 229     Playlist catalog. You can load a new playlist directly from this list.
 230     \item [Add to playlist.] Adds the currently playing file to a playlist.
 231     Select the playlist you want the file to be added to and it will get
 232     appended to that playlist.
 233     \item [Add to new playlist.] Similar to the previous entry this will
 234     add the currently playing track to a playlist. You need to enter a name
 235     for the new playlist first.
 236   \end{description}
 237
 238 \subsubsection{Sound Settings}
 239 This is a shortcut to the \setting{Sound Settings Menu}, where you can configure volume,
 240 bass, treble, and other settings affecting the sound of your music.
 241 See \reference{ref:configure_rockbox_sound} for more information.
 242
 243 \subsubsection{Playback Settings}
 244 This is a shortcut to the \setting{Playback Settings Menu}, where you can configure shuffle,
 245 repeat, party mode, study mode and other settings affecting the playback of your music.
 246
 247 \subsubsection{Rating}
 248 The menu entry is only shown if \setting{Gather Runtime Information} is
 249 enabled. It allows the asignment of a personal rating value (0 -- 10)
 250 to a track which can be displayed in the WPS and used in the Database
 251 browser. The value wraps at 10.
 252
 253 \subsubsection{Bookmarks}
 254 This allows you to create a bookmark in the currently-playing track.
 255
 256 \subsubsection{\label{ref:trackinfoviewer}Show Track Info}
 257 \screenshot{rockbox_interface/images/ss-id3-viewer}{The track info viewer}{}
 258 This screen is accessible from the WPS screen, and provides a detailed view of
 259 all the identity information about the current track. This info is known as
 260 meta data and is stored in audio file formats to keep information on artist,
 261 album etc. To access this screen, %
 262 \opt{PLAYER_PAD,RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,%
 263       MROBE100_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,%
 264       GIGABEAT_PAD,GIGABEAT_S_PAD}{
 265   press \ActionWpsIdThreeScreen. }%
 266 \opt{ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IAUDIO_X5_PAD,IAUDIO_M3_PAD}{press
 267   \ActionWpsContext{} to access the \setting{WPS Context Menu} and select
 268   \setting{Show Track Info}. }%
 269 \opt{RECORDER_PAD,PLAYER_PAD,ONDIO_PAD}{Use \ButtonLeft\ and \ButtonRight\
 270   to move through the information.}%
 271
 272 \subsubsection{Open With...}
 273 This \setting{Open With} function is the same as the \setting{Open With}
 274 function in the file browser's \setting{Context Menu}.
 275
 276 \subsubsection{Delete}
 277 Delete the currently playing file. The file will be deleted but the playback
 278 of the file will not stop immediately. Instead, the part of the file that
 279 has already been buffered (i.e. read into the \daps\ memory) will be played.
 280 This may even be the whole track.
 281
 282 \opt{pitchscreen}{
 283   \subsubsection{\label{sec:pitchscreen}Pitch}
 284
 285   The \setting{Pitch Screen} allows you to change the rate of playback
 286   (i.e. the playback speed and at the same time the pitch) of your
 287   \dap. The rate value can be adjusted between 50\% and 200\%. 50\%
 288   means half the normal playback speed and a pitch that is an octave
 289   lower than the normal pitch. 200\% means double playback speed and a
 290   pitch that is an octave higher than the normal pitch.
 291
 292   The rate can be changed in two modes: procentual and semitone.
 293   Initially, procentual mode is active.
 294
 295   \opt{swcodec}{
 296     If you've enabled the \setting{Timestretch} option in
 297     \setting{Sound Settings} and have since rebooted, you can also use
 298     timestretch mode. This allows you to change the playback speed
 299     without affecting the pitch, and vice versa.
 300
 301     In timestretch mode there are separate displays for pitch and
 302     speed, and each can be altered independently.  Due to the
 303     limitations of the algorithm, speed is limited to be between 35\%
 304     and 250\% of the current pitch value.  Pitch must maintain the
 305     same ratio as well as remain between 50\% and 200\%.
 306   }
 307
 308   The value of the \opt{swcodec}{rate, pitch and speed}\nopt{swcodec}{rate}
 309   is not persisted, i.e. after the \dap\ is turned on it will
 310   always be set to 100\%.
 311
 312   \nopt{swcodec}{
 313     \begin{table}
 314       \begin{btnmap}{}{}
 315         \ActionPsToggleMode
 316         & Toggle pitch changing mode. \\
 317         %
 318         \ActionPsIncSmall{} / \ActionPsDecSmall
 319         & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or by 0.1
 320           semitone (in semitone mode).\\
 321         %
 322         \ActionPsIncBig{} / \ActionPsDecBig
 323         & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
 324           (in semitone mode).\\
 325         %
 326         \ActionPsNudgeLeft{} / \ActionPsNudgeRight
 327         & Temporarily change pitch by 2\% (beatmatch). \\
 328         %
 329         \ActionPsReset
 330         & Reset rate to 100\%. \\
 331         %
 332         \ActionPsExit
 333         & Leave the \setting{Pitch Screen}. \\
 334         %
 335       \end{btnmap}
 336     \end{table}
 337
 338     \warn{Changing the pitch can cause audible 'Artifacts' or 'Dropouts'.}
 339   }
 340
 341   \opt{swcodec}{
 342     \begin{table}
 343       \begin{btnmap}{}{}
 344         \ActionPsToggleMode
 345         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsToggleMode}
 346         & Toggle pitch changing mode (cycle through all available modes).\\
 347         %
 348         \ActionPsIncSmall{} / \ActionPsDecSmall
 349         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncSmall{} / \ActionRCPsDecSmall}
 350         & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or 0.1
 351           semitone (in semitone mode).\\
 352         %
 353         \ActionPsIncBig{} / \ActionPsDecBig
 354         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncBig{} / \ActionRCPsDecBig}
 355         & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
 356           (in semitone mode).\\
 357         %
 358         \ActionPsNudgeLeft{} / \ActionPsNudgeRight
 359         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsNudgeLeft{} / \ActionPsNudgeRight}
 360         & Temporarily change pitch by 2\% (beatmatch), or modify speed (in timestretch mode).\\
 361         %
 362         \ActionPsReset
 363         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsReset}
 364         & Reset pitch and speed to 100\%. \\
 365         %
 366         \ActionPsExit
 367         \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsExit}
 368         & Leave the \setting{Pitch Screen}. \\
 369         %
 370       \end{btnmap}
 371     \end{table}
 372   }
 373
 374 }
 375
 376 %********************QUICKSCREENS***********************************************
 377 \opt{RECORDER_PAD}{
 378   \section{\label{ref:QuickScreens}Quick Screens}
 379   \screenshot{rockbox_interface/images/ss-quick-screen-112x64x1.png}{The F2 quick screen}{}
 380   \screenshot{rockbox_interface/images/ss-quick-screen2-112x64x1.png}{The F3 quick screen}{}
 381   Rockbox handles function buttons in a different way to the Archos software.
 382   \ButtonFOne\ is always bound to the menu function, while \ButtonFTwo\ and
 383   \ButtonFThree\ enable two quick screens.
 384
 385   \ButtonFTwo\ displays some browse and play settings which are likely to be
 386   changed frequently. This settings are Shuffle mode, Repeat mode and the Show
 387   files options
 388
 389   Shuffle mode plays each track in the currently playing list in a random order
 390   rather than in the order shown in the browser.
 391
 392   Repeat mode repeats either a single track (One) or the entire playlist (All).
 393
 394   Show files determines what type files can be seen in the browser.  This can be
 395   just MP3 files and directories (Music), Playlists, MP3 files and directories
 396   (Playlists), any files that Rockbox supports (Supported) or all files on the
 397   disk (All).
 398
 399   See \reference{ref:PlaybackOptions} for more information about these
 400   settings.
 401
 402   \begin{table}
 403     \begin{btnmap}{}{}
 404       \ButtonLeft & Control Shuffle mode setting. \\
 405       \ButtonRight & Control Repeat mode setting. \\
 406       \ButtonDown & Control Show file setting. \\
 407     \end{btnmap}
 408   \end{table}
 409
 410   \ButtonFThree\ controls frequently used display options.
 411
 412   Scroll bar turns the display of the Scroll bar on the left of the screen on
 413   or off.
 414
 415   Status bar turns the status display at the top of the screen on or off.
 416   Upside down inverts the screen so that the top of the display appears nearest
 417   to the buttons. This is sometimes useful when storing the \dap\ in a pocket.
 418   Key assignments swap over with the display orientation where it is logical
 419   for them to do so.
 420
 421   See \reference{ref:Displayoptions} for more information about these
 422   settings.
 423
 424   \begin{table}
 425     \begin{btnmap}{}{}
 426       \ButtonLeft & Control scroll bar display. \\
 427       \ButtonRight & Control status bar display. \\
 428       \ButtonDown & Control upside down screen setting. \\
 429     \end{btnmap}
 430   \end{table}
 431 }