devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Manual: remove most HWCODEC artifacts

Browse source 
This causes 3 changes in layout. 2 I can't track down and 1 is better this way.

Change-Id: If4ad5e1d7431b4c2cbaaf9767d78139ef4e2dc44
This commit is contained in:
Moshe Piekarski 2020-11-16 18:14:31 -05:00
parent 7c87467ba4
commit 0aa702836b
24 changed files with 451 additions and 613 deletions
Download patch file Download diff file Expand all files Collapse all files

81
manual/advanced_topics/main.tex
View file

@ -42,29 +42,26 @@ Rockbox allows you to choose a plugin to run for select menu options.
Simply choose the option in the setting menu and choose the plugin Simply choose the option in the setting menu and choose the plugin
you would like to run. you would like to run.
\opt{lcd_bitmap}{
\subsection{\label{ref:GettingExtras}Getting Extras} \subsection{\label{ref:GettingExtras}Getting Extras}
Rockbox supports custom fonts. A collection of fonts is available for download Rockbox supports custom fonts. A collection of fonts is available for download
in the font package at \url{http://www.rockbox.org/daily.shtml}.} in the font package at \url{http://www.rockbox.org/daily.shtml}.
\opt{lcd_bitmap}{ \subsection{\label{ref:Loadingfonts}Loading Fonts}\index{Fonts}
\subsection{\label{ref:Loadingfonts}Loading Fonts}\index{Fonts} Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the
Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the \dap{} and ``play'' it in the \setting{File Browser}. If you want a font to
\dap{} and ``play'' it in the \setting{File Browser}. If you want a font to be loaded automatically every time you start up, it must be located in the
be loaded automatically every time you start up, it must be located in the \fname{/.rockbox/fonts} directory and the filename must be at most 24 characters
\fname{/.rockbox/fonts} directory and the filename must be at most 24 characters long. You can browse the fonts in \fname{/.rockbox/fonts} under
long. You can browse the fonts in \fname{/.rockbox/fonts} under \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font}
\setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font} in the \setting{Main Menu}.\\
in the \setting{Main Menu}.\\
\note{Advanced Users Only: Any BDF font should \note{Advanced Users Only: Any BDF font should
be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use
the \fname{convbdf} tool. This tool can be found in the \fname{tools} the \fname{convbdf} tool. This tool can be found in the \fname{tools}
directory of the Rockbox source code. See \wikilink{CreateFonts\#ConvBdf} directory of the Rockbox source code. See \wikilink{CreateFonts\#ConvBdf}
for more details. Or just run \fname{convbdf} without any parameters to for more details. Or just run \fname{convbdf} without any parameters to
see the possible options.} see the possible options.}
}
\subsection{\label{ref:Loadinglanguages}Loading Languages} \subsection{\label{ref:Loadinglanguages}Loading Languages}
\index{Language files}% \index{Language files}%
@ -109,15 +106,13 @@ file find the instructions on the Rockbox website:
\\ \\
\config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa, \config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa,
\firmwareextension{}, % \firmwareextension{}, %
\opt{swcodec}{mp1, }mp2, mp3% mp1, mp2, mp3, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, wv,
\opt{swcodec}{, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, spc, ape,
wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, mac, sap, mpg, mpeg%
spc, ape, mac, sap}%
\opt{lcd_bitmap}{\opt{swcodec}{, mpg, mpeg}}%
\opt{HAVE_REMOTE_LCD}{, rwps}% \opt{HAVE_REMOTE_LCD}{, rwps}%
\opt{lcd_non-mono}{, bmp}% \opt{lcd_non-mono}{, bmp}%
\opt{radio}{, fmr}% \opt{radio}{, fmr}%
\opt{lcd_bitmap}{, fnt, kbd}}\\* , fnt, kbd}\\*
%It'd be ideal to get these from filetypes.c %It'd be ideal to get these from filetypes.c
All file extensions that are not either specifically listed in the All file extensions that are not either specifically listed in the
@ -286,8 +281,8 @@ 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 line defining a viewport are displayed in the default viewport. Elements
defined after a viewport declaration are drawn within that viewport. defined after a viewport declaration are drawn within that viewport.
\opt{lcd_bitmap}{Loading images (see Appendix \reference{ref:wps_images}) Loading images (see Appendix \reference{ref:wps_images})
should be done within the default viewport.} should be done within the default viewport.
A viewport ends either with the end of the file, or with the next viewport A viewport ends either with the end of the file, or with the next viewport
declaration line. Viewports sharing the same declaration line. Viewports sharing the same
coordinates and dimensions cannot be displayed at the same time. Viewports coordinates and dimensions cannot be displayed at the same time. Viewports
@ -526,18 +521,17 @@ That is, ``tracknum -- title [artist, album]'', where most fields are only
displayed if available. Could also be rendered as ``filename'' or ``tracknum -- displayed if available. Could also be rendered as ``filename'' or ``tracknum --
title [artist]''. title [artist]''.
%\opt{lcd_bitmap}{ %\begin{verbatim}
% \begin{verbatim} % %s%?it<%?in<%in. |>%it|%fn>
% %s%?it<%?in<%in. |>%it|%fn> % %s%?ia<%ia|%?d2<%d(2)|(root)>>
% %s%?ia<%ia|%?d2<%d(2)|(root)>> % %s%?id<%id|%?d1<%d(1)|(root)>> %?iy<(%iy)|>
% %s%?id<%id|%?d1<%d(1)|(root)>> %?iy<(%iy)|>
% %
% %al%pc/%pt%ar[%pp:%pe] % %al%pc/%pt%ar[%pp:%pe]
% %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)> % %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>
% %pb % %pb
% %pm % %pm
% % \end{verbatim} %
%} %\end{verbatim}
\section{\label{ref:manage_settings}Managing Rockbox Settings} \section{\label{ref:manage_settings}Managing Rockbox Settings}
@ -713,11 +707,10 @@ current version.
available. available.
\opt{swcodec}{
Another area of savings is avoiding or reducing CPU boosting Another area of savings is avoiding or reducing CPU boosting
through disabling computing intense features (e.g. sound processing) or through disabling computing intense features (e.g. sound processing) or
using effective audio codecs. using effective audio codecs.
} The following provides a short overview of the most relevant settings and The following provides a short overview of the most relevant settings and
rules of thumb. rules of thumb.
\subsection{Display backlight} \subsection{Display backlight}
@ -765,16 +758,13 @@ current version.
that allows correct and continuous playback (see \reference{ref:AntiSkipBuf}). that allows correct and continuous playback (see \reference{ref:AntiSkipBuf}).
} }
\opt{swcodec}{
\subsection{Replaygain} \subsection{Replaygain}
Replaygain is a post processing that equalises the playback volume of audio Replaygain is a post processing that equalises the playback volume of audio
files to the same perceived loudness. This post processing applies a factor 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 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 you want to achieve some (minor) savings in runtime, switch this feature off
(see \reference{ref:ReplayGain}). (see \reference{ref:ReplayGain}).
}
\opt{lcd_bitmap}{
\subsection{Peak Meter} \subsection{Peak Meter}
The peak meter is a feature of the While Playing Screen and will be updated with a 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 high framerate. Depending on your \dap{} this might result in a high CPU load. To
@ -782,15 +772,11 @@ current version.
\opt{ipodvideo}{ \opt{ipodvideo}{
\note{Especially the \playerman{} \playertype{} suffers from an enabled peak meter.} \note{Especially the \playerman{} \playertype{} suffers from an enabled peak meter.}
} }
}
\opt{swcodec,disk_storage,flash_storage}{
\subsection{Audio format and bitrate} \subsection{Audio format and bitrate}
\opt{swcodec}{
In general the fastest decoding audio format will be the best in terms of 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}. on different \dap{}s can be found at \wikilink{CodecPerformanceComparison}.
}
\opt{flash_storage}{ \opt{flash_storage}{
Your target uses flash that consumes a certain amount of power during access. Your target uses flash that consumes a certain amount of power during access.
@ -813,11 +799,8 @@ current version.
another based upon the above mentioned. This will reduce the audio quality. 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. original source material.
}
\opt{swcodec}{
\subsection{Sound settings} \subsection{Sound settings}
In general all kinds of sound processing will need more CPU time and therefore 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}). the battery runtime (for options see \reference{ref:configure_rockbox_sound}).
}

2
manual/appendix/appendix.tex
View file

@ -3,7 +3,7 @@
\input{appendix/file_formats.tex} \input{appendix/file_formats.tex}
\opt{lcd_bitmap}{\input{appendix/album_art_info.tex}} \input{appendix/album_art_info.tex}
\input{appendix/wps_tags.tex} \input{appendix/wps_tags.tex}

11
manual/appendix/config_file_options.tex
View file

