devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

FS#12110: Rework of the audio format and metadata section in the manual. Add notes for several audio formats, correct the file extensions for several formats, describe the feature sets supported by the different metadata formats, describe limitations of the metadata handling.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29894 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Andree Buschmann 2011-05-17 20:50:26 +00:00
parent 58995c1e2f
commit 0101c701e0
1 changed files with 186 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

259
manual/appendix/file_formats.tex
View file

@ -104,101 +104,214 @@
\end{rbtabular} \end{rbtabular}
\opt{swcodec}{ \opt{swcodec}{
\chapter{Audio and metadata formats}
\section{\label{ref:Supportedaudioformats}Supported audio formats} \section{\label{ref:Supportedaudioformats}Supported audio formats}
\subsection{Lossy Codecs} \subsection{Lossy Codecs}
\begin{rbtabular}{\textwidth}{l>{\raggedright}p{6em}X}% \begin{rbtabular}{\textwidth}{l>{\raggedright}p{6em}X}%
{\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{} {\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{}
ATSC A/52 & \fname{.a52}, \fname{.ac3} & Supports downmixing for playback of 5.1 streams in stereo\tabularnewline ATSC A/52 (AC3)
ADX & \fname{.adx} & \tabularnewline & \fname{.a52}, \fname{.ac3}, \fname{.rm}, \fname{.ra}, \fname{.rmvb}
Advanced Audio Coding & \fname{.m4a}, \fname{.m4b}, \fname{.mp4} & \tabularnewline & Supports downmixing for playback of 5.1 streams in stereo\\
MPEG audio & \fname{.mp1}, \fname{.mpa}, \fname{.mp2}, \fname{.mp3} & \tabularnewline ADX
Musepack & \fname{.mpc} & Supports SV7 and SV8 in mono/stereo \tabularnewline & \fname{.adx}
OGG/Vorbis & \fname{.ogg}, \fname{.oga} & Playback of some old ``floor 0'' files may fail\tabularnewline & \\
Sony Audio & \fname{.oma}, \fname{.aa3} & \tabularnewline Advanced Audio Coding
RealAudio & \fname{.rm}, \fname{.ra}, \fname{.rmvb} & \tabularnewline & \fname{.m4a}, \fname{.m4b}, \fname{.mp4}, \fname{.rm}, \fname{.ra}, \fname{.rmvb}
Speex & \fname{.spx} & \tabularnewline \nopt{clipv1,c200v2}{
Dialogic telephony type & \fname{.vox} & \tabularnewline & Supports AAC-LC, -HEv1, and -HEv2 profiles\\}
Windows Media Audio Standard & \fname{.wma}, \fname{.wmv}, \fname{.asf} & \tabularnewline \opt{clipv1,c200v2}{ % low memory targets (CODEC_SIZE <= 512 KB)
Windows Media Audio Professional & \fname{.wma}, \fname{.wmv}, \fname{.asf} & \tabularnewline & Supports AAC-LC profile\\}
MPEG audio
& \fname{.mpa}, \fname{.mp1}, \fname{.mp2}, \fname{.mp3}
& MPEG 1/2/2.5 Layer 1/2/3\\
Musepack
& \fname{.mpc}
& Supports SV7 and SV8 in mono/stereo \\
OGG/Vorbis
& \fname{.ogg}, \fname{.oga}
& Playback of some old ``floor 0'' files may fail on low memory targets.
Files with album art larger than available RAM will be skipped.
Chained Ogg files are not supported.\\
Sony Audio
& \fname{.oma}, \fname{.aa3}, \fname{.rm}, \fname{.ra}, \fname{.rmvb}
& Supports ATRAC3\\
RealAudio
& \fname{.rm}, \fname{.ra}, \fname{.rmvb}
& Supports RealAudio G2 (Cook)\\
Speex
& \fname{.spx}
& \\
Dialogic telephony type
& \fname{.vox}
& \\
Windows Media Audio Standard
& \fname{.wma}, \fname{.wmv}, \fname{.asf}
& \\
Windows Media Audio Professional
& \fname{.wma}, \fname{.wmv}, \fname{.asf}
& \\
\end{rbtabular} \end{rbtabular}
\note{AAC-HE profiles might not play in realtime on all devices due to CPU
performance requirements.}
\subsection{Lossless Codecs} \subsection{Lossless Codecs}
\begin{rbtabular}{\textwidth}{lp{6em}X}% \begin{rbtabular}{\textwidth}{lp{6em}X}%
{\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{} {\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{}
Audio Interchange File Format & \fname{.aif}, \fname{.aiff} & AIFF supports following formats:\\ Audio Interchange File Format
& & Linear PCM 8/16/24/32 bit\\ & \fname{.aif}, \fname{.aiff}
& & IEEE float 32/64 bit\\ & Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.711 a-law/$\mu$-law,
& & ITU-T G.711 a-law/$\mu$-law\\ QuickTime IMA ADPCM\\
& & QuickTime IMA ADPCM\\ Monkey's Audio
\opt{gigabeatf,iriverh100,iriverh300,iaudiox5,iaudiom5,iaudiom3,ipodnano2g,clipv1}{ & \fname{.ape}, \fname{.mac}
Monkey's Audio & \fname{.ape}, \fname{.mac} & -c1000 to -c3000 \opt{gigabeatf,iriverh100,iriverh300,iaudiox5,iaudiom5,iaudiom3,ipodnano2g,clipv1}{
files decode fast enough to be useful.} & -c1000 to -c3000 files decode fast enough to be useful.\\}
\opt{gigabeats}{ \opt{gigabeats}{
Monkey's Audio & \fname{.ape}, \fname{.mac} & } & \\}
\nopt{ipodnano2g}{ \nopt{ipodnano2g}{\opt{ipod,iriverh10,iriverh10_5gb,mrobe100,sansa,vibe500}{
\opt{ipod,iriverh10,iriverh10_5gb,mrobe100,sansa,vibe500}{ & Only -c1000 files decode fast enough to be useful.\\}}
Monkey's Audio & \fname{.ape}, \fname{.mac} & Only -c1000 files decode fast Sun Audio
enough to be useful.} & \fname{.au}, \fname{.snd}
} & Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.711 a-law/$\mu$-law\\
\\ Free Lossless Audio
Sun Audio & \fname{.au}, \fname{.snd} & Sun Audio supports following formats: \\ & \fname{.flac}
& & Linear PCM 8/16/24/32 bit \\ & \\
& & IEEE float 32/64 bit\\ Apple Lossless
& & ITU-T G.711 a-law/$\mu$-law\\ & \fname{.m4a}, \fname{.mp4}
Free Lossless Audio & \fname{.flac} & \\ & \\
Apple Lossless & \fname{.m4a}, \fname{.mp4} & \\ Shorten
Shorten & \fname{.shn} & Seeking not supported.\\ & \fname{.shn}
True Audio & \fname{.tta} & \\ & Seeking not supported.\\
Wave64 & \fname{.w64} & Wave/Wave64 supports following formats: \\ True Audio
Waveform audio format & \fname{.wav} & Linear PCM 8/16/24/32 bit\\ & \fname{.tta}
& & IEEE float 32/64 bit\\ & \\
& & ITU-T G.711 a-law/$\mu$-law\\ Wave64
& & Microsoft ADPCM\\ & \fname{.w64}
& & Intel DVI ADPCM(IMA ADPCM) 2/3/4/5 bit\\ & Supports same formats as Waveform audio format.\\
& & Dialogic OKI ADPCM\\ Waveform audio format
& & YAMAHA ADPCM\\ & \fname{.wav}
& & Adobe SWF ADPCM\\ & Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.711 a-law/$\mu$-law,
Wavpack & \fname{.wv} & \\ Microsoft ADPCM, Intel DVI ADPCM (IMA ADPCM) 2/3/4/5 bit, Dialogic OKI ADPCM,
YAMAHA ADPCM, Adobe SWF ADPCM\\
Wavpack
& \fname{.wv}
& \\
\end{rbtabular} \end{rbtabular}
\subsection{Other Codecs} \subsection{Other Codecs}
\begin{rbtabular}{\textwidth}{l>{\raggedright}p{6em}X}% \begin{rbtabular}{\textwidth}{l>{\raggedright}p{6em}X}%
{\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{} {\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{}
Atari Sound Format & \fname{.cmc}, \fname{.cm3}, \fname{.cmr}, \fname{.cms}, Atari Sound Format
\fname{.dmc}, \fname{.dlt}, \fname{.mpt}, \fname{.mpd} & \tabularnewline & \fname{.cmc}, \fname{.cm3}, \fname{.cmr}, \fname{.cms}, \fname{.dmc},
Synthetic music Mobile Application Format & \fname{.mmf} & Supports PCM/ADPCM only \tabularnewline \fname{.dlt}, \fname{.mpt}, \fname{.mpd}
MOD & \fname{.mod} & \tabularnewline & \\
NES Sound Format & \fname{.nsf}, \fname{.nsfe} & \tabularnewline Synthetic music Mobile Application Format
Atari SAP & \fname{.sap} & \tabularnewline & \fname{.mmf}
Sound Interface Device & \fname{.sid} & \tabularnewline & PCM/ADPCM only \\
SPC700 & \fname{.spc} & \tabularnewline MOD
& \fname{.mod}
& \\
NES Sound Format
& \fname{.nsf}, \fname{.nsfe}
& Progress bar and seek use tracks instead of seconds.\\
Atari SAP
& \fname{.sap}
& \\
Sound Interface Device
& \fname{.sid}
& \\
SPC700
& \fname{.spc}
& \\
\end{rbtabular} \end{rbtabular}
\section{\label{ref:SupportedMetadata}Supported metadata tags} \section{\label{ref:SupportedMetadata}Supported metadata tags}
Rockbox supports different metadata formats. In general those tag formats Rockbox supports different metadata formats. In general those tag formats
are ID3 (v1 and v2), APE (v1 and v2), Vorbis, MP4 and ASF. Few codecs use are ID3 (v1.0, v1.1, v2.2, v2.3 and v2.4), APE (v1 and v2), Vorbis, MP4 and
codec specific tags, several codecs do not use any tags yet. The following ASF. Few codecs use codec specific tags, several codecs do not use any tags
table gives an overview about what tag types rockbox supports for which yet. The following table gives an overview about what tag types rockbox
audio file extension. supports for which audio file extension.
\note{There is always only \emph{one} tag type supported for each file \note{There is always only \emph{one} tag type supported for each file
extension.} extension.}
\begin{rbtabular}{\textwidth}{lX}% \begin{rbtabular}{\textwidth}{lX}%
{\textbf{Extension} & \textbf{Tag type}}{}{} {\textbf{Tag type} & \textbf{File extension}}{}{}
\fname{.mp1}, \fname{.mpa}, \fname{.mp2}, \fname{.mp3}, ID3 & \fname{.mp1}, \fname{.mpa}, \fname{.mp2}, \fname{.mp3},
\fname{.rm}, \fname{.ra}, \fname{.rmvb}, \fname{.tta} & ID3 \\ \fname{.rm}, \fname{.ra}, \fname{.rmvb}, \fname{.tta} \\
\fname{.mpc}, \fname{.ape}, \fname{.mac}, \fname{.wv} & APE \\ APE & \fname{.mpc}, \fname{.ape}, \fname{.mac}, \fname{.wv} \\
\fname{.ogg}, \fname{.oga}, \fname{.spx}, \fname{.flac} & Vorbis \\ Vorbis & \fname{.ogg}, \fname{.oga}, \fname{.spx}, \fname{.flac} \\
\fname{.m4a}, \fname{.m4b}, \fname{.mp4} & MP4 \\ MP4 & \fname{.m4a}, \fname{.m4b}, \fname{.mp4} \\
\fname{.wma}, \fname{.wmv}, \fname{.asf} & ASF \\ ASF & \fname{.wma}, \fname{.wmv}, \fname{.asf} \\
\fname{.mmf}, \fname{.mod}, \fname{.nsf}, \fname{.nsfe}, Codec specific & \fname{.mmf}, \fname{.mod}, \fname{.nsf}, \fname{.nsfe},
\fname{.sap}, \fname{.sid}, \fname{.spc} & Codec specific \\ \fname{.sap}, \fname{.sid}, \fname{.spc} \\
\fname{.a52}, \fname{.ac3}, \fname{.adx}, \fname{.oma}, None & \fname{.a52}, \fname{.ac3}, \fname{.adx}, \fname{.oma},
\fname{.aa3}, \fname{.aif}, \fname{.aiff}, \fname{.au} & None \\ \fname{.aa3}, \fname{.aif}, \fname{.aiff}, \fname{.au},
\fname{.snd}, \fname{.shn}, \fname{.vox}, \fname{.w64}, \fname{.snd}, \fname{.shn}, \fname{.vox}, \fname{.w64},
\fname{.wav}, \fname{.cmc}, \fname{.cm3}, \fname{.cmr} & None \\ \fname{.wav}, \fname{.cmc}, \fname{.cm3}, \fname{.cmr},
\fname{.cms}, \fname{.dmc}, \fname{.dlt}, \fname{.mpt}, \fname{.cms}, \fname{.dmc}, \fname{.dlt}, \fname{.mpt},
\fname{.mpd} & None \\ \fname{.mpd} \\
\end{rbtabular} \end{rbtabular}
\subsection{Featureset for generic metadata tags}
\begin{rbtabular}{\textwidth}{lccccX}%
{\textbf{Feature} & \textbf{ID3} & \textbf{APE} & \textbf{Vorbis} &
\textbf{MP4} & \textbf{ASF}}{}{}
Embedded albumart \fname{.bmp} & & & & & \\
Embedded albumart \fname{.jpg} & x & & & x & \\
Embedded albumart \fname{.png} & & & & & \\
Replaygain information & x & x & x & x & x \\
Title (string) & x & x & x & x & x \\
Artist (string) & x & x & x & x & x \\
Album (string) & x & x & x & x & x \\
Genre (string) & x & x & x & x & x \\
Disc (string or number) & x & x & x & x & \\
Track (string or number) & x & x & x & x & x \\
Year (string or number) & x & x & x & x & x \\
Composer (string) & & x & x & x & x \\
Comment (string) & x & x & x & x & x \\
Albumartist (string) & x & x & x & x & x \\
Grouping (string) & & x & x & x & \\
\end{rbtabular}
\subsection{Featureset for codec specific metadata}
\begin{rbtabular}{\textwidth}{lX}%
{\textbf{Feature} & \textbf{Codec specific metadata (file extension)}}{}{}
Embedded \fname{.bmp} & None \\
Embedded \fname{.jpg} & None \\
Embedded \fname{.png} & None \\
Replaygain & \fname{.mpc}\\
Title & \fname{.tta}, \fname{.spc}, \fname{.mmf}, \fname{.sid},
\fname{.rm}, \fname{.ra}, \fname{.rmvb}, \fname{.nsf},
\fname{.nsfe}, \fname{.mod}, \fname{.sap} \\
Artist & \fname{.tta}, \fname{.spc}, \fname{.mmf}, \fname{.sid},
\fname{.rm}, \fname{.ra}, \fname{.rmvb}, \fname{.nsf},
\fname{.nsfe}, \fname{.sap} \\
Album & \fname{.spc}, \fname{.sid}, \fname{.nsf}, \fname{.nsfe} \\
Genre & \fname{.tta}, \fname{.spc}, \fname{.sap} \\
Disc & \fname{.tta} \\
Track & \fname{.tta} \\
Year & \fname{.spc}, \fname{.sid}, \fname{.sap} \\
Composer & \fname{.mmf} \\
Comment & \fname{.spc}, \fname{.rm}, \fname{.ra}, \fname{.rmvb} \\
Albumartist & None \\
Grouping & None \\
\end{rbtabular}
\subsection{Limitations of metadata handling}
\begin{enumerate}
\item Multiple tags (e.g. for Genre) are not supported. The first tag
item of a set of multiple tags is used.
\item Only one tag type is supported for each audio format.
\nopt{clipv1,c200v2}{
\item Overall there are 900 bytes available to load metadata strings.
\item The maximum size of each metadata item (e.g. Artists) is limited
to 240 bytes.
}
\opt{clipv1,c200v2}{
\item Overall there are 300 bytes available to load metadata strings.
\item The maximum size of each metadata item (e.g. Artists) is limited
to 90 bytes.
}
\end{enumerate}
} }