blob: a7f18d12df67c48d4857d559468553a85d094d44 [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
Dominik Riebeling9723cb72006-09-17 20:47:10 +00008\input{appendix/config_file_options.tex}
Martin Arver55e67fc2006-03-23 15:23:53 +00009
Martin Arvere78cb652008-07-15 18:33:43 +000010\input{appendix/menu_structure.tex}
11
Dominik Riebeling536c6b42006-08-14 07:13:01 +000012\chapter{User feedback}\label{sec:feedback}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000013\section{Bug reports}
14If you experience inappropriate performance from any supported feature,
15please file a bug report on our web page. Do not report missing
Marc Guay6e4aab02008-07-12 22:46:53 +000016features as bugs, instead file them as feature ideas (see below).
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000017
18For open bug reports refer to
Dominik Riebeling8258c5f2006-04-09 12:25:45 +000019\url{http://www.rockbox.org/tracker/index.php?type=2}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000020
Martin Arver784e0e12006-03-13 13:29:27 +000021\subsection{Rules for submitting new bug reports}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000022
23\begin{enumerate}
Thom Johansenc479b992008-02-13 13:32:44 +000024\item Check that the bug has not already been reported
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000025\item Always include the following information in your bug report:
Martin Arver784e0e12006-03-13 13:29:27 +000026
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000027\begin{itemize}
Martin Arver7bdd03a2006-08-27 15:00:50 +000028\item Which exact \dap{} you have.
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000029\item Which exact Rockbox version you are using
Nils Wallménius22942db2010-05-17 08:12:07 +000030(Menu $\rightarrow$ System $\rightarrow$ Rockbox Info $\rightarrow$ Version)
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000031\item A step{}-by{}-step description of what you did and what happened
Martin Arver784e0e12006-03-13 13:29:27 +000032\item Whether the problem is repeatable or a one{}-time occurrence
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000033\item All relevant data regarding the problem, such as playlists, MP3
Nils Wallménius22942db2010-05-17 08:12:07 +000034files etc. (IMPORTANT!)
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000035\end{itemize}
Frank Gevaerts9050cdd2010-01-20 18:33:44 +000036\end{enumerate}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000037
Marc Guay6e4aab02008-07-12 22:46:53 +000038\section{Feature ideas}
39To suggest an idea for a feature or to read those made by others, see
40\url{http://forums.rockbox.org/index.php?board=49.0}. Please keep in
41mind that this forum is for the discussion of feature ideas - they are not
42 requests and there is no guarantee they will be acted upon.
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000043
Marc Guay6e4aab02008-07-12 22:46:53 +000044\subsection{Rules for submitting a new feature idea}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000045
46\begin{enumerate}
Marc Guay8df0a922008-07-12 23:05:38 +000047\item Check that the feature has not already been suggested.
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000048 Duplicates are really boring!
Thom Johansenc479b992008-02-13 13:32:44 +000049\item Check that the feature has not already been implemented.
Martin Arver06848272007-01-29 18:47:53 +000050 Download the latest current/daily build and/or search the mail list archive.
Martin Arver26c6e7b2006-08-01 11:57:38 +000051\item Check that the feature is possible to implement (see \reference{ref:NODO}).
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000052\end{enumerate}
53
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000054\subsection{\label{ref:NODO}Features we will not implement}
55This is a list of Feature Requests we get repeatedly that we simply
56cannot do. View it as the opposite of a TODO!
57
58\begin{itemize}
Nils Wallménius7d6add52006-08-19 12:23:47 +000059\opt{archos}{
Alex Parkera8cf6432009-12-17 23:41:01 +000060\item Record to WAV (uncompressed) or MP3pro format.\\
Christi Scarboroughd68d7c02006-02-06 07:25:25 +000061The recording hardware (the MAS) does not allow us to do this
Alex Parkera8cf6432009-12-17 23:41:01 +000062\item Crossfade between tracks.\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000063 Crossfading would require two mp3 decoders, and we only have one.
64 This is not possible.
Alex Parkera8cf6432009-12-17 23:41:01 +000065\item Support MP3pro, WMA or other sound format playback.\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000066 The mp3{}-decoding hardware can only play MP3. We cannot make it play other
67 sound formats.
Alex Parkera8cf6432009-12-17 23:41:01 +000068\item Converting OGG $\rightarrow$ MP3.\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000069 The mp3{}-decoding hardware cannot decode OGG. It can be reprogrammed, but
70 there is too little memory for OGG and we have no documentation on how to
71 program the MAS' DSP. Doing the conversion with the CPU is impossible, since
Andree Buschmann1248e9c2010-04-14 20:38:21 +000072 a 12~MHz SH1 is far too slow for this daunting task.
Alex Parkera8cf6432009-12-17 23:41:01 +000073\item Archos Multimedia support.\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000074 The Archos Multimedia is a completely different beast. It is an entirely
75 different architecture, different CPU and upgrading the software is done
76 a completely different way. We do not wish to venture into this. Others
Thom Johansenc479b992008-02-13 13:32:44 +000077 may do so. We will not.
Alex Parkera8cf6432009-12-17 23:41:01 +000078\item Multi{}-band (or graphic) equaliser.\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000079 We cannot access information for that kind of visualisation from the MP3
80 decoding hardware.
Alex Parkera8cf6432009-12-17 23:41:01 +000081\item CBR recording.\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000082 The MP3 encoding hardware does not allow this.
Alex Parkera8cf6432009-12-17 23:41:01 +000083\item Change tempo of a song without changing pitch.\\
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000084 The MP3 decoding hardware does not allow this.
Alex Parkera8cf6432009-12-17 23:41:01 +000085\item Graphic frequency (spectrum analyser).\\
Thom Johansenc479b992008-02-13 13:32:44 +000086 We cannot access the audio waveform from the MP3 decoder so we cannot analyse
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000087 it. Even if we had access to it, the CPU would probably be too slow to
88 perform the analysis anyway.
Alex Parkera8cf6432009-12-17 23:41:01 +000089\item Cool sound effects.\\
Thom Johansenc479b992008-02-13 13:32:44 +000090 Adding new sound effects requires reprogramming the MAS chip, and we cannot
Dominik Riebeling3fbbce32006-04-01 17:17:15 +000091 do that. The MAS chip is programmable, but we have no access to the chip
92 documentation.
Martin Arver784e0e12006-03-13 13:29:27 +000093}
Marianne Arnoldb43b4932011-01-17 18:30:18 +000094\nopt{iriverh300,iaudiox5}{
Alex Parkera8cf6432009-12-17 23:41:01 +000095\item Interfacing with other USB devices (like cameras) or 2 player games over USB.\\
Nils Wallménius7d6add52006-08-19 12:23:47 +000096 The USB system demands that there is a master that talks to a slave. The
97 \dap{} can only serve as a slave, as most other USB devices such as
98 cameras can. Thus, without a master no communication between the slaves
Robert Menesf747d9d2009-02-06 17:13:32 +000099 can take place. If that is not enough, we have no way of actually
Nils Wallménius7d6add52006-08-19 12:23:47 +0000100 controlling the communication performed over USB since the USB circuit
101 in the \dap{} is strictly made for disk{}-access and does not allow us
102 to play with it the way we'd need for any good communication to work.
103}
Alex Parkera8cf6432009-12-17 23:41:01 +0000104\item Support other file systems than FAT32 (like NTFS or ext2 etc.).\\
Nils Wallménius7d6add52006-08-19 12:23:47 +0000105 No.
106 \opt{archos}{Rockbox needs to support FAT32 since it can only start off a FAT32
107 partition (since that is the only way the ROM can load it), and adding}%
108 support for more file systems will just take away valuable ram for
109 unnecessary features. You can partition your \dap{} fine, just make sure
110 the first one is FAT32 and then make the other ones whatever file system
Thom Johansenc479b992008-02-13 13:32:44 +0000111 you want. Just do not expect Rockbox to understand them.
Alex Parkera8cf6432009-12-17 23:41:01 +0000112\item Add scandisk{}-like features.\\
Nils Wallménius7d6add52006-08-19 12:23:47 +0000113 It would be a very slow operation that would drain the batteries and
114 take a lot of useful ram for something that is much better and faster
115 done when connected to a host computer.
Alex Parkera8cf6432009-12-17 23:41:01 +0000116\item Alphabetical list skipping.\\
117 Skipping around the lists by jumping letters (i.e skip all C's and go
118 straight to the first D). This isn't feasible with the current list
119 implementation, if you really want this you can get similar effects using
120 the database (see \reference{ref:database}).
121\item Add support for non standard tag formats.\\
122APE tags in MP3 files has been rejected a few times already. Its not something we want.
123\item Implementing the ability to playback DRM files.\\
124 Firstly, this would be extremely difficult to implement legally - Rockbox
125 is not legal entity as such, and therefore is unable to enter into license
126 agreements with providers of DRM technology.
127 Secondly, Rockbox is open source, which would mean that any DRM technology we
128 incorporated into our codebase would suddenly become visible to the whole world,
Bertrik Sikken9e7898b2011-05-22 14:01:28 +0000129 completely defeating its purpose. Remember, DRM achieves part of its security
Alex Parkera8cf6432009-12-17 23:41:01 +0000130 through obscurity, and publishing the keys necessary to decrypt DRM'd
131 media would essentially render it useless.
Nils Wallménius7d6add52006-08-19 12:23:47 +0000132\end{itemize}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +0000133
Martin Arver784e0e12006-03-13 13:29:27 +0000134\chapter{Credits}
Dominik Riebelingb074b222006-06-05 10:08:54 +0000135People that have contributed to the project, one way or another. Friends!
136%
137\begin{multicols}{2}
Dominik Riebelingcee8f012008-12-01 21:21:42 +0000138\noindent\caps{\small{\input{CREDITS.tex}}}
Dominik Riebelingb074b222006-06-05 10:08:54 +0000139\end{multicols}
Christi Scarboroughd68d7c02006-02-06 07:25:25 +0000140
Martin Arvere9163b42006-12-07 20:47:39 +0000141\chapter{Licenses}
142
143\section{GNU Free Documentation License}
Martin Arver784e0e12006-03-13 13:29:27 +0000144\input{appendix/fdl.tex}
Martin Arvere9163b42006-12-07 20:47:39 +0000145\newpage
146\section{The GNU General Public License}
Thom Johansenc479b992008-02-13 13:32:44 +0000147\input{appendix/gpl-2.0.tex}