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

Split 'Configure Rockbox' chapter into separate chapters for Sound Settings and General Settings. Some cosmetic updates.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9401 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Michael DiFebbo 2006-04-01 15:41:21 +00:00
parent df91a9b011
commit c1ecc63e73
10 changed files with 187 additions and 215 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
manual/configure_rockbox/bookmarking.tex
View file

@ -1,4 +1,4 @@
\subsection{\label{ref:Bookmarkconfigactual}Bookmarking}
\section{\label{ref:Bookmarkconfigactual}Bookmarking}
Bookmarks allow you to save your current position within a track so that you can return to it at a later time.
Bookmarks are saved on a per folder basis. In other words, all of the files in the same folder have their bookmarks stored together in the folder where the files are located. You can store multiple bookmarks for the same track.

2
manual/configure_rockbox/display_options.tex
View file

@ -1,4 +1,4 @@
\subsection{\label{ref:Displayoptions}Display Options}
\section{\label{ref:Displayoptions}Display Options}
\begin{itemize}
\item \textbf{Browse fonts: }

2
manual/configure_rockbox/file_view.tex
View file

@ -1,4 +1,4 @@
\subsection{File View}
\section{File View}
The File View menu deals with options relating to how the File Browser displays files.
\begin{itemize}

1
manual/configure_rockbox/general_settings.tex
View file

@ -1,4 +1,3 @@
\section{\label{ref:GeneralSettings}General Settings}
\begin{center}
\includegraphics[width=4cm]{configure_rockbox/images/ss-general-settings-\genericimg.png}
\end{center}

2
manual/configure_rockbox/language.tex
View file

@ -1,2 +1,2 @@
\subsection{\label{ref:Language}Language}
\section{\label{ref:Language}Language}
This setting controls the language of the Rockbox user interface. Selecting a language will activate it. The language files must be in the \textbf{/.rockbox/lang/} directory. See page \pageref{ref:Loadinglanguages} for further details about languages.

7
manual/configure_rockbox/main.tex
View file

@ -1,6 +1,9 @@
\chapter{Configuring Rockbox}
\label{ref:configure_rockbox}
\chapter{Configuring Rockbox: Sound Settings}
\label{ref:configure_rockbox_sound}
\input{configure_rockbox/sound_settings.tex}
\chapter{Configuring Rockbox: General Settings}
\label{ref:configure_rockbox_general}
\input{configure_rockbox/general_settings.tex}
\input{configure_rockbox/playback_options.tex}
\input{configure_rockbox/file_view.tex}

87
manual/configure_rockbox/playback_options.tex
View file

@ -1,36 +1,36 @@
\subsection{\label{ref:PlaybackOptions}Playback Options}
\section{\label{ref:PlaybackOptions}Playback Options}
The ``Playback Options'' submenu allows you to configure settings related to audio playback.
\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:
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 \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{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 \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 \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.}
\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.
@ -39,7 +39,7 @@
\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 \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.
@ -47,7 +47,7 @@
\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{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.
@ -58,58 +58,23 @@
}
\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.
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}
}
\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}
}
\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.
\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} TODO find the place in the IRC logs where Slasheri explained this.
\item \textbf{Fade in duration} The length of time, in seconds, that it takes your music to fade in.
\item \textbf{Fade out delay} TODO find the place in the IRC logs where Slasheri explained this.
\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}
}
\item \textbf{ID3 tag priority}
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.
\end{itemize}

195
manual/configure_rockbox/sound_settings.tex
View file

