From 909b9462da8387e1c8379a52058c61bf18e222e5 Mon Sep 17 00:00:00 2001 From: Nils Wallménius Date: Sat, 3 Mar 2007 00:07:31 +0000 Subject: Update the manual to reflect recent menu changes, add descriptions of how to move and remove tracks in the playlist viewer, Recording settings are now in their own chapter. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12553 a1c6a512-1295-4272-9138-f99709370657 --- manual/configure_rockbox/database.tex | 5 + manual/configure_rockbox/display_options.tex | 2 +- manual/configure_rockbox/file_view.tex | 10 -- manual/configure_rockbox/main.tex | 10 +- manual/configure_rockbox/playback_options.tex | 22 +--- manual/configure_rockbox/playlist_options.tex | 14 +++ manual/configure_rockbox/recording_settings.tex | 161 ++++++++++++++++++++++++ manual/configure_rockbox/system_options.tex | 19 +-- 8 files changed, 206 insertions(+), 37 deletions(-) create mode 100644 manual/configure_rockbox/database.tex create mode 100644 manual/configure_rockbox/playlist_options.tex create mode 100644 manual/configure_rockbox/recording_settings.tex (limited to 'manual/configure_rockbox') 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 @@ +% $Id: $ % +\section{Database} + This sub menu allows you to configure the database. + See \reference{ref:database} for more information about using + 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 @@ % $Id$ % -\section{\label{ref:Displayoptions}Display Options} +\section{\label{ref:Displayoptions}Display} \begin{description} \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. hidden. \item[Playlists:] The \setting{File Browser} displays only directories and playlists, for simplified navigation. - \item[Database:] This shows the files based on the \setting{Database} - information, thus disabling the \setting{File Browser}. You can browse the - database by various tags and search them. Only information present - in music file tags are shown. For a detailed description of - \setting{Database} refer to \reference{ref:database}. - \end{description} \item[Follow Playlist:] @@ -64,8 +58,4 @@ displays files. If set to \setting{Current Directory Only} only the name of the current directory will be displayed. -\item[Database:] - This option allows you to configure the database. - See \reference{ref:database} for more information about using - the database. \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 @@ \label{ref:configure_rockbox_general} \input{configure_rockbox/general_settings.tex} \input{configure_rockbox/playback_options.tex} + \input{configure_rockbox/playlist_options.tex} \input{configure_rockbox/file_view.tex} + \input{configure_rockbox/database.tex} \input{configure_rockbox/display_options.tex} \input{configure_rockbox/system_options.tex} \input{configure_rockbox/bookmarking.tex} \input{configure_rockbox/language.tex} - \input{configure_rockbox/voice.tex} \ No newline at end of file + \input{configure_rockbox/voice.tex} + +\opt{HAVE_RECORDING}{ +\chapter{Recording Settings} +\label{ref:Recordingsettings} + \input{configure_rockbox/recording_settings.tex} +} 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 @@ % $Id$ % -\section{\label{ref:PlaybackOptions}Playback Options} -The \setting{Playback Options} sub menu allows you to configure settings +\section{\label{ref:PlaybackOptions}Playback} +The \setting{Playback} sub menu allows you to configure settings related to audio playback. \begin{description} \item[Shuffle. ]Alters how Rockbox will select which song to play next.\\ @@ -56,31 +56,19 @@ related to audio playback. } } \end{description} - + \item[Play Selected First. ]This setting controls what happens when you select a file for playback while shuffle mode is on. If the \setting{Play Selected First} setting is \setting{Yes}, the file you selected will be played first. If this setting is \setting{No}, a random file in the directory will be played first. - -\item[Resume on Startup. ]Rockbox can be configured to start playing automatically - when you turn on the \dap. If the resume function is set to start - automatically playing, Rockbox will start at the point where you last - turned off the \dap. The options for the \setting{Resume on Startup} - function are: - \begin{description} - \item[Yes. ]Rockbox will unconditionally try to resume. - \item[No. ]Rockbox will not resume. - \note{If \setting{Resume on Startup} is set to \setting{No}, Rockbox will - start in the \setting{File Browser}.} - \end{description} - + \item[Fast-Forward/Rewind. ]How fast you want search (fast forward or rewind) to accelerate when you hold down the button. \setting{Off} means no acceleration. \setting{2x/1s} means double the search speed once every second the button is held. \setting{2x/5s} means double the search speed once every 5 seconds the button is held. - + \item[Anti-Skip Buffer. ]This setting allows you to control how much music is stored in the \daps{} memory whilst playing a song, acting as a buffer 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 @@ +% $Id:$ % +\section{\label{ref:PlaylistOptions}Playlist} +The \setting{Playlist} sub menu allows you to configure settings +related to playlists. +\begin{description} +\item[Recursively Insert Directories. ] + If set to \setting{On}, then when a directory is inserted or queued into a + dynamic playlist, all sub-directories will also be inserted. If set to \setting{Ask}, + Rockbox will prompt the user about whether to include sub-directories. + +\item[Warn When Erasing Dynamic Playlist. ] + If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to + take an action that will cause Rockbox to erase the current dynamic playlist. +\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 @@ +% $Id:$ % +\screenshot{main_menu/images/ss-recording-settings}{The recording settings screen}{} + +\opt{MASCODEC}{ + \section{Quality} + 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. + + 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. + + \begin{table}[h!] + \begin{center} + \begin{tabularx}{0.75\textwidth}{lX}\toprule + \emph{Frequency} & \emph{Bitrate} (Kbit/s) -- quality 0$\rightarrow$7 \\\midrule + 44100Hz stereo & 75, 80, 90, 100, 120, 140, 160, 170 \\ + 22050Hz stereo & 39, 41, 45, 50, 60, 80, 110, 130 \\ + 44100Hz mono & 65, 68, 73, 80, 90, 105, 125, 140 \\ + 22050Hz mono & 35, 38, 40, 45, 50, 60, 75, 90 \\\bottomrule + \end{tabularx} + \end{center} + \end{table} +} + +\opt{SWCODEC}{ + \section{Format} + Choose which format to save your recording in. The available choices are + the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the + losslessly compressed \setting{WavPack} and the lossy + \setting{MPEG Layer 3}. + + \section{Encoder Settings} + This sets the bitrate when using the \setting{MPEG Layer 3} format. And has + no settings for the other formats. +} + + \section{Frequency} + Choose the recording frequency (sample rate). + \opt{MASCODEC}{48kHz, 44.1kHz, 32kHz, 24kHz, 22.05kHz, 16kHz} + \opt{h1xx,h300}{44.1kHz, 22.05kHz and 11.025kHz} + \opt{x5}{88.2kHz, 44.1kHz, 22.05kHz and 11.025kHz} + are available. Higher sample rates use up more disk space, but give better + sound quality. + \opt{SWCODEC}{\note{The 11.025kHz setting is not available when using% + \setting{MPEG Layer 3} format.} + }% + \opt{MASCODEC}{ + The frequency setting also determines which version of the MPEG standard + the sound is recorded using:\\ + MPEG v1 for 48, 44.1 and 32\\ + MPEG v2 for 24, 22.05 and 16\\ + } + \opt{recorder,recorderv2fm,h1xx} + {\note{You cannot change the sample rate for digital recordings.} + } + +\section{Source} + Choose the source of the recording. This can be + \opt{recorder,recorderv2fm,h1xx}{\setting{SPDIF (digital)},}% + \setting{Mic} or \setting{Line In}. + \opt{CONFIG_TUNER}{For recording from the radio see \reference{ref:FMradio}.} + +\section{Channels} + 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. + +\opt{MASCODEC}{ + \section{Independent Frames} + 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. +} + +\section{File Split Options} + This sub menu contains options for file splitting, which can be used to split + up long recordings into manageable pieces. 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. + \begin{description} + \item[Split Measure:] + This option controls wether to split the recording when the + \setting{Split Filesize} is reached or when the + \setting{Split Time} has elapsed. + + \item[What to do when Splitting:] + This controls what will happend when the splitting condition is + fullfilled the two available options here are + \setting{Start a new file} or \setting{Stop recording}. + + \item[Split Time:] + Set the time to record between each split, if time is used as + \setting{Split Measure}.\\ + Options (hours:minutes between splits): Off, 00:05, 00:10, 00:15, 00:30, + 1:00, 1:14 (74 minute CD), 1:20 (80 minute CD), 2:00, 4:00, 8:00, 10:00, + 12:00, 18:00, 24:00. + + \item[Split Filesize:] + Set the filesize to record between each split, if filesize is used as + \setting{Split Measure}. + + \end{description} + +\section{Prerecord Time} + 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. + +\section{Directory} + Allows changing the location where the recorded files are saved. The + default location is \fname{/recordings}. If set to + \setting{Current Directory} the recorded files will be saved in the + directory where the \setting{File Browser} was left. + +\nopt{ondio}{ + \section{Clipping Light} + Causes the backlight to flash on when clipping has been detected.\\ + Options: \setting{Off}, \setting{Main unit only}, + \setting{Main and remote unit}, \setting{Remote unit only}. +} + \section{Trigger} + \fixme{Add description of triggered recording.} + +\opt{h1xx,h300}{% + \section{Automatic Gain Control} + The \setting{Automatic Gain Control} has five different presets for + automatically controlling the gain while recording. + \begin{description} + \item[Safety (clip):] + This preset will lower the gain when the levels get too high (-1dB) + and will never increase gain. + + \item[Live (slow):] + This preset is designed to be used for recording of live shows and has + quite large headroom for loud parts. It heads for a nominal target peak + level of -9dB and will slowly increase or decrease gain to reach it. + + \item[DJ-Set (slow):] + This preset heads for a nominal target peak level of -5dB and will + slowly increase or decrease gain to reach it. + + \item[Medium:] + This preset heads for a nominal target peak level of -6dB and will + increase or decrease gain to reach it. + + \item[Voice (fast):] + This preset is designed to be used for voice recording and heads for a + nominal target peak level of -7dB and will quickly increase or + decrease gain to reach it. + \end{description} + + \section{AGC clip time} + This setting controls how long the level is too loud or soft before the + \setting{Automatic Gain Control} kicks in. +}% 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 @@ % $Id$ % -\section{\label{ref:SystemOptions}System Options} +\section{\label{ref:SystemOptions}System} +\subsection{Start Screen} + Set the screen that Rockbox will start in. Selecting + \setting{Resume Playback} will resume playback where it was when the \dap{} + was shut off if there is a playlist to resume and will then end up in the + WPS. Selecting \setting{Previous Screen} will make Rockbox start in the + screen it was when the \dap{} was shut off. \subsection{Battery} 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 recording. Settings are either \setting{Off} or \setting{1} to \setting{10} minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are available. -\subsection{Sleep Timer} -This option lets you power off your \dap{} after playing for a given time. Can -be set from \setting{Off} to 5 hours in 5 minute steps. -\opt{recorderv2fm}{This setting is reset on boot. Using this option - disables the \setting{Wake up alarm} (see below). - \subsection{Wake Up alarm} + +\opt{HAVE_RTC_ALARM}{ +\subsection{Wake Up alarm} This option turns the \dap{} off and then starts it up again at the specified time. This is most useful when combined with the \setting{Resume} 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. \ButtonPlay{} confirms the alarm and shuts your \dap{} down, and \ButtonOff cancels setting an alarm. If the \dap{} is turned on again before the alarm occurs, the alarm will be cancelled. Using this option disables the - \setting{Sleep Timer}(see above). + \setting{Sleep Timer}. } \subsection{Limits} -- cgit v1.2.3