@ -64,9 +64,7 @@
bidir limit & 0 to 200 & \% screen\\ bidir limit & 0 to 200 & \% screen\\
scroll paginated & on, off & N/A\\ scroll paginated & on, off & N/A\\
hold\_lr\_for\_scroll\_in\_list & on, off & N/A\\ hold\_lr\_for\_scroll\_in\_list & on, off & N/A\\
\opt{lcd_bitmap}{ show path in browser & off, current directory, full path & N/A\\
show path in browser & off, current directory, full path & N/A\\
}
contrast & 0 to 63 & N/A\\ contrast & 0 to 63 & N/A\\
backlight timeout backlight timeout
& off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
@ -167,7 +165,6 @@
list\_accel\_wait & 1 to 10 & s\\ list\_accel\_wait & 1 to 10 & s\\
} }
% %
\opt{swcodec}{
replaygain type replaygain type
& track, album, track shuffle, off & track, album, track shuffle, off
& N/A\\ & N/A\\
@ -232,7 +229,6 @@
keyclick repeats & on, off & N/A\\ keyclick repeats & on, off & N/A\\
dircache & on, off & N/A\\ dircache & on, off & N/A\\
tagcache\_ram & on, off & N/A\\ tagcache\_ram & on, off & N/A\\
}%
\opt{touchpad}{ \opt{touchpad}{
\opt{GIGABEAT_PAD}{ \opt{GIGABEAT_PAD}{
@ -244,7 +240,6 @@
} }
}% }%
\opt{lcd_bitmap}{
peak meter release peak meter release
& 1 to 126 & ?\\ & 1 to 126 & ?\\
peak meter hold peak meter hold
@ -284,12 +279,8 @@
show icons & on, off & N/A\\ show icons & on, off & N/A\\
iconset & /path/filename.bmp & N/A\\ iconset & /path/filename.bmp & N/A\\
viewers iconset & /path/filename.bmp & N/A\\ viewers iconset & /path/filename.bmp & N/A\\
}%
\opt{swcodec}{% This doesn't depend on swcodec but using a \nopt here
% causes ondiosp not to build for mysterious reasons.
backdrop & /path/filename.bmp & N/A\\ backdrop & /path/filename.bmp & N/A\\
}%
\opt{lcd_color}{ \opt{lcd_color}{
foreground colour & 000000 to FFFFFF & RRGGBB\\ foreground colour & 000000 to FFFFFF & RRGGBB\\

8
manual/appendix/file_formats.tex
View file

@ -6,18 +6,14 @@
& \textbf{Action when selected}}{}{} & \textbf{Action when selected}}{}{}
\includegraphics[width=0.37cm]{appendix/images/icon-directory.png} \includegraphics[width=0.37cm]{appendix/images/icon-directory.png}
& Directory & \emph{none} & Enter the directory \tabularnewline & Directory & \emph{none} & Enter the directory \tabularnewline
\opt{swcodec}{
\includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png}
& Audio file & \emph{various}\newline% & Audio file & \emph{various}\newline%
(see \ref{ref:Supportedaudioformats})% (see \ref{ref:Supportedaudioformats})%
% do NOT use \reference{} here as that will break the table. % do NOT use \reference{} here as that will break the table.
& Start playing the file and show the WPS\tabularnewline & Start playing the file and show the WPS\tabularnewline
}
& Bookmark & \fname{.bmark} & Display all bookmarks for an audio file\tabularnewline & Bookmark & \fname{.bmark} & Display all bookmarks for an audio file\tabularnewline
\opt{lcd_bitmap}{
& Game of Life & \fname{.cells} & Show the configuration with the & Game of Life & \fname{.cells} & Show the configuration with the
``Rocklife'' plugin\tabularnewline ``Rocklife'' plugin\tabularnewline
}
\includegraphics[width=0.37cm]{appendix/images/icon-config.png} \includegraphics[width=0.37cm]{appendix/images/icon-config.png}
& Configuration File & \fname{.cfg} & Load the settings file\tabularnewline & Configuration File & \fname{.cfg} & Load the settings file\tabularnewline
\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} \includegraphics[width=0.37cm]{appendix/images/icon-chip8.png}
@ -62,10 +58,8 @@
\includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png}
& Rockbox firmware & \fname{.mi4} & Load the new firmware with ROLO \tabularnewline & Rockbox firmware & \fname{.mi4} & Load the new firmware with ROLO \tabularnewline
} }
\opt{swcodec}{
\includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png}
& Video & \fname{.mpg}, \fname{.mpeg}, \fname{.mpv}, \fname{.m2v} & Play the MPEG1/2 video \tabularnewline & Video & \fname{.mpg}, \fname{.mpeg}, \fname{.mpv}, \fname{.m2v} & Play the MPEG1/2 video \tabularnewline
}
\includegraphics[width=0.37cm]{appendix/images/icon-rock.png} \includegraphics[width=0.37cm]{appendix/images/icon-rock.png}
& Plugin & \fname{.rock} & Start the plugin\tabularnewline & Plugin & \fname{.rock} & Start the plugin\tabularnewline
\opt{sansaAMS}{ \opt{sansaAMS}{
@ -79,7 +73,6 @@
& While Playing Screen & \fname{.wps} & Load the new WPS display configuration\tabularnewline & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\tabularnewline
\end{rbtabular} \end{rbtabular}
\opt{swcodec}{
\chapter{Audio and metadata formats} \chapter{Audio and metadata formats}
\section{\label{ref:Supportedaudioformats}Supported audio formats} \section{\label{ref:Supportedaudioformats}Supported audio formats}
\subsection{Lossy Codecs} \subsection{Lossy Codecs}
@ -375,4 +368,3 @@
to 90 bytes. to 90 bytes.
} }
\end{enumerate} \end{enumerate}
}

19
manual/appendix/wps_tags.tex
View file

@ -159,11 +159,10 @@ or \config{\%D(2)}), produce the information for the next file to be played.
\section{Playlist/Song Info} \section{Playlist/Song Info}
\begin{tagmap} \begin{tagmap}
\config{\%pb} & Progress Bar. \config{\%pb} & Progress Bar.
\opt{lcd_bitmap}{ This will replace the entire line with a progress bar.
This will replace the entire line with a progress bar. You can set the position, width and height of the progressbar
You can set the position, width and height of the progressbar (in pixels) and load a custom image for it:
(in pixels) and load a custom image for it: \config{\%pb(x,y,[width],[height],image.bmp)} \\
\config{\%pb(x,y,[width],[height],image.bmp)}} \\
\config{\%px} & Percentage played in song\\ \config{\%px} & Percentage played in song\\
\config{\%pc} & Current time in song\\ \config{\%pc} & Current time in song\\
\config{\%pe} & Total number of playlist entries\\ \config{\%pe} & Total number of playlist entries\\
@ -181,8 +180,8 @@ or \config{\%D(2)}), produce the information for the next file to be played.
\config{\%pv} & Current volume (in dB). Can also be used in a conditional: \config{\%pv} & Current volume (in dB). Can also be used in a conditional:
\config{\%?pv<Mute|\ldots|0 dB|Above 0 dB>}\newline \config{\%?pv<Mute|\ldots|0 dB|Above 0 dB>}\newline
Mute is 0\% volume, \ldots is the values between Mute and max, 0 dB is max volume, and Above 0 dB is amplified volume Mute is 0\% volume, \ldots is the values between Mute and max, 0 dB is max volume, and Above 0 dB is amplified volume
\opt{lcd_bitmap}{This can also be used like \%pb to provide a continuous scale: This can also be used like \%pb to provide a continuous scale:
\config{\%pv(x,y,[width],[height],image.bmp)}} \\ \config{\%pv(x,y,[width],[height],image.bmp)} \\
\config{\%pS} & Track is starting. An optional number gives how many seconds \config{\%pS} & Track is starting. An optional number gives how many seconds
the tag remains true for after the start of the track. The default is the tag remains true for after the start of the track. The default is
10 seconds if no number is specified. 10 seconds if no number is specified.
@ -227,20 +226,16 @@ or \config{\%D(2)}), produce the information for the next file to be played.
\config{\%ra} & Autoscore for the song\\ \config{\%ra} & Autoscore for the song\\
\end{tagmap} \end{tagmap}
\opt{swcodec}{
\section{Sound (DSP) settings} \section{Sound (DSP) settings}
\begin{tagmap} \begin{tagmap}
\config{\%Sp} & Current playback pitch \\ \config{\%Sp} & Current playback pitch \\
\opt{swcodec}{
\config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip, \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip,
Shuffle, Shuffle and Man Skip, Always\\ Shuffle, Shuffle and Man Skip, Always\\
\config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional, \config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional,
Replaygain type in use: \config{\%?rg<Off|Track% Replaygain type in use: \config{\%?rg<Off|Track%
|Album|TrackShuffle|AlbumShuffle% |Album|TrackShuffle|AlbumShuffle%
|No tag>}\\ |No tag>}\\
}
\end{tagmap} \end{tagmap}
}
\section{Hold} \section{Hold}
\begin{tagmap} \begin{tagmap}
@ -360,13 +355,11 @@ Examples:
\end{enumerate} \end{enumerate}
\opt{lcd_bitmap}{
\section{\label{ref:wps_images}Images} \section{\label{ref:wps_images}Images}
\begin{tagmap} \begin{tagmap}
\config{\%X(filename.bmp)} \config{\%X(filename.bmp)}
& Load and set a backdrop image for the WPS. & Load and set a backdrop image for the WPS.
This image must be exactly the same size as your LCD.\\ This image must be exactly the same size as your LCD.\\
}%
\config{\%x(n,filename[,x,y])} \config{\%x(n,filename[,x,y])}
& Load and display an image\newline & Load and display an image\newline
\config{n}: image ID for later referencing in \config{\%xd}\newline \config{n}: image ID for later referencing in \config{\%xd}\newline

6
manual/configure_rockbox/bookmarking.tex
View file

@ -1,9 +1,9 @@
% $Id$ % % $Id$ %
\section{\label{ref:Bookmarkconfigactual}Bookmarking} \section{\label{ref:Bookmarkconfigactual}Bookmarking}
Bookmarks allow you to save your current position within a track so that Bookmarks allow you to save your current position within a track so that
you can return to it at a later time. \opt{swcodec}{Bookmarks also store you can return to it at a later time. Bookmarks also store rate, pitch
rate, pitch and speed information from the \setting{Pitch Screen} (see and speed information from the \setting{Pitch Screen} (see
\reference{sec:pitchscreen}).} Bookmarks are saved on a per directory \reference{sec:pitchscreen}). Bookmarks are saved on a per directory
basis or for individual (saved) playlists. You can store multiple bookmarks, basis or for individual (saved) playlists. You can store multiple bookmarks,
even for the same track. When there's already a bookmark for a directory or even for the same track. When there's already a bookmark for a directory or
playlist, new bookmarks are added before existing ones. playlist, new bookmarks are added before existing ones.

117
manual/configure_rockbox/display_options.tex
View file

