summaryrefslogtreecommitdiffstats
path: root/manual/appendix/appendix.tex
blob: dfb53025c890e6d1e4f6b89db7a96359e50788f6 (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
% $Id$ %
\appendix
\chapter{File formats}
\section{\label{ref:Supportedfileformats}Supported file formats}
\begin{center}
\begin{tabularx}{\textwidth}{lllX}\toprule
\textbf{Icon} & \textbf{File Type} & \textbf{Extension} 
  & \textbf{Action when selected} \\\midrule
\includegraphics[width=0.37cm]{appendix/images/icon-directory.png} 
  & Directory & \emph{none} & The browser enters that directory \\
\includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} 
  & Audio file & 
  \opt{MASCODEC}{mp3}\opt{SWCODEC}{\emph{various}}
  & Rockbox takes you to the WPS and starts playing the file \\
\includegraphics[width=0.37cm]{appendix/images/icon-wav-file.png} 
  & Wave Audio File & \fname{.wav} & Play a WAV file \\%
\includegraphics[width=0.37cm]{appendix/images/icon-playlist.png} 
  & Playlist & \fname{.m3u} & Rockbox loads the playlist and starts playing 
    the first file \\
\includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 
  & Rockbox firmware & 
    \opt{player}{\fname{.mod}}\opt{recorder,recorderv2fm,ondiofm,ondiosp}{\fname{.ajz}}\opt{iriver}{\fname{.iriver}}\opt{ipod}{\fname{.ipod}}
  & ROLO will load the new firmware \\
\includegraphics[width=0.37cm]{appendix/images/icon-wps.png} 
  & While Playing Screen & \fname{.wps} & The new WPS display configuration will be loaded \\
\includegraphics[width=0.37cm]{appendix/images/icon-lang.png} 
  & Language File & \fname{.lng} & Loads a language file \\
\includegraphics[width=0.37cm]{appendix/images/icon-text.png} 
  & Text File & \fname{.txt} & This will display the text file using Rockbox text browser plugin\\
\includegraphics[width=0.37cm]{appendix/images/icon-config.png} 
  & Configuration File & \fname{.cfg} & The settings file will be loaded\\
\includegraphics[width=0.37cm]{appendix/images/icon-font.png} 
  & Font & \fname{.fnt} & This font will replace the current one\\
\includegraphics[width=0.37cm]{appendix/images/icon-rock.png} 
  & Plugin & \fname{.rock} & Starts a Rockbox plugin\\
\opt{archos}{
  \includegraphics[width=0.37cm]{appendix/images/icon-ucl.png} 
    & Flash Image & \fname{.ucl} & This Rockbox image will be flashed into the ROM \\
  }
\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} 
  & Chip8 game & \fname{.ch8} & Play a Chip8 game \\
\includegraphics[width=0.37cm]{appendix/images/icon-image-file.png} 
  & Image & \fname{.jpg} & View a JPEG image \\
\opt{MASCODEC}{\opt{HAVE_LCD_BITMAP}{
  \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} 
    & Rockbox Video & \fname{.rvf} & View a movie (Rockbox format)\\}
}
\bottomrule
\end{tabularx}
\end{center}

\input{appendix/wps_tags.tex}

\chapter{\label{ref:config_file_options}Config file options}
\ifpdfoutput{\input{appendix/config_file_options.tex}}
{\fixme{The config file options are omitted in the HTML version of the manual for now.}}

\chapter{LCD Screen Sizes}
\begin{center}
  \begin{tabularx}{.8\textwidth}{lXX}\toprule
    \textbf{Player} & \textbf{Main LCD Size} & \textbf{Remote LCD Size}\\\midrule
    Archos Players & 11x2 characters & (none)\\
    Archos Recorders & 112x64 & (none)\\ 
    Archos Ondio & 112x64 & (none)\\
    Iaudio X5 & 160x128 & 128x96\\
    Ipod 4G Gray & 160x128 & (none)\\
    Ipod 4G Color & 220x176 & (none)\\
    Ipod 5G Video & 320x240 & (none)\\
    Ipod Mini &138x110 & (none) \\
    Ipod Nano & 176x132 & (none)\\
    Iriver H1x0 & 160x128 & 128x64\\
    Iriver H3x0 & 220x176 & 128x64\\\bottomrule
  \end{tabularx}
\end{center}


\chapter{User feedback}
\section{Bug reports}
If you experience inappropriate performance from any supported feature,
please file a bug report on our web page. Do not report missing
features as bugs, instead file them as feature requests (see below).

