blob: e686288c2b6c01f9fc0d258ed8ad51486baae4b0 [file] [log] [blame]
Robert Hak019203b2002-08-21 10:36:05 +00001Q1. What is a FAQ?
2A1. A rare small animal of the species 'Textius Electronicus'. It is known for
3 its helpful attitude and vicious misspellings.
4
5Q2. Okay, fine, what is _this_ FAQ?
6A2. This FAQ is for questions (that we have answers too) that have been asked
7 repeatedly either in emails or on IRC.
8
9Q3. What is Rockbox? What is it's purpose?
10A3. The purpose of this project is to write an Open Source replacement
11 firmware for the Archos Jukebox 6000, Studio 20 and Recorder MP3 players.
12
13Q4. I want to write code for my Archos, how do I proceed?
Robert Hakdb96b1f2002-08-21 11:06:32 +000014A4. First make sure to read the file CONTRIBUTING in the docs directory
Robert Hak54099ba2002-08-22 07:02:03 +000015 on Sourceforge. See http://rockbox.haxx.se/docs/contributing.html
Robert Hak019203b2002-08-21 10:36:05 +000016 if you do not want to have to wade through the CVS directories.
17
Robert Hak09499b52002-08-22 07:03:17 +000018Q5: What is CVS?
Robert Hak019203b2002-08-21 10:36:05 +000019A5: Concurrent Versions System (http://www.cvshome.org). We have a small
20 help page about how to use this to get, update and commit files on the web
21 at http://rockbox.haxx.se/cvs.html
22
23Q6. What exactly is the CONTRIBUTING file?
24A6. Just like the name implies, it lists conventions that the project follows,
25 and in turn asks you to follow, for the formating of source code in
26 general.
27
28Q7. Okay, so I read CONTRIBUTING and although I don't agree with all your
29 conventions, I am going to be sensible and follow them anyway. Now what?
30A7. Start by reading up on the information about the jukeboxes on our web page.
31 Then go into CVS and look at the code we've written. Then take what you
32 need and start writing.
33
34Q8. Okay, so how do I submit a patch?
Björn Stenberg10fc53c2002-08-23 20:49:12 +000035A8. Run: "diff -ub oldfile newfile > patchfile" against the file(s) you have
36 changed. Then mail the output to the rockbox mailing list and
37 we will take it under consideration. Please remember that all
38 submissions are not automatically accepted. This is nothing personal.
Robert Hak019203b2002-08-21 10:36:05 +000039
Björn Stenberg10fc53c2002-08-23 20:49:12 +000040 Preferrably, run the diff against the current cvs code:
41 cvs diff -ub > patchfile
Robert Hak019203b2002-08-21 10:36:05 +000042
43Q9. I want to join the development team, but don't have a SourceForge account,
44 what should I do?
Björn Stenberg10fc53c2002-08-23 20:49:12 +000045A9. You don't need a SourceForge account to help developing Rockbox. Just
46 submit patches to the mailing list as per the instructions above.
47
48 If your patches are consistently well-written and thus accepted, you may
49 ultimately be offered CVS commit access. If that should happen, you will
50 need to get a Sourceforge account:
51 http://sourceforge.net/account/register.php
Robert Hak019203b2002-08-21 10:36:05 +000052
53Q10. Do you have a mailing list?
54A10. Sure do! As a matter of fact, we have several of them for specific
Robert Hakf5a9a722002-08-21 17:33:56 +000055 things. Please check out: http://rockbox.haxx.se/mail/
Robert Hak019203b2002-08-21 10:36:05 +000056
57Q11. Great you have a mailing list! Is there anyway for me to catch up on
58 past posts?
Robert Hak16aae472002-08-21 11:22:59 +000059A11. Check out the archives at: http://rockbox.haxx.se/mail/
Robert Hak019203b2002-08-21 10:36:05 +000060
61Q12. How can I meet the developers working on the project?
62A12. One way is by visiting us on IRC. Head on over to the server
63 irc.openprojects.net, and then join "#rockbox". There is usually at
64 least one person there. If you don't see any activity, feel free to post
65 questions anyway, serveral of us log the channel and will get you answers
66 when we unidle.
67
68Q13: Wow, you guys talk on IRC alot? I wish I had been around for those
69 conversations to see what happened.
70A13: We are glad you mentioned that! http://rockbox.haxx.se/irc happens
71 to have a list of various logs we have recorded of events in the channel.
72 Feel free to read up, and ask questions on what you find.
73
74Q14. What is this "SourceForge" you keep mentioning?
75A14. http://www.sourceforge.net
76
77Q15. Can the changes or the software that Rockbox suggests or offers
78 possibly damage my Archos Player?
79A15. All firmware mods that are presented are still highly experimental.
80 Try them at your own risk. We offer no guarantee that this software, or
81 the hardware modifications we show, will not damage your player or void
82 your warranty. That said, we have not been able to damage any of our
83 units by modifying only the firmware. You can accidentally password
84 protect your harddisk, but there are ways around that. (See below.)
85
86Q16. I want to see what the inside of my player looks like, but I would really
87 like to avoid voiding my warranty. Is there anything you can suggest?
88A16. We have a collection of photos of both the player and recorder. Look at
89 http://rockbox.haxx.se/internals/
90
91Q17. What exactly are you trying to achieve with this line of development?
92 (A.K.A. whats your purpose for being here?)
93A17. Firstly, we wouldn't start something like this if we didn't simply enjoy
94 it profusely. This is great fun!
95 Secondly, we feel the firmware is lacking some features and contain a
96 number of annoying bugs that we want to fix.
97 Some ideas would include (in no particular order):
98 - No pause between songs
99 - Mid-song resume
100 - Mid-playlist resume
101 - No-scan playlists
102 - Unlimited playlist size
103 - Autobuild playlists (ie: "all songs in this directory tree")
104 - Auto-continue play in the next directory
105 - Current folder and all sub-folder random play
106 - Full disk random play
107 - REAL random
108 - Multi song queue
109 - Faster scroll speed
110 - More cool features with the wire remote control (including
111 controlling your Archos from your car radio (req hw mod))
112 - Support playing of other files types (ie: Ogg Vorbis support)
113 - Support for megabass switch (req hw mod)
114 - Player control via USB
115 - Memory expansion?
116 Note: Just because something is on this list, does not mean that it is
Robert Hakf5a9a722002-08-21 17:33:56 +0000117 technically feasible. (But hey we can dream) And something not
118 being on the list does not mean it isn't a neat idea. Bring it to
119 the list.
Robert Hak019203b2002-08-21 10:36:05 +0000120
121Q18. I don't see you mentioning other file types on your list of ideas. What
122 about supporting those?
123A18. Pessimist's Answer: At the current time we belive this is not very likely
124 The Micronas chip (MAS3507) decoder in the archos does not natively
125 support decoding and there is very little program space in the player to
126 implement it ourselves. The alternative would be to write a software
127 decoder as part of the RockBox firmware. However, as much as we love
128 our players, the computing power of the Archos (SH1 microcontroller) is
129 not fully sufficent for this need.
130
131 Optimist's Answer: We can play any format if only we can write code for
132 the DSP to decode it. The MAS 3507 (and 3587) are generic DSPs that
133 simply have MP3 codecs in ROM. We can download new codecs in them and
134 we will be the first to celebrate if we can get OGG or FLAC or anything
135 into these DSPs. Unfortunately, we have no docs or tools for writing new
136 MAS DSP code and Intermetall is very secretive about it. If anyone can
137 help, please get in touch!
138
139
140Q19. What about supporting playing of WMA files?
Robert Hak54099ba2002-08-22 07:02:03 +0000141A19. Dear Mr. Gates, you have two options. Re-read question #18, or go buy
Robert Hak019203b2002-08-21 10:36:05 +0000142 your own project.
143
Robert Hak54099ba2002-08-22 07:02:03 +0000144Q20. What is the most recent version of Rockbox?
Robert Hak019203b2002-08-21 10:36:05 +0000145A20. We recently released version 1.2, so head on over to
146 http://rockbox.haxx.se/download.html and pull it down.
147 Make sure to read the release notes.
148 (http://rockbox.haxx.se/download/rockbox-1.2-notes.txt).
149
150Q21. What do you plan to add to coming versions?
151A21. We have a rough idea of which features we plan/expect/hope to be included
152 in which versions. Once again, remember that none of this is written in
153 stone (noticing a pattern yet?)
154
155 Version 1.3
156 Persistent settings for Player, UI improvements
157
158 Version 1.4
159 Recording?
160
161Q22. I tried one of your firmware files and now I can't access my harddisk!
162 When I turn on my jukebox, it says:
163 Part. Error
164 Pls Chck HD
165A22. Your harddisk has been password protected. We're not 100% sure why it
166 happens, but you can unlock it yourself. Look at:
167 http://rockbox.haxx.se/lock.html
168
169Q23: This FAQ doesn't answer the question I have. What should I do?
170A23: You have a couple options here. You could forget the question, find an
171 easier question, or accept '42' as the answer no matter what. We don't
172 really recommend any of these (though I do opt for '42' often myself).
173 What we do recommend is stopping by IRC, reading
174 http://rockbox.haxx.se to see if the question was answered else
175 where and just not included here, or ultimatly dropping an email to the
176 mailing list (rockbox@cool.haxx.se) or the FAQ maintainer listed on the
177 project homepage.
178
179Q24: Are there other ways to contact the developers?
180A24: Yes.
181
182Q25: Are you going to tell us what they are?
183A25: No. Post to the mailing list and we will get back to you.
184
185Q26: But I _really_ want to talk with you in person.
186A26: I'm sorry. My girlfriend/boyfriend/pet says I'm not allowed to, and the
187 doctors here won't let me have pens or pencils. They say its some rule
188 about us not having sharp objects. I'm sorry. Now please stop calling me
189 here.
190
191Q27: Will you ever port Quake II to the Archos?
192A27: If you ask that again, I'm sending your address and phone number to the
Robert Hakf5a9a722002-08-21 17:33:56 +0000193 guy that mailed us with question #24.
Robert Hak019203b2002-08-21 10:36:05 +0000194
195Q28: Umm, was that sarcasm?
196A28: That's it, I'm mailing him now.
197
198Q29: Is this legal? I mean, I'd just hate to see something like that
199 challenged under the DMCA in all its ridiculousness. Any thoughts or
200 ideas?
201A29: We believe we are in the green on this. We are not violating anyone's
202 copyright and we are not circumventing any copy protection scheme.
203 This has been a big point for the project since its inception. Some
204 people wanted us to distribute patched versions of the original firmware,
205 but seeing as that _would_ have violated Archos' copyright, we didn't
206 follow that course of action.
207
208Q30: On the website [and various information postings] you state
209 "Every tiny bit was reverse engineered, disassembled and then
210 re-written from scratch".
211 If it was rewritten from scratch then why was it first reverse-engineered
212 and disassembled? Instead this sounds more like someone disassembled it
213 then used the understanding that they gained to create a new version,
214 which is not quite the same as "from scratch".
215A30: Don't confuse the terms. Reverse engineering means examining a product
216 to find out how it works. Disassembling the firmware is merely one tool
217 used in that examination. Oscilloscopes and logic analyzers are other
218 tools we have used. We have written every single byte of the Rockbox
219 firmware. But we could not have written the software without first
220 researching how the hardware was put together, i.e. reverse engineer it.
221 All of this is completely legal. If you define "from scratch" as writing
222 software without first researching the surrounding interfaces, then no
223 software has ever been written from scratch.
224
225Q31: Wait a minute here. When you released version 1.0 you did not have a
226 single one of the ideas you have mentioned on your website actually
227 implimented! Calling this version 1.0 is really misleading. Whats the
228 story?!
229A31: In simple terms, the first release was called 1.0 because it had a basic
230 working feature set that worked and had no known bugs. That is what 1.0
231 meant. It is true that Rockbox 1.0 lacked most of the feature set that
232 every sane user wanted. However, we never said it was more
233 feature-complete or better in any way then the original firmware that early
234 in the project. The first release was done as a proof of concept that our
235 ideas are moving in the right direction. We also hoped that it would help
236 bring the project some attention, and some additional developers.
237 Adding the missing features was just a matter of time. In more recently
238 releases we have completed many of our desired goals, and several new ones
239 that were implimented to fullfill user requests.
240
241Q32: I've heard talk of a 'Rolo'. What is that? (Or 'All you ever wanted
242 to know about Rockbox boot loaders')
243A32: The developers have discussed the possibility of a boot loader. (Mainly
244 because having one sounds cool, and isn't Rolo just a great name?)
245 The idea would be that a user could use the load to choose between
246 different verions of Rockbox or the Archo firmware itself. We have a
247 working version of ROLO implimented for the players, and a version in
248 development for the recorders. However, at this time, the patch for ROLO
249 is not optimal for use and is not part of the main branch of the CVS.
250 Once this improves and has been tested sufficently, it will become part of
251 the main release. Please check the mailing list logs and irc logs for more
252 information.
253
254Q33: I was thinking about making the USB a bit more usable. What are the
255 chances of using the USB port to [play games / share files / list
256 the device as something other then a hard drive / sell my soul to you
257 for a nickel]. What do you think?
258A33: You really don't want to know what I think, it involves road flares,
259 microwave ovens and shaved cats. Enough said. But regarding the USB
260 portion of your question, this is not feasible. First, any ideas
261 regarding special communications over the USB port will not work because
262 we have no control over the USB port itself. We are capable of
263 dectecting if it is in use (so we know which mode to switch to) but that
264 is it. Second, if you would like to have your Archos as a harddrive for
265 another device, know that this will not work either. The Archos unit is
266 a slave. Most other USB devices are slaves as well. So without some
267 master involved there can be no communication. Sorry. Now about your
268 soul. Would you settle for 3 cents and a small wad of belly button lint?
269
270Q34: When I use RockBox my jukebox's red "error" light turns on a lot, but this
271 doesn't happen on the factory firmware. Why?
272A34: Rockbox uses the red LED as harddisk activity light, not as an error
273 light. Relax and enjoy the music.
274
275Q35: How do I use the loadable fonts?
276A35: Loadable fonts are a work in progress. We do not have full documentation
277 for it. The best we can do now is tell you that you need a valid .bdf
278 font, and to use the tool "bdf2ajf" from CVS to conver to the .ajf format.
279 The final .ajf font must be stored in the archos root as 'system.ajf'
280 We do expect more documentation on this process shortly.
281
282Q36: I have a question about the batteries...
Robert Hake96bc172002-08-21 10:51:38 +0000283A36: STOP! We have put together a completely different FAQ for battery
Robert Hak35c04802002-08-21 11:07:28 +0000284 related questions.
285 Check out: http://rockbox.haxx.se/docs/battery-faq.html
Robert Hak019203b2002-08-21 10:36:05 +0000286
Robert Hakfac78522002-08-22 03:00:12 +0000287Q37: What is the WPS?
288A37: That is the 'While Playing Screen'. Basically this is what is shown on
289 your player's display while we are playing your song.
290
291Q38: What good is the WPS? How usable/flexible is it?
292A38: It is very good if you want information about the current item playing ;)
293 Currently the WPS on the Player is very flexible. By using the file
294 'wps.config' you can manage exactly how/what you want data displayed on
295 your Archos Player. Currently this feature has not yet been added to the
296 Recorder version of Rockbox. Please see
297 http://rockbox.haxx.se/docs/custom_wps_format.html for more information.
298
Robert Hakee609dc2002-08-23 13:59:44 +0000299Q39: Can the Player LCD font be modified?
300A39: The simple answer is no. The more detailed answer is that we have
301 the ability to change/create up to 4 chars on one model and 8 on another.
Björn Stenberg10fc53c2002-08-23 20:49:12 +0000302 We currently use several of this 'letters' to store icons for the player.