devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Opt out some SWCODEC only information from archos manuals and made some small tweaks

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10872 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Nils Wallménius 2006-09-03 16:43:06 +00:00
parent 630c300660
commit 86171f28cc
1 changed files with 44 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

79
manual/rockbox_interface/tagcache.tex
View file

@ -2,10 +2,11 @@
\section{\label{ref:tagcache}Tag Cache} \section{\label{ref:tagcache}Tag Cache}
\subsection{Introduction} \subsection{Introduction}
Tag Cache is the Rockbox music database system. Using the information Tag Cache is the Rockbox music database system. Using the information
contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your contained in the tags (ID3v1, ID3v2%
audio files, Rockbox builds and maintains a database of the music files on \opt{SWCODEC}{, Vorbis Comments, Apev2, etc.}%
your player and allows you to browse them by Artist, Album and Genre. ) in your audio files, Rockbox builds and maintains a database of the music
files on your player and allows you to browse them by Artist, Album and Genre.
\subsection{Initializing the Tag Cache} \subsection{Initializing the Tag Cache}
Before you use the Tag Cache for the first time, you must initialize it by using Before you use the Tag Cache for the first time, you must initialize it by using
@ -23,40 +24,49 @@ described in the following section.
option to \setting{No} keeps the tagcache on the disk, meaning slower option to \setting{No} keeps the tagcache on the disk, meaning slower
browsing but it does not use extra RAM and saves some battery on boot up. browsing but it does not use extra RAM and saves some battery on boot up.
\note{If you use TagCache frequently, you should load to RAM, as this \note{If you browse your music frequently using Tag Cache, you should load
will reduce the overall battery consumption because the disk will not to RAM, as this will reduce the overall battery consumption because the
need to spin on each search.} disk will not need to spin on each search.}
} }
\item[Auto Update: ] \item[Auto Update: ]
If \setting{Auto update} is set to \setting{on}, each time the \dap{} If \setting{Auto update} is set to \setting{on}, each time the \dap{}
boots, Tag Cache will automatically do everything that the boots, Tag Cache will automatically update the database.
\setting{Update now} setting does. Note that the \setting{Auto \opt{SWCODEC}{
Update} will only check for deleted files if the Directory Cache \note{The \setting{Auto Update} will only check for deleted files if the
(\setting{General Settings $\rightarrow$ System $\rightarrow$ \setting{Directory Cache} (\setting{General Settings $\rightarrow$ System
Disk $\rightarrow$ Directory Cache}) is enabled. $\rightarrow$ Disk $\rightarrow$ Directory Cache}) is enabled.
\setting{Update now} includes that check whether dircache has been enabled or \setting{Update now} includes that check whether dircache has been
not. enabled or not.}
}%
\opt{MASCODEC}{\setting{Auto Update} does not detect deleted files. To remove
deleted files from the database you need to run \setting{Update Now}.}%
\item[Initialize Now: ] \item[Initialize Now: ]
Before you use the Tag Cache for the first time, you must initialize it by Before you use the Tag Cache for the first time, you must initialize it by
using the \setting{Initialize Now} function in the \setting{Tag Cache using the \setting{Initialize Now} function in the \setting{Tag Cache
Menu}. \setting{Initialize Now} removes all database files (removing Menu}.
runtimedb data also) and rebuilds the database from scratch. This takes \warn{\setting{Initialize Now} removes all database files (removing
approximately 5 to 10 minutes, and may require a restart to allow the runtimedb data also) and rebuilds the database from scratch.}
files to be committed to the cache. This can take quite a while depending on the number of music files on your
\dap{}, and may require a restart to allow the files to be committed to the
The Tag Cache initialization happens in the background, so you can continue cache.
to listen to music while the Tag Cache is being initialized. If you shut
down your player during initialization, the database building process will The Tag Cache initialization happens in the background, so you can continue
to listen to music while the Tag Cache is being initialized. If you shut
down your player during initialization, the database building process will
continue next time you turn it on. continue next time you turn it on.
\item[Update Now: ] \item[Update Now: ]
\setting{Update now} causes Tag Cache to detect new and deleted files \setting{Update now} causes Tag Cache to detect new and deleted files
Note that unlike the \setting{Auto Update} function, \setting{Update Now} \opt{SWCODEC}{
will update the database regardless of whether the \setting{Directory Cache} \note{Unlike the \setting{Auto Update} function, \setting{Update Now}
is enabled. Thus, an update using \setting{Update now} may take a long will update the database regardless of whether the \setting{Directory Cache}
time. Unlike \setting{Initialize Now}, the \setting{Update Now} function is enabled. Thus, an update using \setting{Update now} may take a long
time.
}
}
Unlike \setting{Initialize Now}, the \setting{Update Now} function
does not remove runtime database information. does not remove runtime database information.
\item[Gather Runtime Data (Experimental): ] \item[Gather Runtime Data (Experimental): ]
@ -66,8 +76,8 @@ described in the following section.
\item[Export modifications: ] \item[Export modifications: ]
This allows for the runtime data to be exported into \\ This allows for the runtime data to be exported into \\
\fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in
ASCII format. This is needed when Tag Cache structures change, because new ASCII format. This is needed when Tag Cache structures change, because new
code cannot read old Tag Cache database code. But, all modifications code cannot read old Tag Cache database code. But, all modifications
exported to ASCII format should be readable by all Tag Cache versions. exported to ASCII format should be readable by all Tag Cache versions.
\item[Import modifications: ] \item[Import modifications: ]
@ -79,10 +89,10 @@ described in the following section.
\subsection{Using the Tag Cache} \subsection{Using the Tag Cache}
Once the Tag Cache has been initialized, you can browse your music by Artist, Once the Tag Cache has been initialized, you can browse your music by Artist,
Album, Genre and Song Name. To use the Tag Cache, change the Album, Genre and Song Name. To use the Tag Cache, change the
\setting{Show Files} show mode by changing the \setting{General Settings \setting{Show Files} show mode by changing the \setting{General Settings
$\rightarrow$ File View $\rightarrow$ Show files} option to $\rightarrow$ File View $\rightarrow$ Show files} option to
\setting{ID3 database}. This disables the \setting{File Browser} and instead \setting{ID3 database}. This disables the \setting{File Browser} and instead
allows you to view files using the information in the Tag Cache database.\\ allows you to view files using the information in the Tag Cache database.\\
\note{You may need to increase the value of the \setting{Max files in dir \note{You may need to increase the value of the \setting{Max files in dir
@ -111,4 +121,3 @@ to RAM.}
\end{tabularx} \end{tabularx}
\end{center} \end{center}
\end{table} \end{table}