@ -173,11 +173,9 @@
\item[Scroll Start Delay.] \item[Scroll Start Delay.]
Controls how many milliseconds Rockbox should wait before a new Controls how many milliseconds Rockbox should wait before a new
text begins automatically scrolling. text begins automatically scrolling.
\opt{lcd_bitmap}{
\item[Scroll Step Size.] \item[Scroll Step Size.]
Defines the number of pixels the text should move for each step, as used Defines the number of pixels the text should move for each step, as used
by the Scroll Speed setting. by the Scroll Speed setting.
}
\opt{remote}{ \opt{remote}{
\item[Remote Scrolling Options.] \item[Remote Scrolling Options.]
The options here have the same effect on the remote LCD as the options The options here have the same effect on the remote LCD as the options
@ -191,22 +189,20 @@
Rockbox chooses which method it should use depending of how much it has to Rockbox chooses which method it should use depending of how much it has to
scroll to the left. This setting lets you tell Rockbox where that limit scroll to the left. This setting lets you tell Rockbox where that limit
is, expressed in percentage of the line length. is, expressed in percentage of the line length.
\opt{lcd_bitmap}{ \item[Screen Scrolls Out of View.]
\item[Screen Scrolls Out of View.] Screens can be manually scrolled horizontally by pressing
Screens can be manually scrolled horizontally by pressing \opt{IRIVER_H10_PAD}{Long \ButtonRew/\ButtonFF}%
\opt{IRIVER_H10_PAD}{Long \ButtonRew/\ButtonFF}% \opt{IRIVER_H10_PAD,XDUOO_X3_PAD}{Long \ButtonPrev/\ButtonNext}%
\opt{IRIVER_H10_PAD,XDUOO_X3_PAD}{Long \ButtonPrev/\ButtonNext}% \nopt{IRIVER_H10_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,XDUOO_X3_PAD%
\nopt{IRIVER_H10_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,XDUOO_X3_PAD% ,touchscreen}{%
,touchscreen}{% Long \ButtonRight/\ButtonLeft}.
Long \ButtonRight/\ButtonLeft}. Setting this option to \setting{Yes}
Setting this option to \setting{Yes} will keep the list entries at their fixed positions and allow them to be
will keep the list entries at their fixed positions and allow them to be scrolled out of view, whereas \setting{No} will only scroll those entries
scrolled out of view, whereas \setting{No} will only scroll those entries which surpass the right margin.
which surpass the right margin. \item[Screen Scroll Step Size.]
\item[Screen Scroll Step Size.] Defines the number of pixels the horizontal manual screen scroll should move
Defines the number of pixels the horizontal manual screen scroll should move for each step.
for each step.
}
\item[Paged Scrolling.] \item[Paged Scrolling.]
When set to \setting{Yes} scrolling vertically on pages that surpass the When set to \setting{Yes} scrolling vertically on pages that surpass the
screen size will page up/down instead of simply changing lines. This can be screen size will page up/down instead of simply changing lines. This can be
@ -227,50 +223,49 @@
} }
\end{description} \end{description}
% %
\opt{lcd_bitmap}{ \item[Peak Meter.]
\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}
\begin{description} \item[Peak Release.]
\item[Peak Release.] This determines how fast the bar shrinks when the music becomes
This determines how fast the bar shrinks when the music becomes softer. Lower values make the peak meter look smoother.
softer. Lower values make the peak meter look smoother. Expressed in scale units per 10~ms.
Expressed in scale units per 10~ms. \item[Peak Hold Time.]
\item[Peak Hold Time.] Specifies the time after which the peak indicator will reset.
Specifies the time after which the peak indicator will reset. For example, if you set this value to 5~s, the peak indicator displays
For example, if you set this value to 5~s, the peak indicator displays the loudest volume value that occurred within the last 5 seconds.
the loudest volume value that occurred within the last 5 seconds. Larger values are useful if you want to find the peak level of a song,
Larger values are useful if you want to find the peak level of a song, which might be of interest when copying music from the \dap\ via the
which might be of interest when copying music from the \dap\ via the analogue output to some other recording device.
analogue output to some other recording device. \item[Clip Hold Time.]
\item[Clip Hold Time.] The number of seconds that the clipping indicator will be visible
The number of seconds that the clipping indicator will be visible after clipping is detected.
after clipping is detected. \opt{recording}{
\opt{recording}{ \item[Clip Counter.]
\item[Clip Counter.] Show the number of times the clip indicator went active during
Show the number of times the clip indicator went active during recording in front of the peak meters.
recording in front of the peak meters.
}
\item[\label{ref:Peakmetersetting}Scale.]
Select whether the peak meter displays linear or logarithmic values.
The human ear perceives loudness on a logarithmic scale. If the Scale
setting is set to \setting{Logarithmic} (dB) scale, the volume values
are scaled logarithmically. The volume meters of digital audio
devices usually are scaled this way. On the other hand, if you
are interested in the power level that is applied to your headphones
you should choose \setting{Linear} display. This setting cannot be
displayed in units like volts or watts because such units depend
on your headphones.
\item[Minimum and maximum range.]
These two options define the full value range that the peak meter
displays. Recommended values for the \setting{Logarithmic} (dB) setting
are {}-40~dB for minimum and 0~dB for maximum. Recommended values
for \setting{Linear} display are 0 and 100\%. Note that {}-40~dB is
approximately 1\% in linear value, but if you change the minimum
setting in linear mode slightly and then change to the dB scale,
there will be a large change. You can use these values for `zooming'
into the peak meter.
\end{description}
} }
\item[\label{ref:Peakmetersetting}Scale.]
Select whether the peak meter displays linear or logarithmic values.
The human ear perceives loudness on a logarithmic scale. If the Scale
setting is set to \setting{Logarithmic} (dB) scale, the volume values
are scaled logarithmically. The volume meters of digital audio
devices usually are scaled this way. On the other hand, if you
are interested in the power level that is applied to your headphones
you should choose \setting{Linear} display. This setting cannot be
displayed in units like volts or watts because such units depend
on your headphones.
\item[Minimum and maximum range.]
These two options define the full value range that the peak meter
displays. Recommended values for the \setting{Logarithmic} (dB) setting
are {}-40~dB for minimum and 0~dB for maximum. Recommended values
for \setting{Linear} display are 0 and 100\%. Note that {}-40~dB is
approximately 1\% in linear value, but if you change the minimum
setting in linear mode slightly and then change to the dB scale,
there will be a large change. You can use these values for `zooming'
into the peak meter.
\end{description}
\item[\label{ref:Defaultcodepage}Default Codepage.] \item[\label{ref:Defaultcodepage}Default Codepage.]
A codepage describes the way extended characters that are not available A codepage describes the way extended characters that are not available
within the ASCII character set are encoded. ID3v1 tags do not have a within the ASCII character set are encoded. ID3v1 tags do not have a

4
manual/configure_rockbox/main.tex
View file

@ -16,9 +16,9 @@
\input{configure_rockbox/system_options.tex} \input{configure_rockbox/system_options.tex}
\input{configure_rockbox/startup_shutdown_options.tex} \input{configure_rockbox/startup_shutdown_options.tex}
\input{configure_rockbox/bookmarking.tex} \input{configure_rockbox/bookmarking.tex}
\opt{tagcache}{\opt{swcodec}{ \opt{tagcache}{
\input{configure_rockbox/autoresume.tex} \input{configure_rockbox/autoresume.tex}
}} }
\input{configure_rockbox/language.tex} \input{configure_rockbox/language.tex}
\input{configure_rockbox/voice.tex} \input{configure_rockbox/voice.tex}
\input{configure_rockbox/wps_context_plugin.tex} \input{configure_rockbox/wps_context_plugin.tex}

234
manual/configure_rockbox/playback_options.tex
View file

@ -68,10 +68,8 @@ you to configure settings related to audio playback.
This can happen if the \dap{} is knocked, shaken or jogged heavily while This can happen if the \dap{} is knocked, shaken or jogged heavily while
Rockbox is trying to read the hard drive. Rockbox is trying to read the hard drive.
\opt{swcodec}{ The anti-skip buffer can be set to various values between
The anti-skip buffer can be set to various values between 5 seconds and 10 minutes.\\
5 seconds and 10 minutes.\\
}
\note{Having a large anti-skip buffer tends to use more power, and may \note{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 reduce your battery life. It is recommended to always use the lowest
@ -90,110 +88,108 @@ you to configure settings related to audio playback.
instead of being played immediately. Pausing and stopping playback is instead of being played immediately. Pausing and stopping playback is
disabled as well as skipping songs and launching plugins. disabled as well as skipping songs and launching plugins.
\opt{swcodec}{ \opt{crossfade}{
\opt{crossfade}{ \section{Crossfade}
\section{Crossfade} This section controls the behavior of the crossfader. The crossfader, when
This section controls the behavior of the crossfader. The crossfader, when enabled, smoothly fades one track into the next. This can occur in two
enabled, smoothly fades one track into the next. This can occur in two situations: an automatic track change or a manual track skip. An automatic
situations: an automatic track change or a manual track skip. An automatic track change occurs at the end of the track, moving to the next track in the
track change occurs at the end of the track, moving to the next track in the playlist without user intervention. A manual track skip goes to the next
playlist without user intervention. A manual track skip goes to the next track immediately when the appropriate button is pressed.\\
track immediately when the appropriate button is pressed.\\
Options for crossfade settings are: Options for crossfade settings are:
\begin{description} \begin{description}
\item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled
and all track changes are gapless. If set to and all track changes are gapless. If set to
\setting{Automatic Track Change Only}, crossfade occurs for automatic \setting{Automatic Track Change Only}, crossfade occurs for automatic
track changes, but not for manual track skips. The next setting, track changes, but not for manual track skips. The next setting,
\setting{Manual Track Skip Only}, is the opposite: tracks will only \setting{Manual Track Skip Only}, is the opposite: tracks will only
crossfade when manually skipped. If set to \setting{Shuffle}, crossfade crossfade when manually skipped. If set to \setting{Shuffle}, crossfade
is enabled for all track changes, automatic or manual, when the shuffle is enabled for all track changes, automatic or manual, when the shuffle
feature is set to \setting{Yes}, but disabled otherwise. If set to feature is set to \setting{Yes}, but disabled otherwise. If set to
\setting{Shuffle or Manual Track Skip} then crossfade will be active \setting{Shuffle or Manual Track Skip} then crossfade will be active
either when shuffle is set to \setting{Yes} or the track is manually either when shuffle is set to \setting{Yes} or the track is manually
skipped. If set to \setting{Always}, tracks will always crossfade into skipped. If set to \setting{Always}, tracks will always crossfade into
one another. one another.
% %
\item[Fade In Delay.] The ``fade in delay'' is the length of time between \item[Fade In Delay.] The ``fade in delay'' is the length of time between
when the crossfade process begins and when the new track begins to fade when the crossfade process begins and when the new track begins to fade
in. in.
% %
\item[Fade In Duration.] The length of time, in seconds, that it takes \item[Fade In Duration.] The length of time, in seconds, that it takes
your music to fade in once the \setting{Fade In Delay} has ended. your music to fade in once the \setting{Fade In Delay} has ended.
% %
\item[Fade Out Delay.] The ``fade out delay'' is the length of time \item[Fade Out Delay.] The ``fade out delay'' is the length of time
between when the crossfade process begins and when the old track begins between when the crossfade process begins and when the old track begins
to fade out. to fade out.
% %
\item[Fade Out Duration.] The length of time, in seconds, that it takes \item[Fade Out Duration.] The length of time, in seconds, that it takes
your music to fade out once the \setting{Fade Out Delay} has ended. your music to fade out once the \setting{Fade Out Delay} has ended.
% %
\item[Fade Out Mode.] If set to \setting{Crossfade}, one song will fade \item[Fade Out Mode.] If set to \setting{Crossfade}, one song will fade
out and the next song will simultaneously fade in. If set to out and the next song will simultaneously fade in. If set to
\setting{Mix}, the ending song will not fade out at all, and will \setting{Mix}, the ending song will not fade out at all, and will
continue to play as normal until its end with the starting song fading continue to play as normal until its end with the starting song fading
in from under it. \setting{Mix} mode is not used for manual track skips, in from under it. \setting{Mix} mode is not used for manual track skips,
even if it is selected here. even if it is selected here.
\end{description} \end{description}
\note{The rules above apply except in the instance where \note{The rules above apply except in the instance where
\setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then \setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then
\setting{Fade In Delay} (which would create a gap in the audio). In this case, \setting{Fade In Delay} (which would create a gap in the audio). In this case,
the \setting{Fade In Delay} is reduced to eliminate the gap.\\} the \setting{Fade In Delay} is reduced to eliminate the gap.\\}
The graphic below illustrates how the different settings work in practice. The graphic below illustrates how the different settings work in practice.
\includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png} \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png}
}%\opt{crossfade} }%\opt{crossfade}
\section{\label{ref:ReplayGain}Replaygain} \section{\label{ref:ReplayGain}Replaygain}
This allows you to control the replaygain function. This allows you to control the replaygain function.
The purpose of replaygain is to adjust the volume of the music played The purpose of replaygain is to adjust the volume of the music played
so that all songs (or albums, depending on your settings) have the so that all songs (or albums, depending on your settings) have the
same apparent volume. This prevents sudden changes in volume when same apparent volume. This prevents sudden changes in volume when
changing between songs recorded at different volume levels. changing between songs recorded at different volume levels.
For replaygain to work, the songs must have been processed by a program For replaygain to work, the songs must have been processed by a program
that adds replaygain information to the ID3 tags (or Vorbis tags).\\ that adds replaygain information to the ID3 tags (or Vorbis tags).\\
Options for replaygain are: Options for replaygain are:
\begin{description} \begin{description}
\item[Replaygain Type.] Choose the type of replaygain to apply: \item[Replaygain Type.] Choose the type of replaygain to apply:
\begin{description} \begin{description}
\item[Album Gain.] Maintain a constant volume level between \item[Album Gain.] Maintain a constant volume level between
albums, but keep any intentional volume variations between albums, but keep any intentional volume variations between
songs in an album. (If album gain value is not available, songs in an album. (If album gain value is not available,
uses track gain information). uses track gain information).
%
\item[Track Gain.] Maintain a constant volume level between
tracks. If track gain value is not available, no replaygain
is applied.
%
\item[Track Gain If Shuffling.] Maintains a constant volume
between tracks if \setting{Shuffle} is set to \setting{Yes}.
Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
%
\item[Off.] Do not process replaygain information, i.e. turn off
the replaygain function.
\end{description}
% %
\item[Prevent Clipping.] Avoid clipping of a song's waveform. \item[Track Gain.] Maintain a constant volume level between
If a song would clip during playback, the volume is lowered for tracks. If track gain value is not available, no replaygain
that song. Replaygain information is needed for this to work. is applied.
% %
\item[Pre-amp.] This allows you to adjust the volume when replaygain \item[Track Gain If Shuffling.] Maintains a constant volume
is applied. Replaygain often lowers the volume, sometimes quite between tracks if \setting{Shuffle} is set to \setting{Yes}.
much, so here you can compensate for that. Please note that a Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
(large) positive pre-amp setting can cause clipping, unless %
prevent clipping is enabled. The pre-amp can be set to any \item[Off.] Do not process replaygain information, i.e. turn off
decibel (dB) value between -12~dB and +12~dB, in increments of 0.5~dB. the replaygain function.
\end{description} \end{description}
%
\item[Prevent Clipping.] Avoid clipping of a song's waveform.
If a song would clip during playback, the volume is lowered for
that song. Replaygain information is needed for this to work.
%
\item[Pre-amp.] This allows you to adjust the volume when replaygain
is applied. Replaygain often lowers the volume, sometimes quite
much, so here you can compensate for that. Please note that a
(large) positive pre-amp setting can cause clipping, unless
prevent clipping is enabled. The pre-amp can be set to any
decibel (dB) value between -12~dB and +12~dB, in increments of 0.5~dB.
\end{description}
\section{Track Skip Beep} \section{Track Skip Beep}
Controls the volume of the beep that is heard when Controls the volume of the beep that is heard when
skipping forward or backward between tracks. The beep is disabled when skipping forward or backward between tracks. The beep is disabled when
set to \setting{Off}. set to \setting{Off}.
}%\opt{swcodec}
\opt{spdif_power}{ \opt{spdif_power}{
\section{\label{ref:SPDIF_OnOff}Optical Output} \section{\label{ref:SPDIF_OnOff}Optical Output}
@ -294,32 +290,28 @@ you to configure settings related to audio playback.
if a track ends, which can be achieved by combining this option with if a track ends, which can be achieved by combining this option with
\setting{Repeat} set to \setting{One} \setting{Repeat} set to \setting{One}
\opt{swcodec}{ \section{Rewind Before Resume}\index{Rewind Before Resume}
\section{Rewind Before Resume}\index{Rewind Before Resume} When restarting a track or a bookmark, a short rewind can be done before the
When restarting a track or a bookmark, a short rewind can be done before the playback is started. This can be useful when listening to speech material,
playback is started. This can be useful when listening to speech material, to help remember what was being said just before playback was stopped.
to help remember what was being said just before playback was stopped. The size of the rewind can be set to various values between 0 (off) and
The size of the rewind can be set to various values between 0 (off) and 60 seconds.
60 seconds. \note{This option does not apply to resuming a paused track. Use
\note{This option does not apply to resuming a paused track. Use the next option for rewinding on pause.}
the next option for rewinding on pause.} \note{The actual rewind distance may differ a little from the requested
\note{The actual rewind distance may differ a little from the requested value, depending on the file in question.}
value, depending on the file in question.}
}%\opt{swcodec}
\section{Rewind on Pause}\index{Rewind on Pause} \section{Rewind on Pause}\index{Rewind on Pause}
This option rewinds the current track by a small amount whenever it is This option rewinds the current track by a small amount whenever it is
paused (not stopped). The amount to rewind can be set between 0 and paused (not stopped). The amount to rewind can be set between 0 and
15 seconds. 15 seconds.
\opt{swcodec}{ \opt{play_frequency}{
\opt{play_frequency}{ \section{Frequency}\index{Frequency}
\section{Frequency}\index{Frequency} This is the sampling frequency used for the rockbox playback engine. Audio
This is the sampling frequency used for the rockbox playback engine. Audio at a different sampling rate will be converted to this sampling rate prior to
at a different sampling rate will be converted to this sampling rate prior to mixing using a cubic Hermite polynomial resampler.
mixing using a cubic Hermite polynomial resampler. \note{For best quality and battery life, select the sampling rate used by
\note{For best quality and battery life, select the sampling rate used by your audio. This is typically 44.1kHz.}
your audio. This is typically 44.1kHz.} \note{Opus files are always 48kHz.}
\note{Opus files are always 48kHz.} }
}
}%\opt{swcodec}

27
manual/configure_rockbox/recording_settings.tex
View file

@ -6,16 +6,14 @@
where you want to store them in the \setting{File Browser} and select where you want to store them in the \setting{File Browser} and select
\setting{Set As Recording Directory}.} \setting{Set As Recording Directory}.}
\opt{swcodec}{ \section{Format}
\section{Format} Choose which format to save your recording in. The available choices are
Choose which format to save your recording in. The available choices are the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the
the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the losslessly compressed \setting{WavPack} and the lossy
losslessly compressed \setting{WavPack} and the lossy \setting{MPEG Layer~3}.
\setting{MPEG Layer~3}.
\section{Encoder Settings (MP3 only)} \section{Encoder Settings (MP3 only)}
This sets the bitrate when using the \setting{MPEG Layer~3} format. This sets the bitrate when using the \setting{MPEG Layer~3} format.
}
\section{Frequency} \section{Frequency}
\nopt{ipodnano,ipodcolor,ipod4g}{ \nopt{ipodnano,ipodcolor,ipod4g}{
@ -39,9 +37,8 @@
22.05~kHz, 16~kHz, 12~kHz, 11.025~kHz and 8~kHz} 22.05~kHz, 16~kHz, 12~kHz, 11.025~kHz and 8~kHz}
are available. Higher sample rates use up more disk space, but give better are available. Higher sample rates use up more disk space, but give better
sound quality. sound quality.
\opt{swcodec}{\note{The 11.025~kHz setting is not available when using % \note{The 11.025~kHz setting is not available when using %
\setting{MPEG Layer~3} format.} \setting{MPEG Layer~3} format.}
}
\opt{recording_digital} \opt{recording_digital}
{\note{You cannot change the sample rate for digital recordings.} {\note{You cannot change the sample rate for digital recordings.}
} }
@ -80,11 +77,9 @@
for mono recording, only the left channel is recorded. Mono recordings for mono recording, only the left channel is recorded. Mono recordings
are usually somewhat smaller than stereo. are usually somewhat smaller than stereo.
\opt{swcodec}{ \section{Mono Mode}
\section{Mono Mode} When configured to record to mono and the source is a stereo signal, use this
When configured to record to mono and the source is a stereo signal, use this setting to configure how the mono signal is created. Options are L, R and L+R.
setting to configure how the mono signal is created. Options are L, R and L+R.
}
\section{File Split Options} \section{File Split Options}
This sub menu contains options for file splitting, which can be used to split This sub menu contains options for file splitting, which can be used to split

16
manual/configure_rockbox/sound_settings.tex
View file

@ -197,7 +197,6 @@ change to customise your listening experience.
}% }%
} }
\opt{swcodec}{
\section{Crossfeed} \section{Crossfeed}
Crossfeed attempts to make the experience of listening to music on Crossfeed attempts to make the experience of listening to music on
headphones more similar to listening to music with stereo speakers. When you headphones more similar to listening to music with stereo speakers. When you
@ -250,9 +249,7 @@ change to customise your listening experience.
% http://www.ohl.to/interests-in-audio/crossfeed-and-eq-for-headphones/ % http://www.ohl.to/interests-in-audio/crossfeed-and-eq-for-headphones/
Beware that the crossfeed function is capable of making the audio distort Beware that the crossfeed function is capable of making the audio distort
if you choose settings which result in a too high output level. if you choose settings which result in a too high output level.
}
\opt{swcodec}{
\section{\label{ref:EQ}Equalizer} \section{\label{ref:EQ}Equalizer}
\screenshot{configure_rockbox/images/ss-equalizer}{The graphical equalizer}{} \screenshot{configure_rockbox/images/ss-equalizer}{The graphical equalizer}{}
Rockbox features a parametric equalizer (EQ). In contrast to non-parametric Rockbox features a parametric equalizer (EQ). In contrast to non-parametric
@ -472,9 +469,7 @@ configure the EQ, or use the presets for designing their own custom EQ
settings. settings.
\end{description} \end{description}
}
\opt{swcodec}{
\section{Dithering} \section{Dithering}
This setting controls the dithering and noise shaping functionality of Rockbox. This setting controls the dithering and noise shaping functionality of Rockbox.
@ -500,9 +495,7 @@ and not easily noticable.
Rockbox uses highpass triangular distribution noise as the dithering noise Rockbox uses highpass triangular distribution noise as the dithering noise
source, and a third order noise shaper. source, and a third order noise shaper.
}
\opt{swcodec}{%
\opt{pitchscreen}{% \opt{pitchscreen}{%
\section{Timestretch} \section{Timestretch}
Enabling \setting{Timestretch} allows you to change the playback speed without Enabling \setting{Timestretch} allows you to change the playback speed without
@ -512,9 +505,7 @@ intended for speech playback and may significantly dilute your listening
experience with more complex audio. See \reference{sec:pitchscreen} for more experience with more complex audio. See \reference{sec:pitchscreen} for more
details about how to use the feature. details about how to use the feature.
} }
}
\opt{swcodec}{
\section{Haas Surround} \section{Haas Surround}
This setting implements the Haas effect with adjustable delay time to enhance This setting implements the Haas effect with adjustable delay time to enhance
the stereo effect of the sound. A full range Haas effect creates the impression the stereo effect of the sound. A full range Haas effect creates the impression
@ -526,25 +517,19 @@ and \setting{f(x2)} to set frequencies which are not affected. The \setting{SIDE
setting uses mid-side processing to determine and apply effect to the side channel only. setting uses mid-side processing to determine and apply effect to the side channel only.
Finally, the \setting{Dry/Wet Mix} setting adjusts the proportion mixed from the Finally, the \setting{Dry/Wet Mix} setting adjusts the proportion mixed from the
original (dry) and 'effected' (wet) signals. original (dry) and 'effected' (wet) signals.
}
\opt{swcodec}{
\section{Perceptual Bass Enhancement} \section{Perceptual Bass Enhancement}
This setting implements a group delay correction and an additional biophonic EQ to This setting implements a group delay correction and an additional biophonic EQ to
emphasize to boost bass perception. The \setting{precut} setting provides emphasize to boost bass perception. The \setting{precut} setting provides
negative overall gain to prevent possible audio distortion due to the EQ negative overall gain to prevent possible audio distortion due to the EQ
gain. The defult precut value is set to -2.5 dB and can be adjust from 0 dB to -4.5 dB. gain. The defult precut value is set to -2.5 dB and can be adjust from 0 dB to -4.5 dB.
Note that this effect will stack with any other EQ applied. Note that this effect will stack with any other EQ applied.
}
\opt{swcodec}{
\section{Auditory Fatigue Reduction} \section{Auditory Fatigue Reduction}
Human hearing is more senstive to some frequency bands. This setting applies additional Human hearing is more senstive to some frequency bands. This setting applies additional
equalization and bi-shelf filtering to reduce signals in these bands to minimize equalization and bi-shelf filtering to reduce signals in these bands to minimize
the chance that temporary threshold shift (auditory fatigue) occurs. the chance that temporary threshold shift (auditory fatigue) occurs.
}
\opt{swcodec}{
\section{Compressor} \section{Compressor}
The \setting{Compressor} reduces, or compresses, the dynamic range of the audio The \setting{Compressor} reduces, or compresses, the dynamic range of the audio
signal. This makes the quieter and louder sections closer to the same volume signal. This makes the quieter and louder sections closer to the same volume
@ -592,4 +577,3 @@ the input signal is reduced appropriately, but the gain isn't allowed to
immediately return to normal levels. This is necessary to reduce artifacts immediately return to normal levels. This is necessary to reduce artifacts
such as ``pumping.'' Instead, the gain is allowed to return to normal at the such as ``pumping.'' Instead, the gain is allowed to return to normal at the
chosen rate. Release Time is the time for the gain to recover by 10~dB. chosen rate. Release Time is the time for the gain to recover by 10~dB.
}

40
manual/configure_rockbox/system_options.tex
View file

@ -203,27 +203,25 @@ therefore result in better runtime.
} }
} }
\opt{swcodec}{ \subsection{Keyclick}
\subsection{Keyclick} This menu controls key clicks on button presses.
This menu controls key clicks on button presses. \begin{description}
\begin{description} \opt{hardware_click}{
\opt{hardware_click}{ \item [Headphone Keyclick. ]This setting controls how strong the keyclicks
\item [Headphone Keyclick. ]This setting controls how strong the keyclicks played through the headphones are. If set to \setting{Off}, the keyclicks
played through the headphones are. If set to \setting{Off}, the keyclicks will be disabled.
will be disabled. \item [Speaker Keyclick. ]This setting turns playing of keyclicks through
\item [Speaker Keyclick. ]This setting turns playing of keyclicks through the built in speaker \setting{On} or \setting{Off}.
the built in speaker \setting{On} or \setting{Off}. }
} \nopt{hardware_click}{
\nopt{hardware_click}{ \item [Keyclick. ]This setting controls how strong the keyclicks are.
\item [Keyclick. ]This setting controls how strong the keyclicks are. If set to \setting{Off}, the keyclicks will be disabled.
If set to \setting{Off}, the keyclicks will be disabled. }
} \item [Keyclick repeats.] This setting turns keyclick repeats \setting{On}
\item [Keyclick repeats.] This setting turns keyclick repeats \setting{On} and \setting{Off}. If set to \setting{On}, the keyclicks will be
and \setting{Off}. If set to \setting{On}, the keyclicks will be repeated when you hold down a button. If set to \setting{Off}, you will
repeated when you hold down a button. If set to \setting{Off}, you will hear only one click.
hear only one click. \end{description}
\end{description}
}
\opt{touchpad}{ \opt{touchpad}{
\subsection{Touchpad} \subsection{Touchpad}

52
manual/configure_rockbox/theme_settings.tex
View file

@ -47,11 +47,9 @@ customize the visual appearance of Rockbox.
headphones and when connected to an external amplifier. See headphones and when connected to an external amplifier. See
\reference{ref:CreateYourOwnWPS} for more details.} \reference{ref:CreateYourOwnWPS} for more details.}
\opt{lcd_bitmap}{
\item[Font.] \item[Font.]
Browse the installed fonts on your \dap{}. Selecting one will activate it. Browse the installed fonts on your \dap{}. Selecting one will activate it.
See \reference{ref:Loadingfonts} for further details about fonts. See \reference{ref:Loadingfonts} for further details about fonts.
}
\item[While Playing Screen.] \item[While Playing Screen.]
Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and
@ -75,10 +73,8 @@ customize the visual appearance of Rockbox.
Rockbox has the ability to display an icon to the left of the file Rockbox has the ability to display an icon to the left of the file
in the \setting{File Browser}. For details of these icons, see in the \setting{File Browser}. For details of these icons, see
\reference{ref:Supportedfileformats}. \reference{ref:Supportedfileformats}.
\opt{lcd_bitmap}{ These icons can also be customised. See the \wikilink{IconSets}
These icons can also be customised. See the \wikilink{IconSets} and \wikilink{CustomIcons} Wiki pages for details.
and \wikilink{CustomIcons} Wiki pages for details.
}
\opt{lcd_non-mono}{% \opt{lcd_non-mono}{%
\item[Clear Backdrop.] \item[Clear Backdrop.]
@ -87,30 +83,27 @@ customize the visual appearance of Rockbox.
This option allows you to clear the backdrops that you set. This option allows you to clear the backdrops that you set.
} }
% %
\opt{lcd_bitmap}{ \item[Status/Scrollbar.]
\item[Status/Scrollbar.] Settings related to on screen status display and the scrollbar.
Settings related to on screen status display and the scrollbar. \begin{description}
\begin{description} \item[Scroll Bar.] Allows you to choose where the vertical scroll bar
\item[Scroll Bar.] Allows you to choose where the vertical scroll bar should appear.
should appear. \item[Scroll Bar Width.] Allows you to choose the width of the
\item[Scroll Bar Width.] Allows you to choose the width of the scroll bar (in pixels). Default value is 6.
scroll bar (in pixels). Default value is 6. \item[Status Bar.] Allows you to choose where to display the
\item[Status Bar.] Allows you to choose where to display the statusbar\opt{remote}{ on the main display}.
statusbar\opt{remote}{ on the main display}. \opt{remote}{
\opt{remote}{ \item[Remote Status Bar.] Allows you to choose where to display the
\item[Remote Status Bar.] Allows you to choose where to display the statusbar on the remote display.
statusbar on the remote display. }
} \item[Volume Display.] Controls whether the volume is displayed as a
\item[Volume Display.] Controls whether the volume is displayed as a graphic or a numeric value on the Status Bar. If you select a numeric
graphic or a numeric value on the Status Bar. If you select a numeric display, volume is displayed in decibels. See \reference{ref:volume}
display, volume is displayed in decibels. See \reference{ref:volume} for more on the volume setting.
for more on the volume setting. \item[Battery Display.] Controls whether the battery charge status is
\item[Battery Display.] Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar.
displayed as a graphic or numerical percentage value on the Status Bar. \end{description}
\end{description}
}
% %
\opt{lcd_bitmap}{
\item[Line Selector Type.] \item[Line Selector Type.]
This option allows you to select which type of line selector to use. This option allows you to select which type of line selector to use.
\begin{description} \begin{description}
@ -127,7 +120,6 @@ customize the visual appearance of Rockbox.
submenu. submenu.
} }
\end{description} \end{description}
}
\opt{lcd_color}{ \opt{lcd_color}{
\item[Colours.] \item[Colours.]

2
manual/getting_started/installation.tex
View file

@ -243,7 +243,6 @@ still available to you.\\
various important aspects of Rockbox, such as the different versions various important aspects of Rockbox, such as the different versions
available.\\}} available.\\}}
\opt{swcodec} {
\opt{HAVE_RB_BL_ON_DISK}{There are three separate components, \opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
two of which need to be installed in order to run Rockbox:} two of which need to be installed in order to run Rockbox:}
\opt{HAVE_RB_BL_IN_FLASH}{There are two separate components \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components
@ -282,7 +281,6 @@ still available to you.\\
\fname{.rockbox} which contains all of the Rockbox files, and is \fname{.rockbox} which contains all of the Rockbox files, and is
located in the root of your \daps{} drive. located in the root of your \daps{} drive.
\end{description} \end{description}
}
Apart from the required parts there are some addons you might be interested Apart from the required parts there are some addons you might be interested
in installing. in installing.

