% $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, 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, Genre, 
Song Name, etc.  The criteria the database uses to sort the songs can be completely
 customised. More information on how to achieve this can be found on the Rockbox
 website at \wikilink{DataBase}. 

\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.

\subsubsection{Ignoring Directories During Database Initialization}

You may have directories on your \dap{} whose contents should not be added
to the database. Placing a file named \fname{database.ignore} in a directory
will exclude the files in that directory and all its subdirectories from
scanning their tags and adding them to the database. This will speed up the
database initialization.

If a subdirectory of an `ignored' directory should still be scanned, place a
file named \fname{database.unignore} in it. The files in that directory and
its subdirectories will be scanned and added to the database.

\subsubsection{Issues During Database Commit}

You may have files on your \dap{} whose contents might not be displayed
correctly or even crash the database.
Placing a file named \fname{/.rockbox/database\_commit.ignore}
will prevent the device from committing the database automatically
you can manually commit the database using the db\_commit plugin in APPS
with logging

\subsection{\label{ref:databasemenu}The Database Menu}

\begin{description}
  \opt{tc_ramcache}{
  \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, beginning with the next reboot, 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.

    \opt{HAVE_DISK_STORAGE}{
      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.
    }

    \note{When Load to RAM is turned on, and the directory cache (see
    \reference{ref:dircache}) is enabled as well, it may take an unexpectedly long amount
    of time for disk activity to wind down after booting, depending on your library size
    and player.

    This can be mitigated by choosing the \setting{Quick} option instead, which causes
    the database to ignore cached file references. In that case, you should expect brief
    moments of disk activity whenever the path for a database entry has to be retrieved.

    Setting this to \setting{On} may be preferable for reducing disk accesses if you plan to
    take advantage of \setting{Auto Update}, have enabled \setting{Gather Runtime Data}
    (see below for both), enabled \setting{Automatic resume} (see
    \reference{ref:Autoresumeconfigactual}), or use a WPS that displays multiple upcoming
    tracks from the current playlist. In the latter case, metadata will not be displayed
    for those tracks otherwise.}
  }

\item[Auto Update]
  If \setting{Auto update} is set to \setting{on}, each time the \dap{}
  boots, the database will automatically be updated.

\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
    \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.

\item[Select directories to scan.]
  The database normally scans all directories for audio files. This setting
  allows you to limit the scan to a specified list of directories, so only
  files contained in one of these directories will be added to the database.
  Scanning is recursive -- all subdirectories of a selected directory will
  be scanned as well.

\end{description}

\subsection{Using the Database}
Once the database has been initialized, you can browse your music 
by Artist, Album, Genre, Song Name, etc.  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 Entries in File
Browser} setting (\setting{Settings $\rightarrow$ General Settings
$\rightarrow$ System $\rightarrow$ Limits}) in order to view long lists of
tracks in the ID3 database browser.\\

To "turn off" the database, do not initialize it, and do not load it to RAM.}%

If the number of tracks you are attempting to play exceeds the value of the
\setting{Max Playlist Size} setting (\setting{Settings $\rightarrow$ General
Settings $\rightarrow$ System $\rightarrow$ Limits}), a randomly chosen
subset of tracks is added to the current playlist instead. This allows you
to play random tracks from your whole library without having to increase any
limits that may degrade performance.

\note{For your convenience, a shortcut button "Shuffle Songs" is available directly
from the \setting{Database} menu to create and start a mix with all of your
existing music tracks.}

\begin{table}
  \begin{rbtabular}{.75\textwidth}{XXX}%
  {\textbf{Tag}   & \textbf{Type}  & \textbf{Origin}}{}{}
  filename              & string    & system \\ 
  album                 & string    & id tag \\
  albumartist           & string    & id tag \\
  artist                & string    & id tag \\
  comment               & string    & id tag \\
  composer              & string    & id tag \\
  genre                 & string    & id tag \\
  grouping              & string    & id tag \\
  title                 & string    & id tag \\
  bitrate               & numeric   & id tag \\
  discnum               & numeric   & id tag \\
  year                  & numeric   & id tag \\
  tracknum              & numeric   & id tag/filename \\
  autoscore             & numeric   & runtime db \\
  lastplayed            & numeric   & runtime db \\
  playcount             & numeric   & runtime db \\
  Pm (play time -- min)  & numeric   & runtime db \\
  Ps (play time -- sec)  & numeric   & runtime db \\
  rating                & numeric   & runtime db \\
  commitid              & numeric   & system \\
  entryage              & numeric   & system \\
  length                & numeric   & system \\
  Lm (track len -- min)  & numeric   & system \\
  Ls (track len -- sec)  & numeric   & system \\
  \end{rbtabular}
\end{table}
