summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
Diffstat (limited to 'manual')
-rw-r--r--manual/rockbox_interface/tagcache.tex79
1 files changed, 44 insertions, 35 deletions
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex
index 1343957d87..7ade78d7df 100644
--- a/manual/rockbox_interface/tagcache.tex
+++ b/manual/rockbox_interface/tagcache.tex
@@ -2,10 +2,11 @@
2\section{\label{ref:tagcache}Tag Cache} 2\section{\label{ref:tagcache}Tag Cache}
3 3
4\subsection{Introduction} 4\subsection{Introduction}
5Tag Cache is the Rockbox music database system. Using the information 5Tag Cache is the Rockbox music database system. Using the information
6contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your 6contained in the tags (ID3v1, ID3v2%
7audio files, Rockbox builds and maintains a database of the music files on 7 \opt{SWCODEC}{, Vorbis Comments, Apev2, etc.}%
8your player and allows you to browse them by Artist, Album and Genre. 8) in your audio files, Rockbox builds and maintains a database of the music
9files on your player and allows you to browse them by Artist, Album and Genre.
9 10
10\subsection{Initializing the Tag Cache} 11\subsection{Initializing the Tag Cache}
11Before you use the Tag Cache for the first time, you must initialize it by using 12Before you use the Tag Cache for the first time, you must initialize it by using
@@ -23,40 +24,49 @@ described in the following section.
23 option to \setting{No} keeps the tagcache on the disk, meaning slower 24 option to \setting{No} keeps the tagcache on the disk, meaning slower
24 browsing but it does not use extra RAM and saves some battery on boot up. 25 browsing but it does not use extra RAM and saves some battery on boot up.
25 26
26 \note{If you use TagCache frequently, you should load to RAM, as this 27 \note{If you browse your music frequently using Tag Cache, you should load
27 will reduce the overall battery consumption because the disk will not 28 to RAM, as this will reduce the overall battery consumption because the
28 need to spin on each search.} 29 disk will not need to spin on each search.}
29 } 30 }
30 31
31\item[Auto Update: ] 32\item[Auto Update: ]
32 If \setting{Auto update} is set to \setting{on}, each time the \dap{} 33 If \setting{Auto update} is set to \setting{on}, each time the \dap{}
33 boots, Tag Cache will automatically do everything that the 34 boots, Tag Cache will automatically update the database.
34 \setting{Update now} setting does. Note that the \setting{Auto 35 \opt{SWCODEC}{
35 Update} will only check for deleted files if the Directory Cache 36 \note{The \setting{Auto Update} will only check for deleted files if the
36 (\setting{General Settings $\rightarrow$ System $\rightarrow$ 37 \setting{Directory Cache} (\setting{General Settings $\rightarrow$ System
37 Disk $\rightarrow$ Directory Cache}) is enabled. 38 $\rightarrow$ Disk $\rightarrow$ Directory Cache}) is enabled.
38 \setting{Update now} includes that check whether dircache has been enabled or 39 \setting{Update now} includes that check whether dircache has been
39 not. 40 enabled or not.}
40 41 }%
42 \opt{MASCODEC}{\setting{Auto Update} does not detect deleted files. To remove
43 deleted files from the database you need to run \setting{Update Now}.}%
44
41\item[Initialize Now: ] 45\item[Initialize Now: ]
42 Before you use the Tag Cache for the first time, you must initialize it by 46 Before you use the Tag Cache for the first time, you must initialize it by
43 using the \setting{Initialize Now} function in the \setting{Tag Cache 47 using the \setting{Initialize Now} function in the \setting{Tag Cache
44 Menu}. \setting{Initialize Now} removes all database files (removing 48 Menu}.
45 runtimedb data also) and rebuilds the database from scratch. This takes 49 \warn{\setting{Initialize Now} removes all database files (removing
46 approximately 5 to 10 minutes, and may require a restart to allow the 50 runtimedb data also) and rebuilds the database from scratch.}
47 files to be committed to the cache. 51 This can take quite a while depending on the number of music files on your
48 52 \dap{}, and may require a restart to allow the files to be committed to the
49 The Tag Cache initialization happens in the background, so you can continue 53 cache.
50 to listen to music while the Tag Cache is being initialized. If you shut 54
51 down your player during initialization, the database building process will 55 The Tag Cache initialization happens in the background, so you can continue
56 to listen to music while the Tag Cache is being initialized. If you shut
57 down your player during initialization, the database building process will
52 continue next time you turn it on. 58 continue next time you turn it on.
53 59
54\item[Update Now: ] 60\item[Update Now: ]
55 \setting{Update now} causes Tag Cache to detect new and deleted files 61 \setting{Update now} causes Tag Cache to detect new and deleted files
56 Note that unlike the \setting{Auto Update} function, \setting{Update Now} 62 \opt{SWCODEC}{
57 will update the database regardless of whether the \setting{Directory Cache} 63 \note{Unlike the \setting{Auto Update} function, \setting{Update Now}
58 is enabled. Thus, an update using \setting{Update now} may take a long 64 will update the database regardless of whether the \setting{Directory Cache}
59 time. Unlike \setting{Initialize Now}, the \setting{Update Now} function 65 is enabled. Thus, an update using \setting{Update now} may take a long
66 time.
67 }
68 }
69 Unlike \setting{Initialize Now}, the \setting{Update Now} function
60 does not remove runtime database information. 70 does not remove runtime database information.
61 71
62\item[Gather Runtime Data (Experimental): ] 72\item[Gather Runtime Data (Experimental): ]
@@ -66,8 +76,8 @@ described in the following section.
66\item[Export modifications: ] 76\item[Export modifications: ]
67 This allows for the runtime data to be exported into \\ 77 This allows for the runtime data to be exported into \\
68 \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in 78 \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in
69 ASCII format. This is needed when Tag Cache structures change, because new 79 ASCII format. This is needed when Tag Cache structures change, because new
70 code cannot read old Tag Cache database code. But, all modifications 80 code cannot read old Tag Cache database code. But, all modifications
71 exported to ASCII format should be readable by all Tag Cache versions. 81 exported to ASCII format should be readable by all Tag Cache versions.
72 82
73\item[Import modifications: ] 83\item[Import modifications: ]
@@ -79,10 +89,10 @@ described in the following section.
79 89
80\subsection{Using the Tag Cache} 90\subsection{Using the Tag Cache}
81Once the Tag Cache has been initialized, you can browse your music by Artist, 91Once the Tag Cache has been initialized, you can browse your music by Artist,
82Album, Genre and Song Name. To use the Tag Cache, change the 92Album, Genre and Song Name. To use the Tag Cache, change the
83\setting{Show Files} show mode by changing the \setting{General Settings 93\setting{Show Files} show mode by changing the \setting{General Settings
84$\rightarrow$ File View $\rightarrow$ Show files} option to 94$\rightarrow$ File View $\rightarrow$ Show files} option to
85\setting{ID3 database}. This disables the \setting{File Browser} and instead 95\setting{ID3 database}. This disables the \setting{File Browser} and instead
86allows you to view files using the information in the Tag Cache database.\\ 96allows you to view files using the information in the Tag Cache database.\\
87 97
88\note{You may need to increase the value of the \setting{Max files in dir 98\note{You may need to increase the value of the \setting{Max files in dir
@@ -111,4 +121,3 @@ to RAM.}
111 \end{tabularx} 121 \end{tabularx}
112\end{center} 122\end{center}
113\end{table} 123\end{table}
114