Next part of FS#9086: Add a description of the crossfade settings to the playback...

[kugel-rb.git] / manual / configure_rockbox / playback_options.tex

% $Id$ %
\section{\label{ref:PlaybackOptions}Playback}
The \setting{Playback} sub menu allows you to configure settings
related to audio playback.
\begin{description}
\item[Shuffle]Turning shuffle on will cause Rockbox to randomly re-order the
  playlist. Thus, to shuffle all of the audio files on the player, you first
  need to create a playlist containing all of them. For more information on
  creating playlists refer to \reference{ref:working_with_playlists}.\\
  Options: \setting{Yes}/\setting{No}.
  %
\item[Repeat]Configures settings related to repeating of directories or
  playlists.\\
  Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle}
  \nopt{ondiosp,ondiofm}{\setting{/A-B}}:
  \begin{description}
    %
  \item[Off]The current playlist will not repeat when it is finished.
    \note{If you have the \setting{Auto-Change Directory} option set to
      \setting{Yes}, Rockbox will move on to the next directory on your
      hard drive. If the \setting{Auto-Change Directory} option is set to
      \setting{No}, playback will stop when the current directory or
      playlist is finished.}
    %
  \item[All]The current playlist will repeat when it is finished.

    %
  \item[One]Repeat one track over and over.
    %
  \item[Shuffle]When the current playlist has finished playing, it will
    be shuffled and then repeated.
    %
    \nopt{ondiosp,ondiofm}{
    \item[A-B]Repeats between two user defined points within a track,
      typically used by musicians when attempting to learn a piece of music.
      This option is more complicated to use than the others as the \dap\
      must first be placed into A-B repeat mode and then the start and end
      points defined.\\
      \opt{RECORDER_PAD}{
          To set the Start Point (A) hold \ButtonOn{} and press \ButtonLeft{}.
          Setting the End Point (B) is done accordingly using
          \ButtonOn{} and \ButtonRight{}.
          To reset the markers hold \ButtonOn{} and press \ButtonOff{}.
      }
      \opt{h10,h10_5gb}{
          Hold \ButtonPower{} and press \ButtonRew{} to set the Start Point (A).
          For setting the End Point (B) hold \ButtonPower{} and press \ButtonFF{}.
          You can reset the markers by pressing \ButtonPower{} and \ButtonPlay{}.
      }
      \opt{ipod,x5}{
          To set the Start Point (A) press \ButtonSelect{}. The following
          press of \ButtonSelect{} will set the End Point (B), and a third
          successive \ButtonSelect{} will reset the markers.
      }
      \opt{h1xx,h300}{
          To set the Start Point (A) hold \ButtonOn{} and press \ButtonLeft{}.
          Setting the End Point (B) is done accordingly using
          \ButtonOn{} and \ButtonRight{}.
          To reset the markers hold \ButtonOn{} and press \ButtonSelect{}.
      }
      \opt{sansa}{
          To set the Start Point (A) hold \ButtonPower{} and press \ButtonLeft{}.
          Setting the End Point (B) is done accordingly using
          \ButtonPower{} and \ButtonRight{}.
          To reset the markers hold \ButtonPower{} and press \ButtonUp{}.
      }
      \opt{gigabeatf}{
          To set the Start Point (A) hold \ButtonA{} and press \ButtonLeft{}.
          Setting the End Point (B) is done accordingly using
          \ButtonA{} and \ButtonRight{}.
          To reset the markers hold \ButtonA{} and press \ButtonSelect{}.
      }
      \opt{MROBE100_PAD}{
          To set the Start Point (A) hold \ButtonDisplay{} and press \ButtonLeft{}.
          Setting the End Point (B) is done accordingly using
          \ButtonDisplay{} and \ButtonRight{}.
          To reset the markers hold \ButtonDisplay{} and press \ButtonSelect{}.
      }
      \opt{gigabeats}{
          To set the Start Point (A) hold \ButtonBack{} and press \ButtonLeft{}.
          Setting the End Point (B) is done accordingly using
          \ButtonBack{} and \ButtonRight{}.
          To reset the markers \ButtonBack{} and press \ButtonSelect{}.
      }
      \nopt{h1xx,h300,h10,h10_5gb,ipod,x5,e200,gigabeatf,RECORDER_PAD,MROBE100_PAD,gigabeats}{
        \fixme{
          --- Sets Start Point (A)\\
          --- Sets End Point (B)\\
        }
      }
    }
  \end{description}

