diff options
Diffstat (limited to 'manual')
-rw-r--r-- | manual/advanced_topics/main.tex | 840 | ||||
-rw-r--r-- | manual/configure_rockbox/main.tex | 615 | ||||
-rw-r--r-- | manual/getting_started/archos_choice.tex | 139 | ||||
-rw-r--r-- | manual/getting_started/main.tex | 112 | ||||
-rw-r--r-- | manual/main_menu/main.tex | 492 | ||||
-rw-r--r-- | manual/rockbox.tex | 10 | ||||
-rw-r--r-- | manual/rockbox_interface/main.tex | 804 |
7 files changed, 3007 insertions, 5 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex new file mode 100644 index 0000000000..97165d6855 --- /dev/null +++ b/manual/advanced_topics/main.tex | |||
@@ -0,0 +1,840 @@ | |||
1 | \chapter{Advanced Topics} | ||
2 | \newpage | ||
3 | \section{\label{ref:CustomisingUI}Customising the userinterface} | ||
4 | \subsection{\label{ref:GettingExtras}Getting Extras (Fonts,Languages)} | ||
5 | Rockbox supports custom fonts (for the Recorder and Ondio only) and a number of different languages. Rockbox 2.4 comes with 41 fonts and 24 languages already included. If new fonts and language files have been created, then they will be found at \url{http://www.rockbox.org/fonts/} and \url{http://www.rockbox.org/lang/}. | ||
6 | |||
7 | \subsection{\label{ref:LoadingForts}Loading Fonts (Recorder, Ondio)} | ||
8 | Rockbox can load fonts dynamically. Simply copy the .fnt file to the | ||
9 | disk and ``play'' them in the directory browser or select \textbf{General Settings {\textgreater} Fonts} from the Main Menu . | ||
10 | |||
11 | If you want a font to be loaded automatically every time you start up, | ||
12 | it must be located in the \textbf{/.rockbox }folder and the file name | ||
13 | must be at most 24 characters long. | ||
14 | |||
15 | Any BDF font file up to 16 pixels high should be usable with Rockbox. To | ||
16 | convert from .bdf to .fnt, use the convbdf tool. This tool can be found | ||
17 | on the Rockbox website | ||
18 | (Linux: \url{http://www.rockbox.org/fonts/convbdf}, Windows: \url{http://www.rockbox.org/fonts/convbdf.exe}). | ||
19 | |||
20 | \subsection{\label{ref:Loadinglanguages}Loading Languages} | ||
21 | Rockbox can load language files at runtime. Simply copy the .lng file | ||
22 | (do not use the .lang file) to the Jukebox and | ||
23 | ``play'' it in the Rockbox directory browser | ||
24 | or select \textbf{General Settings {}-{\textgreater} Languages }from | ||
25 | the Main Menu. | ||
26 | |||
27 | If you want a language to be loaded automatically every time you start | ||
28 | up, it must be located in the \textbf{/.rockbox }folder and the file | ||
29 | name must be a maximum of 24 characters long. | ||
30 | |||
31 | Rockbox supports many different languages. You can get .lng files at | ||
32 | \url{http://www.rockbox.org/lang/}. | ||
33 | Currently all of these languages are included in the Rockbox | ||
34 | distribution. | ||
35 | |||
36 | If your language is not yet supported and you want to write your own | ||
37 | language file, follow these instructions: | ||
38 | |||
39 | \begin{itemize} | ||
40 | \item Copy the\url{./ http://www.rockbox.org/lang/english.lang }file and start filling in the ``new:'' lines. | ||
41 | \item Name your file {\textless}language{\textgreater}.lang, where | ||
42 | {\textless}language{\textgreater} is the local name for your language. i.e. svenska.lang, francais.lang etc. | ||
43 | \item When you are done, submit your .lang file to Rockbox patch | ||
44 | tracker. | ||
45 | (\url{http://sourceforge.net/tracker/?group_id=44306&atid=439120}) | ||
46 | \end{itemize} | ||
47 | |||
48 | \section{\label{ref:ConfiguringtheWPS}Configuring the WPS} | ||
49 | |||
50 | \subsection{Description / General Info} | ||
51 | |||
52 | \begin{itemize} | ||
53 | \item The Custom While Playing Screen (WPS) display is used on both the | ||
54 | Player and Recorder as a means to customise the WPS to the | ||
55 | user's likings. | ||
56 | \item After editing the .wps file, ``play'' it to make it take effect. | ||
57 | \item The file may be 2 lines long for the Player, and 13 lines for the | ||
58 | Recorder. | ||
59 | \item All characters not preceded by \% are displayed as typed. | ||
60 | \item Lines beginning with \# are comments and will be ignored. | ||
61 | \end{itemize} | ||
62 | |||
63 | \subsection{File Location} | ||
64 | Custom WPS files may be located anywhere on the drive. The only | ||
65 | restriction is that they must end in .wps. When PLAY is pressed on a | ||
66 | .wps file, it will be used for future WPS screens. If the | ||
67 | ``played'' .wps file is located in the | ||
68 | /.rockbox folder, it will be remembered and used after reboot. The .wps | ||
69 | filename must be no more than 24 characters long for it to be | ||
70 | remembered. | ||
71 | |||
72 | \subsection{Tags} | ||
73 | |||
74 | \begin{itemize} | ||
75 | \item {\bfseries | ||
76 | ID3 Info Tags:} | ||
77 | |||
78 | \%ia : ID3 Artist | ||
79 | |||
80 | \%ic : ID3 Composer | ||
81 | |||
82 | \%id : ID3 Album Name | ||
83 | |||
84 | \%ig : ID3 Genre Name | ||
85 | |||
86 | \%in : ID3 Track Number | ||
87 | |||
88 | \%it : ID3 Track Title | ||
89 | |||
90 | \%iy : ID3 Year | ||
91 | |||
92 | \%iv : ID3 Version (1.0, 1.1, 2.2, 2.3, 2.4 or empty if no id3 tag) | ||
93 | \item {\bfseries | ||
94 | Battery Info:} | ||
95 | |||
96 | \%bl : Show numeric battery level in percent | ||
97 | |||
98 | \%bt : Show estimated battery time left | ||
99 | \item {\bfseries | ||
100 | File Info Tags:} | ||
101 | |||
102 | \%fb : File Bitrate (in kbps) | ||
103 | |||
104 | \%ff : File Frequency (in Hz) | ||
105 | |||
106 | \%fm : File Name | ||
107 | |||
108 | \%fn : File Name (without extension) | ||
109 | |||
110 | \%fp : File Path | ||
111 | |||
112 | \%fs : File Size (In Kilobytes) | ||
113 | |||
114 | \%fv : ``(vbr)'' if variable bit rate or ``'' if constant bit rate | ||
115 | |||
116 | \%d1 : First directory from end of file path. | ||
117 | |||
118 | \%d2 : Second directory from end of file path. | ||
119 | |||
120 | \%d3 : Third directory from end of file path. | ||
121 | |||
122 | Example for the the \%dN commands: If the path is /Rock/Kent/Isola/11 | ||
123 | {}-747.mp3, \%d1 is ``Isola'', \%d2 is ``Kent'', \%d3 is ``Rock''. | ||
124 | \end{itemize} | ||
125 | |||
126 | \begin{itemize} | ||
127 | \item {\bfseries | ||
128 | Playlist/Song Info Tags:} | ||
129 | |||
130 | \%pb : Progress Bar | ||
131 | |||
132 | \begin{itemize} | ||
133 | \item[] { | ||
134 | Player: This will display a 1 character | ||
135 | ``cup'' that empties as the song progresses.} | ||
136 | |||
137 | Recorder: This will replace the entire line with a progress bar. | ||
138 | \end{itemize} | ||
139 | \%pf : Player: Full{}-line progress bar + time display | ||
140 | |||
141 | \%pc : Current Time In Song | ||
142 | |||
143 | \%pe : Total Number of Playlist Entries | ||
144 | |||
145 | \%pm : Peak Meter (Recorder only) {}- the entire line is used as volume | ||
146 | peak meter. | ||
147 | |||
148 | \%pn : Playlist Name (Without path or extension) | ||
149 | |||
150 | \%pp : Playlist Position | ||
151 | |||
152 | \%pr : Remaining Time In Song | ||
153 | |||
154 | \%ps : Shuffle. Shows 's' if shuffle | ||
155 | mode is enabled. | ||
156 | |||
157 | \%pt : Total Track Time | ||
158 | |||
159 | \%pv : Current volume | ||
160 | \item {\bfseries | ||
161 | Conditional Tags (If/Else block):} | ||
162 | |||
163 | \%?xx{\textless}{\textbar}{\textgreater} : Conditional: if the tag | ||
164 | specified by ``xx'' has a value, the text | ||
165 | between the ``{\textless}'' and the ``{\textbar}'' is displayed, else the text | ||
166 | between the ``{\textbar}'' and the | ||
167 | ``{\textgreater}'' is displayed. The else part is optional, so the ``{\textbar}'' does not have to be specified if no else part is desired. The conditionals | ||
168 | nest, so the text in the if and else part can contain all \% commands, | ||
169 | including conditionals. | ||
170 | \end{itemize} | ||
171 | \begin{itemize} | ||
172 | \item {\bfseries | ||
173 | Next Song info} | ||
174 | |||
175 | You can display information about the next song {}- the song that is | ||
176 | about to play after the one currently playing (unless you change the | ||
177 | plan). | ||
178 | |||
179 | If you use the upper{}-case versions of the | ||
180 | three tags: F, I and D, they will instead refer to the next song | ||
181 | instead of the current one. Example: \%Ig is the genre name used in the | ||
182 | next song and \%Ff is the mp3 frequency. | ||
183 | |||
184 | Take note that the next song information WILL NOT be available at all | ||
185 | times, but will most likely be available at the end of a song. We | ||
186 | suggest you use the conditional display tag a lot when displaying | ||
187 | information about the next song! | ||
188 | \item {\bfseries | ||
189 | Alternating sublines} | ||
190 | |||
191 | It is possible to group items on each line into 2 or more groups or | ||
192 | ``sublines''. Each subline will be displayed | ||
193 | in succession on the line for a specified time, alternating | ||
194 | continuously through each defined subline. | ||
195 | |||
196 | Items on a line are broken into sublines with the semicolon | ||
197 | ';' character. The display time for | ||
198 | each subline defaults to 2 seconds unless modified by using the | ||
199 | '\%t' tag to specify an alternate | ||
200 | time (in seconds and optional tenths of a second) for the subline to be | ||
201 | displayed. | ||
202 | |||
203 | Subline related special characters and tags: | ||
204 | |||
205 | ; : Split items on a line into separate sublines | ||
206 | |||
207 | \%t : Set the subline display time. The | ||
208 | '\%t' is followed by either integer | ||
209 | seconds (\%t5), or seconds and tenths of a second (\%t3.5). | ||
210 | |||
211 | Each alternating subline can still be optionally scrolled while it is | ||
212 | being displayed, and scrollable formats can be displayed on the same | ||
213 | line with non{}-scrollable formats (such as track elapsed time) as long | ||
214 | as they are separated into different sublines. | ||
215 | \item {\bfseries | ||
216 | Other Tags:} | ||
217 | |||
218 | \%\% : Display a '\%' | ||
219 | |||
220 | \%{\textless} : Display a | ||
221 | '{\textless}' | ||
222 | |||
223 | \%{\textbar} : Display a '{\textbar}' | ||
224 | |||
225 | \%{\textgreater} : Display a | ||
226 | '{\textgreater}' | ||
227 | |||
228 | \%s : Indicate that the line should scroll. Can occur anywhere in a line | ||
229 | (given that the text is displayed; see conditionals above). You can | ||
230 | specify up to 10 scrolling lines. Scrolling lines can not contain | ||
231 | dynamic content such as timers, peak meters or progress bars. | ||
232 | \end{itemize} | ||
233 | {\bfseries | ||
234 | Example File} | ||
235 | |||
236 | \%s\%pp/\%pe: \%?it{\textless}\%it{\textbar}\%fn{\textgreater} {}- | ||
237 | \%?ia{\textless}\%ia{\textbar}\%d2{\textgreater} {}- | ||
238 | \%?id{\textless}\%id{\textbar}\%d1{\textgreater} | ||
239 | |||
240 | \%pb\%pc/\%pt | ||
241 | |||
242 | That is, ``tracknum {}- title [artist, | ||
243 | album]'', where most fields are only displayed if | ||
244 | available. Could also be rendered as | ||
245 | ``filename'' or ``tracknum {}-title [artist]''. | ||
246 | |||
247 | {\bfseries | ||
248 | Default} | ||
249 | |||
250 | If you haven't selected a .wps file in the /.rockbox | ||
251 | directory, you get the hard coded layout. The default WPS screen for | ||
252 | Players is: | ||
253 | |||
254 | \%s\%pp/\%pe: \%?it{\textless}\%it{\textbar}\%fn{\textgreater} {}- | ||
255 | \%?ia{\textless}\%ia{\textbar}\%d2{\textgreater} {}- | ||
256 | \%?id{\textless}\%id{\textbar}\%d1{\textgreater} | ||
257 | |||
258 | \%pc\%?ps{\textless}*{\textbar}/{\textgreater}\%pt | ||
259 | |||
260 | And for the Recorder and Ondio: | ||
261 | |||
262 | \%s\%?it{\textless}\%?in{\textless}\%in. | ||
263 | {\textbar}{\textgreater}\%it{\textbar}\%fn{\textgreater} | ||
264 | |||
265 | \%s\%?ia{\textless}\%ia{\textbar}\%?d2{\textless}\%d2{\textbar}(root){\textgreater}{\textgreater} | ||
266 | |||
267 | \%s\%?id{\textless}\%id{\textbar}\%?d1{\textless}\%d1{\textbar}(root){\textgreater}{\textgreater} | ||
268 | \%?iy{\textless}(\%iy){\textbar}{\textgreater} | ||
269 | |||
270 | \%pc/\%pt [\%pp:\%pe] | ||
271 | |||
272 | \%fbkBit \%?fv{\textless}avg{\textbar}{\textgreater} | ||
273 | \%?iv{\textless}(id3v\%iv){\textbar}(no id3){\textgreater} | ||
274 | |||
275 | \%pb | ||
276 | |||
277 | \%pm | ||
278 | |||
279 | \section{\label{ref:SettingsFile}Making your own settings file} | ||
280 | A .cfg file is used to load settings from a plain text file. A .cfg file | ||
281 | may reside anywhere on the hard disk. The only restriction is that the | ||
282 | filename must end in .cfg | ||
283 | |||
284 | Hint: Use the ``Write .cfg file'' feature | ||
285 | (Main Menu{}-{\textgreater} General Settings) to save the current | ||
286 | settings, then use a text editor to customize the settings file. | ||
287 | |||
288 | {\bfseries | ||
289 | Format Rules} | ||
290 | |||
291 | \begin{itemize} | ||
292 | \item Format: setting: value | ||
293 | \item Each setting must be on a separate line. | ||
294 | \item Lines starting with \# are ignored. | ||
295 | \end{itemize} | ||
296 | {\bfseries | ||
297 | Settings (allowed values) [unit]} | ||
298 | |||
299 | volume (0 {}- 100) | ||
300 | |||
301 | bass ({}-15 {}- 15) | ||
302 | |||
303 | treble ({}-15 {}- 15) | ||
304 | |||
305 | balance ({}-100 {}- 100) | ||
306 | |||
307 | channels (stereo, stereo narrow, stereo wide, mono, mono left, | ||
308 | |||
309 | mono right, karaoke) | ||
310 | |||
311 | shuffle (on, off) | ||
312 | |||
313 | repeat (off, all, one) | ||
314 | |||
315 | play selected (on, off) | ||
316 | |||
317 | resume (off, ask, ask once, on) | ||
318 | |||
319 | scan min step (1, 2, 3, 4, 5, 6, 8, 10, 15, 20, 25, 30, 45, 60) [secs] | ||
320 | |||
321 | scan accel (0 {}- 15) [double scan speed every X seconds] | ||
322 | |||
323 | antiskip (0 {}- 7) [seconds] | ||
324 | |||
325 | volume fade (on, off) | ||
326 | |||
327 | sort case (on, off) | ||
328 | |||
329 | show files (all, supported, music, playlists) | ||
330 | |||
331 | follow playlist (on, off) | ||
332 | |||
333 | playlist viewer icons | ||
334 | |||
335 | (on, off) | ||
336 | |||
337 | playlist viewer track display | ||
338 | |||
339 | (on, off) | ||
340 | |||
341 | recursive directory insert | ||
342 | |||
343 | (on, off) | ||
344 | |||
345 | scroll speed (0 {}- 15) | ||
346 | |||
347 | scroll delay (0 {}- 250) [1/10s] | ||
348 | |||
349 | scroll step (1 {}- 112) [pixels] | ||
350 | |||
351 | bidir limit (0 {}- 200) [\% of screen width] | ||
352 | |||
353 | contrast (0 {}- 63) | ||
354 | |||
355 | backlight timeout (off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, | ||
356 | 30, | ||
357 | |||
358 | 45, 60, 90) [seconds] | ||
359 | |||
360 | backlight when plugged | ||
361 | |||
362 | (on, off) | ||
363 | |||
364 | disk spindown (3 {}- 254) [seconds] | ||
365 | |||
366 | battery capacity (1500 {}- 2400) [mAh] | ||
367 | |||
368 | idle poweroff (off, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 30, 45, 60) | ||
369 | [minutes] | ||
370 | |||
371 | lang (/path/filename.lng) | ||
372 | |||
373 | wps (/path/filename.wps) | ||
374 | |||
375 | autocreate bookmarks (on, off) | ||
376 | |||
377 | autoload bookmarks (on, off) | ||
378 | |||
379 | use most{}-recent{}-bookmarks | ||
380 | |||
381 | (on, off) | ||
382 | |||
383 | talk dir (off, number, spell, hover) | ||
384 | |||
385 | talk file (off, number, spell, hover) | ||
386 | |||
387 | talk menu (off, on) | ||
388 | |||
389 | {\bfseries | ||
390 | Recorder{}-specific settings} | ||
391 | |||
392 | loudness (0 {}- 17) | ||
393 | |||
394 | super bass (on, off) | ||
395 | |||
396 | auto volume (off, 0.02, 2, 4, 8) [seconds] | ||
397 | |||
398 | MDB enable (on, off) | ||
399 | |||
400 | MDB strength (0 {--} 127) [dB] | ||
401 | |||
402 | MDB harmonics (0 {--} 100) [\%] | ||
403 | |||
404 | MDB center frequency (20{}-300) [Hz] | ||
405 | |||
406 | MDB shape (50{}-300) [Hz] | ||
407 | |||
408 | peak meter release (1 {}- 126) | ||
409 | |||
410 | peak meter hold (off, 200ms, 300ms, 500ms, 1, 2, 3, 4, 5, 6, 7, 8, | ||
411 | |||
412 | 9, 10, 15, 20, 30, 1min) | ||
413 | |||
414 | peak meter clip hold (on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, | ||
415 | |||
416 | |||
417 | 45, 60, 90, 2min, 3min, 5min, 10min, 20min, | ||
418 | |||
419 | 45min, 90min) | ||
420 | |||
421 | peak meter busy (on, off) | ||
422 | |||
423 | peak meter dbfs (on, off) (on = dbfs, off = linear) | ||
424 | |||
425 | peak meter min (0 {}- 89) [dB] or (0 {}- 100) [\%] | ||
426 | |||
427 | peak meter max (0 {}- 89) [dB] or (0 {}- 100) [\%] | ||
428 | |||
429 | statusbar (on, off) | ||
430 | |||
431 | scrollbar (on, off) | ||
432 | |||
433 | volume display (graphic, numeric) | ||
434 | |||
435 | battery display (graphic, numeric) | ||
436 | |||
437 | time format (12hour, 24hour) | ||
438 | |||
439 | font (/path/filename.fnt) | ||
440 | |||
441 | invert (on, off) | ||
442 | |||
443 | deep discharge (on, off) | ||
444 | |||
445 | trickle charge (on, off) | ||
446 | |||
447 | disk poweroff (on, off) | ||
448 | |||
449 | rec quality (0 {}- 7) (0=smallest size, 7=highest quality) | ||
450 | |||
451 | rec frequency (48, 44, 32, 24, 22, 16) [kHz] | ||
452 | |||
453 | rec source (mic, line, spdif) | ||
454 | |||
455 | rec channels (mono, stereo) | ||
456 | |||
457 | rec mic gain (0 to 15) | ||
458 | |||
459 | rec left gain (0 to 15) | ||
460 | |||
461 | rec right gain (0 to 15) | ||
462 | |||
463 | editable recordings (on,off) | ||
464 | |||
465 | rec timesplit (off, 00:05, 00:10, 00:20, 00:30, 01:00, 01:12, \newline | ||
466 | 01:20, 02:00, 04:00, 06:00, 08:00, 16:00,\newline | ||
467 | 24:00) [hh:mm] | ||
468 | |||
469 | pre{}-recording time (off, 1{}-30) [secs] | ||
470 | |||
471 | rec directory (/recordings, current) | ||
472 | |||
473 | {\bfseries | ||
474 | FM recorder specific settings} | ||
475 | |||
476 | \textmd{force fm mono (on,off)} | ||
477 | |||
478 | \textbf{Example File} | ||
479 | |||
480 | volume: 70 | ||
481 | |||
482 | bass: 11 | ||
483 | |||
484 | treble: 12 | ||
485 | |||
486 | balance: 0 | ||
487 | |||
488 | time format: 12hour | ||
489 | |||
490 | volume display: numeric | ||
491 | |||
492 | show files: supported | ||
493 | |||
494 | wps: /.rockbox/car.wps | ||
495 | |||
496 | lang: /.rockbox/afrikaans.lng | ||
497 | |||
498 | \section{\label{ref:PartISection1}Differences between binaries} | ||
499 | There are 3 different types of firmware binaries from Rockbox website. Current Version, Daily Builds and Bleeding Edge. | ||
500 | |||
501 | \begin{itemize} | ||
502 | \item \begin{itemize} | ||
503 | \item The current version is the latest stable version developed by the | ||
504 | Rockbox Team. It's free of known critical bugs and works with Archos | ||
505 | Jukebox Player/Studio, Recorders and Ondio devices. It is available | ||
506 | from | ||
507 | \url{http://www.rockbox.org/download/}. | ||
508 | \item The Daily Build is a development version of Rockbox. It supports all new features and patches developed since last stable version. It may also contain bugs! This version is generated automatically every day and can be found at | ||
509 | \url{http://www.rockbox.org/daily.shtml}. | ||
510 | \item Bleeding edge builds are the same as the Daily build, but built | ||
511 | from the latest development code every 20 minutes. These builds are for | ||
512 | people who want to test the code that developers just checked in. | ||
513 | \end{itemize} | ||
514 | \end{itemize} | ||
515 | There are binaries for different Jukebox models: | ||
516 | |||
517 | \begin{itemize} | ||
518 | \item \begin{itemize} | ||
519 | \item The Player version is suitable for Archos Jukebox 5000, 6000 and | ||
520 | all Studio models. | ||
521 | \end{itemize} | ||
522 | \end{itemize} | ||
523 | \begin{itemize} | ||
524 | \item \begin{itemize} | ||
525 | \item If you have a recorder with cylindrically rounded bumpers, you | ||
526 | need the ``regular'' recorder version. | ||
527 | \item FM Recorders are models with a FM radio. | ||
528 | \item The V2 recorder is a recorder in an FM Recorder form factor, but | ||
529 | without radio. | ||
530 | \item The 8mb version requires a hardware hack, where the RAM chips are | ||
531 | replaced. | ||
532 | \item The Ondio builds come with and without radio support, for the | ||
533 | Ondio FM and SP respectively. | ||
534 | \end{itemize} | ||
535 | \end{itemize} | ||
536 | If in doubt as to which version to use, the table on page | ||
537 | \pageref{ref:Jukeboxtypetable} may be of assistance. | ||
538 | |||
539 | Note: All references in this manual to | ||
540 | ``Recorder'' apply equally to the FM Recorder | ||
541 | unless otherwise specified. | ||
542 | |||
543 | \section{\label{ref:FirmwareLoading}Firmware Loading} | ||
544 | When your Jukebox powers on, it loads the Archos firmware in ROM, which | ||
545 | automatically checks your Jukebox hard disk's root folder for a file | ||
546 | named \textbf{archos.mod} (on the player version) or | ||
547 | \textbf{ajbrec.ajz} (on the recorder version). Note that Archos | ||
548 | firmware can only read the first ten characters of each file name in | ||
549 | this process, so don't rename your old firmware files with names like | ||
550 | archos.mod.old and so on, because it's possible that the Jukebox will | ||
551 | load a file other than the one you intended. | ||
552 | |||
553 | \section{\label{ref:PartISection4}Using ROLO (Rockbox loader)} | ||
554 | Rockbox is able to load and start another firmware file without | ||
555 | rebooting. You just press PLAY on an .ajz (Recorder, Ondio) or .mod | ||
556 | (Player) file. This can be used to test new firmware versions without | ||
557 | deleting your current version, or to load the original Archos firmware | ||
558 | (you have to download the appropriate file from | ||
559 | Archos' website). | ||
560 | |||
561 | \section{\label{ref:Rockboxinflash}Rockbox in flash (Recorder, Ondio)} | ||
562 | \textbf{FLASHING ROCKBOX IS OPTIONAL!} It is not required for using | ||
563 | Rockbox on your Jukebox Recorder. Please read the whole section | ||
564 | thoroughly before flashing. | ||
565 | |||
566 | \subsection{\label{ref:PartISection61}Introduction} | ||
567 | Flashing in the sense used here and elsewhere in regard to Rockbox means | ||
568 | reprogramming the flash memory of the Jukebox unit. Flash memory | ||
569 | (sometimes called ``Flash ROM'') is a type of | ||
570 | non{}-volatile memory that can be erased and reprogrammed in circuit. It is a variation of electrically erasable | ||
571 | programmable read{}-only memory (EEPROM). | ||
572 | |||
573 | A from the factory Jukebox comes with the Archos firmware flashed. It is | ||
574 | possible to replace the built{}-in software with Rockbox. | ||
575 | |||
576 | Terminology used in the following:\newline | ||
577 | \textbf{Firmware} means the flash ROM content as a whole.\newline | ||
578 | \textbf{Image} means one operating software started from there. | ||
579 | |||
580 | By reprogramming the firmware, the Jukebox will boot much faster. The | ||
581 | Archos boot loader seems to take forever compared to the Rockbox | ||
582 | version. In fact, the Rockbox boot loader is so fast that it has to | ||
583 | wait for the disk to spin up. The flashing procedure is a bit involved | ||
584 | for the first time, updates are very simple later on. | ||
585 | |||
586 | \subsection{\label{ref:Method}Method} | ||
587 | The replaced firmware will host a bootloader and 2 images. This is made | ||
588 | possible by compression. The first is the | ||
589 | ``permanent'' backup. The second is the | ||
590 | default image to be started. The former is only used when you hold the | ||
591 | F1 key during start, and is the original Archos firmware, the second is | ||
592 | a current build of Rockbox. This second image is meant to be | ||
593 | reprogrammed whenever a Rockbox upgrade is performed. | ||
594 | |||
595 | There are two programming tools supplied: | ||
596 | |||
597 | \begin{itemize} | ||
598 | \item The first one is called \textbf{firmware\_flash.rock} and is used | ||
599 | to program the whole flash with new content. It can also be used to | ||
600 | revert back to the original firmware that is backed up as part of this | ||
601 | procedure. This tool will only be needed once, and can be viewed as | ||
602 | ``formatting'' the flash with the desired image structure. | ||
603 | \item The second one is called \textbf{rockbox\_flash.rock }and is used | ||
604 | to reprogram only the second image. If the resulting programmed | ||
605 | firmware image is not operational, it is | ||
606 | possible to hold down the F1 key while booting to start the Jukebox | ||
607 | with the Archos firmware and Rockbox booted from disk to reinstall a | ||
608 | working firmware image. | ||
609 | \end{itemize} | ||
610 | |||
611 | \subsubsection{\label{ref:PartISection63}Risks} | ||
612 | Well, is it dangerous? Yes, certainly, like programming a | ||
613 | mainboard BIOS, CD/DVD drive firmware, | ||
614 | mobile phone, etc. If the power fails, the chip malfunctions while | ||
615 | programming or particularly if the programming software malfunctions, | ||
616 | your Jukebox may stop functioning. The Rockbox team take no | ||
617 | responsibility of any kind {}- do this at your own risk. | ||
618 | |||
619 | However, the code has been extensively tested and is known to work well. | ||
620 | The new firmware file is completely read before it starts programming, | ||
621 | there are a lot of sanity checks. If any fail, it will not program. | ||
622 | There is no reason why such low level code should behave differently on | ||
623 | your Jukebox. | ||
624 | |||
625 | There's one ultimate safety net to bring back Jukeboxes | ||
626 | with even completely garbled flash content: the UART boot mod, which in | ||
627 | turn requires the serial mod. This can bring the dead back to life, | ||
628 | with that it's possible to reflash independently from the outside, even | ||
629 | if the flash is completely erased. It has been used during development, | ||
630 | else Rockbox in flash wouldn't have been possible. | ||
631 | Extensive development effort went into the development of the UART boot | ||
632 | mod. Mechanically adept users with good soldering skills can easily | ||
633 | perform these mods. Others may feel uncomfortable using the first tool | ||
634 | (\textbf{firmware\_flash.rock}) for reflashing the firmware. | ||
635 | |||
636 | If you are starting with a known{}-good image, you are unlikely to | ||
637 | experience problems. The flash tools have been stable for quite a | ||
638 | while. Several users have used them extensively, even flashing while | ||
639 | playing! Although it worked, it's not the recommended | ||
640 | method. | ||
641 | |||
642 | The flashing software is very paranoid about making sure that the | ||
643 | correct flash version is being installed. If the wrong file is used, | ||
644 | it will simply refuse to flash the Jukebox. | ||
645 | |||
646 | About the safety of operation: Since the Rockbox boot code gives ``dual | ||
647 | boot'' capability, the Archos firmware is still there when you hold F1 | ||
648 | during startup. So even if you have problems with Rockbox from flash, you can still use | ||
649 | the Jukebox, reflash the second image with an updated Rockbox copy, | ||
650 | etc. | ||
651 | |||
652 | The flash chip being used by Archos is specified for 100,000 cycles, so | ||
653 | it's very unlikely that flashing it will wear it out. | ||
654 | |||
655 | \subsection{\label{ref:Requirements}Requirements} | ||
656 | You need two things: | ||
657 | |||
658 | \begin{itemize} | ||
659 | \item The first is a Recorder or FM model, or an Ondio SP or FM. Be sure | ||
660 | you're using the correct package, they differ | ||
661 | depending on your precise hardware! The technology works for the Player | ||
662 | models, too. Players can also be flashed, but Rockbox does not run | ||
663 | cold{}-started on those, yet. | ||
664 | \item Second, you need an in{}-circuit programmable flash. Chances are | ||
665 | about 85\% that you have, but Archos also used an older flash chip | ||
666 | which can't do the trick. You can find out via Rockbox | ||
667 | debug menu, entry Hardware Info. If the flash info gives you question | ||
668 | marks, you're out of luck. The only option for | ||
669 | flashing if this is the case is to solder in the right chip | ||
670 | (SST39VF020), preferably with the firmware already in. If the chip is | ||
671 | blank, you'll need the UART boot mod as well. | ||
672 | \end{itemize} | ||
673 | \subsubsection{\label{ref:FlashingProcedure}Flashing Procedure} | ||
674 | Here are step{}-by{}-step instructions on how to flash and update to a | ||
675 | current build. It is assumed that you can install and operate Rockbox | ||
676 | the usual way. The flashing procedure has a lot of failsafes, and will | ||
677 | check for correct model, file, etc. {}- if something is incompatible it | ||
678 | just won't flash, that's all. | ||
679 | |||
680 | Now here are the steps: | ||
681 | |||
682 | \textbf{Preparation} | ||
683 | |||
684 | Install (with all the files, not just the .ajz) and use the current | ||
685 | daily build you'd like to have. Enable any voice | ||
686 | features that are helpful throughout the process, such as menus and | ||
687 | filename spelling. Set the file view to show all files, with the menu | ||
688 | option \textbf{General Settings {}-{\textgreater} File View | ||
689 | {}-{\textgreater} Show Files} set to ``all''. | ||
690 | Have the Jukebox nicely charged to avoid | ||
691 | running out of power during the flash write. Keep the Jukebox plugged | ||
692 | into the charger until flashing is complete. | ||
693 | |||
694 | {\bfseries | ||
695 | Backup } | ||
696 | |||
697 | Backup the existing flash content. This is not an essential part of the | ||
698 | procedure, but is strongly recommended since you will need these files | ||
699 | if you wish to reverse the flashing procedure, or if you need to update | ||
700 | the bootloader (as opposed to the firmware) in the future. Keep them | ||
701 | safe! | ||
702 | |||
703 | Access the main menu by pressing F1 then select \textbf{Info | ||
704 | {}-{\textgreater} Debug}. Select the first entry, \textbf{Dump ROM | ||
705 | contents}, by pressing Play one more time. The disk should start to | ||
706 | spin. Wait for it to settle down, then plug in the USB cable to copy | ||
707 | the dump file this has just been created to your PC. The main folder of | ||
708 | your Jukebox now should contain two strange .bin files. Copy the larger | ||
709 | one named | ||
710 | \textbf{internal\_rom\_2000000{}-203FFFF.bin} | ||
711 | to a safe place, then delete them both from the box. | ||
712 | |||
713 | {\bfseries | ||
714 | Copy the new flash content file to your box } | ||
715 | |||
716 | Depending on your model (recorder, FM, V2 recorder), download one of the | ||
717 | 3 packages: | ||
718 | |||
719 | \url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_rec.zip} | ||
720 | |||
721 | \url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_fm.zip} | ||
722 | |||
723 | \url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip} | ||
724 | \url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip} | ||
725 | |||
726 | \url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_v2.zip} | ||
727 | |||
728 | \url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiosp.zip} | ||
729 | |||
730 | \url{http://joerg.hohensohn.bei.t-online.de/archos/flash/flash_ondiofm.zip} | ||
731 | |||
732 | The zip archives contain two .bin files each. Those firmware*.bin files | ||
733 | are all we want, copy them to the root directory of your box. The names | ||
734 | differ depending on the model, the flash | ||
735 | plugin will pick the right one, no way of | ||
736 | doing this wrong. | ||
737 | |||
738 | {\bfseries | ||
739 | Install the Rockbox | ||
740 | Bootloader (``formatting'' the flash)} | ||
741 | |||
742 | This procedure is only necessary the first time you flash Rockbox. | ||
743 | Unplug the USB cable again, then select \textbf{Browse | ||
744 | }\textbf{Plugins}\textbf{ } from the main menu (F1). Locate \textbf{firmware\_flash.rock}, and start it with PLAY. Rockbox now displays an info screen, press F1 to acknowledge it and start a file check. Again wait for the disk to | ||
745 | settle, then press F2 to proceed to a warning message (if the plugin | ||
746 | has exited, you don't have the proper file) and F3 to actually program | ||
747 | the file. This takes maybe 15 seconds, wait for the disk to settle | ||
748 | again. Then press a key to exit the plugin. | ||
749 | |||
750 | {\centering\itshape | ||
751 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
752 | %\includegraphics[width=3.609cm,height=2.062cm]{images/rockbox-manual-img75.png} | ||
753 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
754 | %\includegraphics[width=3.669cm,height=2.097cm]{images/rockbox-manual-img76.png} | ||
755 | \textmd{ } [Warning: Image ignored] | ||
756 | % Unhandled or unsupported graphics: | ||
757 | %\includegraphics[width=3.739cm,height=2.136cm]{images/rockbox-manual-img77.png} | ||
758 | \newline | ||
759 | Flashing boot loader in 3 easy steps | ||
760 | \par} | ||
761 | |||
762 | {\bfseries | ||
763 | \label{ref:FlashingRockbox}Install the Rockbox binary in flash} | ||
764 | |||
765 | All the above was necessary only once, although there will not be any | ||
766 | obvious difference (other than the Archos firmware loading a bit more quickly) | ||
767 | after the step above is complete. Next install the actual Rockbox firmware thatwill be used from ROM. This is how Rockbox will be updated when | ||
768 | installing a new release from now on. | ||
769 | |||
770 | \begin{itemize} | ||
771 | \item Unpack the whole build that you are installing onto the Jukebox, | ||
772 | including plugins and support files. This can be done using the Windows setup program to install the new version onto the Jukebox. | ||
773 | \item Test the build you are going to flash by playing the .ajz file so | ||
774 | that ROLO loads it up. This puts the firmware in memory without | ||
775 | changing your flash, so you can check that everything is working. If | ||
776 | you have just installed the bootloader (see above) then this will happen automatically as the existing Archos firmware loads the .ajz that you have just installed. If upgrading ROMbox, this step \textbf{must }be carried out since Rockbox cannot overwrite the ROM while it is running from it. | ||
777 | \item Play the .ucl file, which is usually found in the | ||
778 | \textbf{/.rockbox} directory, this will kick off the | ||
779 | \textbf{rockbox\_flash.rock} plugin. It's a bit | ||
780 | similar to the other one, but it's made different to | ||
781 | make the user aware. It will check the file, available size, etc. With | ||
782 | F2 it begins programming, there is no need for warning this time. If it | ||
783 | goes wrong, you'll still have the permanent image. | ||
784 | |||
785 | {\centering\itshape | ||
786 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
787 | %\includegraphics[width=3.53cm,height=2.016cm]{images/rockbox-manual-img78.png} | ||
788 | \textmd{ } [Warning: Image ignored] | ||
789 | % Unhandled or unsupported graphics: | ||
790 | %\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img79.png} | ||
791 | \newline | ||
792 | Using rockbox\_flash to update your boot firmware | ||
793 | \par} | ||
794 | \item It is possible that you could get an ``Incompatible | ||
795 | Version'' error if the plugin interface has changed since | ||
796 | you last flashed Rockbox. This means you are running an | ||
797 | ``old'' copy of Rockbox, but are trying to | ||
798 | execute a newer plugin, the one you just downloaded. The easiest | ||
799 | solution is to ROLO into this new version, | ||
800 | by playing the\textbf{ ajbrec.ajz }file. Then you are consistent and can play | ||
801 | \textbf{rockbox.ucl}. | ||
802 | \item When done, you can restart the box and hopefully your new Rockbox | ||
803 | image. | ||
804 | \end{itemize} | ||
805 | UCLs for the latest Recorder and FM firmware are included in Rockbox 2.4 | ||
806 | and also the daily builds. | ||
807 | |||
808 | \subsection{\label{ref:KnownIssuesAndLimits}Known Issues and Limitations} | ||
809 | There are two variants as to how the Jukebox starts, which is why there | ||
810 | are normal and \_norom firmware files. The vast majority of Jukeboxes | ||
811 | all have the same boot ROM content, but some have different flash | ||
812 | content. Rockbox identifies this boot ROM with a CRC value of 0x222F in | ||
813 | the hardware info screen. Some recorders have the boot ROM disabled (it | ||
814 | might be unprogrammed) and start directly from a flash mirror at | ||
815 | address zero. They need the \_norom firmware, it has a slightly | ||
816 | different bootloader. Without a boot ROM there is no UART boot safety | ||
817 | net. To compensate for that as much as possible the MiniMon monitor is | ||
818 | included, and can be started by pressing F3+ON. Using this the box can | ||
819 | be reprogrammed via serial if the UART mod has been applied and the | ||
820 | first \~{}2000 bytes of the flash are OK. | ||
821 | |||
822 | \subsubsection{ROMbox} | ||
823 | ROMbox is a flashable version of Rockbox that is | ||
824 | uncompressed and runs directly from the flash chip rather than being | ||
825 | copied into memory first. The advantage of this is that memory that | ||
826 | would normally be used for storing the Rockbox code can be used for | ||
827 | buffering MP3s instead, resulting in less disk | ||
828 | spin{}-ups and therefore longer battery life | ||
829 | Unfortunately being uncompressed, ROMbox requires more space in flash | ||
830 | than Rockbox and will therefore not fit in the space that is left on an | ||
831 | FM recorder. ROMbox therefore runs on the V1 and V2 recorder models | ||
832 | only. | ||
833 | |||
834 | The procedure for flashing ROMbox is identical to the procedure for | ||
835 | flashing Rockbox as laid out on page \pageref{ref:FlashingRockbox}. | ||
836 | The only difference is that the file to install is called | ||
837 | \textbf{rombox.ucl}. ROMbox is included automatically with rockbox 2.4 | ||
838 | and all the current daily builds, so the procedure is identical | ||
839 | otherwise. | ||
840 | |||
diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex new file mode 100644 index 0000000000..7e984f4217 --- /dev/null +++ b/manual/configure_rockbox/main.tex | |||
@@ -0,0 +1,615 @@ | |||
1 | \chapter{Configuring Rockbox} | ||
2 | \newpage | ||
3 | |||
4 | \section{Sound Settings} | ||
5 | {\centering\itshape | ||
6 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
7 | %\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img32.png} | ||
8 | \textmd{ } [Warning: Image ignored] | ||
9 | % Unhandled or unsupported graphics: | ||
10 | %\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img33.png} | ||
11 | \newline | ||
12 | Recorder sound settings Player sound settings | ||
13 | \par} | ||
14 | |||
15 | This menu offers a selection of sound properties you may change to | ||
16 | improve your sound experience. | ||
17 | |||
18 | \begin{itemize} | ||
19 | \item \textbf{Volume} | ||
20 | |||
21 | The sound volume your music is played at. Although settable range is | ||
22 | 0{}-100\%, many units don't produce audible output | ||
23 | below 40\%. On Recorders, volume settings above 92\% will cause | ||
24 | distortion (clipping) and are not recommended. | ||
25 | |||
26 | \item \textbf{Bass} | ||
27 | This emphasises or suppresses the lower | ||
28 | (bass) sounds in the track. 0 means that bass sounds are unaltered | ||
29 | (flat response). | ||
30 | |||
31 | \item \textbf{Treble} | ||
32 | This emphasises or suppresses the higher | ||
33 | (treble) sounds in the track. 0 means that treble sounds are unaltered | ||
34 | (flat response). | ||
35 | |||
36 | \item \textbf{Balance} | ||
37 | How much of the volume is generated by the left or right channel of the | ||
38 | sound. The default, 0, means that the left and right outputs are equal | ||
39 | in volume. Negative numbers increase the volume of the left channel | ||
40 | relative to the right, positive numbers increase the volume of the | ||
41 | right channel relative to the left. | ||
42 | |||
43 | \item \textbf{Channels} | ||
44 | |||
45 | This option controls the on{}-board mixing | ||
46 | facilities of the Jukebox. A stereo audio signal consists of two | ||
47 | channels, left and right. Available options are | ||
48 | |||
49 | \begin{itemize} | ||
50 | \item \textbf{Mono Left: }Plays the left channel in both stereo channels. | ||
51 | \item \textbf{Mono Right:} Plays the right channel in both stereo channels. | ||
52 | \item \textbf{Mono:} Mix both channels down to mono and send the mixed signal | ||
53 | back to both. | ||
54 | \item \textbf{Stereo:} Do not mix the signal | ||
55 | \item \textbf{Stereo Narrow: }Mixes small amounts of the opposite channel into | ||
56 | the left and right channels, thus making the sound seem closer | ||
57 | together. | ||
58 | \item \textbf{Stereo Wide:} Elements of one channel that are present in the | ||
59 | opposite channel are removed from the latter. This results in the | ||
60 | sound seeming further apart. | ||
61 | \item \textbf{Karaoke:} Removes all sound that is the same in both channels. | ||
62 | Since most vocals are recorded in this way to make the artist sound | ||
63 | central, this often (but not always) has the effect of removing the | ||
64 | voice track from a song. | ||
65 | \end{itemize} | ||
66 | |||
67 | \item \textbf{Loudness (Recorder only)} | ||
68 | Loudness is an effect which emphasises bass and treble. This makes the | ||
69 | track seem louder by amplifying the frequencies that the human ear | ||
70 | finds hard to hear. Frequencies in the vocal range are unaffected, | ||
71 | since the human ear picks these up very easily. | ||
72 | |||
73 | \item \textbf{Auto Volume (Recorder only)} | ||
74 | Auto volume is a feature that automatically lowers the volume on loud | ||
75 | parts, and then slowly restores the volume to the previous level over a | ||
76 | time interval. That time interval is configurable here. Short values | ||
77 | like 20ms are useful for ensuring a constant volume for in car use and | ||
78 | other applications where background noise makes a constant loudness | ||
79 | desirable. A longer timeout means that the change in volume back to | ||
80 | the previous level will be smoother, so there will be less sharp | ||
81 | changes in volume level. | ||
82 | |||
83 | \item \textbf{Super Bass (Recorder Only)} | ||
84 | This setting changes the threshold at which bass frequencies are | ||
85 | affected by the \textbf{Loudness} setting, making the sound of drums | ||
86 | and bass guitar louder in comparison to the rest of the track. This | ||
87 | setting only has an effect if \textbf{Loudness} is set to a value | ||
88 | larger than 0dB. | ||
89 | |||
90 | \item \textbf{MDB {}- Micronas Dynamic Bass (Recorder Only)} | ||
91 | The rest of the parameters on this menu relate to the Micronas Dynamic | ||
92 | Bass (MDB) function. This is designed to enable the user to hear bass | ||
93 | notes that the headphones and/or speakers are not capable of | ||
94 | reproducing. Every tone has a fundamental frequency (the ``main tone'') and also several harmonics, which are related to that tone. The human brain has a | ||
95 | mechanism whereby it can actually infer the presence of bass notes from | ||
96 | the higher harmonics that they would generate.\\ | ||
97 | |||
98 | The practical upshot of this is that MDB produces a more authentic | ||
99 | sounding bass by tricking the brain in believing it's | ||
100 | hearing tones that the headphones or speakers aren't | ||
101 | capable of reproducing. Try it and see what you think.\\ | ||
102 | |||
103 | The MDB parameters are as follows. | ||
104 | |||
105 | \begin{itemize} | ||
106 | \item \textbf{MDB enable: } This turns the MDB feature on or off. For many | ||
107 | users this will be the only setting they need, since Rockbox picks | ||
108 | sensible defaults for the other parameters. MDB is turned off by | ||
109 | default. | ||
110 | \item \textbf{MDB strength:} How loud the harmonics generated by the MDB will | ||
111 | be. | ||
112 | \item \textbf{MDB Harmonics}: The percentage of the low notes that is | ||
113 | converted into harmonics. If low notes are causing speaker distortion, | ||
114 | this can be set to 100\% to eliminate the fundamental completely and | ||
115 | only produce harmonics in the signal. If set to 0\% this is the same | ||
116 | as turning the MDB feature off. | ||
117 | \item \textbf{MDB Centre Frequency: }The cutoff frequency of your headphones or speakers. This is usually given in the specification for the headphones/speakers. | ||
118 | \item \textbf{MDB shape: }It is recommended that this parameter be set to 1.5 | ||
119 | times the centre frequency.\\ | ||
120 | |||
121 | This is the frequency up to which harmonics are generated. Some of the | ||
122 | lower fundamentals near the cut{}-off range | ||
123 | will have their lower harmonics cut off, since they will be below the | ||
124 | range of the speakers. Fundamentals between the | ||
125 | cut{}-off frequency and the lower frequency will have their harmonics proportionally boosted to compensate and restore the 'loudness' of these | ||
126 | notes.\\ | ||
127 | |||
128 | For most users, the defaults should provide an improvement in sound | ||
129 | quality and can be safely left as they are. For reference, the | ||
130 | defaults Rockbox uses are: | ||
131 | |||
132 | |||
133 | \begin{tabular}[c]{|p{4.5290003cm}|p{1.56cm}|} | ||
134 | \hline | ||
135 | {\centering\bfseries\itshape | ||
136 | Setting | ||
137 | \par} | ||
138 | & | ||
139 | {\centering\bfseries\itshape | ||
140 | Value | ||
141 | \par} | ||
142 | \\\hline | ||
143 | {\centering\upshape | ||
144 | MDB Strength | ||
145 | \par} | ||
146 | & | ||
147 | 50dB | ||
148 | \\\hline | ||
149 | {\centering\upshape | ||
150 | MDB Harmonics | ||
151 | \par} | ||
152 | & | ||
153 | 48\% | ||
154 | \\\hline | ||
155 | {\centering\upshape | ||
156 | MDB Centre Frequency | ||
157 | \par} | ||
158 | & | ||
159 | 60Hz | ||
160 | \\\hline | ||
161 | {\centering\upshape | ||
162 | MDB Shape | ||
163 | \par} | ||
164 | & | ||
165 | 90Hz | ||
166 | \\\hline | ||
167 | \end{tabular} | ||
168 | |||
169 | \end{itemize} | ||
170 | \end{itemize} | ||
171 | |||
172 | \section{\label{ref:GeneralSettings}General Settings} | ||
173 | {\centering\mdseries\itshape | ||
174 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
175 | %\includegraphics[width=3.822cm,height=2.184cm]{images/rockbox-manual-img34.png} | ||
176 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
177 | %\includegraphics[width=4.667cm,height=1.963cm]{images/rockbox-manual-img35.png} | ||
178 | \newline | ||
179 | Recorder general settings Player general settings | ||
180 | \par} | ||
181 | |||
182 | \subsubsection{\label{ref:PlaybackOptions}Playback Options} | ||
183 | This menu is for configuring settings related to MP3 playback | ||
184 | |||
185 | \begin{itemize} | ||
186 | \item \textbf{Shuffle} | ||
187 | Select shuffle ON/OFF. This alters how Rockbox will select which next | ||
188 | song to play. | ||
189 | \item \textbf{Repeat} | ||
190 | Repeat modes are Off/One/All. ``Off'' means no | ||
191 | repeat. ``One'' means repeat one track over | ||
192 | and over. ``All'' means repeat playlist/directory. | ||
193 | \item \item{Play Selected First } | ||
194 | This setting controls what happens when you press PLAY on a file in a | ||
195 | directory and shuffle mode is on. If this setting is Yes, the file you | ||
196 | selected will be played first. If this setting is No, a random file in | ||
197 | the directory will be played first. | ||
198 | \item \textbf{Resume} | ||
199 | Sets whether Rockbox will resume playing at the point where you shut | ||
200 | off. Options are: Ask/Yes/No/Ask once. | ||
201 | ``Ask'' means it will ask at boot time. ``Yes'' means it will unconditionally try to resume. ``No'' means it will not resume. ``Ask once'' will erase the resume info if you answer no, and thus not ask you again. | ||
202 | \item \textbf{FFwd / Rewind} | ||
203 | Two options are available at this point | ||
204 | |||
205 | \begin{itemize} | ||
206 | \item \textbf{FF/RW Min Step} | ||
207 | The smallest step, in seconds, you want to fast forward or rewind in a | ||
208 | track. | ||
209 | \item \textbf{FF/RW Accel} | ||
210 | How fast you want search (ffwd/rew) to accelerate when you hold | ||
211 | down the button. ``Off'' means no acceleration. ``2x/1s'' means double the | ||
212 | search speed once every second the button is held. ``2x/5s'' means double the search speed once every 5 seconds the button is held. | ||
213 | \end{itemize} | ||
214 | |||
215 | \item \textbf{Anti{}-skip Buffer} | ||
216 | This setting is really ``extra anti{}-skip''. It lets you set | ||
217 | a timer for how many seconds earlier than normally necessary the disk | ||
218 | should spin up and start reading data. You don't need | ||
219 | this unless you shake and bump the unit a lot. Spinning up the disk | ||
220 | earlier than necessary naturally drains the batteries a little extra. | ||
221 | Most users will not need this setting. | ||
222 | |||
223 | \item \textbf{Fade on Stop/Pause} | ||
224 | This setting enables and disables a fade effect when you pause | ||
225 | or stop playing a song. Fade is a progressive increase or reduction of | ||
226 | volume, from your set volume to 0, and vice versa. | ||
227 | |||
228 | \item \textbf{ID3 tag priority} | ||
229 | ID3 tags in an MP3 file contain information about the artist, title, | ||
230 | album etc. of the track. This option controls whether Rockbox uses the information from ID3v2 tags in preference to that from ID3v1 tags when both types of tag are present. | ||
231 | \end{itemize} | ||
232 | |||
233 | \subsection{File View} | ||
234 | This menu deals with options relating to how the file browser displays | ||
235 | files | ||
236 | |||
237 | \begin{itemize} | ||
238 | \item \textbf{Sort Case Sensitive} | ||
239 | If this option is enabled files that start with a | ||
240 | lower case letter will appear after the files that start with an upper case letter have all been listed If disabled, then case will be ignored when sorting files. | ||
241 | \item \textbf{Sort Directories} | ||
242 | This option controls how Rockbox sorts folders. The default is to sort | ||
243 | them alphabetically. ``By date'' sorts them with the oldest folder | ||
244 | first. ``By newest date'' sorts them with the newest folder first. | ||
245 | |||
246 | \item \textbf{Sort Files} | ||
247 | This option controls how Rockbox sorts files. In addition to the | ||
248 | options for directory sorting above, there is a ``By type'' option | ||
249 | which sorts files alphabetically by their type (such as .mp3) then | ||
250 | alphabetically within each type. | ||
251 | |||
252 | \item \textbf{\label{ref:ShowFiles}Show Files} | ||
253 | Controls which files are displayed in the directory browser: | ||
254 | |||
255 | \begin{itemize} | ||
256 | \item \textbf{Music: } | ||
257 | Only directories, .mp3, .mp2, .mpa and .m3u files | ||
258 | are shown. Extensions are strippe'd. Files anddirectories starting with . Or with the ``hidden'' flag set are hidden. | ||
259 | \item \textbf{Playlists:} | ||
260 | Only shows directories and playlists, for | ||
261 | simplified navigation. | ||
262 | \item \textbf{Supported:} | ||
263 | All directories and files Rockbox understands (see page \pageref{ref:Supportedfileformats}) are shown. Files and directories starting with . or with the | ||
264 | ``hidden'' flag set are hidden. | ||
265 | \item \textbf{All:} | ||
266 | All files and directories are shown. Extensions are shown. No files or | ||
267 | directories arehidden | ||
268 | \end{itemize} | ||
269 | |||
270 | \item \textbf{Follow Playlist} | ||
271 | If Follow Playlist is set to ``Yes'', you will find yourself in the same | ||
272 | directory as the currently playing file if you go to the Directory | ||
273 | Browser from the WPS. If set to ``No'', you will stay in the same directory as you were last in. | ||
274 | |||
275 | \item \textbf{Show Icons} | ||
276 | This indicates whether Rockbox will display an icon representing what | ||
277 | type a file is on the left of the file in the browser. For details of | ||
278 | these icons, please see page \pageref{ref:Supportedfileformats}. | ||
279 | \end{itemize} | ||
280 | |||
281 | \subsection{\label{ref:Displayoptions}Display Options} | ||
282 | |||
283 | \begin{itemize} | ||
284 | \item \textbf{Browse fonts} | ||
285 | Browse the fonts that reside in your \textbf{/.rockbox} directory. | ||
286 | Selecting one will activate it. See page \pageref{ref:Loadingfonts} for further details about fonts. | ||
287 | |||
288 | \item \textbf{Browse WPS files} | ||
289 | Opens the file browser in the \textbf{/.rockbox} directory and displays | ||
290 | all .wps files. Selecting one will activate it, stop will exit back to | ||
291 | the menu.\\ | ||
292 | |||
293 | For further information about the WPS see page \pageref{ref:WPS}. For | ||
294 | information about editing a .wps file see page \pageref{ref:ConfiguringtheWPS}. | ||
295 | |||
296 | \item \textbf{LCD Settings} | ||
297 | |||
298 | %\begin{itemize} | ||
299 | This submenu contains settings that relate to the display of the | ||
300 | Jukebox. | ||
301 | \item \textbf{Backlight:} | ||
302 | How long the backlight shines after a key | ||
303 | press. Set to OFF to never light it, set to ON to never shut it off or | ||
304 | set a preferred timeout period. | ||
305 | \item \textbf{Backlight on WhenPlugged:} | ||
306 | This option turns the backlight on constantly while the charger cable is connected. | ||
307 | \item \textbf{Caption Backlight:} This option turns the backlight on for | ||
308 | 25 seconds either side of the start of a new track so that the display | ||
309 | can be read to see song information. | ||
310 | \item \textbf{Contrast:} Changes the contrast of your LCD display. | ||
311 | Warning: Setting the contrast too dark or too light can make it hard to | ||
312 | find this menu option again! | ||
313 | \item \textbf{LCD Mode} (Recorder only): This setting lets you invert | ||
314 | the whole screen, so now you get a black background and green text | ||
315 | graphics. | ||
316 | \item \textbf{Upside Down: }Displays the screen so that the top of the | ||
317 | display is nearest the buttons. This is sometimes useful when carrying | ||
318 | the Recorder in a pocket for easy access to the headphone socket. | ||
319 | \item \textbf{Line Selector: }Select this option to have a bar of | ||
320 | inverted text (``Bar'' option) mark the current line in the File | ||
321 | Browser rather than the default arrow to the left (``Pointer'' option). | ||
322 | This gives slightly more room for filenames. | ||
323 | %\end{itemize} | ||
324 | |||
325 | \item \textbf{Scrolling} | ||
326 | This feature controls how text will scroll in Rockbox. You can configure | ||
327 | the following parameters: | ||
328 | |||
329 | \begin{itemize} | ||
330 | \item \textbf{Scroll Speed:} | ||
331 | Controls how many times per second the scrolling text moves a step. | ||
332 | \item \textbf{Scroll StartDelay:} | ||
333 | Controls how many milliseconds Rockbox should wait before a new text begins scrolling. | ||
334 | \item \textbf{Scroll Step Size:} | ||
335 | Controls how many pixels the text scroll should move for each step. (Recorder/Ondio only) | ||
336 | \item \textbf{Bidirectional Scroll Limit: } | ||
337 | Rockbox has two different scroll methods, always scrolling the text to the left, and when the line has ended, beginning again at the start, or moving to the | ||
338 | left until you can read the end of the line, and scroll right until you | ||
339 | see the beginning again. Rockbox chooses which method it should use, | ||
340 | depending of how much it has to scroll left. This setting lets you tell | ||
341 | Rockbox where that limit is, expressed in percentage of line length. | ||
342 | \end{itemize} | ||
343 | |||
344 | \item \textbf{Status/Scrollbar (Recorder only)} | ||
345 | Settings related to on screen status display and the scrollbar. | ||
346 | |||
347 | \begin{itemize} | ||
348 | \item \textbf{Scroll Bar: }Enables or disables the scroll bar at the | ||
349 | left. | ||
350 | \item \textbf{Status Bar: }Enables or disables the status bar | ||
351 | at the upper side. | ||
352 | \item \textbf{Button Bar:} Enables or disables the button bar prompts | ||
353 | for the F keys at the bottom of the screen. | ||
354 | \item \textbf{Volume Display:} Controls whether the volume is displayed | ||
355 | as a graphic or a numerical percentage value on the Status Bar. | ||
356 | \item \textbf{Battery Display: }Controls whether the battery charge | ||
357 | status is displayed as a graphic or numerical percentage value on the | ||
358 | Status Bar. | ||
359 | \end{itemize} | ||
360 | |||
361 | \item \textbf{Peak Meter (Recorder only) } | ||
362 | The peak meter can be configured with a number of parameters. (For a description of the peak meter see page \pageref{ref:Peakmeter}.) | ||
363 | |||
364 | \begin{itemize} | ||
365 | \item \textbf{Peak Release:} | ||
366 | This determines how fast the bar shrinks when the music becomes softer. | ||
367 | Lower values make the peak meter look smoother. | ||
368 | \item \textbf{Peak Hold Time:} | ||
369 | Specifies the time after which the peak indicator will reset. If you set this value e.g. to 5s then the peak indicator displays the loudest volume value | ||
370 | that occurred within the last 5 seconds. Big values are good if you | ||
371 | want to find the peak level of a song, which might be of interest when | ||
372 | copying music from the jukebox via the analogue output to some other | ||
373 | recording device. | ||
374 | \item \textbf{Clip Hold Time:} | ||
375 | How long the clipping indicator will be visible after clipping was detected | ||
376 | \item \textbf{Performance:} | ||
377 | In high performance mode, the peak meter is updated as often as possible. This reduces the chance of missing a peak value, making the peak meter more precise. In energy save mode the peak meter is updated just often enough to look fluid. | ||
378 | This reduces the load on the CPU and thus saves a little bit of energy. If you crave every second of runtime for your jukebox or simply use the peak meter as a screen effect, the use of energy save mode is recommended. If you want to use | ||
379 | the peak meter as a measuring instrument you'll want to use high performance mode. | ||
380 | \item \textbf{Scale:} | ||
381 | Select whether the peak meter displays linear or logarithmic values. In | ||
382 | ``dB'' (decibel) scale the volume values are scaled logarithmically. | ||
383 | This very similar to the perception of loudness. The volume meters of | ||
384 | digital audio devices usually are scaled this way. If you are | ||
385 | interested in the power level that is applied to your headphones you | ||
386 | should choose ``linear'' display. Unfortunately this value | ||
387 | doesn't have real units like volts or watts since that | ||
388 | depends on the phones. So they can only be displayed as percentage | ||
389 | values. | ||
390 | \item \textbf{Minimum and maximum range:} These two options define the | ||
391 | full value range that the peak meter displays. Recommended values for | ||
392 | dbFs are {}-40 for min. and 0 for maximum. For linear display, use 0 | ||
393 | and 100\%. Note that {}-40 dbFs is approximately 1\% in linear value, | ||
394 | but if you change the minimum setting in linear mode slightly and then change to dbFs there will be a large change. You can use these values for | ||
395 | 'zooming' into the peak meter. | ||
396 | \end{itemize} | ||
397 | \end{itemize} | ||
398 | |||
399 | \subsubsection{\label{ref:SystemOptions}System Options} | ||
400 | |||
401 | \begin{itemize} | ||
402 | \item \textbf{Battery} | ||
403 | Options relating to the batteries in the Jukebox unit. | ||
404 | \begin{itemize} | ||
405 | \item \textbf{Battery Capacity} can be used to tell the Jukebox what | ||
406 | capacity (in mAh) of battery is being used inside it. The default is | ||
407 | 1500mAh for NiMH battery based units, and 2300mAh for LiOn battery | ||
408 | based units, which is the capacity value for the standard batteries | ||
409 | shipped with these units. This value is used for calculating remaining | ||
410 | battery life. | ||
411 | \item \textbf{Deep discharge (Non{}-FM recorder only)} | ||
412 | Set this to ON if you intend to keep your charger connected for a long | ||
413 | period of time. It lets the batteries go down to 10\% before starting | ||
414 | to charge again. Setting this to OFF will cause the charging to restart | ||
415 | on 95\%. | ||
416 | \item \textbf{Trickle Charge (Non{}-FM recorder only)} | ||
417 | The Jukebox cannot be turned off while the charger is connected. | ||
418 | Therefore, trickle charge is needed to keep the batteries full after | ||
419 | charging has completed. For more in depth information about charging | ||
420 | see Battery FAQ in your \textbf{/.rockbox/docs }directory. | ||
421 | \end{itemize} | ||
422 | |||
423 | \item \textbf{Disk} | ||
424 | Options relating to the hard disk. | ||
425 | |||
426 | \begin{itemize} | ||
427 | \item \textbf{DiskSpindown:} | ||
428 | Rockbox has a timer that makes it spin down the hard disk after being idle for acertain time. You can modify this timeout here. This idle time is only | ||
429 | affected by user activity, like navigating through file browser. When | ||
430 | the hard disk spins up to fill mp3 buffer, it automatically spins down | ||
431 | afterwards. | ||
432 | \item \textbf{Disk Poweroff:}(non v2/FM{}-recorder only) | ||
433 | Whether the disk is powered OFF or only set to ``sleep'' when spun | ||
434 | down. Power off uses less power but takes longer to spin{}-up. | ||
435 | \end{itemize} | ||
436 | |||
437 | \item \textbf{Time and Date (Recorder Only)} | ||
438 | Time related menu options. | ||
439 | |||
440 | \begin{itemize} | ||
441 | \item \textbf{Set Time/Date: } | ||
442 | Set current time and date. | ||
443 | \item \textbf{Time Format: } | ||
444 | Choose 12 or 24 Hour clock. | ||
445 | \end{itemize} | ||
446 | |||
447 | \item \textbf{\label{ref:idlepoweroff}Idle Poweroff} | ||
448 | Rockbox can be configured to turn off power after the unit has been idle | ||
449 | for a defined number of minutes. The unit is idle when playback is | ||
450 | stopped or paused. It is not idle while the USB or charger is | ||
451 | connected, or while recording. | ||
452 | |||
453 | \item \textbf{Sleep Timer} | ||
454 | This option lets you power off your jukebox after playing for a given | ||
455 | time. This setting is reset on boot. Using this option disables the | ||
456 | \textbf{Wake up alarm} (see below). | ||
457 | |||
458 | \item \textbf{Wake up alarm (Recorder v2/FM only)} | ||
459 | This option turns the Jukebox off and then starts it up again at the | ||
460 | specified time. This is most useful when combined with the Resume | ||
461 | setting in the Playback options set to ``Yes'', so that the Jukebox | ||
462 | wakes up and immediately starts playing music. Use LEFT and RIGHT to | ||
463 | adjust the minutes setting, UP and DOWN to adjust the HOURS. PLAY | ||
464 | confirms the alarm and shuts your Jukebox down, and STOP cancels | ||
465 | setting an alarm. If the Jukebox is turned on again before the alarm | ||
466 | occurs the alarm will be canceled. Using this option disables the \textbf{Sleep Timer} (see above). | ||
467 | |||
468 | \item \textbf{Limits} | ||
469 | This submenu relates to limits in the Rockbox operating system. | ||
470 | |||
471 | \begin{itemize} | ||
472 | \item \textbf{Max files in dir browser: }Configurable limit of files in | ||
473 | the directory browser (file buffer size). You can configure the size to | ||
474 | be between 50 and 10000 files in steps of 50 files. The default is 400, | ||
475 | higher values will shorten the music buffer.\\ | ||
476 | |||
477 | Note: the device must be rebooted for settings to take effect! | ||
478 | \item \textbf{Max playlist size: }Option to configure the maximum size | ||
479 | of a playlist. The playlist size can be between 1000 and 20000 files in | ||
480 | steps of 1000. By default it is 10000. Higher values will shorten the | ||
481 | music buffer.\\ | ||
482 | |||
483 | Note: the device must be rebooted for settings to take effect! | ||
484 | \end{itemize} | ||
485 | |||
486 | \item \textbf{Car Adapter Mode} | ||
487 | This option turns on and off the car ignition auto stop | ||
488 | function. | ||
489 | |||
490 | When using the Jukebox in a car, car adapter mode automatically stops | ||
491 | playback on the Jukebox when power (i.e. from cigarette lighter power | ||
492 | adapter) to the external DC in jack is turned off. | ||
493 | |||
494 | When the external power off condition is detected, the Car Adapter Mode | ||
495 | function only pauses the playback. In order to shut down the Jukebox | ||
496 | completely the \textbf{Idle Poweroff} function (see above) must also be | ||
497 | set. | ||
498 | |||
499 | If power to the DC in jack is turned back on before the \textbf{Idle | ||
500 | Poweroff} function has shut the Jukebox off, playback will be resumed | ||
501 | 5 seconds after the power is applied. This delay is to allow for the | ||
502 | time while the car engine is being started. Once the Jukebox is shut | ||
503 | off either manually, or automatically with the \textbf{Idle Poweroff | ||
504 | }function, it must be powered up manually to resume playback. | ||
505 | |||
506 | \item \textbf{Line In (Player only)} | ||
507 | This option activates the line in port on Jukebox Player, which | ||
508 | is off by default. | ||
509 | |||
510 | This is useful for such applications as: | ||
511 | \begin{itemize} | ||
512 | \item Game boy {}-{\textgreater} Jukebox {}-{\textgreater} human | ||
513 | \item laptop {}-{\textgreater} Jukebox {}-{\textgreater}human | ||
514 | \item LAN party computer {}-{\textgreater} Jukebox {}-{\textgreater} human | ||
515 | \end{itemize} | ||
516 | |||
517 | \item \textbf{Manage settings} | ||
518 | This submenu deals with loading and saving settings. | ||
519 | |||
520 | \begin{itemize} | ||
521 | \item \textbf{Browse .cfg Files: } | ||
522 | This displays a list of configuration | ||
523 | (.cfg) files stored in the \textbf{/.rockbox} system directory. This | ||
524 | is useful if the Jukebox is plugged into more than one different output | ||
525 | device (e.g. headphones, computer, car stereo, hi{}-fi) so that a settings file can be maintained for each. | ||
526 | \item \textbf{Browse Firmwares:} This displays a list of firmware (.mod | ||
527 | for Players and .ajz for Recorders) file in the \textbf{/.rockbox} system directory. Playing a firmware file loads it into memory. Thus it is possible to | ||
528 | run the original Archos firmware or a different version of Rockbox from | ||
529 | here assuming that you have the right files installed on your disk. | ||
530 | \item \textbf{Reset Settings: }This wipes the saved settings in the | ||
531 | Jukebox and resets all settings to their default values. | ||
532 | \item \textbf{Write .cfg file: }Saves the current settings into a .cfg | ||
533 | file for later use with \textbf{Browse .cfg Files} above. | ||
534 | \end{itemize} | ||
535 | |||
536 | \end{itemize} | ||
537 | |||
538 | \subsubsection{\label{ref:Bookmarkconfigactual}Bookmarking} | ||
539 | |||
540 | \begin{itemize} | ||
541 | \item \textbf{Bookmark on Stop} | ||
542 | Write a bookmark to the disk whenever the stop key is pressed. If | ||
543 | playback is stopped it can be resumed easily at a later time. The | ||
544 | \textbf{Resume} function remembers your position in the most | ||
545 | recently accessed track regardless of this setting. | ||
546 | \item \textbf{Load Last Bookmark} | ||
547 | When this is on, Rockbox automatically returns to the position of the | ||
548 | last bookmark within a file when it is played. If set to Ask, Rockbox | ||
549 | will ask the user whether they want to start from the beginning or the | ||
550 | bookmark. When set to no, playback always starts from the beginning | ||
551 | and the Bookmark file must be played or \textbf{Load Bookmark} selected | ||
552 | from the \textbf{Bookmarks} submenu of the Main Menu while the file is | ||
553 | playing. | ||
554 | \item \textbf{Maintain a list of Recently Used Bookmarks} | ||
555 | If this option is turned on, Rockbox will store a list of Bookmarks that | ||
556 | have been accessed recently. This is then accessible from the | ||
557 | \textbf{Recent Bookmarks} option of the \textbf{Bookmarks} submenu of | ||
558 | the Main Menu. | ||
559 | \end{itemize} | ||
560 | |||
561 | \subsection{\label{ref:Language}Language} | ||
562 | This setting controls the language of the Rockbox user interface. | ||
563 | Selecting a language will activate it. The language files must be in | ||
564 | the \textbf{/.rockbox/lang/} directory. | ||
565 | |||
566 | See page \pageref{ref:Loadinglanguages} for further details about | ||
567 | languages. | ||
568 | |||
569 | \subsection{Voice} | ||
570 | |||
571 | \begin{itemize} | ||
572 | \item \textbf{Voice Menus} | ||
573 | This option turns on the Voice User Interface, which will read out menu items and settings as they are selected by the cursor. In order for this to work, a voice file must be present in the \textbf{/.rockbox/lang/} directory on the recorder. Voice files are large (1.5MB) and are not shipped with Rockbox by | ||
574 | default. | ||
575 | |||
576 | The voice file is the name of the language for which it is made, | ||
577 | followed by the extension .voice. So for English, the file name would | ||
578 | be \textbf{english.voice}. | ||
579 | |||
580 | This option is on by default. It will do nothing unless the appropriate | ||
581 | .voice file is installed in the correct place on the Jukebox. | ||
582 | |||
583 | \begin{itemize} | ||
584 | \item \textbf{Limitations} | ||
585 | \begin{itemize} | ||
586 | \item Setting the Sound Option \textbf{Channels} to ``karaoke'' may | ||
587 | disable voice menus. | ||
588 | \item Plugins and the wake up alarm do not support voice features. | ||
589 | \end{itemize} | ||
590 | |||
591 | \item \textbf{Voice Directories} | ||
592 | This option turns on the speaking of directory names. The Jukebox is | ||
593 | not powerful enough to produce these voices in real time, so a number of options are available. | ||
594 | |||
595 | \begin{itemize} | ||
596 | \item \textbf{.talk mp3 clip: } | ||
597 | Use special pre{}-recorded MP3 files (\textbf{\_dirname.talk}) in each directory. These must be generated in advance, and are typically produced synthetically using a text to speech engine on a PC. If no such file exists, the output is as for the ``numbers'' option below. | ||
598 | \item \textbf{Spell: } | ||
599 | Speak the directory name by spelling it out letter | ||
600 | by letter. Support is provided only for the most common letters and | ||
601 | punctuation. | ||
602 | \item \textbf{Numbers: } | ||
603 | Each directory is assigned a number based upon its position in the file list. They are then announced as ``Directory 1'', ``Directory 2'' etc. | ||
604 | \item \textbf{Off: } | ||
605 | No attempt will be made to speak directory names. | ||
606 | \end{itemize} | ||
607 | |||
608 | \item \textbf{Voice Filenames} | ||
609 | This option turns on the speaking of directory names. The options | ||
610 | provided are ``Spell'', ``Numbers'', and ``Off'' which function the same as for \textbf{Voice Directories} and ``.talk mp3 clip'', which functions as above except that the files are named with the same name as the music file (e.g. \textbf{Punkadiddle.mp3 } would require a file called \textbf{Punkadiddle.mp3.talk}). | ||
611 | \end{itemize} | ||
612 | \end{itemize} | ||
613 | See | ||
614 | \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceHowto} for more details on configuring speech support in Rockbox. | ||
615 | |||
diff --git a/manual/getting_started/archos_choice.tex b/manual/getting_started/archos_choice.tex new file mode 100644 index 0000000000..1c3944455b --- /dev/null +++ b/manual/getting_started/archos_choice.tex | |||
@@ -0,0 +1,139 @@ | |||
1 | \section{Before installation} | ||
2 | |||
3 | Before you install Rockbox, you will need to know what model of Archos | ||
4 | Jukebox you own. Rockbox comes in different versions depending on the | ||
5 | model of your Jukebox. There are six different versions of the | ||
6 | software. The table below will help you to identify which version of | ||
7 | the software you need. | ||
8 | |||
9 | The model name is printed on the case. The hard drive size is listed on | ||
10 | the serial number sticker on the back of the unit. | ||
11 | |||
12 | \begin{minipage}{16.589cm} | ||
13 | \begin{center}\begin{tabular}{|p{1.846cm}|p{5.6280003cm}|p{6.053cm}|p{2.195cm}|} | ||
14 | \hline | ||
15 | {\centering\bfseries\itshape | ||
16 | \label{ref:Jukeboxtypetable}Picture | ||
17 | \par} | ||
18 | & | ||
19 | {\centering\bfseries\itshape | ||
20 | DISK size | ||
21 | \par} | ||
22 | & | ||
23 | {\centering\bfseries\itshape | ||
24 | Model Name | ||
25 | \par} | ||
26 | & | ||
27 | {\centering\bfseries\itshape | ||
28 | Version Name | ||
29 | \par} | ||
30 | \\\hline | ||
31 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
32 | %\includegraphics[width=2.117cm,height=2.858cm]{images/rockbox-manual-img2.jpg} | ||
33 | |||
34 | & | ||
35 | {\centering | ||
36 | 5GB, 6GB, 10GB, 20GB | ||
37 | \par} | ||
38 | & | ||
39 | {\centering | ||
40 | Jukebox 5000,\newline | ||
41 | Jukebox 6000,\newline | ||
42 | Jukebox Studio 10,\newline | ||
43 | Jukebox Studio 20 | ||
44 | \par} | ||
45 | & | ||
46 | {\centering | ||
47 | player | ||
48 | \par} | ||
49 | \\\hline | ||
50 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
51 | %\includegraphics[width=2.117cm,height=2.822cm]{images/rockbox-manual-img3.jpg} | ||
52 | |||
53 | & | ||
54 | {\centering | ||
55 | 6GB, 10GB, 15GB, 20GB | ||
56 | \par} | ||
57 | & | ||
58 | {\centering | ||
59 | Jukebox Recorder 6,\newline | ||
60 | Jukebox Recorder 10,\newline | ||
61 | Jukebox Recorder 15,\newline | ||
62 | Jukebox Recorder 20 | ||
63 | \par} | ||
64 | & | ||
65 | {\centering | ||
66 | recorder | ||
67 | \par} | ||
68 | \\\hline | ||
69 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
70 | %\includegraphics[width=2.117cm,height=2.893cm]{images/rockbox-manual-img4.jpg} | ||
71 | |||
72 | & | ||
73 | {\centering | ||
74 | 20GB | ||
75 | \par} | ||
76 | & | ||
77 | {\centering | ||
78 | Jukebox Recorder v2 | ||
79 | \par} | ||
80 | & | ||
81 | {\centering | ||
82 | recorderv2 | ||
83 | \par} | ||
84 | \\\hline | ||
85 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
86 | %\includegraphics[width=2.117cm,height=2.893cm]{images/rockbox-manual-img5.jpg} | ||
87 | |||
88 | & | ||
89 | {\centering | ||
90 | 20GB | ||
91 | \par} | ||
92 | & | ||
93 | {\centering | ||
94 | Jukebox Recorder FM | ||
95 | \par} | ||
96 | & | ||
97 | {\centering | ||
98 | fmrecorder | ||
99 | \par} | ||
100 | \\\hline | ||
101 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
102 | %\includegraphics[width=2.12cm,height=2.889cm]{images/rockbox-manual-img6.jpg} | ||
103 | |||
104 | & | ||
105 | {\centering | ||
106 | 128MB\newline | ||
107 | (flash) | ||
108 | \par} | ||
109 | & | ||
110 | {\centering | ||
111 | Ondio 128 SP | ||
112 | \par} | ||
113 | & | ||
114 | {\centering | ||
115 | ondiosp | ||
116 | \par} | ||
117 | \\\hline | ||
118 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
119 | %\includegraphics[width=2.117cm,height=2.893cm]{images/rockbox-manual-img7.jpg} | ||
120 | |||
121 | & | ||
122 | {\centering | ||
123 | 128MB\newline | ||
124 | (flash) | ||
125 | \par} | ||
126 | & | ||
127 | {\centering | ||
128 | Ondio 128 FM | ||
129 | \par} | ||
130 | & | ||
131 | {\centering | ||
132 | ondiofm | ||
133 | \par} | ||
134 | \\\hline | ||
135 | \end{tabular}\end{center} | ||
136 | \end{minipage}Please note that Rockbox does not run on the Archos | ||
137 | Jukebox Multimedia or any Archos MP3 player products other than those | ||
138 | mentioned here. | ||
139 | |||
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex new file mode 100644 index 0000000000..276f2a87a1 --- /dev/null +++ b/manual/getting_started/main.tex | |||
@@ -0,0 +1,112 @@ | |||
1 | \chapter{Getting started} | ||
2 | \newpage | ||
3 | \section{Welcome} | ||
4 | This is the manual for Rockbox. Rockbox is a replacement firmware for the | ||
5 | Jukebox Studio, Recorder and Ondio players made by Archos, the H120/140 | ||
6 | players from iRiver and the Apple iPod Nano etc. It is a complete rewrite of | ||
7 | the software used to make the PDA play and record music, and contains many | ||
8 | features and enhancements not available in the original firmware supplied by | ||
9 | the manufacturer. Among the things that Rockbox has to offer are the | ||
10 | following: | ||
11 | |||
12 | \begin{itemize} | ||
13 | \item Faster loading than the \playername firmware | ||
14 | \item Uninterrupted playing of MP3 files {--} skipping is very rare | ||
15 | \item More control over how your music is played | ||
16 | \item Built in viewers for several common file types | ||
17 | \item Sophisticated plugin system that allows the Jukebox to run games, | ||
18 | a calendar, a clock, and many other applications. | ||
19 | \item Totally removable. (Removal of Rockbox before returning the | ||
20 | Jukebox for repair under warranty is advised.) | ||
21 | \item Optional voice user interface for complete control without looking | ||
22 | at the screen | ||
23 | \end{itemize} | ||
24 | Rockbox is a complete from scratch rewrite of the \playername software and | ||
25 | uses no fragments of the original firmware. Not only is it free to | ||
26 | use, it's also released under the GNU public license, | ||
27 | which means that it will always remain free to both use and to change. | ||
28 | |||
29 | \opt{OndioSP,OndioFM}{Although Rockbox also runs on the Archos Ondio series of | ||
30 | flash based MP3 players, this is a recent development, which is not covered | ||
31 | fully in this manual. Most of this manual will, however, apply equally to | ||
32 | Rockbox on the Ondio Jukeboxes. For more details on the Ondio port, please | ||
33 | see the web page: | ||
34 | \url{http://www.rockbox.org/twiki/bin/view/Main/ArchosOndio}.} | ||
35 | |||
36 | \section{Getting more help} | ||
37 | |||
38 | This manual is intended to be a comprehensive introduction to the Rockbox | ||
39 | software. There is, however, more help available. The Rockbox website at | ||
40 | \url{http://www.rockbox.org/}contains very extensive documentation and guides | ||
41 | written by members of the Rockbox community and this should be your first port | ||
42 | of call when looking for further help. | ||
43 | |||
44 | \opt{Archos}{\input{chapter1/archos_choice}} | ||
45 | |||
46 | |||
47 | \section{Downloading Rockbox} | ||
48 | |||
49 | The latest release of the Rockbox software will always be available from | ||
50 | \url{http://www.rockbox.org/download/}. | ||
51 | Windows users may wish to download the self{}-extracting Windows | ||
52 | installer, which works for all Jukebox models, but those wishing to | ||
53 | install manually or using a different operating system should choose | ||
54 | the .zip archive containing the firmware for their model of the | ||
55 | Jukebox. | ||
56 | |||
57 | \section{Installing Rockbox} | ||
58 | |||
59 | Using the Windows self installing executable to install Rockbox is the easiest | ||
60 | method of installing the software on your Jukebox. Simply follow the | ||
61 | on{}-screen instructions and select the appropriate drive letter and Jukebox | ||
62 | model when prompted. You can use ``Add / Remove Programs'' to uninstall the | ||
63 | software at a later date. | ||
64 | |||
65 | For non{}-Windows users and those wishing to install manually from the archive | ||
66 | the procedure is still fairly simple. Connect your \playername to the computer | ||
67 | via USB as described in the manual that came with your \playername. On Windows, | ||
68 | the \playername drive will appear as a drive letter in your ``My Computer'' | ||
69 | folder. Take the file that you downloaded above, and unpack its contents to | ||
70 | your \playername drive. You can do this using a program such as | ||
71 | \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}. | ||
72 | |||
73 | You will need to unpack all of the files in the archive onto your hard | ||
74 | disk. If this has been done correctly, you will have a file called | ||
75 | \opt{PS}{\fname{archos.mod}} | ||
76 | \opt{Rec,Rec2,FMRec}{\fname{ajbrec.ajz}} | ||
77 | \opt{H120,H340}{\fname{rockbox.iriver}} | ||
78 | in the main folder of your \playername drive, and also a folder called | ||
79 | /\fname{.rockbox}, which contains a number of system files used by the | ||
80 | software. | ||
81 | |||
82 | \section{Enabling Speech Support (optional)} | ||
83 | |||
84 | If you wish to use speech support you will also need a language file, | ||
85 | available from | ||
86 | \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}. | ||
87 | For the English language, the file is called \fname{english.voice}. | ||
88 | When it has been downloaded, unpack this file and copy it into the | ||
89 | \fname{lang} folder which is inside the /\fname{.rockbox} folder on | ||
90 | your Jukebox. Voice menus are turned on by default. See page | ||
91 | \pageref{ref:Voiceconfiguration} for details on voice settings. | ||
92 | |||
93 | |||
94 | \section{Running Rockbox} | ||
95 | |||
96 | Remove your Jukebox from the computer's USB port. | ||
97 | Unplug any connected power supply and turn the unit off. When you next | ||
98 | turn the unit on, the Jukebox firmware will start to load, and then it | ||
99 | will load Rockbox for you. When you see the Rockbox splash screen, | ||
100 | Rockbox is loaded and ready for use. | ||
101 | |||
102 | \section{Uninstalling Rockbox} | ||
103 | |||
104 | If you would like to go back to using the | ||
105 | original \playername software, then connect the \playername up to your computer, | ||
106 | and delete the | ||
107 | \opt{PS}{\fname{archos.mod}} | ||
108 | \opt{Rec,Rec2,FMRec}{\fname{ajbrec.ajz}} | ||
109 | \opt{H120,H340}{\fname{rockbox.iriver}} | ||
110 | If you wish to clean up your disk, you may also wish to delete the | ||
111 | \fname{.rockbox} folder and its contents. Turn the \playername off and on and | ||
112 | the normal \playername software will load. | ||
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex new file mode 100644 index 0000000000..f02227a10d --- /dev/null +++ b/manual/main_menu/main.tex | |||
@@ -0,0 +1,492 @@ | |||
1 | \chapter{The Main Menu} | ||
2 | \newpage | ||
3 | |||
4 | \section{Introducing the Main Menu} | ||
5 | {\centering\itshape | ||
6 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
7 | %\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img24.png} | ||
8 | \textmd{ } [Warning: Image ignored] | ||
9 | % Unhandled or unsupported graphics: | ||
10 | %\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img25.png} | ||
11 | \newline | ||
12 | Recorder main menu Player main menu | ||
13 | \par} | ||
14 | |||
15 | This is the screen from which the rest of the | ||
16 | Rockbox functions can be accessed. It is used for a variety of | ||
17 | functions, which are detailed below. You can access the Rockbox main | ||
18 | menu by pressing MENU (player/studio version) or F1 (recorder version) | ||
19 | key. All options in Rockbox can be controlled via this menu. Some of | ||
20 | them can also be found in the Quick Menus (recorder version only). | ||
21 | |||
22 | All settings are persistently stored on the unit. However, Rockbox does | ||
23 | not spin up the disk solely for the purpose of saving settings, but | ||
24 | instead will save them when it spins up the disk the next time, for | ||
25 | example when refilling the MP3 buffer or navigating through the file | ||
26 | browser. Changes to settings may therefore not be saved unless the | ||
27 | Jukebox is shut down safely (see page \pageref{ref:Safeshutdown}). | ||
28 | |||
29 | The two settings menus are covered in detail starting on page \pageref{ref:Part4}. | ||
30 | All the other options on the main menu are explained here. | ||
31 | |||
32 | Navigating through the menu: | ||
33 | |||
34 | \subsection{Recorder} | ||
35 | |||
36 | \begin{tabular}[c]{|p{3.27cm}|p{13.318cm}|} | ||
37 | \hline | ||
38 | {\centering\bfseries\itshape | ||
39 | KEY | ||
40 | \par} | ||
41 | & | ||
42 | {\centering\bfseries\itshape | ||
43 | ACTION | ||
44 | \par} | ||
45 | \\\hline | ||
46 | {\centering | ||
47 | UP | ||
48 | \par} | ||
49 | & | ||
50 | Moves up in the menu. Inside a setting, increases the value or chooses | ||
51 | next option | ||
52 | \\\hline | ||
53 | {\centering | ||
54 | DOWN | ||
55 | \par} | ||
56 | & | ||
57 | Moves down in the menu. Inside a setting, decreases the value or chooses | ||
58 | previous option | ||
59 | \\\hline | ||
60 | {\centering | ||
61 | PLAY/RIGHT | ||
62 | \par} | ||
63 | & | ||
64 | Selects option | ||
65 | \\\hline | ||
66 | {\centering | ||
67 | OFF/LEFT | ||
68 | \par} | ||
69 | & | ||
70 | Exits menu, setting or moves to parent menu | ||
71 | \\\hline | ||
72 | \end{tabular} | ||
73 | \subsection{Player} | ||
74 | |||
75 | \begin{tabular}[c]{|p{3.27cm}|p{13.317cm}|} | ||
76 | \hline | ||
77 | {\centering\bfseries\itshape | ||
78 | KEY | ||
79 | \par} | ||
80 | & | ||
81 | {\centering\bfseries\itshape | ||
82 | ACTION | ||
83 | \par} | ||
84 | \\\hline | ||
85 | {\centering | ||
86 | MINUS | ||
87 | \par} | ||
88 | & | ||
89 | Selects previous option in the menu. Inside an setting, decreases the | ||
90 | value or chooses previous option | ||
91 | \\\hline | ||
92 | {\centering | ||
93 | PLUS | ||
94 | \par} | ||
95 | & | ||
96 | Selects next option in the menu. Inside an setting increases the value | ||
97 | or chooses next option | ||
98 | \\\hline | ||
99 | {\centering | ||
100 | PLAY | ||
101 | \par} | ||
102 | & | ||
103 | Selects item | ||
104 | \\\hline | ||
105 | {\centering | ||
106 | STOP | ||
107 | \par} | ||
108 | & | ||
109 | Exit menu, setting or moves to parent menu. | ||
110 | \\\hline | ||
111 | \end{tabular} | ||
112 | |||
113 | \section{\label{ref:Recording}Recording (Recorder, Ondio FM)} | ||
114 | \subsection{\label{ref:Whilerecordingscreen}While Recording Screen} | ||
115 | {\centering\itshape | ||
116 | Recording Screen Recording F2 screen Recording F3 screen | ||
117 | \par} | ||
118 | |||
119 | \begin{center} | ||
120 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
121 | %\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img26.png} | ||
122 | |||
123 | \end{center} | ||
124 | \begin{center} | ||
125 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
126 | %\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img27.png} | ||
127 | |||
128 | \end{center} | ||
129 | \begin{center} | ||
130 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
131 | %\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img28.png} | ||
132 | |||
133 | \end{center} | ||
134 | Entering the ``Recording'' option in the Main menu launches the | ||
135 | recording application. The screen shows the time elapsed and the size | ||
136 | of the file being recorded. A peak meter is present to allow you set | ||
137 | Gain correctly. The frequency, channels and quality settings are shown | ||
138 | on the last line. | ||
139 | |||
140 | The controls for this screen are: | ||
141 | |||
142 | \begin{tabular}[l]{|p{2.033cm}|p{14.603001cm}|} | ||
143 | \hline | ||
144 | {\centering\bfseries\itshape | ||
145 | BUTTON | ||
146 | \par} | ||
147 | & | ||
148 | {\centering\bfseries\itshape | ||
149 | FUNCTION | ||
150 | \par} | ||
151 | \\\hline | ||
152 | {\centering | ||
153 | LEFT | ||
154 | \par} | ||
155 | & | ||
156 | Decreases Gain | ||
157 | \\\hline | ||
158 | {\centering | ||
159 | RIGHT | ||
160 | \par} | ||
161 | & | ||
162 | Increases Gain | ||
163 | \\\hline | ||
164 | {\centering | ||
165 | PLAY | ||
166 | \par} | ||
167 | & | ||
168 | Starts recording. While recording, button closes the current file and | ||
169 | opens a new one\newline | ||
170 | (while recording) Pauses / restarts recording | ||
171 | \\\hline | ||
172 | {\centering | ||
173 | STOP | ||
174 | \par} | ||
175 | & | ||
176 | Exits Recording Screen\newline | ||
177 | (while recording) Stop recording | ||
178 | \\\hline | ||
179 | {\centering | ||
180 | F1 | ||
181 | \par} | ||
182 | & | ||
183 | Opens Recording Settings screen (see below) | ||
184 | \\\hline | ||
185 | {\centering | ||
186 | F2 | ||
187 | \par} | ||
188 | & | ||
189 | Quick menu for recording settings. A quick press will leave the screen | ||
190 | up (press F2 again to exit), while holding it will close the screen | ||
191 | when you release it. | ||
192 | \\\hline | ||
193 | {\centering | ||
194 | F3 | ||
195 | \par} | ||
196 | & | ||
197 | Quick menu for source setting. Quick/hold works as for F2.\newline | ||
198 | (while recording) Start a new recording file | ||
199 | \\\hline | ||
200 | \end{tabular} | ||
201 | |||
202 | |||
203 | \subsubsection{\label{ref:Recordingsettings}Recording Settings} | ||
204 | \begin{itemize} | ||
205 | \item \textbf{Quality} | ||
206 | Choose the quality here (0 to 7). Default is 5, best quality is 7, | ||
207 | smallest file size is 0. This setting effects how much your sound | ||
208 | sample will be compressed. Higher quality settings result in larger | ||
209 | MP3 files. | ||
210 | |||
211 | The quality setting is just a way of selecting an average bit rate, or | ||
212 | number of bits per second, for a recording. When this setting is | ||
213 | lowered, recordings are compressed more (meaning worse sound quality), | ||
214 | and the average bitrate changes as follows. | ||
215 | \end{itemize} | ||
216 | |||
217 | \begin{center}\begin{tabular}{|p{4.598cm}|p{8.051001cm}|} | ||
218 | \hline | ||
219 | {\centering\bfseries\itshape | ||
220 | FREQUENCY | ||
221 | \par} | ||
222 | & | ||
223 | {\centering\bfseries\itshape | ||
224 | BITRATE (Kbit/s) {}- quality 0{}-{\textgreater}7 | ||
225 | \par} | ||
226 | \\\hline | ||
227 | {\centering | ||
228 | 44100Hz stereo: | ||
229 | \par} | ||
230 | & | ||
231 | 75, 80, 90, 100, 120, 140, 160, 170 | ||
232 | \\\hline | ||
233 | {\centering | ||
234 | 22050Hz stereo | ||
235 | \par} | ||
236 | & | ||
237 | 39, 41, 45, 50, 60, 80, 110, 130 | ||
238 | \\\hline | ||
239 | {\centering | ||
240 | 44100Hz mono | ||
241 | \par} | ||
242 | & | ||
243 | 65, 68, 73, 80, 90, 105, 125, 140 | ||
244 | \\\hline | ||
245 | {\centering | ||
246 | 22050Hz mono | ||
247 | \par} | ||
248 | & | ||
249 | 35, 38, 40, 45, 50, 60, 75, 90 | ||
250 | \\\hline | ||
251 | \end{tabular}\end{center} | ||
252 | |||
253 | \begin{itemize} | ||
254 | \item \textbf{Frequency} | ||
255 | Choose the recording frequency (sample rate) {}- 48kHz, 44.1kHz, | ||
256 | 32kHz (MPEG version 1), and 24kHz, 22.05kHz, 16kHz (MPEG version 2) are | ||
257 | available. Higher sample rates use up more disk space, but give better | ||
258 | sound quality. This setting determines which frequency range can | ||
259 | accurately be reproduced during playback. Lower frequencies produce | ||
260 | smaller files, for two reasons. The amount of data to be compressed is | ||
261 | smaller and the data is easier to compress, since higher frequencies | ||
262 | are not present. The frequency setting also determines which version | ||
263 | of the MPEG standard sound is recorded using. | ||
264 | |||
265 | \item \textbf{Source} | ||
266 | Choose the source of the recording. This can be microphone, line in, | ||
267 | or SPDIF (digital). For recording from the radio on the FM recorder, | ||
268 | see page \pageref{ref:FMradio} below. | ||
269 | |||
270 | Note: you cannot change the sample rate for digital recordings. | ||
271 | |||
272 | \item \textbf{Channels} | ||
273 | This allows you to select mono or stereo recording. Please note that | ||
274 | for mono recording, only the left channel is recorded. Mono recordings | ||
275 | are usually somewhat smaller than stereo. | ||
276 | |||
277 | \item \textbf{Independent Frames} | ||
278 | The independent frames option tells the Jukebox to encode with the bit | ||
279 | reservoir disabled, so the frames are independent of each other. This | ||
280 | makes a file easier to edit. | ||
281 | |||
282 | \item \textbf{Time Split} | ||
283 | This option is useful when timing recordings. If set to active it stops | ||
284 | a recording at a given interval and then starts recording again with a | ||
285 | new file., which is useful for long term recordings. | ||
286 | |||
287 | The splits are seamless (frame accurate), no audio is lost at the split | ||
288 | point. The break between recordings is only the time required to stop | ||
289 | and restart the recording, on the order of 2{}-4 seconds. | ||
290 | |||
291 | Options (hours:minutes between splits): off, 24:00, 18:00, 12:00, 10:00, | ||
292 | 8:00, 6:00, 4:00, 2:00, 1:20 (80 minute CD), 1:14 (74 minute CD), | ||
293 | 1:00, 00:30, 00:15, 00:10, 00:05. | ||
294 | \item \textbf{Prerecord Time} | ||
295 | This setting buffers a small amount of audio so that when the | ||
296 | record button is pressed, the recording will begin from that number of | ||
297 | seconds earlier. This is useful for ensuring that a recording begins | ||
298 | before a cue that is being waited for.\\ | ||
299 | |||
300 | Options: Off, 1{}-30 seconds | ||
301 | \end{itemize} | ||
302 | |||
303 | \section{\label{ref:FMradio}FM Radio (FM recorder Ondio FM)} | ||
304 | {\centering\itshape | ||
305 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
306 | %\includegraphics[width=4.15cm,height=2.371cm]{images/rockbox-manual-img29.png} | ||
307 | \newline | ||
308 | FM radio screen | ||
309 | \par} | ||
310 | |||
311 | This menu option switches to the radio screen. | ||
312 | |||
313 | The keys are: | ||
314 | |||
315 | \begin{tabular}[l]{|p{3.211cm}|p{13.424cm}|} | ||
316 | \hline | ||
317 | {\centering\bfseries\itshape | ||
318 | BUTTON | ||
319 | \par} | ||
320 | & | ||
321 | {\centering\bfseries\itshape | ||
322 | FUNCTION | ||
323 | \par} | ||
324 | \\\hline | ||
325 | {\centering | ||
326 | LEFT, RIGHT | ||
327 | \par} | ||
328 | & | ||
329 | Change frequency in 0.1 MHz steps. For automatic station seek, hold | ||
330 | LEFT/RIGHT for a little longer. | ||
331 | \\\hline | ||
332 | {\centering | ||
333 | UP, DOWN | ||
334 | \par} | ||
335 | & | ||
336 | Change volume | ||
337 | \\\hline | ||
338 | {\centering | ||
339 | PLAY | ||
340 | \par} | ||
341 | & | ||
342 | \textcolor{black}{(EXPERIMENTAL) } freezes all | ||
343 | screen updates, may enhance radio reception in some cases. | ||
344 | \\\hline | ||
345 | {\centering | ||
346 | ON | ||
347 | \par} | ||
348 | & | ||
349 | Leave the radio screen with the radio playing | ||
350 | \\\hline | ||
351 | {\centering | ||
352 | OFF | ||
353 | \par} | ||
354 | & | ||
355 | Back to main menu | ||
356 | \\\hline | ||
357 | \end{tabular} | ||
358 | The FM radio has the ability to record and to remember station frequency | ||
359 | settings (presets). | ||
360 | |||
361 | \begin{itemize} | ||
362 | |||
363 | \item \textbf{Saving a preset} | ||
364 | You can save your favourite stations in the 32 | ||
365 | presets. Press F1 to go to the menu, then select | ||
366 | ``Save preset''. Enter the name (maximum number | ||
367 | of characters is 32). | ||
368 | |||
369 | \item \textbf{Selecting a preset} | ||
370 | Press F2 to go to the preset list. Use UP and DOWN to move the cursor | ||
371 | and then press PLAY to select. Use LEFT to leave the preset without | ||
372 | selecting anything. | ||
373 | |||
374 | \item \textbf{Removing a preset} | ||
375 | Press F1 to go to the menu, then select ``Remove preset''. | ||
376 | |||
377 | \item \textbf{Recording} | ||
378 | Press F3 to start recording the currently playing station. Press OFF to | ||
379 | stop recording. Press PLAY again to seamlessly start recording to a new | ||
380 | file. The settings for the recording can be changed in the F1 menu | ||
381 | before starting the recording. See page \pageref{ref:Recordingsettings} | ||
382 | for details of recording settings. | ||
383 | |||
384 | Note: The radio will turn off when playing an MP3. | ||
385 | \end{itemize} | ||
386 | |||
387 | \section{\label{ref:Bookmarkconfig}\label{ref:Bookmarkmenu}Bookmarks} | ||
388 | The bookmarks menu allows you to create and manage bookmark files. | ||
389 | |||
390 | \begin{itemize} | ||
391 | |||
392 | \item \textbf{Create Bookmark} | ||
393 | While playing a track, use this option to save your current position | ||
394 | within the track so that you can return to it at a later time. | ||
395 | Bookmarks are saved on a per folder basis i.e. all of the files in the | ||
396 | same folder have their bookmarks stored together. You can store | ||
397 | multiple bookmarks for the same track. | ||
398 | |||
399 | \item \textbf{List Bookmarks} | ||
400 | |||
401 | % Unhandled or unsupported graphics: | ||
402 | %\includegraphics[width=4.098cm,height=2.341cm]{images/rockbox-manual-img30.png}% Unhandled or unsupported graphics: | ||
403 | %\includegraphics[width=4.669cm,height=2.006cm]{images/rockbox-manual-img31.png} | ||
404 | Recorder bookmark browser Player bookmark browser | ||
405 | |||
406 | While playing a track, use this option to return to any bookmark in the current folder. The bookmark browser | ||
407 | screen (shown above) is now displayed. Use the UP and DOWN keys | ||
408 | (recorder) or MINUS and PLUS keys (player) to navigate between | ||
409 | bookmarks. Press PLAY to jump to a bookmark, ON+PLAY to delete a | ||
410 | bookmark or STOP/OFF to exit the browser. | ||
411 | |||
412 | \item \textbf {Recent bookmarks} | ||
413 | If the ``save a list of recently created bookmarks'' option is enabled | ||
414 | then you can view a list of several recent bookmarks here and select | ||
415 | one to jump straight to that track. This option is off by default. | ||
416 | See page \pageref{ref:Bookmarkconfigactual} for more details on | ||
417 | configuring bookmarking in Rockbox. | ||
418 | |||
419 | \end{itemize} | ||
420 | |||
421 | \section{\label{ref:playlistoptions}Playlist Options} | ||
422 | This menu allows you to work with playlists. | ||
423 | Playlists can either be created automatically by playing a file in | ||
424 | a directory directly, which will cause all of the files in that | ||
425 | directory to be placed in the playlist, or they can be created by hand | ||
426 | using the File Menu (see page \pageref{ref:Filemenu}) | ||
427 | or using the Playlist Options menu. Both automatic and manually | ||
428 | created playlists can be edited using this menu. | ||
429 | |||
430 | \begin{itemize} | ||
431 | \item \textbf{Create Playlist} | ||
432 | Rockbox will create a playlist with all tracks in the current directory and all subdirectories. The playlist will be created one folder level ``up'' from | ||
433 | where you currently are. | ||
434 | |||
435 | \item \textbf{View Current Playlist} | ||
436 | Displays the contents of the playlist currently stored in memory. | ||
437 | |||
438 | \item \textbf{Save Current Playlist} | ||
439 | Saves the current dynamic playlist, excluding queued tracks, to the | ||
440 | specified file. If no path is provided then playlist is saved to | ||
441 | current directory (see page \pageref{ref:Playlistsubmenu}). | ||
442 | |||
443 | \item \textbf{Recursively Insert Directories} | ||
444 | If set to ON then when you insert/queue a directory in Dynamic Playlist, | ||
445 | all subdirectories will also be inserted. If set to ASK then you are | ||
446 | prompted about recursive insertion when inserting a directory. | ||
447 | \end{itemize} | ||
448 | |||
449 | \section{Browse Plugins} | ||
450 | With this option you can load and run various plugins that have been | ||
451 | written for Rockbox.\\ | ||
452 | |||
453 | A detailed description of the different plugins begins on page \pageref{ref:Part5}. | ||
454 | |||
455 | \section{\label{ref:Info}Info} | ||
456 | This option shows MP3 ram buffer size, battery voltage level and | ||
457 | estimated time remaining, disk total space and disk free space. | ||
458 | |||
459 | On players use the MINUS and PLUS keys to step through several pages of | ||
460 | information. | ||
461 | |||
462 | \begin{itemize} | ||
463 | |||
464 | \item \textbf{Show ID3 info} | ||
465 | This is an alternative way to access the ID3 viewer. See page | ||
466 | \pageref{ref:ID3viewer} for details on the ID3 viewer. | ||
467 | |||
468 | \item \textbf{Rockbox Info} | ||
469 | Displays some basic system information. This is, from top to bottom, | ||
470 | the amount of memory Rockbox has available for storing music (the | ||
471 | buffer), battery status, hard disk size and the amount of free space on | ||
472 | the disk. | ||
473 | |||
474 | \item \textbf{Version} | ||
475 | Software version and credits display. | ||
476 | |||
477 | \item \textbf{Debug (Keep Out!)} | ||
478 | This submenu is intended to be used only by Rockbox developers. It shows | ||
479 | hardware, disk, battery status and a lot of other information. It is | ||
480 | not recommended that users access this menu unless instructed to do so | ||
481 | in the course of fixing a problem with Rockbox. In particular the | ||
482 | ``Dump ROM Contents'', ``View/clear RTC RAM'' and | ||
483 | ``Screenshot'' and ``Sound test'' functions | ||
484 | should be treated with care. | ||
485 | \end{itemize} | ||
486 | |||
487 | \section{Shutdown (Player)} | ||
488 | This menu option saves the Rockbox configuration and turns off the hard | ||
489 | drive before shutting down the machine. For maximum safety this | ||
490 | procedure is recommended when turning off the Jukebox. (There is a | ||
491 | very small risk of hard disk corruption otherwise.) See page | ||
492 | \pageref{ref:Safeshutdown} for more details. | ||
diff --git a/manual/rockbox.tex b/manual/rockbox.tex index d038b21f68..8f3b654fe0 100644 --- a/manual/rockbox.tex +++ b/manual/rockbox.tex | |||
@@ -12,12 +12,12 @@ | |||
12 | 12 | ||
13 | \pagestyle{fancy} | 13 | \pagestyle{fancy} |
14 | 14 | ||
15 | \input{chapter1/getting_started.tex} | 15 | \input{getting_started/main.tex} |
16 | \input{chapter2/rockbox_interface.tex} | 16 | \input{rockbox_interface/main.tex} |
17 | \input{chapter3/main_menu.tex} | 17 | \input{main_menu/main.tex} |
18 | \input{chapter4/configure_rockbox.tex} | 18 | \input{configure_rockbox/main.tex} |
19 | \input{chapter5/plugins.tex} | 19 | \input{chapter5/plugins.tex} |
20 | \input{chapter6/advanced_topics.tex} | 20 | \input{advanced_topics/main.tex} |
21 | %\input{appendix.tex} | 21 | %\input{appendix.tex} |
22 | %\appendix | 22 | %\appendix |
23 | 23 | ||
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex new file mode 100644 index 0000000000..3e8e4de0d4 --- /dev/null +++ b/manual/rockbox_interface/main.tex | |||
@@ -0,0 +1,804 @@ | |||
1 | \chapter{\label{ref:PARTII}The Rockbox interface} | ||
2 | \clearpage | ||
3 | \section{Your Jukebox} | ||
4 | \begin{minipage}{16.554cm} | ||
5 | {\centering\itshape | ||
6 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
7 | %\includegraphics[width=7.904cm,height=10.723cm]{images/rockbox-manual-img8.jpg} | ||
8 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
9 | %\includegraphics[width=7.87cm,height=10.703cm]{images/rockbox-manual-img9.jpg} | ||
10 | \newline | ||
11 | Jukebox Player Jukebox Recorder | ||
12 | \par} | ||
13 | |||
14 | {\centering\itshape | ||
15 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
16 | %\includegraphics[width=7.87cm,height=10.7cm]{images/rockbox-manual-img10.jpg} | ||
17 | \newline | ||
18 | Ondio 128 | ||
19 | \par} | ||
20 | \end{minipage} | ||
21 | |||
22 | Throughout this manual, the buttons on the Jukebox are labelled | ||
23 | according to the pictures above. There are minor cosmetic differences | ||
24 | between Jukebox models, but the buttons are in approximately the same | ||
25 | position as on the picture.\\ | ||
26 | |||
27 | To turn on a Jukebox containing Rockbox, hold down the ON key | ||
28 | for 2{}-3 seconds. (Flashed Jukeboxes only require a tap of the ON key | ||
29 | {--} see page \textup{\pageref{ref:FlashingRockboxReal}} for more | ||
30 | information about flashing Rockbox.) | ||
31 | \label{ref:Safeshutdown}On shutdown, Rockbox automatically saves its settings and turns off the hard drive safely. To tell Rockbox to shut the Jukebox down, do the following: | ||
32 | |||
33 | \begin{center}\begin{tabular}{|p{5.905cm}|p{10.558001cm}|} | ||
34 | \hline | ||
35 | {\centering\bfseries\itshape | ||
36 | model | ||
37 | \par} | ||
38 | & | ||
39 | {\centering\bfseries\itshape | ||
40 | POWER OFF | ||
41 | \par} | ||
42 | \\\hline | ||
43 | {\centering | ||
44 | V2 / FM RECORDER/ ONDIO | ||
45 | \par} | ||
46 | & | ||
47 | Hold the OFF key for 2{}-3 seconds | ||
48 | \\\hline | ||
49 | {\centering | ||
50 | V1 RECORDER | ||
51 | \par} | ||
52 | & | ||
53 | Double{}-tap the OFF key when playback is stopped | ||
54 | \\\hline | ||
55 | {\centering | ||
56 | PLAYER | ||
57 | \par} | ||
58 | & | ||
59 | From the Rockbox Main Menu select \textbf{Shutdown} | ||
60 | \\\hline | ||
61 | \end{tabular}\end{center} | ||
62 | |||
63 | In the unlikely event of a software failure, a hardware power off can be | ||
64 | performed by holding down STOP until the Jukebox power light goes off. | ||
65 | This works for all models of Jukebox.\\ | ||
66 | |||
67 | For further details about connecting, charging and caring for your | ||
68 | Jukebox, please see the Archos manual that came with it. | ||
69 | |||
70 | \section{\label{ref:PartIIFB}File Browser} | ||
71 | {\centering\itshape | ||
72 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
73 | %\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img11.png} | ||
74 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
75 | %\includegraphics[width=4.15cm,height=1.981cm]{images/rockbox-manual-img12.png} | ||
76 | \newline | ||
77 | Recorder file browser Player file browser | ||
78 | \par} | ||
79 | The file browser helps you navigate through the files on your Jukebox, | ||
80 | entering folders and executing the default action on each file. To help | ||
81 | us differentiate files, each file format is displayed with an icon. You | ||
82 | can select which file types are displayed (see page | ||
83 | \pageref{ref:ShowFiles}). | ||
84 | |||
85 | \subsection{\label{ref:PartIISectionCtrls}Controls} | ||
86 | \opt{Rec}{ | ||
87 | \begin{center}\begin{tabular}{|p{4cm}|p{10cm}|} | ||
88 | \hline | ||
89 | \tabelth{KEY} & \tabelth{FUNCTION} \\ \hline | ||
90 | % | ||
91 | \tabeltc{UP/DOWN} & | ||
92 | Go to previous/next item in list. If you are on the first/last entry, | ||
93 | the cursor will wrap to the last/first entry. \\ \hline | ||
94 | % | ||
95 | \tabeltc{ON+UP/DOWN} & | ||
96 | Move one page up/down on the list.\\ \hline | ||
97 | % | ||
98 | \tabeltc{LEFT} & Go to the parent directory. \\ \hline | ||
99 | % | ||
100 | \tabeltc{PLAY/RIGHT} & | ||
101 | Executes an action. Depending on the file type, that action may vary. | ||
102 | (See page \pageref{ref:Filemenu}) \\ \hline | ||
103 | % | ||
104 | \tabeltc{centering} & | ||
105 | If there is a MP3 playing, returns to the While Playing Screen (WPS) | ||
106 | without stopping playback. \\ \hline | ||
107 | % | ||
108 | \tabeltc{ON+PLAY/HOLD PLAY} & Enters the File Menu \\ \hline | ||
109 | % | ||
110 | \tabeltc{F1} & Switches to the Main Menu \\ \hline | ||
111 | % | ||
112 | \tabeltc{F2} & Switches to the Browse/Play Quick Menu \\ \hline | ||
113 | % | ||
114 | \tabeltc{F3} & Switches to the Display Quick Menu \\ \hline | ||
115 | % | ||
116 | \end{tabular}\end{center} | ||
117 | } | ||
118 | % | ||
119 | \opt{PS}{ | ||
120 | \begin{tabular}[c]{|p{4.314cm}|p{12.288cm}|} | ||
121 | \hline | ||
122 | {\centering\bfseries\itshape | ||
123 | KEY | ||
124 | \par} | ||
125 | & | ||
126 | {\centering\bfseries\itshape | ||
127 | FUNCTION | ||
128 | \par} | ||
129 | \\\hline | ||
130 | {\centering | ||
131 | MINUS/PLUS | ||
132 | \par} | ||
133 | & | ||
134 | Go to previous/next item in list. If you are on the first/last entry, | ||
135 | the cursor will wrap to the last/first entry. | ||
136 | \\\hline | ||
137 | {\centering | ||
138 | STOP | ||
139 | \par} | ||
140 | & | ||
141 | Go to the parent directory. | ||
142 | \\\hline | ||
143 | {\centering | ||
144 | PLAY | ||
145 | \par} | ||
146 | & | ||
147 | Executes an action. Depending on the file type, that action may vary. | ||
148 | (See page \pageref{ref:Filemenu}) | ||
149 | \\\hline | ||
150 | {\centering | ||
151 | ON | ||
152 | \par} | ||
153 | & | ||
154 | If there is a MP3 playing, returns to the While Playing Screen (WPS) | ||
155 | without stopping playback. | ||
156 | \\\hline | ||
157 | {\centering | ||
158 | ON+PLAY/HOLD PLAY | ||
159 | \par} | ||
160 | & | ||
161 | Enters the File Menu | ||
162 | \\\hline | ||
163 | {\centering | ||
164 | Menu | ||
165 | \par} | ||
166 | & | ||
167 | Switches to the Main Menu | ||
168 | \\\hline | ||
169 | \end{tabular} | ||
170 | The functions of the F keys are also summarised on the button bar at the | ||
171 | bottom of the screen. | ||
172 | } | ||
173 | |||
174 | |||
175 | \subsection{\label{ref:Filemenu}\label{ref:PartIISectionFM}File Menu} | ||
176 | {\centering\itshape | ||
177 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
178 | %\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img13.png} | ||
179 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
180 | %\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img14.png} | ||
181 | \newline | ||
182 | Recorder file menu Player file menu | ||
183 | \par} | ||
184 | |||
185 | This menu operates on the file that was selected in the browser at the | ||
186 | time ON+PLAY was pressed to enter it. It can also be accessed by | ||
187 | holding down the PLAY key for a short while. It offers the following | ||
188 | options: | ||
189 | |||
190 | \begin{itemize} | ||
191 | \item \textbf{Open with:} Runs a viewer plugin on the file. | ||
192 | Normally the filetype of a file is detected and the appropriate plugin | ||
193 | is run automatically when you press play on it. Use this menu if for | ||
194 | some reason you want to override the default action and select a viewer | ||
195 | by hand. See page \textmd{\pageref{ref:Viewersplugins}} for more details on viewers. | ||
196 | For example, this would be used to run the VBRfix plugin to recreate the | ||
197 | Xing header for an MP3 file, which can fix problems such as | ||
198 | fast{}-forward and rewind not working correctly on a particular MP3 file or the play time of a track being listed incorrectly. | ||
199 | \item \textbf{Playlist:} Change to the Playlist submenu (see below). | ||
200 | \item \textbf{Rename:} This function lets the user modify a file name. | ||
201 | \item \textbf{Delete:} Only files can be deleted, not folders. Rockbox will ask for confirmation before deleting a file. Press PLAY to confirm deletion or any other key to cancel. | ||
202 | \item \textbf{Delete Directory: }Deletes the folder pointed to by the cursor and all the files and folders contained in it. Use with caution. | ||
203 | \item \textbf{Create Directory:} Makes a new folder in the current folder on | ||
204 | the disk. | ||
205 | \end{itemize} | ||
206 | |||
207 | |||
208 | \subsection{\label{ref:Playlistsubmenu}Playlist Submenu} | ||
209 | If the playlist submenu is invoked on a directory, it will act on all the files within that directory. If invoked on a playlist it will act on all the files in that playlist. Otherwise it acts only on the current file. | ||
210 | |||
211 | {\centering\itshape | ||
212 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
213 | %\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img15.png} | ||
214 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
215 | %\includegraphics[width=4.15cm,height=1.951cm]{images/rockbox-manual-img16.png} | ||
216 | \newline | ||
217 | Recorder playlist submenu Player playlist submenu | ||
218 | \par} | ||
219 | |||
220 | This menu provides the following options: | ||
221 | |||
222 | \begin{itemize} | ||
223 | \item \textbf{Insert:} Add track(s) to playlist. If no other tracks have been | ||
224 | inserted then the selected track will be added immediately after | ||
225 | current playing track, otherwise they will be added to end of insertion | ||
226 | list. | ||
227 | \item \textbf{Insert next: }Add track(s) immediately after current playing | ||
228 | track, no matter what else has been inserted. | ||
229 | \item \textbf{Insert last: }Add track(s) to end of playlist. | ||
230 | \item \textbf{Queue: } Queue is the same as Insert except queued | ||
231 | tracks are deleted immediately from the playlist after | ||
232 | they've been played. Also, queued tracks are not saved to the playlist file (see page \pageref{ref:playlistoptions}). | ||
233 | \item \textbf{Queue next:} Queue track(s) immediately after current playing | ||
234 | track. | ||
235 | \item \textbf{Queue last: }Queue track(s) at end of playlist. | ||
236 | \end{itemize} | ||
237 | |||
238 | You can insert a track, directory or playlist even if nothing is | ||
239 | currently playing. In this case, a new playlist is created with only | ||
240 | the selected tracks and then play is started. | ||
241 | |||
242 | Note: The dynamic playlist is saved so resume will restore it exactly as | ||
243 | before shutdown. Stopped playlists can be resumed from File Browser by | ||
244 | pressing ON. | ||
245 | |||
246 | |||
247 | |||
248 | |||
249 | \subsection{Virtual Keyboard} | ||
250 | {\centering\itshape | ||
251 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
252 | %\includegraphics[width=4.165cm,height=2.177cm]{images/rockbox-manual-img17.png} | ||
253 | \textmd{ } [Warning: Image ignored] | ||
254 | % Unhandled or unsupported graphics: | ||
255 | %\includegraphics[width=4.598cm,height=2.071cm]{images/rockbox-manual-img18.png} | ||
256 | \newline | ||
257 | Recorder keyboard Player Keyboard | ||
258 | \par} | ||
259 | |||
260 | This is the virtual keyboard that is used when entering file names in | ||
261 | Rockbox. | ||
262 | |||
263 | \opt{Rec}{ | ||
264 | |||
265 | \begin{tabular}[c]{|p{3.8799999cm}|p{12.653cm}|} | ||
266 | \hline | ||
267 | {\centering\bfseries\itshape | ||
268 | KEY | ||
269 | \par} | ||
270 | & | ||
271 | {\centering\bfseries\itshape | ||
272 | FUNCTION | ||
273 | \par} | ||
274 | \\\hline | ||
275 | {\centering | ||
276 | ARROW KEYS | ||
277 | \par} | ||
278 | & | ||
279 | Move about the virtual keyboard (moves the solid cursor) | ||
280 | \\\hline | ||
281 | {\centering | ||
282 | ON+LEFT/RIGHT | ||
283 | \par} | ||
284 | & | ||
285 | Move about within the current file name (moves the line cursor) | ||
286 | \\\hline | ||
287 | {\centering | ||
288 | PLAY | ||
289 | \par} | ||
290 | & | ||
291 | Inserts the currently selected keyboard letter at the current filename | ||
292 | cursor position | ||
293 | \\\hline | ||
294 | {\centering | ||
295 | STOP | ||
296 | \par} | ||
297 | & | ||
298 | Exits the virtual keyboard without saving any changes | ||
299 | \\\hline | ||
300 | {\centering | ||
301 | ON | ||
302 | \par} | ||
303 | & | ||
304 | No action | ||
305 | \\\hline | ||
306 | {\centering | ||
307 | F1 | ||
308 | \par} | ||
309 | & | ||
310 | SHIFT: Shifts between the upper case, lower case and accented keyboards | ||
311 | \\\hline | ||
312 | {\centering | ||
313 | F2 | ||
314 | \par} | ||
315 | & | ||
316 | OK: Exits the virtual keyboard and saves any changer | ||
317 | \\\hline | ||
318 | {\centering | ||
319 | F3 | ||
320 | \par} | ||
321 | & | ||
322 | DEL: Deletes the character before the current filename cursor | ||
323 | \\\hline | ||
324 | \end{tabular} | ||
325 | } | ||
326 | |||
327 | |||
328 | \opt{PS}{ | ||
329 | The current filename is always listed on the first line of the display. | ||
330 | The second line of the display can contain the character selection bar, | ||
331 | as in the screenshot above, or one of a number of other options. | ||
332 | |||
333 | \begin{center}\begin{tabular}{|p{3.86cm}|p{12.708cm}|} | ||
334 | \hline | ||
335 | {\centering\bfseries\itshape | ||
336 | KEY | ||
337 | \par} | ||
338 | & | ||
339 | {\centering\bfseries\itshape | ||
340 | FUNCTION | ||
341 | \par} | ||
342 | \\\hline | ||
343 | {\centering | ||
344 | MINUS/PLUS | ||
345 | \par} | ||
346 | & | ||
347 | Moves the arrow to/from the filename and changes between the character | ||
348 | bar and BACKSPACE, DELETE, ACCEPT and ABORT. | ||
349 | \\\hline | ||
350 | {\centering | ||
351 | PLAY/STOP | ||
352 | \par} | ||
353 | & | ||
354 | Varies (see below) | ||
355 | \\\hline | ||
356 | {\centering | ||
357 | ON | ||
358 | \par} | ||
359 | & | ||
360 | Nothing | ||
361 | \\\hline | ||
362 | {\centering | ||
363 | Menu | ||
364 | \par} | ||
365 | & | ||
366 | Shift. When the character selection bar is selected this changes | ||
367 | between upper case, lower case, and accented letters. | ||
368 | \\\hline | ||
369 | \end{tabular}\end{center} | ||
370 | The function of the PLAY and STOP buttons depends on what the arrow is | ||
371 | pointing to, as follows. | ||
372 | |||
373 | \begin{center}\begin{tabular}{|p{4.243cm}|p{12.359cm}|} | ||
374 | \hline | ||
375 | {\centering\bfseries\itshape | ||
376 | SELECTED OPTION | ||
377 | \par} | ||
378 | & | ||
379 | {\centering\bfseries\itshape | ||
380 | PLAY/STOP FUNCTION | ||
381 | \par} | ||
382 | \\\hline | ||
383 | {\centering | ||
384 | filename | ||
385 | \par} | ||
386 | & | ||
387 | Moves the cursor left (STOP) or right (PLAY) within the filename | ||
388 | \\\hline | ||
389 | {\centering | ||
390 | character bar | ||
391 | \par} | ||
392 | & | ||
393 | Moves the character bar to the next (PLAY) or previous (STOP) character. | ||
394 | \\\hline | ||
395 | {\centering | ||
396 | BACKSPACE | ||
397 | \par} | ||
398 | & | ||
399 | PLAY deletes the character before the current cursor position | ||
400 | \\\hline | ||
401 | {\centering | ||
402 | DELETE | ||
403 | \par} | ||
404 | & | ||
405 | PLAY deletes the character at the current cursor position | ||
406 | \\\hline | ||
407 | {\centering | ||
408 | ACCEPT | ||
409 | \par} | ||
410 | & | ||
411 | PLAY exits the virtual keyboard and saves any changes | ||
412 | \\\hline | ||
413 | {\centering | ||
414 | ABORT | ||
415 | \par} | ||
416 | & | ||
417 | PLAY exits the virtual keyboard and discards any changes | ||
418 | \\\hline | ||
419 | \end{tabular}\end{center} | ||
420 | } | ||
421 | |||
422 | \section{\label{ref:WPS}\label{ref:PartIISectionWPS}While Playing | ||
423 | Screen} | ||
424 | The While Playing Screen (WPS) displays various pieces of information | ||
425 | about the currently playing MP3 file: | ||
426 | % | ||
427 | \opt{Rec}{ | ||
428 | \begin{itemize} | ||
429 | \item Status bar: Battery level, charger status, volume, play mode, repeat | ||
430 | mode, shuffle mode and clock. | ||
431 | \item Scrolling path+filename of the current song. | ||
432 | \item The ID3 track name. | ||
433 | \item The ID3 album name. | ||
434 | \item The ID3 artist name. | ||
435 | \item Bit rate. VBR files display average bitrate and ``(avg)'' | ||
436 | \item Elapsed and total time. | ||
437 | \item A slidebar progress meter representing where in the song you are. | ||
438 | \item Peak meter. | ||
439 | \end{itemize} | ||
440 | |||
441 | Notes: | ||
442 | |||
443 | \begin{itemize} | ||
444 | \item The number of lines shown depends on the size of the font used. | ||
445 | \item The peak meter is only visible if you turn off the status bar or if | ||
446 | using a small font that gives 8 or more display lines. | ||
447 | \end{itemize} | ||
448 | } | ||
449 | % | ||
450 | \opt{PS}{ | ||
451 | \begin{itemize} | ||
452 | \item Playlist index/Playlist size: Artist {}- Title. | ||
453 | \item Current{}-time Progress{}-indicator Left. | ||
454 | \end{itemize} | ||
455 | |||
456 | See page \textmd{\pageref{ref:ConfiguringtheWPS}} for | ||
457 | details of customising your WPS (While Playing Screen). | ||
458 | } | ||
459 | |||
460 | \subsection{\label{ref:PartIISectionWPSCtrls}WPS Key Controls} | ||
461 | |||
462 | \opt{Rec}{ | ||
463 | \begin{flushleft}\begin{tabular}{|p{3.407cm}|p{13.093cm}|} | ||
464 | \hline | ||
465 | {\centering\bfseries\itshape | ||
466 | KEY | ||
467 | \par} | ||
468 | & | ||
469 | {\centering\bfseries\itshape | ||
470 | ACTION | ||
471 | \par} | ||
472 | \\\hline | ||
473 | {\centering | ||
474 | UP/DOWN | ||
475 | \par} | ||
476 | & | ||
477 | Volume up/down | ||
478 | \\\hline | ||
479 | {\centering | ||
480 | LEFT | ||
481 | \par} | ||
482 | & | ||
483 | (quick press) Go to beginning of track, or if pressed while in the first | ||
484 | seconds of a track, go to previous track | ||
485 | \\\hline | ||
486 | {\centering | ||
487 | LEFT (hold) | ||
488 | \par} | ||
489 | & | ||
490 | Rewind in track | ||
491 | \\\hline | ||
492 | {\centering | ||
493 | RIGHT | ||
494 | \par} | ||
495 | & | ||
496 | (quick press) Go to next track. | ||
497 | \\\hline | ||
498 | {\centering | ||
499 | RIGHT (hold) | ||
500 | \par} | ||
501 | & | ||
502 | Fast forward in track. | ||
503 | \\\hline | ||
504 | {\centering | ||
505 | PLAY | ||
506 | \par} | ||
507 | & | ||
508 | Toggle play/pause | ||
509 | \\\hline | ||
510 | {\centering | ||
511 | ON | ||
512 | \par} | ||
513 | & | ||
514 | (quick press) Go to file browser | ||
515 | \\\hline | ||
516 | {\centering | ||
517 | ON (hold) | ||
518 | \par} | ||
519 | & | ||
520 | Show pitch setting screen | ||
521 | \\\hline | ||
522 | {\centering | ||
523 | STOP | ||
524 | \par} | ||
525 | & | ||
526 | Stop playback | ||
527 | \\\hline | ||
528 | {\centering | ||
529 | F1 | ||
530 | \par} | ||
531 | & | ||
532 | Go to Main menu | ||
533 | \\\hline | ||
534 | {\centering | ||
535 | F2 | ||
536 | \par} | ||
537 | & | ||
538 | Toggles Play/browse quick menu | ||
539 | \\\hline | ||
540 | {\centering | ||
541 | F3 | ||
542 | \par} | ||
543 | & | ||
544 | Toggles Display quick menu | ||
545 | \\\hline | ||
546 | {\centering | ||
547 | F1+DOWN | ||
548 | \par} | ||
549 | & | ||
550 | Key lock on/off | ||
551 | \\\hline | ||
552 | {\centering | ||
553 | F1+PLAY | ||
554 | \par} | ||
555 | & | ||
556 | Mute on/off | ||
557 | \\\hline | ||
558 | {\centering | ||
559 | F1+ON | ||
560 | \par} | ||
561 | & | ||
562 | Enter ID3 viewer | ||
563 | \\\hline | ||
564 | \end{tabular}\end{flushleft} | ||
565 | } | ||
566 | % | ||
567 | \opt{PS}{ | ||
568 | \begin{center}\begin{tabular}{|p{3.27cm}|p{13.29cm}|} | ||
569 | \hline | ||
570 | {\centering\bfseries\itshape | ||
571 | KEY | ||
572 | \par} | ||
573 | & | ||
574 | {\centering\bfseries\itshape | ||
575 | ACTION | ||
576 | \par} | ||
577 | \\\hline | ||
578 | {\centering | ||
579 | MENU+PLUS | ||
580 | \par} | ||
581 | & | ||
582 | Increases volume | ||
583 | \\\hline | ||
584 | {\centering | ||
585 | MENU+MINUS | ||
586 | \par} | ||
587 | & | ||
588 | Decreases volume | ||
589 | \\\hline | ||
590 | {\centering | ||
591 | MINUS | ||
592 | \par} | ||
593 | & | ||
594 | (quick press) Go to beginning of track, or if pressed while in the first | ||
595 | seconds of a track, go to previous track. | ||
596 | \\\hline | ||
597 | {\centering | ||
598 | MINUS (hold) | ||
599 | \par} | ||
600 | & | ||
601 | Rewind in track | ||
602 | \\\hline | ||
603 | {\centering | ||
604 | PLUS | ||
605 | \par} | ||
606 | & | ||
607 | (quick press) Go to next track. | ||
608 | \\\hline | ||
609 | {\centering | ||
610 | PLUS (hold) | ||
611 | \par} | ||
612 | & | ||
613 | Fast{}-forward in track. | ||
614 | \\\hline | ||
615 | {\centering | ||
616 | PLAY | ||
617 | \par} | ||
618 | & | ||
619 | Toggle play/pause | ||
620 | \\\hline | ||
621 | {\centering | ||
622 | ON | ||
623 | \par} | ||
624 | & | ||
625 | Quick press = Go to file browser | ||
626 | \\\hline | ||
627 | {\centering | ||
628 | OFF | ||
629 | \par} | ||
630 | & | ||
631 | Stop playback | ||
632 | \\\hline | ||
633 | {\centering | ||
634 | MENU | ||
635 | \par} | ||
636 | & | ||
637 | Go to Main menu | ||
638 | \\\hline | ||
639 | {\centering | ||
640 | MENU+STOP | ||
641 | \par} | ||
642 | & | ||
643 | Key lock on/off | ||
644 | \\\hline | ||
645 | {\centering | ||
646 | MENU+PLAY | ||
647 | \par} | ||
648 | & | ||
649 | Mute on/off | ||
650 | \\\hline | ||
651 | {\centering | ||
652 | MENU+ON | ||
653 | \par} | ||
654 | & | ||
655 | Enter ID3 viewer | ||
656 | \\\hline | ||
657 | \end{tabular}\end{center} | ||
658 | } | ||
659 | |||
660 | \opt{Rec,Rec2,FMRec,OndioSP,OndioFM,H120}{ | ||
661 | \subsection{Peak Meter} | ||
662 | The peak meter can be displayed on the While Playing Screen and consists | ||
663 | of several indicators. For a picture of the peak meter, please see the | ||
664 | While Recording Screen on page \pageref{ref:Whilerecordingscreen}. | ||
665 | |||
666 | \begin{itemize} | ||
667 | \item \textbf{The bar: }This is the wide horizontal bar. It represents the | ||
668 | current volume value. | ||
669 | \item \textbf{The peak indicator:} This is a little vertical line at the right | ||
670 | end of the bar. It indicates the peak volume value that occurred | ||
671 | recently. | ||
672 | \item \textbf{The clip indicator: }This is a little black block that is | ||
673 | displayed at the very right of the scale when an overflow occurs. It | ||
674 | usually doesn't show up during normal playback unless | ||
675 | you play an audio file that is distorted heavily. If you encounter | ||
676 | clipping while recording your recording will sound distorted. You | ||
677 | should lower the gain. Note that the clip detection is not very | ||
678 | precise. Clipping might occur without being indicated. | ||
679 | \item \textbf{The scale: }Between the indicators of the right and left channel | ||
680 | there are little dots. These dots represent important volume values. In | ||
681 | linear mode each dot is a 10\% mark. In dbfs mode the dots represent | ||
682 | the following values (from right to left): 0db, {}-3db, {}-6db, {}-9db, | ||
683 | {}-12db, {}-18db, {}-24db, {}-30db, {}-40db, {}-50db, {}-60db. | ||
684 | \end{itemize} | ||
685 | } | ||
686 | |||
687 | \subsection{\label{ref:ID3viewer}ID3 Viewer} | ||
688 | {\centering\itshape | ||
689 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
690 | %\includegraphics[width=3.833cm,height=2.191cm]{images/rockbox-manual-img21.png} | ||
691 | \newline | ||
692 | The ID3 viewer | ||
693 | \par} | ||
694 | |||
695 | This screen is accessible from the WPS screen by pressing F1+ON (recorder) or MENU+ON (player). It provides a detailed view of all the identity information about the current track that is stored in an MP3 file. Use the LEFT and RIGHT (recorder) or PLUS and MINUS (player) keys to move through the information and the STOP key to exit the viewer. | ||
696 | |||
697 | |||
698 | \opt{Rec,Rec2,FMRec,H120}{ | ||
699 | \section{\label{ref:QuickScreenMenus}Quick Screen Menus} | ||
700 | |||
701 | {\centering\itshape | ||
702 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
703 | %\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img22.png} | ||
704 | \textmd{ } [Warning: Image ignored] | ||
705 | % Unhandled or unsupported graphics: | ||
706 | %\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img23.png} | ||
707 | \newline | ||
708 | F2 Quick Screen Menu F3 Quick Screen Menu | ||
709 | \par} | ||
710 | |||
711 | Rockbox handles function buttons in a different way to the Archos | ||
712 | software. F1 is always bound to the menu function, while F2 and F3 | ||
713 | enable two quick menus. | ||
714 | |||
715 | F2 displays some browse and play settings which are likely to be changed | ||
716 | frequently. This settings are Shuffle mode, Repeat mode and the Show | ||
717 | files options | ||
718 | |||
719 | Shuffle mode plays each track in the currently playing list in a random | ||
720 | order rather than in the order shown in the browser. | ||
721 | |||
722 | Repeat mode repeats either a single track (One) or the entire playlist | ||
723 | (All). | ||
724 | |||
725 | Show files determines what type files can be seen in the browser. This | ||
726 | can be just MP3 files and directories (Music), Playlists, MP3 files and directories (Playlists), any files that Rockbox supports (Supported) or all files on the disk (All). | ||
727 | |||
728 | See page \pageref{ref:PlaybackOptions} for more information about these | ||
729 | settings. | ||
730 | |||
731 | \begin{center}\begin{tabular}{|p{2.852cm}|p{8.387cm}|} | ||
732 | \hline | ||
733 | {\centering\bfseries\itshape | ||
734 | KEY | ||
735 | \par} | ||
736 | & | ||
737 | {\centering\bfseries\itshape | ||
738 | ACTION | ||
739 | \par} | ||
740 | \\\hline | ||
741 | {\centering | ||
742 | LEFT | ||
743 | \par} | ||
744 | & | ||
745 | Controls Shuffle mode setting | ||
746 | \\\hline | ||
747 | {\centering | ||
748 | RIGHT | ||
749 | \par} | ||
750 | & | ||
751 | Controls Repeat mode setting | ||
752 | \\\hline | ||
753 | {\centering | ||
754 | DOWN | ||
755 | \par} | ||
756 | & | ||
757 | Controls Show file setting | ||
758 | \\\hline | ||
759 | \end{tabular}\end{center} | ||
760 | F3 controls frequently used display options. | ||
761 | |||
762 | Scroll bar turns the display of the Scroll bar on the left of the screen | ||
763 | on or off. | ||
764 | |||
765 | Status bar turns the status display at the top of the screen on or off. | ||
766 | |||
767 | Upside down inverts the screen so that the top of the display appears | ||
768 | nearest to the buttons. This is sometimes useful when storing the | ||
769 | Jukebox in a pocket. Key assignments swap over with the display | ||
770 | orientation where it is logical for them to do so. | ||
771 | |||
772 | See page \pageref{ref:Displayoptions} for more information about these | ||
773 | settings. | ||
774 | |||
775 | \begin{tabular}[c]{|p{2.852cm}|p{8.387cm}|} | ||
776 | \hline | ||
777 | {\centering\bfseries\itshape | ||
778 | KEY | ||
779 | \par} | ||
780 | & | ||
781 | {\centering\bfseries\itshape | ||
782 | ACTION | ||
783 | \par} | ||
784 | \\\hline | ||
785 | {\centering | ||
786 | LEFT | ||
787 | \par} | ||
788 | & | ||
789 | Controls scroll bar display | ||
790 | \\\hline | ||
791 | {\centering | ||
792 | RIGHT | ||
793 | \par} | ||
794 | & | ||
795 | Controls status bar display | ||
796 | \\\hline | ||
797 | {\centering | ||
798 | DOWN | ||
799 | \par} | ||
800 | & | ||
801 | Controls upside down screen setting | ||
802 | \\\hline | ||
803 | \end{tabular} | ||
804 | } | ||