Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Patch #5038 by Mark Bright - Rewrite playback options section.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9551 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Michael DiFebbo 2006-04-07 17:14:14 +00:00
parent 71fe062e3d
commit 1aa57ddd26
1 changed files with 153 additions and 68 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

221
manual/configure_rockbox/playback_options.tex
View file

@ -1,80 +1,165 @@
\section{\label{ref:PlaybackOptions}Playback Options}
The ``Playback Options'' submenu allows you to configure settings related to audio playback.
\begin{description}
\item[Shuffle: ]Alters how Rockbox will select which next song to play.\\
Options: On/Off.
%
\item[Repeat: ]Configures settings related to repeating of directories or playlists.\\
Options: Off/All/One/Shuffle/A--B:
\begin{description}
%
\item[Off: ]The current directory or playlist will not repeat
when it is finished.\\
\note{Note: If you have the ``Auto change directory'' option set to ``Yes,''
Rockbox will move on to the next directory on your hard drive. If the ``Auto
change directory'' option is set to ``No,'' playback will stop when the current
directory or playlist is finished.}
%
\item[All: ]The current directory or playlist will repeat when it is finished.\\
\note{Note: this option does \emph{not} shuffle all files on your \dap.
Rockbox is playlist oriented. When you play a song, or a directory, or an album,
Rockbox creates a playlist and plays it. Thus, to shuffle all songs on the \dap,
you need to create a playlist of all songs on the player, and play that playlist
with shuffle mode set to ``All.''}
%
\item[One: ]Repeat one track over and over.
%
\item[Shuffle: ]When the current directory or playlist has finished playing, it
will be shuffled and then repeated.
%
\item[A--B: ]Repeats between two user defined point within a track, typically
used by musicians when attempting to learn a piece of music.\\
This option is more complicated to use that the others as the \dap\ must first be
placed into A--B repeat mode and then the start and end points defined.\\
\fixme{
Hold Play and press Left --- Sets Start Point (A)\\
Hold Play and press Right --- Sets End Point (B)\\
}
\end{description}
\begin{itemize}
\item \textbf{Shuffle}
Select shuffle ON/OFF. This alters how Rockbox will select which next song to play.
\item \textbf{Repeat}
The ``Repeat'' setting is for configuring settings related to repeating of directories or playlists. Repeat modes are Off/One/All/Shuffle:
\begin{itemize}
\item \textbf{Off: }``Off'' means that the current directory or playlist will not repeat when it is finished. (Note: If you have the ``Auto change directory'' option set to ``Yes,'' Rockbox will move on to the next directory on your hard drive. If the ``Auto change directory'' option is set to ``No,'' playback will stop when the current directory or playlist is finished.)
\item\textbf{One: }``One'' means repeat one track over and over.
\item\textbf{All: } ``All'' means that the current directory or playlist will repeat when it is finished. (Note: this option does \textbf{not} shuffle all files on your \dap. Rockbox is playlist oriented. When you play a song, or a directory, or an album, Rockbox creates a playlist and plays it. Thus, to shuffle all songs on the player, you need to create a playlist of all songs on the player, and play that playlist with shuffle mode set to ``All.'')
\item\textbf{Shuffle: }``Shuffle'' means that when the current directory or playlist has finished playing, it will be shuffled and then repeated.
\end{itemize}
\item[Play Selected First: ]This setting controls what happens when you select a file
for playback while shuffle mode is on. If the Play Selected First setting is
``Yes,'' the file you selected will be played first. If this setting is ``No,''
a random file in the directory will be played first.
\item[Resume: ]Rockbox can be configured to start playing automatically when you turn
on the \dap. If the resume function is set to start automatically playing, Rockbox
will start at the point where you last turned off the \dap. The options for the
Resume function are:\\
\begin{enumerate}
\item[Yes: ]Rockbox will unconditionally try to resume.
\item[No: ]Rockbox will not resume.
\emph{If resume is set to ``No,'' Rockbox will start in the File Browser.}
\end{enumerate}
\note{Note: Earlier versions of Rockbox had an "Ask" setting, which would ask whether
to resume when the jukebox was turned on. This setting has been eliminated because it
was redundant. If resume is set to ``Yes'' pressing
\opt{PLAYER_PAD,RECORDER_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\fixme{FixMe}}
\opt{ONDIO_PAD}{\fixme{FixMe}}
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
on the \dap\ will resume from the point where the \dap\ was stopped before shutdown.
\item \textbf{Play Selected First}
This setting controls what happens when you select a file for playback while shuffle mode is on. If the Play Selected First setting is ``Yes,'' the file you selected will be played first. If this setting is ``No,'' a random file in the directory will be played first.
\item \textbf{Resume}
Rockbox can be configured to start playing automatically when you turn on the \dap. If the resume function is set to start automatically playing, Rockbox will start at the point where you last turned off the \dap. The options for the Resume function are:
\begin{enumerate}
\item\textbf{Yes: }``Yes'' means Rockbox will unconditionally try to resume.
\item\textbf{No: }``No'' means Rockbox will not resume. If resume is set to ``No,'' Rockbox will start in the File Browser.
\end{enumerate}
Note: Earlier versions of Rockbox had an "Ask" setting, which would ask whether to resume when the jukebox was turned on. This setting has been eliminated because it was redundant. If resume is set to ``Yes'' simply on the \dap will resume from the point where the \dap was stopped before shutdown.
\item[FFwd/Rewind: ]How fast you want search (fast forward or rewind) to accelerate
when you hold down the button. ``Off'' means no acceleration. ``2x/1s'' means double
the search speed once every second the button is held. ``2x/5s'' means double the
search speed once every 5 seconds the button is held.
\item \textbf{FFwd/Rewind}
How fast you want search (fastforward or rewind) to accelerate when you hold down the button. ``Off'' means no acceleration. ``2x/1s'' means double the search speed once every second the button is held. ``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 \dap's 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.
\item \textbf{Anti-skip Buffer}
This setting allows you to control how much music is stored in the player's memory whilst playing a song, acting as a buffer against shock or playback problems. The player 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.
\opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 seconds.}
\opt{SWCODEC}{The anti-skip buffer can be set to various values between 5 seconds and 10 minutes.}
\opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 seconds.}
\opt{SWCODEC}{The anti-skip buffer can be set to various values between 5 seconds and 10 minutes.}
\emph{Tip: }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.
\textbf{Tip: }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 ``Yes,'' your music will
fade out when you press \fixme{STOP} or \fixme{PAUSE}, and fade in when you resume playback.
\item \textbf{Fade On Stop/Pause}
This setting enables and disables a fade effect when you pause or stop playing a song. If the Fade on Stop/Pause option is set to ``Yes,'' your music will fade out when you press STOP or PAUSE, and fade in when you resume playback.
\item[Party Mode: ]Enables unstoppable music playback. When new songs are selected, they are
added to the end of the current dynamic playlist instead of being played immediately.
The \fixme{PLAY} and \fixme{STOP} buttons are disabled.
\item \textbf{Party Mode}
The ``Party Mode'' enables unstoppable music playback. When new songs are selected, they are added to the end of the current dynamic playlist instead of being played immediately. The PLAY and STOP buttons are disabled.
\item[Fade On Stop/Pause: ]
This setting enables and disables a fade effect when you pause or stop playing a song.
If the Fade on Stop/Pause option is set to ``Yes,'' your music will fade out when you
press \fixme{STOP} or \fixme{PAUSE}, and fade in when you resume playback.
\item \textbf{Fade On Stop/Pause}
This setting enables and disables a fade effect when you pause or stop playing a song. If the Fade on Stop/Pause option is set to ``Yes,'' your music will fade out when you press STOP or PAUSE, and fade in when you resume playback.
\opt{SWCODEC}{
\item \textbf{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. Options:
\begin{itemize}
\item \textbf{Enable crossfade} If set to ``Off,'' crossfade is disabled. If set to ``Always,'' songs will always cross-fade into one another. If set to ``Shuffle,'' crossfade is enabled when the shuffle feature is set to ``Yes,'' but disabled otherwise.
\item \textbf{Fade in delay} The ``fade in delay'' and ``fade out delay'' control the offset between when the first song starts to fade out and the second song starts to fade in.
\item \textbf{Fade in duration} The length of time, in seconds, that it takes your music to fade in.
\item \textbf{Fade out delay} The ``fade in delay'' and ``fade out delay'' control the offset between when the first song starts to fade out and the second song starts to fade in.
\item \textbf{Fade out duration} The length of time, in seconds, that it takes your music to fade out.
\item \textbf{Fade out mode} If set to ``Crossfade," one song will fade out and the next song will simultaneously fade in. If set to ``Mix,'' the currently playing song will fade out according to the fade out settings, but the next song will simply start, without fading in.
\end{itemize}
\textbf{TIP} The crossfade setting is particularly effective when the player is set on shuffle.
}
\opt{SWCODEC}{
\item \textbf{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 as ID3 tags (or vorbis tags for certain formats). Note that APEv2 tags are not currently supported.
Options for replaygain are:
\begin{itemize}
\item \textbf{Enable replaygain} This turns on/off the replaygain function.
\item \textbf{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 \textbf{Replaygain type} Choose the type of replaygain to apply:
\begin{itemize}
\item \textbf{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 \textbf{Track gain} Maintain a constant volume level between tracks. If track gain value is not available, no replaygain is applied.
\item \textbf{Track gain if shuffling} Maintains a constant volume between tracks if shuffle mode is selected. Reverts to album mode if shuffle is off.
\end{itemize}
\item \textbf{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{itemize}
\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.\\
Options:
\begin{description}
\item[Enable Crossfade: ]If set to ``Off,'' crossfade is disabled. If set to ``Always,''
songs will always cross-fade into one another. If set to ``Shuffle,'' crossfade is
enabled when the shuffle feature is set to ``Yes,'' but disabled otherwise.
%
\item[Fade In Delay: ]The ``fade in delay'' and ``fade out delay'' control the offset
between when the first song starts to fade out and the second song starts to fade in.
%
\item[Fade In Duration: ]The length of time, in seconds, that it takes your music to fade in.
%
\item[Fade Out Delay: ]The ``fade in delay'' and ``fade out delay'' control the offset
between when the first song starts to fade out and the second song starts to fade in.
%
\item[Fade Out Duration: ]The length of time, in seconds, that it takes your music to fade out.
%
\item[Fade Out Mode: ]If set to ``Crossfade," one song will fade out and the next song will
simultaneously fade in. If set to ``Mix,'' the currently playing song will fade out
according to the fade out settings, but the next song will simply start, without fading in.
\end{description}
\emph{TIP:} The crossfade setting is particularly effective when the player is set on shuffle.
}
\item \textbf{Party Mode}
The ``Party Mode'' enables unstoppable music playback. When new songs are selected, they are added to the end of the current dynamic playlist instead of being played immediately. The PLAY and STOP buttons are disabled.
\end{itemize}
\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 as ID3 tags (or vorbis tags for certain formats). Note that 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 shuffle mode is
selected. Reverts to album mode if shuffle is off.
\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}
}
}
\end{description}