summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNils Wallménius <nils@rockbox.org>2008-10-13 15:11:11 +0000
committerNils Wallménius <nils@rockbox.org>2008-10-13 15:11:11 +0000
commit5aa0665b5b5522f7867e0ba26ab14e30712f9829 (patch)
treeca40e0772bed96d656e84ca306219291e885814f
parent4b7ebdc6f272e2fcfb5f2805ea91c19757d9aca9 (diff)
downloadrockbox-5aa0665b5b5522f7867e0ba26ab14e30712f9829.tar.gz
rockbox-5aa0665b5b5522f7867e0ba26ab14e30712f9829.zip
Move 'Playback Settings' up from 'General Settings' to 'Settings' (FS#9472 by William Poetra Yoga Hadisoeseno but without the menu rearrangement) also closes FS#9154. Update manual to reflect the menu change, Playback Settings is now its own chapter. As a bonus that makes it a bit easier to find stuff in the toc.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18799 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--apps/menus/main_menu.c1
-rw-r--r--apps/menus/settings_menu.c2
-rw-r--r--manual/configure_rockbox/main.tex5
-rw-r--r--manual/configure_rockbox/playback_options.tex174
4 files changed, 96 insertions, 86 deletions
diff --git a/apps/menus/main_menu.c b/apps/menus/main_menu.c
index 3995eafd24..77322c6ef4 100644
--- a/apps/menus/main_menu.c
+++ b/apps/menus/main_menu.c
@@ -549,6 +549,7 @@ static int mainmenu_callback(int action,const struct menu_item_ex *this_item)
549MAKE_MENU(main_menu_, ID2P(LANG_SETTINGS), mainmenu_callback, 549MAKE_MENU(main_menu_, ID2P(LANG_SETTINGS), mainmenu_callback,
550 Icon_Submenu_Entered, 550 Icon_Submenu_Entered,
551 &sound_settings, 551 &sound_settings,
552 &playback_settings,
552 &settings_menu_item, &theme_menu, 553 &settings_menu_item, &theme_menu,
553#ifdef HAVE_RECORDING 554#ifdef HAVE_RECORDING
554 &recording_settings, 555 &recording_settings,
diff --git a/apps/menus/settings_menu.c b/apps/menus/settings_menu.c
index 48ab316a87..60fc9c0cc0 100644
--- a/apps/menus/settings_menu.c
+++ b/apps/menus/settings_menu.c
@@ -499,7 +499,7 @@ MENUITEM_FUNCTION(browse_langs, 0, ID2P(LANG_LANGUAGE), language_browse,
499 499
500MAKE_MENU(settings_menu_item, ID2P(LANG_GENERAL_SETTINGS), 0, 500MAKE_MENU(settings_menu_item, ID2P(LANG_GENERAL_SETTINGS), 0,
501 Icon_General_settings_menu, 501 Icon_General_settings_menu,
502 &playback_settings, &playlist_settings, &file_menu, 502 &playlist_settings, &file_menu,
503#ifdef HAVE_TAGCACHE 503#ifdef HAVE_TAGCACHE
504 &tagcache_menu, 504 &tagcache_menu,
505#endif 505#endif
diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex
index 52888f2159..5412d77ccc 100644
--- a/manual/configure_rockbox/main.tex
+++ b/manual/configure_rockbox/main.tex
@@ -2,10 +2,13 @@
2\label{ref:configure_rockbox_sound} 2\label{ref:configure_rockbox_sound}
3 \input{configure_rockbox/sound_settings.tex} 3 \input{configure_rockbox/sound_settings.tex}
4 4
5\chapter{Playback Settings}
6\label{ref:configure_rockbox_playback}
7 \input{configure_rockbox/playback_options.tex}
8
5\chapter{General Settings} 9\chapter{General Settings}
6\label{ref:configure_rockbox_general} 10\label{ref:configure_rockbox_general}
7 \input{configure_rockbox/general_settings.tex} 11 \input{configure_rockbox/general_settings.tex}
8 \input{configure_rockbox/playback_options.tex}
9 \input{configure_rockbox/playlist_options.tex} 12 \input{configure_rockbox/playlist_options.tex}
10 \input{configure_rockbox/file_view.tex} 13 \input{configure_rockbox/file_view.tex}
11 \input{configure_rockbox/database.tex} 14 \input{configure_rockbox/database.tex}
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index 7701855781..e7a2977660 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -1,16 +1,16 @@
1% $Id$ % 1% $Id$ %
2\section{\label{ref:PlaybackOptions}Playback} 2The \setting{Playback Settings} menu allows you to configure settings
3The \setting{Playback} sub menu allows you to configure settings
4related to audio playback. 3related to audio playback.
5\begin{description} 4
6\item[Shuffle]Turning shuffle on will cause Rockbox to randomly re-order the 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 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 8 need to create a playlist containing all of them. For more information on
9 creating playlists refer to \reference{ref:working_with_playlists}.\\ 9 creating playlists refer to \reference{ref:working_with_playlists}.\\
10 Options: \setting{Yes}/\setting{No}. 10 Options: \setting{Yes}/\setting{No}.
11 % 11 %
12\item[Repeat]Configures settings related to repeating of directories or 12\section{Repeat}
13 playlists.\\ 13 Configures settings related to repeating of directories or playlists.\\
14 Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle} / 14 Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle} /
15 \setting{A-B}: 15 \setting{A-B}:
16 \begin{description} 16 \begin{description}
@@ -49,65 +49,70 @@ related to audio playback.
49 }% 49 }%
50 \end{description} 50 \end{description}
51 51
52\item[Play Selected First]This setting controls what happens when you 52\section{Play Selected First}
53 This setting controls what happens when you
53 select a file for playback while shuffle mode is on. If the 54 select a file for playback while shuffle mode is on. If the
54 \setting{Play Selected First} setting is \setting{Yes}, the file you 55 \setting{Play Selected First} setting is \setting{Yes}, the file you
55 selected will be played first. If this setting is \setting{No}, a random 56 selected will be played first. If this setting is \setting{No}, a random
56 file in the directory will be played first. 57 file in the directory will be played first.
57 58
58 \item[Fast-Forward/Rewind]These settings control the speed and acceleration during fast forward and rewind. 59\section{Fast-Forward/Rewind}
60 These settings control the speed and acceleration during fast forward and rewind.
59 The setting \setting{FF/RW Min Step} controls the initial speed and \setting{FF/RW Accel} controls the acceleration. 61 The setting \setting{FF/RW Min Step} controls the initial speed and \setting{FF/RW Accel} controls the acceleration.
60 62
61 \item[Anti-Skip Buffer]This setting allows you to control how much music is 63\section{Anti-Skip Buffer}
62 stored in the \daps{} memory whilst playing a song, acting as a buffer 64 This setting allows you to control how much music is
63 against shock or playback problems. The \dap{} transfers the selected 65 stored in the \daps{} memory whilst playing a song, acting as a buffer
64 amount of the forthcoming song into its memory at high speed whilst you are 66 against shock or playback problems. The \dap{} transfers the selected
65 playing the song. It keeps a ``rolling'' buffer, which keeps feeding more 67 amount of the forthcoming song into its memory at high speed whilst you are
66 of the forthcoming song into memory as it goes along. 68 playing the song. It keeps a ``rolling'' buffer, which keeps feeding more
67 If the \dap{} is knocked, shaken or jogged heavily while Rockbox is trying 69 of the forthcoming song into memory as it goes along.
68 to read the hard drive, Rockbox might not be able to read the drive. 70 If the \dap{} is knocked, shaken or jogged heavily while Rockbox is trying
69 Rockbox will retry over and over again until it succeeds, but may 71 to read the hard drive, Rockbox might not be able to read the drive.
70 eventually reach the end of the memory buffer. When that happens, Rockbox 72 Rockbox will retry over and over again until it succeeds, but may
71 must stop playing and wait for more data from the disk, which causes your 73 eventually reach the end of the memory buffer. When that happens, Rockbox
72 music to skip. The anti-skip setting tells Rockbox how much extra buffer 74 must stop playing and wait for more data from the disk, which causes your
73 memory to spare to handle this situation. This setting therefore allows you 75 music to skip. The anti-skip setting tells Rockbox how much extra buffer
74 to reduce the chances of there being a gap or pause during playback of 76 memory to spare to handle this situation. This setting therefore allows you
75 songs. 77 to reduce the chances of there being a gap or pause during playback of
78 songs.
76 79
77 \nopt{ondio}{ 80 \nopt{ondio}{
78 \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 81 \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7
79 seconds.} 82 seconds.}
80 }% 83 }%
81 \opt{ondio}{ 84 \opt{ondio}{
82 The anti-skip buffer can safely be kept at zero. It will eventually be 85 The anti-skip buffer can safely be kept at zero. It will eventually be
83 eliminated. 86 eliminated.
84 }% 87 }%
85 \opt{swcodec}{The anti-skip buffer can be set to various values between 88 \opt{swcodec}{The anti-skip buffer can be set to various values between
86 5 seconds and 10 minutes.}% 89 5 seconds and 10 minutes.}%
87 90
88 \note{Having a large anti-skip buffer tends to use more power, and may 91 \note{Having a large anti-skip buffer tends to use more power, and may
89 reduce your battery life. It is recommended to always use the lowest 92 reduce your battery life. It is recommended to always use the lowest
90 possible setting that allows correct and continuous playback.} 93 possible setting that allows correct and continuous playback.}
91 94
92 \item[Fade on Stop/Pause]Enables and disables a fade effect when you 95\section{Fade on Stop/Pause}
93 pause or stop playing a song. If the Fade on Stop/Pause option is 96 Enables and disables a fade effect when you
94 set to \setting{Yes}, your music will fade out when you stop or pause 97 pause or stop playing a song. If the Fade on Stop/Pause option is
95 playback, and fade in when you resume playback. 98 set to \setting{Yes}, your music will fade out when you stop or pause
99 playback, and fade in when you resume playback.
96 100
97 \item[Party Mode]Enables unstoppable music playback. When new songs are 101\section{Party Mode}
98 selected, they are queued at the end of the current dynamic playlist 102 Enables unstoppable music playback. When new songs are
99 instead of being played immediately. Pausing and stopping playback is 103 selected, they are queued at the end of the current dynamic playlist
100 disabled as well as skipping songs and launching plugins. 104 instead of being played immediately. Pausing and stopping playback is
105 disabled as well as skipping songs and launching plugins.
101 106
102 \opt{swcodec}{ 107\opt{swcodec}{
103 \item[Crossfade] 108 \section{Crossfade}
104 This setting enables a cross-fader. At the end of a song, the song will 109 This setting enables a cross-fader. At the end of a song, the song will
105 fade out as the next song fades in, creating a smooth transition between 110 fade out as the next song fades in, creating a smooth transition between
106 songs. The crossfade setting is particularly effective when the player is 111 songs. The crossfade setting is particularly effective when the player is
107 set on shuffle.\\ 112 set on shuffle.\\
108 113
109 Options for crossfade settings are: 114 Options for crossfade settings are:
110 \begin{description} 115 \begin{description}
111 \item[Enable Crossfade]If set to \setting{Off}, crossfade is disabled. 116 \item[Enable Crossfade]If set to \setting{Off}, crossfade is disabled.
112 If set to \setting{Always}, songs will always crossfade into one 117 If set to \setting{Always}, songs will always crossfade into one
113 another. If set to \setting{Shuffle}, crossfade is enabled when the 118 another. If set to \setting{Shuffle}, crossfade is enabled when the
@@ -145,20 +150,19 @@ related to audio playback.
145 The graphic below illustrates how the different settings work in practice. 150 The graphic below illustrates how the different settings work in practice.
146 151
147 \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png} 152 \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png}
148 }%
149 153
150 \opt{swcodec}{ 154 \section{Replaygain}
151 \item[Replaygain]This allows you to control the replaygain function. 155 This allows you to control the replaygain function.
152 The purpose of replaygain is to adjust the volume of the music played 156 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 157 so that all songs (or albums, depending on your settings) have the
154 same apparent volume. This prevents sudden changes in volume when 158 same apparent volume. This prevents sudden changes in volume when
155 changing between songs recorded at different volume levels. 159 changing between songs recorded at different volume levels.
156 For replaygain to work, the songs must have been processed by a program 160 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). 161 that adds replaygain information to the ID3 tags (or Vorbis tags).
158 \note{APEv2 tags are not currently supported.} 162 \note{APEv2 tags are not currently supported.}
159 163
160 Options for replaygain are: 164 Options for replaygain are:
161 \begin{description} 165 \begin{description}
162 \item[Enable Replaygain]This turns on/off the replaygain function. 166 \item[Enable Replaygain]This turns on/off the replaygain function.
163 % 167 %
164 \item[Prevent Clipping]Avoid clipping of a song's waveform. 168 \item[Prevent Clipping]Avoid clipping of a song's waveform.
@@ -188,20 +192,22 @@ related to audio playback.
188 prevent clipping is enabled. The pre-amp can be set to any 192 prevent clipping is enabled. The pre-amp can be set to any
189 decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB. 193 decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB.
190 \end{description} 194 \end{description}
191 }
192 \opt{swcodec}{
193 \item[Beep Volume]Controls the volume of the beep that is heard when
194 skipping forward or backward between tracks. The beep is disabled when
195 set to \setting{Off}.
196 }
197 195
198 \opt{spdif_power}{ 196 \section{Beep Volume}
199 \item[Optical Output. ]Enables or disables the optical S/PDIF output to 197 Controls the volume of the beep that is heard when
200 allow a digital connection to a suitable external decoder. To enable 198 skipping forward or backward between tracks. The beep is disabled when
201 optical output, set to \setting{Yes} 199 set to \setting{Off}.
202 } 200}%\opt{swcodec}
203 201
204\item[Auto-Change Directory]Control what Rockbox does when it reaches the end 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
205 of a directory. If \setting{Auto-Change Directory} is set to \setting{Yes}, 211 of a directory. If \setting{Auto-Change Directory} is set to \setting{Yes},
206 Rockbox will continue to the next directory. If 212 Rockbox will continue to the next directory. If
207 \setting{Auto-Change Directory} is set to \setting{No}, playback will stop at 213 \setting{Auto-Change Directory} is set to \setting{No}, playback will stop at
@@ -215,7 +221,8 @@ related to audio playback.
215 221
216 % 222 %
217\opt{headphone_detection}{ 223\opt{headphone_detection}{
218\item[Pause on Headphone Unplug] Enables and disables automatic pausing of 224\section{Pause on Headphone Unplug}
225 Enables and disables automatic pausing of
219 playback when the headphones are disconnected from the \daps{} headphone 226 playback when the headphones are disconnected from the \daps{} headphone
220 socket. 227 socket.
221 % 228 %
@@ -240,7 +247,7 @@ related to audio playback.
240 247
241}% 248}%
242 249
243\item[Last.fm Log]\index{Last.fm Log}\index{Audioscrobbler|see{Last.fm Log}} 250\section{Last.fm Log}\index{Last.fm Log}\index{Audioscrobbler|see{Last.fm Log}}
244 Enables logging of your played tracks for submittal to 251 Enables logging of your played tracks for submittal to
245 \url{http://www.last.fm}. This service was formely known as 252 \url{http://www.last.fm}. This service was formely known as
246 \emph{Audioscrobbler}. When you enable this option, you'll have to reboot to 253 \emph{Audioscrobbler}. When you enable this option, you'll have to reboot to
@@ -251,7 +258,7 @@ related to audio playback.
251 \note{See \wikilink{LastFMLog} for a further description, and for tools you 258 \note{See \wikilink{LastFMLog} for a further description, and for tools you
252 can use to submit your Last.fm log.} 259 can use to submit your Last.fm log.}
253 260
254\item[Cuesheet Support]\index{Cuesheet Support} 261\section{Cuesheet Support}\index{Cuesheet Support}
255 Enables reading of cuesheet files for played tracks. If a cuesheet is found 262 Enables reading of cuesheet files for played tracks. If a cuesheet is found
256 for a track, track markers are displayed on the progressbar and it is 263 for a track, track markers are displayed on the progressbar and it is
257 possible to skip between the tracks within the cuesheet. Also the information 264 possible to skip between the tracks within the cuesheet. Also the information
@@ -259,7 +266,7 @@ related to audio playback.
259 When you enable this option, you'll have to reboot for it to come into 266 When you enable this option, you'll have to reboot for it to come into
260 effect. 267 effect.
261 268
262\item[Skip Length]\index{Skip Length} 269\section{Skip Length}\index{Skip Length}
263 Designed to speed up navigation and prevent unintentional track skipping when 270 Designed to speed up navigation and prevent unintentional track skipping when
264 listening to long audio tracks, \setting{Skip Length} changes the behavior of 271 listening to long audio tracks, \setting{Skip Length} changes the behavior of
265 the \ActionWpsSkipPrev{} and \ActionWpsSkipNext{} buttons so that they skip 272 the \ActionWpsSkipPrev{} and \ActionWpsSkipNext{} buttons so that they skip
@@ -267,6 +274,5 @@ related to audio playback.
267 274
268 \note{To skip tracks with this setting set to a time interval, press Short 275 \note{To skip tracks with this setting set to a time interval, press Short
269 \ActionWpsSkipPrev{} + Long \ActionWpsSkipNext{} to go forward and Short 276 \ActionWpsSkipPrev{} + Long \ActionWpsSkipNext{} to go forward and Short
270 \ActionWpsSkipNext{} + Long \ActionWpsSkipPrev{} to go back.} 277 \ActionWpsSkipNext{} + Long \ActionWpsSkipPrev{} to go back.}
271 278
272\end{description}