Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Manual: Pull general album art info out of the theme tags section.

Browse source 
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
This commit is contained in:
Marianne Arnold 2012-05-19 17:41:11 +02:00
parent 6c0a1cb223
commit cf90958e94
3 changed files with 55 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
manual/appendix/album_art_info.tex Normal file
View file

@ -0,0 +1,51 @@
\chapter{\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.
\section{Limitations}
\opt{albumart}{%
Rockbox supports embedded album art only for some specific formats, see
\reference{ref:featureset_for_generic_metadata_tags} for full details. It additionally
supports loading images located on the \disk{}. PictureFlow is currently unable to
use embedded album art.
}%
\nopt{albumart}{%
Rockbox currently only supports loading images located on the
\disk{} for use in PictureFlow.
}%
The image files must be in either BMP or JPEG format\opt{albumart}{, while embedded
album art is currently limited to JPEG. Embedded JPEG images must not be
unsynchronized}. 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 embedded (JPEG images in ID3v2 or MP4 tags only)
\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/albumartist-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 albumartist-albumtitle.bmp: \textbackslash{} / : <
> ? * |. Doublequotes will be replaced by single quotes.
If no album artist is set, artist will be used instead. See \wikilink{AlbumArt}
in the wiki for programs that will help you automate the process of putting
album art on your \dap{}.

2
manual/appendix/appendix.tex
View file

@ -3,6 +3,8 @@
\input{appendix/file_formats.tex}
\opt{lcd_bitmap}{\input{appendix/album_art_info.tex}}
\input{appendix/wps_tags.tex}
\input{appendix/config_file_options.tex}

48
manual/appendix/wps_tags.tex
View file

@ -428,52 +428,6 @@ with image ID ``M'', and then reference the individual sub-images in a condition
}
\opt{albumart}{
\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 supports embedded album art only for some specific formats, see
\reference{ref:featureset_for_generic_metadata_tags} for full details. It additionally supports
loading images located on the \disk{}.
The image files must be in either BMP or JPEG format, while embedded album art
is currently limited to JPEG. Rockbox does not support
RLE-compressed BMP files, nor does it support progressive and multi-scan
JPEG files. Embedded JPEG images must not be unsynchronized.
JPEG files must consist of a single scan with interleaved components,
as progessive and multi-scan images require much more memory to decode.
Pictureflow does not currently support embedded album art.
\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 embedded (JPEG images in ID3v2 or MP4 tags only)
\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/albumartist-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 albumartist-albumtitle.bmp: \textbackslash{} / : <
> ? * |. Doublequotes will be replaced by single quotes.
If no album artist is set, artist will be used instead. 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
@ -507,6 +461,8 @@ Examples:
corner:\\
\config{\%Cl(0,20,100,100,r,b)}
\end{enumerate}
For general information where to put album art see \reference{ref:album_art}.
}
\opt{radio}{