@ -1,13 +1,11 @@
\section{Sound Settings}
\begin{center}
\includegraphics[width=4cm]{configure_rockbox/images/ss-sound-settings-\genericimg.png}
\end{center}
The Sound Settings menu offers a selection of sound properties you may change to customize your listening experience.
\begin{itemize}
\item \textbf{Volume}
This control adjusts the volume of your music. Like most professional audio gear and many consumer audio products, Rockbox uses a decibel scale where 0 dB is a reference that indicates the maximum volume that the \dap can produce without distortion (clipping). Because the volume control is basically a comparison of the volume level you set to a reference volume of 0 dB.
\section{Volume}
This control adjusts the volume of your music. Like most professional audio gear and many consumer audio products, Rockbox uses a decibel scale where 0 dB is a reference that indicates the maximum volume that the \dap\ can produce without distortion (clipping). Because the volume control is basically a comparison of the volume level you set to a reference maximum volume of 0 dB, the usable range of the volume setting is shown as a negative number.
\opt{player}{ Volume can be adjusted from a minimum of -78 dB to a maximum of +18 dB.}
\opt{recorder,recorderv2fm,ondio}{ Volume can be adjusted from a minimum of -100 dB to a maximum of +12 dB.}
\opt{h1xx,h300}{ Volume can be adjusted from a minimum of -84 dB to a maximum of 0 dB.}
@ -15,108 +13,115 @@ The Sound Settings menu offers a selection of sound properties you may change to
\opt{ipodvideo}{ Volume can be adjusted from a minimum of -57 dB to a maximum of +6 dB.}
\opt{ipodcolor}{ Volume can be adjusted from a minimum of -?? dB to a maximum of +?? dB.}
\item \textbf{Bass}
\section{Bass}
\opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the lower (bass) sounds in the track. 0 means that bass sounds are unaltered (flat response).}
\opt{h1xx,h300}{The Bass setting can be used to increase (but not decrease) frequencies below 300Hz. Bass boost can be set from 0 to 24 dB in increments of 2 dB. A setting of 0 means that low frequencies are unaltered (flat response).}
\opt{ipodnano,ipodcolor,ipodvideo}{TODO - platform specific description.}
\item \textbf{Treble}
\section{Treble}
\opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the higher (treble) sounds in the track. 0 means that treble sounds are unaltered (flat response).}
\opt{h1xx,h300}{The Treble setting can be used to increase (but not decrease) frequencies above 1.5kHz. Treble boost can be set from 0 to 6 dB in increments of 2 dB. A setting of 0 means that high frequencies are unaltered (flat response).}
\opt{ipodnano,ipodcolor,ipodvideo}{TODO - platform specific description.}
\item \textbf{Balance}
How much of the volume is generated by the left or right channel of the sound. The default, 0, means that the left and right outputs are equal in volume. Negative numbers increase the volume of the left channel relative to the right, positive numbers increase the volume of the right channel relative to the left.
\item \textbf{Channels}
\section{Balance}
This setting controls the balance between the left and right channels. The default, 0, means that the left and right outputs are equal in volume. Negative numbers increase the volume of the left channel relative to the right, positive numbers increase the volume of the right channel relative to the left.
\section{Channels}
A stereo audio signal consists of two channels, left and right. The channels function controls how much of the left channel signal is mixed into the right channel signal, and vice versa.
\opt{MASCODEC}{This option controls the on{}-board mixing facilities of the \dap.}
\opt{SWCODEC}{This option controls the mixing facilities of the \dap.} Available options are:
\opt{SWCODEC}{This option controls the mixing facilities of the \dap.}
Available options are:
\begin{tabularx}{\textwidth}{lX}\toprule
\textbf{Setting} & \textbf{Description} \\\midrule
Mono Left & Plays the left channel in both stereo channels. \\
%
Mono Right & Plays the right channel in both stereo channels. \\
%
Mono & Mix both channels down to mono and send the mixed signal back to both. \\
%
Stereo & Do not mix the signal. \\
%
Stereo Narrow & Mixes small amounts of the opposite channel into the left and right channels, thus making the sound seem closer together. \\
%
Stereo Wide & Elements of one channel that are present in the opposite channel are removed from the latter. This results in the sound seeming further apart. \\
%
Karaoke & Removes all sound that is the same in both channels. Since most vocals are recorded in this way to make the artist sound central, this often (but not always) has the effect of removing the voice track from a song. \\
\bottomrule
\end{tabularx}
\opt{recorder,recorderv2fm}{
\section{Loudness}
Loudness is an effect which emphasises bass and treble. This makes the track seem louder by amplifying the frequencies that the human ear finds hard to hear. Frequencies in the vocal range are unaffected, since the human ear picks these up very easily.
}
\opt{recorder,recorderv2fm}{
\section{Auto Volume}
Auto volume is a feature that automatically lowers the volume on loud parts, and then slowly restores the volume to the previous level over a time interval. That time interval is configurable here. Short values like 20ms are useful for ensuring a constant volume for in car use and other applications where background noise makes a constant loudness desirable. A longer timeout means that the change in volume back to the previous level will be smoother, so there will be less sharp changes in volume level.
}
\opt{recorder,recorderv2fm}{
\section{Super Bass}
This setting changes the threshold at which bass frequencies are affected by the \textbf{Loudness} setting, making the sound of drums and bass guitar louder in comparison to the rest of the track. This setting only has an effect if \textbf{Loudness} is set to a value larger than 0dB.
}
\opt{recorder,recorderv2fm}{
\section{MDB {}- Micronas Dynamic Bass}
The rest of the parameters on this menu relate to the Micronas Dynamic Bass (MDB) function. This is designed to enable the user to hear bass notes that the headphones and/or speakers are not capable of reproducing. Every tone has a fundamental frequency (the ``main tone'') and also several harmonics, which are related to that tone. The human brain has a mechanism whereby it can actually infer the presence of bass notes from the higher harmonics that they would generate.\\
The practical upshot of this is that MDB produces a more authentic sounding bass by tricking the brain in believing it's hearing tones that the headphones or speakers aren't capable of reproducing. Try it and see what you think.\\
The MDB parameters are as follows.
\begin{itemize}
\item \textbf{Mono Left: }Plays the left channel in both stereo channels.
\item \textbf{Mono Right:} Plays the right channel in both stereo channels.
\item \textbf{Mono:} Mix both channels down to mono and send the mixed signal
back to both.
\item \textbf{Stereo:} Do not mix the signal
\item \textbf{Stereo Narrow: }Mixes small amounts of the opposite channel into
the left and right channels, thus making the sound seem closer
together.
\item \textbf{Stereo Wide:} Elements of one channel that are present in the
opposite channel are removed from the latter. This results in the
sound seeming further apart.
\item \textbf{Karaoke:} Removes all sound that is the same in both channels.
Since most vocals are recorded in this way to make the artist sound
central, this often (but not always) has the effect of removing the
voice track from a song.
\item \textbf{MDB enable: }
This turns the MDB feature on or off. For many users this will be the only setting they need, since Rockbox picks sensible defaults for the other parameters. MDB is turned off by default.
\item \textbf{MDB strength:}
How loud the harmonics generated by the MDB will be.
\item \textbf{MDB Harmonics:}
The percentage of the low notes that is converted into harmonics. If low notes are causing speaker distortion, this can be set to 100\% to eliminate the fundamental completely and only produce harmonics in the signal. If set to 0\% this is the same as turning the MDB feature off.
\item \textbf{MDB Centre Frequency: }The cutoff frequency of your headphones or speakers. This is usually given in the specification for the headphones/speakers.
\item \textbf{MDB shape: }It is recommended that this parameter be set to 1.5 times the centre frequency.\\
This is the frequency up to which harmonics are generated. Some of the lower fundamentals near the cut{}-off range will have their lower harmonics cut off, since they will be below the range of the speakers. Fundamentals between the cut{}-off frequency and the lower frequency will have their harmonics proportionally boosted to compensate and restore the 'loudness' of these notes.\\
For most users, the defaults should provide an improvement in sound quality and can be safely left as they are. For reference, the defaults Rockbox uses are:
\begin{table}[h!]
\begin{center}
\begin{tabular}{@{}lc@{}}\toprule
Setting & Value \\\midrule
MDB Strength & 50dB \\
MDB Harmonics & 48\% \\
MDB Centre Frequency & 60Hz \\
MDB Shape & 90Hz \\\bottomrule
\end{tabular}
\end{center}
\end{table}
\end{itemize}
}
\opt{SWCODEC}{
\section{Crossfeed}
Crossfeed attempts to make the experience of listening to music on headphones more similar to listening to stereo speakers. When you listen to music through speakers, your right ear hears sound from the left speaker and vice versa. However, the sound from the left speaker reaches your left ear slightly later than the sound from your right ear, and vice versa. Moreover, when listening to speakers, you hear the direct sound from the speakers, but you also hear reflections of that sound as the sound waves bounce off of walls, floors, ceilings, etc. These reflections reach your ears slightly after the direct sound.
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.
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.
}
\opt{recorder,recorderv2fm}{
\item \textbf{Loudness}
Loudness is an effect which emphasises bass and treble. This makes the track seem louder by amplifying the frequencies that the human ear finds hard to hear. Frequencies in the vocal range are unaffected, since the human ear picks these up very easily.
}
\opt{recorder,recorderv2fm}{
\item \textbf{Auto Volume}
Auto volume is a feature that automatically lowers the volume on loud parts, and then slowly restores the volume to the previous level over a time interval. That time interval is configurable here. Short values like 20ms are useful for ensuring a constant volume for in car use and other applications where background noise makes a constant loudness desirable. A longer timeout means that the change in volume back to the previous level will be smoother, so there will be less sharp changes in volume level.
}
\opt{recorder,recorderv2fm}{
\item \textbf{Super Bass}
This setting changes the threshold at which bass frequencies are affected by the \textbf{Loudness} setting, making the sound of drums and bass guitar louder in comparison to the rest of the track. This setting only has an effect if \textbf{Loudness} is set to a value larger than 0dB.
}
\opt{recorder,recorderv2fm}{
\item \textbf{MDB {}- Micronas Dynamic Bass}
The rest of the parameters on this menu relate to the Micronas Dynamic Bass (MDB) function. This is designed to enable the user to hear bass notes that the headphones and/or speakers are not capable of reproducing. Every tone has a fundamental frequency (the ``main tone'') and also several harmonics, which are related to that tone. The human brain has a mechanism whereby it can actually infer the presence of bass notes from the higher harmonics that they would generate.\\
\opt{SWCODEC}{
\section{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:
\begin{itemize}
\item \textbf{Band 0: Low shelf filter. }A low shelf filter boosts or lowers all frequencies below the designated cutoff point. The ``bass''control on most home or car stereos is an example of a low shelf filter. The low shelf filter in Rockbox is more flexible than a simple ``bass'' control, because a simple bass control only lets you adjust the amount of gain that is applied. Rockbox lets you control the amount of gain that is applied (i.e., the amount that the bass is boosted or cut) too, but Rockbox also allows you to adjust the ``cutoff'' frequency where the shelving starts to take effect. For example, a cutoff frequency of 50 Hz will adjust only very low frequencies. A cutoff frequency of 200 Hz, on the other hand, will adjust a much wider range of bass frequencies.
\item \textbf{Bands 1-3: Peaking filters.} Peaking EQ filters boost or low a center frequency that you select, as well as the frequencies within a certain distance of that center. Graphic equalizers in home stereos are usually peaking filters. The peaking EQs on Rockbox's parametric equalizer let you adjust three different parameters for each EQ band 1 through 3. The ``center'' parameter controls the center frequency that is adjusted by that EQ band. The ``gain'' parameter controls how much each band is adjusted. Positive numbers make the EQ band louder, while negative numbers make that EQ band quieter. Finally, the ``Q'' parameter controls how wide or narrow each EQ band is. Higher Q values will affect a narrow band of frequencies, while lower EQ values will affect a wider band of frequencies.
\item \textbf{Band 4: High shelf filter.} A high shelf filter boosts or lowers all frequencies above a designated cutoff point. The ``treble'' control on most home or car stereos is an example of a high shelf filter. The high shelf filter is adjusted the same way as the low shelf filter, except that it works on the high end of the frequency spectrum rather than the low end.
\end{itemize}
The practical upshot of this is that MDB produces a more authentic sounding bass by tricking the brain in believing it's hearing tones that the headphones or speakers aren't capable of reproducing. Try it and see what you think.\\
So, as a general guide, EQ band 0 should be used for lows, EQ bands 1 through 3 should be used for mids, and EQ band 4 should be used for highs.
The MDB parameters are as follows.
\begin{itemize}
\item \textbf{MDB enable: }
This turns the MDB feature on or off. For many users this will be the only setting they need, since Rockbox picks sensible defaults for the other parameters. MDB is turned off by default.
\item \textbf{MDB strength:}
How loud the harmonics generated by the MDB will be.
\item \textbf{MDB Harmonics:}
The percentage of the low notes that is converted into harmonics. If low notes are causing speaker distortion, this can be set to 100\% to eliminate the fundamental completely and only produce harmonics in the signal. If set to 0\% this is the same as turning the MDB feature off.
\item \textbf{MDB Centre Frequency: }The cutoff frequency of your headphones or speakers. This is usually given in the specification for the headphones/speakers.
\item \textbf{MDB shape: }It is recommended that this parameter be set to 1.5 times the centre frequency.\\
This is the frequency up to which harmonics are generated. Some of the lower fundamentals near the cut{}-off range will have their lower harmonics cut off, since they will be below the range of the speakers. Fundamentals between the cut{}-off frequency and the lower frequency will have their harmonics proportionally boosted to compensate and restore the 'loudness' of these notes.\\
For most users, the defaults should provide an improvement in sound quality and can be safely left as they are. For reference, the defaults Rockbox uses are:
\begin{table}[h!]
\begin{center}
\begin{tabular}{@{}lc@{}}\toprule
Setting & Value \\\midrule
MDB Strength & 50dB \\
MDB Harmonics & 48\% \\
MDB Centre Frequency & 60Hz \\
MDB Shape & 90Hz \\\bottomrule
\end{tabular}
\end{center}
\end{table}
\end{itemize}
}
\opt{SWCODEC}{
\item \textbf{Crossfeed} Crossfeed attempts to make the experience of listening to music on headphones more similar to listening to stereo speakers. When you listen to music through speakers, your right ear hears sound from the left speaker and vice versa. However, the sound from the left speaker reaches your left ear slightly later than the sound from your right ear, and vice versa. Moreover, when listening to speakers, you hear the direct sound from the speakers, but you also hear reflections of that sound as the sound waves bounce off of walls, floors, ceilings, etc. These reflections reach your ears slightly after the direct sound.
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.
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.
}
\opt{SWCODEC}{
\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:
\begin{itemize}
\item \textbf{Band 0: Low shelf filter. }A low shelf filter boosts or lowers all frequencies below the designated cutoff point. The ``bass''control on most home or car stereos is an example of a low shelf filter. The low shelf filter in Rockbox is more flexible than a simple ``bass'' control, because a simple bass control only lets you adjust the amount of gain that is applied. Rockbox lets you control the amount of gain that is applied (i.e., the amount that the bass is boosted or cut) too, but Rockbox also allows you to adjust the ``cutoff'' frequency where the shelving starts to take effect. For example, a cutoff frequency of 50 Hz will adjust only very low frequencies. A cutoff frequency of 200 Hz, on the other hand, will adjust a much wider range of bass frequencies.
\item \textbf{Bands 1-3: Peaking filters.} Peaking EQ filters boost or low a center frequency that you select, as well as the frequencies within a certain distance of that center. Graphic equalizers in home stereos are usually peaking filters. The peaking EQs on Rockbox's parametric equalizer let you adjust three different parameters for each EQ band 1 through 3. The ``center'' parameter controls the center frequency that is adjusted by that EQ band. The ``gain'' parameter controls how much each band is adjusted. Positive numbers make the EQ band louder, while negative numbers make that EQ band quieter. Finally, the ``Q'' parameter controls how wide or narrow each EQ band is. Higher Q values will affect a narrow band of frequencies, while lower EQ values will affect a wider band of frequencies.
\item \textbf{Band 4: High shelf filter.} A high shelf filter boosts or lowers all frequencies above a designated cutoff point. The ``treble'' control on most home or car stereos is an example of a high shelf filter. The high shelf filter is adjusted the same way as the low shelf filter, except that it works on the high end of the frequency spectrum rather than the low end.
\end{itemize}
So, as a general guide, EQ band 0 should be used for lows, EQ bands 1 through 3 should be used for mids, and EQ band 4 should be used for highs.
You can find more information about setting the parametric equalizer and using equalizer presets in the Advanced Topics chapter of this manual.
}
\end{itemize}
You can find more information about setting the parametric equalizer and using equalizer presets in the Advanced Topics chapter of this manual.
}

84
manual/configure_rockbox/system_options.tex
View file

@ -1,10 +1,10 @@
\subsection{\label{ref:SystemOptions}System Options}
\section{\label{ref:SystemOptions}System Options}
\begin{itemize}
\item \textbf{Battery: }
Options relating to the batteries in the \dap.
\begin{itemize}
\item \textbf{Battery Capacity: }This setting can be used to tell Rockbox what capacity (in mAh) of battery is being used inside it.
\item \textbf{Battery Capacity: }This setting can be used to tell Rockbox what capacity (in mAh) of battery is being used inside it.
\opt{player,recorder,recorderv2fm,ondio}{The default is 1500mAh for NiMH battery based units, and 2300mAh for LiOn battery based units, which is the capacity value for the standard batteries shipped with these units.}
\opt{h1xx,h300}{The default is 1300mAh.}
\opt{ipodnano,ipodcolor,ipodvideo}{TODO: correct battery values for ipod platforms.}
@ -18,10 +18,10 @@
The \dap cannot be turned off while the charger is connected. Therefore, trickle charge is needed to keep the batteries full after charging has completed. For more in depth information about charging see Battery FAQ in your \textbf{/.rockbox/docs }directory.
}
\end{itemize}
\item \textbf{Disk: }
Options relating to the hard disk.
Options relating to the hard disk.
\begin{itemize}
\item \textbf{Disk Spindown: }
Rockbox has a timer that makes it spin down the hard disk after it is idle for a certain amount of time. This setting controls the amount of time between the last user activity and the time that the disk spins down. This idle time is only affected by user activity, like navigating through file browser. When the hard disk spins up to fill mp3 buffer, it automatically spins down afterwards.
@ -30,97 +30,97 @@
This setting controls whether the disk is powered off or only set to ``sleep'' when spun down. If this setting is YES, the disk will power off. If set to NO, the disk will enter ``sleep'' mode. Power off uses less power but takes longer to spin{}-up.}
\item \textbf{Directory cache: } Rockbox has the ability to scan the contents of your drive in the background and save those contents to a cache in RAM. The Directory Cache takes a small amount of memory away from Rockbox that would otherwise be used to buffer music, but it speeds up navigation by eliminating the slight pause between the time a navigation button is pressed and the time Rockbox responds. Turning this setting ON activates the directory cache, and turning it OFF deactivates the directory cache. Note: the first time you set the directory cache to ON, Rockbox will take a few minutes to scan the drive and you will need to restart the player. Thereafter, the directory cache will work in the background. (TODO: confirm that these last two sentences are true.)
\end{itemize}
\opt{recorder,recorderv2fm,h3xx}{
\item \textbf{Time and Date:}
Time related menu options.
\begin{itemize}
\item \textbf{Set Time/Date: }
Set current time and date.
\item \textbf{Time Format: }
Choose 12 or 24 Hour clock.
Choose 12 or 24 Hour clock.
\end{itemize}
}
\item \textbf{\label{ref:idlepoweroff}Idle Poweroff:}
Rockbox can be configured to turn off power after the unit has been idle for a defined number of minutes. The \dap\ is idle when playback is stopped or paused. It is not idle while the USB or charger is connected, or while recording.
\item \textbf{Sleep Timer:}
This option lets you power off your \dap after playing for a given time.
This option lets you power off your \dap after playing for a given time.
\opt{recorderv2fm}{This setting is reset on boot. Using this option disables the \textbf{Wake up alarm} (see below).}
\opt{recorderv2fm}{
\item \textbf{Wake up alarm:}
This option turns the \dap off and then starts it up again at the specified time. This is most useful when combined with the ``resume'' setting in the ``Playback options'' menu is set to YES, so that the \dap wakes up and immediately starts playing music. Use LEFT and RIGHT to adjust the minutes setting, UP and DOWN to adjust the HOURS. PLAY confirms the alarm and shuts your \dap down, and STOP cancels setting an alarm. If the \dap is turned on again before the alarm occurs, the alarm will be canceled. Using this option disables the \textbf{Sleep Timer} (see above).
}
\item \textbf{Limits:}
This submenu relates to limits in the Rockbox operating system.
\begin{itemize}
\item \textbf{Max files in dir browser:}
This setting controls the limit on the number of files that you can put in any particular directory in the file browser. You can configure the size to be between 50 and 10000 files in steps of 50 files. The default is 400. Higher values will shorten the music buffer, so you should increase this setting \textbf{only} if you have directories with a large number of files.
\item \textbf{Max playlist size:}
This setting controls the maximum size of a playlist. The playlist size can be between 1,000 and 20,000 files, in steps of 1000. The default is 10,000. Higher values will shorten the music buffer, so you should increase this setting \textbf{only} if you have very large playlists.\\
\end{itemize}
\opt{player,recorder,recorderv2fm}{
\item \textbf{Car Adapter Mode}
This option turns on and off the car ignition auto stop function.
When using the \dap in a car, car adapter mode automatically stops playback on the \dap when power (i.e. from cigarette lighter power adapter) to the external DC in jack is turned off. If the Car Adaptor Mode is set to ON, Rockbox will pause playback when the external power off condition is detected. Rockbox will then shutdown the \dap after the length of time set in the \textbf{Idle Poweroff} setting (see above). If power to the DC in jack is turned back on before the \textbf{Idle Poweroff} function has shut the \dap off, playback will be resumed 5 seconds after the power is applied. This delay is to allow for the time while the car engine is being started.
This option turns on and off the car ignition auto stop function.
When using the \dap in a car, car adapter mode automatically stops playback on the \dap when power (i.e. from cigarette lighter power adapter) to the external DC in jack is turned off. If the Car Adaptor Mode is set to ON, Rockbox will pause playback when the external power off condition is detected. Rockbox will then shutdown the \dap after the length of time set in the \textbf{Idle Poweroff} setting (see above). If power to the DC in jack is turned back on before the \textbf{Idle Poweroff} function has shut the \dap off, playback will be resumed 5 seconds after the power is applied. This delay is to allow for the time while the car engine is being started.
Once the \dap is shut off either manually, or automatically with the \textbf{Idle Poweroff}function, it must be powered up manually to resume playback.
}
\opt{player}{
\item \textbf{Line In (Player only)}
This option activates the line in port on \dap Player, which is off by default.
This is useful for such applications as:
\begin{itemize}
\item Game boy {}-{\textgreater} \dap {}-{\textgreater} human
\item laptop {}-{\textgreater} \dap {}-{\textgreater}human
\item LAN party computer {}-{\textgreater} \dap {}-{\textgreater} human
\item LAN party computer {}-{\textgreater} \dap {}-{\textgreater} human
\end{itemize}
}
\item \textbf{Manage settings}
This submenu deals with loading and saving settings. \opt{MASCODEC}{This submenu also allows you to load or save different firmware versions.
}
\begin{itemize}
\item \textbf{Browse .cfg Files: }
Opens the file browser in the \textbf{/.rockbox} directory and displays all .cfg (configuration) files. Selecting a .cfg file will cause Rockbox to load that the settings contained in that file. STOP will exit back to the menu. (TODO--proper button configurations for different platforms.) See the \textbf{Write .cfg files} option on the Manage Settings menu for details of how to save and edit a configuration file.
\opt{MASCODEC}{
\item \textbf{Browse Firmwares:}
This displays a list of firmware file in the \fname{/.rockbox} system directory.
\opt{recorder,recorderv2fm}{ Firmware files have an extension of .ajz.}
\opt{player,ondio}{ Firmware files have an extension of .mod}
\opt{MASCODEC}{
\item \textbf{Browse Firmwares:}
This displays a list of firmware file in the \fname{/.rockbox} system directory.
\opt{recorder,recorderv2fm}{ Firmware files have an extension of .ajz.}
\opt{player,ondio}{ Firmware files have an extension of .mod}
Playing a firmware file loads it into memory. Thus, it is possible to run the original Archos firmware or a different version of Rockbox from here assuming that you have the right files installed on your disk. There's no need of any other file or directory to be installed to use this option; the firmware is resident in that one file.
}
\item \textbf{Reset Settings: }
This wipes the saved settings in the \dap and resets all settings to their default values.
\opt{h100, h300}{ \textbf{Note: } You can also reset all settings to their default values by turning off the \dap\, turning it back on, and pressing the REC button (TODO--proper button def) immediately after the \dap\ turns on. (TODO: check if this feature is available on other platforms.}
\item \textbf{Write .cfg file: }
This option writes a Rockbox configuration file to your jukebox's hard disk. The configuration file has the ".cfg" extension and is used to store all of the user settings that are described throughout this manual.
This option writes a Rockbox configuration file to your jukebox's hard disk. The configuration file has the ".cfg" extension and is used to store all of the user settings that are described throughout this manual.
A configuration file may reside anywhere on the hard disk. Multiple configuration files are permitted. So, for example, you could have a car.cfg file for the settings that you use while playing your jukebox in your car, and a headphones.cfg file to store the settings that you use while listening to your jukebox through headphones.
A configuration file may reside anywhere on the hard disk. Multiple configuration files are permitted. So, for example, you could have a car.cfg file for the settings that you use while playing your jukebox in your car, and a headphones.cfg file to store the settings that you use while listening to your jukebox through headphones.
The Rockbox configuration file is a plain text file, so once you use the \textbf{Write .cfg file} option to create the file, you can edit the file on your computer using any text editor program. Configuration files use the following formatting rules:
The Rockbox configuration file is a plain text file, so once you use the \textbf{Write .cfg file} option to create the file, you can edit the file on your computer using any text editor program. Configuration files use the following formatting rules:
\begin{enumerate}
\item Each setting must be on a separate line.
\item Each line has the format ``setting: value''.
\item Values must be within the ranges specified in this manual for each setting.
\item Lines starting with \# are ignored. This lets you write comments into your configuration files.
\end{enumerate}
\begin{enumerate}
\item Each setting must be on a separate line.
\item Each line has the format ``setting: value''.
\item Values must be within the ranges specified in this manual for each setting.
\item Lines starting with \# are ignored. This lets you write comments into your configuration files.
\end{enumerate}
Configuration files may be loaded using the Browse .cfg files option on the Manage Settings menu.
Configuration files may be loaded using the Browse .cfg files option on the Manage Settings menu.
\textbf{Hint: }Configuration files do not need to contain all of the Rockbox options. You can create configuration files that change only certain settings. So, for example, let's say you typically use the \dap at one volume in the car, and another when using headphones. Further, suppose you like to use an inverse LCD when you're in the car, and a regular LCD setting when you're using headphones. You could create configuration files that control only the volume and LCD settings. Create a few different files with different settings, give each file a different name (such as car.cfg, headphones.cfg, etc.), and you can then use the \textbf{Browse .cfg files} option to quickly change settings.
\textbf{Hint: }Configuration files do not need to contain all of the Rockbox options. You can create configuration files that change only certain settings. So, for example, let's say you typically use the \dap at one volume in the car, and another when using headphones. Further, suppose you like to use an inverse LCD when you're in the car, and a regular LCD setting when you're using headphones. You could create configuration files that control only the volume and LCD settings. Create a few different files with different settings, give each file a different name (such as car.cfg, headphones.cfg, etc.), and you can then use the \textbf{Browse .cfg files} option to quickly change settings.
\end{itemize}
\end{itemize}

20
manual/configure_rockbox/voice.tex
View file

@ -1,16 +1,16 @@
\subsection{\label{ref:Voiceconfiguration}Voice}
\section{\label{ref:Voiceconfiguration}Voice}
\begin{itemize}
\item \textbf{Voice Menus:}
This option turns on the Voice User Interface, which will read out menu items and settings as they are selected by the cursor. In order for this to work, a voice file must be present in the \textbf{/.rockbox/lang/} directory on the \dap\. Voice files are large (1.5MB) and are not shipped with Rockbox by default.
This option turns on the Voice User Interface, which will read out menu items and settings as they are selected by the cursor. In order for this to work, a voice file must be present in the \textbf{/.rockbox/lang/} directory on the \dap. Voice files are large (1.5MB) and are not shipped with Rockbox by default.
The voice file is the name of the language for which it is made, followed by the extension .voice. So for English, the file name would be \fname{english.voice}.
This option is on by default. It will do nothing unless the appropriate .voice file is installed in the correct place on the \dap\.
The Voice Menus have several limitations:
\begin{itemize}
This option is on by default. It will do nothing unless the appropriate .voice file is installed in the correct place on the \dap.
The Voice Menus have several limitations:
\begin{itemize}
\item Setting the Sound Option \textbf{Channels} to ``karaoke'' may disable voice menus.
\item Plugins and the wake up alarm do not support voice features.
\end{itemize}
\item \textbf{Voice Directories:}
This option turns on the speaking of directory names. The \dap\ is not powerful enough to produce these voices in real time, so a number of options are available.
\begin{itemize}
@ -23,10 +23,10 @@
\item \textbf{Off: }
No attempt will be made to speak directory names.
\end{itemize}
\item \textbf{Voice Filenames:}
This option turns on the speaking of directory names. The options provided are ``Spell'', ``Numbers'', and ``Off'' which function the same as for \textbf{Voice Directories} and ``.talk mp3 clip,'' which functions as above except that the files are named with the same name as the music file (e.g. \fname{Punkadiddle.mp3 } would require a file called \textbf{Punkadiddle.mp3.talk}).
\end{itemize}
\end{itemize}
See \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceHowto} for more details on configuring speech support in Rockbox.