14
manual/main_menu/fmradio.tex
View file

@ -20,14 +20,12 @@
files are available here: \wikilink{FmPresets}. files are available here: \wikilink{FmPresets}.
\opt{recording}{ \opt{recording}{
\opt{swcodec}{ It is also possible to record the FM radio while listening.
It is also possible to record the FM radio while listening. To start recording, enter the FM radio settings menu with
To start recording, enter the FM radio settings menu with \ActionFMMenu{} and then select \setting{Recording}.
\ActionFMMenu{} and then select \setting{Recording}. At this point, you will be switched to the \setting{Recording Screen}.
At this point, you will be switched to the \setting{Recording Screen}. Further information on \setting{Recording} can be found in
Further information on \setting{Recording} can be found in \reference{ref:Recording}.
\reference{ref:Recording}.
}
} }
\begin{btnmap} \begin{btnmap}

32
manual/plugins/lrcplayer.tex
View file

@ -37,8 +37,8 @@ Any other tags and lines without time tags are ignored.
\subsubsection{Location of lyrics files} \subsubsection{Location of lyrics files}
The plugin checks the following directories for lyrics files. The plugin checks the following directories for lyrics files.
\opt{swcodec}{If no lyrics file is found and the audio file is a \fname{.mp3}, If no lyrics file is found and the audio file is a \fname{.mp3},
it also checks for SYLT and USLT tags in the id3v2 tags.} it also checks for SYLT and USLT tags in the id3v2 tags.
\begin{enumerate} \begin{enumerate}
\item The directory containing the audio file and its parent directories. \item The directory containing the audio file and its parent directories.
@ -116,10 +116,8 @@ same order as in that list.
\begin{description} \begin{description}
\item[Theme settings.] Change theme related settings. \item[Theme settings.] Change theme related settings.
\begin{description} \begin{description}
\opt{lcd_bitmap}{% \item[Show Statusbar.] Show / hide the statusbar.
\item[Show Statusbar.] Show / hide the statusbar. \item[Display Title.] Show / hide the track title.
\item[Display Title.] Show / hide the track title.
}%
\item[Display Time.] Show / hide the current time. \item[Display Time.] Show / hide the current time.
\opt{lcd_color}{% \opt{lcd_color}{%
\item[Inactive Colour.] Set the colour of the inactive part of the lyrics. \item[Inactive Colour.] Set the colour of the inactive part of the lyrics.
@ -127,22 +125,18 @@ same order as in that list.
\item[Backlight Force On.] Do not turn off the backlight while displaying \item[Backlight Force On.] Do not turn off the backlight while displaying
the lyrics. the lyrics.
\end{description} \end{description}
\opt{lcd_bitmap}{% \item[Display Settings.] Change how the lyrics are displayed.
\item[Display Settings.] Change how the lyrics are displayed. \begin{description}
\begin{description} \item[Wrap.] Breaks lines at white space.
\item[Wrap.] Breaks lines at white space. \item[Wipe.] Wipes the text.
\item[Wipe.] Wipes the text. \item[Alignment.] Align text to the left, centre, or right.
\item[Alignment.] Align text to the left, centre, or right. \item[Activate Only Current Line.]
\item[Activate Only Current Line.] Activate only the current line, or the current and previous lines.
Activate only the current line, or the current and previous lines. \end{description}
\end{description}
}%
\item[Lyrics Settings.] Change how the lyrics files are loaded. \item[Lyrics Settings.] Change how the lyrics files are loaded.
\begin{description} \begin{description}
\item[Encoding.] Sets the codepage used in the plugin. \item[Encoding.] Sets the codepage used in the plugin.
\opt{swcodec}{% \item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files.
\item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files.
}%
\item[Lrc Directory.] Set the directory where lyrics files are stored, \item[Lrc Directory.] Set the directory where lyrics files are stored,
must be a maximum of 63 bytes. must be a maximum of 63 bytes.
\end{description} \end{description}

130
manual/plugins/main.tex
View file

@ -14,30 +14,28 @@ them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\
Viewer plugins get started automatically by opening an associated file (i.e. Viewer plugins get started automatically by opening an associated file (i.e.
text files% text files%
\opt{lcd_bitmap}{, chip8 games}% , chip8 games), or from the \setting{Open with} option on the \setting{Context Menu}.
), or from the \setting{Open with} option on the \setting{Context Menu}.
\section{Games} \section{Games}
\opt{lcd_bitmap} See also the Chip{}-8 emulator in \reference{ref:Chip8emulator},
{See also the Chip{}-8 emulator in \reference{ref:Chip8emulator}, Frotz in \reference{ref:Frotz},
Frotz in \reference{ref:Frotz}, \opt{iriverh100,iaudiom5,lcd_color}
\opt{iriverh100,iaudiom5,lcd_color} {Rockboy in \reference{ref:Rockboy}}
{Rockboy in \reference{ref:Rockboy}} and ZXBox in \reference{ref:ZXBox}.
and ZXBox in \reference{ref:ZXBox}.}
\opt{lcd_bitmap}{\input{plugins/2048.tex}} \input{plugins/2048.tex}
\opt{lcd_bitmap}{\input{plugins/blackjack.tex}} \input{plugins/blackjack.tex}
\opt{large_plugin_buffer}{\input{plugins/boomshine.tex}} \opt{large_plugin_buffer}{\input{plugins/boomshine.tex}}
\opt{lcd_bitmap}{\input{plugins/brickmania.tex}} \input{plugins/brickmania.tex}
\opt{lcd_bitmap}{\input{plugins/bubbles.tex}} \input{plugins/bubbles.tex}
\opt{lcd_bitmap}{\input{plugins/chessbox.tex}} \input{plugins/chessbox.tex}
\opt{lcd_bitmap}{\input{plugins/chopper.tex}} \input{plugins/chopper.tex}
\opt{lcd_color}{\input{plugins/clix.tex}} \opt{lcd_color}{\input{plugins/clix.tex}}
@ -51,103 +49,103 @@ text files%
{\input{plugins/flipit.tex}} {\input{plugins/flipit.tex}}
\opt{lcd_bitmap}{\input{plugins/goban.tex}} \input{plugins/goban.tex}
\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{ \opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
\input{plugins/invadrox.tex}}} \input{plugins/invadrox.tex}}}
{\input{plugins/jackpot.tex}} {\input{plugins/jackpot.tex}}
\opt{lcd_bitmap}{\input{plugins/jewels.tex}} \input{plugins/jewels.tex}
\opt{lcd_bitmap}{\input{plugins/maze.tex}} \input{plugins/maze.tex}
\opt{lcd_bitmap}{\input{plugins/mazezam.tex}} \input{plugins/mazezam.tex}
\opt{lcd_bitmap}{\input{plugins/minesweeper.tex}} \input{plugins/minesweeper.tex}
\opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2}{\input{plugins/pacbox.tex}}} \opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2}{\input{plugins/pacbox.tex}}}
\opt{lcd_bitmap}{\input{plugins/pegbox.tex}} \input{plugins/pegbox.tex}
\opt{lcd_color}{\opt{large_plugin_buffer}{\input{plugins/pixelpainter.tex}}} \opt{lcd_color}{\opt{large_plugin_buffer}{\input{plugins/pixelpainter.tex}}}
\opt{lcd_bitmap}{\input{plugins/pong.tex}} \input{plugins/pong.tex}
\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/quake.tex}}} \opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/quake.tex}}}
\opt{lcd_bitmap}{\input{plugins/reversi.tex}} \input{plugins/reversi.tex}
\opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}} \input{plugins/robotfindskitten.tex}
{\input{plugins/rockblox.tex}} {\input{plugins/rockblox.tex}}
\opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}} \input{plugins/rockblox1d.tex}
\opt{lcd_bitmap}{\input{plugins/sgt-puzzles.tex}} \input{plugins/sgt-puzzles.tex}
\opt{lcd_bitmap}{\input{plugins/sliding.tex}} \input{plugins/sliding.tex}
\opt{lcd_bitmap}{\input{plugins/snake.tex}} \input{plugins/snake.tex}
\opt{lcd_bitmap}{\input{plugins/snake2.tex}} \input{plugins/snake2.tex}
\opt{lcd_bitmap}{\input{plugins/sokoban.tex}} \input{plugins/sokoban.tex}
\opt{lcd_bitmap}{\input{plugins/solitaire.tex}} \input{plugins/solitaire.tex}
\opt{lcd_bitmap}{\input{plugins/spacerocks.tex}} \input{plugins/spacerocks.tex}
\opt{lcd_bitmap}{\input{plugins/star.tex}} \input{plugins/star.tex}
\opt{lcd_bitmap}{\input{plugins/sudoku.tex}} \input{plugins/sudoku.tex}
\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{ \opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
\input{plugins/superdom.tex}}} \input{plugins/superdom.tex}}}
\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/wolf3d.tex}}} \opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/wolf3d.tex}}}
\opt{lcd_bitmap}{\input{plugins/wormlet.tex}} \input{plugins/wormlet.tex}
\opt{lcd_bitmap}{\input{plugins/xobox.tex}} \input{plugins/xobox.tex}
\opt{lcd_color}{\input{plugins/xworld.tex}} \opt{lcd_color}{\input{plugins/xworld.tex}}
\section{Demos} \section{Demos}
\opt{lcd_bitmap}{\input{plugins/bounce.tex}} \input{plugins/bounce.tex}
{\input{plugins/credits.tex}} {\input{plugins/credits.tex}}
{\input{plugins/cube.tex}} {\input{plugins/cube.tex}}
\opt{lcd_bitmap}{\input{plugins/demystify.tex}} \input{plugins/demystify.tex}
\opt{swcodec}{\input{plugins/fft.tex}} \input{plugins/fft.tex}
\opt{lcd_bitmap}{\input{plugins/fire.tex}} \input{plugins/fire.tex}
\opt{lcd_bitmap}{\input{plugins/fractals.tex}} \input{plugins/fractals.tex}
{\input{plugins/logo.tex}} {\input{plugins/logo.tex}}
\opt{lcd_bitmap}{\nopt{xduoox3,clip,clipplus}{\input{plugins/matrix.tex}}} \nopt{xduoox3,clip,clipplus}{\input{plugins/matrix.tex}}
{\input{plugins/mosaic.tex}} {\input{plugins/mosaic.tex}}
\opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}} \input{plugins/oscilloscope.tex}
\opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}} \opt{tagcache}{\input{plugins/pictureflow.tex}}
\opt{lcd_bitmap}{\input{plugins/plasma.tex}} \input{plugins/plasma.tex}
\opt{lcd_bitmap}{\input{plugins/rocklife.tex}} \input{plugins/rocklife.tex}
{\input{plugins/snow.tex}} {\input{plugins/snow.tex}}
\opt{lcd_bitmap}{\input{plugins/starfield.tex}} \input{plugins/starfield.tex}
\opt{lcd_bitmap}{\input{plugins/vumeter.tex}} \input{plugins/vumeter.tex}
\section{\label{ref:Viewersplugins}Viewers} \section{\label{ref:Viewersplugins}Viewers}
@ -168,7 +166,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
Frotz & \fname{.z1} to \fname{.z8} & \\ Frotz & \fname{.z1} to \fname{.z8} & \\
Image Viewer & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}} & \\ Image Viewer & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}} & \\
Lua scripting language& \fname{.lua} & \\ Lua scripting language& \fname{.lua} & \\
\opt{swcodec}{\nopt{lowmem}{ \nopt{lowmem}{
Midiplay & \fname{.mid, .midi} & \\ Midiplay & \fname{.mid, .midi} & \\
Mikmod & \fname{.669, .amf, .asy, .dsm,} & \\ Mikmod & \fname{.669, .amf, .asy, .dsm,} & \\
& \fname{.far, .gdm, imf, .it,} & \\ & \fname{.far, .gdm, imf, .it,} & \\
@ -176,13 +174,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
& \fname{.s3m, .stm, .stx, .ult,} & \\ & \fname{.s3m, .stm, .stx, .ult,} & \\
& \fname{.uni, .umx, .xm} & \\ & \fname{.uni, .umx, .xm} & \\
MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\ MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\
}} }
\opt{swcodec}{
MP3 Encoder & \fname{.wav} & x \\ MP3 Encoder & \fname{.wav} & x \\
}
\opt{lcd_bitmap}{
Rockboy & \fname{.gb, .gbc} & \\ Rockboy & \fname{.gb, .gbc} & \\
}
Search & \fname{.m3u, .m3u8} & x \\ Search & \fname{.m3u, .m3u8} & x \\
Shopping list & \fname{.shopper} & \\ Shopping list & \fname{.shopper} & \\
Sort & \fname{.*} & x \\ Sort & \fname{.*} & x \\
@ -196,31 +190,31 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/winshortcuts.tex}} {\input{plugins/winshortcuts.tex}}
\opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}} \input{plugins/chip8emulator.tex}
\opt{lcd_bitmap}{\input{plugins/frotz.tex}} \input{plugins/frotz.tex}
\opt{lcd_bitmap}{\input{plugins/imageviewer.tex}} \input{plugins/imageviewer.tex}
\opt{large_plugin_buffer}{\input{plugins/lua.tex}} \opt{large_plugin_buffer}{\input{plugins/lua.tex}}
\opt{swcodec}{\nopt{lowmem}{\input{plugins/midiplay.tex}}} \nopt{lowmem}{\input{plugins/midiplay.tex}}
\opt{swcodec}{\nopt{lowmem}{\input{plugins/mikmod.tex}}} \nopt{lowmem}{\input{plugins/mikmod.tex}}
\opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}} \nopt{lowmem}{\input{plugins/mpegplayer.tex}}
\opt{swcodec}{\input{plugins/mp3_encoder.tex}} \input{plugins/mp3_encoder.tex}
\opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD% \opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{ ,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{
\input{plugins/pdbox.tex}} \input{plugins/pdbox.tex}}
\opt{lcd_bitmap}{\nopt{% \nopt{%
ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented
,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented ,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented
,mrobe100% lcd size/depth not implemented ,mrobe100% lcd size/depth not implemented
}{ }{
\input{plugins/rockboy.tex}}} \input{plugins/rockboy.tex}}
{\input{plugins/search.tex}} {\input{plugins/search.tex}}
@ -236,7 +230,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/vbrfix.tex}} {\input{plugins/vbrfix.tex}}
\opt{lcd_bitmap}{\input{plugins/zxbox.tex}} \input{plugins/zxbox.tex}
\section{Applications} \section{Applications}
@ -244,7 +238,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/batterybenchmark.tex}} {\input{plugins/batterybenchmark.tex}}
\opt{lcd_bitmap}{\input{plugins/calculator.tex}} \input{plugins/calculator.tex}
\opt{rtc}{\input{plugins/calendar.tex}} \opt{rtc}{\input{plugins/calendar.tex}}
@ -260,7 +254,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
\opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}} \opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
\opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}} \input{plugins/lrcplayer.tex}
{\input{plugins/main_menu_config.tex}} {\input{plugins/main_menu_config.tex}}
@ -270,9 +264,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/otp.tex}} {\input{plugins/otp.tex}}
\opt{lcd_bitmap}{\input{plugins/periodic_table.tex}} \input{plugins/periodic_table.tex}
\opt{swcodec}{\opt{recording_mic}{\input{plugins/pitch_detector.tex}}} \opt{recording_mic}{\input{plugins/pitch_detector.tex}}
{\input{plugins/random_folder_advance_config.tex}} {\input{plugins/random_folder_advance_config.tex}}
@ -284,4 +278,4 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\input{plugins/stopwatch.tex}} {\input{plugins/stopwatch.tex}}
\opt{lcd_bitmap}{\input{plugins/text_editor.tex}} \input{plugins/text_editor.tex}

