summaryrefslogtreecommitdiffstats log msg author committer range
blob: 8f7a942eb6f8c94c0d85dedf0fc17be0363050f9 (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119  % $Id$ % \section{\label{ref:database}Database} \subsection{Introduction} This chapter describes the Rockbox music database system. Using the information contained in the tags (ID3v1, ID3v2% \opt{SWCODEC}{, Vorbis Comments, Apev2, etc.}% ) 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 database} The first time you use the database, Rockbox will scan your disk for audio files. This can take quite a while depending on the number of files on your \dap{}. This scan happens in the background, so you can choose to return to the Main Menu and continue to listen to music. If you shut down your player, the scan will continue next time you turn it on. After the scan is finished you may be prompted to restart your \dap{} before you can use the database. \subsection{\label{ref:databasemenu}The Database Menu} \begin{description} \opt{SWCODEC}{ \item[Load To Ram.] The database can either be kept on disk (to save memory), or loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads the database to RAM, allowing faster browsing and searching. Setting this option to \setting{No} keeps the database on the disk, meaning slower browsing but it does not use extra RAM and saves some battery on boot up. \note{If you browse your music frequently using the database, you should load to RAM, as this will reduce the overall battery consumption because the disk will not need to spin on each search.} } \item[Auto Update.] If \setting{Auto update} is set to \setting{on}, each time the \dap{} boots, the database will automatically be updated. \opt{SWCODEC}{ \note{The \setting{Auto Update} will only check for deleted files if the \setting{Directory Cache} (\setting{Settings $\rightarrow$ General Settings $\rightarrow$ System $\rightarrow$ Disk $\rightarrow$ Directory Cache}) is enabled. \setting{Update now} includes that check whether dircache has been 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.] You can force Rockbox to rescan your disk for tagged files by using the \setting{Initialize Now} function in the \setting{Database Menu}. \warn{\setting{Initialize Now} removes all database files (removing runtimedb data also) and rebuilds the database from scratch.} \item[Update Now.] \setting{Update now} causes the database to detect new and deleted files \opt{SWCODEC}{ \note{Unlike the \setting{Auto Update} function, \setting{Update Now} will update the database regardless of whether the \setting{Directory Cache} 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. \item[Gather Runtime Data.] When enabled, rockbox will record how often and how long a track is being played, when it was last played and its rating. This information can be displayed in the WPS and is used in the database browser to, for example, show the most played, unplayed and most recently played tracks. \item[Export modifications.] This allows for the runtime data to be exported to the file \\ \fname{/.rockbox/database\_changelog.txt}, which backs up the runtime data in ASCII format. This is needed when database structures change, because new code cannot read old database code. But, all modifications exported to ASCII format should be readable by all database versions. \item[Import modifications.] Allows the \fname{/.rockbox/database\_changelog.txt} backup to be conveniently loaded into the database. If \setting{Auto Update} is enabled this is performed automatically when the database is initialized. \end{description} \subsection{Using the database} Once the database has been initialized, you can browse your music by Artist, Album, Genre and Song Name. To use the database, go to the \setting{Main Menu} and select \setting{Database}.\\ \note{You may need to increase the value of the \setting{Max files in dir browser} setting (\setting{Settings $\rightarrow$ General Settings $\rightarrow$ System $\rightarrow$ Limits}) in order to view long lists of tracks in the ID3 database browser.\\ There is no option to turn off database completely. If you do not want to use it just don't do the initial build of the database and do not load it to RAM.} % \begin{table} \begin{center} \begin{tabularx}{.75\textwidth}{XX}% \toprule% \textbf{Supported Tags} & \textbf{Unsupported Tags} \\ \midrule Artist & Comment \\ Album & Performer\\ Bitrate & \\ Composer & \\ Genre & \\ Length & \\ Title & \\ Track Number & \\ \bottomrule \end{tabularx} \end{center} \end{table}