blob: 9aeadba56dac3df3faaf80ffddf719c3704b63d3 [file] [log] [blame]
Dominik Riebeling36a31332006-04-09 21:22:42 +00001% $Id$ %
Christi Scarboroughd68d7c02006-02-06 07:25:25 +00002\appendix
Dominik Riebeling251e5192006-08-02 17:21:38 +00003
4\input{appendix/file_formats.tex}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +00005
Martin Arver94c12892006-03-23 14:11:52 +00006\input{appendix/wps_tags.tex}
7
Marianne Arnoldbfc73a12009-03-22 16:55:24 +00008\opt{lcd_bitmap}{\opt{tagcache}{
Jonas Häggqvist410cbd12009-02-20 18:37:57 +00009\input{appendix/album_art.tex}
10}}
11
Dominik Riebeling9723cb72006-09-17 20:47:10 +000012\input{appendix/config_file_options.tex}
Martin Arver55e67fc2006-03-23 15:23:53 +000013
Martin Arvere78cb652008-07-15 18:33:43 +000014\input{appendix/menu_structure.tex}
15
Dominik Riebeling536c6b42006-08-14 07:13:01 +000016\chapter{User feedback}\label{sec:feedback}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000017\section{Bug reports}
18If you experience inappropriate performance from any supported feature,
19please file a bug report on our web page. Do not report missing
Marc Guay6e4aab02008-07-12 22:46:53 +000020features as bugs, instead file them as feature ideas (see below).
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000021
22For open bug reports refer to
Dominik Riebeling8258c5f2006-04-09 12:25:45 +000023\url{http://www.rockbox.org/tracker/index.php?type=2}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000024
Martin Arver784e0e12006-03-13 13:29:27 +000025\subsection{Rules for submitting new bug reports}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000026
27\begin{enumerate}
Thom Johansenc479b992008-02-13 13:32:44 +000028\item Check that the bug has not already been reported
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000029\item Always include the following information in your bug report:
30\end{enumerate}
Martin Arver784e0e12006-03-13 13:29:27 +000031
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000032\begin{itemize}
Martin Arver7bdd03a2006-08-27 15:00:50 +000033\item Which exact \dap{} you have.
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000034\item Which exact Rockbox version you are using
35(Menu{}-{\textgreater}Info {}-{\textgreater} Version)
36\item A step{}-by{}-step description of what you did and what happened
Martin Arver784e0e12006-03-13 13:29:27 +000037\item Whether the problem is repeatable or a one{}-time occurrence
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000038\item All relevant data regarding the problem, such as playlists, MP3
39files etc. (IMPORTANT!)
40\end{itemize}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000041
Marc Guay6e4aab02008-07-12 22:46:53 +000042\section{Feature ideas}
43To suggest an idea for a feature or to read those made by others, see
44\url{http://forums.rockbox.org/index.php?board=49.0}. Please keep in
45mind that this forum is for the discussion of feature ideas - they are not
46 requests and there is no guarantee they will be acted upon.
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000047
Marc Guay6e4aab02008-07-12 22:46:53 +000048\subsection{Rules for submitting a new feature idea}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000049
50\begin{enumerate}
Marc Guay8df0a922008-07-12 23:05:38 +000051\item Check that the feature has not already been suggested.
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000052 Duplicates are really boring!
Thom Johansenc479b992008-02-13 13:32:44 +000053\item Check that the feature has not already been implemented.
Martin Arver06848272007-01-29 18:47:53 +000054 Download the latest current/daily build and/or search the mail list archive.
Martin Arver26c6e7b2006-08-01 11:57:38 +000055\item Check that the feature is possible to implement (see \reference{ref:NODO}).
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000056\end{enumerate}
57
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000058\subsection{\label{ref:NODO}Features we will not implement}
59This is a list of Feature Requests we get repeatedly that we simply
60cannot do. View it as the opposite of a TODO!
61
62\begin{itemize}
Nils Wallménius7d6add52006-08-19 12:23:47 +000063\opt{archos}{
Martin Arver784e0e12006-03-13 13:29:27 +000064\item Record to WAV (uncompressed) or MP3pro format!\\
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000065The recording hardware (the MAS) does not allow us to do this
Martin Arver784e0e12006-03-13 13:29:27 +000066\item Crossfade between tracks!\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000067 Crossfading would require two mp3 decoders, and we only have one.
68 This is not possible.
Martin Arver784e0e12006-03-13 13:29:27 +000069\item Support MP3pro, WMA or other sound format playback!\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000070 The mp3{}-decoding hardware can only play MP3. We cannot make it play other
71 sound formats.
72\item Converting OGG $\rightarrow$ MP3 \\
73 The mp3{}-decoding hardware cannot decode OGG. It can be reprogrammed, but
74 there is too little memory for OGG and we have no documentation on how to
75 program the MAS' DSP. Doing the conversion with the CPU is impossible, since
76 a 12MHz SH1 is far too slow for this daunting task.
Martin Arver784e0e12006-03-13 13:29:27 +000077\item Archos Multimedia support!\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000078 The Archos Multimedia is a completely different beast. It is an entirely
79 different architecture, different CPU and upgrading the software is done
80 a completely different way. We do not wish to venture into this. Others
Thom Johansenc479b992008-02-13 13:32:44 +000081 may do so. We will not.
Martin Arver784e0e12006-03-13 13:29:27 +000082\item Multi{}-band (or graphic) equaliser\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000083 We cannot access information for that kind of visualisation from the MP3
84 decoding hardware.
Martin Arver784e0e12006-03-13 13:29:27 +000085\item CBR recording!\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000086 The MP3 encoding hardware does not allow this.
Martin Arver784e0e12006-03-13 13:29:27 +000087\item Change tempo of a song without changing pitch!\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000088 The MP3 decoding hardware does not allow this.
Martin Arver784e0e12006-03-13 13:29:27 +000089\item Graphic frequency (spectrum analyser!)\\
Thom Johansenc479b992008-02-13 13:32:44 +000090 We cannot access the audio waveform from the MP3 decoder so we cannot analyse
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000091 it. Even if we had access to it, the CPU would probably be too slow to
92 perform the analysis anyway.
Martin Arver784e0e12006-03-13 13:29:27 +000093\item Cool sound effects!\\
Thom Johansenc479b992008-02-13 13:32:44 +000094 Adding new sound effects requires reprogramming the MAS chip, and we cannot
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000095 do that. The MAS chip is programmable, but we have no access to the chip
96 documentation.
Martin Arver784e0e12006-03-13 13:29:27 +000097}
Nils Wallménius7d6add52006-08-19 12:23:47 +000098\nopt{h300,x5}{
99\item Interfacing with other USB devices (like cameras) or 2 player games over USB\\
100 The USB system demands that there is a master that talks to a slave. The
101 \dap{} can only serve as a slave, as most other USB devices such as
102 cameras can. Thus, without a master no communication between the slaves
Robert Menesf747d9d2009-02-06 17:13:32 +0000103 can take place. If that is not enough, we have no way of actually
Nils Wallménius7d6add52006-08-19 12:23:47 +0000104 controlling the communication performed over USB since the USB circuit
105 in the \dap{} is strictly made for disk{}-access and does not allow us
106 to play with it the way we'd need for any good communication to work.
107}
Martin Arverf8e2f3e2006-10-17 12:18:51 +0000108\item Support other file systems than FAT32 (like NTFS or ext2 or whatever)!\\
Nils Wallménius7d6add52006-08-19 12:23:47 +0000109 No.
110 \opt{archos}{Rockbox needs to support FAT32 since it can only start off a FAT32
111 partition (since that is the only way the ROM can load it), and adding}%
112 support for more file systems will just take away valuable ram for
113 unnecessary features. You can partition your \dap{} fine, just make sure
114 the first one is FAT32 and then make the other ones whatever file system
Thom Johansenc479b992008-02-13 13:32:44 +0000115 you want. Just do not expect Rockbox to understand them.
Nils Wallménius7d6add52006-08-19 12:23:47 +0000116\item Add scandisk{}-like features!\\
117 It would be a very slow operation that would drain the batteries and
118 take a lot of useful ram for something that is much better and faster
119 done when connected to a host computer.
120\end{itemize}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +0000121
Frank Gevaerts54c1c772008-12-21 16:26:35 +0000122\input{appendix/changelog.tex}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +0000123
Martin Arver784e0e12006-03-13 13:29:27 +0000124\chapter{Credits}
Dominik Riebelingb074b222006-06-05 10:08:54 +0000125People that have contributed to the project, one way or another. Friends!
126%
127\begin{multicols}{2}
Dominik Riebelingcee8f012008-12-01 21:21:42 +0000128\noindent\caps{\small{\input{CREDITS.tex}}}
Dominik Riebelingb074b222006-06-05 10:08:54 +0000129\end{multicols}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +0000130
Martin Arvere9163b42006-12-07 20:47:39 +0000131\chapter{Licenses}
132
133\section{GNU Free Documentation License}
Martin Arver784e0e12006-03-13 13:29:27 +0000134\input{appendix/fdl.tex}
Martin Arvere9163b42006-12-07 20:47:39 +0000135\newpage
136\section{The GNU General Public License}
Thom Johansenc479b992008-02-13 13:32:44 +0000137\input{appendix/gpl-2.0.tex}