6
manual/plugins/oscilloscope.tex
View file

@ -4,10 +4,8 @@
This demo shows the shape of the sound samples that make up the music This demo shows the shape of the sound samples that make up the music
being played. being played.
\opt{swcodec}{ At faster speed rates, the \dap\ is less responsive
At faster speed rates, the \dap\ is less responsive to user input and music may start to skip.
to user input and music may start to skip.
}
\subsubsection{Keys} \subsubsection{Keys}

8
manual/plugins/pictureflow.tex
View file

@ -1,9 +1,9 @@
\subsection{PictureFlow} \subsection{PictureFlow}
\screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow} \screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow}
PictureFlow provides a visualisation of your albums with their associated cover PictureFlow provides a visualisation of your albums with their associated cover
art. \opt{swcodec}{It is possible to start playback of the selected art. It is possible to start playback of the selected album from PictureFlow.
album from PictureFlow. Playback will start from the selected track. The Playback will start from the selected track. The PictureFlow plugin will
PictureFlow plugin will continue to run while your tracks are played.} continue to run while your tracks are played.
\subsubsection{Requirements} \subsubsection{Requirements}
PictureFlow uses both the album art (see \reference{ref:album_art}) and PictureFlow uses both the album art (see \reference{ref:album_art}) and
@ -139,7 +139,7 @@ aware:
\subsubsection{Main Menu} \subsubsection{Main Menu}
\begin{description} \begin{description}
\item[Go to WPS.] Leave PictureFlow and enter the while playing screen. \item[Go to WPS.] Leave PictureFlow and enter the while playing screen.
\opt{swcodec}{\item[Playback Control.] Control music playback from within the plugin.} \item[Playback Control.] Control music playback from within the plugin.
\item[Settings.] Enter the settings menu. \item[Settings.] Enter the settings menu.
\item[Return.] Exit menu. \item[Return.] Exit menu.
\item[Quit.] Exit PictureFlow plugin. \item[Quit.] Exit PictureFlow plugin.

