summaryrefslogtreecommitdiff
path: root/manual/appendix/file_formats.tex
blob: 68a7780e63c534e81e584cae73d941a84697a611 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
% $Id$ %
\chapter{File formats}
\section{\label{ref:Supportedfileformats}Supported file formats}
\begin{rbtabular}{\textwidth}{clp{7em}X}%
{\textbf{Icon} & \textbf{File Type} & \textbf{Extension} 
  & \textbf{Action when selected}}{}{}
\includegraphics[width=0.37cm]{appendix/images/icon-directory.png} 
  & Directory & \emph{none} & Enter the directory \\
\opt{recorder,recorderv2fm,ondiofm,ondiosp}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.ajz} & Load the new firmware with ROLO \\
}
\opt{swcodec}{
  \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} 
  & Audio file & \emph{various}\newline%
  (see \ref{ref:Supportedaudioformats})%
  % do NOT use \reference{} here as that will break the table.
  & Start playing the file and show the WPS\\
}
  & Bookmark & \fname{.bmark} & Display all bookmarks for an audio file\\
\opt{lcd_bitmap}{
  & Game of Life & \fname{.cells} & Show the configuration with the
     ``Rocklife'' plugin\\
}
\includegraphics[width=0.37cm]{appendix/images/icon-config.png} 
  & Configuration File & \fname{.cfg} & Load the settings file\\
\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} 
  & Chip8 game & \fname{.ch8} & Play the Chip8 game \\
\opt{lcd_color}{
  & Colours & \fname{.colours} & Open the colours file for editing.
    See \reference{ref:ChangingFiletypeColours}.\\
}
\includegraphics[width=0.37cm]{appendix/images/icon-cuesheet.png} 
  & Cuesheet & \fname{.cue} & View the cuesheet file \\
\opt{radio}{
  & FM Presets & \fname{.fmr} & Load the FM Presets (previous are discarded)\\
}
\includegraphics[width=0.37cm]{appendix/images/icon-font.png} 
  & Font & \fname{.fnt} & Change the user interface font to this one\\
\opt{gigabeat}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.gigabeat} & Load the new firmware with ROLO \\
}
\opt{iaudio}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.iaudio} & Load the new firmware with ROLO \\
}
\opt{ipod}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.ipod} & Load the new firmware with ROLO \\
}
\opt{iriverh100,iriverh300}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.iriver} & Load the new firmware with ROLO \\
}
\includegraphics[width=0.37cm]{appendix/images/icon-image-file.png} 
  & Image & \fname{.jpg} & View the JPEG image \\
  & Link & \fname{.link} & Display list of target files and directories;
    selecting one jumps to the target. See \reference{ref:Shortcutsplugin}.\\
\includegraphics[width=0.37cm]{appendix/images/icon-lang.png} 
  & Language File & \fname{.lng} & Load the language file \\
\includegraphics[width=0.37cm]{appendix/images/icon-playlist.png}
  & Playlist & \fname{.m3u, .m3u8} & Load the playlist and start playing 
    the first file \\
\opt{iriverh10,iriverh10_5gb,sansa,vibe500}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.mi4} & Load the new firmware with ROLO \\
}
\opt{player}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.mod} & Load the new firmware with ROLO \\
}
\opt{masd,masf}{
  \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} 
  & Audio file & \fname{.mp2, .mp3} & Start playing the file and show the WPS\\
}
\opt{swcodec}{
 \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png}
 & Video & \fname{.mpg, .mpeg, .mpv, .m2v} & Play the MPEG1/2 video \\
}
\includegraphics[width=0.37cm]{appendix/images/icon-rock.png} 
  & Plugin & \fname{.rock} & Start the plugin\\
\opt{masf}{\opt{lcd_bitmap}{
  \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} 
    & Rockbox Video & \fname{.rvf} & View the movie (Rockbox format)\\}
}
\opt{sansaAMS}{
  \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & \fname{.sansa} & Load the new firmware with ROLO \\
}
\includegraphics[width=0.37cm]{appendix/images/icon-text.png} 
  & Text File & \fname{.txt} & Display the text file using the text viewer plugin\\
\opt{archos}{
  \includegraphics[width=0.37cm]{appendix/images/icon-ucl.png} 
    & Flash Image & \fname{.ucl} & Flash the Rockbox image into the ROM \\
  }
  & Voice file & \fname{.voice} & Allow Rockbox to speak menus\\
\opt{masf}{
  \includegraphics[width=0.37cm]{appendix/images/icon-wav-file.png} 
    & Wave Audio File & \fname{.wav} & Play the WAV file \\%
}
\includegraphics[width=0.37cm]{appendix/images/icon-wps.png} 
  & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\\
\end{rbtabular}