\item[Play Selected First]This setting controls what happens when you
  select a file for playback while shuffle mode is on. If the
  \setting{Play Selected First} setting is \setting{Yes}, the file you
  selected will be played first. If this setting is \setting{No}, a random
  file in the directory will be played first.

  \item[Fast-Forward/Rewind]How fast you want search (fast forward or rewind)
    to accelerate when you hold down the button. \setting{Off} means no 
    acceleration. \setting{2x/1s} means double the search speed once every 
    second the button is held. \setting{2x/5s} means double the search speed 
    once every 5 seconds the button is held.

  \item[Anti-Skip Buffer]This setting allows you to control how much music is
    stored in the \daps{} memory whilst playing a song, acting as a buffer
    against shock or playback problems. The \dap{} transfers the selected
    amount of the forthcoming song into its memory at high speed whilst you are
    playing the song. It keeps a ``rolling'' buffer, which keeps feeding more
    of the forthcoming song into memory as it goes along.
    If the \dap{} is knocked, shaken or jogged heavily while Rockbox is trying
    to read the hard drive, Rockbox might not be able to read the drive.
    Rockbox will retry over and over again until it succeeds, but may
    eventually reach the end of the memory buffer. When that happens, Rockbox
    must stop playing and wait for more data from the disk, which causes your
    music to skip. The anti-skip setting tells Rockbox how much extra buffer
    memory to spare to handle this situation. This setting therefore allows you
    to reduce the chances of there being a gap or pause during playback of
    songs.
    
    \nopt{ondio}{
      \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7
        seconds.}
    }%
    \opt{ondio}{
      The anti-skip buffer can safely be kept at zero. It will eventually be 
      eliminated.
    }%
    \opt{swcodec}{The anti-skip buffer can be set to various values between
      5 seconds and 10 minutes.}%
    
    \note{Having a large anti-skip buffer tends to use more power, and may
      reduce your battery life. It is recommended to always use the lowest
      possible setting that allows correct and continuous playback.}
    
  \item[Fade on Stop/Pause]Enables and disables a fade effect when you
    pause or stop playing a song. If the Fade on Stop/Pause option is
    set to \setting{Yes}, your music will fade out when you stop or pause 
    playback, and fade in when you resume playback.
    
  \item[Party Mode]Enables unstoppable music playback. When new songs are
    selected, they are queued at the end of the current dynamic playlist
    instead of being played immediately. Pausing and stopping playback is
    disabled as well as skipping songs and launching plugins.

    \opt{swcodec}{
    \item[Crossfade]
      This setting enables a cross-fader. At the end of a song, the song will 
      fade out as the next song fades in, creating a smooth transition between 
      songs. The crossfade setting is particularly effective when the player is 
        set on shuffle.\\

      Options for crossfade settings are:
      \begin{description}
      \item[Enable Crossfade]If set to \setting{Off}, crossfade is disabled.
        If set to \setting{Always}, songs will always crossfade into one
        another. If set to \setting{Shuffle}, crossfade is enabled when the
        shuffle feature is set to \setting{Yes}, but disabled otherwise. If set
        to track skip only, tracks will only crossfade when you manually change
        tracks.
        %
      \item[Fade In Delay]The ``fade in delay'' is the length of time between
        when the crossfade process begins and when the new track begins to fade
        in.
        %
      \item[Fade In Duration]The length of time, in seconds, that it takes
        your music to fade in once the \setting{Fade In Delay} has ended.
        %
      \item[Fade Out Delay]The ``fade out delay'' is the length of time
        between when the crossfade process begins and when the old track begins
        to fade out.
        %
      \item[Fade Out Duration]The length of time, in seconds, that it takes
        your music to fade out once the \setting{Fade Out Delay} has ended.
        %
      \item[Fade Out Mode]If set to \setting{Crossfade}, one song will fade
        out and the next song will simultaneously fade in. If set to 
        \setting{Mix}, the ending song will continue to play as normal until 
        its end, while the starting song will fade in from under it. 
        \setting{Mix} mode is not
        used for manual track skips, even if it is selected here.
      \end{description}
      
      \note{The rules above apply except in the instance where
          \setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then
          \setting{Fade In Delay} (which would create a gap in the audio). In this case,
          the \setting{Fade In Delay} is reduced to eliminate the gap.}

          The graphic below illustrates how the different settings work in practice.

         \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png}
    }%
    
    \opt{swcodec}{
    \item[Replaygain]This allows you to control the replaygain function.
      The purpose of replaygain is to adjust the volume of the music played
      so that all songs (or albums, depending on your settings) have the
      same apparent volume. This prevents sudden changes in volume when
      changing between songs recorded at different volume levels.
      For replaygain to work, the songs must have been processed by a program
      that adds replaygain information to the ID3 tags (or Vorbis tags).
      \note{APEv2 tags are not currently supported.}
      
      Options for replaygain are:
      \begin{description}
      \item[Enable Replaygain]This turns on/off the replaygain function.
        %
      \item[Prevent Clipping]Avoid clipping of a song's waveform.
        If a song would clip during playback, the volume is lowered for 
        that song. Replaygain information is needed for this to work.
        %
      \item[Replaygain Type]Choose the type of replaygain to apply:
        \begin{description}
        \item[Album Gain]Maintain a constant volume level between
          albums, but keep any intentional volume variations between 
          songs in an album. (If album gain value is not available,
          uses track gain information).
          %
        \item[Track Gain]Maintain a constant volume level between
          tracks. If track gain value is not available, no replaygain 
          is applied.
          %
        \item[Track Gain If Shuffling]Maintains a constant volume
          between tracks if \setting{Shuffle} is set to \setting{Yes}.
          Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
        \end{description}
        %
      \item[Pre-amp]This allows you to adjust the volume when replaygain
        is applied. Replaygain often lowers the volume, sometimes quite
        much, so here you can compensate for that. Please note that a
        (large) positive pre-amp setting can cause clipping, unless
        prevent clipping is enabled.  The pre-amp can be set to any
        decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB.
      \end{description}
    }
    \opt{swcodec}{
      \item[Beep Volume]Controls the volume of the beep that is heard when
        skipping forward or backward between tracks. The beep is disabled when
        set to \setting{Off}.
    }

    \opt{spdif_power}{
      \item[Optical Output. ]Enables or disables the optical S/PDIF output to 
         allow a digital connection to a suitable external decoder.  To enable
         optical output, set to \setting{Yes}
    }

