diff options
author | Alex Parker <rockbox@aeparker.com> | 2010-05-29 19:02:25 +0000 |
---|---|---|
committer | Alex Parker <rockbox@aeparker.com> | 2010-05-29 19:02:25 +0000 |
commit | 018133ea30b8cf125aace543f81e5d84499ad06b (patch) | |
tree | b29923b9d6339ed463d67ee8c903242805042e9d /manual | |
parent | caa68b5e1ca17471e5373c1c379ff6c2be95a921 (diff) | |
download | rockbox-018133ea30b8cf125aace543f81e5d84499ad06b.tar.gz rockbox-018133ea30b8cf125aace543f81e5d84499ad06b.zip |
Consolidate the information on album art into one place.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26390 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r-- | manual/appendix/album_art.tex | 42 | ||||
-rw-r--r-- | manual/appendix/appendix.tex | 4 | ||||
-rw-r--r-- | manual/appendix/wps_tags.tex | 46 |
3 files changed, 45 insertions, 47 deletions
diff --git a/manual/appendix/album_art.tex b/manual/appendix/album_art.tex deleted file mode 100644 index 39e4372bf9..0000000000 --- a/manual/appendix/album_art.tex +++ /dev/null | |||
@@ -1,42 +0,0 @@ | |||
1 | % $Id$ % | ||
2 | \chapter{\label{ref:album_art}Album Art} | ||
3 | \section{Introduction} | ||
4 | |||
5 | Rockbox allows you to put the album art, or another image related to the music | ||
6 | on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the | ||
7 | WPS}. For this feature to work, you must observe a few rules. | ||
8 | |||
9 | \section{Limitations} | ||
10 | |||
11 | Rockbox does not support album art embedded in your files' tags, and will | ||
12 | instead look for a picture located in the filesystem. In addition to this, the | ||
13 | pictures must be in the BMP or JPEG formats. Rockbox does not support | ||
14 | RLE-compressed BMP files, nor does it support progressive and multi-scan | ||
15 | JPEG files. JPEG files must consist of a single scan with interleaved components, | ||
16 | as progessive and multi-scan images require much more memory to decode. | ||
17 | |||
18 | \section{Where to put album art} | ||
19 | |||
20 | The pictures can be named a number of different ways, and placed to a number of | ||
21 | different locations. You can have pictures specific to the file or the album | ||
22 | or use a generic picture. You can place the picture in the same directory | ||
23 | as the file, in the parent directory or in a fixed directory named | ||
24 | \fname{/.rockbox/albumart/}. The order Rockbox uses when looking for a picture | ||
25 | is as follows (a list in braces means that those file extensions are tried in | ||
26 | that order): | ||
27 | |||
28 | \begin{enumerate} | ||
29 | \item \fname{./filename.\{jpeg,jpg,bmp\}} | ||
30 | \item \fname{./albumtitle.\{jpeg,jpg,bmp\}} | ||
31 | \item \fname{./cover.\{jpeg,jpg,bmp\}} | ||
32 | \item \fname{./folder.jpg} | ||
33 | \item \fname{/.rockbox/albumart/artist-albumtitle.\{jpeg,jpg,bmp\}} | ||
34 | \item \fname{../albumtitle.\{jpeg,jpg,bmp\}} | ||
35 | \item \fname{../cover.\{jpeg,jpg,bmp\}} | ||
36 | \end{enumerate} | ||
37 | |||
38 | The following characters will be replaced with an underscore (\_) when looking | ||
39 | for albumtitle.bmp or artist-albumtitle.bmp: \textbackslash{} / : \textless{} | ||
40 | \textgreater{} ? * \textbar{}. Doublequotes will be replaced by single quotes. | ||
41 | See \wikilink{AlbumArt} in the wiki for more details and programs that will | ||
42 | 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 6cb7e21a85..58b9760a4b 100644 --- a/manual/appendix/appendix.tex +++ b/manual/appendix/appendix.tex | |||
@@ -5,10 +5,6 @@ | |||
5 | 5 | ||
6 | \input{appendix/wps_tags.tex} | 6 | \input{appendix/wps_tags.tex} |
7 | 7 | ||
8 | \opt{lcd_bitmap}{\opt{tagcache}{ | ||
9 | \input{appendix/album_art.tex} | ||
10 | }} | ||
11 | |||
12 | \input{appendix/config_file_options.tex} | 8 | \input{appendix/config_file_options.tex} |
13 | 9 | ||
14 | \input{appendix/menu_structure.tex} | 10 | \input{appendix/menu_structure.tex} |
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 697a256b33..9cc7a61159 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 | |||
337 | } | 337 | } |
338 | 338 | ||
339 | \opt{albumart}{ | 339 | \opt{albumart}{ |
340 | \section{Album Art} | 340 | \section{\label{ref:album_art}Album Art} |
341 | Rockbox allows you to put the album art, or another image related to the music | ||
342 | on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the | ||
343 | theme}. For this feature to work, there are a few requirements. | ||
344 | |||
345 | \subsection{Limitations} | ||
346 | |||
347 | Rockbox does not support album art embedded in your files' tags, and will | ||
348 | instead look for a picture located on disk. In addition to this, the | ||
349 | pictures must be in either BMP or JPEG format. Rockbox does not support | ||
350 | RLE-compressed BMP files, nor does it support progressive and multi-scan | ||
351 | JPEG files. JPEG files must consist of a single scan with interleaved components, | ||
352 | as progessive and multi-scan images require much more memory to decode. | ||
353 | |||
354 | \subsection{Where to put album art} | ||
355 | |||
356 | The pictures can be named a number of different ways, and placed to a number of | ||
357 | different locations. You can have pictures specific to the file or the album | ||
358 | or use a generic picture. You can place the picture in the same directory | ||
359 | as the file, in the parent directory or in a fixed directory named | ||
360 | \fname{/.rockbox/albumart/}. The order Rockbox uses when looking for a picture | ||
361 | is as follows (a list in braces means that those file extensions are tried in | ||
362 | that order): | ||
363 | |||
364 | \begin{enumerate} | ||
365 | \item \fname{./filename.\{jpeg,jpg,bmp\}} | ||
366 | \item \fname{./albumtitle.\{jpeg,jpg,bmp\}} | ||
367 | \item \fname{./cover.\{jpeg,jpg,bmp\}} | ||
368 | \item \fname{./folder.jpg} | ||
369 | \item \fname{/.rockbox/albumart/artist-albumtitle.\{jpeg,jpg,bmp\}} | ||
370 | \item \fname{../albumtitle.\{jpeg,jpg,bmp\}} | ||
371 | \item \fname{../cover.\{jpeg,jpg,bmp\}} | ||
372 | \end{enumerate} | ||
373 | |||
374 | The following characters will be replaced with an underscore (\_) when looking | ||
375 | for albumtitle.bmp or artist-albumtitle.bmp: \textbackslash{} / : \textless{} | ||
376 | \textgreater{} ? * \textbar{}. Doublequotes will be replaced by single quotes. | ||
377 | See \wikilink{AlbumArt} in the wiki for programs that will | ||
378 | help you automate the process of putting album art on your \dap{}. | ||
379 | |||
380 | \subsection{How to display the album art} | ||
381 | |||
382 | Once the album art files are present on your \dap, they can be displayed as | ||
383 | follows. | ||
384 | |||
341 | \begin{tagmap} | 385 | \begin{tagmap} |
342 | \config{\%Cl{\textbar}x{\textbar}y{\textbar}[[l{\textbar}c{\textbar}r]maxwidth]{\textbar}[[t{\textbar}c{\textbar}b]maxheight]{\textbar}} | 386 | \config{\%Cl{\textbar}x{\textbar}y{\textbar}[[l{\textbar}c{\textbar}r]maxwidth]{\textbar}[[t{\textbar}c{\textbar}b]maxheight]{\textbar}} |
343 | & Define the settings for albumart\\ | 387 | & Define the settings for albumart\\ |