summaryrefslogtreecommitdiff
path: root/manual/main_menu/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/main_menu/main.tex')
-rw-r--r--manual/main_menu/main.tex492
1 files changed, 492 insertions, 0 deletions
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
12Recorder main menu Player main menu
13\par}
14
15This is the screen from which the rest of the
16Rockbox functions can be accessed. It is used for a variety of
17functions, which are detailed below. You can access the Rockbox main
18menu by pressing MENU (player/studio version) or F1 (recorder version)
19key. All options in Rockbox can be controlled via this menu. Some of
20them can also be found in the Quick Menus (recorder version only).
21
22All settings are persistently stored on the unit. However, Rockbox does
23not spin up the disk solely for the purpose of saving settings, but
24instead will save them when it spins up the disk the next time, for
25example when refilling the MP3 buffer or navigating through the file
26browser. Changes to settings may therefore not be saved unless the
27Jukebox is shut down safely (see page \pageref{ref:Safeshutdown}).
28
29The 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
32Navigating through the menu:
33
34\subsection{Recorder}
35
36\begin{tabular}[c]{|p{3.27cm}|p{13.318cm}|}
37\hline
38{\centering\bfseries\itshape
39KEY
40\par}
41&
42{\centering\bfseries\itshape
43ACTION
44\par}
45\\\hline
46{\centering
47UP
48\par}
49&
50Moves up in the menu. Inside a setting, increases the value or chooses
51next option
52\\\hline
53{\centering
54DOWN
55\par}
56&
57Moves down in the menu. Inside a setting, decreases the value or chooses
58previous option
59\\\hline
60{\centering
61PLAY/RIGHT
62\par}
63&
64Selects option
65\\\hline
66{\centering
67OFF/LEFT
68\par}
69&
70Exits 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
78KEY
79\par}
80&
81{\centering\bfseries\itshape
82ACTION
83\par}
84\\\hline
85{\centering
86MINUS
87\par}
88&
89Selects previous option in the menu. Inside an setting, decreases the
90value or chooses previous option
91\\\hline
92{\centering
93PLUS
94\par}
95&
96Selects next option in the menu. Inside an setting increases the value
97or chooses next option
98\\\hline
99{\centering
100PLAY
101\par}
102&
103Selects item
104\\\hline
105{\centering
106STOP
107\par}
108&
109Exit 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
116Recording 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}
134Entering the ``Recording'' option in the Main menu launches the
135recording application. The screen shows the time elapsed and the size
136of the file being recorded. A peak meter is present to allow you set
137Gain correctly. The frequency, channels and quality settings are shown
138on the last line.
139
140The controls for this screen are:
141
142\begin{tabular}[l]{|p{2.033cm}|p{14.603001cm}|}
143\hline
144{\centering\bfseries\itshape
145BUTTON
146\par}
147&
148{\centering\bfseries\itshape
149FUNCTION
150\par}
151\\\hline
152{\centering
153LEFT
154\par}
155&
156Decreases Gain
157\\\hline
158{\centering
159RIGHT
160\par}
161&
162Increases Gain
163\\\hline
164{\centering
165PLAY
166\par}
167&
168Starts recording. While recording, button closes the current file and
169opens a new one\newline
170(while recording) Pauses / restarts recording
171\\\hline
172{\centering
173STOP
174\par}
175&
176Exits Recording Screen\newline
177(while recording) Stop recording
178\\\hline
179{\centering
180F1
181\par}
182&
183Opens Recording Settings screen (see below)
184\\\hline
185{\centering
186F2
187\par}
188&
189Quick menu for recording settings. A quick press will leave the screen
190up (press F2 again to exit), while holding it will close the screen
191when you release it.
192\\\hline
193{\centering
194F3
195\par}
196&
197Quick 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}
206Choose the quality here (0 to 7). Default is 5, best quality is 7,
207smallest file size is 0. This setting effects how much your sound
208sample will be compressed. Higher quality settings result in larger
209MP3 files.
210
211The quality setting is just a way of selecting an average bit rate, or
212number of bits per second, for a recording. When this setting is
213lowered, recordings are compressed more (meaning worse sound quality),
214and 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
220FREQUENCY
221\par}
222&
223{\centering\bfseries\itshape
224BITRATE (Kbit/s) {}- quality 0{}-{\textgreater}7
225\par}
226\\\hline
227{\centering
22844100Hz stereo:
229\par}
230&
23175, 80, 90, 100, 120, 140, 160, 170
232\\\hline
233{\centering
23422050Hz stereo
235\par}
236&
23739, 41, 45, 50, 60, 80, 110, 130
238\\\hline
239{\centering
24044100Hz mono
241\par}
242&
24365, 68, 73, 80, 90, 105, 125, 140
244\\\hline
245{\centering
24622050Hz mono
247\par}
248&
24935, 38, 40, 45, 50, 60, 75, 90
250\\\hline
251\end{tabular}\end{center}
252
253\begin{itemize}
254\item \textbf{Frequency}
255Choose the recording frequency (sample rate) {}- 48kHz, 44.1kHz,
25632kHz (MPEG version 1), and 24kHz, 22.05kHz, 16kHz (MPEG version 2) are
257available. Higher sample rates use up more disk space, but give better
258sound quality. This setting determines which frequency range can
259accurately be reproduced during playback. Lower frequencies produce
260smaller files, for two reasons. The amount of data to be compressed is
261smaller and the data is easier to compress, since higher frequencies
262are not present. The frequency setting also determines which version
263of the MPEG standard sound is recorded using.
264
265\item \textbf{Source}
266Choose the source of the recording. This can be microphone, line in,
267or SPDIF (digital). For recording from the radio on the FM recorder,
268see page \pageref{ref:FMradio} below.
269
270Note: you cannot change the sample rate for digital recordings.
271
272\item \textbf{Channels}
273This allows you to select mono or stereo recording. Please note that
274for mono recording, only the left channel is recorded. Mono recordings
275are usually somewhat smaller than stereo.
276
277\item \textbf{Independent Frames}
278The independent frames option tells the Jukebox to encode with the bit
279reservoir disabled, so the frames are independent of each other. This
280makes a file easier to edit.
281
282\item \textbf{Time Split}
283This option is useful when timing recordings. If set to active it stops
284a recording at a given interval and then starts recording again with a
285new file., which is useful for long term recordings.
286
287The splits are seamless (frame accurate), no audio is lost at the split
288point. The break between recordings is only the time required to stop
289and restart the recording, on the order of 2{}-4 seconds.
290
291Options (hours:minutes between splits): off, 24:00, 18:00, 12:00, 10:00,
2928:00, 6:00, 4:00, 2:00, 1:20 (80 minute CD), 1:14 (74 minute CD),
2931:00, 00:30, 00:15, 00:10, 00:05.
294\item \textbf{Prerecord Time}
295This setting buffers a small amount of audio so that when the
296record button is pressed, the recording will begin from that number of
297seconds earlier. This is useful for ensuring that a recording begins
298before a cue that is being waited for.\\
299
300Options: 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
308FM radio screen
309\par}
310
311This menu option switches to the radio screen.
312
313The keys are:
314
315\begin{tabular}[l]{|p{3.211cm}|p{13.424cm}|}
316\hline
317{\centering\bfseries\itshape
318BUTTON
319\par}
320&
321{\centering\bfseries\itshape
322FUNCTION
323\par}
324\\\hline
325{\centering
326LEFT, RIGHT
327\par}
328&
329Change frequency in 0.1 MHz steps. For automatic station seek, hold
330LEFT/RIGHT for a little longer.
331\\\hline
332{\centering
333UP, DOWN
334\par}
335&
336Change volume
337\\\hline
338{\centering
339PLAY
340\par}
341&
342\textcolor{black}{(EXPERIMENTAL) } freezes all
343screen updates, may enhance radio reception in some cases.
344\\\hline
345{\centering
346ON
347\par}
348&
349Leave the radio screen with the radio playing
350\\\hline
351{\centering
352OFF
353\par}
354&
355Back to main menu
356\\\hline
357\end{tabular}
358The FM radio has the ability to record and to remember station frequency
359settings (presets).
360
361\begin{itemize}
362
363\item \textbf{Saving a preset}
364You can save your favourite stations in the 32
365presets. Press F1 to go to the menu, then select
366``Save preset''. Enter the name (maximum number
367of characters is 32).
368
369\item \textbf{Selecting a preset}
370Press F2 to go to the preset list. Use UP and DOWN to move the cursor
371and then press PLAY to select. Use LEFT to leave the preset without
372selecting anything.
373
374\item \textbf{Removing a preset}
375Press F1 to go to the menu, then select ``Remove preset''.
376
377\item \textbf{Recording}
378Press F3 to start recording the currently playing station. Press OFF to
379stop recording. Press PLAY again to seamlessly start recording to a new
380file. The settings for the recording can be changed in the F1 menu
381before starting the recording. See page \pageref{ref:Recordingsettings}
382for details of recording settings.
383
384Note: The radio will turn off when playing an MP3.
385\end{itemize}
386
387\section{\label{ref:Bookmarkconfig}\label{ref:Bookmarkmenu}Bookmarks}
388The bookmarks menu allows you to create and manage bookmark files.
389
390\begin{itemize}
391
392\item \textbf{Create Bookmark}
393While playing a track, use this option to save your current position
394within the track so that you can return to it at a later time.
395Bookmarks are saved on a per folder basis i.e. all of the files in the
396same folder have their bookmarks stored together. You can store
397multiple 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}
404Recorder bookmark browser Player bookmark browser
405
406While playing a track, use this option to return to any bookmark in the current folder. The bookmark browser
407screen (shown above) is now displayed. Use the UP and DOWN keys
408(recorder) or MINUS and PLUS keys (player) to navigate between
409bookmarks. Press PLAY to jump to a bookmark, ON+PLAY to delete a
410bookmark or STOP/OFF to exit the browser.
411
412\item \textbf {Recent bookmarks}
413If the ``save a list of recently created bookmarks'' option is enabled
414then you can view a list of several recent bookmarks here and select
415one to jump straight to that track. This option is off by default.
416See page \pageref{ref:Bookmarkconfigactual} for more details on
417configuring bookmarking in Rockbox.
418
419\end{itemize}
420
421\section{\label{ref:playlistoptions}Playlist Options}
422This menu allows you to work with playlists.
423Playlists can either be created automatically by playing a file in
424a directory directly, which will cause all of the files in that
425directory to be placed in the playlist, or they can be created by hand
426using the File Menu (see page \pageref{ref:Filemenu})
427or using the Playlist Options menu. Both automatic and manually
428created playlists can be edited using this menu.
429
430\begin{itemize}
431\item \textbf{Create Playlist}
432Rockbox will create a playlist with all tracks in the current directory and all subdirectories. The playlist will be created one folder level ``up'' from
433where you currently are.
434
435\item \textbf{View Current Playlist}
436Displays the contents of the playlist currently stored in memory.
437
438\item \textbf{Save Current Playlist}
439Saves the current dynamic playlist, excluding queued tracks, to the
440specified file. If no path is provided then playlist is saved to
441current directory (see page \pageref{ref:Playlistsubmenu}).
442
443\item \textbf{Recursively Insert Directories}
444If set to ON then when you insert/queue a directory in Dynamic Playlist,
445all subdirectories will also be inserted. If set to ASK then you are
446prompted about recursive insertion when inserting a directory.
447\end{itemize}
448
449\section{Browse Plugins}
450With this option you can load and run various plugins that have been
451written for Rockbox.\\
452
453A detailed description of the different plugins begins on page \pageref{ref:Part5}.
454
455\section{\label{ref:Info}Info}
456This option shows MP3 ram buffer size, battery voltage level and
457estimated time remaining, disk total space and disk free space.
458
459On players use the MINUS and PLUS keys to step through several pages of
460information.
461
462\begin{itemize}
463
464\item \textbf{Show ID3 info}
465This 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}
469Displays some basic system information. This is, from top to bottom,
470the amount of memory Rockbox has available for storing music (the
471buffer), battery status, hard disk size and the amount of free space on
472the disk.
473
474\item \textbf{Version}
475Software version and credits display.
476
477\item \textbf{Debug (Keep Out!)}
478This submenu is intended to be used only by Rockbox developers. It shows
479hardware, disk, battery status and a lot of other information. It is
480not recommended that users access this menu unless instructed to do so
481in 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
484should be treated with care.
485\end{itemize}
486
487\section{Shutdown (Player)}
488This menu option saves the Rockbox configuration and turns off the hard
489drive before shutting down the machine. For maximum safety this
490procedure is recommended when turning off the Jukebox. (There is a
491very small risk of hard disk corruption otherwise.) See page
492\pageref{ref:Safeshutdown} for more details.