From 1e99b669f520569cfd58cce6794fa004a1497c2d Mon Sep 17 00:00:00 2001 From: Martin Arver Date: Thu, 23 Mar 2006 21:19:28 +0000 Subject: Commit again. Thanks to safetydan for pointing it out. The file is now properly indented, so that it is easier to spot begin-end errors git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9218 a1c6a512-1295-4272-9138-f99709370657 --- manual/configure_rockbox/main.tex | 610 ++++++++++++++++++++------------------ 1 file changed, 314 insertions(+), 296 deletions(-) diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex index 72dede7ed7..259de4abd3 100644 --- a/manual/configure_rockbox/main.tex +++ b/manual/configure_rockbox/main.tex @@ -2,7 +2,7 @@ \label{ref:configure_rockbox} \section{Sound Settings} \begin{center} -\includegraphics[width=4cm]{configure_rockbox/images/ss-sound-settings-\genericimg.png} + \includegraphics[width=4cm]{configure_rockbox/images/ss-sound-settings-\genericimg.png} \end{center} This menu offers a selection of sound properties you may change to improve your sound experience. @@ -16,6 +16,7 @@ This menu offers a selection of sound properties you may change to improve your \opt{ipodnano}{ Volume can be adjusted from a minimum of -72 dB to a maximum of +6 dB.} \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} \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).} @@ -27,28 +28,27 @@ This menu offers a selection of sound properties you may change to improve your \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} + 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{player,recorder,recorderv2fm,ondio}{ - This option controls the on{}-board mixing facilities of the \dap. A stereo audio signal consists of two channels, left and right. Available options are - \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. - \end{itemize} - } - \opt{h1xx,h300,ipodnano,ipodcolor,ipodvideo}{TODO write for sw-platform} + \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. + \end{itemize} \opt{recorder,recorderv2fm}{ \item \textbf{Loudness} @@ -68,9 +68,9 @@ This menu offers a selection of sound properties you may change to improve your \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.\\ - + 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} @@ -82,11 +82,11 @@ This menu offers a selection of sound properties you may change to improve your 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 @@ -101,313 +101,331 @@ This menu offers a selection of sound properties you may change to improve your \end{itemize} } -\end{itemize} - - -\section{\label{ref:GeneralSettings}General Settings} -\begin{center} - \includegraphics[width=4cm]{configure_rockbox/images/ss-general-settings-\genericimg.png} -\end{center} - -\subsection{\label{ref:PlaybackOptions}Playback Options} -This menu is for configuring 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} - Repeat modes are Off/One/All. ``Off'' means no repeat. ``One'' means repeat one track over and over. ``All'' means repeat playlist/directory. -\item \textbf{Play Selected First} - 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. -\item \textbf{Resume} - 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. -\item \textbf{FFwd / Rewind} - The options available at this point are: - \begin{enumerate} - \item \textbf{FF/RW Min Step} - The smallest step, in seconds, you want to fast forward or rewind in a - track. - \item \textbf{FF/RW Accel} - How fast you want search (ffwd/rew) 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. - \end{enumerate} + \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. + } -\item \textbf{Anti{}-skip Buffer} - 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. - -\item \textbf{Fade on Stop/Pause} - 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. - -\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} - -\subsection{File View} -This menu deals with options relating to how the file browser displays files - -\begin{itemize} -\item \textbf{Sort Case Sensitive} - If this option is enabled files that start with a lower case letter will appear after the files that start with an upper case letter have all been listed If disabled, then case will be ignored when sorting files. -\item \textbf{Sort Directories} - This option controls how Rockbox sorts folders. The default is to sort them alphabetically. ``By date'' sorts them with the oldest folder first. ``By newest date'' sorts them with the newest folder first. + \section{\label{ref:GeneralSettings}General Settings} + \begin{center} + \includegraphics[width=4cm]{configure_rockbox/images/ss-general-settings-\genericimg.png} + \end{center} + + \subsection{\label{ref:PlaybackOptions}Playback Options} + This menu is for configuring settings related to audio playback. -\item \textbf{Sort Files} - This option controls how Rockbox sorts files. In addition to the options for directory sorting above, there is a ``By type'' option which sorts files alphabetically by their type (such as .mp3) then alphabetically within each type. - -\item \textbf{\label{ref:ShowFiles}Show Files} - Controls which files are displayed in the directory browser: - \begin{itemize} - \item \textbf{Music: } - Only directories, .m3u files and the supported \emph{audio} fileformats are shown. Extensions are strippe'd. Files anddirectories starting with . Or with the ``hidden'' flag set are hidden. - \item \textbf{Playlists:} - Only shows directories and playlists, for simplified navigation. - \item \textbf{Supported:} - All directories and files Rockbox understands (see page \pageref{ref:Supportedfileformats}) are shown. Files and directories starting with . or with the ``hidden'' flag set are hidden. - \item \textbf{All:} - All files and directories are shown. Extensions are shown. No files or directories arehidden + \item \textbf{Shuffle} + Select shuffle ON/OFF. This alters how Rockbox will select which next song to play. + \item \textbf{Repeat} + The ``Repeat'' setting is for configuring settings related to repeating of directories or playlists. Repeat modes are Off/One/All/Shuffle: + \begin{itemize} + \item \textbf{Off: }``Off'' means that the current directory or playlist will not repeat when it is finished. (Note: If you have the ``Auto change directory'' option set to ``Yes,'' Rockbox will move on to the next directory on your hard drive. If the ``Auto change directory'' option is set to ``No,'' playback will stop when the current directory or playlist is finished.) + \item\textbf{One: }``One'' means repeat one track over and over. + \item\textbf{All: } ``All'' means that the current directory or playlist will repeat when it is finished. (Note: this option does \textbf{not} shuffle all files on your \dap. Rockbox is playlist oriented. When you play a song, or a directory, or an album, Rockbox creates a playlist and plays it. Thus, to shuffle all songs on the player, you need to create a playlist of all songs on the player, and play that playlist with shuffle mode set to ``All.'') + \item\textbf{Shuffle: }``Shuffle'' means that when the current directory or playlist has finished playing, it will be shuffled and then repeated. + \end{itemize} + + \item \textbf{Play Selected First} + 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. + \item \textbf{Resume} + 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. + \item \textbf{FFwd / Rewind} + The options available at this point are: + \begin{enumerate} + \item \textbf{FF/RW Min Step} + The smallest step, in seconds, you want to fast forward or rewind in a + track. + \item \textbf{FF/RW Accel} + How fast you want search (ffwd/rew) 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. + \end{enumerate} + + \item \textbf{Anti{}-skip Buffer} + 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. + + \item \textbf{Fade on Stop/Pause} + 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. + + \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} -\item \textbf{Follow Playlist} - If Follow Playlist is set to ``Yes'', you will find yourself in the same directory as the currently playing file if you go to the Directory Browser from the WPS. If set to ``No'', you will stay in the same directory as you were last in. - -\item \textbf{Show Icons} - This indicates whether Rockbox will display an icon representing what type a file is on the left of the file in the browser. For details of these icons, please see page \pageref{ref:Supportedfileformats}. -\end{itemize} - -\subsection{\label{ref:Displayoptions}Display Options} - -\begin{itemize} -\item \textbf{Browse fonts} - Browse the fonts that reside in your \fname{/.rockbox} directory. Selecting one will activate it. See page \pageref{ref:Loadingfonts} for further details about fonts. + \subsection{File View} + This menu deals with options relating to how the file browser displays files + + \begin{itemize} + \item \textbf{Sort Case Sensitive} + If this option is enabled files that start with a lower case letter will appear after the files that start with an upper case letter have all been listed If disabled, then case will be ignored when sorting files. + \item \textbf{Sort Directories} + This option controls how Rockbox sorts folders. The default is to sort them alphabetically. ``By date'' sorts them with the oldest folder first. ``By newest date'' sorts them with the newest folder first. + + \item \textbf{Sort Files} + This option controls how Rockbox sorts files. In addition to the options for directory sorting above, there is a ``By type'' option which sorts files alphabetically by their type (such as .mp3) then alphabetically within each type. + + \item \textbf{\label{ref:ShowFiles}Show Files} + Controls which files are displayed in the directory browser: + + \begin{itemize} + \item \textbf{Music: } + Only directories, .m3u files and the supported \emph{audio} fileformats are shown. Extensions are strippe'd. Files anddirectories starting with . Or with the ``hidden'' flag set are hidden. + \item \textbf{Playlists:} + Only shows directories and playlists, for simplified navigation. + \item \textbf{Supported:} + All directories and files Rockbox understands (see page \pageref{ref:Supportedfileformats}) are shown. Files and directories starting with . or with the ``hidden'' flag set are hidden. + \item \textbf{All:} + All files and directories are shown. Extensions are shown. No files or directories arehidden + \end{itemize} + + \item \textbf{Follow Playlist} + If Follow Playlist is set to ``Yes'', you will find yourself in the same directory as the currently playing file if you go to the Directory Browser from the WPS. If set to ``No'', you will stay in the same directory as you were last in. + + \item \textbf{Show Icons} + This indicates whether Rockbox will display an icon representing what type a file is on the left of the file in the browser. For details of these icons, please see page \pageref{ref:Supportedfileformats}. + \end{itemize} -\item \textbf{Browse WPS files} - Opens the file browser in the \textbf{/.rockbox} directory and displays all .wps files. Selecting one will activate it, stop will exit back to the menu.\\ - For further information about the WPS see page \pageref{ref:WPS}. For information about editing a .wps file see page \pageref{ref:ConfiguringtheWPS}. + \subsection{\label{ref:Displayoptions}Display Options} -\item \textbf{LCD Settings} - This submenu contains settings that relate to the display of the \dap. \begin{itemize} - \item \textbf{Backlight:} - How long the backlight shines after a key press. Set to OFF to never light it, set to ON to never shut it off or set a preferred timeout period. - \item \textbf{Backlight on WhenPlugged:} - This option turns the backlight on constantly while the charger cable is connected. - \item \textbf{Caption Backlight:} This option turns the backlight on for 25 seconds either side of the start of a new track so that the display can be read to see song information. - \item \textbf{Contrast:} Changes the contrast of your LCD display. Warning: Setting the contrast too dark or too light can make it hard to find this menu option again! + \item \textbf{Browse fonts} + Browse the fonts that reside in your \fname{/.rockbox} directory. Selecting one will activate it. See page \pageref{ref:Loadingfonts} for further details about fonts. + + \item \textbf{Browse WPS files} + Opens the file browser in the \textbf{/.rockbox} directory and displays all .wps files. Selecting one will activate it, stop will exit back to the menu.\\ + For further information about the WPS see page \pageref{ref:WPS}. For information about editing a .wps file see page \pageref{ref:ConfiguringtheWPS}. + + \item \textbf{LCD Settings} + This submenu contains settings that relate to the display of the \dap. + \begin{itemize} + \item \textbf{Backlight:} + How long the backlight shines after a key press. Set to OFF to never light it, set to ON to never shut it off or set a preferred timeout period. + \item \textbf{Backlight on WhenPlugged:} + This option turns the backlight on constantly while the charger cable is connected. + \item \textbf{Caption Backlight:} This option turns the backlight on for 25 seconds either side of the start of a new track so that the display can be read to see song information. + \item \textbf{Contrast:} Changes the contrast of your LCD display. Warning: Setting the contrast too dark or too light can make it hard to find this menu option again! + \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolor,ipodvideo}{ + \item \textbf{LCD Mode}: This setting lets you invert the whole screen, so now you get a black background and green text graphics. + } + \item \textbf{Upside Down: }Displays the screen so that the top of the display is nearest the buttons. This is sometimes useful when carrying the \dap in a pocket for easy access to the headphone socket. + \item \textbf{Line Selector: }Select this option to have a bar of inverted text (``Bar'' option) mark the current line in the File Browser rather than the default arrow to the left (``Pointer'' option). This gives slightly more room for filenames. + \end{itemize} + + \item \textbf{Scrolling} + This feature controls how text will scroll in Rockbox. You can configure the following parameters: + \begin{itemize} + \item \textbf{Scroll Speed:} + Controls how many times per second the scrolling text moves a step. + \item \textbf{Scroll StartDelay:} + Controls how many milliseconds Rockbox should wait before a new text begins scrolling. + \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolor,ipodvideo}{ + \item \textbf{Scroll Step Size:} + Controls how many pixels the text scroll should move for each step. + } + \item \textbf{Bidirectional Scroll Limit: } + Rockbox has two different scroll methods, always scrolling the text to the left, and when the line has ended, beginning again at the start, or moving to the left until you can read the end of the line, and scroll right until you see the beginning again. Rockbox chooses which method it should use, depending of how much it has to scroll left. This setting lets you tell Rockbox where that limit is, expressed in percentage of line length. + \end{itemize} + \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolor,ipodvideo}{ - \item \textbf{LCD Mode}: This setting lets you invert the whole screen, so now you get a black background and green text graphics. + \item \textbf{Status/Scrollbar} + Settings related to on screen status display and the scrollbar. + \begin{itemize} + \item \textbf{Scroll Bar: }Enables or disables the scroll bar at the left. + \item \textbf{Status Bar: }Enables or disables the status bar at the upper side. + \item \textbf{Button Bar:} Enables or disables the button bar prompts for the F keys at the bottom of the screen. + \item \textbf{Volume Display:} Controls whether the volume is displayed as a graphic or a numerical percentage value on the Status Bar. + \item \textbf{Battery Display: }Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar. + \end{itemize} } - \item \textbf{Upside Down: }Displays the screen so that the top of the display is nearest the buttons. This is sometimes useful when carrying the \dap in a pocket for easy access to the headphone socket. - \item \textbf{Line Selector: }Select this option to have a bar of inverted text (``Bar'' option) mark the current line in the File Browser rather than the default arrow to the left (``Pointer'' option). This gives slightly more room for filenames. - \end{itemize} - -\item \textbf{Scrolling} - This feature controls how text will scroll in Rockbox. You can configure the following parameters: - \begin{itemize} - \item \textbf{Scroll Speed:} - Controls how many times per second the scrolling text moves a step. - \item \textbf{Scroll StartDelay:} - Controls how many milliseconds Rockbox should wait before a new text begins scrolling. + \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolor,ipodvideo}{ - \item \textbf{Scroll Step Size:} - Controls how many pixels the text scroll should move for each step. + \item \textbf{Peak Meter} + The peak meter can be configured with a number of parameters. (For a description of the peak meter see page \pageref{ref:Peakmeter}.) + + \begin{itemize} + \item \textbf{Peak Release:} + This determines how fast the bar shrinks when the music becomes softer. Lower values make the peak meter look smoother. + \item \textbf{Peak Hold Time:} + Specifies the time after which the peak indicator will reset. If you set this value e.g. to 5s then the peak indicator displays the loudest volume value that occurred within the last 5 seconds. Big values are good if you want to find the peak level of a song, which might be of interest when copying music from the \dap via the analogue output to some other recording device. + \item \textbf{Clip Hold Time:} + How long the clipping indicator will be visible after clipping was detected + \item \textbf{Performance:} + In high performance mode, the peak meter is updated as often as possible. This reduces the chance of missing a peak value, making the peak meter more precise. In energy save mode the peak meter is updated just often enough to look fluid. This reduces the load on the CPU and thus saves a little bit of energy. If you crave every second of runtime for your \dap or simply use the peak meter as a screen effect, the use of energy save mode is recommended. If you want to use the peak meter as a measuring instrument you'll want to use high performance mode. + \item \textbf{Scale:} + Select whether the peak meter displays linear or logarithmic values. In ``dB'' (decibel) scale the volume values are scaled logarithmically. This very similar to the perception of loudness. The volume meters of digital audio devices usually are scaled this way. If you are interested in the power level that is applied to your headphones you should choose ``linear'' display. Unfortunately this value doesn't have real units like volts or watts since that depends on the phones. So they can only be displayed as percentage values. + \item \textbf{Minimum and maximum range:} + These two options define the full value range that the peak meter displays. Recommended values for dB's are {}-40 for min. and 0 for maximum. For linear display, use 0 and 100\%. Note that {}-40 dB's is approximately 1\% in linear value, but if you change the minimum setting in linear mode slightly and then change to dbFs there will be a large change. You can use these values for 'zooming' into the peak meter. + \end{itemize} } - \item \textbf{Bidirectional Scroll Limit: } - Rockbox has two different scroll methods, always scrolling the text to the left, and when the line has ended, beginning again at the start, or moving to the left until you can read the end of the line, and scroll right until you see the beginning again. Rockbox chooses which method it should use, depending of how much it has to scroll left. This setting lets you tell Rockbox where that limit is, expressed in percentage of line length. \end{itemize} - \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolor,ipodvideo}{ - \item \textbf{Status/Scrollbar} - Settings related to on screen status display and the scrollbar. + \subsection{\label{ref:SystemOptions}System Options} + + \begin{itemize} + \item \textbf{Battery} + Options relating to the batteries in the \dap. \begin{itemize} - \item \textbf{Scroll Bar: }Enables or disables the scroll bar at the left. - \item \textbf{Status Bar: }Enables or disables the status bar at the upper side. - \item \textbf{Button Bar:} Enables or disables the button bar prompts for the F keys at the bottom of the screen. - \item \textbf{Volume Display:} Controls whether the volume is displayed as a graphic or a numerical percentage value on the Status Bar. - \item \textbf{Battery Display: }Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar. + \item \textbf{Battery Capacity} 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.} + This value is used for calculating remaining battery life. + \opt{recorder}{ + \item \textbf{Deep discharge} + Set this to ON if you intend to keep your charger connected for a long period of time. It lets the batteries go down to 10\% before starting to charge again. Setting this to OFF will cause the charging to restart on 95\%. + } + \opt{recorder}{ + \item \textbf{Trickle Charge} + 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} - } - - - \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{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolor,ipodvideo}{ - \item \textbf{Peak Meter} - The peak meter can be configured with a number of parameters. (For a description of the peak meter see page \pageref{ref:Peakmeter}.) + \item \textbf{Disk} + Options relating to the hard disk. \begin{itemize} - \item \textbf{Peak Release:} - This determines how fast the bar shrinks when the music becomes softer. Lower values make the peak meter look smoother. - \item \textbf{Peak Hold Time:} - Specifies the time after which the peak indicator will reset. If you set this value e.g. to 5s then the peak indicator displays the loudest volume value that occurred within the last 5 seconds. Big values are good if you want to find the peak level of a song, which might be of interest when copying music from the jukebox via the analogue output to some other recording device. - \item \textbf{Clip Hold Time:} - How long the clipping indicator will be visible after clipping was detected - \item \textbf{Performance:} - In high performance mode, the peak meter is updated as often as possible. This reduces the chance of missing a peak value, making the peak meter more precise. In energy save mode the peak meter is updated just often enough to look fluid. This reduces the load on the CPU and thus saves a little bit of energy. If you crave every second of runtime for your jukebox or simply use the peak meter as a screen effect, the use of energy save mode is recommended. If you want to use the peak meter as a measuring instrument you'll want to use high performance mode. - \item \textbf{Scale:} - Select whether the peak meter displays linear or logarithmic values. In ``dB'' (decibel) scale the volume values are scaled logarithmically. This very similar to the perception of loudness. The volume meters of digital audio devices usually are scaled this way. If you are interested in the power level that is applied to your headphones you should choose ``linear'' display. Unfortunately this value doesn't have real units like volts or watts since that depends on the phones. So they can only be displayed as percentage values. - \item \textbf{Minimum and maximum range:} - These two options define the full value range that the peak meter displays. Recommended values for dB's are {}-40 for min. and 0 for maximum. For linear display, use 0 and 100\%. Note that {}-40 dB's is approximately 1\% in linear value, but if you change the minimum setting in linear mode slightly and then change to dbFs there will be a large change. You can use these values for 'zooming' into the peak meter. + \item \textbf{DiskSpindown:} + Rockbox has a timer that makes it spin down the hard disk after being idle for acertain time. You can modify this timeout here. 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. + \opt{recorder,h1xx,h300}{ + \item \textbf{Disk Poweroff:} + Whether the disk is powered OFF or only set to ``sleep'' when spun down. Power off uses less power but takes longer to spin{}-up.} \end{itemize} - } -\end{itemize} - -\subsection{\label{ref:SystemOptions}System Options} - -\begin{itemize} -\item \textbf{Battery} - Options relating to the batteries in the \dap. - \begin{itemize} - \item \textbf{Battery Capacity} 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.} - This value is used for calculating remaining battery life. - \opt{recorder}{ - \item \textbf{Deep discharge} - Set this to ON if you intend to keep your charger connected for a long period of time. It lets the batteries go down to 10\% before starting to charge again. Setting this to OFF will cause the charging to restart on 95\%. + + \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. + \end{itemize} } - \opt{recorder}{ - \item \textbf{Trickle Charge} - The Jukebox 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. + + \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 unit 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. \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 (Recorder v2/FM only)} + 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 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). } - \end{itemize} - -\item \textbf{Disk} - Options relating to the hard disk. - - \begin{itemize} - \item \textbf{DiskSpindown:} - Rockbox has a timer that makes it spin down the hard disk after being idle for acertain time. You can modify this timeout here. 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. - \opt{recorder,h1xx,h300}{ - \item \textbf{Disk Poweroff:} - Whether the disk is powered OFF or only set to ``sleep'' when spun down. Power off uses less power but takes longer to spin{}-up.} - \end{itemize} - - \opt{recorder,recorderv2fm,h3xx}{ - \item \textbf{Time and Date} - Time related menu options. + + \item \textbf{Limits} + This submenu relates to limits in the Rockbox operating system. \begin{itemize} - \item \textbf{Set Time/Date: } - Set current time and date. - \item \textbf{Time Format: } - Choose 12 or 24 Hour clock. + \item \textbf{Max files in dir browser:} + Configurable limit of files in the directory browser (file buffer size). 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.\\ + \item \textbf{Max playlist size:} + Option to configure the maximum size of a playlist. The playlist size can be between 1000 and 20000 files in + steps of 1000. By default it is 10000. Higher values will shorten the music buffer.\\ \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 unit 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 jukebox 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 (Recorder v2/FM only)} - This option turns the Jukebox 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 set to ``Yes'', so that the Jukebox 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 Jukebox down, and STOP cancels setting an alarm. If the Jukebox 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:} - Configurable limit of files in the directory browser (file buffer size). 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.\\ - \item \textbf{Max playlist size:} - Option to configure the maximum size of a playlist. The playlist size can be between 1000 and 20000 files in - steps of 1000. By default it is 10000. Higher values will shorten the music buffer.\\ - \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. - When the external power off condition is detected, the Car Adapter Mode function only pauses the playback. In order to shut down the \dap completely the \textbf{Idle Poweroff} function (see above) must also be set. + \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. + + When the external power off condition is detected, the Car Adapter Mode function only pauses the playback. In order to shut down the \dap completely the \textbf{Idle Poweroff} function (see above) must also be set. + + 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 + \end{itemize} + } - If power to the DC in jack is turned back on before the \textbf{Idle Poweroff} function has shut the Jukebox 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 Jukebox 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 Jukebox Player, which is off by default. + \item \textbf{Manage settings} + This submenu deals with loading and saving settings. - This is useful for such applications as: \begin{itemize} - \item Game boy {}-{\textgreater} Jukebox {}-{\textgreater} human - \item laptop {}-{\textgreater} Jukebox {}-{\textgreater}human - \item LAN party computer {}-{\textgreater} Jukebox {}-{\textgreater} human + \item \textbf{Browse .cfg Files: } + This displays a list of configuration (.cfg) files stored in the \textbf{/.rockbox} system directory. This is useful if the \dap is plugged into more than one different output device (e.g. headphones, computer, car stereo, hi{}-fi) so that a settings file can be maintained for each. + \item \textbf{Browse Firmwares:} + This displays a list of firmware file in the \fname{/.rockbox} system directory. 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. + \item \textbf{Reset Settings: } + This wipes the saved settings in the \dap and resets all settings to their default values. + \item \textbf{Write .cfg file: } + Saves the current settings into a .cfg file for later use with \textbf{Browse .cfg Files} above. \end{itemize} - } - -\item \textbf{Manage settings} - This submenu deals with loading and saving settings. + + \end{itemize} + \subsection{\label{ref:Bookmarkconfigactual}Bookmarking} + \begin{itemize} - \item \textbf{Browse .cfg Files: } - This displays a list of configuration (.cfg) files stored in the \textbf{/.rockbox} system directory. This is useful if the \dap is plugged into more than one different output device (e.g. headphones, computer, car stereo, hi{}-fi) so that a settings file can be maintained for each. - \item \textbf{Browse Firmwares:} - This displays a list of firmware file in the \fname{/.rockbox} system directory. 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. - \item \textbf{Reset Settings: } - This wipes the saved settings in the \dap and resets all settings to their default values. - \item \textbf{Write .cfg file: } - Saves the current settings into a .cfg file for later use with \textbf{Browse .cfg Files} above. + \item \textbf{Bookmark on Stop} + Write a bookmark to the disk whenever the stop key is pressed. If playback is stopped it can be resumed easily at a later time. The \textbf{Resume} function remembers your position in the most recently accessed track regardless of this setting. + \item \textbf{Load Last Bookmark} + When this is on, Rockbox automatically returns to the position of the last bookmark within a file when it is played. If set to Ask, Rockbox will ask the user whether they want to start from the beginning or the bookmark. When set to no, playback always starts from the beginning and the Bookmark file must be played or \textbf{Load Bookmark} selected from the \textbf{Bookmarks} submenu of the Main Menu while the file is playing. + \item \textbf{Maintain a list of Recently Used Bookmarks} + If this option is turned on, Rockbox will store a list of Bookmarks that have been accessed recently. This is then accessible from the \textbf{Recent Bookmarks} option of the \textbf{Bookmarks} submenu of the Main Menu. \end{itemize} -\end{itemize} - -\subsection{\label{ref:Bookmarkconfigactual}Bookmarking} - -\begin{itemize} -\item \textbf{Bookmark on Stop} - Write a bookmark to the disk whenever the stop key is pressed. If playback is stopped it can be resumed easily at a later time. The \textbf{Resume} function remembers your position in the most recently accessed track regardless of this setting. -\item \textbf{Load Last Bookmark} - When this is on, Rockbox automatically returns to the position of the last bookmark within a file when it is played. If set to Ask, Rockbox will ask the user whether they want to start from the beginning or the bookmark. When set to no, playback always starts from the beginning and the Bookmark file must be played or \textbf{Load Bookmark} selected from the \textbf{Bookmarks} submenu of the Main Menu while the file is playing. -\item \textbf{Maintain a list of Recently Used Bookmarks} - If this option is turned on, Rockbox will store a list of Bookmarks that have been accessed recently. This is then accessible from the \textbf{Recent Bookmarks} option of the \textbf{Bookmarks} submenu of the Main Menu. -\end{itemize} - -\subsection{\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. - -\subsection{\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. - 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. + \subsection{\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. + + \subsection{Voice} + \begin{itemize} - \item \textbf{Limitations} + \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. + 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. \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. + \item \textbf{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} \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} + \item \textbf{.talk mp3 clip: } + Use special pre{}-recorded MP3 files (\fname{\_dirname.talk}) in each directory. These must be generated in advance, and are typically produced synthetically using a text to speech engine on a PC. If no such file exists, the output is as for the ``numbers'' option below. + \item \textbf{Spell: } + Speak the directory name by spelling it out letter by letter. Support is provided only for the most common letters and punctuation. + \item \textbf{Numbers: } + Each directory is assigned a number based upon its position in the file list. They are then announced as ``Directory 1'', ``Directory 2'' etc. + \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} - -\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} - \item \textbf{.talk mp3 clip: } - Use special pre{}-recorded MP3 files (\fname{\_dirname.talk}) in each directory. These must be generated in advance, and are typically produced synthetically using a text to speech engine on a PC. If no such file exists, the output is as for the ``numbers'' option below. - \item \textbf{Spell: } - Speak the directory name by spelling it out letter by letter. Support is provided only for the most common letters and punctuation. - \item \textbf{Numbers: } - Each directory is assigned a number based upon its position in the file list. They are then announced as ``Directory 1'', ``Directory 2'' etc. - \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. + -- cgit v1.2.3