diff options
| author | Jonas Häggqvist <rasher@rasher.dk> | 2009-02-20 18:37:57 +0000 |
|---|---|---|
| committer | Jonas Häggqvist <rasher@rasher.dk> | 2009-02-20 18:37:57 +0000 |
| commit | 410cbd1af7103cf9a19ca3f155647da5a34e4d05 (patch) | |
| tree | 198f516396dd557f56d45c50ed1faeccec9a8c47 /manual/appendix | |
| parent | 5c5b06ba39d2f00d70baef66a90c9e3d6c497817 (diff) | |
| download | rockbox-410cbd1af7103cf9a19ca3f155647da5a34e4d05.zip rockbox-410cbd1af7103cf9a19ca3f155647da5a34e4d05.tar.gz rockbox-410cbd1af7103cf9a19ca3f155647da5a34e4d05.tar.bz2 rockbox-410cbd1af7103cf9a19ca3f155647da5a34e4d05.tar.xz | |
Add an album art appendix to the manual. Add album art tags to the WPS tags appendix and remove the image tag section from the Player manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20067 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/appendix')
| -rw-r--r-- | manual/appendix/album_art.tex | 37 | ||||
| -rw-r--r-- | manual/appendix/appendix.tex | 4 | ||||
| -rw-r--r-- | manual/appendix/wps_tags.tex | 36 |
3 files changed, 77 insertions, 0 deletions
diff --git a/manual/appendix/album_art.tex b/manual/appendix/album_art.tex new file mode 100644 index 0000000..dc6a778 --- /dev/null +++ b/manual/appendix/album_art.tex @@ -0,0 +1,37 @@ +% $Id: wps_tags.tex 19361 2008-12-07 23:00:15Z bluebrother $ % +\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 format. + +\section{Where to put album art} + +The pictures can be named a number of different ways, and placed 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 direcotry +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: + +\begin{enumerate} +\item \fname{./filename.bmp} +\item \fname{./albumtitle.bmp} +\item \fname{./cover.bmp} +\item \fname{/.rockbox/albumart/artist-albumtitle.bmp} +\item \fname{../albumtitle.bmp} +\item \fname{../cover.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 qutoes. +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 e8a6c83..b7ee15a 100644 --- a/manual/appendix/appendix.tex +++ b/manual/appendix/appendix.tex @@ -5,6 +5,10 @@ \input{appendix/wps_tags.tex} +\opt{swcodec}{\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 2c505f9..487090c 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex @@ -201,6 +201,7 @@ that, it will display the volume value. Example: Can be used as a simple tag \config{\%St{\textbar}skip length{\textbar}} or with conditionals \config{\%?St{\textbar}eq enabled{\textbar}{\textless}Equalizer is enabled{\textbar}Equalizer is disabled{\textgreater}}. +\opt{lcd_bitmap}{ \section{Images} \begin{table} \begin{tagmap}{}{} @@ -255,6 +256,41 @@ with image ID ``M'', and then reference the individual sub-images in a condition repect each of the players' limits. \end{itemize} } +} + +\opt{albumart}{ +\section{Album art} +\begin{table} + \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\\ + & \config{x}: x coordinate\\ + & \config{y}: y coordinate\\ + & \config{maxwidth}: Maximum height.\\ + & \config{maxheight}: Maximum width.\\ + \config{\%C} & Display the album art as configured\\ + \end{tagmap} +\end{table} + +The picture will be rescaled, preserving aspect ratio to fit the given +\config{maxwidth} and \config{maxheight}. If the aspect ratio doesn't match the +configured values, the picture will be placed according to the flags to the +\config{maxwidth} and \config{maxheight} parameters: +\begin{itemize} + \item \config{maxwidth}: + \begin{description} + \item[\config{l}.] Align left + \item[\config{c}.] Align center (default) + \item[\config{r}.] Align right + \end{description} + \item \config{maxheight}: + \begin{description} + \item[\config{t}.] Align left + \item[\config{c}.] Align center (default) + \item[\config{b}.] Align right + \end{description} +\end{itemize} +} \section{Alignment} \begin{table} |