\opt{swcodec}{
  \section{\label{ref:Supportedaudioformats}Supported audio formats}
  \subsection{Lossy Codecs}
  \begin{rbtabular}{\textwidth}{lp{6em}X}%
  {\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{}
    ATSC A/52 & \fname{.a52, .ac3} & Supports downmixing for playback of 5.1 streams in stereo. \\
    ADX & \fname{.adx} & \\
    Advanced Audio Coding & \fname{.m4a, .m4b, .mp4} & \\
    MPEG audio & \fname{.mp1, .mpa, .mp2, .mp3} & \\
    Musepack & \fname{.mpc} & Supports SV7 and SV8 in mono/stereo \\
    OGG/Vorbis & \fname{.ogg, .oga} & Playback of some old ``floor 0'' files may fail. \\
    Sony Audio & \fname{.oma, .aa3} & \\
    RealAudio & \fname{.rm, .ra, .rmvb} & \\
    Speex & \fname{.spx} & \\
    Dialogic telephony type & \fname{.vox} & \\
    Windows Media Audio Standard & \fname{.wma, .wmv, .asf} & \\
    Windows Media Audio Professional & \fname{.wma, .wmv, .asf} & \\
  \end{rbtabular}

  \subsection{Lossless Codecs}
  \begin{rbtabular}{\textwidth}{lp{6em}X}%
  {\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{}
    Audio Interchange File Format & \fname{.aif, .aiff} & AIFF supports following formats: \\
                                  &                     & linear pcm 8/16/24/32 bit. \\
                                  &                     & IEEE float 32/64 bit\\
                                  &                     & ITU-T G.711 a-low/$\mu$-low\\
                                  &                     & QuickTime IMA ADPCM\\
    \opt{gigabeatf,iriverh100,iriverh300,iaudiox5,iaudiom5,iaudiom3,ipodnano2g,clipv1}{
      Monkey's Audio & \fname{.ape, .mac} & -c1000 to -c3000
      files decode fast enough to be useful.}
    \opt{gigabeats}{
      Monkey's Audio & \fname{.ape, .mac} & }
    \nopt{ipodnano2g}{
      \opt{ipod,iriverh10,iriverh10_5gb,mrobe100,sansa,vibe500}{
        Monkey's Audio & \fname{.ape, .mac} & Only -c1000 files decode fast
        enough to be useful.}
    }
    \\
    Sun Audio & \fname{.au, .snd} & Sun Audio supports following formats: \\
              &                   & linear pcm 8/16/24/32 bit. \\
              &                   & IEEE float 32/64 bit\\
              &                   & ITU-T G.711 a-low/$\mu$-low\\
    Free Lossless Audio & \fname{.flac} & \\
    Apple Lossless & \fname{.m4a, .mp4} & \\
    Shorten & \fname{.shn} & Seeking not supported.\\
    True Audio & \fname{.tta} & \\
    Wave64 & \fname{.w64} & Wave/Wave64 supports following formats: \\
    Waveform audio format & \fname{.wav} & linear pcm 8/16/24/32 bit. \\
                          &              & IEEE float 32/64 bit\\
                          &              & ITU-T G.711 a-low/$\mu$-low\\
                          &              & 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}

  \subsection{Other Codecs}
  \begin{rbtabular}{\textwidth}{lp{6em}X}%
  {\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{}
    Atari Sound Format & \fname{.cmc, .cm3, .cmr, .cms, .dmc, .dlt, .mpt, .mpd} & \\
    Synthetic music Mobile Application Format & \fname{.mmf} & Supports PCM/ADPCM only \\
    MOD & \fname{.mod} & \\
    NES Sound Format & \fname{.nsf, .nsfe} & \\
    Atari SAP & \fname{.sap} & \\
    Sound Interface Device & \fname{.sid} & \\
    SPC700 & \fname{.spc} & \\
  \end{rbtabular}
  
  \section{\label{ref:SupportedMetadata}Supported metadata tags}
    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
    codec specific tags, several codecs do not use any tags yet. The following
    table gives an overview about what tag types rockbox supports for which
    audio file extension.
    
    \note{There is always only \emph{one} tag type supported for each file
    extension.}
    
    \begin{rbtabular}{\textwidth}{lX}%
    {\textbf{Extension} & \textbf{Tag type}}{}{}
      \fname{.mp1}, \fname{.mpa}, \fname{.mp2}, \fname{.mp3},
         \fname{.rm}, \fname{.ra}, \fname{.rmvb}, \fname{.tta}        & ID3 \\
      \fname{.mpc}, \fname{.ape}, \fname{.mac}, \fname{.wv}           & APE \\
      \fname{.ogg}, \fname{.oga}, \fname{.spx}, \fname{.flac}         & Vorbis \\
      \fname{.m4a}, \fname{.m4b}, \fname{.mp4}                        & MP4 \\
      \fname{.wma}, \fname{.wmv}, \fname{.asf}                        & ASF \\
      \fname{.mmf}, \fname{.mod}, \fname{.nsf}, \fname{.nsfe},
         \fname{.sap}, \fname{.sid}, \fname{.spc}                     & Codec specific \\
      \fname{.a52}, \fname{.ac3}, \fname{.adx}, \fname{.oma},
         \fname{.aa3}, \fname{.aif}, \fname{.aiff}, \fname{.au}       & None \\
      \fname{.snd}, \fname{.shn}, \fname{.vox}, \fname{.w64},
         \fname{.wav}, \fname{.cmc}, \fname{.cm3}, \fname{.cmr}       & None \\
      \fname{.cms}, \fname{.dmc}, \fname{.dlt}, \fname{.mpt},
         \fname{.mpd}                                                 & None \\
    \end{rbtabular}
}