summaryrefslogtreecommitdiff
path: root/manual/configure_rockbox
diff options
context:
space:
mode:
Diffstat (limited to 'manual/configure_rockbox')
-rw-r--r--manual/configure_rockbox/database.tex5
-rw-r--r--manual/configure_rockbox/display_options.tex2
-rw-r--r--manual/configure_rockbox/file_view.tex10
-rw-r--r--manual/configure_rockbox/main.tex10
-rw-r--r--manual/configure_rockbox/playback_options.tex22
-rw-r--r--manual/configure_rockbox/playlist_options.tex14
-rw-r--r--manual/configure_rockbox/recording_settings.tex161
-rw-r--r--manual/configure_rockbox/system_options.tex19
8 files changed, 206 insertions, 37 deletions
diff --git a/manual/configure_rockbox/database.tex b/manual/configure_rockbox/database.tex
new file mode 100644
index 0000000000..dcdeb36b6e
--- /dev/null
+++ b/manual/configure_rockbox/database.tex
@@ -0,0 +1,5 @@
1% $Id: $ %
2\section{Database}
3 This sub menu allows you to configure the database.
4 See \reference{ref:database} for more information about using
5 the database.
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index cca0ecdeb0..0b96c5ebce 100644
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -1,5 +1,5 @@
1% $Id$ % 1% $Id$ %
2\section{\label{ref:Displayoptions}Display Options} 2\section{\label{ref:Displayoptions}Display}
3 3
4 \begin{description} 4 \begin{description}
5 \nopt{player}{ 5 \nopt{player}{
diff --git a/manual/configure_rockbox/file_view.tex b/manual/configure_rockbox/file_view.tex
index 98a47854c7..50ef547f89 100644
--- a/manual/configure_rockbox/file_view.tex
+++ b/manual/configure_rockbox/file_view.tex
@@ -36,12 +36,6 @@ displays files.
36 hidden. 36 hidden.
37 \item[Playlists:] The \setting{File Browser} displays only directories and playlists, 37 \item[Playlists:] The \setting{File Browser} displays only directories and playlists,
38 for simplified navigation. 38 for simplified navigation.
39 \item[Database:] This shows the files based on the \setting{Database}
40 information, thus disabling the \setting{File Browser}. You can browse the
41 database by various tags and search them. Only information present
42 in music file tags are shown. For a detailed description of
43 \setting{Database} refer to \reference{ref:database}.
44
45 \end{description} 39 \end{description}
46 40
47\item[Follow Playlist:] 41\item[Follow Playlist:]
@@ -64,8 +58,4 @@ displays files.
64 If set to \setting{Current Directory Only} only the name of the current 58 If set to \setting{Current Directory Only} only the name of the current
65 directory will be displayed. 59 directory will be displayed.
66 60
67\item[Database:]
68 This option allows you to configure the database.
69 See \reference{ref:database} for more information about using
70 the database.
71\end{description} 61\end{description}
diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex
index bec668395b..b234892539 100644
--- a/manual/configure_rockbox/main.tex
+++ b/manual/configure_rockbox/main.tex
@@ -6,9 +6,17 @@
6\label{ref:configure_rockbox_general} 6\label{ref:configure_rockbox_general}
7 \input{configure_rockbox/general_settings.tex} 7 \input{configure_rockbox/general_settings.tex}
8 \input{configure_rockbox/playback_options.tex} 8 \input{configure_rockbox/playback_options.tex}
9 \input{configure_rockbox/playlist_options.tex}
9 \input{configure_rockbox/file_view.tex} 10 \input{configure_rockbox/file_view.tex}
11 \input{configure_rockbox/database.tex}
10 \input{configure_rockbox/display_options.tex} 12 \input{configure_rockbox/display_options.tex}
11 \input{configure_rockbox/system_options.tex} 13 \input{configure_rockbox/system_options.tex}
12 \input{configure_rockbox/bookmarking.tex} 14 \input{configure_rockbox/bookmarking.tex}
13 \input{configure_rockbox/language.tex} 15 \input{configure_rockbox/language.tex}
14 \input{configure_rockbox/voice.tex} \ No newline at end of file 16 \input{configure_rockbox/voice.tex}
17
18\opt{HAVE_RECORDING}{
19\chapter{Recording Settings}
20\label{ref:Recordingsettings}
21 \input{configure_rockbox/recording_settings.tex}
22}
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index b73301baa5..4e6346b26e 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -1,6 +1,6 @@
1% $Id$ % 1% $Id$ %
2\section{\label{ref:PlaybackOptions}Playback Options} 2\section{\label{ref:PlaybackOptions}Playback}
3The \setting{Playback Options} sub menu allows you to configure settings 3The \setting{Playback} sub menu allows you to configure settings
4related to audio playback. 4related to audio playback.
5\begin{description} 5\begin{description}
6\item[Shuffle. ]Alters how Rockbox will select which song to play next.\\ 6\item[Shuffle. ]Alters how Rockbox will select which song to play next.\\
@@ -56,31 +56,19 @@ related to audio playback.
56 } 56 }
57 } 57 }
58 \end{description} 58 \end{description}
59 59
60\item[Play Selected First. ]This setting controls what happens when you 60\item[Play Selected First. ]This setting controls what happens when you
61 select a file for playback while shuffle mode is on. If the 61 select a file for playback while shuffle mode is on. If the
62 \setting{Play Selected First} setting is \setting{Yes}, the file you 62 \setting{Play Selected First} setting is \setting{Yes}, the file you
63 selected will be played first. If this setting is \setting{No}, a random 63 selected will be played first. If this setting is \setting{No}, a random
64 file in the directory will be played first. 64 file in the directory will be played first.
65 65
66\item[Resume on Startup. ]Rockbox can be configured to start playing automatically
67 when you turn on the \dap. If the resume function is set to start
68 automatically playing, Rockbox will start at the point where you last
69 turned off the \dap. The options for the \setting{Resume on Startup}
70 function are:
71 \begin{description}
72 \item[Yes. ]Rockbox will unconditionally try to resume.
73 \item[No. ]Rockbox will not resume.
74 \note{If \setting{Resume on Startup} is set to \setting{No}, Rockbox will
75 start in the \setting{File Browser}.}
76 \end{description}
77
78 \item[Fast-Forward/Rewind. ]How fast you want search (fast forward or rewind) 66 \item[Fast-Forward/Rewind. ]How fast you want search (fast forward or rewind)
79 to accelerate when you hold down the button. \setting{Off} means no 67 to accelerate when you hold down the button. \setting{Off} means no
80 acceleration. \setting{2x/1s} means double the search speed once every 68 acceleration. \setting{2x/1s} means double the search speed once every
81 second the button is held. \setting{2x/5s} means double the search speed 69 second the button is held. \setting{2x/5s} means double the search speed
82 once every 5 seconds the button is held. 70 once every 5 seconds the button is held.
83 71
84 \item[Anti-Skip Buffer. ]This setting allows you to control how much music is 72 \item[Anti-Skip Buffer. ]This setting allows you to control how much music is
85 stored in the \daps{} memory whilst playing a song, acting as a buffer 73 stored in the \daps{} memory whilst playing a song, acting as a buffer
86 against shock or playback problems. The \dap{} transfers the selected 74 against shock or playback problems. The \dap{} transfers the selected
diff --git a/manual/configure_rockbox/playlist_options.tex b/manual/configure_rockbox/playlist_options.tex
new file mode 100644
index 0000000000..dbddad03e6
--- /dev/null
+++ b/manual/configure_rockbox/playlist_options.tex
@@ -0,0 +1,14 @@
1% $Id:$ %
2\section{\label{ref:PlaylistOptions}Playlist}
3The \setting{Playlist} sub menu allows you to configure settings
4related to playlists.
5\begin{description}
6\item[Recursively Insert Directories. ]
7 If set to \setting{On}, then when a directory is inserted or queued into a
8 dynamic playlist, all sub-directories will also be inserted. If set to \setting{Ask},
9 Rockbox will prompt the user about whether to include sub-directories.
10
11\item[Warn When Erasing Dynamic Playlist. ]
12 If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
13 take an action that will cause Rockbox to erase the current dynamic playlist.
14\end{description}
diff --git a/manual/configure_rockbox/recording_settings.tex b/manual/configure_rockbox/recording_settings.tex
new file mode 100644
index 0000000000..ce9abc2368
--- /dev/null
+++ b/manual/configure_rockbox/recording_settings.tex
@@ -0,0 +1,161 @@
1% $Id:$ %
2\screenshot{main_menu/images/ss-recording-settings}{The recording settings screen}{}
3
4\opt{MASCODEC}{
5 \section{Quality}
6 Choose the quality here (0 to 7). Default is 5, best quality is 7,
7 smallest file size is 0. This setting effects how much your sound
8 sample will be compressed. Higher quality settings result in larger
9 MP3 files.
10
11 The quality setting is just a way of selecting an average bit rate,
12 or number of bits per second, for a recording. When this setting
13 is lowered, recordings are compressed more (meaning worse sound quality),
14 and the average bitrate changes as follows.
15
16 \begin{table}[h!]
17 \begin{center}
18 \begin{tabularx}{0.75\textwidth}{lX}\toprule
19 \emph{Frequency} & \emph{Bitrate} (Kbit/s) -- quality 0$\rightarrow$7 \\\midrule
20 44100Hz stereo & 75, 80, 90, 100, 120, 140, 160, 170 \\
21 22050Hz stereo & 39, 41, 45, 50, 60, 80, 110, 130 \\
22 44100Hz mono & 65, 68, 73, 80, 90, 105, 125, 140 \\
23 22050Hz mono & 35, 38, 40, 45, 50, 60, 75, 90 \\\bottomrule
24 \end{tabularx}
25 \end{center}
26 \end{table}
27}
28
29\opt{SWCODEC}{
30 \section{Format}
31 Choose which format to save your recording in. The available choices are
32 the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the
33 losslessly compressed \setting{WavPack} and the lossy
34 \setting{MPEG Layer 3}.
35
36 \section{Encoder Settings}
37 This sets the bitrate when using the \setting{MPEG Layer 3} format. And has
38 no settings for the other formats.
39}
40
41 \section{Frequency}
42 Choose the recording frequency (sample rate).
43 \opt{MASCODEC}{48kHz, 44.1kHz, 32kHz, 24kHz, 22.05kHz, 16kHz}
44 \opt{h1xx,h300}{44.1kHz, 22.05kHz and 11.025kHz}
45 \opt{x5}{88.2kHz, 44.1kHz, 22.05kHz and 11.025kHz}
46 are available. Higher sample rates use up more disk space, but give better
47 sound quality.
48 \opt{SWCODEC}{\note{The 11.025kHz setting is not available when using%
49 \setting{MPEG Layer 3} format.}
50 }%
51 \opt{MASCODEC}{
52 The frequency setting also determines which version of the MPEG standard
53 the sound is recorded using:\\
54 MPEG v1 for 48, 44.1 and 32\\
55 MPEG v2 for 24, 22.05 and 16\\
56 }
57 \opt{recorder,recorderv2fm,h1xx}
58 {\note{You cannot change the sample rate for digital recordings.}
59 }
60
61\section{Source}
62 Choose the source of the recording. This can be
63 \opt{recorder,recorderv2fm,h1xx}{\setting{SPDIF (digital)},}%
64 \setting{Mic} or \setting{Line In}.
65 \opt{CONFIG_TUNER}{For recording from the radio see \reference{ref:FMradio}.}
66
67\section{Channels}
68 This allows you to select mono or stereo recording. Please note that
69 for mono recording, only the left channel is recorded. Mono recordings
70 are usually somewhat smaller than stereo.
71
72\opt{MASCODEC}{
73 \section{Independent Frames}
74 The independent frames option tells the \dap{} to encode with the bit
75 reservoir disabled, so the frames are independent of each other. This
76 makes a file easier to edit.
77}
78
79\section{File Split Options}
80 This sub menu contains options for file splitting, which can be used to split
81 up long recordings into manageable pieces. The splits are seamless (frame
82 accurate), no audio is lost at the split point. The break between recordings
83 is only the time required to stop and restart the recording, on the order of
84 2 -- 4 seconds.
85 \begin{description}
86 \item[Split Measure:]
87 This option controls wether to split the recording when the
88 \setting{Split Filesize} is reached or when the
89 \setting{Split Time} has elapsed.
90
91 \item[What to do when Splitting:]
92 This controls what will happend when the splitting condition is
93 fullfilled the two available options here are
94 \setting{Start a new file} or \setting{Stop recording}.
95
96 \item[Split Time:]
97 Set the time to record between each split, if time is used as
98 \setting{Split Measure}.\\
99 Options (hours:minutes between splits): Off, 00:05, 00:10, 00:15, 00:30,
100 1:00, 1:14 (74 minute CD), 1:20 (80 minute CD), 2:00, 4:00, 8:00, 10:00,
101 12:00, 18:00, 24:00.
102
103 \item[Split Filesize:]
104 Set the filesize to record between each split, if filesize is used as
105 \setting{Split Measure}.
106
107 \end{description}
108
109\section{Prerecord Time}
110 This setting buffers a small amount of audio so that when the record button
111 is pressed, the recording will begin from that number of seconds earlier.
112 This is useful for ensuring that a recording begins before a cue that is
113 being waited for.
114
115\section{Directory}
116 Allows changing the location where the recorded files are saved. The
117 default location is \fname{/recordings}. If set to
118 \setting{Current Directory} the recorded files will be saved in the
119 directory where the \setting{File Browser} was left.
120
121\nopt{ondio}{
122 \section{Clipping Light}
123 Causes the backlight to flash on when clipping has been detected.\\
124 Options: \setting{Off}, \setting{Main unit only},
125 \setting{Main and remote unit}, \setting{Remote unit only}.
126}
127 \section{Trigger}
128 \fixme{Add description of triggered recording.}
129
130\opt{h1xx,h300}{%
131 \section{Automatic Gain Control}
132 The \setting{Automatic Gain Control} has five different presets for
133 automatically controlling the gain while recording.
134 \begin{description}
135 \item[Safety (clip):]
136 This preset will lower the gain when the levels get too high (-1dB)
137 and will never increase gain.
138
139 \item[Live (slow):]
140 This preset is designed to be used for recording of live shows and has
141 quite large headroom for loud parts. It heads for a nominal target peak
142 level of -9dB and will slowly increase or decrease gain to reach it.
143
144 \item[DJ-Set (slow):]
145 This preset heads for a nominal target peak level of -5dB and will
146 slowly increase or decrease gain to reach it.
147
148 \item[Medium:]
149 This preset heads for a nominal target peak level of -6dB and will
150 increase or decrease gain to reach it.
151
152 \item[Voice (fast):]
153 This preset is designed to be used for voice recording and heads for a
154 nominal target peak level of -7dB and will quickly increase or
155 decrease gain to reach it.
156 \end{description}
157
158 \section{AGC clip time}
159 This setting controls how long the level is too loud or soft before the
160 \setting{Automatic Gain Control} kicks in.
161}%
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index 984c5ee202..16e0a32f55 100644
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -1,5 +1,11 @@
1% $Id$ % 1% $Id$ %
2\section{\label{ref:SystemOptions}System Options} 2\section{\label{ref:SystemOptions}System}
3\subsection{Start Screen}
4 Set the screen that Rockbox will start in. Selecting
5 \setting{Resume Playback} will resume playback where it was when the \dap{}
6 was shut off if there is a playlist to resume and will then end up in the
7 WPS. Selecting \setting{Previous Screen} will make Rockbox start in the
8 screen it was when the \dap{} was shut off.
3 9
4\subsection{Battery} 10\subsection{Battery}
5 Options relating to the \opt{archos}{batteries}\nopt{archos}{battery}% 11 Options relating to the \opt{archos}{batteries}\nopt{archos}{battery}%
@@ -78,12 +84,9 @@ paused. It is not idle while the USB or charger is connected, or while
78recording. Settings are either \setting{Off} or \setting{1} to \setting{10} 84recording. Settings are either \setting{Off} or \setting{1} to \setting{10}
79minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are 85minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are
80available. 86available.
81\subsection{Sleep Timer} 87
82This option lets you power off your \dap{} after playing for a given time. Can 88\opt{HAVE_RTC_ALARM}{
83be set from \setting{Off} to 5 hours in 5 minute steps. 89\subsection{Wake Up alarm}
84\opt{recorderv2fm}{This setting is reset on boot. Using this option
85 disables the \setting{Wake up alarm} (see below).
86 \subsection{Wake Up alarm}
87 This option turns the \dap{} off and then starts it up again at the 90 This option turns the \dap{} off and then starts it up again at the
88 specified time. This is most useful when combined with the \setting{Resume} 91 specified time. This is most useful when combined with the \setting{Resume}
89 setting in the \setting{Playback Options} menu is set to \setting{Yes}, so 92 setting in the \setting{Playback Options} menu is set to \setting{Yes}, so
@@ -93,7 +96,7 @@ be set from \setting{Off} to 5 hours in 5 minute steps.
93 \ButtonPlay{} confirms the alarm and shuts your \dap{} down, and \ButtonOff 96 \ButtonPlay{} confirms the alarm and shuts your \dap{} down, and \ButtonOff
94 cancels setting an alarm. If the \dap{} is turned on again before the alarm 97 cancels setting an alarm. If the \dap{} is turned on again before the alarm
95 occurs, the alarm will be cancelled. Using this option disables the 98 occurs, the alarm will be cancelled. Using this option disables the
96 \setting{Sleep Timer}(see above). 99 \setting{Sleep Timer}.
97} 100}
98 101
99\subsection{Limits} 102\subsection{Limits}