\item[Auto-Change Directory]Control what Rockbox does when it reaches the end
  of a directory. If \setting{Auto-Change Directory} is set to \setting{Yes},
  Rockbox will continue to the next directory. If
  \setting{Auto-Change Directory} is set to \setting{No}, playback will stop at
  the end of the current playlist.  Using the \setting{Random} feature requires
  you to first generate a folder list via the Random Folder Advance Configuration
  plugin (see \reference{ref:random_folder_advance_config}).
  \note{You must have the \setting{Repeat} option set to \setting{No} for
    \setting{Auto-Change Directory} to function properly.}
  \note{This feature only works when songs have been played from the file
    browser.  Using it with the database may cause unexpected behavior.}

  %
\opt{headphone_detection}{
\item[Pause on Headphone Unplug] Enables and disables automatic pausing of 
  playback when the headphones are disconnected from the \daps{} headphone 
  socket.
  %
  \begin{description}
  \item[Pause on Headphone Unplug]Options for automatic pause:
    \begin{description}
    \item[Off.] Disables automatic pause.
      %
    \item[Pause.] Pauses the \dap{} when the headphones are removed.
      %
    \item[Pause and Resume.] Pauses when the headphones are removed, and 
      resumes playback when they are reconnected.
  \end{description}
  \item[Duration to Rewind] Number of seconds (between 0 and 15) to rewind 
    playback when the headphones are removed.
    %
  \item[Disable Auto-Resume If Phones Not Present] This option will disable 
    the automatic resumption of playback at startup if the headphones are not 
    connected to the \dap{}.
    \note{This requires \setting{Resume on Startup} to be enabled.}
  \end{description}

}%

\item[Last.fm Log]\index{Last.fm Log}\index{Audioscrobbler|see{Last.fm Log}}
  Enables logging of your played tracks for submittal to 
  \url{http://www.last.fm}. This service was formely known as 
  \emph{Audioscrobbler}. When you enable this option, you'll have to reboot to
  start the logging. The log-file is called 
  \opt{rtc}{\fname{.scrobbler.log},}%
  \nopt{rtc}{\fname{.scrobbler-timeless.log},}%
  and is to be found in the root directory of your \dap{}.
  \note{See \wikilink{LastFMLog} for a further description, and for tools you 
    can use to submit your Last.fm log.}

\item[Cuesheet Support]\index{Cuesheet Support}
  Enables reading of cuesheet files for played tracks. If a cuesheet is found
  for a track, track markers are displayed on the progressbar and it is
  possible to skip between the tracks within the cuesheet. Also the information
  found in the cuesheet file will replace the information from the ID3 tags.
  When you enable this option, you'll have to reboot for it to come into
  effect.

\end{description}