summaryrefslogtreecommitdiff
path: root/manual/main_menu
diff options
context:
space:
mode:
Diffstat (limited to 'manual/main_menu')
-rw-r--r--manual/main_menu/main.tex263
1 files changed, 148 insertions, 115 deletions
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index 446deeed85..70fd40cdbd 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -4,9 +4,9 @@
4\begin{center} 4\begin{center}
5 \includegraphics[width=4cm]{main_menu/images/ss-main-menu-\genericimg.png} 5 \includegraphics[width=4cm]{main_menu/images/ss-main-menu-\genericimg.png}
6\end{center} 6\end{center}
7This is the screen from which the rest of the Rockbox functions can be accessed. It is used for a variety of functions, which are detailed below. All options in Rockbox can be controlled via this menu. 7This is the screen from which the rest of the Rockbox functions can be accessed. It is used for a variety of functions, which are detailed below. All options in Rockbox can be controlled via this menu.
8 8
9All settings are persistently stored on the unit. However, Rockbox does not spin up the disk solely for the purpose of saving settings, but instead will save them when it spins up the disk the next time, for example when refilling the MP3 buffer or navigating through the file browser. Changes to settings may therefore not be saved unless the \dap is shut down safely (see page \pageref{ref:Safeshutdown}). 9All settings are persistently stored on the unit. However, Rockbox does not spin up the disk solely for the purpose of saving settings, but instead will save them when it spins up the disk the next time, for example when refilling the MP3 buffer or navigating through the file browser. Changes to settings may therefore not be saved unless the \dap\ is shut down safely (see page \pageref{ref:Safeshutdown}).
10 10
11The two settings menus are covered in detail starting on page \pageref{ref:configure_rockbox}. All the other options on the main menu are explained here. 11The two settings menus are covered in detail starting on page \pageref{ref:configure_rockbox}. All the other options on the main menu are explained here.
12 12
@@ -56,82 +56,116 @@ Navigating through the menu:
56 \end{center} 56 \end{center}
57} 57}
58 58
59\section{\label{ref:Recording}Recording} 59\opt{HAVE_RECORDING}{
60\subsection{\label{ref:Whilerecordingscreen}While Recording Screen} 60 \section{\label{ref:Recording}Recording}
61\begin{center} 61 \subsection{\label{ref:Whilerecordingscreen}While Recording Screen}
62 \includegraphics[width=4cm]{main_menu/images/ss-while-recording-screen-112x64x1.png}
63\end{center}
64Entering the ``Recording'' option in the Main menu launches the recording application. The screen shows the time elapsed and the size of the file being recorded. A peak meter is present to allow you set Gain correctly. The frequency, channels and quality settings are shown on the last line.
65
66The controls for this screen are:
67
68\begin{table}[h!]
69 \begin{center}
70 \begin{tabular}{@{}cc@{}}\toprule
71 \textbf{Button} & \textbf{Function} \\\midrule
72 LEFT & Decreases Gain \\
73 RIGHT & Increases Gain \\
74 PLAY & Starts recording. \\
75 & While recording, button closes the current file and opens a new one.\\
76 & (while recording) Pauses / restarts recording \\
77 STOP & Exits Recording Screen.\\
78 & (while recording) Stop recording \\
79 F1 & Opens Recording Settings screen (see below) \\
80 F2 & Quick menu for recording settings. \\
81 & A quick press will leave the screen up (press F2 again to exit),\\
82 & while holding it will close the screen when you release it. \\
83 F3 & Quick menu for source setting. \\
84 & Quick/hold works as for F2. \\
85 & (while recording) Start a new recording file \\\bottomrule
86 \end{tabular}
87 \end{center}
88\end{table}
89
90\subsubsection{\label{ref:Recordingsettings}Recording Settings}
91\begin{itemize}
92\item \textbf{Quality}
93 Choose the quality here (0 to 7). Default is 5, best quality is 7, smallest file size is 0. This setting effects how much your sound sample will be compressed. Higher quality settings result in larger MP3 files.
94
95 The quality setting is just a way of selecting an average bit rate, or number of bits per second, for a recording. When this setting is lowered, recordings are compressed more (meaning worse sound quality), and the average bitrate changes as follows.
96\end{itemize}
97
98\begin{table}[h!]
99 \begin{center} 62 \begin{center}
100 \begin{tabular}{@{}ll@{}}\toprule 63 \includegraphics[width=4cm]{main_menu/images/ss-while-recording-screen-112x64x1.png}
101 \textbf{Frequency} & \textbf{Bitrate} (Kbit/s) {}- quality 0{}-{\textgreater}7 \\\midrule
102 44100Hz stereo: & 75, 80, 90, 100, 120, 140, 160, 170 \\
103 22050Hz stereo & 39, 41, 45, 50, 60, 80, 110, 130 \\
104 44100Hz mono & 65, 68, 73, 80, 90, 105, 125, 140 \\
105 22050Hz mono & 35, 38, 40, 45, 50, 60, 75, 90 \\\bottomrule
106 \end{tabular}
107 \end{center} 64 \end{center}
108\end{table} 65 Entering the ``Recording'' option in the Main menu launches the recording application. The screen shows the time elapsed and the size of the file being recorded. A peak meter is present to allow you set Gain correctly. \opt{MASCODEC}{The frequency, channels and quality} \opt{SWCODEC}{The frequency and channels} settings are shown on the last line.
109 66
110\begin{itemize} 67 The controls for this screen are:
111\item \textbf{Frequency} 68
112Choose the recording frequency (sample rate) {}- 48kHz, 44.1kHz, 32kHz (MPEG version 1), and 24kHz, 22.05kHz, 16kHz (MPEG version 2) are available. Higher sample rates use up more disk space, but give better sound quality. This setting determines which frequency range can accurately be reproduced during playback. Lower frequencies produce smaller files, for two reasons. The amount of data to be compressed is smaller and the data is easier to compress, since higher frequencies are not present. The frequency setting also determines which version of the MPEG standard sound is recorded using. 69 \begin{table}[h!]
113 70 \begin{center}
114\item \textbf{Source} 71 \begin{tabular}{@{}ll@{}}\toprule
115Choose the source of the recording. This can be microphone, line in, or SPDIF (digital). For recording from the radio on the FM recorder, see page \pageref{ref:FMradio}. 72 \textbf{Button} & \textbf{Function} \\\midrule
116 73 \ButtonLeft & Decreases Gain \\
117Note: you cannot change the sample rate for digital recordings. 74 %
118 75 \ButtonRight & Increases Gain \\
119\item \textbf{Channels} 76 %
120This allows you to select mono or stereo recording. Please note that for mono recording, only the left channel is recorded. Mono recordings are usually somewhat smaller than stereo. 77 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
121 78 \opt{ONDIO_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{FixMe:} & Starts recording. \\
122\item \textbf{Independent Frames} 79 & While recording, button closes the current file and opens a new one.\\
123The independent frames option tells the \dap to encode with the bit reservoir disabled, so the frames are independent of each other. This makes a file easier to edit. 80 & (while recording) Pauses / restarts recording \\
124 81 %
125\item \textbf{Time Split} 82 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
126This option is useful when timing recordings. If set to active it stops a recording at a given interval and then starts recording again with a new file., which is useful for long term recordings. 83 \opt{ONDIO_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{FixMe:} & Exits Recording Screen.\\
127 84 & (while recording) Stop recording \\
128The splits are seamless (frame accurate), no audio is lost at the split point. The break between recordings is only the time required to stop and restart the recording, on the order of 2{}-4 seconds. 85 %
129 86 \opt{RECORDER_PAD}{\ButtonFOne}
130Options (hours:minutes between splits): off, 24:00, 18:00, 12:00, 10:00, 8:00, 6:00, 4:00, 2:00, 1:20 (80 minute CD), 1:14 (74 minute CD), 1:00, 00:30, 00:15, 00:10, 00:05. 87 \opt{ONDIO_PAD}{\ButtonMenu}
131\item \textbf{Prerecord Time} 88 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{Hold \ButtonSelect} & Opens Recording Settings screen (see below) \\
132This setting buffers a small amount of audio so that when the record button is pressed, the recording will begin from that number of seconds earlier. This is useful for ensuring that a recording begins before a cue that is being waited for.\\ 89 %
133Options: Off, 1{}-30 seconds 90 \opt{RECORDER_PAD}{
134\end{itemize} 91 \ButtonFTwo & Quick menu for recording settings. \\
92 & A quick press will leave the screen up (press {\ButtonFTwo} again to exit),\\
93 & while holding it will close the screen when you release it. \\
94 }
95 %
96 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{
97 \ButtonSelect & Quick menu for recording settings. \\
98 }
99 %
100 \opt{RECORDER_PAD}{
101 \ButtonFThree & Quick menu for source setting. \\
102 & Quick/hold works as for {\ButtonFTwo}. \\
103 & (while recording) Start a new recording file \\
104 }
105 \bottomrule
106 \end{tabular}
107 \end{center}
108 \end{table}
109
110 \subsubsection{\label{ref:Recordingsettings}Recording Settings}
111
112 \opt{MASCODEC}{
113 \begin{itemize}
114 \item \textbf{Quality}
115 Choose the quality here (0 to 7). Default is 5, best quality is 7, smallest file size is 0. This setting effects how much your sound sample will be compressed. Higher quality settings result in larger MP3 files.
116
117 The quality setting is just a way of selecting an average bit rate, or number of bits per second, for a recording. When this setting is lowered, recordings are compressed more (meaning worse sound quality), and the average bitrate changes as follows.
118 \end{itemize}
119
120 \begin{table}[h!]
121 \begin{center}
122 \begin{tabular}{@{}ll@{}}\toprule
123 \textbf{Frequency} & \textbf{Bitrate} (Kbit/s) {}- quality 0{}-{\textgreater}7 \\\midrule
124 44100Hz stereo: & 75, 80, 90, 100, 120, 140, 160, 170 \\
125 22050Hz stereo & 39, 41, 45, 50, 60, 80, 110, 130 \\
126 44100Hz mono & 65, 68, 73, 80, 90, 105, 125, 140 \\
127 22050Hz mono & 35, 38, 40, 45, 50, 60, 75, 90 \\\bottomrule
128 \end{tabular}
129 \end{center}
130 \end{table}
131 }
132 \begin{itemize}
133 \item \textbf{Frequency}
134 Choose the recording frequency (sample rate) {}- 48kHz, 44.1kHz, 32kHz (MPEG version 1), and 24kHz, 22.05kHz, 16kHz (MPEG version 2) are available. Higher sample rates use up more disk space, but give better sound quality. This setting determines which frequency range can accurately be reproduced during playback. Lower frequencies produce smaller files, for two reasons. The amount of data to be compressed is smaller and the data is easier to compress, since higher frequencies are not present. \opt{MASCODEC}{The frequency setting also determines which version of the MPEG standard sound is recorded using.}
135
136 \item \textbf{Source}
137 Choose the source of the recording. This can be microphone, line in, or SPDIF (digital). For recording from the radio on the FM recorder, see page \pageref{ref:FMradio}.
138
139 Note: you cannot change the sample rate for digital recordings.
140
141 \item \textbf{Channels}
142 This allows you to select mono or stereo recording. Please note that for mono recording, only the left channel is recorded. Mono recordings are usually somewhat smaller than stereo.
143
144 \item \textbf{Independent Frames}
145 The independent frames option tells the \dap to encode with the bit reservoir disabled, so the frames are independent of each other. This makes a file easier to edit.
146
147 \item \textbf{Time Split}
148 This option is useful when timing recordings. If set to active it stops a recording at a given interval and then starts recording again with a new file., which is useful for long term recordings.
149
150 The splits are seamless (frame accurate), no audio is lost at the split point. The break between recordings is only the time required to stop and restart the recording, on the order of 2{}-4 seconds.
151
152 Options (hours:minutes between splits): off, 24:00, 18:00, 12:00, 10:00, 8:00, 6:00, 4:00, 2:00, 1:20 (80 minute CD), 1:14 (74 minute CD), 1:00, 00:30, 00:15, 00:10, 00:05.
153
154 \item \textbf{Prerecord Time}
155 This setting buffers a small amount of audio so that when the record button is pressed, the recording will begin from that number of seconds earlier. This is useful for ensuring that a recording begins before a cue that is being waited for.\\
156 Options: Off, 1{}-30 seconds\\
157
158 \item \textbf{Directory}
159 Allows changing the location where the recorded files are saved.\\
160
161 \item \textbf{Show recording screen on startup} If set to yes, the \dap\ will start up with the while recording screen showing\\
162 Options: Yes, No\\
163
164 \item \textbf{Clipping Light} Causes the backlight to flash on when clipping has been detected\\
165 Options: Off, Remote unit only,Main and remote unit, Main unit only\\
166
167 \end{itemize}
168}
135 169
136\section{\label{ref:FMradio}FM Radio} 170\section{\label{ref:FMradio}FM Radio}
137\begin{center} 171\begin{center}
@@ -146,11 +180,11 @@ The keys are:
146 \begin{tabular}{@{}lc@{}}\toprule 180 \begin{tabular}{@{}lc@{}}\toprule
147 \textbf{Button} & \textbf{Function} \\\midrule 181 \textbf{Button} & \textbf{Function} \\\midrule
148 LEFT, RIGHT & Change frequency in 0.1 MHz steps. \\ 182 LEFT, RIGHT & Change frequency in 0.1 MHz steps. \\
149 & For automatic station seek, \\ 183 & For automatic station seek, \\
150 & hold LEFT/RIGHT for a little longer. \\ 184 & hold LEFT/RIGHT for a little longer. \\
151 UP, DOWN & Change volume \\ 185 UP, DOWN & Change volume \\
152 PLAY & \textbf{(EXPERIMENTAL)} freezes all screen updates.\\ 186 PLAY & \textbf{(EXPERIMENTAL)} freezes all screen updates.\\
153 & May enhance radio reception in some cases. \\ 187 & May enhance radio reception in some cases. \\
154 ON & Leave the radio screen with the radio playing \\ 188 ON & Leave the radio screen with the radio playing \\
155 OFF & Back to main menu \\\bottomrule 189 OFF & Back to main menu \\\bottomrule
156 \end{tabular} 190 \end{tabular}
@@ -159,39 +193,39 @@ The keys are:
159The FM radio has the ability to record and to remember station frequency settings (presets). 193The FM radio has the ability to record and to remember station frequency settings (presets).
160 194
161\begin{itemize} 195\begin{itemize}
162 196
163\item \textbf{Saving a preset} 197\item \textbf{Saving a preset}
164You can save your favourite stations in the 32 presets. Press F1 to go to the menu, then select ``Save preset''. Enter the name (maximum number of characters is 32). 198 You can save your favourite stations in the 32 presets. Press F1 to go to the menu, then select ``Save preset''. Enter the name (maximum number of characters is 32).
165 199
166\item \textbf{Selecting a preset} 200\item \textbf{Selecting a preset}
167Press F2 to go to the preset list. Use UP and DOWN to move the cursor and then press PLAY to select. Use LEFT to leave the preset without selecting anything. 201 Press F2 to go to the preset list. Use UP and DOWN to move the cursor and then press PLAY to select. Use LEFT to leave the preset without selecting anything.
168 202
169\item \textbf{Removing a preset} 203\item \textbf{Removing a preset}
170Press F1 to go to the menu, then select ``Remove preset''. 204 Press F1 to go to the menu, then select ``Remove preset''.
171 205
172\item \textbf{Recording} 206\item \textbf{Recording}
173Press F3 to start recording the currently playing station. Press OFF to stop recording. Press PLAY again to seamlessly start recording to a new file. The settings for the recording can be changed in the F1 menu before starting the recording. See page \pageref{ref:Recordingsettings} for details of recording settings. 207 Press F3 to start recording the currently playing station. Press OFF to stop recording. Press PLAY again to seamlessly start recording to a new file. The settings for the recording can be changed in the F1 menu before starting the recording. See page \pageref{ref:Recordingsettings} for details of recording settings.
174 208
175Note: The radio will turn off when playing an MP3. 209 Note: The radio will turn off when playing an MP3.
176\end{itemize} 210\end{itemize}
177 211
178\section{\label{ref:Bookmarkconfig}\label{ref:Bookmarkmenu}Bookmarks} 212\section{\label{ref:Bookmarkconfig}\label{ref:Bookmarkmenu}Bookmarks}
179The bookmarks menu allows you to create and manage bookmark files. 213The bookmarks menu allows you to create and manage bookmark files.
180 214
181\begin{itemize} 215\begin{itemize}
182 216
183\item \textbf{Create Bookmark} 217\item \textbf{Create Bookmark}
184While playing a track, use this option to save your current position within the track so that you can return to it at a later time. Bookmarks are saved on a per folder basis i.e. all of the files in the same folder have their bookmarks stored together. You can store multiple bookmarks for the same track. 218 While playing a track, use this option to save your current position within the track so that you can return to it at a later time. Bookmarks are saved on a per folder basis i.e. all of the files in the same folder have their bookmarks stored together. You can store multiple bookmarks for the same track.
185 219
186\item \textbf{List Bookmarks} 220\item \textbf{List Bookmarks}
187\begin{center} 221 \begin{center}
188 \includegraphics[width=4cm]{main_menu/images/ss-list-bookmarks-112x64x1.png} 222 \includegraphics[width=4cm]{main_menu/images/ss-list-bookmarks-112x64x1.png}
189\end{center} 223 \end{center}
190%\includegraphics[width=4.669cm,height=2.006cm]{images/rockbox-manual-img31.png} 224 %\includegraphics[width=4.669cm,height=2.006cm]{images/rockbox-manual-img31.png}
191While playing a track, use this option to return to any bookmark in the current folder. The bookmark browser screen (shown above) is now displayed. Use the UP and DOWN keys (recorder) or MINUS and PLUS keys (player) to navigate between bookmarks. Press PLAY to jump to a bookmark, ON+PLAY to delete a bookmark or STOP/OFF to exit the browser. 225 While playing a track, use this option to return to any bookmark in the current folder. The bookmark browser screen (shown above) is now displayed. Use the UP and DOWN keys (recorder) or MINUS and PLUS keys (player) to navigate between bookmarks. Press PLAY to jump to a bookmark, ON+PLAY to delete a bookmark or STOP/OFF to exit the browser.
192 226
193\item \textbf {Recent bookmarks} 227\item \textbf {Recent bookmarks}
194If the ``save a list of recently created bookmarks'' option is enabled then you can view a list of several recent bookmarks here and select one to jump straight to that track. This option is off by default. See page \pageref{ref:Bookmarkconfigactual} for more details on configuring bookmarking in Rockbox. 228 If the ``save a list of recently created bookmarks'' option is enabled then you can view a list of several recent bookmarks here and select one to jump straight to that track. This option is off by default. See page \pageref{ref:Bookmarkconfigactual} for more details on configuring bookmarking in Rockbox.
195\end{itemize} 229\end{itemize}
196 230
197\section{\label{ref:playlistoptions}Playlist Options} 231\section{\label{ref:playlistoptions}Playlist Options}
@@ -199,17 +233,16 @@ This menu allows you to work with playlists. Playlists can either be created aut
199 233
200\begin{itemize} 234\begin{itemize}
201\item \textbf{Create Playlist} 235\item \textbf{Create Playlist}
202Rockbox will create a playlist with all tracks in the current directory and all subdirectories. The playlist will be created one folder level ``up'' from 236 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 where you currently are.
203where you currently are. 237
204
205\item \textbf{View Current Playlist} 238\item \textbf{View Current Playlist}
206Displays the contents of the playlist currently stored in memory. 239 Displays the contents of the playlist currently stored in memory.
207 240
208\item \textbf{Save Current Playlist} 241\item \textbf{Save Current Playlist}
209Saves the current dynamic playlist, excluding queued tracks, to the specified file. If no path is provided then playlist is saved to current directory (see page \pageref{ref:Playlistsubmenu}). 242 Saves the current dynamic playlist, excluding queued tracks, to the specified file. If no path is provided then playlist is saved to current directory (see page \pageref{ref:Playlistsubmenu}).
210 243
211\item \textbf{Recursively Insert Directories} 244\item \textbf{Recursively Insert Directories}
212If set to ON then when you insert/queue a directory in Dynamic Playlist, all subdirectories will also be inserted. If set to ASK then you are prompted about recursive insertion when inserting a directory. 245 If set to ON then when you insert/queue a directory in Dynamic Playlist, all subdirectories will also be inserted. If set to ASK then you are prompted about recursive insertion when inserting a directory.
213\end{itemize} 246\end{itemize}
214 247
215\section{Browse Plugins} 248\section{Browse Plugins}
@@ -222,18 +255,18 @@ This option shows MP3 ram buffer size, battery voltage level and estimated time
222On players use the MINUS and PLUS keys to step through several pages of information. 255On players use the MINUS and PLUS keys to step through several pages of information.
223 256
224\begin{itemize} 257\begin{itemize}
225 258
226\item \textbf{Show ID3 info} 259\item \textbf{Show ID3 info}
227This is an alternative way to access the ID3 viewer. See page \pageref{ref:ID3viewer} for details on the ID3 viewer. 260 This is an alternative way to access the ID3 viewer. See page \pageref{ref:ID3viewer} for details on the ID3 viewer.
228\item \textbf{Rockbox Info} 261\item \textbf{Rockbox Info}
229Displays some basic system information. This is, from top to bottom, the amount of memory Rockbox has available for storing music (the buffer), battery status, hard disk size and the amount of free space on the disk. 262 Displays some basic system information. This is, from top to bottom, the amount of memory Rockbox has available for storing music (the buffer), battery status, hard disk size and the amount of free space on the disk.
230 263
231\item \textbf{Version} 264\item \textbf{Version}
232Software version and credits display. 265 Software version and credits display.
233 266
234\item \textbf{Debug (Keep Out!)} 267\item \textbf{Debug (Keep Out!)}
235This submenu is intended to be used only by Rockbox developers. It shows hardware, disk, battery status and a lot of other information. It is not recommended that users access this menu unless instructed to do so in the course of fixing a problem with Rockbox. In particular the ``Dump ROM Contents'', ``View/clear RTC RAM'' and ``Screenshot'' and ``Sound test'' functions should be treated with care. 268 This submenu is intended to be used only by Rockbox developers. It shows hardware, disk, battery status and a lot of other information. It is not recommended that users access this menu unless instructed to do so in the course of fixing a problem with Rockbox. In particular the ``Dump ROM Contents'', ``View/clear RTC RAM'' and ``Screenshot'' and ``Sound test'' functions should be treated with care.
236\end{itemize} 269\end{itemize}
237 270
238\section{Shutdown (Player)} 271\section{Shutdown (Player)}
239This menu option saves the Rockbox configuration and turns off the hard drive before shutting down the machine. For maximum safety this procedure is recommended when turning off the Jukebox. (There is a very small risk of hard disk corruption otherwise.) See page \pageref{ref:Safeshutdown} for more details. 272This menu option saves the Rockbox configuration and turns off the hard drive before shutting down the machine. For maximum safety this procedure is recommended when turning off the Jukebox. (There is a very small risk of hard disk corruption otherwise.) See page \pageref{ref:Safeshutdown} for more details. \ No newline at end of file