blob: 9a083e235e5512398967c88fa98615a2ed89c6a9 [file] [log] [blame]
Nils Wallméniuscb527ca2006-09-10 10:17:47 +00001% $Id$ %
Martin Arver8e8207f2006-02-11 00:57:17 +00002\chapter{Advanced Topics}
Martin Arver35dcf902006-03-08 17:58:11 +00003
Marc Guay85eec852008-06-24 05:16:23 +00004\section{\label{ref:CustomisingUI}Customising the User Interface}
Nils Wallménius12eb0582008-03-23 22:07:09 +00005\opt{lcd_bitmap}{
Marianne Arnoldaf78b5f2008-07-06 16:10:28 +00006\subsection{\label{ref:GettingExtras}Getting Extras}
7
Martin Arver7bdd03a2006-08-27 15:00:50 +00008Rockbox supports custom fonts. A collection of fonts is available for download
Marianne Arnoldaf78b5f2008-07-06 16:10:28 +00009in the font package at \url{http://www.rockbox.org/daily.shtml}.}
Martin Arver8e8207f2006-02-11 00:57:17 +000010
Nils Wallménius12eb0582008-03-23 22:07:09 +000011\opt{lcd_bitmap}{
Dominik Riebeling85deab12006-11-20 19:56:55 +000012 \subsection{\label{ref:Loadingfonts}Loading Fonts}\index{Fonts}
Nils Wallméniuscb527ca2006-09-10 10:17:47 +000013 Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the
14 \dap{} and ``play'' it in the \setting{File Browser}. If you want a font to
15 be loaded automatically every time you start up, it must be located in the
Marianne Arnoldb2f7c612007-12-14 02:03:58 +000016 \fname{/.rockbox/fonts} directory and the filename must be at most 24 characters
Nils Wallméniuscb527ca2006-09-10 10:17:47 +000017 long. You can browse the fonts in \fname{/.rockbox/fonts} under
Jonas Häggqvist4b831752009-06-22 17:37:36 +000018 \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font}
Alex Parker51743412009-08-25 21:51:55 +000019 in the \setting{Main Menu}.\\
20
Alexander Levind9306412010-05-18 20:45:32 +000021 \note{Advanced Users Only: Any BDF font should
Nils Wallméniuscb527ca2006-09-10 10:17:47 +000022 be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use
23 the \fname{convbdf} tool. This tool can be found in the \fname{tools}
Alexander Levind9306412010-05-18 20:45:32 +000024 directory of the Rockbox source code. See \wikilink{CreateFonts\#ConvBdf}
25 for more details.}
Dominik Riebelingebb8a222006-04-04 17:48:10 +000026}
Martin Arver8e8207f2006-02-11 00:57:17 +000027
28\subsection{\label{ref:Loadinglanguages}Loading Languages}
Dominik Riebeling85deab12006-11-20 19:56:55 +000029\index{Language files}%
Martin Arver47ea9062006-06-07 12:15:46 +000030Rockbox can load language files at runtime. Simply copy the \fname{.lng} file
Dominik Riebelingb7eef892006-04-10 21:47:09 +000031\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
Nils Wallménius15c5d262007-03-15 02:09:15 +000032Rockbox directory browser or select \setting{Settings $\rightarrow$
Alex Parker51743412009-08-25 21:51:55 +000033General Settings $\rightarrow$ Language }from the \setting{Main Menu}.\\
Martin Arver8e8207f2006-02-11 00:57:17 +000034
Dominik Riebelingb7eef892006-04-10 21:47:09 +000035\note{If you want a language to be loaded automatically every time you start
Marianne Arnoldb2f7c612007-12-14 02:03:58 +000036up, it must be located in the \fname{/.rockbox/langs} directory and the filename
Alex Parker51743412009-08-25 21:51:55 +000037must be a maximum of 24 characters long.\\}
Martin Arver8e8207f2006-02-11 00:57:17 +000038
Dominik Riebelingebb8a222006-04-04 17:48:10 +000039If your language is not yet supported and you want to write your own language
40file find the instructions on the Rockbox website:
Dominik Riebelingb394e182006-12-29 19:22:56 +000041\wikilink{LangFiles}
Martin Arver8e8207f2006-02-11 00:57:17 +000042
Nils Wallménius12eb0582008-03-23 22:07:09 +000043\opt{lcd_color}{
Alexander Levin71812ca2009-03-20 19:33:20 +000044 \subsection{\label{ref:ChangingFiletypeColours}Changing Filetype Colours}
Alex Parker6c4661c2009-03-18 14:24:28 +000045 Rockbox has the capability to modify the \setting{File Browser} to show
Alexander Levin71812ca2009-03-20 19:33:20 +000046 files of different types in different colours, depending on the file extension.
Alex Parker6c4661c2009-03-18 14:24:28 +000047
Alexander Levin71812ca2009-03-20 19:33:20 +000048 \subsubsection{Set-up}
Alexander Levin277ce9a2009-03-21 09:25:49 +000049 There are two steps to changing the filetype colours -- creating
Alexander Levin71812ca2009-03-20 19:33:20 +000050 a file with the extension \fname{.colours} and then activating it using
51 a config file. The \fname{.colours} files \emph{must} be stored in
52 the \fname{/.rockbox/themes/} directory.
53 The \fname{.colours} file is just a text file, and can be edited with
54 your text editor of choice.
Alex Parker6c4661c2009-03-18 14:24:28 +000055
Alexander Levin71812ca2009-03-20 19:33:20 +000056 \subsubsection{Creating the .colours file}
57 The \fname{.colours} file consists of the file extension
58 (or \fname{folder}) followed by a colon and then the colour desired
59 as an RGB value in hexadecimal, as in the following example:\\*
60 \\
61 \config{folder:808080}\\
62 \config{mp3:00FF00}\\
63 \config{ogg:00FF00}\\
64 \config{txt:FF0000}\\
65 \config{???:FFFFFF}\\*
Alex Parker6c4661c2009-03-18 14:24:28 +000066
Alexander Levin71812ca2009-03-20 19:33:20 +000067 The permissible extensions are as follows:\\*
68 \\
69 \config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa,
70 \firmwareextension{}, %
71 \opt{swcodec}{mp1, }mp2, mp3%
72 \opt{swcodec}{, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc,
73 wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe,
74 spc, ape, mac, sap}%
75 \opt{lcd_bitmap}{\opt{swcodec}{, mpg, mpeg}}%
76 \opt{HAVE_REMOTE_LCD}{, rwps}%
77 \opt{lcd_non-mono}{, bmp}%
78 \opt{radio}{, fmr}%
79 \opt{lcd_bitmap}{, fnt, kbd}}\\*
80 %It'd be ideal to get these from filetypes.c
Alex Parker6c4661c2009-03-18 14:24:28 +000081
Alexander Levin71812ca2009-03-20 19:33:20 +000082 All file extensions that are not either specifically listed in the
83 \fname{.colours} files or are not in the list above will be
84 set to the colour given by \config{???}. Extensions that
85 are in the above list but not in the \fname{.colours}
86 file will be set to the foreground colour as normal.
Alex Parker6c4661c2009-03-18 14:24:28 +000087
Alexander Levin71812ca2009-03-20 19:33:20 +000088 \subsubsection{Activating}
89 To activate the filetype colours, the \fname{.colours} file needs to be
90 invoked from a \fname{.cfg} configuration file. The easiest way to do
91 this is to create a new text file containing the following single
92 line:\\*
93 \\
94 \config{filetype colours: /.rockbox/themes/filename.colours}\\*
Alex Parker6c4661c2009-03-18 14:24:28 +000095
Alexander Levin71812ca2009-03-20 19:33:20 +000096 where filename is replaced by the filename you used when creating the
97 \fname{.colours} file. Save this file as e.g. \fname{colours.cfg} in the
98 \fname{/.rockbox/themes} directory and then activate the config file
99 from the menu as normal
100 (\setting{Settings} $\rightarrow$ \setting{Theme Settings}%
Jonas Häggqvist4b831752009-06-22 17:37:36 +0000101 $\rightarrow$ \setting{Browse Theme Files}).
Alex Parker6c4661c2009-03-18 14:24:28 +0000102
Alexander Levin71812ca2009-03-20 19:33:20 +0000103 \subsubsection{Editing}
104 The built-in \setting{Text Editor} (see \reference{sec:text_editor})
105 automatically understands the
106 \fname{.colours} file format, but an external text editor can
107 also be used. To edit the \fname{.colours} file using Rockbox,
108 ``play'' it in the \setting{File Browser}. The file will open in
109 the \setting{Text Editor}. Upon selecting a line, the following choices
110 will appear:\\*
111 \\
112 \config{Extension}\\
113 \config{Colour}\\*
114
115 If \config{Extension} is selected, the \setting{virtual keyboard}
116 (see \reference{sec:virtual_keyboard}) appears,
117 allowing the file extension to be modified. If \config{Colour}
118 is selected, the colour selector screen appears. Choose the desired
119 colour, then save the \fname{.colours} file using the standard
120 \setting{Text Editor} controls.
Nils Wallménius15c5d262007-03-15 02:09:15 +0000121}
122
Marianne Arnold81892462008-07-15 20:57:05 +0000123\opt{lcd_non-mono}{%
Nils Wallméniusda555882006-11-13 15:14:28 +0000124 \subsection{\label{ref:LoadingBackdrops}Loading Backdrops}
125 Rockbox supports showing an image as a backdrop in the \setting{File Browser}
126 and the menus. The backdrop image must be a \fname{.bmp} file of the exact
127 same dimensions as the display in your \dap{} (\genericimg{} with the last
128 number giving the colour depth in bits). To use an image as a backdrop browse
Marianne Arnold90bcefa2008-03-03 23:01:44 +0000129 to it in the \setting{File Browser} and open the \setting{Context Menu}
130 (see \reference{ref:Contextmenu}) on it and select the option
Nils Wallméniusda555882006-11-13 15:14:28 +0000131 \setting{Set As Backdrop}. If you want rockbox to remember your
132 backdrop the next time you start your \dap{} the backdrop must be placed in
Marianne Arnoldb2f7c612007-12-14 02:03:58 +0000133 the \fname{/.rockbox/backdrops} directory.
Nils Wallméniusda555882006-11-13 15:14:28 +0000134}%
135
Alex Parkerab563da2009-09-20 16:48:45 +0000136\nopt{lcd_charcell}{
137 \subsection{UI Viewport}
138 By default, the UI is drawn on the whole screen. This can be changed so that
139 the UI is confined to a specific area of the screen, by use of a UI
140 viewport. This is done by adding the following line to the
141 \fname{.cfg} file for a theme:\\*
142
143 \nopt{lcd_non-mono}{\config{ui viewport: X,Y,[width],[height],[font]}}
144 \nopt{lcd_color}{\opt{lcd_non-mono}{
145 \config{ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
146 \opt{lcd_color}{
147 \config{ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
148 \\*
149
150 \opt{HAVE_REMOTE_LCD}{
151 The dimensions of the menu that is displayed on the remote control of your
152 \dap\ can be set in the same way. The line to be added to the theme
153 \fname{.cfg} is the following:\\*
154
155 \nopt{lcd_non-mono}{\config{remote ui viewport: X,Y,[width],[height],[font]}}
156 \nopt{lcd_color}{\opt{lcd_non-mono}{
157 \config{remote ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
158 \opt{lcd_color}{
159 \config{remote ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
160 \\*
161 }
162
163 Only the first two parameters \emph{have} to be specified, the others can
Alexander Levinb57fe482009-12-23 20:05:29 +0000164 be omitted using `-' as a placeholder. The syntax is very similar to WPS
Alex Parkerab563da2009-09-20 16:48:45 +0000165 viewports (see \reference{ref:Viewports}). Briefly:
166
167 \nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-uivp-syntax.tex}}
168 \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-uivp-syntax.tex}}}
169 \opt{lcd_color}{\input{advanced_topics/viewports/colour-uivp-syntax.tex}}
170}
171
Alex Parker40782d52010-05-13 08:13:31 +0000172\section{\label{ref:ConfiguringtheWPS}Configuring the Theme}
Martin Arver8e8207f2006-02-11 00:57:17 +0000173
Alex Parker40782d52010-05-13 08:13:31 +0000174\subsection{Themeing -- General Info}
Martin Arver8e8207f2006-02-11 00:57:17 +0000175
Alex Parker40782d52010-05-13 08:13:31 +0000176 There are various different aspects of the Rockbox interface
177 that can be themed -- the WPS or \setting{While Playing Screen}, the FMS or
178 \setting{FM Screen} (if the \dap{} has a tuner), and the SBS or
Jonathan Gordon32382932010-05-16 11:20:42 +0000179 \setting{Base Skin}. The WPS is the name used to
Alex Parker40782d52010-05-13 08:13:31 +0000180 describe the information displayed on the \daps{} screen whilst an audio
181 track is being played, the FMS is the screen shown while listening to the
Jonathan Gordon32382932010-05-16 11:20:42 +0000182 radio, and the SBS lets you specify a base skin that is shown in the
Alex Parker40782d52010-05-13 08:13:31 +0000183 menus and browsers, as well as the WPS and FMS. The SBS also allows you to
184 control certain aspects of the appearance of the menus/browsers.
185 There are a number of themes included in Rockbox, and
Nils Wallménius01bd7362009-02-04 14:22:35 +0000186 you can load one of these at any time by selecting it in
Alex Parker40782d52010-05-13 08:13:31 +0000187 \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Browse Theme Files}.
188 It is also possible to set individual items of a theme from within the
189 \setting{Settings $\rightarrow$ Theme Settings} menu.
Martin Arver8e8207f2006-02-11 00:57:17 +0000190
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000191
Alex Parker40782d52010-05-13 08:13:31 +0000192\subsection{\label{ref:CreateYourOwnWPS}Themes -- Create Your Own}
193The theme files are simple text files, and can be created (or edited) in your
194favourite text editor. To make sure non-English characters
Martin Arver47ea9062006-06-07 12:15:46 +0000195display correctly in your WPS you must save the .wps file with UTF-8 character
196encoding. This can be done in most editors, for example Notepad in Windows 2000
Alex Parker40782d52010-05-13 08:13:31 +0000197or XP (but not in 9x/ME) can do this.
198
199\begin{description}
200\item [Files Locations: ] Each different ``themeable'' aspect requires its own file --
201 WPS files have the extension \fname{.wps}, FM screen files have the extension
202 \fname{.fms}, and SBS files have the extension \fname{.sbs}. The main theme
203 file has the extension \fname{.cfg}. All files should have the same name.
204
205 The theme \fname{.cfg} file should be placed in the \fname{/.rockbox/themes}
206 directory, while the \fname{.wps}, \fname{.fms} and \fname{.sbs} files should
207 be placed in the \fname{/.rockbox/wps} directory. Any images used by the
208 theme should be placed in a subdirectory of \fname{/.rockbox/wps} with the
209 same name as the theme, e.g. if the theme files are named
210 \fname{mytheme.wps, mytheme.sbs} etc., then the images should be placed in
211 \fname{/.rockbox/wps/mytheme}.
212\end{description}
213
214All full list of the available tags are given in appendix
215\reference{ref:wps_tags}; some of the more powerful concepts in theme designe
216are discussed below.
Martin Arver8e8207f2006-02-11 00:57:17 +0000217
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000218\begin{itemize}
Martin Arver09c39612006-08-18 16:57:56 +0000219\item All characters not preceded by \% are displayed as typed.
220\item Lines beginning with \# are comments and will be ignored.
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000221\end{itemize}
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000222
Dominik Riebeling5ec38052006-08-28 18:09:17 +0000223\note{Keep in mind that your \dap{} resolution is \genericimg{} (with
224 the last number giving the colour depth in bits) when
225 designing your own WPS, or if you use a WPS designed for another target.
226 \opt{HAVE_REMOTE_LCD}{The resolution of the remote is
Nils Wallménius01bd7362009-02-04 14:22:35 +0000227 \opt{h100,h300}{128x64x1}\opt{x5,m5}{128x96x2} pixels.}}
Martin Arver6fc30d62006-08-28 17:44:49 +0000228
Alex Parkerab563da2009-09-20 16:48:45 +0000229\nopt{lcd_charcell}{
230\subsubsection{\label{ref:Viewports}Viewports}
231
232By default, a viewport filling the whole screen contains all the elements
Alexander Levin64bb9a02010-05-18 20:23:22 +0000233defined in the \fname{.wps} file. The
Alex Parkerab563da2009-09-20 16:48:45 +0000234\opt{lcd_non-mono}{elements in this viewport are displayed
Alexander Levin64bb9a02010-05-18 20:23:22 +0000235 with the same background/\linebreak{}foreground
Alex Parkerab563da2009-09-20 16:48:45 +0000236 \opt{lcd_color}{colours}\nopt{lcd_color}{shades} and the}
237text is rendered in the
238same font as in the main menu. To change this behaviour a custom viewport can
239be defined. A viewport is a rectangular window on the screen%
240\opt{lcd_non-mono}{ with its own foreground/background
241\opt{lcd_color}{colours}\nopt{lcd_color}{shades}}.
242This window also has variable dimensions. To
243define a viewport a line starting \config{{\%V{\textbar}\dots}} has to be
244present in the \fname{.wps} file. The full syntax will be explained later in
245this section. All elements placed before the
246line defining a viewport are displayed in the default viewport. Elements
247defined after a viewport declaration are drawn within that viewport.
248\opt{lcd_bitmap}{Loading images (see Appendix \reference{ref:wps_images})
249 should be done within the default viewport.}
250A viewport ends either with the end of the file, or with the next viewport
251declaration line. Viewports sharing the same
252coordinates and dimensions cannot be displayed at the same time. Viewports
253cannot be layered \emph{transparently} over one another. Subsequent viewports
254will be drawn over any other viewports already drawn onto that
255area of the screen.
256
257\nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-vp-syntax.tex}}
258\nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}}
259\opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}}
260
261
262\subsubsection{Conditional Viewports}
263
264Any viewport can be displayed either permanently or conditionally.
265Defining a viewport as \config{{\%V{\textbar}\dots}}
266will display it permanently.
267
268\begin{itemize}
269\item {\config{\%Vl{\textbar}'identifier'{\textbar}\dots{\textbar}}}
Alexander Levine0bb22182010-05-12 22:07:49 +0000270This tag preloads a viewport for later display. `identifier' is a single
Alex Parkerab563da2009-09-20 16:48:45 +0000271lowercase letter (a-z) and the '\dots' parameters use the same logic as
272the \config{\%V} tag explained above.
273\item {\config{\%Vd'identifier'}} Display the 'identifier' viewport.
274\end{itemize}
275
276Viewports can share identifiers so that you can display multiple viewports
277with one \%Vd line.
278
279\nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-conditional.tex}}
280\nopt{lcd_color}{%
281 \opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-conditional.tex}}}
282\opt{lcd_color}{\input{advanced_topics/viewports/colour-conditional.tex}}
283\\*
284
285\note{The tag to display conditional viewports must come before the tag to
286preload the viewport in the \fname{.wps} file.}
Alex Parker6d549df2010-05-13 08:13:37 +0000287
288\subsection{Info Viewport (SBS only)}
289As mentioned above, it is possible to set a UI viewport via the theme
290\fname{.cfg} file. It is also possible to set the UI viewport through the SBS
291file, and to conditionally select different UI viewports.
292
293 \begin{itemize}
294 \item {\config{\%Vi{\textbar}'label'{\textbar}\dots{\textbar}}}
295 This viewport is used as Custom UI Viewport in the case that the theme
296 doesn't have a ui viewport set in the theme \fname{.cfg} file. Having this
297 is strongly recommended since it makes you able to use the SBS
298 with other themes. If label is set this viewport can be selectivly used as the
299 Info Viewport using the \%VI tag. The '\dots' parameters use the same logic as
300 the \config{\%V} tag explained above.
301
302 \item {\config{\%VI'label'}} Set the Info Viewport to use the viewport called
303 label, as declared with the previous tag.
304 \end{itemize}
Alex Parkerab563da2009-09-20 16:48:45 +0000305}
306
Martin Arvera245e882006-03-08 15:04:36 +0000307\subsubsection{Conditional Tags}
Martin Arverd3d3e342006-03-15 10:56:14 +0000308
Martin Arver47ea9062006-06-07 12:15:46 +0000309\begin{description}
310\item[If/else: ]
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000311Syntax: \config{\%?xx{\textless}true{\textbar}false{\textgreater}}
Martin Arver8e8207f2006-02-11 00:57:17 +0000312
Martin Arver68e40172006-06-07 16:37:04 +0000313If the tag specified by ``\config{xx}'' has a value, the text between the
314``\config{{\textless}}'' and the ``\config{{\textbar}}'' is displayed (the true
315part), else the text between the ``\config{{\textbar}}'' and the
316``\config{{\textgreater}}'' is displayed (the false part).
317The else part is optional, so the ``\config{{\textbar}}'' does not have to be
318specified if no else part is desired. The conditionals nest, so the text in the
319if and else part can contain all \config{\%} commands, including conditionals.
Martin Arverd3d3e342006-03-15 10:56:14 +0000320
Martin Arver47ea9062006-06-07 12:15:46 +0000321\item[Enumerations: ]
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000322Syntax: \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}}
Martin Arver8e8207f2006-02-11 00:57:17 +0000323
Martin Arver68e40172006-06-07 16:37:04 +0000324For tags with multiple values, like Play status, the conditional can hold a
325list of alternatives, one for each value the tag can have.
Martin Arver68e40172006-06-07 16:37:04 +0000326Example enumeration:
327\begin{example}
Martin Arver06424512006-10-25 22:12:25 +0000328 \%?mp{\textless}Stop{\textbar}\%Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}
Martin Arver68e40172006-06-07 16:37:04 +0000329\end{example}
Martin Arver8e8207f2006-02-11 00:57:17 +0000330
Martin Arver68e40172006-06-07 16:37:04 +0000331The last else part is optional, and will be displayed if the tag has no value.
332The WPS parser will always display the last part if the tag has no value, or if
333the list of alternatives is too short.
Martin Arver47ea9062006-06-07 12:15:46 +0000334\end{description}
Martin Arver8e8207f2006-02-11 00:57:17 +0000335
Marc Guay85eec852008-06-24 05:16:23 +0000336\subsubsection{Next Song Info}
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000337You can display information about the next song -- the song that is
Martin Arver8e8207f2006-02-11 00:57:17 +0000338about to play after the one currently playing (unless you change the
Martin Arvera245e882006-03-08 15:04:36 +0000339plan).
Martin Arver8e8207f2006-02-11 00:57:17 +0000340
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000341If you use the upper-case versions of the
Martin Arver68e40172006-06-07 16:37:04 +0000342three tags: \config{F}, \config{I} and \config{D}, they will instead refer to
343the next song instead of the current one. Example: \config{\%Ig} is the genre
Alex Parker51743412009-08-25 21:51:55 +0000344name used in the next song and \config{\%Ff} is the mp3 frequency.\\
Martin Arver8e8207f2006-02-11 00:57:17 +0000345
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000346\note{The next song information \emph{will not} be available at all
Martin Arver09c39612006-08-18 16:57:56 +0000347 times, but will most likely be available at the end of a song. We
348 suggest you use the conditional display tag a lot when displaying
349 information about the next song!}
Martin Arvera245e882006-03-08 15:04:36 +0000350
Alex Parkere56030a2009-05-15 21:17:21 +0000351\subsubsection{\label{ref:AlternatingSublines}Alternating Sublines}
Martin Arver8e8207f2006-02-11 00:57:17 +0000352
Martin Arver68e40172006-06-07 16:37:04 +0000353It is possible to group items on each line into 2 or more groups or
354``sublines''. Each subline will be displayed in succession on the line for a
355specified time, alternating continuously through each defined subline.
Martin Arver8e8207f2006-02-11 00:57:17 +0000356
357Items on a line are broken into sublines with the semicolon
Martin Arver68e40172006-06-07 16:37:04 +0000358'\config{;}' character. The display time for
Martin Arver8e8207f2006-02-11 00:57:17 +0000359each subline defaults to 2 seconds unless modified by using the
Martin Arver68e40172006-06-07 16:37:04 +0000360'\config{\%t}' tag to specify an alternate
Martin Arver8e8207f2006-02-11 00:57:17 +0000361time (in seconds and optional tenths of a second) for the subline to be
362displayed.
363
364Subline related special characters and tags:
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000365\begin{description}
366\item[;] Split items on a line into separate sublines
367\item[\%t] Set the subline display time. The
Martin Arver68e40172006-06-07 16:37:04 +0000368'\config{\%t}' is followed by either integer
369seconds (\config{\%t5}), or seconds and tenths of a second (\config{\%t3.5}).
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000370\end{description}
Martin Arver8e8207f2006-02-11 00:57:17 +0000371
372Each alternating subline can still be optionally scrolled while it is
373being displayed, and scrollable formats can be displayed on the same
374line with non{}-scrollable formats (such as track elapsed time) as long
Martin Arvera245e882006-03-08 15:04:36 +0000375as they are separated into different sublines.
Martin Arvera245e882006-03-08 15:04:36 +0000376Example subline definition:
Martin Arver47ea9062006-06-07 12:15:46 +0000377\begin{example}
Martin Arver49cdd5e2006-06-07 13:29:52 +0000378 %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds,
379 Display id3 title for 2 seconds,
380 Display current and remaining track time
381 for 3 seconds,
382 repeat...
Martin Arver47ea9062006-06-07 12:15:46 +0000383\end{example}
Martin Arver8e8207f2006-02-11 00:57:17 +0000384
Martin Arver68e40172006-06-07 16:37:04 +0000385Conditionals can be used with sublines to display a different set and/or number
386of sublines on the line depending on the evaluation of the conditional.
Martin Arvera245e882006-03-08 15:04:36 +0000387Example subline with conditionals:
Martin Arver47ea9062006-06-07 12:15:46 +0000388\begin{example}
Martin Arver49cdd5e2006-06-07 13:29:52 +0000389 %?it{\textless}%t8%s%it{\textbar}%s%fn{\textgreater};%?ia{\textless}%t3%s%ia{\textbar}%t0{\textgreater}\\
Martin Arver47ea9062006-06-07 12:15:46 +0000390\end{example}
Martin Arver8e8207f2006-02-11 00:57:17 +0000391
Martin Arver68e40172006-06-07 16:37:04 +0000392The format above will do two different things depending if ID3 tags are
393present. If the ID3 artist and title are present:
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000394\begin{itemize}
395\item Display id3 title for 8 seconds,
396\item Display id3 artist for 3 seconds,
397\item repeat\dots
398\end{itemize}
399If the ID3 artist and title are not present:
400\begin{itemize}
401\item Display the filename continuously.
402\end{itemize}
Dominik Riebelingebb8a222006-04-04 17:48:10 +0000403Note that by using a subline display time of 0 in one branch of a conditional,
404a subline can be skipped (not displayed) when that condition is met.
Martin Arvera245e882006-03-08 15:04:36 +0000405
Martin Arvera245e882006-03-08 15:04:36 +0000406\subsubsection{Using Images}
Dominik Riebelingb7eef892006-04-10 21:47:09 +0000407You can have as many as 52 images in your WPS. There are various ways of
Dominik Riebelingebb8a222006-04-04 17:48:10 +0000408displaying images:
Martin Arvera245e882006-03-08 15:04:36 +0000409\begin{enumerate}
Martin Arver68e40172006-06-07 16:37:04 +0000410 \item Load and always show the image, using the \config{\%x} tag
411 \item Preload the image with \config{\%xl} and show it with \config{\%xd}.
412 This way you can have your images displayed conditionally.
Nils Wallméniusda555882006-11-13 15:14:28 +0000413 \nopt{archos}{%
Martin Arver09c39612006-08-18 16:57:56 +0000414 \item Load an image and show as backdrop using the \config{\%X} tag. The
415 image must be of the same exact dimensions as your display.
Nils Wallméniusda555882006-11-13 15:14:28 +0000416 }%
Martin Arvera245e882006-03-08 15:04:36 +0000417\end{enumerate}
Martin Arver959d23e2006-06-04 15:03:39 +0000418
Nils Wallménius12eb0582008-03-23 22:07:09 +0000419\optv{swcodec}{% This doesn't depend on swcodec but we don't have a \noptv
Nils Wallméniusda555882006-11-13 15:14:28 +0000420 % command.
Martin Arver47ea9062006-06-07 12:15:46 +0000421 Example on background image use:
422 \begin{example}
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000423 %X|background.bmp|
Martin Arver47ea9062006-06-07 12:15:46 +0000424 \end{example}
425 The image with filename \fname{background.bmp} is loaded and used in the WPS.
Nils Wallméniusda555882006-11-13 15:14:28 +0000426}%
Martin Arver47ea9062006-06-07 12:15:46 +0000427
428Example on bitmap preloading and use:
429\begin{example}
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000430 %x|a|static_icon.bmp|50|50|
431 %xl|b|rep\_off.bmp|16|64|
432 %xl|c|rep\_all.bmp|16|64|
433 %xl|d|rep\_one.bmp|16|64|
434 %xl|e|rep\_shuffle.bmp|16|64|
435 %?mm<%xdb|%xdc|%xdd|%xde>
Martin Arver47ea9062006-06-07 12:15:46 +0000436\end{example}
437Four images at the same x and y position are preloaded in the example. Which
Martin Arver68e40172006-06-07 16:37:04 +0000438image to display is determined by the \config{\%mm} tag (the repeat mode).
Martin Arvera245e882006-03-08 15:04:36 +0000439
440\subsubsection{Example File}
Martin Arver47ea9062006-06-07 12:15:46 +0000441\begin{example}
Dominik Riebelingf949c8e2006-06-07 17:09:06 +0000442 %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]>
443 %pb%pc/%pt
Martin Arver47ea9062006-06-07 12:15:46 +0000444\end{example}
Dominik Riebelingebb8a222006-04-04 17:48:10 +0000445That is, ``tracknum -- title [artist, album]'', where most fields are only
446displayed if available. Could also be rendered as ``filename'' or ``tracknum --
447title [artist]''.
Martin Arvera245e882006-03-08 15:04:36 +0000448
Nils Wallménius12eb0582008-03-23 22:07:09 +0000449%\opt{lcd_bitmap}{
Martin Arvera245e882006-03-08 15:04:36 +0000450% \begin{verbatim}
Martin Arver47ea9062006-06-07 12:15:46 +0000451% %s%?it<%?in<%in. |>%it|%fn>
452% %s%?ia<%ia|%?d2<%d2|(root)>>
453% %s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|>
454%
455% %al%pc/%pt%ar[%pp:%pe]
456% %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)>
457% %pb
458% %pm
459% % \end{verbatim}
460%}
Martin Arver8e8207f2006-02-11 00:57:17 +0000461
Marc Guay85eec852008-06-24 05:16:23 +0000462\section{\label{ref:manage_settings}Managing Rockbox Settings}
Martin Arver8e8207f2006-02-11 00:57:17 +0000463
Alexander Levin15c850c2010-01-22 22:54:05 +0000464\subsection{Introduction to \fname{.cfg} Files}
Marianne Arnoldb24f5ce2008-01-17 19:45:22 +0000465Rockbox allows users to store and load multiple settings through the use of
466configuration files. A configuration file is simply a text file with the
467extension \fname{.cfg}.
Martin Arver8e8207f2006-02-11 00:57:17 +0000468
Marianne Arnolda352c622007-05-19 19:03:39 +0000469A configuration file may reside anywhere on the disk. Multiple
Martin Arver09c39612006-08-18 16:57:56 +0000470configuration files are permitted. So, for example, you could have
471a \fname{car.cfg} file for the settings that you use while playing your
472jukebox in your car, and a \fname{headphones.cfg} file to store the
Nils Wallménius01bd7362009-02-04 14:22:35 +0000473settings that you use while listening to your \dap{} through headphones.
Martin Arver8e8207f2006-02-11 00:57:17 +0000474
Martin Arver09c39612006-08-18 16:57:56 +0000475See \reference{ref:cfg_specs} below for an explanation of the format
Marianne Arnoldb24f5ce2008-01-17 19:45:22 +0000476for configuration files. See \reference{ref:manage_settings_menu} for an
Martin Arver09c39612006-08-18 16:57:56 +0000477explanation of how to create, edit and load configuration files.
Martin Arver8e8207f2006-02-11 00:57:17 +0000478
Alexander Levin15c850c2010-01-22 22:54:05 +0000479\subsection{\label{ref:cfg_specs}Specifications for \fname{.cfg} Files}
Michael DiFebbo06238412006-08-12 15:56:33 +0000480
Martin Arver09c39612006-08-18 16:57:56 +0000481The Rockbox configuration file is a plain text file, so once you use the
Nils Wallméniusb659c0c2008-03-22 15:26:45 +0000482\setting{Save .cfg file} option to create the file, you can edit the file on
Marianne Arnoldb24f5ce2008-01-17 19:45:22 +0000483your computer using any text editor program. See
Martin Arver09c39612006-08-18 16:57:56 +0000484Appendix \reference{ref:config_file_options} for available settings. Configuration
Marianne Arnoldb24f5ce2008-01-17 19:45:22 +0000485files use the following formatting rules: %
Martin Arver09c39612006-08-18 16:57:56 +0000486
487\begin{enumerate}
488\item Each setting must be on a separate line.
489\item Each line has the format ``setting: value''.
490\item Values must be within the ranges specified in this manual for each
491 setting.
492\item Lines starting with \# are ignored. This lets you write comments into
493 your configuration files.
494\end{enumerate}
495
496Example of a configuration file:
497\begin{example}
Alexander Levin005caba2009-03-22 12:14:03 +0000498 volume: 70
499 bass: 11
500 treble: 12
501 balance: 0
502 time format: 12hour
503 volume display: numeric
504 show files: supported
505 wps: /.rockbox/car.wps
506 lang: /.rockbox/afrikaans.lng
Martin Arver09c39612006-08-18 16:57:56 +0000507\end{example}
508
509\note{As you can see from the example, configuration files do not need to
510 contain all of the Rockbox options. You can create configuration files
511 that change only certain settings. So, for example, supppose you
Martin Arver56b339e2006-08-27 20:44:23 +0000512 typically use the \dap{} at one volume in the car, and another when using
Martin Arver09c39612006-08-18 16:57:56 +0000513 headphones. Further, suppose you like to use an inverse LCD when you are
514 in the car, and a regular LCD setting when you are using headphones. You
515 could create configuration files that control only the volume and LCD
516 settings. Create a few different files with different settings, give
517 each file a different name (such as \fname{car.cfg},
518 \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg
Alex Parker51743412009-08-25 21:51:55 +0000519 files} option to quickly change settings.\\}
Nils Wallménius01bd7362009-02-04 14:22:35 +0000520
521 A special case configuration file can be used to force a particular setting
522 or settings every time Rockbox starts up (e.g. to set the volume to a safe
523 level). Format a new configuration file as above with the required setting(s)
524 and save it into the \fname{/.rockbox} directory with the filename
525 \fname{fixed.cfg}.
Martin Arver09c39612006-08-18 16:57:56 +0000526
527\subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings}
528 menu} The \setting{Manage Settings} menu can be found in the \setting{Main
Martin Arver56b339e2006-08-27 20:44:23 +0000529 Menu}. The \setting{Manage Settings} menu allows you to save and load
Nils Wallménius01bd7362009-02-04 14:22:35 +0000530 \fname{.cfg} files.
Martin Arver09c39612006-08-18 16:57:56 +0000531
532\begin{description}
Michael DiFebbo06238412006-08-12 15:56:33 +0000533
Nils Wallménius01bd7362009-02-04 14:22:35 +0000534\item [Browse .cfg Files]Opens the \setting{File Browser} in the
535 \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration)
536 files. Selecting a \fname{.cfg} file will cause Rockbox to load the settings
Tomer Shalev13c78662009-12-14 20:18:38 +0000537 contained in that file. Pressing \nopt{COWON_D2_PAD}{\ButtonLeft}
Tomer Shalevc7fee002009-12-17 17:38:58 +0000538 \opt{COWON_D2_PAD}{\ButtonPower{} or \TouchTopLeft} will exit back to the
Nils Wallménius01bd7362009-02-04 14:22:35 +0000539 \setting{Manage Settings} menu. See the \setting{Write .cfg files} option on
540 the \setting{Manage Settings} menu for details of how to save and edit a
Martin Arver56b339e2006-08-27 20:44:23 +0000541 configuration file.
Martin Arver09c39612006-08-18 16:57:56 +0000542
Marc Guay162a8f22008-06-28 16:10:02 +0000543\item [Reset Settings]This wipes the saved settings
Nils Wallménius01bd7362009-02-04 14:22:35 +0000544 in the \dap{} and resets all settings to their default values.
Martin Arver09c39612006-08-18 16:57:56 +0000545
Marianne Arnold56b3f922008-01-20 16:33:12 +0000546 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{
547 \note{You can also reset all settings to their default
Marc Guay162a8f22008-06-28 16:10:02 +0000548 values by turning off the \dap, turning it back on, and holding the
Nils Wallménius01bd7362009-02-04 14:22:35 +0000549 \ButtonRec{} button immediately after the \dap{} turns on.}
Martin Arver09c39612006-08-18 16:57:56 +0000550 }
Marc Guay162a8f22008-06-28 16:10:02 +0000551 \opt{IRIVER_H10_PAD}{\note{You can also reset all settings to
Marianne Arnold56b3f922008-01-20 16:33:12 +0000552 their default values by turning off the \dap, and turning it back on
Nils Wallménius01bd7362009-02-04 14:22:35 +0000553 with the \ButtonHold{} button on.}
Marcoen Hirschberg1e514772007-04-27 19:38:16 +0000554 }
Marc Guay162a8f22008-06-28 16:10:02 +0000555 \opt{IPOD_4G_PAD}{\note{You can also reset all settings to their default
556 values by turning off the \dap, turning it back on, and activating the
Nils Wallménius01bd7362009-02-04 14:22:35 +0000557 \ButtonHold{} button immediately after the backlight comes on.}
Marc Guay162a8f22008-06-28 16:10:02 +0000558 }
Marianne Arnold56b3f922008-01-20 16:33:12 +0000559 \opt{GIGABEAT_PAD}{\note{You can also reset all settings to their default
560 values by turning off the \dap, turning it back on and pressing the
Nils Wallménius01bd7362009-02-04 14:22:35 +0000561 \ButtonA{} button immediately after the \dap{} turns on.}
Marianne Arnoldb24f5ce2008-01-17 19:45:22 +0000562 }
563
Marc Guay85eec852008-06-24 05:16:23 +0000564\item [Save .cfg File]This option writes a \fname{.cfg} file to
Nils Wallménius01bd7362009-02-04 14:22:35 +0000565 your \daps{} disk. The configuration file has the \fname{.cfg}
Martin Arver09c39612006-08-18 16:57:56 +0000566 extension and is used to store all of the user settings that are described
567 throughout this manual.
Nils Wallménius01bd7362009-02-04 14:22:35 +0000568
Marc Guay85eec852008-06-24 05:16:23 +0000569 Hint: Use the \setting{Save .cfg File} feature (\setting{Main Menu
Nils Wallménius01bd7362009-02-04 14:22:35 +0000570 $\rightarrow$ Manage Settings}) to save the current settings, then
Martin Arver09c39612006-08-18 16:57:56 +0000571 use a text editor to customize the settings file. See Appendix
572 \reference{ref:config_file_options} for the full reference of available
573 options.
Dominik Riebelingd3bf94f2008-03-11 18:43:56 +0000574
Marc Guay85eec852008-06-24 05:16:23 +0000575\item [Save Sound Settings]This option writes a \fname{.cfg} file to
Nils Wallménius01bd7362009-02-04 14:22:35 +0000576 your \daps{} disk. The configuration file has the \fname{.cfg}
Dominik Riebelingd3bf94f2008-03-11 18:43:56 +0000577 extension and is used to store all of the sound related settings.
578
Marc Guay85eec852008-06-24 05:16:23 +0000579\item [Save Theme Settings]This option writes a \fname{.cfg} file to
Nils Wallménius01bd7362009-02-04 14:22:35 +0000580 your \daps{} disk. The configuration file has the \fname{.cfg}
Dominik Riebelingd3bf94f2008-03-11 18:43:56 +0000581 extension and is used to store all of the theme related settings.
Michael DiFebbo06238412006-08-12 15:56:33 +0000582
Martin Arver09c39612006-08-18 16:57:56 +0000583\end{description}
Martin Arver8e8207f2006-02-11 00:57:17 +0000584
Martin Arver8e8207f2006-02-11 00:57:17 +0000585\section{\label{ref:FirmwareLoading}Firmware Loading}
Martin Arver96f898e2006-03-25 09:22:43 +0000586\opt{player,recorder,recorderv2fm,ondio}{
Martin Arver7bdd03a2006-08-27 15:00:50 +0000587 When your \dap{} powers on, it loads the Archos firmware in ROM, which
Marianne Arnoldb2f7c612007-12-14 02:03:58 +0000588 automatically checks your \daps{} root directory for a file named
Martin Arver47ea9062006-06-07 12:15:46 +0000589 \firmwarefilename. Note that Archos firmware can only read the first
Thom Johansenc479b992008-02-13 13:32:44 +0000590 ten characters of each filename in this process, so do not rename your old
Martin Arver47ea9062006-06-07 12:15:46 +0000591 firmware files with names like \firmwarefilename.\fname{old} and so on,
Thom Johansen10d03442007-12-13 22:51:27 +0000592 because it is possible that the \dap{} will load a file other than the one
Martin Arver7bdd03a2006-08-27 15:00:50 +0000593 you intended.
Martin Arverd3d3e342006-03-15 10:56:14 +0000594}
Martin Arver8e8207f2006-02-11 00:57:17 +0000595
Marc Guay85eec852008-06-24 05:16:23 +0000596\subsection{\label{ref:using_rolo}Using ROLO (Rockbox Loader)}
Dominik Riebelingebb8a222006-04-04 17:48:10 +0000597Rockbox is able to load and start another firmware file without rebooting.
Dominik Riebeling27948882006-07-24 20:53:27 +0000598You just ``play'' a file with the extension %
599\opt{recorder,recorderv2fm,ondio}{\fname{.ajz}.} %
600\opt{player}{\fname{.mod}.} %
Dominik Riebelingf498d532008-12-07 23:00:15 +0000601\opt{h100,h300}{\fname{.iriver}.} %
Dominik Riebeling27948882006-07-24 20:53:27 +0000602\opt{ipod}{\fname{.ipod}.} %
603\opt{iaudio}{\fname{.iaudio}.} %
Szymon Dzioka09152b2010-04-15 18:35:41 +0000604\opt{sansa,h10,h10_5gb,vibe500}{\fname{.mi4}.} %
Rafaël Carrée3c9d6a2009-05-22 10:44:15 +0000605\opt{sansaAMS}{\fname{.sansa}.} %
Alex Parker51743412009-08-25 21:51:55 +0000606\opt{gigabeatf,gigabeats}{\fname{.gigabeat}.} %
Dominik Riebeling27948882006-07-24 20:53:27 +0000607This can be used to test new firmware versions without deleting your
Dominik Riebelingebb8a222006-04-04 17:48:10 +0000608current version.
Martin Arver8e8207f2006-02-11 00:57:17 +0000609
Martin Arver30b0e662006-06-15 11:56:50 +0000610\opt{archos}{\input{advanced_topics/archos-flashing.tex}}
Alexander Levinb57fe482009-12-23 20:05:29 +0000611
Andree Buschmann10023ad2010-03-29 17:58:17 +0000612\section{Optimising battery runtime}
613 Rockbox offers a lot of settings that have high impact on the battery runtime
614 of your \dap{}. The largest power savings can be achieved through disabling
615 unneeded hardware components -- for some of those there are settings
616 available.
617\opt{swcodec}{
618 Another area of savings is avoiding or reducing CPU boosting
619 through disabling computing intense features (e.g. sound processing) or
620 using effective audio codecs.
621} The following provides a short overview of the most relevant settings and
622 rules of thumb.
623
624\nopt{ondio}{
625\subsection{Display backlight}
626 The active backlight consumes a lot of power. Therefore choose a setting that
627 disables the backlight after timeout (for setting \setting{Backlight} see
628 \reference{ref:Displayoptions}). Avoid to have the backlight enabled all the
629 time.
630}
631
632\opt{lcd_sleep}{
633\subsection{Display power-off}
634 Shutting down the display and the display controller saves a reasonable amount
635 of power. Choose a setting that will put the display to sleep after timeout
636 (for setting \setting{Sleep} see \reference{ref:Displayoptions}). Avoid to
637 have the display enabled all the time -- even, if the display is transflective
638 and is readable without backlight. Depending on your \dap{} it might be
639 significantly more efficient to re-enable the display and its backlight for a
640 glimpse a few times per hour than to keep the display enabled.
641}
642
643\opt{accessory_supply}{
644\subsection{Accessory power supply}
645 As default your \dap{}'s accessory power supply is always enabled to ensure
646 proper function of connected accessory devices. Disable this power supply, if
647 -- or as long as -- you do not use any accessory device with your \dap{} while
648 running Rockbox (see \reference{ref:AccessoryPowerSupply}).
649}
650
651\opt{lineout_poweroff}{
652\subsection{Line Out}
653 Rockbox allows to switch off the line-out on your \dap{}. If you do not need
654 the line-out, switch it off (see \reference{ref:LineoutOnOff}).
655}
656
657\opt{spdif_power}{
658\subsection{Optical Output}
659 Rockbox allows to switch off the S/PDIF output on your \dap{}. If you do not
660 need this output, switch it off (see \reference{ref:SPDIF_OnOff}).
661}
662
663\opt{disk_storage}{
664\subsection{Anti-Skip Buffer}
665 Having a large anti-skip buffer tends to use more power, and may reduce your
666 battery life. It is recommended to always use the lowest possible setting
667 that allows correct and continuous playback (see \reference{ref:AntiSkipBuf}).
668}
669
Andree Buschmann2349cf52010-04-12 06:40:58 +0000670\opt{swcodec}{
671\subsection{Replaygain}
672 Replaygain is a post processing that equalises the playback volume of audio
673 files to the same perceived loudness. This post processing applies a factor
674 to each single PCM sample and is therefore consuming additional CPU time. If
675 you want to achieve some (minor) savings in runtime, switch this feature off
676 (see \reference{ref:ReplayGain}).
677}
678
Andree Buschmann10023ad2010-03-29 17:58:17 +0000679\opt{swcodec,disk_storage,flash_storage}{
680\subsection{Audio format and bitrate}
681\opt{swcodec}{
682 In general the fastest decoding audio format will be the best in terms of
683 battery runtime on your \dap{}. An overview of different codec's performance
684 on different \dap{}s can be found at \wikilink{CodecPerformanceComparison}.
685}
686
687\opt{flash_storage}{
688 Your target uses flash that consumes a certain amount of power during access.
689 The less often the flash needs to be switched on for buffering and the shorter
690 the buffering duration is, the lower is the overall power consumption.
691 Therefore the bitrate of the audio files does have an impact on the battery
692 runtime as well. Lower bitrate audio files will result in longer battery
693 runtime.
694}
695\opt{disk_storage}{
696 Your target uses a hard disk which consumes a large amount of power while
697 spinning -- up to several hundred mA. The less often the hard disk needs to
698 spin up for buffering and the shorter the buffering duration is, the lower is
699 the power consumption. Therefore the bitrate of the audio files does have an
700 impact on the battery runtime as well. Lower bitrate audio files will result
701 in longer battery runtime.
702}
703
704 Please do not re-encode any existing audio files from one lossy format to
705 another based upon the above mentioned. This will reduce the audio quality.
706 If you have the choice, select the best suiting codec when encoding the
707 original source material.
708}
709
710\opt{swcodec}{
711\subsection{Sound settings}
712 In general all kinds of sound processing will need more CPU time and therefore
713 consume more power. The less sound processing you use, the better it is for
714 the battery runtime (for options see \reference{ref:configure_rockbox_sound}).
715}