28
manual/plugins/text_viewer.tex
View file

@ -197,25 +197,19 @@ by using \emph{Open with} from the \emph{Context Menu}
\begin{description} \begin{description}
\item[Encoding] Set the codepage in the text viewer. \item[Encoding] Set the codepage in the text viewer.
Available settings: Available settings:
\setting{ISO-8859-1} (Latin 1). \setting{ISO-8859-1} (Latin 1),
\setting{ISO-8859-7} (Greek), \setting{ISO-8859-7} (Greek),
\opt{lcd_bitmap}{ \setting{ISO-8859-8} (Hebrew),
\setting{ISO-8859-8} (Hebrew),
}
\setting{CP1251} (Cyrillic), \setting{CP1251} (Cyrillic),
\opt{lcd_bitmap}{ \setting{ISO-8859-11} (Thai),
\setting{ISO-8859-11} (Thai), \setting{CP1256} (Arabic),
\setting{CP1256} (Arabic),
}
\setting{ISO-8859-9} (Turkish), \setting{ISO-8859-9} (Turkish),
\setting{ISO-8859-2} (Latin Extended), \setting{ISO-8859-2} (Latin Extended),
\setting{CP1250} (Central European), \setting{CP1250} (Central European),
\opt{lcd_bitmap}{ \setting{SJIS} (Japanese),
\setting{SJIS} (Japanese), \setting{GB-2312} (Simple Chinese),
\setting{GB-2312} (Simple Chinese), \setting{KSX-1001} (Korean),
\setting{KSX-1001} (Korean), \setting{BIG5} (Traditional Chinese),
\setting{BIG5} (Traditional Chinese),
}
\setting{UTF-8} (Unicode), \setting{UTF-8} (Unicode),
This setting only applies to the plugin and is independent from the This setting only applies to the plugin and is independent from the
\setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}). \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}).
@ -230,9 +224,7 @@ by using \emph{Open with} from the \emph{Context Menu}
\item[Join] Join lines together. \item[Join] Join lines together.
\item[Expand] Add a blank line at newlines. Useful for making paragraphs \item[Expand] Add a blank line at newlines. Useful for making paragraphs
clearer in some book style text files. clearer in some book style text files.
\opt{lcd_bitmap}{
\item[Reflow Lines] Justify the text. \item[Reflow Lines] Justify the text.
}
\end{description} \end{description}
\item[Screens Per Page] Set the number of screens per page. Available \item[Screens Per Page] Set the number of screens per page. Available
options are \setting{1} to \setting{5} screens per page. options are \setting{1} to \setting{5} screens per page.
@ -242,7 +234,6 @@ by using \emph{Open with} from the \emph{Context Menu}
(Useful for displaying right-to-left languages, such as Arabic or Hebrew) (Useful for displaying right-to-left languages, such as Arabic or Hebrew)
\item[Left] Set the text alignment to the left. \item[Left] Set the text alignment to the left.
\end{description} \end{description}
\opt{lcd_bitmap}{
\item[Show Header] Select whether to show the header. The header displays the file path. \item[Show Header] Select whether to show the header. The header displays the file path.
\begin{description} \begin{description}
\item[No] Do not display the header. \item[No] Do not display the header.
@ -263,7 +254,6 @@ by using \emph{Open with} from the \emph{Context Menu}
\item[No] Do not display the status bar. \item[No] Do not display the status bar.
\item[Yes] Display the status bar. \item[Yes] Display the status bar.
\end{description} \end{description}
}
\item[Scroll Settings] The scrolling settings submenu. \item[Scroll Settings] The scrolling settings submenu.
\begin{description} \begin{description}
\item[Horizontal] Submenu for horizontal scrolling settings. \item[Horizontal] Submenu for horizontal scrolling settings.
@ -299,14 +289,12 @@ by using \emph{Open with} from the \emph{Context Menu}
\item[Scroll by Page] Scroll up or down one full screen. \item[Scroll by Page] Scroll up or down one full screen.
\item[Scroll by Line] Scroll up or down one line. \item[Scroll by Line] Scroll up or down one line.
\end{description} \end{description}
\opt{lcd_bitmap}{
\item[Overlap Pages] Set whether the last line from the \item[Overlap Pages] Set whether the last line from the
previous screen is retained when scrolling pages. previous screen is retained when scrolling pages.
\begin{description} \begin{description}
\item[No] Do not retain previous line. \item[No] Do not retain previous line.
\item[Yes] Retain previous line. \item[Yes] Retain previous line.
\end{description} \end{description}
}
\item[Auto-scroll Speed] Control the speed of auto-scrolling \item[Auto-scroll Speed] Control the speed of auto-scrolling
in number of lines per second. Available options are in number of lines per second. Available options are
\setting{1} to \setting{10} lines per second. As an example, \setting{1} to \setting{10} lines per second. As an example,

