Dominik Riebeling | 36a3133 | 2006-04-09 21:22:42 +0000 | [diff] [blame] | 1 | % $Id$ % |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 2 | \appendix |
Dominik Riebeling | 251e519 | 2006-08-02 17:21:38 +0000 | [diff] [blame] | 3 | |
| 4 | \input{appendix/file_formats.tex} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 5 | |
Martin Arver | 94c1289 | 2006-03-23 14:11:52 +0000 | [diff] [blame] | 6 | \input{appendix/wps_tags.tex} |
| 7 | |
Dominik Riebeling | 9723cb7 | 2006-09-17 20:47:10 +0000 | [diff] [blame] | 8 | \input{appendix/config_file_options.tex} |
Martin Arver | 55e67fc | 2006-03-23 15:23:53 +0000 | [diff] [blame] | 9 | |
Martin Arver | e78cb65 | 2008-07-15 18:33:43 +0000 | [diff] [blame] | 10 | \input{appendix/menu_structure.tex} |
| 11 | |
Dominik Riebeling | 536c6b4 | 2006-08-14 07:13:01 +0000 | [diff] [blame] | 12 | \chapter{User feedback}\label{sec:feedback} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 13 | \section{Bug reports} |
| 14 | If you experience inappropriate performance from any supported feature, |
| 15 | please file a bug report on our web page. Do not report missing |
Marc Guay | 6e4aab0 | 2008-07-12 22:46:53 +0000 | [diff] [blame] | 16 | features as bugs, instead file them as feature ideas (see below). |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 17 | |
| 18 | For open bug reports refer to |
Dominik Riebeling | 8258c5f | 2006-04-09 12:25:45 +0000 | [diff] [blame] | 19 | \url{http://www.rockbox.org/tracker/index.php?type=2} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 20 | |
Martin Arver | 784e0e1 | 2006-03-13 13:29:27 +0000 | [diff] [blame] | 21 | \subsection{Rules for submitting new bug reports} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 22 | |
| 23 | \begin{enumerate} |
Thom Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 24 | \item Check that the bug has not already been reported |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 25 | \item Always include the following information in your bug report: |
Martin Arver | 784e0e1 | 2006-03-13 13:29:27 +0000 | [diff] [blame] | 26 | |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 27 | \begin{itemize} |
Martin Arver | 7bdd03a | 2006-08-27 15:00:50 +0000 | [diff] [blame] | 28 | \item Which exact \dap{} you have. |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 29 | \item Which exact Rockbox version you are using |
Nils Wallménius | 22942db | 2010-05-17 08:12:07 +0000 | [diff] [blame] | 30 | (Menu $\rightarrow$ System $\rightarrow$ Rockbox Info $\rightarrow$ Version) |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 31 | \item A step{}-by{}-step description of what you did and what happened |
Martin Arver | 784e0e1 | 2006-03-13 13:29:27 +0000 | [diff] [blame] | 32 | \item Whether the problem is repeatable or a one{}-time occurrence |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 33 | \item All relevant data regarding the problem, such as playlists, MP3 |
Nils Wallménius | 22942db | 2010-05-17 08:12:07 +0000 | [diff] [blame] | 34 | files etc. (IMPORTANT!) |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 35 | \end{itemize} |
Frank Gevaerts | 9050cdd | 2010-01-20 18:33:44 +0000 | [diff] [blame] | 36 | \end{enumerate} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 37 | |
Marc Guay | 6e4aab0 | 2008-07-12 22:46:53 +0000 | [diff] [blame] | 38 | \section{Feature ideas} |
| 39 | To 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 |
| 41 | mind 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 Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 43 | |
Marc Guay | 6e4aab0 | 2008-07-12 22:46:53 +0000 | [diff] [blame] | 44 | \subsection{Rules for submitting a new feature idea} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 45 | |
| 46 | \begin{enumerate} |
Marc Guay | 8df0a92 | 2008-07-12 23:05:38 +0000 | [diff] [blame] | 47 | \item Check that the feature has not already been suggested. |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 48 | Duplicates are really boring! |
Thom Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 49 | \item Check that the feature has not already been implemented. |
Martin Arver | 0684827 | 2007-01-29 18:47:53 +0000 | [diff] [blame] | 50 | Download the latest current/daily build and/or search the mail list archive. |
Martin Arver | 26c6e7b | 2006-08-01 11:57:38 +0000 | [diff] [blame] | 51 | \item Check that the feature is possible to implement (see \reference{ref:NODO}). |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 52 | \end{enumerate} |
| 53 | |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 54 | \subsection{\label{ref:NODO}Features we will not implement} |
| 55 | This is a list of Feature Requests we get repeatedly that we simply |
| 56 | cannot do. View it as the opposite of a TODO! |
| 57 | |
| 58 | \begin{itemize} |
Nils Wallménius | 7d6add5 | 2006-08-19 12:23:47 +0000 | [diff] [blame] | 59 | \opt{archos}{ |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 60 | \item Record to WAV (uncompressed) or MP3pro format.\\ |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 61 | The recording hardware (the MAS) does not allow us to do this |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 62 | \item Crossfade between tracks.\\ |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 63 | Crossfading would require two mp3 decoders, and we only have one. |
| 64 | This is not possible. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 65 | \item Support MP3pro, WMA or other sound format playback.\\ |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 66 | The mp3{}-decoding hardware can only play MP3. We cannot make it play other |
| 67 | sound formats. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 68 | \item Converting OGG $\rightarrow$ MP3.\\ |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 69 | 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 Buschmann | 1248e9c | 2010-04-14 20:38:21 +0000 | [diff] [blame] | 72 | a 12~MHz SH1 is far too slow for this daunting task. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 73 | \item Archos Multimedia support.\\ |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 74 | 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 Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 77 | may do so. We will not. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 78 | \item Multi{}-band (or graphic) equaliser.\\ |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 79 | We cannot access information for that kind of visualisation from the MP3 |
| 80 | decoding hardware. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 81 | \item CBR recording.\\ |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 82 | The MP3 encoding hardware does not allow this. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 83 | \item Change tempo of a song without changing pitch.\\ |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 84 | The MP3 decoding hardware does not allow this. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 85 | \item Graphic frequency (spectrum analyser).\\ |
Thom Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 86 | We cannot access the audio waveform from the MP3 decoder so we cannot analyse |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 87 | it. Even if we had access to it, the CPU would probably be too slow to |
| 88 | perform the analysis anyway. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 89 | \item Cool sound effects.\\ |
Thom Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 90 | Adding new sound effects requires reprogramming the MAS chip, and we cannot |
Dominik Riebeling | 3fbbce3 | 2006-04-01 17:17:15 +0000 | [diff] [blame] | 91 | do that. The MAS chip is programmable, but we have no access to the chip |
| 92 | documentation. |
Martin Arver | 784e0e1 | 2006-03-13 13:29:27 +0000 | [diff] [blame] | 93 | } |
Marianne Arnold | b43b493 | 2011-01-17 18:30:18 +0000 | [diff] [blame] | 94 | \nopt{iriverh300,iaudiox5}{ |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 95 | \item Interfacing with other USB devices (like cameras) or 2 player games over USB.\\ |
Nils Wallménius | 7d6add5 | 2006-08-19 12:23:47 +0000 | [diff] [blame] | 96 | 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 Menes | f747d9d | 2009-02-06 17:13:32 +0000 | [diff] [blame] | 99 | can take place. If that is not enough, we have no way of actually |
Nils Wallménius | 7d6add5 | 2006-08-19 12:23:47 +0000 | [diff] [blame] | 100 | 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 Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 104 | \item Support other file systems than FAT32 (like NTFS or ext2 etc.).\\ |
Nils Wallménius | 7d6add5 | 2006-08-19 12:23:47 +0000 | [diff] [blame] | 105 | 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 Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 111 | you want. Just do not expect Rockbox to understand them. |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 112 | \item Add scandisk{}-like features.\\ |
Nils Wallménius | 7d6add5 | 2006-08-19 12:23:47 +0000 | [diff] [blame] | 113 | 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 Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 116 | \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.\\ |
| 122 | APE 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 Sikken | 9e7898b | 2011-05-22 14:01:28 +0000 | [diff] [blame] | 129 | completely defeating its purpose. Remember, DRM achieves part of its security |
Alex Parker | a8cf643 | 2009-12-17 23:41:01 +0000 | [diff] [blame] | 130 | through obscurity, and publishing the keys necessary to decrypt DRM'd |
| 131 | media would essentially render it useless. |
Nils Wallménius | 7d6add5 | 2006-08-19 12:23:47 +0000 | [diff] [blame] | 132 | \end{itemize} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 133 | |
Martin Arver | 784e0e1 | 2006-03-13 13:29:27 +0000 | [diff] [blame] | 134 | \chapter{Credits} |
Dominik Riebeling | b074b22 | 2006-06-05 10:08:54 +0000 | [diff] [blame] | 135 | People that have contributed to the project, one way or another. Friends! |
| 136 | % |
| 137 | \begin{multicols}{2} |
Dominik Riebeling | cee8f01 | 2008-12-01 21:21:42 +0000 | [diff] [blame] | 138 | \noindent\caps{\small{\input{CREDITS.tex}}} |
Dominik Riebeling | b074b22 | 2006-06-05 10:08:54 +0000 | [diff] [blame] | 139 | \end{multicols} |
Christi Scarborough | d68d7c0 | 2006-02-06 07:25:25 +0000 | [diff] [blame] | 140 | |
Martin Arver | e9163b4 | 2006-12-07 20:47:39 +0000 | [diff] [blame] | 141 | \chapter{Licenses} |
| 142 | |
| 143 | \section{GNU Free Documentation License} |
Martin Arver | 784e0e1 | 2006-03-13 13:29:27 +0000 | [diff] [blame] | 144 | \input{appendix/fdl.tex} |
Martin Arver | e9163b4 | 2006-12-07 20:47:39 +0000 | [diff] [blame] | 145 | \newpage |
| 146 | \section{The GNU General Public License} |
Thom Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 147 | \input{appendix/gpl-2.0.tex} |