summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorWilliam Wilgus <me.theuser@yahoo.com>2016-11-22 06:21:31 +0100
committerWilliam Wilgus <me.theuser@yahoo.com>2017-01-17 23:06:17 +0100
commitdc87e9e9f3c383b63c3cb3713886a6c93b6a79d1 (patch)
tree47a6c0d49e7741f91fa74d7230b1267f60617902 /manual
parent16a9f84571276a13f4cfd5c66db8cd63ce4e2e7f (diff)
downloadrockbox-dc87e9e9f3c383b63c3cb3713886a6c93b6a79d1.tar.gz
rockbox-dc87e9e9f3c383b63c3cb3713886a6c93b6a79d1.tar.bz2
rockbox-dc87e9e9f3c383b63c3cb3713886a6c93b6a79d1.zip
Selective Backlight/Advanced Softlock - Selective actions based on context
Selective backlight allows the user to choose actions that will not enable the backlight when pressed. Advanced softlock allows user to choose actions that will not be blocked by screenlock on devices without a hold button. Both only occur in FM and WPS Contexts. Update: Back from the dead -Cleaned up code, removed unnecessary calls, re-arranged last filter action timeout conditional to work in case last_filtered_action_tick was never set -Added entries to the manual -Fixed back button on some menus not activating backlight -Made menus more intuitive, no actions selected now changes menu item to off. -Added talk fuctionality. -Added option to disable selective backlight while on external power. -Rewrote backlight and softlock handling code to fix issue with scrollwheels -Menu changed to have toggle(yes/no) and settings -Optimized selective actions lookup -Added option to disable notification of 'buttons locked' while softlocked -Removed uneeded code, consolidated action lookup to single function -Fixed incorrect name on selective softlock menu -Added option to disable touch on touchscreen devices -Fixed backlight on original screenlock without selective screenlock active -Added text selection in mask_select for when show_icons is off -Fixed voice in mask_select to speak if voice is defined instead of spelling -Added more lang defines (play skip seek) -Added option to disable unknown keys turning on backlight -Fixed Conditional argument In wrong place causing players without backlight to fail to build -Fixed Disable Unknown blocking detection of context change -Fixed canceling menu didn't update new settings -Added Autolock on backlight off -Removed backlight_on_force from backlight.c, Now sets ignore next to false and uses backlight_on -Cleaned up autolock code added strings to lang file -Fixed issue where rapid presses would bypass softlock -Removed old softlock code, Cleaned selective actions code -Changed menu to match existing RB menus -Fixed Backlight_on_Hold blocked by backlight_ignore_next -Fixed ignore_next for ipod -Fixed bug allowing context with softlock to bypass selective backlight -Changed mask_select to no longer prompt for changes to be saved -Changed menu names -Added ignore timeout to allow ipod scroll wheel to work properly and other players to still work properly, removed some previous code including ignore_event -Increased ignore timeout to prevent sd card accesses from interrupting action code and turning on backlight -Changed Unknown action to unmapped action in menu, changed handling code -Removed unneeded logic and variables for handling unfiltered actions -Reverted unmapped action code to previous functionality -Added manual entries (thanks JohnB) -Removed elusive unhandled unicode character from manual, changed formatting slightly Actions: Volume,Play,Seek,Skip Extras: Disable unmapped actions Disable selective backlight on external power Disable touch during softlock on touchscreen devices Disable softlock notifications (power button still notifies) Autolock on backlight off Method: Adds a function to ignore backlight on next call If selected action occurs backlight is forced on, Filter_first_keypress stays intact. Selective softlock allows selected actions through, bypasses the normal softlock routine. ToDo: DONE previous commit (#1) has attribution for folder_select.c which mask_select is based from. Change-Id: I08132ddcfd64c81751ef23b720f3ec6d68695fe4
Diffstat (limited to 'manual')
-rwxr-xr-x[-rw-r--r--]manual/advanced_topics/main.tex243
-rwxr-xr-x[-rw-r--r--]manual/configure_rockbox/display_options.tex66
-rwxr-xr-x[-rw-r--r--]manual/configure_rockbox/system_options.tex71
3 files changed, 234 insertions, 146 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 9ddf680106..92dddb33db 100644..100755
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -62,12 +62,12 @@ in the font package at \url{http://www.rockbox.org/daily.shtml}.}
\subsection{\label{ref:Loadinglanguages}Loading Languages}
\index{Language files}%
-Rockbox can load language files at runtime. Simply copy the \fname{.lng} file
-\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
+Rockbox can load language files at runtime. Simply copy the \fname{.lng} file
+\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
Rockbox directory browser or select \setting{Settings $\rightarrow$
General Settings $\rightarrow$ Language }from the \setting{Main Menu}.\\
-\note{If you want a language to be loaded automatically every time you start
+\note{If you want a language to be loaded automatically every time you start
up, it must be located in the \fname{/.rockbox/langs} directory and the filename
must be a maximum of 24 characters long.\\}
@@ -78,7 +78,7 @@ file find the instructions on the Rockbox website:
\opt{lcd_color}{
\subsection{\label{ref:ChangingFiletypeColours}Changing Filetype Colours}
Rockbox has the capability to modify the \setting{File Browser} to show
- files of different types in different colours, depending on the file extension.
+ files of different types in different colours, depending on the file extension.
\subsubsection{Set-up}
There are two steps to changing the filetype colours -- creating
@@ -100,7 +100,7 @@ file find the instructions on the Rockbox website:
\config{???:FFFFFF}\\*
The permissible extensions are as follows:\\*
- \\
+ \\
\config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa,
\firmwareextension{}, %
\opt{swcodec}{mp1, }mp2, mp3%
@@ -140,7 +140,7 @@ file find the instructions on the Rockbox website:
automatically understands the
\fname{.colours} file format, but an external text editor can
also be used. To edit the \fname{.colours} file using Rockbox,
- ``play'' it in the \setting{File Browser}. The file will open in
+ ``play'' it in the \setting{File Browser}. The file will open in
the \setting{Text Editor}. Upon selecting a line, the following choices
will appear:\\*
\\
@@ -172,7 +172,7 @@ file find the instructions on the Rockbox website:
\subsection{UI Viewport}
By default, the UI is drawn on the whole screen. This can be changed so that
the UI is confined to a specific area of the screen, by use of a UI
- viewport. This is done by adding the following line to the
+ viewport. This is done by adding the following line to the
\fname{.cfg} file for a theme:\\*
\nopt{lcd_non-mono}{\config{ui viewport: X,Y,[width],[height],[font]}}
@@ -196,7 +196,7 @@ file find the instructions on the Rockbox website:
}
Only the first two parameters \emph{have} to be specified, the others can
- be omitted using `-' as a placeholder. The syntax is very similar to WPS
+ be omitted using `-' as a placeholder. The syntax is very similar to WPS
viewports (see \reference{ref:Viewports}). Briefly:
\nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-uivp-syntax.tex}}
@@ -226,7 +226,7 @@ file find the instructions on the Rockbox website:
\subsection{\label{ref:CreateYourOwnWPS}Themes -- Create Your Own}
The theme files are simple text files, and can be created (or edited) in your
-favourite text editor. To make sure non-English characters
+favourite text editor. To make sure non-English characters
display correctly in your theme you must save the theme files with UTF-8
character encoding. This can be done in most editors, for example Notepad in
Windows 2000 or XP (but not in 9x/ME) can do this.
@@ -236,7 +236,7 @@ Windows 2000 or XP (but not in 9x/ME) can do this.
WPS files have the extension \fname{.wps}, FM screen files have the extension
\fname{.fms}, and SBS files have the extension \fname{.sbs}. The main theme
file has the extension \fname{.cfg}. All files should have the same name.
-
+
The theme \fname{.cfg} file should be placed in the \fname{/.rockbox/themes}
directory, while the \fname{.wps}, \fname{.fms} and \fname{.sbs} files should
be placed in the \fname{/.rockbox/wps} directory. Any images used by the
@@ -269,19 +269,19 @@ are discussed below.
\subsubsection{\label{ref:Viewports}Viewports}
By default, a viewport filling the whole screen contains all the elements
-defined in each theme file. The
+defined in each theme file. The
\opt{lcd_non-mono}{elements in this viewport are displayed
with the same background/\linebreak{}foreground
\opt{lcd_color}{colours}\nopt{lcd_color}{shades} and the}
text is rendered in the
same font as in the main menu. To change this behaviour a custom viewport can
-be defined. A viewport is a rectangular window on the screen%
+be defined. A viewport is a rectangular window on the screen%
\opt{lcd_non-mono}{ with its own foreground/background
\opt{lcd_color}{colours}\nopt{lcd_color}{shades}}.
This window also has variable dimensions. To
define a viewport a line starting \config{{\%V(\dots}} has to be
present in the theme file. The full syntax will be explained later in
-this section. All elements placed before the
+this section. All elements placed before the
line defining a viewport are displayed in the default viewport. Elements
defined after a viewport declaration are drawn within that viewport.
\opt{lcd_bitmap}{Loading images (see Appendix \reference{ref:wps_images})
@@ -390,25 +390,25 @@ and the WPS, but you can use multiple fonts in each of the individual screens.\\
\item[If/else: ]
Syntax: \config{\%?xx{\textless}true{\textbar}false{\textgreater}}
-If the tag specified by ``\config{xx}'' has a value, the text between the
+If the tag specified by ``\config{xx}'' has a value, the text between the
``\config{{\textless}}'' and the ``\config{{\textbar}}'' is displayed (the true
-part), else the text between the ``\config{{\textbar}}'' and the
+part), else the text between the ``\config{{\textbar}}'' and the
``\config{{\textgreater}}'' is displayed (the false part).
-The else part is optional, so the ``\config{{\textbar}}'' does not have to be
+The else part is optional, so the ``\config{{\textbar}}'' does not have to be
specified if no else part is desired. The conditionals nest, so the text in the
if and else part can contain all \config{\%} commands, including conditionals.
\item[Enumerations: ]
Syntax: \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}}
-For tags with multiple values, like Play status, the conditional can hold a
+For tags with multiple values, like Play status, the conditional can hold a
list of alternatives, one for each value the tag can have.
-Example enumeration:
+Example enumeration:
\begin{example}
\%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}
\end{example}
-The last else part is optional, and will be displayed if the tag has no value.
+The last else part is optional, and will be displayed if the tag has no value.
The WPS parser will always display the last part if the tag has no value, or if
the list of alternatives is too short.
\end{description}
@@ -419,8 +419,8 @@ about to play after the one currently playing (unless you change the
plan).
If you use the upper-case versions of the
-three tags: \config{F}, \config{I} and \config{D}, they will instead refer to
-the next song instead of the current one. Example: \config{\%Ig} is the genre
+three tags: \config{F}, \config{I} and \config{D}, they will instead refer to
+the next song instead of the current one. Example: \config{\%Ig} is the genre
name used in the next song and \config{\%Ff} is the mp3 frequency.\\
\note{The next song information \emph{will not} be available at all
@@ -430,8 +430,8 @@ name used in the next song and \config{\%Ff} is the mp3 frequency.\\
\subsubsection{\label{ref:AlternatingSublines}Alternating Sublines}
-It is possible to group items on each line into 2 or more groups or
-``sublines''. Each subline will be displayed in succession on the line for a
+It is possible to group items on each line into 2 or more groups or
+``sublines''. Each subline will be displayed in succession on the line for a
specified time, alternating continuously through each defined subline.
Items on a line are broken into sublines with the semicolon
@@ -439,9 +439,9 @@ Items on a line are broken into sublines with the semicolon
each subline defaults to 2 seconds unless modified by using the
`\config{\%t}' tag to specify an alternate
time (in seconds and optional tenths of a second) for the subline to be
-displayed.
+displayed.
-Subline related special characters and tags:
+Subline related special characters and tags:
\begin{description}
\item[;] Split items on a line into separate sublines
\item[\%t] Set the subline display time. The
@@ -469,7 +469,7 @@ Example subline with conditionals:
%?it{\textless}%t(8)%s%it{\textbar}%s%fn{\textgreater};%?ia{\textless}%t(3)%s%ia{\textbar}%t(0){\textgreater}\\
\end{example}
-The format above will do two different things depending if ID3 tags are
+The format above will do two different things depending if ID3 tags are
present. If the ID3 artist and title are present:
\begin{itemize}
\item Display id3 title for 8 seconds,
@@ -481,17 +481,17 @@ If the ID3 artist and title are not present:
\item Display the filename continuously.
\end{itemize}
Note that by using a subline display time of 0 in one branch of a conditional,
-a subline can be skipped (not displayed) when that condition is met.
+a subline can be skipped (not displayed) when that condition is met.
\subsubsection{Using Images}
-You can have as many as 52 images in your WPS. There are various ways of
+You can have as many as 52 images in your WPS. There are various ways of
displaying images:
\begin{enumerate}
\item Load and always show the image, using the \config{\%x} tag
- \item Preload the image with \config{\%xl} and show it with \config{\%xd}.
+ \item Preload the image with \config{\%xl} and show it with \config{\%xd}.
This way you can have your images displayed conditionally.
\nopt{archos}{%
- \item Load an image and show as backdrop using the \config{\%X} tag. The
+ \item Load an image and show as backdrop using the \config{\%X} tag. The
image must be of the same exact dimensions as your display.
}%
\end{enumerate}
@@ -514,12 +514,12 @@ Example on bitmap preloading and use:
%xl(e,rep\_shuffle.bmp,16,64)
%?mm<%xd(b)|%xd(c)|%xd(d)|%xd(e)>
\end{example}
-Four images at the same x and y position are preloaded in the example. Which
+Four images at the same x and y position are preloaded in the example. Which
image to display is determined by the \config{\%mm} tag (the repeat mode).
\subsubsection{Example File}
\begin{example}
- %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]>
+ %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]>
%pb%pc/%pt
\end{example}
That is, ``tracknum -- title [artist, album]'', where most fields are only
@@ -531,7 +531,7 @@ title [artist]''.
% %s%?it<%?in<%in. |>%it|%fn>
% %s%?ia<%ia|%?d2<%d(2)|(root)>>
% %s%?id<%id|%?d1<%d(1)|(root)>> %?iy<(%iy)|>
-%
+%
% %al%pc/%pt%ar[%pp:%pe]
% %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>
% %pb
@@ -552,25 +552,25 @@ a \fname{car.cfg} file for the settings that you use while playing your
jukebox in your car, and a \fname{headphones.cfg} file to store the
settings that you use while listening to your \dap{} through headphones.
-See \reference{ref:cfg_specs} below for an explanation of the format
+See \reference{ref:cfg_specs} below for an explanation of the format
for configuration files. See \reference{ref:manage_settings_menu} for an
explanation of how to create, edit and load configuration files.
\subsection{\label{ref:cfg_specs}Specifications for \fname{.cfg} Files}
-The Rockbox configuration file is a plain text file, so once you use the
-\setting{Save .cfg file} option to create the file, you can edit the file on
+The Rockbox configuration file is a plain text file, so once you use the
+\setting{Save .cfg file} option to create the file, you can edit the file on
your computer using any text editor program. See
-Appendix \reference{ref:config_file_options} for available settings. Configuration
+Appendix \reference{ref:config_file_options} for available settings. 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.
+\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}
Example of a configuration file:
@@ -586,17 +586,17 @@ Example of a configuration file:
lang: /.rockbox/afrikaans.lng
\end{example}
-\note{As you can see from the example, 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, suppose 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 are
- in the car, and a regular LCD setting when you are 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 \fname{car.cfg},
- \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg
- files} option to quickly change settings.\\}
+\note{As you can see from the example, 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, suppose 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 are
+ in the car, and a regular LCD setting when you are 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 \fname{car.cfg},
+ \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg
+ files} option to quickly change settings.\\}
A special case configuration file can be used to force a particular setting
or settings every time Rockbox starts up (e.g. to set the volume to a safe
@@ -604,35 +604,35 @@ Example of a configuration file:
and save it into the \fname{/.rockbox} directory with the filename
\fname{fixed.cfg}.
-\subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings}
- menu} The \setting{Manage Settings} menu can be found in the \setting{Main
- Menu}. The \setting{Manage Settings} menu allows you to save and load
+\subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings}
+ menu} The \setting{Manage Settings} menu can be found in the \setting{Main
+ Menu}. The \setting{Manage Settings} menu allows you to save and load
\fname{.cfg} files.
\begin{description}
-
+
\item [Browse .cfg Files]Opens the \setting{File Browser} in the
\fname{/.rockbox} directory and displays all \fname{.cfg} (configuration)
files. Selecting a \fname{.cfg} file will cause Rockbox to load the settings
contained in that file. Pressing \ActionStdCancel{} will exit back to the
\setting{Manage Settings} menu. See the \setting{Write .cfg files} option on
- the \setting{Manage Settings} menu for details of how to save and edit a
+ the \setting{Manage Settings} menu for details of how to save and edit a
configuration file.
-
+
\item [Reset Settings]This wipes the saved settings
- in the \dap{} and resets all settings to their default values.
-
+ in the \dap{} and resets all settings to their default values.
+
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD%
,PBELL_VIBE500_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{
- \note{You can also reset all settings to their default
+ \note{You can also reset all settings to their default
values by turning off the \dap, turning it back on, and holding the
\ButtonRec{} button immediately after the \dap{} turns on.}
- }
+ }
\opt{IRIVER_H10_PAD}{\note{You can also reset all settings to
their default values by turning off the \dap, and turning it back on
with the \ButtonHold{} button on.}
}
- \opt{IPOD_4G_PAD}{\note{You can also reset all settings to their default
+ \opt{IPOD_4G_PAD}{\note{You can also reset all settings to their default
values by turning off the \dap, turning it back on, and activating the
\ButtonHold{} button immediately after the backlight comes on.}
}
@@ -641,23 +641,23 @@ Example of a configuration file:
\ButtonA{} button immediately after the \dap{} turns on.}
}
-\item [Save .cfg File]This option writes a \fname{.cfg} file to
- your \daps{} disk. The configuration file has the \fname{.cfg}
- extension and is used to store all of the user settings that are described
+\item [Save .cfg File]This option writes a \fname{.cfg} file to
+ your \daps{} disk. The configuration file has the \fname{.cfg}
+ extension and is used to store all of the user settings that are described
throughout this manual.
- Hint: Use the \setting{Save .cfg File} feature (\setting{Main Menu
- $\rightarrow$ Manage Settings}) to save the current settings, then
- use a text editor to customize the settings file. See Appendix
- \reference{ref:config_file_options} for the full reference of available
+ Hint: Use the \setting{Save .cfg File} feature (\setting{Main Menu
+ $\rightarrow$ Manage Settings}) to save the current settings, then
+ use a text editor to customize the settings file. See Appendix
+ \reference{ref:config_file_options} for the full reference of available
options.
-
-\item [Save Sound Settings]This option writes a \fname{.cfg} file to
- your \daps{} disk. The configuration file has the \fname{.cfg}
+
+\item [Save Sound Settings]This option writes a \fname{.cfg} file to
+ your \daps{} disk. The configuration file has the \fname{.cfg}
extension and is used to store all of the sound related settings.
-
-\item [Save Theme Settings]This option writes a \fname{.cfg} file to
- your \daps{} disk. The configuration file has the \fname{.cfg}
+
+\item [Save Theme Settings]This option writes a \fname{.cfg} file to
+ your \daps{} disk. The configuration file has the \fname{.cfg}
extension and is used to store all of the theme related settings.
\end{description}
@@ -665,16 +665,16 @@ Example of a configuration file:
\section{\label{ref:FirmwareLoading}Firmware Loading}
\opt{player,recorder,recorderv2fm,ondio}{
When your \dap{} powers on, it loads the Archos firmware in ROM, which
- automatically checks your \daps{} root directory for a file named
- \firmwarefilename. Note that Archos firmware can only read the first
- ten characters of each filename in this process, so do not rename your old
- firmware files with names like \firmwarefilename.\fname{old} and so on,
- because it is possible that the \dap{} will load a file other than the one
+ automatically checks your \daps{} root directory for a file named
+ \firmwarefilename. Note that Archos firmware can only read the first
+ ten characters of each filename in this process, so do not rename your old
+ firmware files with names like \firmwarefilename.\fname{old} and so on,
+ because it is possible that the \dap{} will load a file other than the one
you intended.
}
\subsection{\label{ref:using_rolo}Using ROLO (Rockbox Loader)}
-Rockbox is able to load and start another firmware file without rebooting.
+Rockbox is able to load and start another firmware file without rebooting.
You just ``play'' a file with the extension %
\opt{recorder,recorderv2fm,ondio}{\fname{.ajz}.} %
\opt{player}{\fname{.mod}.} %
@@ -690,76 +690,79 @@ current version.
\opt{archos}{\input{advanced_topics/archos-flashing.tex}}
\section{Optimising battery runtime}
- Rockbox offers a lot of settings that have high impact on the battery runtime
+ Rockbox offers a lot of settings that have high impact on the battery runtime
of your \dap{}. The largest power savings can be achieved through disabling
unneeded hardware components -- for some of those there are settings
- available.
+ available.
+
+
\opt{swcodec}{
Another area of savings is avoiding or reducing CPU boosting
- through disabling computing intense features (e.g. sound processing) or
- using effective audio codecs.
-} The following provides a short overview of the most relevant settings and
+ through disabling computing intense features (e.g. sound processing) or
+ using effective audio codecs.
+} The following provides a short overview of the most relevant settings and
rules of thumb.
\nopt{ondio}{
\subsection{Display backlight}
The active backlight consumes a lot of power. Therefore choose a setting that
- disables the backlight after timeout (for setting \setting{Backlight} see
- \reference{ref:Displayoptions}). Avoid to have the backlight enabled all the
- time.
+ disables the backlight after timeout (for setting \setting{Backlight} see
+ \reference{ref:Displayoptions}). Avoid having the backlight enabled all the
+ time (Activating \setting{selectivebacklight}
+ \reference{ref:selectivebacklight} can further reduce power consumption).
}
\opt{lcd_sleep}{
\subsection{Display power-off}
- Shutting down the display and the display controller saves a reasonable amount
+ Shutting down the display and the display controller saves a reasonable amount
of power. Choose a setting that will put the display to sleep after timeout
- (for setting \setting{Sleep} see \reference{ref:Displayoptions}). Avoid to
+ (for setting \setting{Sleep} see \reference{ref:Displayoptions}). Avoid to
have the display enabled all the time -- even, if the display is transflective
- and is readable without backlight. Depending on your \dap{} it might be
- significantly more efficient to re-enable the display and its backlight for a
+ and is readable without backlight. Depending on your \dap{} it might be
+ significantly more efficient to re-enable the display and its backlight for a
glimpse a few times per hour than to keep the display enabled.
}
\opt{accessory_supply}{
\subsection{Accessory power supply}
As default your \dap{}'s accessory power supply is always enabled to ensure
- proper function of connected accessory devices. Disable this power supply, if
- -- or as long as -- you do not use any accessory device with your \dap{} while
+ proper function of connected accessory devices. Disable this power supply, if
+ -- or as long as -- you do not use any accessory device with your \dap{} while
running Rockbox (see \reference{ref:AccessoryPowerSupply}).
}
\opt{lineout_poweroff}{
\subsection{Line Out}
- Rockbox allows to switch off the line-out on your \dap{}. If you do not need
+ Rockbox allows to switch off the line-out on your \dap{}. If you do not need
the line-out, switch it off (see \reference{ref:LineoutOnOff}).
}
\opt{spdif_power}{
\subsection{Optical Output}
- Rockbox allows to switch off the S/PDIF output on your \dap{}. If you do not
+ Rockbox allows to switch off the S/PDIF output on your \dap{}. If you do not
need this output, switch it off (see \reference{ref:SPDIF_OnOff}).
}
\opt{disk_storage}{
\subsection{Anti-Skip Buffer}
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
+ battery life. It is recommended to always use the lowest possible setting
that allows correct and continuous playback (see \reference{ref:AntiSkipBuf}).
}
\opt{swcodec}{
\subsection{Replaygain}
- Replaygain is a post processing that equalises the playback volume of audio
- files to the same perceived loudness. This post processing applies a factor
- to each single PCM sample and is therefore consuming additional CPU time. If
- you want to achieve some (minor) savings in runtime, switch this feature off
+ Replaygain is a post processing that equalises the playback volume of audio
+ files to the same perceived loudness. This post processing applies a factor
+ to each single PCM sample and is therefore consuming additional CPU time. If
+ you want to achieve some (minor) savings in runtime, switch this feature off
(see \reference{ref:ReplayGain}).
}
\opt{lcd_bitmap}{
\subsection{Peak Meter}
- The peak meter is a feature of the While Playing Screen and will be updated with a
- high framerate. Depending on your \dap{} this might result in a high CPU load. To
+ The peak meter is a feature of the While Playing Screen and will be updated with a
+ high framerate. Depending on your \dap{} this might result in a high CPU load. To
save battery runtime you should switch this feature off (see \reference{ref:peak_meter}).
\opt{ipodvideo}{
\note{Especially the \playerman{} \playertype{} suffers from an enabled peak meter.}
@@ -770,36 +773,36 @@ current version.
\subsection{Audio format and bitrate}
\opt{swcodec}{
In general the fastest decoding audio format will be the best in terms of
- battery runtime on your \dap{}. An overview of different codec's performance
+ battery runtime on your \dap{}. An overview of different codec's performance
on different \dap{}s can be found at \wikilink{CodecPerformanceComparison}.
}
\opt{flash_storage}{
Your target uses flash that consumes a certain amount of power during access.
- The less often the flash needs to be switched on for buffering and the shorter
- the buffering duration is, the lower is the overall power consumption.
- Therefore the bitrate of the audio files does have an impact on the battery
- runtime as well. Lower bitrate audio files will result in longer battery
+ The less often the flash needs to be switched on for buffering and the shorter
+ the buffering duration is, the lower is the overall power consumption.
+ Therefore the bitrate of the audio files does have an impact on the battery
+ runtime as well. Lower bitrate audio files will result in longer battery
runtime.
}
\opt{disk_storage}{
Your target uses a hard disk which consumes a large amount of power while
- spinning -- up to several hundred mA. The less often the hard disk needs to
- spin up for buffering and the shorter the buffering duration is, the lower is
- the power consumption. Therefore the bitrate of the audio files does have an
- impact on the battery runtime as well. Lower bitrate audio files will result
+ spinning -- up to several hundred mA. The less often the hard disk needs to
+ spin up for buffering and the shorter the buffering duration is, the lower is
+ the power consumption. Therefore the bitrate of the audio files does have an
+ impact on the battery runtime as well. Lower bitrate audio files will result
in longer battery runtime.
}
- Please do not re-encode any existing audio files from one lossy format to
+ Please do not re-encode any existing audio files from one lossy format to
another based upon the above mentioned. This will reduce the audio quality.
- If you have the choice, select the best suiting codec when encoding the
+ If you have the choice, select the best suiting codec when encoding the
original source material.
}
\opt{swcodec}{
\subsection{Sound settings}
In general all kinds of sound processing will need more CPU time and therefore
- consume more power. The less sound processing you use, the better it is for
+ consume more power. The less sound processing you use, the better it is for
the battery runtime (for options see \reference{ref:configure_rockbox_sound}).
}
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index c872f08031..163b1e884c 100644..100755
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -1,6 +1,6 @@
% $Id$ %
\section{\label{ref:Displayoptions}Display}
-
+
\begin{description}
\item[LCD Settings.]
@@ -32,14 +32,14 @@
\item[Backlight Fade In.]
The amount of time that the backlight will take to fade from off to on
after a button is pressed. If set to \setting{Off} the backlight will
- turn on immediately, with no fade in. Can also be set to
+ turn on immediately, with no fade in. Can also be set to
\setting{500ms}, \setting{1s} or \setting{2s}.
\item[Backlight Fade Out.]
Like Backlight fade in, this controls the amount of time that the
backlight will take to fade from on to off after a button is pressed. If
set to \setting{Off} the backlight will turn off immediately, with no
fade out. Other valid values: \setting{500ms}, \setting{1s},
- \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or
+ \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or
\setting{10s}.
}
\opt{backlight_fade_bool}{
@@ -56,21 +56,51 @@
With this option enabled the first keypress while the backlight is turned
off will only turn the backlight on without having any other effect. When
disabled the first keypress will \emph{also} perform its appropriate action.
-
+
+ \item[\label{ref:selectivebacklight}Selective Backlight]
+ This option allows some selected actions in While Playing Screen and
+ FM screen to \emph{not} turn on the backlight in order to save power.
+ \begin{description}
+ \item[Enabled.]
+ Enables/disables the feature.
+
+ \item[Settings.]
+ Allows to select actions that will \emph{not} activate backlight.
+ \begin{itemize}
+ \item[Volume.]
+ Volume up/down.
+ \item[Play.]
+ Toggling Play/Pause.
+ \item[Seek.]
+ Seeking in a track.
+ \item[Skip.]
+ Skipping of a track.
+ \item[Disable Unmapped Keys.]
+ Buttons that have no action assigned and accidental button
+ combinations don't turn on backlight.
+ \item[Disable on External Power.]
+ When plugged goes back to regular behavior.
+ \end{itemize}
+ Selected actions are indicated by a leading +.
+ Note: If all options get de-selected, the entire feature is disabled.
+ \end{description}
+
+
+
\opt{lcd_sleep}{
\item[Sleep (After Backlight Off).]
This setting controls how long rockbox will wait before turning off the
display after the backlight is turned off. Turning off the display
- saves battery power but turning on the display takes noticeably longer
+ saves battery power but turning on the display takes noticeably longer
than just turning on the backlight.
}
-
+
\opt{backlight_brightness}{
\item[Brightness.]
Changes the brightness of your LCD display.
}
} % \opt{HAVE_BACKLIGHT}
-
+
\opt{lcd_contrast}{
\item[Contrast.]
Changes the contrast of your LCD display.
@@ -122,7 +152,7 @@
This setting lets you invert the whole screen, so now you get a
black background and light text and graphics.
\item[Upside Down.]
- Displays the screen so that the top of the display is nearest
+ 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.
\opt{remote_ticking}{
@@ -138,7 +168,7 @@
the following parameters:
\begin{description}
\item[Scroll Speed.]
- Sets how many times per second the automatic horizontal scrolling text
+ Sets how many times per second the automatic horizontal scrolling text
will move a step.
\item[Scroll Start Delay.]
Controls how many milliseconds Rockbox should wait before a new
@@ -184,23 +214,23 @@
useful on slow displays.
\nopt{scrollwheel}{
\item[List Acceleration Start Delay.]
- This setting enables the acceleration of scroll speed in lists when
- holding \ActionStdPrev{} or \ActionStdNext{}. When set to
- \setting{Off} the acceleration is disabled. When any other value is set
+ This setting enables the acceleration of scroll speed in lists when
+ holding \ActionStdPrev{} or \ActionStdNext{}. When set to
+ \setting{Off} the acceleration is disabled. When any other value is set
the acceleration will start to accelerate after holding
- \ActionStdPrev{} or \ActionStdNext{} for the chosen time (in
+ \ActionStdPrev{} or \ActionStdNext{} for the chosen time (in
seconds).
\item[List Acceleration Speed.]
- This setting controls how fast the scroll speed accelerates. The scroll
- speed will increase every N seconds. For example, selecting
- \setting{Speed up every 3s} will increase the scroll speed every 3
+ This setting controls how fast the scroll speed accelerates. The scroll
+ speed will increase every N seconds. For example, selecting
+ \setting{Speed up every 3s} will increase the scroll speed every 3
seconds while \ActionStdPrev{} or \ActionStdNext{} is held.
}
\end{description}
%
\opt{lcd_bitmap}{
\item[Peak Meter.]
- The peak meter can be configured with a number of parameters.
+ The peak meter can be configured with a number of parameters.
\begin{description}
\item[Peak Release.]
This determines how fast the bar shrinks when the music becomes
@@ -216,7 +246,7 @@
\item[Clip Hold Time.]
The number of seconds that the clipping indicator will be visible
after clipping is detected.
- \opt{recording}{
+ \opt{recording}{
\item[Clip Counter.]
Show the number of times the clip indicator went active during
recording in front of the peak meters.
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index b505175a68..ff2967cec7 100644..100755
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -167,11 +167,11 @@ this option \setting{On}. If it is not required, then turning this setting
\opt{lineout_poweroff}{
\subsection{\label{ref:LineoutOnOff}Line Out}
-This option turns the \dap{}'s line-out \setting{On} and \setting{Off}. On some
-devices an enabled line-out will consume some power even if not used. If it is
-not required, then turning this setting \setting{Off} will save battery and
+This option turns the \dap{}'s line-out \setting{On} and \setting{Off}. On some
+devices an enabled line-out will consume some power even if not used. If it is
+not required, then turning this setting \setting{Off} will save battery and
therefore result in better runtime.
-}
+}
\opt{HAVE_BUTTON_LIGHTS}{
\opt{e200,e200v2}{
@@ -243,6 +243,61 @@ therefore result in better runtime.
+
+\nopt{HAS_BUTTON_HOLD}{
+ \subsection{Advanced Key Lock}
+ This option allows users to select actions that when within WPS or FMS will \emph{not} be
+ blocked by the key lock (software hold switch).
+
+
+ \begin{description}
+ \item[Enabled.]
+ Enables/disables the feature.
+
+ \item[Settings.]
+ Allows to select actions that will \emph{not} be blocked by the key lock.
+ \begin{itemize}
+ \item[Volume.]
+ Volume up/down.
+ \item[Play.]
+ Toggling Play/Pause.
+ \item[Seek.]
+ Seeking in a track.
+ \item[Skip.]
+ Skipping of a track.
+ \opt{HAVE_BACKLIGHT}{
+ \item[Autolock On.]
+ When the backlight turns off, softlock will lock the screen,
+ activates when you press the lock key and if you manually lock
+ again, while active it then disables autolock.
+ \begin{itemize}
+ \item
+ (Lock Button Pressed \#1) >Auto Lock On
+ (device still unlocked till backlight timeout).
+ \item
+ (Lock Button Pressed \#2) >Auto Lock Off (device locked).
+ \item
+ (Lock Button Pressed \#3) >(device unlocked).
+ \end{itemize}
+ } %\opt{HAVE_BACKLIGHT}
+ \opt{touchpad}{
+ \item[Disable Touch.]
+ Blocks touch screen buttons like the original.
+ }
+ \item[Disable Notify.]
+ Suppresses the notification 'Buttons Locked'
+ (still will if power button is pressed).
+ \note{This is a pre-requisite for \setting{selectivebacklight}
+ \reference{ref:selectivebacklight} to work also during key lock.}
+
+ \end{itemize}
+ Selected actions are indicated by a leading +.
+ Note: If all options get de-selected, the entire feature is disabled.
+
+ \end{description}
+} %\nopt{HAS_BUTTON_HOLD}
+
+
\opt{usb_hid}{
\subsection{\label{ref:USB_HID}USB HID}
This option turns the USB HID feature \setting{On} and \setting{Off}.
@@ -550,7 +605,7 @@ therefore result in better runtime.
\\
\end{btnmap}
- \item [Browser.] This mode lets you control a web browser (e.g.
+ \item [Browser.] This mode lets you control a web browser (e.g.
Firefox). It uses the \dap{}'s keys to navigate through the web page
and different tabs, navigate through history, and to control zoom.
@@ -592,7 +647,7 @@ therefore result in better runtime.
\\
}
- % Zoom in / out
+ % Zoom in / out
\opt{SANSA_FUZEPLUS_PAD}{Long \ButtonBottomRight}
\opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
{Long \ButtonUp / Long \ButtonDown}
@@ -707,13 +762,13 @@ therefore result in better runtime.
,SANSA_CLIP_PAD,MROBE100_PAD,PBELL_VIBE500_PAD,SANSA_FUZEPLUS_PAD%
,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}
{\ButtonUp / \ButtonDown / \ButtonLeft / \ButtonRight}
- \opt{IRIVER_H10_PAD}{\ButtonScrollUp / \ButtonScrollDown /
+ \opt{IRIVER_H10_PAD}{\ButtonScrollUp / \ButtonScrollDown /
\ButtonLeft / \ButtonRight}
\opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}
{\ButtonMenu / \ButtonPlay / \ButtonLeft / \ButtonRight}
&
\opt{HAVEREMOTEKEYMAP}{
- \opt{MROBE100_RC_PAD}{\ButtonRCPlay / \ButtonRCDisplay /
+ \opt{MROBE100_RC_PAD}{\ButtonRCPlay / \ButtonRCDisplay /
\ButtonRCRew / \ButtonRCFF}%
&}
Cursor move up / down / left / right, respectively