For open bug reports refer to
\url{http://www.rockbox.org/tracker/index.php?type=2}

\subsection{Rules for submitting new bug reports}

\begin{enumerate}
\item  Check that the bug hasn't already been reported
\item  Always include the following information in your bug report:
\end{enumerate}

\begin{itemize}
\item  Which exact model Jukebox you have (as printed on the unit)
\item  Which exact ROM firmware version you have
\item  Which exact Rockbox version you are using
(Menu{}-{\textgreater}Info {}-{\textgreater} Version)
\item  A step{}-by{}-step description of what you did and what happened
\item  Whether the problem is repeatable or a one{}-time occurrence
\item  All relevant data regarding the problem, such as playlists, MP3
files etc. (IMPORTANT!) 
\end{itemize}

\section{Feature requests}
For open feature requests refer to
\url{http://www.rockbox.org/tracker/index.php?type=1}

\subsection{Rules for submitting a new feature request}

\begin{enumerate}
\item Check that the feature hasn't already been requested. 
  Duplicates are really boring!
\item Check that the feature hasn't already been implemented. 
  Download the latest daily build and/or search the mail list archive.
\item Check that the feature is possible to implement (see \reference{ref:NODO}).
\end{enumerate}

\subsection{\label{ref:NODO}Features we will not implement}
This is a list of Feature Requests we get repeatedly that we simply
cannot do. View it as the opposite of a TODO!

\opt{player,recorder,recorderv2fm}{
\begin{itemize}
\item Record to WAV (uncompressed) or MP3pro format!\\
The recording hardware (the MAS) does not allow us to do this
\item Crossfade between tracks!\\
  Crossfading would require two mp3 decoders, and we only have one. 
  This is not possible.
\item Interfacing with other USB devices (like cameras) or 2 player games over USB\\
  The USB system demands that there is a master that talks to a slave. The 
  Jukebox can only serve as a slave, as most other USB devices such as 
  cameras can. Thus, without a master no communication between the slaves 
  can take place. If that is not enough, we have no ways of actually 
  controlling the communication performed over USB since the USB circuit 
  in the Jukebox is strictly made for disk{}-access and does not allow us 
  to play with it the way we'd need for any good communication to work.
\item Support MP3pro, WMA or other sound format playback!\\
  The mp3{}-decoding hardware can only play MP3. We cannot make it play other 
  sound formats.
\item  Converting OGG $\rightarrow$ MP3 \\
  The mp3{}-decoding hardware cannot decode OGG. It can be reprogrammed, but 
  there is too little memory for OGG and we have no documentation on how to 
  program the MAS' DSP. Doing the conversion with the CPU is impossible, since 
  a 12MHz SH1 is far too slow for this daunting task.
\item Archos Multimedia support!\\
  The Archos Multimedia is a completely different beast. It is an entirely 
  different architecture, different CPU and upgrading the software is done 
  a completely different way. We do not wish to venture into this.  Others 
  may do so. We won't.
\item Multi{}-band (or graphic) equaliser\\
  We cannot access information for that kind of visualisation from the MP3 
  decoding hardware.
\item Support other filesystems than FAT32 (like NTFS or ext2 or whatever)!\\
  No. Rockbox needs to support FAT32 since it can only start off a FAT32 
  partition (since that is the only way the ROM can load it), and adding 
  support for more file systems will just take away valuable ram for 
  unnecessary features. You can partition your Jukebox fine, just make sure 
  the first one is FAT32 and then make the other ones whatever file system 
  you want. Just don't expect Rockbox to understand them.
\item Add scandisk{}-like features!\\
  It would be a very slow operation that would drain the batteries and 
  take a lot of useful ram for something that is much better and faster 
  done when connected to a host computer.
\item CBR recording!\\
  The MP3 encoding hardware does not allow this.
\item Change tempo of a song without changing pitch!\\
  The MP3 decoding hardware does not allow this.
\item Graphic frequency (spectrum analyser!)\\
  We can't access the audio waveform from the MP3 decoder so we can't analyse 
  it. Even if we had access to it, the CPU would probably be too slow to 
  perform the analysis anyway.
\item Cool sound effects!\\
  Adding new sound effects requires reprogramming the MAS chip, and we can't 
  do that. The MAS chip is programmable, but we have no access to the chip 
  documentation.
\end{itemize}
}


\chapter{Changelog}
\section{What's new since v2.5?}
Changes in version 2.5

\chapter{Credits}
People that have contributed to the project, one way or another. Friends!
%
\begin{multicols}{2}
\noindent\textsc{\small{\input{CREDITS.tex}}}
\end{multicols}

\chapter{GNU Free Documentation Licence}
\input{appendix/fdl.tex}