diff options
Diffstat (limited to 'manual/rockbox_interface')
-rw-r--r-- | manual/rockbox_interface/main.tex | 4 | ||||
-rw-r--r-- | manual/rockbox_interface/tagcache.tex | 7 | ||||
-rw-r--r-- | manual/rockbox_interface/wps.tex | 204 |
3 files changed, 87 insertions, 128 deletions
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}. | |||
817 | The Rockbox distribution comes with some themes that should look nice on | 815 | The Rockbox distribution comes with some themes that should look nice on |
818 | your \dap{}. | 816 | your \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 |
822 | fonts from the fonts package, so make sure you installed them. | 819 | fonts from the fonts package, so make sure you installed them. |
823 | Also, if you downloaded additional themes from the Internet make sure you | 820 | Also, if you downloaded additional themes from the Internet make sure you |
824 | have the needed fonts installed as otherwise the theme may not display | 821 | have the needed fonts installed as otherwise the theme may not display |
825 | properly.} | 822 | properly.} |
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} |
5 | This chapter describes the Rockbox music database system. Using the information | 5 | This chapter describes the Rockbox music database system. Using the information |
6 | contained in the tags (ID3v1, ID3v2% | 6 | contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your |
7 | \opt{swcodec}{, Vorbis Comments, Apev2, etc.}% | 7 | audio files, Rockbox builds and maintains a database of the music |
8 | ) in your audio files, Rockbox builds and maintains a database of the music | ||
9 | files on your player and allows you to browse them by Artist, Album, Genre, | 8 | files on your player and allows you to browse them by Artist, Album, Genre, |
10 | Song Name, etc. The criteria the database uses to sort the songs can be completely | 9 | Song 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 @@ | |||
3 | The While Playing Screen (WPS) displays various pieces of information about the | 3 | The While Playing Screen (WPS) displays various pieces of information about the |
4 | currently playing audio file. | 4 | currently playing audio file. |
5 | % | 5 | % |
6 | \opt{lcd_bitmap}{% | 6 | The appearance of the WPS can be configured using WPS configuration files. |
7 | The appearance of the WPS can be configured using WPS configuration files. | 7 | The 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 | 8 | or 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 | 9 | to 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 | ||
28 | See \reference{ref:ConfiguringtheWPS} for details of customising | 26 | See \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} | 140 | The 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 | 141 | several 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} |
180 | Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu} | 177 | Like the context menu for the \setting{File Browser}, the \setting{WPS Context Menu} |
181 | allows you quick access to some often used functions. | 178 | allows 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 | } |