summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarianne Arnold <pixelma@rockbox.org>2012-05-19 17:41:11 +0200
committerMarianne Arnold <pixelma@rockbox.org>2012-05-20 17:58:06 +0200
commitcf90958e940226cd5d0d78b40bc0d8b612b67a41 (patch)
tree220b3f44a1228416f5ace720438535a30433fc84
parent6c0a1cb223f4e953a6f1fe74591f70b205289615 (diff)
downloadrockbox-cf90958e940226cd5d0d78b40bc0d8b612b67a41.tar.gz
rockbox-cf90958e940226cd5d0d78b40bc0d8b612b67a41.zip
Manual: Pull general album art info out of the theme tags section.
Make this info available for all bitmap targets, also ones that only need it in the pictureflow description. Shuffle some lines around so that it doesn't need too many opts. Fixes FS#11350. Change-Id: I5268483c7a1d765c8a994614442309b05de1d832
-rw-r--r--manual/appendix/album_art_info.tex51
-rw-r--r--manual/appendix/appendix.tex2
-rw-r--r--manual/appendix/wps_tags.tex48
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}
2Rockbox allows you to put the album art, or another image related to the music
3on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the
4theme}. 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}%
18The image files must be in either BMP or JPEG format\opt{albumart}{, while embedded
19album art is currently limited to JPEG. Embedded JPEG images must not be
20unsynchronized}. Rockbox does not support RLE-compressed BMP files, nor does it
21support progressive and multi-scan JPEG files.
22JPEG files must consist of a single scan with interleaved components,
23as progessive and multi-scan images require much more memory to decode.
24
25\section{Where to put album art}
26
27The pictures can be named a number of different ways, and placed to a number of
28different locations. You can have pictures specific to the file or the album
29or use a generic picture. You can place the picture in the same directory
30as 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
32is as follows (a list in braces means that those file extensions are tried in
33that 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
46The following characters will be replaced with an underscore (\_) when looking
47for albumtitle.bmp or albumartist-albumtitle.bmp: \textbackslash{} / : <
48> ? * |. Doublequotes will be replaced by single quotes.
49If no album artist is set, artist will be used instead. See \wikilink{AlbumArt}
50in the wiki for programs that will help you automate the process of putting
51album 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}
432Rockbox allows you to put the album art, or another image related to the music
433on your \dap{} to display it in the PictureFlow plugin\opt{albumart}{ or in the
434theme}. For this feature to work, there are a few requirements.
435
436\subsection{Limitations}
437
438Rockbox supports embedded album art only for some specific formats, see
439\reference{ref:featureset_for_generic_metadata_tags} for full details. It additionally supports
440loading images located on the \disk{}.
441The image files must be in either BMP or JPEG format, while embedded album art
442is currently limited to JPEG. Rockbox does not support
443RLE-compressed BMP files, nor does it support progressive and multi-scan
444JPEG files. Embedded JPEG images must not be unsynchronized.
445JPEG files must consist of a single scan with interleaved components,
446as progessive and multi-scan images require much more memory to decode.
447Pictureflow does not currently support embedded album art.
448
449\subsection{Where to put album art}
450
451The pictures can be named a number of different ways, and placed to a number of
452different locations. You can have pictures specific to the file or the album
453or use a generic picture. You can place the picture in the same directory
454as 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
456is as follows (a list in braces means that those file extensions are tried in
457that 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
470The following characters will be replaced with an underscore (\_) when looking
471for albumtitle.bmp or albumartist-albumtitle.bmp: \textbackslash{} / : <
472> ? * |. Doublequotes will be replaced by single quotes.
473If no album artist is set, artist will be used instead. See \wikilink{AlbumArt}
474in the wiki for programs that will help you automate the process of putting
475album art on your \dap{}.
476
477\subsection{How to display the album art} 431\subsection{How to display the album art}
478 432
479Once the album art files are present on your \dap, they can be displayed as 433Once 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
465For general information where to put album art see \reference{ref:album_art}.
510} 466}
511 467
512\opt{radio}{ 468\opt{radio}{