summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMoshe Piekarski <dev.rockbox@melachim.net>2020-11-16 18:14:31 -0500
committerMoshe Piekarski <dev.rockbox@melachim.net>2020-11-18 14:35:09 +0000
commit0aa702836bd0be397c010ebd677bd673b7f900af (patch)
treec171f8f2bf9781cfe2a34a584faa69349853983e
parent7c87467ba4d6f6fabca5b167e1233d4cca1671ca (diff)
downloadrockbox-0aa702836bd0be397c010ebd677bd673b7f900af.tar.gz
rockbox-0aa702836bd0be397c010ebd677bd673b7f900af.zip
Manual: remove most HWCODEC artifacts
This causes 3 changes in layout. 2 I can't track down and 1 is better this way. Change-Id: If4ad5e1d7431b4c2cbaaf9767d78139ef4e2dc44
-rwxr-xr-xmanual/advanced_topics/main.tex85
-rw-r--r--manual/appendix/appendix.tex2
-rw-r--r--manual/appendix/config_file_options.tex11
-rw-r--r--manual/appendix/file_formats.tex8
-rw-r--r--manual/appendix/wps_tags.tex19
-rw-r--r--manual/configure_rockbox/bookmarking.tex6
-rwxr-xr-xmanual/configure_rockbox/display_options.tex117
-rw-r--r--manual/configure_rockbox/main.tex4
-rw-r--r--manual/configure_rockbox/playback_options.tex234
-rw-r--r--manual/configure_rockbox/recording_settings.tex27
-rw-r--r--manual/configure_rockbox/sound_settings.tex16
-rwxr-xr-xmanual/configure_rockbox/system_options.tex40
-rw-r--r--manual/configure_rockbox/theme_settings.tex52
-rw-r--r--manual/getting_started/installation.tex2
-rw-r--r--manual/main_menu/fmradio.tex14
-rw-r--r--manual/plugins/lrcplayer.tex32
-rw-r--r--manual/plugins/main.tex130
-rw-r--r--manual/plugins/oscilloscope.tex6
-rw-r--r--manual/plugins/pictureflow.tex8
-rw-r--r--manual/plugins/text_viewer.tex28
-rw-r--r--manual/plugins/theme_remove.tex8
-rw-r--r--manual/rockbox_interface/main.tex4
-rw-r--r--manual/rockbox_interface/tagcache.tex7
-rw-r--r--manual/rockbox_interface/wps.tex204
24 files changed, 451 insertions, 613 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 66793a8d24..f669dd5211 100755
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -42,29 +42,26 @@ Rockbox allows you to choose a plugin to run for select menu options.
42Simply choose the option in the setting menu and choose the plugin 42Simply choose the option in the setting menu and choose the plugin
43you would like to run. 43you would like to run.
44 44
45\opt{lcd_bitmap}{
46\subsection{\label{ref:GettingExtras}Getting Extras} 45\subsection{\label{ref:GettingExtras}Getting Extras}
47 46
48Rockbox supports custom fonts. A collection of fonts is available for download 47Rockbox supports custom fonts. A collection of fonts is available for download
49in the font package at \url{http://www.rockbox.org/daily.shtml}.} 48in the font package at \url{http://www.rockbox.org/daily.shtml}.
50 49
51\opt{lcd_bitmap}{ 50\subsection{\label{ref:Loadingfonts}Loading Fonts}\index{Fonts}
52 \subsection{\label{ref:Loadingfonts}Loading Fonts}\index{Fonts} 51Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the
53 Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the 52\dap{} and ``play'' it in the \setting{File Browser}. If you want a font to
54 \dap{} and ``play'' it in the \setting{File Browser}. If you want a font to 53be loaded automatically every time you start up, it must be located in the
55 be loaded automatically every time you start up, it must be located in the 54\fname{/.rockbox/fonts} directory and the filename must be at most 24 characters
56 \fname{/.rockbox/fonts} directory and the filename must be at most 24 characters 55long. You can browse the fonts in \fname{/.rockbox/fonts} under
57 long. You can browse the fonts in \fname{/.rockbox/fonts} under 56\setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font}
58 \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font} 57in the \setting{Main Menu}.\\
59 in the \setting{Main Menu}.\\ 58
60 59\note{Advanced Users Only: Any BDF font should
61 \note{Advanced Users Only: Any BDF font should 60 be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use
62 be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use 61 the \fname{convbdf} tool. This tool can be found in the \fname{tools}
63 the \fname{convbdf} tool. This tool can be found in the \fname{tools} 62 directory of the Rockbox source code. See \wikilink{CreateFonts\#ConvBdf}
64 directory of the Rockbox source code. See \wikilink{CreateFonts\#ConvBdf} 63 for more details. Or just run \fname{convbdf} without any parameters to
65 for more details. Or just run \fname{convbdf} without any parameters to 64 see the possible options.}
66 see the possible options.}
67}
68 65
69\subsection{\label{ref:Loadinglanguages}Loading Languages} 66\subsection{\label{ref:Loadinglanguages}Loading Languages}
70\index{Language files}% 67\index{Language files}%
@@ -109,15 +106,13 @@ file find the instructions on the Rockbox website:
109 \\ 106 \\
110 \config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa, 107 \config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa,
111 \firmwareextension{}, % 108 \firmwareextension{}, %
112 \opt{swcodec}{mp1, }mp2, mp3% 109 mp1, mp2, mp3, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, wv,
113 \opt{swcodec}{, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, 110 m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, spc, ape,
114 wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, 111 mac, sap, mpg, mpeg%
115 spc, ape, mac, sap}%
116 \opt{lcd_bitmap}{\opt{swcodec}{, mpg, mpeg}}%
117 \opt{HAVE_REMOTE_LCD}{, rwps}% 112 \opt{HAVE_REMOTE_LCD}{, rwps}%
118 \opt{lcd_non-mono}{, bmp}% 113 \opt{lcd_non-mono}{, bmp}%
119 \opt{radio}{, fmr}% 114 \opt{radio}{, fmr}%
120 \opt{lcd_bitmap}{, fnt, kbd}}\\* 115 , fnt, kbd}\\*
121 %It'd be ideal to get these from filetypes.c 116 %It'd be ideal to get these from filetypes.c
122 117
123 All file extensions that are not either specifically listed in the 118 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
286this section. All elements placed before the 281this section. All elements placed before the
287line defining a viewport are displayed in the default viewport. Elements 282line defining a viewport are displayed in the default viewport. Elements
288defined after a viewport declaration are drawn within that viewport. 283defined after a viewport declaration are drawn within that viewport.
289\opt{lcd_bitmap}{Loading images (see Appendix \reference{ref:wps_images}) 284Loading images (see Appendix \reference{ref:wps_images})
290 should be done within the default viewport.} 285should be done within the default viewport.
291A viewport ends either with the end of the file, or with the next viewport 286A viewport ends either with the end of the file, or with the next viewport
292declaration line. Viewports sharing the same 287declaration line. Viewports sharing the same
293coordinates and dimensions cannot be displayed at the same time. Viewports 288coordinates 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
526displayed if available. Could also be rendered as ``filename'' or ``tracknum -- 521displayed if available. Could also be rendered as ``filename'' or ``tracknum --
527title [artist]''. 522title [artist]''.
528 523
529%\opt{lcd_bitmap}{ 524%\begin{verbatim}
530% \begin{verbatim} 525% %s%?it<%?in<%in. |>%it|%fn>
531% %s%?it<%?in<%in. |>%it|%fn> 526% %s%?ia<%ia|%?d2<%d(2)|(root)>>
532% %s%?ia<%ia|%?d2<%d(2)|(root)>> 527% %s%?id<%id|%?d1<%d(1)|(root)>> %?iy<(%iy)|>
533% %s%?id<%id|%?d1<%d(1)|(root)>> %?iy<(%iy)|>
534% 528%
535% %al%pc/%pt%ar[%pp:%pe] 529% %al%pc/%pt%ar[%pp:%pe]
536% %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)> 530% %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>
537% %pb 531% %pb
538% %pm 532% %pm
539% % \end{verbatim} 533%
540%} 534%\end{verbatim}
541 535
542\section{\label{ref:manage_settings}Managing Rockbox Settings} 536\section{\label{ref:manage_settings}Managing Rockbox Settings}
543 537
@@ -713,11 +707,10 @@ current version.
713 available. 707 available.
714 708
715 709
716\opt{swcodec}{
717 Another area of savings is avoiding or reducing CPU boosting 710 Another area of savings is avoiding or reducing CPU boosting
718 through disabling computing intense features (e.g. sound processing) or 711 through disabling computing intense features (e.g. sound processing) or
719 using effective audio codecs. 712 using effective audio codecs.
720} The following provides a short overview of the most relevant settings and 713 The following provides a short overview of the most relevant settings and
721 rules of thumb. 714 rules of thumb.
722 715
723\subsection{Display backlight} 716\subsection{Display backlight}
@@ -765,16 +758,13 @@ current version.
765 that allows correct and continuous playback (see \reference{ref:AntiSkipBuf}). 758 that allows correct and continuous playback (see \reference{ref:AntiSkipBuf}).
766} 759}
767 760
768\opt{swcodec}{
769\subsection{Replaygain} 761\subsection{Replaygain}
770 Replaygain is a post processing that equalises the playback volume of audio 762 Replaygain is a post processing that equalises the playback volume of audio
771 files to the same perceived loudness. This post processing applies a factor 763 files to the same perceived loudness. This post processing applies a factor
772 to each single PCM sample and is therefore consuming additional CPU time. If 764 to each single PCM sample and is therefore consuming additional CPU time. If
773 you want to achieve some (minor) savings in runtime, switch this feature off 765 you want to achieve some (minor) savings in runtime, switch this feature off
774 (see \reference{ref:ReplayGain}). 766 (see \reference{ref:ReplayGain}).
775}
776 767
777\opt{lcd_bitmap}{
778\subsection{Peak Meter} 768\subsection{Peak Meter}
779 The peak meter is a feature of the While Playing Screen and will be updated with a 769 The peak meter is a feature of the While Playing Screen and will be updated with a
780 high framerate. Depending on your \dap{} this might result in a high CPU load. To 770 high framerate. Depending on your \dap{} this might result in a high CPU load. To
@@ -782,15 +772,11 @@ current version.
782 \opt{ipodvideo}{ 772 \opt{ipodvideo}{
783 \note{Especially the \playerman{} \playertype{} suffers from an enabled peak meter.} 773 \note{Especially the \playerman{} \playertype{} suffers from an enabled peak meter.}
784 } 774 }
785}
786 775
787\opt{swcodec,disk_storage,flash_storage}{
788\subsection{Audio format and bitrate} 776\subsection{Audio format and bitrate}
789\opt{swcodec}{
790 In general the fastest decoding audio format will be the best in terms of 777 In general the fastest decoding audio format will be the best in terms of
791 battery runtime on your \dap{}. An overview of different codec's performance 778 battery runtime on your \dap{}. An overview of different codec's performance
792 on different \dap{}s can be found at \wikilink{CodecPerformanceComparison}. 779 on different \dap{}s can be found at \wikilink{CodecPerformanceComparison}.
793}
794 780
795\opt{flash_storage}{ 781\opt{flash_storage}{
796 Your target uses flash that consumes a certain amount of power during access. 782 Your target uses flash that consumes a certain amount of power during access.
@@ -813,11 +799,8 @@ current version.
813 another based upon the above mentioned. This will reduce the audio quality. 799 another based upon the above mentioned. This will reduce the audio quality.
814 If you have the choice, select the best suiting codec when encoding the 800 If you have the choice, select the best suiting codec when encoding the
815 original source material. 801 original source material.
816}
817 802
818\opt{swcodec}{
819\subsection{Sound settings} 803\subsection{Sound settings}
820 In general all kinds of sound processing will need more CPU time and therefore 804 In general all kinds of sound processing will need more CPU time and therefore
821 consume more power. The less sound processing you use, the better it is for 805 consume more power. The less sound processing you use, the better it is for
822 the battery runtime (for options see \reference{ref:configure_rockbox_sound}). 806 the battery runtime (for options see \reference{ref:configure_rockbox_sound}).
823}
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex
index f1d6ccca16..1ce4eef7c9 100644
--- a/manual/appendix/appendix.tex
+++ b/manual/appendix/appendix.tex
@@ -3,7 +3,7 @@
3 3
4\input{appendix/file_formats.tex} 4\input{appendix/file_formats.tex}
5 5
6\opt{lcd_bitmap}{\input{appendix/album_art_info.tex}} 6\input{appendix/album_art_info.tex}
7 7
8\input{appendix/wps_tags.tex} 8\input{appendix/wps_tags.tex}
9 9
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
index 74607b4507..117d6f90fe 100644
--- a/manual/appendix/config_file_options.tex
+++ b/manual/appendix/config_file_options.tex
@@ -64,9 +64,7 @@
64 bidir limit & 0 to 200 & \% screen\\ 64 bidir limit & 0 to 200 & \% screen\\
65 scroll paginated & on, off & N/A\\ 65 scroll paginated & on, off & N/A\\
66 hold\_lr\_for\_scroll\_in\_list & on, off & N/A\\ 66 hold\_lr\_for\_scroll\_in\_list & on, off & N/A\\
67 \opt{lcd_bitmap}{ 67 show path in browser & off, current directory, full path & N/A\\
68 show path in browser & off, current directory, full path & N/A\\
69 }
70 contrast & 0 to 63 & N/A\\ 68 contrast & 0 to 63 & N/A\\
71 backlight timeout 69 backlight timeout
72 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 70 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
@@ -167,7 +165,6 @@
167 list\_accel\_wait & 1 to 10 & s\\ 165 list\_accel\_wait & 1 to 10 & s\\
168 } 166 }
169% 167%
170 \opt{swcodec}{
171 replaygain type 168 replaygain type
172 & track, album, track shuffle, off 169 & track, album, track shuffle, off
173 & N/A\\ 170 & N/A\\
@@ -232,7 +229,6 @@
232 keyclick repeats & on, off & N/A\\ 229 keyclick repeats & on, off & N/A\\
233 dircache & on, off & N/A\\ 230 dircache & on, off & N/A\\
234 tagcache\_ram & on, off & N/A\\ 231 tagcache\_ram & on, off & N/A\\
235 }%
236 232
237 \opt{touchpad}{ 233 \opt{touchpad}{
238 \opt{GIGABEAT_PAD}{ 234 \opt{GIGABEAT_PAD}{
@@ -244,7 +240,6 @@
244 } 240 }
245 }% 241 }%
246 242
247 \opt{lcd_bitmap}{
248 peak meter release 243 peak meter release
249 & 1 to 126 & ?\\ 244 & 1 to 126 & ?\\
250 peak meter hold 245 peak meter hold
@@ -284,12 +279,8 @@
284 show icons & on, off & N/A\\ 279 show icons & on, off & N/A\\
285 iconset & /path/filename.bmp & N/A\\ 280 iconset & /path/filename.bmp & N/A\\
286 viewers iconset & /path/filename.bmp & N/A\\ 281 viewers iconset & /path/filename.bmp & N/A\\
287 }%
288 282
289 \opt{swcodec}{% This doesn't depend on swcodec but using a \nopt here
290 % causes ondiosp not to build for mysterious reasons.
291 backdrop & /path/filename.bmp & N/A\\ 283 backdrop & /path/filename.bmp & N/A\\
292 }%
293 284
294 \opt{lcd_color}{ 285 \opt{lcd_color}{
295 foreground colour & 000000 to FFFFFF & RRGGBB\\ 286 foreground colour & 000000 to FFFFFF & RRGGBB\\
diff --git a/manual/appendix/file_formats.tex b/manual/appendix/file_formats.tex
index bfba184ade..4d64cf6bc6 100644
--- a/manual/appendix/file_formats.tex
+++ b/manual/appendix/file_formats.tex
@@ -6,18 +6,14 @@
6 & \textbf{Action when selected}}{}{} 6 & \textbf{Action when selected}}{}{}
7\includegraphics[width=0.37cm]{appendix/images/icon-directory.png} 7\includegraphics[width=0.37cm]{appendix/images/icon-directory.png}
8 & Directory & \emph{none} & Enter the directory \tabularnewline 8 & Directory & \emph{none} & Enter the directory \tabularnewline
9\opt{swcodec}{
10 \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} 9 \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png}
11 & Audio file & \emph{various}\newline% 10 & Audio file & \emph{various}\newline%
12 (see \ref{ref:Supportedaudioformats})% 11 (see \ref{ref:Supportedaudioformats})%
13 % do NOT use \reference{} here as that will break the table. 12 % do NOT use \reference{} here as that will break the table.
14 & Start playing the file and show the WPS\tabularnewline 13 & Start playing the file and show the WPS\tabularnewline
15}
16 & Bookmark & \fname{.bmark} & Display all bookmarks for an audio file\tabularnewline 14 & Bookmark & \fname{.bmark} & Display all bookmarks for an audio file\tabularnewline
17\opt{lcd_bitmap}{
18 & Game of Life & \fname{.cells} & Show the configuration with the 15 & Game of Life & \fname{.cells} & Show the configuration with the
19 ``Rocklife'' plugin\tabularnewline 16 ``Rocklife'' plugin\tabularnewline
20}
21\includegraphics[width=0.37cm]{appendix/images/icon-config.png} 17\includegraphics[width=0.37cm]{appendix/images/icon-config.png}
22 & Configuration File & \fname{.cfg} & Load the settings file\tabularnewline 18 & Configuration File & \fname{.cfg} & Load the settings file\tabularnewline
23\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} 19\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png}
@@ -62,10 +58,8 @@
62 \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 58 \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png}
63 & Rockbox firmware & \fname{.mi4} & Load the new firmware with ROLO \tabularnewline 59 & Rockbox firmware & \fname{.mi4} & Load the new firmware with ROLO \tabularnewline
64} 60}
65\opt{swcodec}{
66 \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} 61 \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png}
67 & Video & \fname{.mpg}, \fname{.mpeg}, \fname{.mpv}, \fname{.m2v} & Play the MPEG1/2 video \tabularnewline 62 & Video & \fname{.mpg}, \fname{.mpeg}, \fname{.mpv}, \fname{.m2v} & Play the MPEG1/2 video \tabularnewline
68}
69\includegraphics[width=0.37cm]{appendix/images/icon-rock.png} 63\includegraphics[width=0.37cm]{appendix/images/icon-rock.png}
70 & Plugin & \fname{.rock} & Start the plugin\tabularnewline 64 & Plugin & \fname{.rock} & Start the plugin\tabularnewline
71\opt{sansaAMS}{ 65\opt{sansaAMS}{
@@ -79,7 +73,6 @@
79 & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\tabularnewline 73 & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\tabularnewline
80\end{rbtabular} 74\end{rbtabular}
81 75
82\opt{swcodec}{
83 \chapter{Audio and metadata formats} 76 \chapter{Audio and metadata formats}
84 \section{\label{ref:Supportedaudioformats}Supported audio formats} 77 \section{\label{ref:Supportedaudioformats}Supported audio formats}
85 \subsection{Lossy Codecs} 78 \subsection{Lossy Codecs}
@@ -375,4 +368,3 @@
375 to 90 bytes. 368 to 90 bytes.
376 } 369 }
377 \end{enumerate} 370 \end{enumerate}
378}
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 1a0661c008..70fef71015 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -159,11 +159,10 @@ or \config{\%D(2)}), produce the information for the next file to be played.
159\section{Playlist/Song Info} 159\section{Playlist/Song Info}
160 \begin{tagmap} 160 \begin{tagmap}
161 \config{\%pb} & Progress Bar. 161 \config{\%pb} & Progress Bar.
162 \opt{lcd_bitmap}{ 162 This will replace the entire line with a progress bar.
163 This will replace the entire line with a progress bar. 163 You can set the position, width and height of the progressbar
164 You can set the position, width and height of the progressbar 164 (in pixels) and load a custom image for it:
165 (in pixels) and load a custom image for it: 165 \config{\%pb(x,y,[width],[height],image.bmp)} \\
166 \config{\%pb(x,y,[width],[height],image.bmp)}} \\
167 \config{\%px} & Percentage played in song\\ 166 \config{\%px} & Percentage played in song\\
168 \config{\%pc} & Current time in song\\ 167 \config{\%pc} & Current time in song\\
169 \config{\%pe} & Total number of playlist entries\\ 168 \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.
181 \config{\%pv} & Current volume (in dB). Can also be used in a conditional: 180 \config{\%pv} & Current volume (in dB). Can also be used in a conditional:
182 \config{\%?pv<Mute|\ldots|0 dB|Above 0 dB>}\newline 181 \config{\%?pv<Mute|\ldots|0 dB|Above 0 dB>}\newline
183 Mute is 0\% volume, \ldots is the values between Mute and max, 0 dB is max volume, and Above 0 dB is amplified volume 182 Mute is 0\% volume, \ldots is the values between Mute and max, 0 dB is max volume, and Above 0 dB is amplified volume
184 \opt{lcd_bitmap}{This can also be used like \%pb to provide a continuous scale: 183 This can also be used like \%pb to provide a continuous scale:
185 \config{\%pv(x,y,[width],[height],image.bmp)}} \\ 184 \config{\%pv(x,y,[width],[height],image.bmp)} \\
186 \config{\%pS} & Track is starting. An optional number gives how many seconds 185 \config{\%pS} & Track is starting. An optional number gives how many seconds
187 the tag remains true for after the start of the track. The default is 186 the tag remains true for after the start of the track. The default is
188 10 seconds if no number is specified. 187 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.
227 \config{\%ra} & Autoscore for the song\\ 226 \config{\%ra} & Autoscore for the song\\
228 \end{tagmap} 227 \end{tagmap}
229 228
230\opt{swcodec}{
231\section{Sound (DSP) settings} 229\section{Sound (DSP) settings}
232 \begin{tagmap} 230 \begin{tagmap}
233 \config{\%Sp} & Current playback pitch \\ 231 \config{\%Sp} & Current playback pitch \\
234 \opt{swcodec}{
235 \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip, 232 \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip,
236 Shuffle, Shuffle and Man Skip, Always\\ 233 Shuffle, Shuffle and Man Skip, Always\\
237 \config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional, 234 \config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional,
238 Replaygain type in use: \config{\%?rg<Off|Track% 235 Replaygain type in use: \config{\%?rg<Off|Track%
239 |Album|TrackShuffle|AlbumShuffle% 236 |Album|TrackShuffle|AlbumShuffle%
240 |No tag>}\\ 237 |No tag>}\\
241 }
242 \end{tagmap} 238 \end{tagmap}
243}
244 239
245\section{Hold} 240\section{Hold}
246 \begin{tagmap} 241 \begin{tagmap}
@@ -360,13 +355,11 @@ Examples:
360\end{enumerate} 355\end{enumerate}
361 356
362 357
363\opt{lcd_bitmap}{
364\section{\label{ref:wps_images}Images} 358\section{\label{ref:wps_images}Images}
365 \begin{tagmap} 359 \begin{tagmap}
366 \config{\%X(filename.bmp)} 360 \config{\%X(filename.bmp)}
367 & Load and set a backdrop image for the WPS. 361 & Load and set a backdrop image for the WPS.
368 This image must be exactly the same size as your LCD.\\ 362 This image must be exactly the same size as your LCD.\\
369 }%
370 \config{\%x(n,filename[,x,y])} 363 \config{\%x(n,filename[,x,y])}
371 & Load and display an image\newline 364 & Load and display an image\newline
372 \config{n}: image ID for later referencing in \config{\%xd}\newline 365 \config{n}: image ID for later referencing in \config{\%xd}\newline
diff --git a/manual/configure_rockbox/bookmarking.tex b/manual/configure_rockbox/bookmarking.tex
index 8147715ace..a429b63d21 100644
--- a/manual/configure_rockbox/bookmarking.tex
+++ b/manual/configure_rockbox/bookmarking.tex
@@ -1,9 +1,9 @@
1% $Id$ % 1% $Id$ %
2\section{\label{ref:Bookmarkconfigactual}Bookmarking} 2\section{\label{ref:Bookmarkconfigactual}Bookmarking}
3 Bookmarks allow you to save your current position within a track so that 3 Bookmarks allow you to save your current position within a track so that
4 you can return to it at a later time. \opt{swcodec}{Bookmarks also store 4 you can return to it at a later time. Bookmarks also store rate, pitch
5 rate, pitch and speed information from the \setting{Pitch Screen} (see 5 and speed information from the \setting{Pitch Screen} (see
6 \reference{sec:pitchscreen}).} Bookmarks are saved on a per directory 6 \reference{sec:pitchscreen}). Bookmarks are saved on a per directory
7 basis or for individual (saved) playlists. You can store multiple bookmarks, 7 basis or for individual (saved) playlists. You can store multiple bookmarks,
8 even for the same track. When there's already a bookmark for a directory or 8 even for the same track. When there's already a bookmark for a directory or
9 playlist, new bookmarks are added before existing ones. 9 playlist, new bookmarks are added before existing ones.
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index 33ddc3e18c..f00b0a2da9 100755
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -173,11 +173,9 @@
173 \item[Scroll Start Delay.] 173 \item[Scroll Start Delay.]
174 Controls how many milliseconds Rockbox should wait before a new 174 Controls how many milliseconds Rockbox should wait before a new
175 text begins automatically scrolling. 175 text begins automatically scrolling.
176 \opt{lcd_bitmap}{
177 \item[Scroll Step Size.] 176 \item[Scroll Step Size.]
178 Defines the number of pixels the text should move for each step, as used 177 Defines the number of pixels the text should move for each step, as used
179 by the Scroll Speed setting. 178 by the Scroll Speed setting.
180 }
181 \opt{remote}{ 179 \opt{remote}{
182 \item[Remote Scrolling Options.] 180 \item[Remote Scrolling Options.]
183 The options here have the same effect on the remote LCD as the options 181 The options here have the same effect on the remote LCD as the options
@@ -191,22 +189,20 @@
191 Rockbox chooses which method it should use depending of how much it has to 189 Rockbox chooses which method it should use depending of how much it has to
192 scroll to the left. This setting lets you tell Rockbox where that limit 190 scroll to the left. This setting lets you tell Rockbox where that limit
193 is, expressed in percentage of the line length. 191 is, expressed in percentage of the line length.
194 \opt{lcd_bitmap}{ 192 \item[Screen Scrolls Out of View.]
195 \item[Screen Scrolls Out of View.] 193 Screens can be manually scrolled horizontally by pressing
196 Screens can be manually scrolled horizontally by pressing 194 \opt{IRIVER_H10_PAD}{Long \ButtonRew/\ButtonFF}%
197 \opt{IRIVER_H10_PAD}{Long \ButtonRew/\ButtonFF}% 195 \opt{IRIVER_H10_PAD,XDUOO_X3_PAD}{Long \ButtonPrev/\ButtonNext}%
198 \opt{IRIVER_H10_PAD,XDUOO_X3_PAD}{Long \ButtonPrev/\ButtonNext}% 196 \nopt{IRIVER_H10_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,XDUOO_X3_PAD%
199 \nopt{IRIVER_H10_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,XDUOO_X3_PAD% 197 ,touchscreen}{%
200 ,touchscreen}{% 198 Long \ButtonRight/\ButtonLeft}.
201 Long \ButtonRight/\ButtonLeft}. 199 Setting this option to \setting{Yes}
202 Setting this option to \setting{Yes} 200 will keep the list entries at their fixed positions and allow them to be
203 will keep the list entries at their fixed positions and allow them to be 201 scrolled out of view, whereas \setting{No} will only scroll those entries
204 scrolled out of view, whereas \setting{No} will only scroll those entries 202 which surpass the right margin.
205 which surpass the right margin. 203 \item[Screen Scroll Step Size.]
206 \item[Screen Scroll Step Size.] 204 Defines the number of pixels the horizontal manual screen scroll should move
207 Defines the number of pixels the horizontal manual screen scroll should move 205 for each step.
208 for each step.
209 }
210 \item[Paged Scrolling.] 206 \item[Paged Scrolling.]
211 When set to \setting{Yes} scrolling vertically on pages that surpass the 207 When set to \setting{Yes} scrolling vertically on pages that surpass the
212 screen size will page up/down instead of simply changing lines. This can be 208 screen size will page up/down instead of simply changing lines. This can be
@@ -227,50 +223,49 @@
227 } 223 }
228 \end{description} 224 \end{description}
229% 225%
230 \opt{lcd_bitmap}{ 226 \item[Peak Meter.]
231 \item[Peak Meter.] 227 The peak meter can be configured with a number of parameters.
232 The peak meter can be configured with a number of parameters. 228 \begin{description}
233 \begin{description} 229 \item[Peak Release.]
234 \item[Peak Release.] 230 This determines how fast the bar shrinks when the music becomes
235 This determines how fast the bar shrinks when the music becomes 231 softer. Lower values make the peak meter look smoother.
236 softer. Lower values make the peak meter look smoother. 232 Expressed in scale units per 10~ms.
237 Expressed in scale units per 10~ms. 233 \item[Peak Hold Time.]
238 \item[Peak Hold Time.] 234 Specifies the time after which the peak indicator will reset.
239 Specifies the time after which the peak indicator will reset. 235 For example, if you set this value to 5~s, the peak indicator displays
240 For example, if you set this value to 5~s, the peak indicator displays 236 the loudest volume value that occurred within the last 5 seconds.
241 the loudest volume value that occurred within the last 5 seconds. 237 Larger values are useful if you want to find the peak level of a song,
242 Larger values are useful if you want to find the peak level of a song, 238 which might be of interest when copying music from the \dap\ via the
243 which might be of interest when copying music from the \dap\ via the 239 analogue output to some other recording device.
244 analogue output to some other recording device. 240 \item[Clip Hold Time.]
245 \item[Clip Hold Time.] 241 The number of seconds that the clipping indicator will be visible
246 The number of seconds that the clipping indicator will be visible 242 after clipping is detected.
247 after clipping is detected. 243 \opt{recording}{
248 \opt{recording}{ 244 \item[Clip Counter.]
249 \item[Clip Counter.] 245 Show the number of times the clip indicator went active during
250 Show the number of times the clip indicator went active during 246 recording in front of the peak meters.
251 recording in front of the peak meters.
252 }
253 \item[\label{ref:Peakmetersetting}Scale.]
254 Select whether the peak meter displays linear or logarithmic values.
255 The human ear perceives loudness on a logarithmic scale. If the Scale
256 setting is set to \setting{Logarithmic} (dB) scale, the volume values
257 are scaled logarithmically. The volume meters of digital audio
258 devices usually are scaled this way. On the other hand, if you
259 are interested in the power level that is applied to your headphones
260 you should choose \setting{Linear} display. This setting cannot be
261 displayed in units like volts or watts because such units depend
262 on your headphones.
263 \item[Minimum and maximum range.]
264 These two options define the full value range that the peak meter
265 displays. Recommended values for the \setting{Logarithmic} (dB) setting
266 are {}-40~dB for minimum and 0~dB for maximum. Recommended values
267 for \setting{Linear} display are 0 and 100\%. Note that {}-40~dB is
268 approximately 1\% in linear value, but if you change the minimum
269 setting in linear mode slightly and then change to the dB scale,
270 there will be a large change. You can use these values for `zooming'
271 into the peak meter.
272 \end{description}
273 } 247 }
248 \item[\label{ref:Peakmetersetting}Scale.]
249 Select whether the peak meter displays linear or logarithmic values.
250 The human ear perceives loudness on a logarithmic scale. If the Scale
251 setting is set to \setting{Logarithmic} (dB) scale, the volume values
252 are scaled logarithmically. The volume meters of digital audio
253 devices usually are scaled this way. On the other hand, if you
254 are interested in the power level that is applied to your headphones
255 you should choose \setting{Linear} display. This setting cannot be
256 displayed in units like volts or watts because such units depend
257 on your headphones.
258 \item[Minimum and maximum range.]
259 These two options define the full value range that the peak meter
260 displays. Recommended values for the \setting{Logarithmic} (dB) setting
261 are {}-40~dB for minimum and 0~dB for maximum. Recommended values
262 for \setting{Linear} display are 0 and 100\%. Note that {}-40~dB is
263 approximately 1\% in linear value, but if you change the minimum
264 setting in linear mode slightly and then change to the dB scale,
265 there will be a large change. You can use these values for `zooming'
266 into the peak meter.
267 \end{description}
268
274 \item[\label{ref:Defaultcodepage}Default Codepage.] 269 \item[\label{ref:Defaultcodepage}Default Codepage.]
275 A codepage describes the way extended characters that are not available 270 A codepage describes the way extended characters that are not available
276 within the ASCII character set are encoded. ID3v1 tags do not have a 271 within the ASCII character set are encoded. ID3v1 tags do not have a
diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex
index 83089b6d4e..b0711e5b71 100644
--- a/manual/configure_rockbox/main.tex
+++ b/manual/configure_rockbox/main.tex
@@ -16,9 +16,9 @@
16 \input{configure_rockbox/system_options.tex} 16 \input{configure_rockbox/system_options.tex}
17 \input{configure_rockbox/startup_shutdown_options.tex} 17 \input{configure_rockbox/startup_shutdown_options.tex}
18 \input{configure_rockbox/bookmarking.tex} 18 \input{configure_rockbox/bookmarking.tex}
19\opt{tagcache}{\opt{swcodec}{ 19\opt{tagcache}{
20 \input{configure_rockbox/autoresume.tex} 20 \input{configure_rockbox/autoresume.tex}
21}} 21}
22 \input{configure_rockbox/language.tex} 22 \input{configure_rockbox/language.tex}
23 \input{configure_rockbox/voice.tex} 23 \input{configure_rockbox/voice.tex}
24 \input{configure_rockbox/wps_context_plugin.tex} 24 \input{configure_rockbox/wps_context_plugin.tex}
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index 87f974800d..7ddd3c6907 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -68,10 +68,8 @@ you to configure settings related to audio playback.
68 This can happen if the \dap{} is knocked, shaken or jogged heavily while 68 This can happen if the \dap{} is knocked, shaken or jogged heavily while
69 Rockbox is trying to read the hard drive. 69 Rockbox is trying to read the hard drive.
70 70
71 \opt{swcodec}{ 71 The anti-skip buffer can be set to various values between
72 The anti-skip buffer can be set to various values between 72 5 seconds and 10 minutes.\\
73 5 seconds and 10 minutes.\\
74 }
75 73
76 \note{Having a large anti-skip buffer tends to use more power, and may 74 \note{Having a large anti-skip buffer tends to use more power, and may
77 reduce your battery life. It is recommended to always use the lowest 75 reduce your battery life. It is recommended to always use the lowest
@@ -90,110 +88,108 @@ you to configure settings related to audio playback.
90 instead of being played immediately. Pausing and stopping playback is 88 instead of being played immediately. Pausing and stopping playback is
91 disabled as well as skipping songs and launching plugins. 89 disabled as well as skipping songs and launching plugins.
92 90
93\opt{swcodec}{ 91\opt{crossfade}{
94 \opt{crossfade}{ 92\section{Crossfade}
95 \section{Crossfade} 93 This section controls the behavior of the crossfader. The crossfader, when
96 This section controls the behavior of the crossfader. The crossfader, when 94 enabled, smoothly fades one track into the next. This can occur in two
97 enabled, smoothly fades one track into the next. This can occur in two 95 situations: an automatic track change or a manual track skip. An automatic
98 situations: an automatic track change or a manual track skip. An automatic 96 track change occurs at the end of the track, moving to the next track in the
99 track change occurs at the end of the track, moving to the next track in the 97 playlist without user intervention. A manual track skip goes to the next
100 playlist without user intervention. A manual track skip goes to the next 98 track immediately when the appropriate button is pressed.\\
101 track immediately when the appropriate button is pressed.\\
102 99
103 Options for crossfade settings are: 100 Options for crossfade settings are:
104 \begin{description} 101 \begin{description}
105 \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled 102 \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled
106 and all track changes are gapless. If set to 103 and all track changes are gapless. If set to
107 \setting{Automatic Track Change Only}, crossfade occurs for automatic 104 \setting{Automatic Track Change Only}, crossfade occurs for automatic
108 track changes, but not for manual track skips. The next setting, 105 track changes, but not for manual track skips. The next setting,
109 \setting{Manual Track Skip Only}, is the opposite: tracks will only 106 \setting{Manual Track Skip Only}, is the opposite: tracks will only
110 crossfade when manually skipped. If set to \setting{Shuffle}, crossfade 107 crossfade when manually skipped. If set to \setting{Shuffle}, crossfade
111 is enabled for all track changes, automatic or manual, when the shuffle 108 is enabled for all track changes, automatic or manual, when the shuffle
112 feature is set to \setting{Yes}, but disabled otherwise. If set to 109 feature is set to \setting{Yes}, but disabled otherwise. If set to
113 \setting{Shuffle or Manual Track Skip} then crossfade will be active 110 \setting{Shuffle or Manual Track Skip} then crossfade will be active
114 either when shuffle is set to \setting{Yes} or the track is manually 111 either when shuffle is set to \setting{Yes} or the track is manually
115 skipped. If set to \setting{Always}, tracks will always crossfade into 112 skipped. If set to \setting{Always}, tracks will always crossfade into
116 one another. 113 one another.
117 % 114 %
118 \item[Fade In Delay.] The ``fade in delay'' is the length of time between 115 \item[Fade In Delay.] The ``fade in delay'' is the length of time between
119 when the crossfade process begins and when the new track begins to fade 116 when the crossfade process begins and when the new track begins to fade
120 in. 117 in.
121 % 118 %
122 \item[Fade In Duration.] The length of time, in seconds, that it takes 119 \item[Fade In Duration.] The length of time, in seconds, that it takes
123 your music to fade in once the \setting{Fade In Delay} has ended. 120 your music to fade in once the \setting{Fade In Delay} has ended.
124 % 121 %
125 \item[Fade Out Delay.] The ``fade out delay'' is the length of time 122 \item[Fade Out Delay.] The ``fade out delay'' is the length of time
126 between when the crossfade process begins and when the old track begins 123 between when the crossfade process begins and when the old track begins
127 to fade out. 124 to fade out.
128 % 125 %
129 \item[Fade Out Duration.] The length of time, in seconds, that it takes 126 \item[Fade Out Duration.] The length of time, in seconds, that it takes
130 your music to fade out once the \setting{Fade Out Delay} has ended. 127 your music to fade out once the \setting{Fade Out Delay} has ended.
131 % 128 %
132 \item[Fade Out Mode.] If set to \setting{Crossfade}, one song will fade 129 \item[Fade Out Mode.] If set to \setting{Crossfade}, one song will fade
133 out and the next song will simultaneously fade in. If set to 130 out and the next song will simultaneously fade in. If set to
134 \setting{Mix}, the ending song will not fade out at all, and will 131 \setting{Mix}, the ending song will not fade out at all, and will
135 continue to play as normal until its end with the starting song fading 132 continue to play as normal until its end with the starting song fading
136 in from under it. \setting{Mix} mode is not used for manual track skips, 133 in from under it. \setting{Mix} mode is not used for manual track skips,
137 even if it is selected here. 134 even if it is selected here.
138 \end{description} 135 \end{description}
139 136
140 \note{The rules above apply except in the instance where 137 \note{The rules above apply except in the instance where
141 \setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then 138 \setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then
142 \setting{Fade In Delay} (which would create a gap in the audio). In this case, 139 \setting{Fade In Delay} (which would create a gap in the audio). In this case,
143 the \setting{Fade In Delay} is reduced to eliminate the gap.\\} 140 the \setting{Fade In Delay} is reduced to eliminate the gap.\\}
144 141
145 The graphic below illustrates how the different settings work in practice. 142 The graphic below illustrates how the different settings work in practice.
146 143
147 \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png} 144 \includegraphics[width=14cm]{configure_rockbox/images/crossfade_graphic.png}
148 }%\opt{crossfade} 145 }%\opt{crossfade}
149 146
150 \section{\label{ref:ReplayGain}Replaygain} 147\section{\label{ref:ReplayGain}Replaygain}
151 This allows you to control the replaygain function. 148 This allows you to control the replaygain function.
152 The purpose of replaygain is to adjust the volume of the music played 149 The purpose of replaygain is to adjust the volume of the music played
153 so that all songs (or albums, depending on your settings) have the 150 so that all songs (or albums, depending on your settings) have the
154 same apparent volume. This prevents sudden changes in volume when 151 same apparent volume. This prevents sudden changes in volume when
155 changing between songs recorded at different volume levels. 152 changing between songs recorded at different volume levels.
156 For replaygain to work, the songs must have been processed by a program 153 For replaygain to work, the songs must have been processed by a program
157 that adds replaygain information to the ID3 tags (or Vorbis tags).\\ 154 that adds replaygain information to the ID3 tags (or Vorbis tags).\\
158 155
159 Options for replaygain are: 156 Options for replaygain are:
160 \begin{description} 157 \begin{description}
161 \item[Replaygain Type.] Choose the type of replaygain to apply: 158 \item[Replaygain Type.] Choose the type of replaygain to apply:
162 \begin{description} 159 \begin{description}
163 \item[Album Gain.] Maintain a constant volume level between 160 \item[Album Gain.] Maintain a constant volume level between
164 albums, but keep any intentional volume variations between 161 albums, but keep any intentional volume variations between
165 songs in an album. (If album gain value is not available, 162 songs in an album. (If album gain value is not available,
166 uses track gain information). 163 uses track gain information).
167 %
168 \item[Track Gain.] Maintain a constant volume level between
169 tracks. If track gain value is not available, no replaygain
170 is applied.
171 %
172 \item[Track Gain If Shuffling.] Maintains a constant volume
173 between tracks if \setting{Shuffle} is set to \setting{Yes}.
174 Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
175 %
176 \item[Off.] Do not process replaygain information, i.e. turn off
177 the replaygain function.
178 \end{description}
179 % 164 %
180 \item[Prevent Clipping.] Avoid clipping of a song's waveform. 165 \item[Track Gain.] Maintain a constant volume level between
181 If a song would clip during playback, the volume is lowered for 166 tracks. If track gain value is not available, no replaygain
182 that song. Replaygain information is needed for this to work. 167 is applied.
183 % 168 %
184 \item[Pre-amp.] This allows you to adjust the volume when replaygain 169 \item[Track Gain If Shuffling.] Maintains a constant volume
185 is applied. Replaygain often lowers the volume, sometimes quite 170 between tracks if \setting{Shuffle} is set to \setting{Yes}.
186 much, so here you can compensate for that. Please note that a 171 Reverts to album mode if \setting{Shuffle} is set to \setting{No}.
187 (large) positive pre-amp setting can cause clipping, unless 172 %
188 prevent clipping is enabled. The pre-amp can be set to any 173 \item[Off.] Do not process replaygain information, i.e. turn off
189 decibel (dB) value between -12~dB and +12~dB, in increments of 0.5~dB. 174 the replaygain function.
190 \end{description} 175 \end{description}
176 %
177 \item[Prevent Clipping.] Avoid clipping of a song's waveform.
178 If a song would clip during playback, the volume is lowered for
179 that song. Replaygain information is needed for this to work.
180 %
181 \item[Pre-amp.] This allows you to adjust the volume when replaygain
182 is applied. Replaygain often lowers the volume, sometimes quite
183 much, so here you can compensate for that. Please note that a
184 (large) positive pre-amp setting can cause clipping, unless
185 prevent clipping is enabled. The pre-amp can be set to any
186 decibel (dB) value between -12~dB and +12~dB, in increments of 0.5~dB.
187 \end{description}
191 188
192 \section{Track Skip Beep} 189\section{Track Skip Beep}
193 Controls the volume of the beep that is heard when 190 Controls the volume of the beep that is heard when
194 skipping forward or backward between tracks. The beep is disabled when 191 skipping forward or backward between tracks. The beep is disabled when
195 set to \setting{Off}. 192 set to \setting{Off}.
196}%\opt{swcodec}
197 193
198\opt{spdif_power}{ 194\opt{spdif_power}{
199 \section{\label{ref:SPDIF_OnOff}Optical Output} 195 \section{\label{ref:SPDIF_OnOff}Optical Output}
@@ -294,32 +290,28 @@ you to configure settings related to audio playback.
294 if a track ends, which can be achieved by combining this option with 290 if a track ends, which can be achieved by combining this option with
295 \setting{Repeat} set to \setting{One} 291 \setting{Repeat} set to \setting{One}
296 292
297\opt{swcodec}{ 293\section{Rewind Before Resume}\index{Rewind Before Resume}
298 \section{Rewind Before Resume}\index{Rewind Before Resume} 294 When restarting a track or a bookmark, a short rewind can be done before the
299 When restarting a track or a bookmark, a short rewind can be done before the 295 playback is started. This can be useful when listening to speech material,
300 playback is started. This can be useful when listening to speech material, 296 to help remember what was being said just before playback was stopped.
301 to help remember what was being said just before playback was stopped. 297 The size of the rewind can be set to various values between 0 (off) and
302 The size of the rewind can be set to various values between 0 (off) and 298 60 seconds.
303 60 seconds. 299 \note{This option does not apply to resuming a paused track. Use
304 \note{This option does not apply to resuming a paused track. Use 300 the next option for rewinding on pause.}
305 the next option for rewinding on pause.} 301 \note{The actual rewind distance may differ a little from the requested
306 \note{The actual rewind distance may differ a little from the requested 302 value, depending on the file in question.}
307 value, depending on the file in question.}
308}%\opt{swcodec}
309 303
310\section{Rewind on Pause}\index{Rewind on Pause} 304\section{Rewind on Pause}\index{Rewind on Pause}
311 This option rewinds the current track by a small amount whenever it is 305 This option rewinds the current track by a small amount whenever it is
312 paused (not stopped). The amount to rewind can be set between 0 and 306 paused (not stopped). The amount to rewind can be set between 0 and
313 15 seconds. 307 15 seconds.
314 308
315\opt{swcodec}{ 309\opt{play_frequency}{
316 \opt{play_frequency}{ 310 \section{Frequency}\index{Frequency}
317 \section{Frequency}\index{Frequency} 311 This is the sampling frequency used for the rockbox playback engine. Audio
318 This is the sampling frequency used for the rockbox playback engine. Audio 312 at a different sampling rate will be converted to this sampling rate prior to
319 at a different sampling rate will be converted to this sampling rate prior to 313 mixing using a cubic Hermite polynomial resampler.
320 mixing using a cubic Hermite polynomial resampler. 314 \note{For best quality and battery life, select the sampling rate used by
321 \note{For best quality and battery life, select the sampling rate used by 315 your audio. This is typically 44.1kHz.}
322 your audio. This is typically 44.1kHz.} 316 \note{Opus files are always 48kHz.}
323 \note{Opus files are always 48kHz.} 317}
324 }
325}%\opt{swcodec}
diff --git a/manual/configure_rockbox/recording_settings.tex b/manual/configure_rockbox/recording_settings.tex
index 9a5ddb30a6..1abd38c536 100644
--- a/manual/configure_rockbox/recording_settings.tex
+++ b/manual/configure_rockbox/recording_settings.tex
@@ -6,16 +6,14 @@
6 where you want to store them in the \setting{File Browser} and select 6 where you want to store them in the \setting{File Browser} and select
7 \setting{Set As Recording Directory}.} 7 \setting{Set As Recording Directory}.}
8 8
9\opt{swcodec}{ 9\section{Format}
10 \section{Format} 10 Choose which format to save your recording in. The available choices are
11 Choose which format to save your recording in. The available choices are 11 the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the
12 the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the 12 losslessly compressed \setting{WavPack} and the lossy
13 losslessly compressed \setting{WavPack} and the lossy 13 \setting{MPEG Layer~3}.
14 \setting{MPEG Layer~3}.
15 14
16 \section{Encoder Settings (MP3 only)} 15\section{Encoder Settings (MP3 only)}
17 This sets the bitrate when using the \setting{MPEG Layer~3} format. 16 This sets the bitrate when using the \setting{MPEG Layer~3} format.
18}
19 17
20 \section{Frequency} 18 \section{Frequency}
21 \nopt{ipodnano,ipodcolor,ipod4g}{ 19 \nopt{ipodnano,ipodcolor,ipod4g}{
@@ -39,9 +37,8 @@
39 22.05~kHz, 16~kHz, 12~kHz, 11.025~kHz and 8~kHz} 37 22.05~kHz, 16~kHz, 12~kHz, 11.025~kHz and 8~kHz}
40 are available. Higher sample rates use up more disk space, but give better 38 are available. Higher sample rates use up more disk space, but give better
41 sound quality. 39 sound quality.
42 \opt{swcodec}{\note{The 11.025~kHz setting is not available when using % 40 \note{The 11.025~kHz setting is not available when using %
43 \setting{MPEG Layer~3} format.} 41 \setting{MPEG Layer~3} format.}
44 }
45 \opt{recording_digital} 42 \opt{recording_digital}
46 {\note{You cannot change the sample rate for digital recordings.} 43 {\note{You cannot change the sample rate for digital recordings.}
47 } 44 }
@@ -80,11 +77,9 @@
80 for mono recording, only the left channel is recorded. Mono recordings 77 for mono recording, only the left channel is recorded. Mono recordings
81 are usually somewhat smaller than stereo. 78 are usually somewhat smaller than stereo.
82 79
83\opt{swcodec}{ 80\section{Mono Mode}
84 \section{Mono Mode} 81 When configured to record to mono and the source is a stereo signal, use this
85 When configured to record to mono and the source is a stereo signal, use this 82 setting to configure how the mono signal is created. Options are L, R and L+R.
86 setting to configure how the mono signal is created. Options are L, R and L+R.
87}
88 83
89\section{File Split Options} 84\section{File Split Options}
90 This sub menu contains options for file splitting, which can be used to split 85 This sub menu contains options for file splitting, which can be used to split
diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex
index c4ef325689..63a5770c41 100644
--- a/manual/configure_rockbox/sound_settings.tex
+++ b/manual/configure_rockbox/sound_settings.tex
@@ -197,7 +197,6 @@ change to customise your listening experience.
197 }% 197 }%
198} 198}
199 199
200\opt{swcodec}{
201\section{Crossfeed} 200\section{Crossfeed}
202 Crossfeed attempts to make the experience of listening to music on 201 Crossfeed attempts to make the experience of listening to music on
203 headphones more similar to listening to music with stereo speakers. When you 202 headphones more similar to listening to music with stereo speakers. When you
@@ -250,9 +249,7 @@ change to customise your listening experience.
250 % http://www.ohl.to/interests-in-audio/crossfeed-and-eq-for-headphones/ 249 % http://www.ohl.to/interests-in-audio/crossfeed-and-eq-for-headphones/
251 Beware that the crossfeed function is capable of making the audio distort 250 Beware that the crossfeed function is capable of making the audio distort
252 if you choose settings which result in a too high output level. 251 if you choose settings which result in a too high output level.
253}
254 252
255\opt{swcodec}{
256\section{\label{ref:EQ}Equalizer} 253\section{\label{ref:EQ}Equalizer}
257 \screenshot{configure_rockbox/images/ss-equalizer}{The graphical equalizer}{} 254 \screenshot{configure_rockbox/images/ss-equalizer}{The graphical equalizer}{}
258 Rockbox features a parametric equalizer (EQ). In contrast to non-parametric 255 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
472settings. 469settings.
473 470
474\end{description} 471\end{description}
475}
476 472
477\opt{swcodec}{
478\section{Dithering} 473\section{Dithering}
479This setting controls the dithering and noise shaping functionality of Rockbox. 474This setting controls the dithering and noise shaping functionality of Rockbox.
480 475
@@ -500,9 +495,7 @@ and not easily noticable.
500 495
501Rockbox uses highpass triangular distribution noise as the dithering noise 496Rockbox uses highpass triangular distribution noise as the dithering noise
502source, and a third order noise shaper. 497source, and a third order noise shaper.
503}
504 498
505\opt{swcodec}{%
506\opt{pitchscreen}{% 499\opt{pitchscreen}{%
507\section{Timestretch} 500\section{Timestretch}
508Enabling \setting{Timestretch} allows you to change the playback speed without 501Enabling \setting{Timestretch} allows you to change the playback speed without
@@ -512,9 +505,7 @@ intended for speech playback and may significantly dilute your listening
512experience with more complex audio. See \reference{sec:pitchscreen} for more 505experience with more complex audio. See \reference{sec:pitchscreen} for more
513details about how to use the feature. 506details about how to use the feature.
514} 507}
515}
516 508
517\opt{swcodec}{
518\section{Haas Surround} 509\section{Haas Surround}
519This setting implements the Haas effect with adjustable delay time to enhance 510This setting implements the Haas effect with adjustable delay time to enhance
520the stereo effect of the sound. A full range Haas effect creates the impression 511the 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
526setting uses mid-side processing to determine and apply effect to the side channel only. 517setting uses mid-side processing to determine and apply effect to the side channel only.
527Finally, the \setting{Dry/Wet Mix} setting adjusts the proportion mixed from the 518Finally, the \setting{Dry/Wet Mix} setting adjusts the proportion mixed from the
528original (dry) and 'effected' (wet) signals. 519original (dry) and 'effected' (wet) signals.
529}
530 520
531\opt{swcodec}{
532\section{Perceptual Bass Enhancement} 521\section{Perceptual Bass Enhancement}
533This setting implements a group delay correction and an additional biophonic EQ to 522This setting implements a group delay correction and an additional biophonic EQ to
534emphasize to boost bass perception. The \setting{precut} setting provides 523emphasize to boost bass perception. The \setting{precut} setting provides
535negative overall gain to prevent possible audio distortion due to the EQ 524negative overall gain to prevent possible audio distortion due to the EQ
536gain. The defult precut value is set to -2.5 dB and can be adjust from 0 dB to -4.5 dB. 525gain. The defult precut value is set to -2.5 dB and can be adjust from 0 dB to -4.5 dB.
537Note that this effect will stack with any other EQ applied. 526Note that this effect will stack with any other EQ applied.
538}
539 527
540\opt{swcodec}{
541\section{Auditory Fatigue Reduction} 528\section{Auditory Fatigue Reduction}
542Human hearing is more senstive to some frequency bands. This setting applies additional 529Human hearing is more senstive to some frequency bands. This setting applies additional
543equalization and bi-shelf filtering to reduce signals in these bands to minimize 530equalization and bi-shelf filtering to reduce signals in these bands to minimize
544the chance that temporary threshold shift (auditory fatigue) occurs. 531the chance that temporary threshold shift (auditory fatigue) occurs.
545}
546 532
547\opt{swcodec}{
548\section{Compressor} 533\section{Compressor}
549The \setting{Compressor} reduces, or compresses, the dynamic range of the audio 534The \setting{Compressor} reduces, or compresses, the dynamic range of the audio
550signal. This makes the quieter and louder sections closer to the same volume 535signal. 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
592immediately return to normal levels. This is necessary to reduce artifacts 577immediately return to normal levels. This is necessary to reduce artifacts
593such as ``pumping.'' Instead, the gain is allowed to return to normal at the 578such as ``pumping.'' Instead, the gain is allowed to return to normal at the
594chosen rate. Release Time is the time for the gain to recover by 10~dB. 579chosen rate. Release Time is the time for the gain to recover by 10~dB.
595}
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index f9e09a91b1..bf82b8c074 100755
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -203,27 +203,25 @@ therefore result in better runtime.
203 } 203 }
204} 204}
205 205
206\opt{swcodec}{ 206\subsection{Keyclick}
207 \subsection{Keyclick} 207 This menu controls key clicks on button presses.
208 This menu controls key clicks on button presses. 208 \begin{description}
209 \begin{description} 209 \opt{hardware_click}{
210 \opt{hardware_click}{ 210 \item [Headphone Keyclick. ]This setting controls how strong the keyclicks
211 \item [Headphone Keyclick. ]This setting controls how strong the keyclicks 211 played through the headphones are. If set to \setting{Off}, the keyclicks
212 played through the headphones are. If set to \setting{Off}, the keyclicks 212 will be disabled.
213 will be disabled. 213 \item [Speaker Keyclick. ]This setting turns playing of keyclicks through
214 \item [Speaker Keyclick. ]This setting turns playing of keyclicks through 214 the built in speaker \setting{On} or \setting{Off}.
215 the built in speaker \setting{On} or \setting{Off}. 215 }
216 } 216 \nopt{hardware_click}{
217 \nopt{hardware_click}{ 217 \item [Keyclick. ]This setting controls how strong the keyclicks are.
218 \item [Keyclick. ]This setting controls how strong the keyclicks are. 218 If set to \setting{Off}, the keyclicks will be disabled.
219 If set to \setting{Off}, the keyclicks will be disabled. 219 }
220 } 220 \item [Keyclick repeats.] This setting turns keyclick repeats \setting{On}
221 \item [Keyclick repeats.] This setting turns keyclick repeats \setting{On} 221 and \setting{Off}. If set to \setting{On}, the keyclicks will be
222 and \setting{Off}. If set to \setting{On}, the keyclicks will be 222 repeated when you hold down a button. If set to \setting{Off}, you will
223 repeated when you hold down a button. If set to \setting{Off}, you will 223 hear only one click.
224 hear only one click. 224 \end{description}
225 \end{description}
226}
227 225
228\opt{touchpad}{ 226\opt{touchpad}{
229 \subsection{Touchpad} 227 \subsection{Touchpad}
diff --git a/manual/configure_rockbox/theme_settings.tex b/manual/configure_rockbox/theme_settings.tex
index 2cbe57b014..a04646f479 100644
--- a/manual/configure_rockbox/theme_settings.tex
+++ b/manual/configure_rockbox/theme_settings.tex
@@ -47,11 +47,9 @@ customize the visual appearance of Rockbox.
47 headphones and when connected to an external amplifier. See 47 headphones and when connected to an external amplifier. See
48 \reference{ref:CreateYourOwnWPS} for more details.} 48 \reference{ref:CreateYourOwnWPS} for more details.}
49 49
50\opt{lcd_bitmap}{
51 \item[Font.] 50 \item[Font.]
52 Browse the installed fonts on your \dap{}. Selecting one will activate it. 51 Browse the installed fonts on your \dap{}. Selecting one will activate it.
53 See \reference{ref:Loadingfonts} for further details about fonts. 52 See \reference{ref:Loadingfonts} for further details about fonts.
54}
55 53
56\item[While Playing Screen.] 54\item[While Playing Screen.]
57 Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and 55 Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and
@@ -75,10 +73,8 @@ customize the visual appearance of Rockbox.
75 Rockbox has the ability to display an icon to the left of the file 73 Rockbox has the ability to display an icon to the left of the file
76 in the \setting{File Browser}. For details of these icons, see 74 in the \setting{File Browser}. For details of these icons, see
77 \reference{ref:Supportedfileformats}. 75 \reference{ref:Supportedfileformats}.
78 \opt{lcd_bitmap}{ 76 These icons can also be customised. See the \wikilink{IconSets}
79 These icons can also be customised. See the \wikilink{IconSets} 77 and \wikilink{CustomIcons} Wiki pages for details.
80 and \wikilink{CustomIcons} Wiki pages for details.
81 }
82 78
83\opt{lcd_non-mono}{% 79\opt{lcd_non-mono}{%
84 \item[Clear Backdrop.] 80 \item[Clear Backdrop.]
@@ -87,30 +83,27 @@ customize the visual appearance of Rockbox.
87 This option allows you to clear the backdrops that you set. 83 This option allows you to clear the backdrops that you set.
88} 84}
89% 85%
90 \opt{lcd_bitmap}{ 86\item[Status/Scrollbar.]
91 \item[Status/Scrollbar.] 87 Settings related to on screen status display and the scrollbar.
92 Settings related to on screen status display and the scrollbar. 88 \begin{description}
93 \begin{description} 89 \item[Scroll Bar.] Allows you to choose where the vertical scroll bar
94 \item[Scroll Bar.] Allows you to choose where the vertical scroll bar 90 should appear.
95 should appear. 91 \item[Scroll Bar Width.] Allows you to choose the width of the
96 \item[Scroll Bar Width.] Allows you to choose the width of the 92 scroll bar (in pixels). Default value is 6.
97 scroll bar (in pixels). Default value is 6. 93 \item[Status Bar.] Allows you to choose where to display the
98 \item[Status Bar.] Allows you to choose where to display the 94 statusbar\opt{remote}{ on the main display}.
99 statusbar\opt{remote}{ on the main display}. 95 \opt{remote}{
100 \opt{remote}{ 96 \item[Remote Status Bar.] Allows you to choose where to display the
101 \item[Remote Status Bar.] Allows you to choose where to display the 97 statusbar on the remote display.
102 statusbar on the remote display. 98 }
103 } 99 \item[Volume Display.] Controls whether the volume is displayed as a
104 \item[Volume Display.] Controls whether the volume is displayed as a 100 graphic or a numeric value on the Status Bar. If you select a numeric
105 graphic or a numeric value on the Status Bar. If you select a numeric 101 display, volume is displayed in decibels. See \reference{ref:volume}
106 display, volume is displayed in decibels. See \reference{ref:volume} 102 for more on the volume setting.
107 for more on the volume setting. 103 \item[Battery Display.] Controls whether the battery charge status is
108 \item[Battery Display.] Controls whether the battery charge status is 104 displayed as a graphic or numerical percentage value on the Status Bar.
109 displayed as a graphic or numerical percentage value on the Status Bar. 105 \end{description}
110 \end{description}
111 }
112% 106%
113\opt{lcd_bitmap}{
114\item[Line Selector Type.] 107\item[Line Selector Type.]
115 This option allows you to select which type of line selector to use. 108 This option allows you to select which type of line selector to use.
116 \begin{description} 109 \begin{description}
@@ -127,7 +120,6 @@ customize the visual appearance of Rockbox.
127 submenu. 120 submenu.
128} 121}
129 \end{description} 122 \end{description}
130}
131 123
132\opt{lcd_color}{ 124\opt{lcd_color}{
133 \item[Colours.] 125 \item[Colours.]
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 882057b80f..eb6e4a0e7f 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -243,7 +243,6 @@ still available to you.\\
243 various important aspects of Rockbox, such as the different versions 243 various important aspects of Rockbox, such as the different versions
244 available.\\}} 244 available.\\}}
245 245
246\opt{swcodec} {
247 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components, 246 \opt{HAVE_RB_BL_ON_DISK}{There are three separate components,
248 two of which need to be installed in order to run Rockbox:} 247 two of which need to be installed in order to run Rockbox:}
249 \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components 248 \opt{HAVE_RB_BL_IN_FLASH}{There are two separate components
@@ -282,7 +281,6 @@ still available to you.\\
282 \fname{.rockbox} which contains all of the Rockbox files, and is 281 \fname{.rockbox} which contains all of the Rockbox files, and is
283 located in the root of your \daps{} drive. 282 located in the root of your \daps{} drive.
284\end{description} 283\end{description}
285}
286 284
287Apart from the required parts there are some addons you might be interested 285Apart from the required parts there are some addons you might be interested
288in installing. 286in installing.
diff --git a/manual/main_menu/fmradio.tex b/manual/main_menu/fmradio.tex
index 56fe40a6be..bad3907e06 100644
--- a/manual/main_menu/fmradio.tex
+++ b/manual/main_menu/fmradio.tex
@@ -20,14 +20,12 @@
20 files are available here: \wikilink{FmPresets}. 20 files are available here: \wikilink{FmPresets}.
21 21
22 \opt{recording}{ 22 \opt{recording}{
23 \opt{swcodec}{ 23 It is also possible to record the FM radio while listening.
24 It is also possible to record the FM radio while listening. 24 To start recording, enter the FM radio settings menu with
25 To start recording, enter the FM radio settings menu with 25 \ActionFMMenu{} and then select \setting{Recording}.
26 \ActionFMMenu{} and then select \setting{Recording}. 26 At this point, you will be switched to the \setting{Recording Screen}.
27 At this point, you will be switched to the \setting{Recording Screen}. 27 Further information on \setting{Recording} can be found in
28 Further information on \setting{Recording} can be found in 28 \reference{ref:Recording}.
29 \reference{ref:Recording}.
30 }
31 } 29 }
32 30
33 \begin{btnmap} 31 \begin{btnmap}
diff --git a/manual/plugins/lrcplayer.tex b/manual/plugins/lrcplayer.tex
index 2f72cc359f..d1ff67a842 100644
--- a/manual/plugins/lrcplayer.tex
+++ b/manual/plugins/lrcplayer.tex
@@ -37,8 +37,8 @@ Any other tags and lines without time tags are ignored.
37 37
38\subsubsection{Location of lyrics files} 38\subsubsection{Location of lyrics files}
39The plugin checks the following directories for lyrics files. 39The plugin checks the following directories for lyrics files.
40\opt{swcodec}{If no lyrics file is found and the audio file is a \fname{.mp3}, 40If no lyrics file is found and the audio file is a \fname{.mp3},
41 it also checks for SYLT and USLT tags in the id3v2 tags.} 41it also checks for SYLT and USLT tags in the id3v2 tags.
42 42
43\begin{enumerate} 43\begin{enumerate}
44\item The directory containing the audio file and its parent directories. 44\item The directory containing the audio file and its parent directories.
@@ -116,10 +116,8 @@ same order as in that list.
116\begin{description} 116\begin{description}
117 \item[Theme settings.] Change theme related settings. 117 \item[Theme settings.] Change theme related settings.
118 \begin{description} 118 \begin{description}
119 \opt{lcd_bitmap}{% 119 \item[Show Statusbar.] Show / hide the statusbar.
120 \item[Show Statusbar.] Show / hide the statusbar. 120 \item[Display Title.] Show / hide the track title.
121 \item[Display Title.] Show / hide the track title.
122 }%
123 \item[Display Time.] Show / hide the current time. 121 \item[Display Time.] Show / hide the current time.
124 \opt{lcd_color}{% 122 \opt{lcd_color}{%
125 \item[Inactive Colour.] Set the colour of the inactive part of the lyrics. 123 \item[Inactive Colour.] Set the colour of the inactive part of the lyrics.
@@ -127,22 +125,18 @@ same order as in that list.
127 \item[Backlight Force On.] Do not turn off the backlight while displaying 125 \item[Backlight Force On.] Do not turn off the backlight while displaying
128 the lyrics. 126 the lyrics.
129 \end{description} 127 \end{description}
130 \opt{lcd_bitmap}{% 128 \item[Display Settings.] Change how the lyrics are displayed.
131 \item[Display Settings.] Change how the lyrics are displayed. 129 \begin{description}
132 \begin{description} 130 \item[Wrap.] Breaks lines at white space.
133 \item[Wrap.] Breaks lines at white space. 131 \item[Wipe.] Wipes the text.
134 \item[Wipe.] Wipes the text. 132 \item[Alignment.] Align text to the left, centre, or right.
135 \item[Alignment.] Align text to the left, centre, or right. 133 \item[Activate Only Current Line.]
136 \item[Activate Only Current Line.] 134 Activate only the current line, or the current and previous lines.
137 Activate only the current line, or the current and previous lines. 135 \end{description}
138 \end{description}
139 }%
140 \item[Lyrics Settings.] Change how the lyrics files are loaded. 136 \item[Lyrics Settings.] Change how the lyrics files are loaded.
141 \begin{description} 137 \begin{description}
142 \item[Encoding.] Sets the codepage used in the plugin. 138 \item[Encoding.] Sets the codepage used in the plugin.
143 \opt{swcodec}{% 139 \item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files.
144 \item[Read ID3 tag.] Read lyrics from id3 tags in mp3 files.
145 }%
146 \item[Lrc Directory.] Set the directory where lyrics files are stored, 140 \item[Lrc Directory.] Set the directory where lyrics files are stored,
147 must be a maximum of 63 bytes. 141 must be a maximum of 63 bytes.
148 \end{description} 142 \end{description}
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 2b80c3e2ce..4777379f19 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -14,30 +14,28 @@ them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\
14 14
15Viewer plugins get started automatically by opening an associated file (i.e. 15Viewer plugins get started automatically by opening an associated file (i.e.
16text files% 16text files%
17\opt{lcd_bitmap}{, chip8 games}% 17, chip8 games), or from the \setting{Open with} option on the \setting{Context Menu}.
18), or from the \setting{Open with} option on the \setting{Context Menu}.
19 18
20\section{Games} 19\section{Games}
21\opt{lcd_bitmap} 20 See also the Chip{}-8 emulator in \reference{ref:Chip8emulator},
22 {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator}, 21 Frotz in \reference{ref:Frotz},
23 Frotz in \reference{ref:Frotz}, 22 \opt{iriverh100,iaudiom5,lcd_color}
24 \opt{iriverh100,iaudiom5,lcd_color} 23 {Rockboy in \reference{ref:Rockboy}}
25 {Rockboy in \reference{ref:Rockboy}} 24 and ZXBox in \reference{ref:ZXBox}.
26 and ZXBox in \reference{ref:ZXBox}.}
27 25
28\opt{lcd_bitmap}{\input{plugins/2048.tex}} 26\input{plugins/2048.tex}
29 27
30\opt{lcd_bitmap}{\input{plugins/blackjack.tex}} 28\input{plugins/blackjack.tex}
31 29
32\opt{large_plugin_buffer}{\input{plugins/boomshine.tex}} 30\opt{large_plugin_buffer}{\input{plugins/boomshine.tex}}
33 31
34\opt{lcd_bitmap}{\input{plugins/brickmania.tex}} 32\input{plugins/brickmania.tex}
35 33
36\opt{lcd_bitmap}{\input{plugins/bubbles.tex}} 34\input{plugins/bubbles.tex}
37 35
38\opt{lcd_bitmap}{\input{plugins/chessbox.tex}} 36\input{plugins/chessbox.tex}
39 37
40\opt{lcd_bitmap}{\input{plugins/chopper.tex}} 38\input{plugins/chopper.tex}
41 39
42\opt{lcd_color}{\input{plugins/clix.tex}} 40\opt{lcd_color}{\input{plugins/clix.tex}}
43 41
@@ -51,103 +49,103 @@ text files%
51 49
52{\input{plugins/flipit.tex}} 50{\input{plugins/flipit.tex}}
53 51
54\opt{lcd_bitmap}{\input{plugins/goban.tex}} 52\input{plugins/goban.tex}
55 53
56\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{ 54\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
57 \input{plugins/invadrox.tex}}} 55 \input{plugins/invadrox.tex}}}
58 56
59{\input{plugins/jackpot.tex}} 57{\input{plugins/jackpot.tex}}
60 58
61\opt{lcd_bitmap}{\input{plugins/jewels.tex}} 59\input{plugins/jewels.tex}
62 60
63\opt{lcd_bitmap}{\input{plugins/maze.tex}} 61\input{plugins/maze.tex}
64 62
65\opt{lcd_bitmap}{\input{plugins/mazezam.tex}} 63\input{plugins/mazezam.tex}
66 64
67\opt{lcd_bitmap}{\input{plugins/minesweeper.tex}} 65\input{plugins/minesweeper.tex}
68 66
69\opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2}{\input{plugins/pacbox.tex}}} 67\opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2}{\input{plugins/pacbox.tex}}}
70 68
71\opt{lcd_bitmap}{\input{plugins/pegbox.tex}} 69\input{plugins/pegbox.tex}
72 70
73\opt{lcd_color}{\opt{large_plugin_buffer}{\input{plugins/pixelpainter.tex}}} 71\opt{lcd_color}{\opt{large_plugin_buffer}{\input{plugins/pixelpainter.tex}}}
74 72
75\opt{lcd_bitmap}{\input{plugins/pong.tex}} 73\input{plugins/pong.tex}
76 74
77\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/quake.tex}}} 75\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/quake.tex}}}
78 76
79\opt{lcd_bitmap}{\input{plugins/reversi.tex}} 77\input{plugins/reversi.tex}
80 78
81\opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}} 79\input{plugins/robotfindskitten.tex}
82 80
83{\input{plugins/rockblox.tex}} 81{\input{plugins/rockblox.tex}}
84 82
85\opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}} 83\input{plugins/rockblox1d.tex}
86 84
87\opt{lcd_bitmap}{\input{plugins/sgt-puzzles.tex}} 85\input{plugins/sgt-puzzles.tex}
88 86
89\opt{lcd_bitmap}{\input{plugins/sliding.tex}} 87\input{plugins/sliding.tex}
90 88
91\opt{lcd_bitmap}{\input{plugins/snake.tex}} 89\input{plugins/snake.tex}
92 90
93\opt{lcd_bitmap}{\input{plugins/snake2.tex}} 91\input{plugins/snake2.tex}
94 92
95\opt{lcd_bitmap}{\input{plugins/sokoban.tex}} 93\input{plugins/sokoban.tex}
96 94
97\opt{lcd_bitmap}{\input{plugins/solitaire.tex}} 95\input{plugins/solitaire.tex}
98 96
99\opt{lcd_bitmap}{\input{plugins/spacerocks.tex}} 97\input{plugins/spacerocks.tex}
100 98
101\opt{lcd_bitmap}{\input{plugins/star.tex}} 99\input{plugins/star.tex}
102 100
103\opt{lcd_bitmap}{\input{plugins/sudoku.tex}} 101\input{plugins/sudoku.tex}
104 102
105\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{ 103\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
106 \input{plugins/superdom.tex}}} 104 \input{plugins/superdom.tex}}}
107 105
108\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/wolf3d.tex}}} 106\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/wolf3d.tex}}}
109 107
110\opt{lcd_bitmap}{\input{plugins/wormlet.tex}} 108\input{plugins/wormlet.tex}
111 109
112\opt{lcd_bitmap}{\input{plugins/xobox.tex}} 110\input{plugins/xobox.tex}
113 111
114\opt{lcd_color}{\input{plugins/xworld.tex}} 112\opt{lcd_color}{\input{plugins/xworld.tex}}
115 113
116\section{Demos} 114\section{Demos}
117 115
118\opt{lcd_bitmap}{\input{plugins/bounce.tex}} 116\input{plugins/bounce.tex}
119 117
120{\input{plugins/credits.tex}} 118{\input{plugins/credits.tex}}
121 119
122{\input{plugins/cube.tex}} 120{\input{plugins/cube.tex}}
123 121
124\opt{lcd_bitmap}{\input{plugins/demystify.tex}} 122\input{plugins/demystify.tex}
125 123
126\opt{swcodec}{\input{plugins/fft.tex}} 124\input{plugins/fft.tex}
127 125
128\opt{lcd_bitmap}{\input{plugins/fire.tex}} 126\input{plugins/fire.tex}
129 127
130\opt{lcd_bitmap}{\input{plugins/fractals.tex}} 128\input{plugins/fractals.tex}
131 129
132{\input{plugins/logo.tex}} 130{\input{plugins/logo.tex}}
133 131
134\opt{lcd_bitmap}{\nopt{xduoox3,clip,clipplus}{\input{plugins/matrix.tex}}} 132\nopt{xduoox3,clip,clipplus}{\input{plugins/matrix.tex}}
135 133
136{\input{plugins/mosaic.tex}} 134{\input{plugins/mosaic.tex}}
137 135
138\opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}} 136\input{plugins/oscilloscope.tex}
139 137
140\opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}} 138\opt{tagcache}{\input{plugins/pictureflow.tex}}
141 139
142\opt{lcd_bitmap}{\input{plugins/plasma.tex}} 140\input{plugins/plasma.tex}
143 141
144\opt{lcd_bitmap}{\input{plugins/rocklife.tex}} 142\input{plugins/rocklife.tex}
145 143
146{\input{plugins/snow.tex}} 144{\input{plugins/snow.tex}}
147 145
148\opt{lcd_bitmap}{\input{plugins/starfield.tex}} 146\input{plugins/starfield.tex}
149 147
150\opt{lcd_bitmap}{\input{plugins/vumeter.tex}} 148\input{plugins/vumeter.tex}
151 149
152\section{\label{ref:Viewersplugins}Viewers} 150\section{\label{ref:Viewersplugins}Viewers}
153 151
@@ -168,7 +166,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
168 Frotz & \fname{.z1} to \fname{.z8} & \\ 166 Frotz & \fname{.z1} to \fname{.z8} & \\
169 Image Viewer & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}} & \\ 167 Image Viewer & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}} & \\
170 Lua scripting language& \fname{.lua} & \\ 168 Lua scripting language& \fname{.lua} & \\
171 \opt{swcodec}{\nopt{lowmem}{ 169 \nopt{lowmem}{
172 Midiplay & \fname{.mid, .midi} & \\ 170 Midiplay & \fname{.mid, .midi} & \\
173 Mikmod & \fname{.669, .amf, .asy, .dsm,} & \\ 171 Mikmod & \fname{.669, .amf, .asy, .dsm,} & \\
174 & \fname{.far, .gdm, imf, .it,} & \\ 172 & \fname{.far, .gdm, imf, .it,} & \\
@@ -176,13 +174,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
176 & \fname{.s3m, .stm, .stx, .ult,} & \\ 174 & \fname{.s3m, .stm, .stx, .ult,} & \\
177 & \fname{.uni, .umx, .xm} & \\ 175 & \fname{.uni, .umx, .xm} & \\
178 MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\ 176 MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\
179 }}
180 \opt{swcodec}{
181 MP3 Encoder & \fname{.wav} & x \\
182 } 177 }
183 \opt{lcd_bitmap}{ 178 MP3 Encoder & \fname{.wav} & x \\
184 Rockboy & \fname{.gb, .gbc} & \\ 179 Rockboy & \fname{.gb, .gbc} & \\
185 }
186 Search & \fname{.m3u, .m3u8} & x \\ 180 Search & \fname{.m3u, .m3u8} & x \\
187 Shopping list & \fname{.shopper} & \\ 181 Shopping list & \fname{.shopper} & \\
188 Sort & \fname{.*} & x \\ 182 Sort & \fname{.*} & x \\
@@ -196,31 +190,31 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
196 190
197{\input{plugins/winshortcuts.tex}} 191{\input{plugins/winshortcuts.tex}}
198 192
199\opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}} 193\input{plugins/chip8emulator.tex}
200 194
201\opt{lcd_bitmap}{\input{plugins/frotz.tex}} 195\input{plugins/frotz.tex}
202 196
203\opt{lcd_bitmap}{\input{plugins/imageviewer.tex}} 197\input{plugins/imageviewer.tex}
204 198
205\opt{large_plugin_buffer}{\input{plugins/lua.tex}} 199\opt{large_plugin_buffer}{\input{plugins/lua.tex}}
206 200
207\opt{swcodec}{\nopt{lowmem}{\input{plugins/midiplay.tex}}} 201\nopt{lowmem}{\input{plugins/midiplay.tex}}
208\opt{swcodec}{\nopt{lowmem}{\input{plugins/mikmod.tex}}} 202\nopt{lowmem}{\input{plugins/mikmod.tex}}
209 203
210\opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}} 204\nopt{lowmem}{\input{plugins/mpegplayer.tex}}
211 205
212\opt{swcodec}{\input{plugins/mp3_encoder.tex}} 206\input{plugins/mp3_encoder.tex}
213 207
214\opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD% 208\opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
215 ,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{ 209 ,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{
216 \input{plugins/pdbox.tex}} 210 \input{plugins/pdbox.tex}}
217 211
218\opt{lcd_bitmap}{\nopt{% 212\nopt{%
219 ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented 213 ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented
220 ,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented 214 ,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented
221 ,mrobe100% lcd size/depth not implemented 215 ,mrobe100% lcd size/depth not implemented
222 }{ 216 }{
223 \input{plugins/rockboy.tex}}} 217 \input{plugins/rockboy.tex}}
224 218
225{\input{plugins/search.tex}} 219{\input{plugins/search.tex}}
226 220
@@ -236,7 +230,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
236 230
237{\input{plugins/vbrfix.tex}} 231{\input{plugins/vbrfix.tex}}
238 232
239\opt{lcd_bitmap}{\input{plugins/zxbox.tex}} 233\input{plugins/zxbox.tex}
240 234
241\section{Applications} 235\section{Applications}
242 236
@@ -244,7 +238,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
244 238
245{\input{plugins/batterybenchmark.tex}} 239{\input{plugins/batterybenchmark.tex}}
246 240
247\opt{lcd_bitmap}{\input{plugins/calculator.tex}} 241\input{plugins/calculator.tex}
248 242
249\opt{rtc}{\input{plugins/calendar.tex}} 243\opt{rtc}{\input{plugins/calendar.tex}}
250 244
@@ -260,7 +254,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
260 254
261\opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}} 255\opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
262 256
263\opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}} 257\input{plugins/lrcplayer.tex}
264 258
265{\input{plugins/main_menu_config.tex}} 259{\input{plugins/main_menu_config.tex}}
266 260
@@ -270,9 +264,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
270 264
271{\input{plugins/otp.tex}} 265{\input{plugins/otp.tex}}
272 266
273\opt{lcd_bitmap}{\input{plugins/periodic_table.tex}} 267\input{plugins/periodic_table.tex}
274 268
275\opt{swcodec}{\opt{recording_mic}{\input{plugins/pitch_detector.tex}}} 269\opt{recording_mic}{\input{plugins/pitch_detector.tex}}
276 270
277{\input{plugins/random_folder_advance_config.tex}} 271{\input{plugins/random_folder_advance_config.tex}}
278 272
@@ -284,4 +278,4 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
284 278
285{\input{plugins/stopwatch.tex}} 279{\input{plugins/stopwatch.tex}}
286 280
287\opt{lcd_bitmap}{\input{plugins/text_editor.tex}} 281\input{plugins/text_editor.tex}
diff --git a/manual/plugins/oscilloscope.tex b/manual/plugins/oscilloscope.tex
index 71b359cb32..27fe8e7ac9 100644
--- a/manual/plugins/oscilloscope.tex
+++ b/manual/plugins/oscilloscope.tex
@@ -4,10 +4,8 @@
4 4
5This demo shows the shape of the sound samples that make up the music 5This demo shows the shape of the sound samples that make up the music
6being played. 6being played.
7\opt{swcodec}{ 7At faster speed rates, the \dap\ is less responsive
8 At faster speed rates, the \dap\ is less responsive 8to user input and music may start to skip.
9 to user input and music may start to skip.
10}
11 9
12\subsubsection{Keys} 10\subsubsection{Keys}
13 11
diff --git a/manual/plugins/pictureflow.tex b/manual/plugins/pictureflow.tex
index 1915cc38c9..afab86ef18 100644
--- a/manual/plugins/pictureflow.tex
+++ b/manual/plugins/pictureflow.tex
@@ -1,9 +1,9 @@
1\subsection{PictureFlow} 1\subsection{PictureFlow}
2\screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow} 2\screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow}
3PictureFlow provides a visualisation of your albums with their associated cover 3PictureFlow provides a visualisation of your albums with their associated cover
4art. \opt{swcodec}{It is possible to start playback of the selected 4art. It is possible to start playback of the selected album from PictureFlow.
5album from PictureFlow. Playback will start from the selected track. The 5Playback will start from the selected track. The PictureFlow plugin will
6PictureFlow plugin will continue to run while your tracks are played.} 6continue to run while your tracks are played.
7 7
8\subsubsection{Requirements} 8\subsubsection{Requirements}
9PictureFlow uses both the album art (see \reference{ref:album_art}) and 9PictureFlow uses both the album art (see \reference{ref:album_art}) and
@@ -139,7 +139,7 @@ aware:
139\subsubsection{Main Menu} 139\subsubsection{Main Menu}
140\begin{description} 140\begin{description}
141 \item[Go to WPS.] Leave PictureFlow and enter the while playing screen. 141 \item[Go to WPS.] Leave PictureFlow and enter the while playing screen.
142 \opt{swcodec}{\item[Playback Control.] Control music playback from within the plugin.} 142 \item[Playback Control.] Control music playback from within the plugin.
143 \item[Settings.] Enter the settings menu. 143 \item[Settings.] Enter the settings menu.
144 \item[Return.] Exit menu. 144 \item[Return.] Exit menu.
145 \item[Quit.] Exit PictureFlow plugin. 145 \item[Quit.] Exit PictureFlow plugin.
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex
index fe369d1c90..2e215cca38 100644
--- a/manual/plugins/text_viewer.tex
+++ b/manual/plugins/text_viewer.tex
@@ -197,25 +197,19 @@ by using \emph{Open with} from the \emph{Context Menu}
197 \begin{description} 197 \begin{description}
198 \item[Encoding] Set the codepage in the text viewer. 198 \item[Encoding] Set the codepage in the text viewer.
199 Available settings: 199 Available settings:
200 \setting{ISO-8859-1} (Latin 1). 200 \setting{ISO-8859-1} (Latin 1),
201 \setting{ISO-8859-7} (Greek), 201 \setting{ISO-8859-7} (Greek),
202 \opt{lcd_bitmap}{ 202 \setting{ISO-8859-8} (Hebrew),
203 \setting{ISO-8859-8} (Hebrew),
204 }
205 \setting{CP1251} (Cyrillic), 203 \setting{CP1251} (Cyrillic),
206 \opt{lcd_bitmap}{ 204 \setting{ISO-8859-11} (Thai),
207 \setting{ISO-8859-11} (Thai), 205 \setting{CP1256} (Arabic),
208 \setting{CP1256} (Arabic),
209 }
210 \setting{ISO-8859-9} (Turkish), 206 \setting{ISO-8859-9} (Turkish),
211 \setting{ISO-8859-2} (Latin Extended), 207 \setting{ISO-8859-2} (Latin Extended),
212 \setting{CP1250} (Central European), 208 \setting{CP1250} (Central European),
213 \opt{lcd_bitmap}{ 209 \setting{SJIS} (Japanese),
214 \setting{SJIS} (Japanese), 210 \setting{GB-2312} (Simple Chinese),
215 \setting{GB-2312} (Simple Chinese), 211 \setting{KSX-1001} (Korean),
216 \setting{KSX-1001} (Korean), 212 \setting{BIG5} (Traditional Chinese),
217 \setting{BIG5} (Traditional Chinese),
218 }
219 \setting{UTF-8} (Unicode), 213 \setting{UTF-8} (Unicode),
220 This setting only applies to the plugin and is independent from the 214 This setting only applies to the plugin and is independent from the
221 \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}). 215 \setting{Default Codepage} setting (see \reference{ref:Defaultcodepage}).
@@ -230,9 +224,7 @@ by using \emph{Open with} from the \emph{Context Menu}
230 \item[Join] Join lines together. 224 \item[Join] Join lines together.
231 \item[Expand] Add a blank line at newlines. Useful for making paragraphs 225 \item[Expand] Add a blank line at newlines. Useful for making paragraphs
232 clearer in some book style text files. 226 clearer in some book style text files.
233 \opt{lcd_bitmap}{
234 \item[Reflow Lines] Justify the text. 227 \item[Reflow Lines] Justify the text.
235 }
236 \end{description} 228 \end{description}
237 \item[Screens Per Page] Set the number of screens per page. Available 229 \item[Screens Per Page] Set the number of screens per page. Available
238 options are \setting{1} to \setting{5} screens per page. 230 options are \setting{1} to \setting{5} screens per page.
@@ -242,7 +234,6 @@ by using \emph{Open with} from the \emph{Context Menu}
242 (Useful for displaying right-to-left languages, such as Arabic or Hebrew) 234 (Useful for displaying right-to-left languages, such as Arabic or Hebrew)
243 \item[Left] Set the text alignment to the left. 235 \item[Left] Set the text alignment to the left.
244 \end{description} 236 \end{description}
245 \opt{lcd_bitmap}{
246 \item[Show Header] Select whether to show the header. The header displays the file path. 237 \item[Show Header] Select whether to show the header. The header displays the file path.
247 \begin{description} 238 \begin{description}
248 \item[No] Do not display the header. 239 \item[No] Do not display the header.
@@ -263,7 +254,6 @@ by using \emph{Open with} from the \emph{Context Menu}
263 \item[No] Do not display the status bar. 254 \item[No] Do not display the status bar.
264 \item[Yes] Display the status bar. 255 \item[Yes] Display the status bar.
265 \end{description} 256 \end{description}
266 }
267 \item[Scroll Settings] The scrolling settings submenu. 257 \item[Scroll Settings] The scrolling settings submenu.
268 \begin{description} 258 \begin{description}
269 \item[Horizontal] Submenu for horizontal scrolling settings. 259 \item[Horizontal] Submenu for horizontal scrolling settings.
@@ -299,14 +289,12 @@ by using \emph{Open with} from the \emph{Context Menu}
299 \item[Scroll by Page] Scroll up or down one full screen. 289 \item[Scroll by Page] Scroll up or down one full screen.
300 \item[Scroll by Line] Scroll up or down one line. 290 \item[Scroll by Line] Scroll up or down one line.
301 \end{description} 291 \end{description}
302 \opt{lcd_bitmap}{
303 \item[Overlap Pages] Set whether the last line from the 292 \item[Overlap Pages] Set whether the last line from the
304 previous screen is retained when scrolling pages. 293 previous screen is retained when scrolling pages.
305 \begin{description} 294 \begin{description}
306 \item[No] Do not retain previous line. 295 \item[No] Do not retain previous line.
307 \item[Yes] Retain previous line. 296 \item[Yes] Retain previous line.
308 \end{description} 297 \end{description}
309 }
310 \item[Auto-scroll Speed] Control the speed of auto-scrolling 298 \item[Auto-scroll Speed] Control the speed of auto-scrolling
311 in number of lines per second. Available options are 299 in number of lines per second. Available options are
312 \setting{1} to \setting{10} lines per second. As an example, 300 \setting{1} to \setting{10} lines per second. As an example,
diff --git a/manual/plugins/theme_remove.tex b/manual/plugins/theme_remove.tex
index 1c654d91bb..6c21b11312 100644
--- a/manual/plugins/theme_remove.tex
+++ b/manual/plugins/theme_remove.tex
@@ -3,7 +3,7 @@
3This plugin offers a way to remove a theme. Open the \setting{Context Menu} (see \reference{ref:Contextmenu}) 3This plugin offers a way to remove a theme. Open the \setting{Context Menu} (see \reference{ref:Contextmenu})
4upon a theme\fname{.cfg} file and select \setting{Open With... $\rightarrow$ theme\_remove}. 4upon a theme\fname{.cfg} file and select \setting{Open With... $\rightarrow$ theme\_remove}.
5Some files are not removed regardless of the \setting{Remove Options} such as 5Some files are not removed regardless of the \setting{Remove Options} such as
6\fname{rockbox\_default.wps}\opt{lcd_bitmap}{ and the font file currently in use}. 6\fname{rockbox\_default.wps} and the font file currently in use.
7 7
8\subsubsection{Theme Remove menu} 8\subsubsection{Theme Remove menu}
9\begin{description} 9\begin{description}
@@ -34,18 +34,14 @@ Some files are not removed regardless of the \setting{Remove Options} such as
34 \end{description} 34 \end{description}
35 35
36 \begin{description} 36 \begin{description}
37\opt{lcd_bitmap}{
38 \item[Font.] 37 \item[Font.]
39 Specifies how the \fname{.fnt} file belonging to a theme \fname{.cfg} file is handled. 38 Specifies how the \fname{.fnt} file belonging to a theme \fname{.cfg} file is handled.
40 If this option is set to \setting{Remove if not Used}, the fonts came from rockbox-fonts.zip 39 If this option is set to \setting{Remove if not Used}, the fonts came from rockbox-fonts.zip
41 will not be removed as themes may depend on those fonts. 40 will not be removed as themes may depend on those fonts.
42}%
43 \item[WPS.] 41 \item[WPS.]
44 Specifies how the \fname{.wps} file belonging to a theme \fname{.cfg} file is handled. 42 Specifies how the \fname{.wps} file belonging to a theme \fname{.cfg} file is handled.
45\opt{lcd_bitmap}{
46 \item[Statusbar Skin.] 43 \item[Statusbar Skin.]
47 Specifies how the \fname{.sbs} file belonging to a theme \fname{.cfg} file is handled. 44 Specifies how the \fname{.sbs} file belonging to a theme \fname{.cfg} file is handled.
48}%
49\opt{HAVE_REMOTE_LCD}{ 45\opt{HAVE_REMOTE_LCD}{
50 \item[Remote WPS.] 46 \item[Remote WPS.]
51 Specifies how the \fname{.rwps} file belonging to a theme \fname{.cfg} file is handled. 47 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
56 \item[Backdrop.] 52 \item[Backdrop.]
57 Specifies how the backdrop \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled. 53 Specifies how the backdrop \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
58}% 54}%
59\opt{lcd_bitmap}{
60 \item[Iconset.] 55 \item[Iconset.]
61 Specifies how the iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled. 56 Specifies how the iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
62 \item[Viewers Iconset.] 57 \item[Viewers Iconset.]
63 Specifies how the viewers iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled. 58 Specifies how the viewers iconset \fname{.bmp} file belonging to a theme \fname{.cfg} file is handled.
64}%
65\opt{HAVE_REMOTE_LCD}{ 59\opt{HAVE_REMOTE_LCD}{
66 \item[Remote Iconset.] 60 \item[Remote Iconset.]
67 Specifies how the remote iconset \fname{.bmp} file belonging to 61 Specifies how the remote iconset \fname{.bmp} file belonging to
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index 33dae2f62f..27c6b56e8f 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -749,10 +749,8 @@ The default directory structure that is assumed by some parts of Rockbox
749 your music organized in a way different than they assume when attempting to 749 your music organized in a way different than they assume when attempting to
750 guess the Artist and Album names from your filetree. 750 guess the Artist and Album names from your filetree.
751}% 751}%
752\opt{swcodec}{
753 See \reference{ref:Supportedaudioformats} for a list of supported audio 752 See \reference{ref:Supportedaudioformats} for a list of supported audio
754 formats. 753 formats.
755}
756 754
757\subsection{The first contact} 755\subsection{The first contact}
758 756
@@ -817,13 +815,11 @@ is discussed in more detail in \reference{ref:manage_settings}.
817The Rockbox distribution comes with some themes that should look nice on 815The Rockbox distribution comes with some themes that should look nice on
818your \dap{}. 816your \dap{}.
819 817
820\opt{lcd_bitmap}{
821\note{Some of the themes shipped with Rockbox need additional 818\note{Some of the themes shipped with Rockbox need additional
822fonts from the fonts package, so make sure you installed them. 819fonts from the fonts package, so make sure you installed them.
823Also, if you downloaded additional themes from the Internet make sure you 820Also, if you downloaded additional themes from the Internet make sure you
824have the needed fonts installed as otherwise the theme may not display 821have the needed fonts installed as otherwise the theme may not display
825properly.} 822properly.}
826}
827 823
828 \opt{usb_power}{ 824 \opt{usb_power}{
829 \section{USB Charging} 825 \section{USB Charging}
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex
index 8be9a1bd53..3fae3c5c04 100644
--- a/manual/rockbox_interface/tagcache.tex
+++ b/manual/rockbox_interface/tagcache.tex
@@ -3,9 +3,8 @@
3 3
4\subsection{Introduction} 4\subsection{Introduction}
5This chapter describes the Rockbox music database system. Using the information 5This chapter describes the Rockbox music database system. Using the information
6contained in the tags (ID3v1, ID3v2% 6contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your
7 \opt{swcodec}{, Vorbis Comments, Apev2, etc.}% 7audio files, Rockbox builds and maintains a database of the music
8) in your audio files, Rockbox builds and maintains a database of the music
9files on your player and allows you to browse them by Artist, Album, Genre, 8files on your player and allows you to browse them by Artist, Album, Genre,
10Song Name, etc. The criteria the database uses to sort the songs can be completely 9Song Name, etc. The criteria the database uses to sort the songs can be completely
11 customised. More information on how to achieve this can be found on the Rockbox 10 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.
63 62
64\item[Update Now] 63\item[Update Now]
65 \setting{Update now} causes the database to detect new and deleted files 64 \setting{Update now} causes the database to detect new and deleted files
66 \opt{swcodec}{
67 \note{Unlike the \setting{Auto Update} function, \setting{Update Now} 65 \note{Unlike the \setting{Auto Update} function, \setting{Update Now}
68 will update the database regardless of whether the \setting{Directory Cache} 66 will update the database regardless of whether the \setting{Directory Cache}
69 is enabled. Thus, an update using \setting{Update now} may take a long 67 is enabled. Thus, an update using \setting{Update now} may take a long
70 time. 68 time.
71 }
72 } 69 }
73 Unlike \setting{Initialize Now}, the \setting{Update Now} function 70 Unlike \setting{Initialize Now}, the \setting{Update Now} function
74 does not remove runtime database information. 71 does not remove runtime database information.
diff --git a/manual/rockbox_interface/wps.tex b/manual/rockbox_interface/wps.tex
index 3729590e36..e20ed6737d 100644
--- a/manual/rockbox_interface/wps.tex
+++ b/manual/rockbox_interface/wps.tex
@@ -3,26 +3,24 @@
3The While Playing Screen (WPS) displays various pieces of information about the 3The While Playing Screen (WPS) displays various pieces of information about the
4currently playing audio file. 4currently playing audio file.
5% 5%
6\opt{lcd_bitmap}{% 6The appearance of the WPS can be configured using WPS configuration files.
7 The appearance of the WPS can be configured using WPS configuration files. 7The items shown depend on your configuration -- all items can be turned on
8 The items shown depend on your configuration -- all items can be turned on 8or off independently. Refer to \reference{ref:wps_tags} for details on how
9 or off independently. Refer to \reference{ref:wps_tags} for details on how 9to change the display of the WPS.
10 to change the display of the WPS. 10\begin{itemize}
11 \begin{itemize} 11\item Status bar: The Status bar shows Battery level, charger status,
12 \item Status bar: The Status bar shows Battery level, charger status, 12 volume, play mode, repeat mode, shuffle mode\opt{rtc}{ and clock}.
13 volume, play mode, repeat mode, shuffle mode\opt{rtc}{ and clock}. 13 In contrast to all other items, the status bar is always at the top of
14 In contrast to all other items, the status bar is always at the top of 14 the screen.
15 the screen. 15\item (Scrolling) path and filename of the current song.
16 \item (Scrolling) path and filename of the current song. 16\item The ID3 track name.
17 \item The ID3 track name. 17\item The ID3 album name.
18 \item The ID3 album name. 18\item The ID3 artist name.
19 \item The ID3 artist name. 19\item Bit rate. VBR files display average bitrate and ``(avg)''
20 \item Bit rate. VBR files display average bitrate and ``(avg)'' 20\item Elapsed and total time.
21 \item Elapsed and total time. 21\item A slidebar progress meter representing where in the song you are.
22 \item A slidebar progress meter representing where in the song you are. 22\item Peak meter.
23 \item Peak meter. 23\end{itemize}
24 \end{itemize}
25}
26% 24%
27 25
28See \reference{ref:ConfiguringtheWPS} for details of customising 26See \reference{ref:ConfiguringtheWPS} for details of customising
@@ -138,44 +136,43 @@ your WPS (While Playing Screen).
138 \end{btnmap} 136 \end{btnmap}
139 137
140 138
141\opt{lcd_bitmap}{ 139\subsection{\label{ref:peak_meter}Peak Meter}
142 \subsection{\label{ref:peak_meter}Peak Meter} 140The peak meter can be displayed on the While Playing Screen and consists of
143 The peak meter can be displayed on the While Playing Screen and consists of 141several indicators.
144 several indicators. 142\opt{recording}{
143 For a picture of the peak meter, please see the While
144 Recording Screen in \reference{ref:while_recording_screen}.
145}
146\opt{ipodvideo}{
147 \note{Especially the \playerman{} \playertype{}'s performance and battery runtime
148 suffers when this feature is enabled. For this \dap{} it is highly recommended
149 to not use peak meter.}
150}
151
152\begin{description}
153\item [The bar:]
154 This is the wide horizontal bar. It represents the current volume value.
155\item [The peak indicator:]
156 This is a little vertical line at the right end of the bar. It indicates
157 the peak volume value that occurred recently.
158\item [The clip indicator:]
159 This is a little black block that is displayed at the very right of the
160 scale when an overflow occurs. It usually does not show up during normal
161 playback unless you play an audio file that is distorted heavily.
145 \opt{recording}{ 162 \opt{recording}{
146 For a picture of the peak meter, please see the While 163 If you encounter clipping while recording, your recording will sound distorted.
147 Recording Screen in \reference{ref:while_recording_screen}. 164 You should lower the gain.
148 }
149 \opt{ipodvideo}{
150 \note{Especially the \playerman{} \playertype{}'s performance and battery runtime
151 suffers when this feature is enabled. For this \dap{} it is highly recommended
152 to not use peak meter.}
153 } 165 }
166 \note{Note that the clip detection is not very precise.
167 Clipping might occur without being indicated.}
168\item [The scale:]
169 Between the indicators of the right and left channel there are little dots.
170 These dots represent important volume values. In linear mode each dot is a
171 10\% mark. In dBFS mode the dots represent the following values (from right
172 to left): 0~dB, {}-3~dB, {}-6~dB, {}-9~dB, {}-12~dB, {}-18~dB, {}-24~dB, {}-30~dB,
173 {}-40~dB, {}-50~dB, {}-60~dB.
174\end{description}
154 175
155 \begin{description}
156 \item [The bar:]
157 This is the wide horizontal bar. It represents the current volume value.
158 \item [The peak indicator:]
159 This is a little vertical line at the right end of the bar. It indicates
160 the peak volume value that occurred recently.
161 \item [The clip indicator:]
162 This is a little black block that is displayed at the very right of the
163 scale when an overflow occurs. It usually does not show up during normal
164 playback unless you play an audio file that is distorted heavily.
165 \opt{recording}{
166 If you encounter clipping while recording, your recording will sound distorted.
167 You should lower the gain.
168 }
169 \note{Note that the clip detection is not very precise.
170 Clipping might occur without being indicated.}
171 \item [The scale:]
172 Between the indicators of the right and left channel there are little dots.
173 These dots represent important volume values. In linear mode each dot is a
174 10\% mark. In dBFS mode the dots represent the following values (from right
175 to left): 0~dB, {}-3~dB, {}-6~dB, {}-9~dB, {}-12~dB, {}-18~dB, {}-24~dB, {}-30~dB,
176 {}-40~dB, {}-50~dB, {}-60~dB.
177 \end{description}
178}
179\subsection{\label{sec:contextmenu}The WPS Context Menu} 176\subsection{\label{sec:contextmenu}The WPS Context Menu}
180Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu} 177Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu}
181allows you quick access to some often used functions. 178allows you quick access to some often used functions.
@@ -267,7 +264,6 @@ This may even be the whole track.
267 The rate can be changed in two modes: procentual and semitone. 264 The rate can be changed in two modes: procentual and semitone.
268 Initially, procentual mode is active. 265 Initially, procentual mode is active.
269 266
270 \opt{swcodec}{
271 If you've enabled the \setting{Timestretch} option in 267 If you've enabled the \setting{Timestretch} option in
272 \setting{Sound Settings} and have since rebooted, you can also use 268 \setting{Sound Settings} and have since rebooted, you can also use
273 timestretch mode. This allows you to change the playback speed 269 timestretch mode. This allows you to change the playback speed
@@ -278,73 +274,43 @@ This may even be the whole track.
278 limitations of the algorithm, speed is limited to be between 35\% 274 limitations of the algorithm, speed is limited to be between 35\%
279 and 250\% of the current pitch value. Pitch must maintain the 275 and 250\% of the current pitch value. Pitch must maintain the
280 same ratio as well as remain between 50\% and 200\%. 276 same ratio as well as remain between 50\% and 200\%.
281 }
282 277
283 The value of the \opt{swcodec}{rate, pitch and speed}\nopt{swcodec}{rate} 278 The value of the rate, pitch and speed
284 is not persistent, i.e. after the \dap\ is turned on it will 279 is not persistent, i.e. after the \dap\ is turned on it will
285 always be set to 100\%. \opt{swcodec}{ However, the rate, pitch and speed 280 always be set to 100\%. However, the rate, pitch and speed
286 information will be stored in any bookmarks you may create 281 information will be stored in any bookmarks you may create
287 (see \reference{ref:Bookmarkconfigactual}) and will be restored upon 282 (see \reference{ref:Bookmarkconfigactual}) and will be restored upon
288 playing back those bookmarks.} 283 playing back those bookmarks.
289
290 \nopt{swcodec}{
291 \begin{btnmap}
292 \ActionPsToggleMode
293 & Toggle pitch changing mode. \\
294 %
295 \ActionPsIncSmall{} / \ActionPsDecSmall
296 & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or by 0.1
297 semitone (in semitone mode).\\
298 %
299 \ActionPsIncBig{} / \ActionPsDecBig
300 & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
301 (in semitone mode).\\
302 %
303 \ActionPsNudgeLeft{} / \ActionPsNudgeRight
304 & Temporarily change pitch by 2\% (beatmatch). \\
305 %
306 \ActionPsReset
307 & Reset rate to 100\%. \\
308 %
309 \ActionPsExit
310 & Leave the \setting{Pitch Screen}. \\
311 %
312 \end{btnmap}
313
314 \warn{Changing the pitch can cause audible `Artifacts' or `Dropouts'.}
315 }
316 284
317 \opt{swcodec}{ 285 \begin{btnmap}
318 \begin{btnmap} 286 \ActionPsToggleMode
319 \ActionPsToggleMode 287 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsToggleMode}
320 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsToggleMode} 288 & Toggle pitch changing mode (cycle through all available modes).\\
321 & Toggle pitch changing mode (cycle through all available modes).\\ 289 %
322 % 290 \ActionPsIncSmall{} / \ActionPsDecSmall
323 \ActionPsIncSmall{} / \ActionPsDecSmall 291 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncSmall{} / \ActionRCPsDecSmall}
324 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncSmall{} / \ActionRCPsDecSmall} 292 & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or 0.1
325 & Increase~/ Decrease pitch by 0.1\% (in procentual mode) or 0.1 293 semitone (in semitone mode).\\
326 semitone (in semitone mode).\\ 294 %
327 % 295 \nopt{PBELL_VIBE500_PAD}{ % there is no long scroll up or down because of slide
328 \nopt{PBELL_VIBE500_PAD}{ % there is no long scroll up or down because of slide 296 \ActionPsIncBig{} / \ActionPsDecBig
329 \ActionPsIncBig{} / \ActionPsDecBig 297 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncBig{} / \ActionRCPsDecBig}
330 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsIncBig{} / \ActionRCPsDecBig} 298 & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone
331 & Increase~/ Decrease pitch by 1\% (in procentual mode) or a semitone 299 (in semitone mode).\\
332 (in semitone mode).\\ 300 }
333 } 301 %
334 % 302 \ActionPsNudgeLeft{} / \ActionPsNudgeRight
335 \ActionPsNudgeLeft{} / \ActionPsNudgeRight 303 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsNudgeLeft{} / \ActionRCPsNudgeRight}
336 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsNudgeLeft{} / \ActionRCPsNudgeRight} 304 & Temporarily change pitch by 2\% (beatmatch), or modify speed (in timestretch mode).\\
337 & Temporarily change pitch by 2\% (beatmatch), or modify speed (in timestretch mode).\\ 305 %
338 % 306 \ActionPsReset
339 \ActionPsReset 307 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsReset}
340 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsReset} 308 & Reset pitch and speed to 100\%. \\
341 & Reset pitch and speed to 100\%. \\ 309 %
342 % 310 \ActionPsExit
343 \ActionPsExit 311 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsExit}
344 \opt{HAVEREMOTEKEYMAP}{& \ActionRCPsExit} 312 & Leave the \setting{Pitch Screen}. \\
345 & Leave the \setting{Pitch Screen}. \\ 313 %
346 % 314 \end{btnmap}
347 \end{btnmap}
348 }
349 315
350} 316}