diff options
-rw-r--r-- | manual/appendix/album_art_info.tex | 51 | ||||
-rw-r--r-- | manual/appendix/appendix.tex | 2 | ||||
-rw-r--r-- | manual/appendix/wps_tags.tex | 48 |
3 files changed, 55 insertions, 46 deletions
diff --git a/manual/appendix/album_art_info.tex b/manual/appendix/album_art_info.tex new file mode 100644 index 0000000000..0e8f692e3d --- /dev/null +++ b/manual/appendix/album_art_info.tex | |||
@@ -0,0 +1,51 @@ | |||
1 | \chapter{\label{ref:album_art}Album Art} | ||
2 | Rockbox allows you to put the album art, or another image related to the music | ||
3 | on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the | ||
4 | theme}. For this feature to work, there are a few requirements. | ||
5 | |||
6 | \section{Limitations} | ||
7 | |||
8 | \opt{albumart}{% | ||
9 | Rockbox supports embedded album art only for some specific formats, see | ||
10 | \reference{ref:featureset_for_generic_metadata_tags} for full details. It additionally | ||
11 | supports loading images located on the \disk{}. PictureFlow is currently unable to | ||
12 | use embedded album art. | ||
13 | }% | ||
14 | \nopt{albumart}{% | ||
15 | Rockbox currently only supports loading images located on the | ||
16 | \disk{} for use in PictureFlow. | ||
17 | }% | ||
18 | The image files must be in either BMP or JPEG format\opt{albumart}{, while embedded | ||
19 | album art is currently limited to JPEG. Embedded JPEG images must not be | ||
20 | unsynchronized}. Rockbox does not support RLE-compressed BMP files, nor does it | ||
21 | support progressive and multi-scan JPEG files. | ||
22 | JPEG files must consist of a single scan with interleaved components, | ||
23 | as progessive and multi-scan images require much more memory to decode. | ||
24 | |||
25 | \section{Where to put album art} | ||
26 | |||
27 | The pictures can be named a number of different ways, and placed to a number of | ||
28 | different locations. You can have pictures specific to the file or the album | ||
29 | or use a generic picture. You can place the picture in the same directory | ||
30 | as the file, in the parent directory or in a fixed directory named | ||
31 | \fname{/.rockbox/albumart/}. The order Rockbox uses when looking for a picture | ||
32 | is as follows (a list in braces means that those file extensions are tried in | ||
33 | that order): | ||
34 | |||
35 | \begin{enumerate} | ||
36 | \item embedded (JPEG images in ID3v2 or MP4 tags only) | ||
37 | \item \fname{./filename.\{jpeg,jpg,bmp\}} | ||
38 | \item \fname{./albumtitle.\{jpeg,jpg,bmp\}} | ||
39 | \item \fname{./cover.\{jpeg,jpg,bmp\}} | ||
40 | \item \fname{./folder.jpg} | ||
41 | \item \fname{/.rockbox/albumart/albumartist-albumtitle.\{jpeg,jpg,bmp\}} | ||
42 | \item \fname{../albumtitle.\{jpeg,jpg,bmp\}} | ||
43 | \item \fname{../cover.\{jpeg,jpg,bmp\}} | ||
44 | \end{enumerate} | ||
45 | |||
46 | The following characters will be replaced with an underscore (\_) when looking | ||
47 | for albumtitle.bmp or albumartist-albumtitle.bmp: \textbackslash{} / : < | ||
48 | > ? * |. Doublequotes will be replaced by single quotes. | ||
49 | If no album artist is set, artist will be used instead. See \wikilink{AlbumArt} | ||
50 | in the wiki for programs that will help you automate the process of putting | ||
51 | album art on your \dap{}. | ||
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex index a7f18d12df..39a1f603e1 100644 --- a/manual/appendix/appendix.tex +++ b/manual/appendix/appendix.tex | |||
@@ -3,6 +3,8 @@ | |||
3 | 3 | ||
4 | \input{appendix/file_formats.tex} | 4 | \input{appendix/file_formats.tex} |
5 | 5 | ||
6 | \opt{lcd_bitmap}{\input{appendix/album_art_info.tex}} | ||
7 | |||
6 | \input{appendix/wps_tags.tex} | 8 | \input{appendix/wps_tags.tex} |
7 | 9 | ||
8 | \input{appendix/config_file_options.tex} | 10 | \input{appendix/config_file_options.tex} |
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 549d394258..a4f5f54e68 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -428,52 +428,6 @@ with image ID ``M'', and then reference the individual sub-images in a condition | |||
428 | } | 428 | } |
429 | 429 | ||
430 | \opt{albumart}{ | 430 | \opt{albumart}{ |
431 | \section{\label{ref:album_art}Album Art} | ||
432 | Rockbox allows you to put the album art, or another image related to the music | ||
433 | on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the | ||
434 | theme}. For this feature to work, there are a few requirements. | ||
435 | |||
436 | \subsection{Limitations} | ||
437 | |||
438 | Rockbox supports embedded album art only for some specific formats, see | ||
439 | \reference{ref:featureset_for_generic_metadata_tags} for full details. It additionally supports | ||
440 | loading images located on the \disk{}. | ||
441 | The image files must be in either BMP or JPEG format, while embedded album art | ||
442 | is currently limited to JPEG. Rockbox does not support | ||
443 | RLE-compressed BMP files, nor does it support progressive and multi-scan | ||
444 | JPEG files. Embedded JPEG images must not be unsynchronized. | ||
445 | JPEG files must consist of a single scan with interleaved components, | ||
446 | as progessive and multi-scan images require much more memory to decode. | ||
447 | Pictureflow does not currently support embedded album art. | ||
448 | |||
449 | \subsection{Where to put album art} | ||
450 | |||
451 | The pictures can be named a number of different ways, and placed to a number of | ||
452 | different locations. You can have pictures specific to the file or the album | ||
453 | or use a generic picture. You can place the picture in the same directory | ||
454 | as the file, in the parent directory or in a fixed directory named | ||
455 | \fname{/.rockbox/albumart/}. The order Rockbox uses when looking for a picture | ||
456 | is as follows (a list in braces means that those file extensions are tried in | ||
457 | that order): | ||
458 | |||
459 | \begin{enumerate} | ||
460 | \item embedded (JPEG images in ID3v2 or MP4 tags only) | ||
461 | \item \fname{./filename.\{jpeg,jpg,bmp\}} | ||
462 | \item \fname{./albumtitle.\{jpeg,jpg,bmp\}} | ||
463 | \item \fname{./cover.\{jpeg,jpg,bmp\}} | ||
464 | \item \fname{./folder.jpg} | ||
465 | \item \fname{/.rockbox/albumart/albumartist-albumtitle.\{jpeg,jpg,bmp\}} | ||
466 | \item \fname{../albumtitle.\{jpeg,jpg,bmp\}} | ||
467 | \item \fname{../cover.\{jpeg,jpg,bmp\}} | ||
468 | \end{enumerate} | ||
469 | |||
470 | The following characters will be replaced with an underscore (\_) when looking | ||
471 | for albumtitle.bmp or albumartist-albumtitle.bmp: \textbackslash{} / : < | ||
472 | > ? * |. Doublequotes will be replaced by single quotes. | ||
473 | If no album artist is set, artist will be used instead. See \wikilink{AlbumArt} | ||
474 | in the wiki for programs that will help you automate the process of putting | ||
475 | album art on your \dap{}. | ||
476 | |||
477 | \subsection{How to display the album art} | 431 | \subsection{How to display the album art} |
478 | 432 | ||
479 | Once the album art files are present on your \dap, they can be displayed as | 433 | Once the album art files are present on your \dap, they can be displayed as |
@@ -507,6 +461,8 @@ Examples: | |||
507 | corner:\\ | 461 | corner:\\ |
508 | \config{\%Cl(0,20,100,100,r,b)} | 462 | \config{\%Cl(0,20,100,100,r,b)} |
509 | \end{enumerate} | 463 | \end{enumerate} |
464 | |||
465 | For general information where to put album art see \reference{ref:album_art}. | ||
510 | } | 466 | } |
511 | 467 | ||
512 | \opt{radio}{ | 468 | \opt{radio}{ |