From 6a34a92d5d3af39f58cd966d8bca09aef99fb7b5 Mon Sep 17 00:00:00 2001 From: alex Date: Sat, 29 May 2010 19:02:25 +0000 Subject: [PATCH] Consolidate the information on album art into one place. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26390 a1c6a512-1295-4272-9138-f99709370657 --- manual/appendix/album_art.tex | 42 --------------------------------------- manual/appendix/appendix.tex | 4 ---- manual/appendix/wps_tags.tex | 46 ++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 45 insertions(+), 47 deletions(-) delete mode 100644 manual/appendix/album_art.tex diff --git a/manual/appendix/album_art.tex b/manual/appendix/album_art.tex deleted file mode 100644 index 39e4372bf..000000000 --- a/manual/appendix/album_art.tex +++ /dev/null @@ -1,42 +0,0 @@ -% $Id$ % -\chapter{\label{ref:album_art}Album Art} -\section{Introduction} - -Rockbox allows you to put the album art, or another image related to the music -on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the -WPS}. For this feature to work, you must observe a few rules. - -\section{Limitations} - -Rockbox does not support album art embedded in your files' tags, and will -instead look for a picture located in the filesystem. In addition to this, the -pictures must be in the BMP or JPEG formats. Rockbox does not support -RLE-compressed BMP files, nor does it support progressive and multi-scan -JPEG files. JPEG files must consist of a single scan with interleaved components, -as progessive and multi-scan images require much more memory to decode. - -\section{Where to put album art} - -The pictures can be named a number of different ways, and placed to a number of -different locations. You can have pictures specific to the file or the album -or use a generic picture. You can place the picture in the same directory -as the file, in the parent directory or in a fixed directory named -\fname{/.rockbox/albumart/}. The order Rockbox uses when looking for a picture -is as follows (a list in braces means that those file extensions are tried in -that order): - -\begin{enumerate} -\item \fname{./filename.\{jpeg,jpg,bmp\}} -\item \fname{./albumtitle.\{jpeg,jpg,bmp\}} -\item \fname{./cover.\{jpeg,jpg,bmp\}} -\item \fname{./folder.jpg} -\item \fname{/.rockbox/albumart/artist-albumtitle.\{jpeg,jpg,bmp\}} -\item \fname{../albumtitle.\{jpeg,jpg,bmp\}} -\item \fname{../cover.\{jpeg,jpg,bmp\}} -\end{enumerate} - -The following characters will be replaced with an underscore (\_) when looking -for albumtitle.bmp or artist-albumtitle.bmp: \textbackslash{} / : \textless{} -\textgreater{} ? * \textbar{}. Doublequotes will be replaced by single quotes. -See \wikilink{AlbumArt} in the wiki for more details and programs that will -help you automate the process of putting album art on your \dap{}. diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex index 6cb7e21a8..58b9760a4 100644 --- a/manual/appendix/appendix.tex +++ b/manual/appendix/appendix.tex @@ -5,10 +5,6 @@ \input{appendix/wps_tags.tex} -\opt{lcd_bitmap}{\opt{tagcache}{ -\input{appendix/album_art.tex} -}} - \input{appendix/config_file_options.tex} \input{appendix/menu_structure.tex} diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 697a256b3..9cc7a6115 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex @@ -337,7 +337,51 @@ with image ID ``M'', and then reference the individual sub-images in a condition } \opt{albumart}{ -\section{Album Art} +\section{\label{ref:album_art}Album Art} +Rockbox allows you to put the album art, or another image related to the music +on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the +theme}. For this feature to work, there are a few requirements. + +\subsection{Limitations} + +Rockbox does not support album art embedded in your files' tags, and will +instead look for a picture located on disk. In addition to this, the +pictures must be in either BMP or JPEG format. Rockbox does not support +RLE-compressed BMP files, nor does it support progressive and multi-scan +JPEG files. JPEG files must consist of a single scan with interleaved components, +as progessive and multi-scan images require much more memory to decode. + +\subsection{Where to put album art} + +The pictures can be named a number of different ways, and placed to a number of +different locations. You can have pictures specific to the file or the album +or use a generic picture. You can place the picture in the same directory +as the file, in the parent directory or in a fixed directory named +\fname{/.rockbox/albumart/}. The order Rockbox uses when looking for a picture +is as follows (a list in braces means that those file extensions are tried in +that order): + +\begin{enumerate} +\item \fname{./filename.\{jpeg,jpg,bmp\}} +\item \fname{./albumtitle.\{jpeg,jpg,bmp\}} +\item \fname{./cover.\{jpeg,jpg,bmp\}} +\item \fname{./folder.jpg} +\item \fname{/.rockbox/albumart/artist-albumtitle.\{jpeg,jpg,bmp\}} +\item \fname{../albumtitle.\{jpeg,jpg,bmp\}} +\item \fname{../cover.\{jpeg,jpg,bmp\}} +\end{enumerate} + +The following characters will be replaced with an underscore (\_) when looking +for albumtitle.bmp or artist-albumtitle.bmp: \textbackslash{} / : \textless{} +\textgreater{} ? * \textbar{}. Doublequotes will be replaced by single quotes. +See \wikilink{AlbumArt} in the wiki for programs that will +help you automate the process of putting album art on your \dap{}. + +\subsection{How to display the album art} + +Once the album art files are present on your \dap, they can be displayed as +follows. + \begin{tagmap} \config{\%Cl{\textbar}x{\textbar}y{\textbar}[[l{\textbar}c{\textbar}r]maxwidth]{\textbar}[[t{\textbar}c{\textbar}b]maxheight]{\textbar}} & Define the settings for albumart\\ -- 2.11.4.GIT