summaryrefslogtreecommitdiff
path: root/manual/configure_rockbox/playback_options.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/configure_rockbox/playback_options.tex')
-rw-r--r--manual/configure_rockbox/playback_options.tex234
1 files changed, 113 insertions, 121 deletions
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index 87f974800d..7ddd3c6907 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -68,10 +68,8 @@ you to configure settings related to audio playback.
68 This can happen if the \dap{} is knocked, shaken or jogged heavily while 68 This can happen if the \dap{} is knocked, shaken or jogged heavily while
69 Rockbox is trying to read the hard drive. 69 Rockbox is trying to read the hard drive.
70 70
71 \opt{swcodec}{ 71 The anti-skip buffer can be set to various values between
72 The anti-skip buffer can be set to various values between 72 5 seconds and 10 minutes.\\
73 5 seconds and 10 minutes.\\
74 }
75 73
76 \note{Having a large anti-skip buffer tends to use more power, and may 74 \note{Having a large anti-skip buffer tends to use more power, and may
77 reduce your battery life. It is recommended to always use the lowest 75 reduce your battery life. It is recommended to always use the lowest
@@ -90,110 +88,108 @@ you to configure settings related to audio playback.
90 instead of being played immediately. Pausing and stopping playback is 88 instead of being played immediately. Pausing and stopping playback is
91 disabled as well as skipping songs and launching plugins. 89 disabled as well as skipping songs and launching plugins.
92 90
93\opt{swcodec}{ 91\opt{crossfade}{
94 \opt{crossfade}{ 92\section{Crossfade}
95 \section{Crossfade} 93 This section controls the behavior of the crossfader. The crossfader, when
96 This section controls the behavior of the crossfader. The crossfader, when 94 enabled, smoothly fades one track into the next. This can occur in two
97 enabled, smoothly fades one track into the next. This can occur in two 95 situations: an automatic track change or a manual track skip. An automatic
98 situations: an automatic track change or a manual track skip. An automatic 96 track change occurs at the end of the track, moving to the next track in the
99 track change occurs at the end of the track, moving to the next track in the 97 playlist without user intervention. A manual track skip goes to the next
100 playlist without user intervention. A manual track skip goes to the next 98 track immediately when the appropriate button is pressed.\\
101 track immediately when the appropriate button is pressed.\\
102 99
103 Options for crossfade settings are: 100 Options for crossfade settings are:
104 \begin{description} 101 \begin{description}
105 \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled 102 \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled
106 and all track changes are gapless. If set to 103 and all track changes are gapless. If set to
107 \setting{Automatic Track Change Only}, crossfade occurs for automatic 104 \setting{Automatic Track Change Only}, crossfade occurs for automatic
108 track changes, but not for manual track skips. The next setting, 105 track changes, but not for manual track skips. The next setting,
109 \setting{Manual Track Skip Only}, is the opposite: tracks will only 106 \setting{Manual Track Skip Only}, is the opposite: tracks will only
110 crossfade when manually skipped. If set to \setting{Shuffle}, crossfade 107 crossfade when manually skipped. If set to \setting{Shuffle}, crossfade
111 is enabled for all track changes, automatic or manual, when the shuffle 108 is enabled for all track changes, automatic or manual, when the shuffle
112 feature is set to \setting{Yes}, but disabled otherwise. If set to 109 feature is set to \setting{Yes}, but disabled otherwise. If set to
113 \setting{Shuffle or Manual Track Skip} then crossfade will be active 110 \setting{Shuffle or Manual Track Skip} then crossfade will be active
114 either when shuffle is set to \setting{Yes} or the track is manually 111 either when shuffle is set to \setting{Yes} or the track is manually
115 skipped. If set to \setting{Always}, tracks will always crossfade into 112 skipped. If set to \setting{Always}, tracks will always crossfade into
116 one another. 113 one another.
117 % 114 %
118 \item[Fade In Delay.] The ``fade in delay'' is the length of time between 115 \item[Fade In Delay.] The ``fade in delay'' is the length of time between
119 when the crossfade process begins and when the new track begins to fade 116 when the crossfade process begins and when the new track begins to fade
120 in. 117 in.
121 % 118 %
122 \item[Fade In Duration.] The length of time, in seconds, that it takes 119 \item[Fade In Duration.] The length of time, in seconds, that it takes
123 your music to fade in once the \setting{Fade In Delay} has ended. 120 your music to fade in once the \setting{Fade In Delay} has ended.
124 % 121 %
125 \item[Fade Out Delay.] The ``fade out delay'' is the length of time 122 \item[Fade Out Delay.] The ``fade out delay'' is the length of time
126 between when the crossfade process begins and when the old track begins 123 between when the crossfade process begins and when the old track begins
127 to fade out. 124 to fade out.
128 % 125 %
129 \item[Fade Out Duration.] The length of time, in seconds, that it takes 126 \item[Fade Out Duration.] The length of time, in seconds, that it takes
130 your music to fade out once the \setting{Fade Out Delay} has ended. 127 your music to fade out once the \setting{Fade Out Delay} has ended.
131 % 128 %
132 \item[Fade Out Mode.] If set to \setting{Crossfade}, one song will fade 129 \item[Fade Out Mode.] If set to \setting{Crossfade}, one song will fade
133 out and the next song will simultaneously fade in. If set to 130 out and the next song will simultaneously fade in. If set to
134 \setting{Mix}, the ending song will not fade out at all, and will 131 \setting{Mix}, the ending song will not fade out at all, and will
135 continue to play as normal until its end with the starting song fading 132 continue to play as normal until its end with the starting song fading
136 in from under it. \setting{Mix} mode is not used for manual track skips, 133 in from under it. \setting{Mix} mode is not used for manual track skips,
137 even if it is selected here. 134 even if it is selected here.
138 \end{description} 135 \end{description}
139 136
140 \note{The rules above apply except in the instance where 137 \note{The rules above apply except in the instance where
141 \setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then 138 \setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then
142 \setting{Fade In Delay} (which would create a gap in the audio). In this case, 139 \setting{Fade In Delay} (which would create a gap in the audio). In this case,
143 the \setting{Fade In Delay} is reduced to eliminate the gap.\\} 140 the \setting{Fade In Delay} is reduced to eliminate the gap.\\}
144 141
145 The graphic below illustrates how the different settings work in practice. 142 The graphic below illustrates how the different settings work in practice.
146 143
147 \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png} 144 \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png}
148 }%\opt{crossfade} 145 }%\opt{crossfade}
149 146
150 \section{\label{ref:ReplayGain}Replaygain} 147\section{\label{ref:ReplayGain}Replaygain}
151 This allows you to control the replaygain function. 148 This allows you to control the replaygain function.
152 The purpose of replaygain is to adjust the volume of the music played 149 The purpose of replaygain is to adjust the volume of the music played
153 so that all songs (or albums, depending on your settings) have the 150 so that all songs (or albums, depending on your settings) have the
154 same apparent volume. This prevents sudden changes in volume when 151 same apparent volume. This prevents sudden changes in volume when
155 changing between songs recorded at different volume levels. 152 changing between songs recorded at different volume levels.
156 For replaygain to work, the songs must have been processed by a program 153 For replaygain to work, the songs must have been processed by a program
157 that adds replaygain information to the ID3 tags (or Vorbis tags).\\ 154 that adds replaygain information to the ID3 tags (or Vorbis tags).\\
158 155
159 Options for replaygain are: 156 Options for replaygain are:
160 \begin{description} 157 \begin{description}
161 \item[Replaygain Type.] Choose the type of replaygain to apply: 158 \item[Replaygain Type.] Choose the type of replaygain to apply:
162 \begin{description} 159 \begin{description}
163 \item[Album Gain.] Maintain a constant volume level between 160 \item[Album Gain.] Maintain a constant volume level between
164 albums, but keep any intentional volume variations between 161 albums, but keep any intentional volume variations between
165 songs in an album. (If album gain value is not available, 162 songs in an album. (If album gain value is not available,
166 uses track gain information). 163 uses track gain information).
167 %
168 \item[Track Gain.] Maintain a constant volume level between
169 tracks. If track gain value is not available, no replaygain
170 is applied.
171 %
172 \item[Track Gain If Shuffling.] Maintains a constant volume
173 between tracks if \setting{Shuffle} is set to \setting{Yes}.
174 Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
175 %
176 \item[Off.] Do not process replaygain information, i.e. turn off
177 the replaygain function.
178 \end{description}
179 % 164 %
180 \item[Prevent Clipping.] Avoid clipping of a song's waveform. 165 \item[Track Gain.] Maintain a constant volume level between
181 If a song would clip during playback, the volume is lowered for 166 tracks. If track gain value is not available, no replaygain
182 that song. Replaygain information is needed for this to work. 167 is applied.
183 % 168 %
184 \item[Pre-amp.] This allows you to adjust the volume when replaygain 169 \item[Track Gain If Shuffling.] Maintains a constant volume
185 is applied. Replaygain often lowers the volume, sometimes quite 170 between tracks if \setting{Shuffle} is set to \setting{Yes}.
186 much, so here you can compensate for that. Please note that a 171 Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
187 (large) positive pre-amp setting can cause clipping, unless 172 %
188 prevent clipping is enabled. The pre-amp can be set to any 173 \item[Off.] Do not process replaygain information, i.e. turn off
189 decibel (dB) value between -12~dB and +12~dB, in increments of 0.5~dB. 174 the replaygain function.
190 \end{description} 175 \end{description}
176 %
177 \item[Prevent Clipping.] Avoid clipping of a song's waveform.
178 If a song would clip during playback, the volume is lowered for
179 that song. Replaygain information is needed for this to work.
180 %
181 \item[Pre-amp.] This allows you to adjust the volume when replaygain
182 is applied. Replaygain often lowers the volume, sometimes quite
183 much, so here you can compensate for that. Please note that a
184 (large) positive pre-amp setting can cause clipping, unless
185 prevent clipping is enabled. The pre-amp can be set to any
186 decibel (dB) value between -12~dB and +12~dB, in increments of 0.5~dB.
187 \end{description}
191 188
192 \section{Track Skip Beep} 189\section{Track Skip Beep}
193 Controls the volume of the beep that is heard when 190 Controls the volume of the beep that is heard when
194 skipping forward or backward between tracks. The beep is disabled when 191 skipping forward or backward between tracks. The beep is disabled when
195 set to \setting{Off}. 192 set to \setting{Off}.
196}%\opt{swcodec}
197 193
198\opt{spdif_power}{ 194\opt{spdif_power}{
199 \section{\label{ref:SPDIF_OnOff}Optical Output} 195 \section{\label{ref:SPDIF_OnOff}Optical Output}
@@ -294,32 +290,28 @@ you to configure settings related to audio playback.
294 if a track ends, which can be achieved by combining this option with 290 if a track ends, which can be achieved by combining this option with
295 \setting{Repeat} set to \setting{One} 291 \setting{Repeat} set to \setting{One}
296 292
297\opt{swcodec}{ 293\section{Rewind Before Resume}\index{Rewind Before Resume}
298 \section{Rewind Before Resume}\index{Rewind Before Resume} 294 When restarting a track or a bookmark, a short rewind can be done before the
299 When restarting a track or a bookmark, a short rewind can be done before the 295 playback is started. This can be useful when listening to speech material,
300 playback is started. This can be useful when listening to speech material, 296 to help remember what was being said just before playback was stopped.
301 to help remember what was being said just before playback was stopped. 297 The size of the rewind can be set to various values between 0 (off) and
302 The size of the rewind can be set to various values between 0 (off) and 298 60 seconds.
303 60 seconds. 299 \note{This option does not apply to resuming a paused track. Use
304 \note{This option does not apply to resuming a paused track. Use 300 the next option for rewinding on pause.}
305 the next option for rewinding on pause.} 301 \note{The actual rewind distance may differ a little from the requested
306 \note{The actual rewind distance may differ a little from the requested 302 value, depending on the file in question.}
307 value, depending on the file in question.}
308}%\opt{swcodec}
309 303
310\section{Rewind on Pause}\index{Rewind on Pause} 304\section{Rewind on Pause}\index{Rewind on Pause}
311 This option rewinds the current track by a small amount whenever it is 305 This option rewinds the current track by a small amount whenever it is
312 paused (not stopped). The amount to rewind can be set between 0 and 306 paused (not stopped). The amount to rewind can be set between 0 and
313 15 seconds. 307 15 seconds.
314 308
315\opt{swcodec}{ 309\opt{play_frequency}{
316 \opt{play_frequency}{ 310 \section{Frequency}\index{Frequency}
317 \section{Frequency}\index{Frequency} 311 This is the sampling frequency used for the rockbox playback engine. Audio
318 This is the sampling frequency used for the rockbox playback engine. Audio 312 at a different sampling rate will be converted to this sampling rate prior to
319 at a different sampling rate will be converted to this sampling rate prior to 313 mixing using a cubic Hermite polynomial resampler.
320 mixing using a cubic Hermite polynomial resampler. 314 \note{For best quality and battery life, select the sampling rate used by
321 \note{For best quality and battery life, select the sampling rate used by 315 your audio. This is typically 44.1kHz.}
322 your audio. This is typically 44.1kHz.} 316 \note{Opus files are always 48kHz.}
323 \note{Opus files are always 48kHz.} 317}
324 }
325}%\opt{swcodec}