8
manual/plugins/theme_remove.tex
View file

@ -3,7 +3,7 @@
This plugin offers a way to remove a theme. Open the \setting{Context Menu} (see \reference{ref:Contextmenu}) This plugin offers a way to remove a theme. Open the \setting{Context Menu} (see \reference{ref:Contextmenu})
upon a theme\fname{.cfg} file and select \setting{Open With... $\rightarrow$ theme\_remove}. upon a theme\fname{.cfg} file and select \setting{Open With... $\rightarrow$ theme\_remove}.
Some files are not removed regardless of the \setting{Remove Options} such as Some files are not removed regardless of the \setting{Remove Options} such as
\fname{rockbox\_default.wps}\opt{lcd_bitmap}{ and the font file currently in use}. \fname{rockbox\_default.wps} and the font file currently in use.
\subsubsection{Theme Remove menu} \subsubsection{Theme Remove menu}
\begin{description} \begin{description}
@ -34,18 +34,14 @@ Some files are not removed regardless of the \setting{Remove Options} such as
\end{description} \end{description}
\begin{description} \begin{description}
\opt{lcd_bitmap}{
\item[Font.] \item[Font.]
Specifies how the \fname{.fnt} file belonging to a theme \fname{.cfg} file is handled. Specifies how the \fname{.fnt} file belonging to a theme \fname{.cfg} file is handled.
If this option is set to \setting{Remove if not Used}, the fonts came from rockbox-fonts.zip If this option is set to \setting{Remove if not Used}, the fonts came from rockbox-fonts.zip
will not be removed as themes may depend on those fonts. will not be removed as themes may depend on those fonts.
}%
\item[WPS.] \item[WPS.]
Specifies how the \fname{.wps} file belonging to a theme \fname{.cfg} file is handled. Specifies how the \fname{.wps} file belonging to a theme \fname{.cfg} file is handled.
\opt{lcd_bitmap}{
\item[Statusbar Skin.] \item[Statusbar Skin.]
Specifies how the \fname{.sbs} file belonging to a theme \fname{.cfg} file is handled. Specifies how the \fname{.sbs} file belonging to a theme \fname{.cfg} file is handled.
}%
\opt{HAVE_REMOTE_LCD}{ \opt{HAVE_REMOTE_LCD}{
\item[Remote WPS.] \item[Remote WPS.]
Specifies how the \fname{.rwps} file belonging to a theme \fname{.cfg} file is handled. Specifies how the \fname{.rwps} file belonging to a theme \fname{.cfg} file is handled.
@ -56,12 +52,10 @@ Some files are not removed regardless of the \setting{Remove Options} such as
\item[Backdrop.] \item[Backdrop.]
Specifies how the backdrop \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled. Specifies how the backdrop \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
}% }%
\opt{lcd_bitmap}{
\item[Iconset.] \item[Iconset.]
Specifies how the iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled. Specifies how the iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
\item[Viewers Iconset.] \item[Viewers Iconset.]
Specifies how the viewers iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled. Specifies how the viewers iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
}%
\opt{HAVE_REMOTE_LCD}{ \opt{HAVE_REMOTE_LCD}{
\item[Remote Iconset.] \item[Remote Iconset.]
Specifies how the remote iconset \fname{.bmp} file belonging to Specifies how the remote iconset \fname{.bmp} file belonging to

4
manual/rockbox_interface/main.tex
View file

@ -749,10 +749,8 @@ The default directory structure that is assumed by some parts of Rockbox
your music organized in a way different than they assume when attempting to your music organized in a way different than they assume when attempting to
guess the Artist and Album names from your filetree. guess the Artist and Album names from your filetree.
}% }%
\opt{swcodec}{
See \reference{ref:Supportedaudioformats} for a list of supported audio See \reference{ref:Supportedaudioformats} for a list of supported audio
formats. formats.
}
\subsection{The first contact} \subsection{The first contact}
@ -817,13 +815,11 @@ is discussed in more detail in \reference{ref:manage_settings}.
The Rockbox distribution comes with some themes that should look nice on The Rockbox distribution comes with some themes that should look nice on
your \dap{}. your \dap{}.
\opt{lcd_bitmap}{
\note{Some of the themes shipped with Rockbox need additional \note{Some of the themes shipped with Rockbox need additional
fonts from the fonts package, so make sure you installed them. fonts from the fonts package, so make sure you installed them.
Also, if you downloaded additional themes from the Internet make sure you Also, if you downloaded additional themes from the Internet make sure you
have the needed fonts installed as otherwise the theme may not display have the needed fonts installed as otherwise the theme may not display
properly.} properly.}
}
\opt{usb_power}{ \opt{usb_power}{
\section{USB Charging} \section{USB Charging}

7
manual/rockbox_interface/tagcache.tex
View file

@ -3,9 +3,8 @@
\subsection{Introduction} \subsection{Introduction}
This chapter describes the Rockbox music database system. Using the information This chapter describes the Rockbox music database system. Using the information
contained in the tags (ID3v1, ID3v2% contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your
\opt{swcodec}{, Vorbis Comments, Apev2, etc.}% audio files, Rockbox builds and maintains a database of the music
) in your audio files, Rockbox builds and maintains a database of the music
files on your player and allows you to browse them by Artist, Album, Genre, files on your player and allows you to browse them by Artist, Album, Genre,
Song Name, etc. The criteria the database uses to sort the songs can be completely Song Name, etc. The criteria the database uses to sort the songs can be completely
customised. More information on how to achieve this can be found on the Rockbox customised. More information on how to achieve this can be found on the Rockbox
@ -63,12 +62,10 @@ its subdirectories will be scanned and added to the database.
\item[Update Now] \item[Update Now]
\setting{Update now} causes the database to detect new and deleted files \setting{Update now} causes the database to detect new and deleted files
\opt{swcodec}{
\note{Unlike the \setting{Auto Update} function, \setting{Update Now} \note{Unlike the \setting{Auto Update} function, \setting{Update Now}
will update the database regardless of whether the \setting{Directory Cache} will update the database regardless of whether the \setting{Directory Cache}
is enabled. Thus, an update using \setting{Update now} may take a long is enabled. Thus, an update using \setting{Update now} may take a long
time. time.
}
} }
Unlike \setting{Initialize Now}, the \setting{Update Now} function Unlike \setting{Initialize Now}, the \setting{Update Now} function
does not remove runtime database information. does not remove runtime database information.

208
manual/rockbox_interface/wps.tex
View file

@ -3,26 +3,24 @@
The While Playing Screen (WPS) displays various pieces of information about the The While Playing Screen (WPS) displays various pieces of information about the
currently playing audio file. currently playing audio file.
% %
\opt{lcd_bitmap}{% The appearance of the WPS can be configured using WPS configuration files.
The appearance of the WPS can be configured using WPS configuration files. The items shown depend on your configuration -- all items can be turned on
The items shown depend on your configuration -- all items can be turned on or off independently. Refer to \reference{ref:wps_tags} for details on how
or off independently. Refer to \reference{ref:wps_tags} for details on how to change the display of the WPS.
to change the display of the WPS. \begin{itemize}
\begin{itemize} \item Status bar: The Status bar shows Battery level, charger status,
\item Status bar: The Status bar shows Battery level, charger status, volume, play mode, repeat mode, shuffle mode\opt{rtc}{ and clock}.
volume, play mode, repeat mode, shuffle mode\opt{rtc}{ and clock}. In contrast to all other items, the status bar is always at the top of
In contrast to all other items, the status bar is always at the top of the screen.
the screen. \item (Scrolling) path and filename of the current song.
\item (Scrolling) path and filename of the current song. \item The ID3 track name.
\item The ID3 track name. \item The ID3 album name.
\item The ID3 album name. \item The ID3 artist name.
\item The ID3 artist name. \item Bit rate. VBR files display average bitrate and ``(avg)''
\item Bit rate. VBR files display average bitrate and ``(avg)'' \item Elapsed and total time.
\item Elapsed and total time. \item A slidebar progress meter representing where in the song you are.
\item A slidebar progress meter representing where in the song you are. \item Peak meter.
\item Peak meter. \end{itemize}
\end{itemize}
}
% %
See \reference{ref:ConfiguringtheWPS} for details of customising See \reference{ref:ConfiguringtheWPS} for details of customising
@ -138,44 +136,43 @@ your WPS (While Playing Screen).
\end{btnmap} \end{btnmap}
\opt{lcd_bitmap}{ \subsection{\label{ref:peak_meter}Peak Meter}
\subsection{\label{ref:peak_meter}Peak Meter} The peak meter can be displayed on the While Playing Screen and consists of
The peak meter can be displayed on the While Playing Screen and consists of several indicators.
several indicators. \opt{recording}{
\opt{recording}{ For a picture of the peak meter, please see the While
For a picture of the peak meter, please see the While Recording Screen in \reference{ref:while_recording_screen}.
Recording Screen in \reference{ref:while_recording_screen}.
}
\opt{ipodvideo}{
\note{Especially the \playerman{} \playertype{}'s performance and battery runtime
suffers when this feature is enabled. For this \dap{} it is highly recommended
to not use peak meter.}
}
\begin{description}
\item [The bar:]
This is the wide horizontal bar. It represents the current volume value.
\item [The peak indicator:]
This is a little vertical line at the right end of the bar. It indicates
the peak volume value that occurred recently.
\item [The clip indicator:]
This is a little black block that is displayed at the very right of the
scale when an overflow occurs. It usually does not show up during normal
playback unless you play an audio file that is distorted heavily.
\opt{recording}{
If you encounter clipping while recording, your recording will sound distorted.
You should lower the gain.
}
\note{Note that the clip detection is not very precise.
Clipping might occur without being indicated.}
\item [The scale:]
Between the indicators of the right and left channel there are little dots.
These dots represent important volume values. In linear mode each dot is a
10\% mark. In dBFS mode the dots represent the following values (from right
to left): 0~dB, {}-3~dB, {}-6~dB, {}-9~dB, {}-12~dB, {}-18~dB, {}-24~dB, {}-30~dB,
{}-40~dB, {}-50~dB, {}-60~dB.
\end{description}
} }
\opt{ipodvideo}{
\note{Especially the \playerman{} \playertype{}'s performance and battery runtime
suffers when this feature is enabled. For this \dap{} it is highly recommended
to not use peak meter.}
}
\begin{description}
\item [The bar:]
This is the wide horizontal bar. It represents the current volume value.
\item [The peak indicator:]
This is a little vertical line at the right end of the bar. It indicates
the peak volume value that occurred recently.
\item [The clip indicator:]
This is a little black block that is displayed at the very right of the
scale when an overflow occurs. It usually does not show up during normal
playback unless you play an audio file that is distorted heavily.
\opt{recording}{
If you encounter clipping while recording, your recording will sound distorted.
You should lower the gain.
}
\note{Note that the clip detection is not very precise.
Clipping might occur without being indicated.}
\item [The scale:]
Between the indicators of the right and left channel there are little dots.
These dots represent important volume values. In linear mode each dot is a
10\% mark. In dBFS mode the dots represent the following values (from right
to left): 0~dB, {}-3~dB, {}-6~dB, {}-9~dB, {}-12~dB, {}-18~dB, {}-24~dB, {}-30~dB,
{}-40~dB, {}-50~dB, {}-60~dB.
\end{description}
\subsection{\label{sec:contextmenu}The WPS Context Menu} \subsection{\label{sec:contextmenu}The WPS Context Menu}
Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu} Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu}
allows you quick access to some often used functions. allows you quick access to some often used functions.
@ -267,7 +264,6 @@ This may even be the whole track.
The rate can be changed in two modes: procentual and semitone. The rate can be changed in two modes: procentual and semitone.
Initially, procentual mode is active. Initially, procentual mode is active.
\opt{swcodec}{
If you've enabled the \setting{Timestretch} option in If you've enabled the \setting{Timestretch} option in
\setting{Sound Settings} and have since rebooted, you can also use \setting{Sound Settings} and have since rebooted, you can also use
timestretch mode. This allows you to change the playback speed timestretch mode. This allows you to change the playback speed
@ -278,73 +274,43 @@ This may even be the whole track.
limitations of the algorithm, speed is limited to be between 35\% limitations of the algorithm, speed is limited to be between 35\%
and 250\% of the current pitch value. Pitch must maintain the and 250\% of the current pitch value. Pitch must maintain the
same ratio as well as remain between 50\% and 200\%. same ratio as well as remain between 50\% and 200\%.
}
The value of the \opt{swcodec}{rate, pitch and speed}\nopt{swcodec}{rate} The value of the rate, pitch and speed
is not persistent, i.e. after the \dap\ is turned on it will is not persistent, i.e. after the \dap\ is turned on it will
always be set to 100\%. \opt{swcodec}{ However, the rate, pitch and speed always be set to 100\%. However, the rate, pitch and speed
information will be stored in any bookmarks you may create information will be stored in any bookmarks you may create
(see \reference{ref:Bookmarkconfigactual}) and will be restored upon (see \reference{ref:Bookmarkconfigactual}) and will be restored upon
playing back those bookmarks.} playing back those bookmarks.
\nopt{swcodec}{ \begin{btnmap}
\begin{btnmap} \ActionPsToggleMode
\ActionPsToggleMode \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsToggleMode}
& Toggle pitch changing mode. \\ & Toggle pitch changing mode (cycle through all available modes).\\
% %
\ActionPsIncSmall{} / \ActionPsDecSmall \ActionPsIncSmall{} / \ActionPsDecSmall
& Increase~/ Decrease pitch by 0.1\% (in procentual mode) or by 0.1 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncSmall{} / \ActionRCPsDecSmall}
semitone (in semitone mode).\\ & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or 0.1
% semitone (in semitone mode).\\
\ActionPsIncBig{} / \ActionPsDecBig %
& Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone \nopt{PBELL_VIBE500_PAD}{ % there is no long scroll up or down because of slide
(in semitone mode).\\ \ActionPsIncBig{} / \ActionPsDecBig
% \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncBig{} / \ActionRCPsDecBig}
\ActionPsNudgeLeft{} / \ActionPsNudgeRight & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
& Temporarily change pitch by 2\% (beatmatch). \\ (in semitone mode).\\
% }
\ActionPsReset %
& Reset rate to 100\%. \\ \ActionPsNudgeLeft{} / \ActionPsNudgeRight
% \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsNudgeLeft{} / \ActionRCPsNudgeRight}
\ActionPsExit & Temporarily change pitch by 2\% (beatmatch), or modify speed (in timestretch mode).\\
& Leave the \setting{Pitch Screen}. \\ %
% \ActionPsReset
\end{btnmap} \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsReset}
& Reset pitch and speed to 100\%. \\
\warn{Changing the pitch can cause audible `Artifacts' or `Dropouts'.} %
} \ActionPsExit
\opt{HAVEREMOTEKEYMAP}{& \ActionRCPsExit}
\opt{swcodec}{ & Leave the \setting{Pitch Screen}. \\
\begin{btnmap} %
\ActionPsToggleMode \end{btnmap}
\opt{HAVEREMOTEKEYMAP}{& \ActionRCPsToggleMode}
& Toggle pitch changing mode (cycle through all available modes).\\
%
\ActionPsIncSmall{} / \ActionPsDecSmall
\opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncSmall{} / \ActionRCPsDecSmall}
& Increase~/ Decrease pitch by 0.1\% (in procentual mode) or 0.1
semitone (in semitone mode).\\
%
\nopt{PBELL_VIBE500_PAD}{ % there is no long scroll up or down because of slide
\ActionPsIncBig{} / \ActionPsDecBig
\opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncBig{} / \ActionRCPsDecBig}
& Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
(in semitone mode).\\
}
%
\ActionPsNudgeLeft{} / \ActionPsNudgeRight
\opt{HAVEREMOTEKEYMAP}{& \ActionRCPsNudgeLeft{} / \ActionRCPsNudgeRight}
& Temporarily change pitch by 2\% (beatmatch), or modify speed (in timestretch mode).\\
%
\ActionPsReset
\opt{HAVEREMOTEKEYMAP}{& \ActionRCPsReset}
& Reset pitch and speed to 100\%. \\
%
\ActionPsExit
\opt{HAVEREMOTEKEYMAP}{& \ActionRCPsExit}
& Leave the \setting{Pitch Screen}. \\
%
\end{btnmap}
}
} }