manual/configure_rockbox/playback_options.tex

   1 % $Id$ %
   2 The \setting{Playback Settings} menu allows you to configure settings
   3 related to audio playback.
   4
   5 \section{Shuffle}
   6   Turning shuffle on will cause Rockbox to randomly re-order the
   7   playlist. Thus, to shuffle all of the audio files on the player, you first
   8   need to create a playlist containing all of them. For more information on
   9   creating playlists refer to \reference{ref:working_with_playlists}.\\
  10   Options: \setting{Yes}/\setting{No}.
  11   %
  12 \section{Repeat}
  13   Configures settings related to repeating of directories or playlists.\\
  14   Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle} /
  15   \setting{A-B}:
  16   \begin{description}
  17     %
  18   \item[Off]The current playlist will not repeat when it is finished.
  19     \note{If you have the \setting{Auto-Change Directory} option set to
  20       \setting{Yes}, Rockbox will move on to the next directory on your
  21       hard drive. If the \setting{Auto-Change Directory} option is set to
  22       \setting{No}, playback will stop when the current directory or
  23       playlist is finished.}
  24     %
  25   \item[All]The current playlist will repeat when it is finished.
  26
  27     %
  28   \item[One]Repeat one track over and over.
  29     %
  30   \item[Shuffle]When the current playlist has finished playing, it will
  31     be shuffled and then repeated.
  32     %
  33   \item[A-B]Repeats between two user defined points within a track,
  34     typically used by musicians when attempting to learn a piece of music.
  35     This option is more complicated to use than the others as the \dap\
  36     must first be placed into A-B repeat mode and then the start and end
  37     points defined.\\
  38
  39     \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IRIVER_H10_PAD,MROBE100_PAD%
  40         ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{%
  41         To set the Start Point (A) press \ActionWpsAbSetAPrevDir{}.
  42         Setting the End Point (B) is done accordingly using
  43         \ActionWpsAbSetBNextDir{}.  To reset the markers press \ActionWpsAbReset{}.
  44     }%
  45     \opt{ipod,IAUDIO_X5_PAD,ONDIO_PAD,PLAYER_PAD}{%
  46         To set the Start Point (A) press \ActionWpsBrowse{}. The following
  47         press of \ActionWpsBrowse{} will set the End Point (B), and a third
  48         successive \ActionWpsBrowse{} will reset the markers.
  49     }%
  50   \end{description}
  51
  52 \section{Play Selected First}
  53   This setting controls what happens when you
  54   select a file for playback while shuffle mode is on. If the
  55   \setting{Play Selected First} setting is \setting{Yes}, the file you
  56   selected will be played first. If this setting is \setting{No}, a random
  57   file in the directory will be played first.
  58
  59 \section{Fast-Forward/Rewind}
  60   These settings control the speed and acceleration during fast forward and rewind.
  61   The setting \setting{FF/RW Min Step} controls the initial speed and \setting{FF/RW Accel} controls the acceleration.
  62
  63 \section{Anti-Skip Buffer}
  64   This setting allows you to control how much music is
  65   stored in the \daps{} memory whilst playing a song, acting as a buffer
  66   against shock or playback problems. The \dap{} transfers the selected
  67   amount of the forthcoming song into its memory at high speed whilst you are
  68   playing the song. It keeps a ``rolling'' buffer, which keeps feeding more
  69   of the forthcoming song into memory as it goes along.
  70   If the \dap{} is knocked, shaken or jogged heavily while Rockbox is trying
  71   to read the hard drive, Rockbox might not be able to read the drive.
  72   Rockbox will retry over and over again until it succeeds, but may
  73   eventually reach the end of the memory buffer. When that happens, Rockbox
  74   must stop playing and wait for more data from the disk, which causes your
  75   music to skip. The anti-skip setting tells Rockbox how much extra buffer
  76   memory to spare to handle this situation. This setting therefore allows you
  77   to reduce the chances of there being a gap or pause during playback of
  78   songs.
  79
  80   \nopt{ondio}{
  81     \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7
  82       seconds.}
  83   }%
  84   \opt{ondio}{
  85     The anti-skip buffer can safely be kept at zero. It will eventually be
  86     eliminated.
  87   }%
  88   \opt{swcodec}{The anti-skip buffer can be set to various values between
  89     5 seconds and 10 minutes.}%
  90
  91   \note{Having a large anti-skip buffer tends to use more power, and may
  92     reduce your battery life. It is recommended to always use the lowest
  93     possible setting that allows correct and continuous playback.}
  94
  95 \section{Fade on Stop/Pause}
  96   Enables and disables a fade effect when you
  97   pause or stop playing a song. If the Fade on Stop/Pause option is
  98   set to \setting{Yes}, your music will fade out when you stop or pause
  99   playback, and fade in when you resume playback.
 100
 101 \section{Party Mode}
 102   Enables unstoppable music playback. When new songs are
 103   selected, they are queued at the end of the current dynamic playlist
 104   instead of being played immediately. Pausing and stopping playback is
 105   disabled as well as skipping songs and launching plugins.
 106
 107 \opt{swcodec}{
 108   \section{Crossfade}
 109     This setting enables a cross-fader. At the end of a song, the song will
 110     fade out as the next song fades in, creating a smooth transition between
 111     songs. The crossfade setting is particularly effective when the player is
 112       set on shuffle.\\
 113
 114     Options for crossfade settings are:
 115     \begin{description}
 116       \item[Enable Crossfade]If set to \setting{Off}, crossfade is disabled.
 117         If set to \setting{Always}, songs will always crossfade into one
 118         another. If set to \setting{Shuffle}, crossfade is enabled when the
 119         shuffle feature is set to \setting{Yes}, but disabled otherwise. If set
 120         to track skip only, tracks will only crossfade when you manually change
 121         tracks.
 122         %
 123       \item[Fade In Delay]The ``fade in delay'' is the length of time between
 124         when the crossfade process begins and when the new track begins to fade
 125         in.
 126         %
 127       \item[Fade In Duration]The length of time, in seconds, that it takes
 128         your music to fade in once the \setting{Fade In Delay} has ended.
 129         %
 130       \item[Fade Out Delay]The ``fade out delay'' is the length of time
 131         between when the crossfade process begins and when the old track begins
 132         to fade out.
 133         %
 134       \item[Fade Out Duration]The length of time, in seconds, that it takes
 135         your music to fade out once the \setting{Fade Out Delay} has ended.
 136         %
 137       \item[Fade Out Mode]If set to \setting{Crossfade}, one song will fade
 138         out and the next song will simultaneously fade in. If set to
 139         \setting{Mix}, the ending song will continue to play as normal until
 140         its end, while the starting song will fade in from under it.
 141         \setting{Mix} mode is not
 142         used for manual track skips, even if it is selected here.
 143       \end{description}
 144
 145       \note{The rules above apply except in the instance where
 146           \setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then
 147           \setting{Fade In Delay} (which would create a gap in the audio). In this case,
 148           the \setting{Fade In Delay} is reduced to eliminate the gap.}
 149
 150           The graphic below illustrates how the different settings work in practice.
 151
 152          \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png}
 153
 154   \section{Replaygain}
 155     This allows you to control the replaygain function.
 156     The purpose of replaygain is to adjust the volume of the music played
 157     so that all songs (or albums, depending on your settings) have the
 158     same apparent volume. This prevents sudden changes in volume when
 159     changing between songs recorded at different volume levels.
 160     For replaygain to work, the songs must have been processed by a program
 161     that adds replaygain information to the ID3 tags (or Vorbis tags).
 162     \note{APEv2 tags are not currently supported.}
 163
 164     Options for replaygain are:
 165     \begin{description}
 166       \item[Enable Replaygain]This turns on/off the replaygain function.
 167         %
 168       \item[Prevent Clipping]Avoid clipping of a song's waveform.
 169         If a song would clip during playback, the volume is lowered for
 170         that song. Replaygain information is needed for this to work.
 171         %
 172       \item[Replaygain Type]Choose the type of replaygain to apply:
 173         \begin{description}
 174         \item[Album Gain]Maintain a constant volume level between
 175           albums, but keep any intentional volume variations between
 176           songs in an album. (If album gain value is not available,
 177           uses track gain information).
 178           %
 179         \item[Track Gain]Maintain a constant volume level between
 180           tracks. If track gain value is not available, no replaygain
 181           is applied.
 182           %
 183         \item[Track Gain If Shuffling]Maintains a constant volume
 184           between tracks if \setting{Shuffle} is set to \setting{Yes}.
 185           Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
 186         \end{description}
 187         %
 188       \item[Pre-amp]This allows you to adjust the volume when replaygain
 189         is applied. Replaygain often lowers the volume, sometimes quite
 190         much, so here you can compensate for that. Please note that a
 191         (large) positive pre-amp setting can cause clipping, unless
 192         prevent clipping is enabled.  The pre-amp can be set to any
 193         decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB.
 194       \end{description}
 195
 196   \section{Beep Volume}
 197     Controls the volume of the beep that is heard when
 198     skipping forward or backward between tracks. The beep is disabled when
 199     set to \setting{Off}.
 200 }%\opt{swcodec}
 201
 202 \opt{spdif_power}{
 203   \section{Optical Output}
 204     Enables or disables the optical S/PDIF output to
 205     allow a digital connection to a suitable external decoder.  To enable
 206     optical output, set to \setting{Yes}
 207 }
 208
 209 \section{Auto-Change Directory}
 210   Control what Rockbox does when it reaches the end
 211   of a directory. If \setting{Auto-Change Directory} is set to \setting{Yes},
 212   Rockbox will continue to the next directory. If
 213   \setting{Auto-Change Directory} is set to \setting{No}, playback will stop at
 214   the end of the current playlist.  Using the \setting{Random} feature requires
 215   you to first generate a folder list via the Random Folder Advance Configuration
 216   plugin (see \reference{ref:random_folder_advance_config}).
 217   \note{You must have the \setting{Repeat} option set to \setting{No} for
 218     \setting{Auto-Change Directory} to function properly.}
 219   \note{This feature only works when songs have been played from the file
 220     browser.  Using it with the database may cause unexpected behavior.}
 221
 222   %
 223 \opt{headphone_detection}{
 224 \section{Pause on Headphone Unplug}
 225   Enables and disables automatic pausing of
 226   playback when the headphones are disconnected from the \daps{} headphone
 227   socket.
 228   %
 229   \begin{description}
 230   \item[Pause on Headphone Unplug]Options for automatic pause:
 231     \begin{description}
 232     \item[Off.] Disables automatic pause.
 233       %
 234     \item[Pause.] Pauses the \dap{} when the headphones are removed.
 235       %
 236     \item[Pause and Resume.] Pauses when the headphones are removed, and
 237       resumes playback when they are reconnected.
 238   \end{description}
 239   \item[Duration to Rewind] Number of seconds (between 0 and 15) to rewind
 240     playback when the headphones are removed.
 241     %
 242   \item[Disable Auto-Resume If Phones Not Present] This option will disable
 243     the automatic resumption of playback at startup if the headphones are not
 244     connected to the \dap{}.
 245     \note{This requires \setting{Resume on Startup} to be enabled.}
 246   \end{description}
 247
 248 }%
 249
 250 \section{Last.fm Log}\index{Last.fm Log}\index{Audioscrobbler|see{Last.fm Log}}
 251   Enables logging of your played tracks for submittal to
 252   \url{http://www.last.fm}. This service was formely known as
 253   \emph{Audioscrobbler}. When you enable this option, you'll have to reboot to
 254   start the logging. The log-file is called
 255   \opt{rtc}{\fname{.scrobbler.log},}%
 256   \nopt{rtc}{\fname{.scrobbler-timeless.log},}%
 257   and is to be found in the root directory of your \dap{}.
 258   \note{See \wikilink{LastFMLog} for a further description, and for tools you
 259     can use to submit your Last.fm log.}
 260
 261 \section{Cuesheet Support}\index{Cuesheet Support}
 262   Enables reading of cuesheet files for played tracks. If a cuesheet is found
 263   for a track, track markers are displayed on the progressbar and it is
 264   possible to skip between the tracks within the cuesheet. Also the information
 265   found in the cuesheet file will replace the information from the ID3 tags.
 266   When you enable this option, you'll have to reboot for it to come into
 267   effect.
 268
 269 \section{Skip Length}\index{Skip Length}
 270   Designed to speed up navigation and prevent unintentional track skipping when
 271   listening to long audio tracks, \setting{Skip Length} changes the behavior of
 272   the \ActionWpsSkipPrev{} and \ActionWpsSkipNext{} buttons so that they skip
 273   by a given number of minutes instead of skipping to a new track.
 274
 275   \note{To skip tracks with this setting set to a time interval, press Short
 276     \ActionWpsSkipPrev{} + Long \ActionWpsSkipNext{} to go forward and Short
 277     \ActionWpsSkipNext{} + Long \ActionWpsSkipPrev{} to go back.}
 278