summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
Diffstat (limited to 'manual')
-rw-r--r--manual/configure_rockbox/main.tex72
1 files changed, 58 insertions, 14 deletions
diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex
index 2f2489f383..eb5ad58601 100644
--- a/manual/configure_rockbox/main.tex
+++ b/manual/configure_rockbox/main.tex
@@ -106,7 +106,7 @@ This menu offers a selection of sound properties you may change to improve your
106 106
107 The human ear and brain are very good at interpreting the timing differences between direct sounds and reflected sounds and using that information to identify the direction that the sound is coming from. On the other hand, when listening to headphones, your ear hears only the direct sounds, and not reflections. Moreover, your left ear hears only the left channel and the right ear hears only the right channel. The result is that sound from headphones does not provide the same spatial cues to your ear and brain as speakers. 107 The human ear and brain are very good at interpreting the timing differences between direct sounds and reflected sounds and using that information to identify the direction that the sound is coming from. On the other hand, when listening to headphones, your ear hears only the direct sounds, and not reflections. Moreover, your left ear hears only the left channel and the right ear hears only the right channel. The result is that sound from headphones does not provide the same spatial cues to your ear and brain as speakers.
108 108
109The crossfeed function uses an algorithm to feed a delayed and filtered portion of the signal from the right channel into the left channel and vice versa in order to simulate the spatial cues that the ear and brain receive when listening to non-headphone sources. The result is a better stereo image. 109 The crossfeed function uses an algorithm to feed a delayed and filtered portion of the signal from the right channel into the left channel and vice versa in order to simulate the spatial cues that the ear and brain receive when listening to non-headphone sources. The result is a better stereo image.
110 } 110 }
111 \opt{SWCODEC}{ 111 \opt{SWCODEC}{
112 \item \textbf{Equalizer} Rockbox features a parametric equalizer. As the name suggests, a parametric equalizer lets you control several different parameters for each band of the equalizer. Rockbox's parametric EQ is composed of five different EQ bands: 112 \item \textbf{Equalizer} Rockbox features a parametric equalizer. As the name suggests, a parametric equalizer lets you control several different parameters for each band of the equalizer. Rockbox's parametric EQ is composed of five different EQ bands:
@@ -143,29 +143,73 @@ The crossfeed function uses an algorithm to feed a delayed and filtered portion
143 \end{itemize} 143 \end{itemize}
144 144
145 \item \textbf{Play Selected First} 145 \item \textbf{Play Selected First}
146 This setting controls what happens when you press PLAY on a file in a directory and shuffle mode is on. If this 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. 146 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.
147 \item \textbf{Resume} 147 \item \textbf{Resume}
148 Sets whether Rockbox will resume playing at the point where you shut off. Options are: Ask/Yes/No/Ask once. ``Ask'' means it will ask at boot time. ``Yes'' means it will unconditionally try to resume. ``No'' means it will not resume. ``Ask once'' will erase the resume info if you answer no, and thus not ask you again. 148 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:
149 \item \textbf{FFwd / Rewind} 149 \begin{enumerate}
150 \item\textbf{Yes: }``Yes'' means Rockbox will unconditionally try to resume.
151 \item\textbf{No: }``No'' means Rockbox will not resume. If resume is set to ``No,'' Rockbox will start in the File Browser.
152 \end{enumerate}
153 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.
154
155 \item \textbf{FFwd/Rewind}
150 The options available at this point are: 156 The options available at this point are:
151 \begin{enumerate} 157 \begin{enumerate}
152 \item \textbf{FF/RW Min Step} 158 \item \textbf{FF/RW Min Step}
153 The smallest step, in seconds, you want to fast forward or rewind in a 159 The smallest step, in seconds, you want to fast forward or rewind in a track. Options are 1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, or 60 seconds.
154 track.
155 \item \textbf{FF/RW Accel} 160 \item \textbf{FF/RW Accel}
156 How fast you want search (ffwd/rew) to accelerate when you hold 161 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.
157 down the button. ``Off'' means no acceleration. ``2x/1s'' means double the
158 search speed once every second the button is held. ``2x/5s'' means double the search speed once every 5 seconds the button is held.
159 \end{enumerate} 162 \end{enumerate}
160 163
161 \item \textbf{Anti{}-skip Buffer} 164 \item \textbf{Anti-skip Buffer}
162 This setting is really ``extra anti{}-skip''. It lets you set a timer for how many seconds earlier than normally necessary the disk should spin up and start reading data. You don't need this unless you shake and bump the unit a lot. Spinning up the disk earlier than necessary naturally drains the batteries a little extra. Most users will not need this setting. 165 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.
166
167 \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 seconds.}
168 \opt{SWCODEC}{The anti-skip buffer can be set to various values between 5 seconds and 10 minutes.}
169
170 \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.
163 171
164 \item \textbf{Fade on Stop/Pause} 172 \item \textbf{Fade On Stop/Pause}
165 This setting enables and disables a fade effect when you pause or stop playing a song. Fade is a progressive increase or reduction of volume, from your set volume to 0, and vice versa. 173 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.
166 174
175 \item \textbf{Party Mode}
176 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.
177
178 \opt{SWCODEC}{
179 \item \textbf{Crossfade}
180 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:
181 \begin{itemize}
182 \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.
183 \item \textbf{Fade in delay} TODO find the place in the IRC logs where Slasheri explained this.
184 \item \textbf{Fade in duration} The length of time, in seconds, that it takes your music to fade in.
185 \item \textbf{Fade out delay} TODO find the place in the IRC logs where Slasheri explained this.
186 \item \textbf{Fade out duration} The length of time, in seconds, that it takes your music to fade out.
187 \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.
188 \end{itemize}
189 \textbf{TIP} The crossfade setting is particularly effective when the player is set on shuffle.
190 }
191 \opt{SWCODEC}{
192 \item \textbf{replaygain}
193 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.
194
195 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.
196
197 Options for replaygain are:
198 \begin{itemize}
199 \item \textbf{Enable replaygain} This turns on/off the replaygain function.
200 \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.
201 \item \textbf{Replaygain type} Choose the type of replaygain to apply:
202 \begin{itemize}
203 \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).
204 \item \textbf{Track gain} Maintain a constant volume level between tracks. If track gain value is not available, no replaygain is applied.
205 \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.
206 \end{itemize}
207 \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.
208 \end{itemize}
209 }
167 \item \textbf{ID3 tag priority} 210 \item \textbf{ID3 tag priority}
168 ID3 tags in an MP3 file contain information about the artist, title, album etc. of the track. This option controls whether Rockbox uses the information from ID3v2 tags in preference to that from ID3v1 tags when both types of tag are present. 211 ID3 tags in an MP3 file contain information about the artist, title, album etc. of the track. This option controls whether Rockbox uses the information from ID3v2 tags in preference to that from ID3v1 tags when both types of tag are present.
212
169 \end{itemize} 213 \end{itemize}
170 214
171 \subsection{File View} 215 \subsection{File View}
@@ -380,7 +424,7 @@ The crossfeed function uses an algorithm to feed a delayed and filtered portion
380 \end{itemize} 424 \end{itemize}
381 425
382 \end{itemize} 426 \end{itemize}
383 427
384 \subsection{\label{ref:Bookmarkconfigactual}Bookmarking} 428 \subsection{\label{ref:Bookmarkconfigactual}Bookmarking}
385 429
386 \begin{itemize} 430 \begin{itemize}