diff options
-rw-r--r-- | docs/API | 276 | ||||
-rw-r--r-- | docs/BATTERY-FAQ | 154 | ||||
-rw-r--r-- | docs/CONTRIBUTING | 61 | ||||
-rw-r--r-- | docs/COPYING | 340 | ||||
-rw-r--r-- | docs/CREDITS | 44 | ||||
-rw-r--r-- | docs/CUSTOM_WPS_FORMAT | 92 | ||||
-rw-r--r-- | docs/FAQ | 353 | ||||
-rw-r--r-- | docs/FILES | 10 | ||||
-rw-r--r-- | docs/README | 47 | ||||
-rw-r--r-- | docs/UISIMULATOR | 91 |
10 files changed, 0 insertions, 1468 deletions
diff --git a/docs/API b/docs/API deleted file mode 100644 index dfa6690260..0000000000 --- a/docs/API +++ /dev/null @@ -1,276 +0,0 @@ -$Id$ - __________ __ ___. - Open \______ \ ____ ____ | | _\_ |__ _______ ___ - Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / - Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < - Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ - \/ \/ \/ \/ \/ - - API summmary - -[ This is still pretty rough and basic. Extend! ] - -LCD - - #include <lcd.h> - - Generic - - Most LCD functions are specific for which output we work with, due to the - huge differences. - - lcd_init() - init the LCD stuff - lcd_clear_display() - clear the whole display - lcd_backlight(on) - set backlight on/off - lcd_puts(x,y,string) write a string at given character position - - Recorder - - All the functions operate on a display buffer. You make the buffer get - shown on screen by calling lcd_update(). - - lcd_update() update the LCD according to the internal buffer. - - - lcd_update_rect(int x, int y, int height, int width) - - Update the given rectangle to the LCD. Give arguments measured in - pixels. Notice that the smallest vertical resolution in updates that the - hardware supports is even 8 pixels. This function will adjust to those. - - lcd_setfont(int font) set default font - lcd_setmargins(int x, int y) set top/left margins - lcd_putsxy(x,y,string,font) put a string at given position, using a - specific font - lcd_bitmap(src,x,y,width,height,clear) put a bitmap at given position - lcd_clearrect(x,y,width,height) clear a rectangle area - lcd_fillrect(x,y,width,height) fill a rectangle area - lcd_drawrect(x,y,width,height) draw a rectangle - lcd_invertrect(x,y,width,height) revert the graphics of the given area - lcd_drawline(x1,y1,x2,y2) draw a line between the coordinates - lcd_drawpixel(x,y) put a pixel on the given coordinate - lcd_clearpixel(x,y) clear the pixel at the given coordinate - lcd_fontsize(font,width,height) return the width and height of the font - - Player - - lcd_define_pattern(which,pattern,lenth) define a custom pattern - -Buttons - - #include <button.h> - - These functions work the same regardless of which keypad you have, but they - return a different set of values. Note that the Recorder keypad has 10 - keys, while the Player keypad only features 6. - - int button_get(bool block) - - Returns a bitmask for which keys were pressed. If 'block' is set TRUE it - won't return until a key is pressed. - -Files - - (These functions are POSIX look-alikes) - - #include <file.h> - - int open(const char *path, int oflag); - - The open() function establishes the connection between a file and a file - descriptor. It creates an open file descrip- tion that refers to a file - and a file descriptor that refers to that open file description. The file - descriptor is used by other I/O functions to refer to that file. - - int read(int fildes, void *buf, size_t nbyte); - - The read() function attempts to read nbyte bytes from the file associated - with the open file descriptor, fildes, into the buffer pointed to by buf. - - int lseek(int fildes, off_t offset, int whence); - - The lseek() function sets the file pointer associated with the open file - descriptor specified by fildes as follows: - - o If whence is SEEK_SET, the pointer is set to offset - bytes. - - o If whence is SEEK_CUR, the pointer is set to its - current location plus offset. - - o If whence is SEEK_END, the pointer is set to the size - of the file plus offset. - - int write(int fildes, const void *buf, size_t nbyte); - - NOT CURRENTLY SUPPORTED. - - write writes up to count bytes to the file referenced by the file - descriptor fd from the buffer starting at buf. - - int close(int fildes); - - The close() function will deallocate the file descriptor indicated by - fildes. To deallocate means to make the file descriptor available for - return by subsequent calls to open(2) or other functions that allocate - file descriptors. - - int rename(const char *old, const char *new); - - NOT CURRENTLY SUPPORTED. - - The rename() function changes the name of a file. The old argument points - to the pathname of the file to be renamed. The new argument points to the - new pathname of the file. - - int remove(const char *pathname); - - NOT CURRENTLY SUPPORTED. - - remove deletes a name from the filesystem. It calls unlink for files, - and rmdir for directories. - - -Directories - - #include <dir.h> - - DIR *opendir(const char *name); - - The opendir() function opens a directory stream corresponding to the - directory name, and returns a pointer to the directory stream. The - stream is positioned at the first entry in the directory. - - struct dirent *readdir(DIR *dir); - - The readdir() function returns a pointer to a dirent structure - representing the next directory entry in the directory stream pointed to - by dir. It returns NULL on reaching the end-of-file or if an error - occurred. - - Add a description of the struct here. - - int closedir(DIR *dir); - - The closedir() function closes the directory stream associated with dir. - The directory stream descriptor dir is not available after this call. - - -String/Memory - - #include <string.h> - - strcmp() - strcpy() - memcpy() - memset() - ... - -Memory allocation - - #include <dmalloc.h> - - void *malloc(size_t size); - - malloc() allocates size bytes and returns a pointer to the allocated - memory. The memory is not cleared. - - void free(void *ptr); - - free() frees the memory space pointed to by ptr, which must have been - returned by a previous call to malloc(), calloc() or realloc(). - Otherwise, or if free(ptr) has already been called before, undefined - behaviour occurs. - - void *realloc(void *ptr, size_t size); - - realloc() changes the size of the memory block pointed to by ptr to size - bytes. The contents will be unchanged to the minimum of the old and new - sizes; newly allocated memory will be uninitialized. If ptr is NULL, the - call is equivalent to malloc(size); if size is equal to zero, the call is - equivalent to free(ptr). Unless ptr is NULL, it must have been returned - by an earlier call to malloc(), calloc() or realloc(). - - void *calloc(size_t nmemb, size_t size); - - calloc() allocates memory for an array of nmemb elements of size bytes - each and returns a pointer to the allocated memory. The memory is set to - zero. - -ID3 - - #include <id3.h> - bool mp3info(mp3entry *entry, char *filename); - - Return FALSE if successful. The given mp3entry is then filled in with - whatever id3 info it could find about the given file. - -Various - - #include <kernel.h> - - void kernel_init(void) - - Inits the kernel and starts the tick interrupt - - void sleep(ticks) - - Sleep a specified number of ticks, we have HZ ticks per second. - - void yield(void) - - Let another thread run. This should be used as soon as you have to "wait" - for something or similar, and also if you do anything that takes "a long - time". This function is the entire foundation that our "cooperative - multitasking" is based on. Use it. - - int set_irq_level(int level) - - Sets the interrupt level (0 = lowest, 15 = highest) and returns the - previous level. - - void queue_init(struct event_queue *q) - - Initialize an event queue. The maximum number of events in a queue is - QUEUE_LENGTH-1. - - void queue_wait(struct event_queue *q, struct event *ev) - - Receive an event in a queue, blocking the thread if the queue is empty. - - void queue_post(struct event_queue *q, int id, void *data) - - Post an event to a queue. - NOTE: Negative event ID's are for system use only!!! - - bool queue_empty(struct event_queue* q) - - Returns true if the queue is empty. - - int queue_broadcast(int id, void *data) - - Posts an event in all queues that has been initiated with queue_init(). - Returns the number of queues that were posted to. - - int tick_add_task(void (*f)(void)) - - Add a task to the tick task queue. The argument is a pointer to a - function that will be called every tick interrupt. - At most MAX_NUM_TICK_TASKS can be active at the same time. - - int tick_remove_task(void (*f)(void)) - - Remove a task from the task queue. - - void mutex_init(struct mutex *m) - - Initialize a mutex. - - void mutex_lock(struct mutex *m) - - Lock a mutex. This will block the thread if the mutex is already locked. - Note that you will geta deadlock if you lock the mutex twice! - -void mutex_unlock(struct mutex *m) - - Unlock a mutex. diff --git a/docs/BATTERY-FAQ b/docs/BATTERY-FAQ deleted file mode 100644 index d1ccb3c6ab..0000000000 --- a/docs/BATTERY-FAQ +++ /dev/null @@ -1,154 +0,0 @@ -Q1: Are my batteries charged all the time when connected to my Player/Recorder? -A1: Player: the charging is all done by hardware and the exact - functionality is hard to determine. It is however not recommended to keep - the charger connected for more than 10-15 hours if you're not using the - unit. - - Recorder: no. The charging algorithm is carefully crafted in to not wear - out the batteries any more than necessary. If you're using your unit - connected to the charger most of the time, use the 'deep discharge' option - to save your batteries somewhat. - -Q2: Will keeping my charger connected a long time damage my batteries? Can I - leave it over night? -A2: The charger logic lets the batteries charge until they are full. After - that, the charger is disabled, but the device will stay powered on and - continue to consume some power from the batteries (the hardware does - not allow running from the charger without charging batteries, or - powering off with the charger connected). After some time, it will - start charging the batteries again to keep them full. This will - wear the batteries a little, but overnight charging is what most - people do. - - As the Battery FAQ at http://www.greenbatteries.com/ puts it: - "A NiMH battery can be charged and discharged hundreds of times, - but whether that means 200 times or 800 times has a lot to do - with how (you use it)". - -Q3: Does Rockbox charge the batteries more/less/worse/better than the Archos - firmware? -A3: Player: Rockbox doesn't affect the charging on Players, it is all done - by hardware logic out of software control. - - Recorder: The current release of 1.2 is much worse than the Archos - charger, it tends to stop charging much too early and leave the batteries - half empty. - - The current development code (CVS daily builds as of 20.8.2002) is much - better than the 1.2 release, but still not perfect. Linus recently - measured 6 hours continuous playtime after a rockbox charge, and much - over 7 hours after an Archos charge. We are working on fine-tuning - the charger logic to get the most out of the batteries, but the - emphasis is on not overcharging them, since that would damage the - batteries. Better be safe than sorry. - -Q4: What kind of batteries are there in my factory default Player/Recorder? -A4: Both ship with 1500 mAh NiMH (Nickel Metal Hybride) batteries. - -Q5: Is it hard to change the batteries? Does it void my warranty? -A5: The archos manual and web site describe how to replace the batteries, - so you're supposed to do it. They recommend using only Archos-supplied - batteries, but my Recorder 20 unit only shipped with one set. Some - units have been shipped with two sets of batteries. Someone actually had - Archos send him new batteries free of charge after they had weared out, - under the warranty. (have asked from support-technique@archos.com, - waiting for an answer to arrive!) - -Q6: How much do replacement batteries cost? Where can I buy them? -A6: http://www.greenbatteries.com sells 1800 mAh NiMH cells at $3.25USD each, - and I bought 4 of the same GP batteries for 20 euros in an home - electronics & household appliance store in Finland. NiMH batteries are - sold in almost all shops that sell consumer electronics, and in many - online shops. Browse around. There's a pretty good comparison between - different battery makes and models at the digital imaging resource site: - http://www.imaging-resource.com/ACCS/BATTS/BATTS.HTM - -Q7: What kind of run-time can I expect on a set of fully-charged batteries - when running Rockbox? -A7: For the stock 1500 mAh cells, from 6 hours to 8 hours, depending on - which charger was used (see Q3). It depends a lot on the condition of - the batteries. We are looking into implementing more battery-saving - techniques in rockbox to make it rock longer. - -Q8: Can I use different batteries in my Archos? -A8: Only use NiMH-type rechargeable batteries. It is considered to be safe - to use NiMH batteries of different capacities though, a lot of people - have purchaced 1700 or 1800 mAh batteries to replace the stock 1500 mAh - cells and have the device run a bit longer. - -Q9: Can I use non-chargeable batteries in my Archos? -A9: This is not recommended. The unit has been designed to operate with - four 1.2V batteries producing about 4.8V at most, and using 1.5V - alkaline/zinc carbon batteries will produce around 6.0V, which will - heat up the unit a lot more and might even damage it. The Archos - manual explicitly tells you not to do so. - Also, if you connect the charger, it may even destroy both the batteries - and the unit. - -Q10: Can I use a different charger? -A10: People have successfully used different chargers with similar - specifications as the stock charger. The charger must have the - same kind of connector with same polarity (center positive/+). - The charger should supply at least 7-8 volts, and if it provides - more than 9V, it probably should be current limited (do not - directly plug it in your 12V car battery or it's charger!). - The universal travel charger sold by Archos is specified at - 12V, 1.2A so that's probably the maximum rating you should use. - - Using lower charging voltage will slow down the charging, and using - higher voltage will cause a higher charging current, more heat, - and too much heat and current can damage the batteries or the unit. - Using a different charger will void your warranty and can be - dangerous to your unit, so we can not recommend it. - - Many people are happy using an external quick charger which - is specified to work with NiMH batteries. - -Q11: Can I buy a replacement charger exactly as the one Archos shipped? -A11: The FAQ on the Archos web site and the top of the charger both read: - - Output: 9VDC 600mA - Center positive (+) polarity - - The universal travel charger sold separately on the Archos web site - is specified for 12VDC, 1200mA output. - - Chargers with similar (or user-adjustable) properties are available - at shops selling consumer electronics. - - -Q12: I often need to stop my player for about 15 minutes or so, and when I do - it runs off it's batteries. I was wondering, which is best: shutting the - player down completely and rebooting it when I want to listen again, or - leaving the unit on? Which way does it draw more power? -A12: In our testing we found the following results: - HDD off, LED off, idle 94 mA - HDD off, LED off, play 97 mA - HDD off, LED on, idle 129 mA - HDD off, LED on, play 131 mA - HDD on, LED on, play 230 mA - HD on, reading, LED off ~ 600 mA - HD spin up before read max 800 mA - - So leaving the unit on and paused consumes ~100mA, and thus much less - than needing to reboot the unit. Your mileage may vary. - -Q13: When I plug in the charger when the Recorder is turned off, it turns - itself on and starts charging in the Archos software? What's up? -A13: There is a switch in the DC IN jack of the Jukebox - when a charger (or - whatever) is plugged in, the unit is powered on, even if the charger - is not plugged in a mains outlet. - - If the charger is providing power at this point, the Archos firmware - located on the FLASH ROM does not load a new firmware version (like - Rockbox) from the disk, but goes into charging mode instead. You can - use this feature to get to the Archos charger if you want to. - -Q14: When I plug the charger in my Recorder, it doesn't immediately start - charging the batteries! -A14: When Rockbox is running on the Recorder (the device has been booted - without the charger) it's power management code runs once per minute - (thus the charge level and charging status is only updated every minute). - If the battery is not full, it will start charging. If the 'deep - discharge' mode is enabled in the settings menu, it will start charging - only when the battery is almost empty. diff --git a/docs/CONTRIBUTING b/docs/CONTRIBUTING deleted file mode 100644 index 51058c8b77..0000000000 --- a/docs/CONTRIBUTING +++ /dev/null @@ -1,61 +0,0 @@ -$Id$ - - __________ __ ___. - Open \______ \ ____ ____ | | _\_ |__ _______ ___ - Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / - Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < - Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ - \/ \/ \/ \/ \/ - Contribution Policies - - -In order for the project to run as smoothly as possible, it's best if all -contributors adhere to a few simple conventions: - -Language --------- -Write all code in C. Sometimes assembly is faster, but C is always more -readable and maintainable. - -Language features ------------------ -Write normal C code. Don't redefine the language. No new types (structs are -structs, not typedefs), no C++isms or Javaisms. Also, avoid using "const". - -Names ------ -Variables and function names should be all lower case. -Preprocessor symbols should be all uppercase. - -Style ------ -When changing code, follow the code style of the file you are editing. - -When writing new files, you may use the brace placement style of your choice. - -Always indent your code with four spaces. Don't use TAB characters, as that -will mess up code display in CVS, printing, and a zillion other places. - -Keep lines below 80 columns length. Use whitespace and newlines to make the -code easy to browse/read. - -Text format ------------ -Use "unix style" line feeds: "LF" only. Do not use "CR+LF". - -Patches -------- -Create a patch using 'cvs diff -ub'. -Trim your patches so they only contain relevant changes. -Submit all patches to the mailing list. -Put [PATCH] first on the subject line of your mail. -If the patch is very large (>50k), gzip it before you send it. - - - - - - - - - diff --git a/docs/COPYING b/docs/COPYING deleted file mode 100644 index d60c31a97a..0000000000 --- a/docs/COPYING +++ /dev/null @@ -1,340 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - <signature of Ty Coon>, 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. diff --git a/docs/CREDITS b/docs/CREDITS deleted file mode 100644 index fe4f10afb5..0000000000 --- a/docs/CREDITS +++ /dev/null @@ -1,44 +0,0 @@ - __________ __ ___. - Open \______ \ ____ ____ | | _\_ |__ _______ ___ - Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / - Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < - Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ - \/ \/ \/ \/ \/ - Credits Listing - -People that have contributed to the project, one way or another. Friends! - -Björn Stenberg Originator, project manager, code -Linus Nielsen Feltzing Electronics, code -Andy Choi Checksums -Andrew Jamieson Schematics, electronics -Paul Suade Serial port setup -Joachim Schiffer Schematics, electronics -Daniel Stenberg Code -Alan Korr Code -Gary Czvitkovicz Code -Stuart Martin Code -Felix Arends Code -Ulf Ralberg Thread embryo -David Härdeman Initial ID3 code -Thomas Saeys Logo -Grant Wier Code -Julien Labruyére Donated Archos Player -Nicolas Sauzede Display research -Robert Hak Code, documentation, sarcasm -Dave Chapman Code -Stefan Meyer Code -Eric Linenberg Code -Tom Cvitan Web design -Magnus Öman Font -Jerome Kuptz Code -Julien Boissinot Code, Sound research -Nuutti Kotivuori Code -Heikki Hannikainen Code -Hardeep Sidhu Code -Markus Braun Code -Justin Heiner Code -Magnus Holmgren Code -Bill Napier Build fixes -George Styles Code -Mats Lidell Code
\ No newline at end of file diff --git a/docs/CUSTOM_WPS_FORMAT b/docs/CUSTOM_WPS_FORMAT deleted file mode 100644 index 916c9887b1..0000000000 --- a/docs/CUSTOM_WPS_FORMAT +++ /dev/null @@ -1,92 +0,0 @@ -Custom WPS Display -wps.config File Format Specifications - - -Description / General Info --------------------------- -* The Custom WPS Display is used on the Rockbox Player ONLY, as a means - to customize the WPS to the user's likings. -* Plans to implement this feature into the recorder are in progress. -* The first line of the 2 line display is the customized line (scrolling). -* The second line is always the time display. (Elapsed & Total Time). -* The second line is not able to be customized. -* Any CR's, LF's, or CR/LF's (Commonly known as Newline/Return/Enter) in - the wps.config file will be treated as spaces. IE: Don't use them. -* After editing the wps.config file, you may need to reboot your Rockbox. -* All tags except for %%, %?, and %: contain 3 characters (%xx). Remember - to type the tags correctly, or you will get unexpected output, or even - possibly no output at all. -* All characters not preceded by % are displayed as typed. - - -File Location -------------- -The configuration file must be located in the root folder of the -device and must be named wps.config (lowercase) - - -Tags ----- -ID3 Info Tags: - %it : ID3 Title - %ia : ID3 Artist - %in : ID3 Track Number - %id : ID3 Album -File Info Tags: - %fc : Conditional Title/Filename - Displays "Artist - Title" *or* - Displays Filename if no ID3 Artist/Title - %fd : Conditional Title/Filename - Displays "Title - Artist" *or* - Displays Filename if no ID3 Artist/Title - %fb : File Bitrate - %ff : File Frequency - %fp : File Path - %fn : File Name - %fs : File Size (In Kilobytes) -Playlist/Song Info Tags: - %pp : Playlist Position - %pe : Playlist Total Entries - %pc : Current Time In Song - %pt : Total Track Time -Other Tags: - %% : Displays a % -Conditional ID3/File Tags (If/Else block): - The following two tags are completely optional, and meant only for those - that wish to go crazy with customization. It lets you specify what to - do when it finds an ID3 tag, and also when it doesn't find one. It can - be placed anywhere within the wps.config file. - The first condition of the If/Else block is what to do when it DOES find - valid ID3 tags. The second condition is what to do when there are no - valid ID3 tags available. - %? : Start/End an If/Else block - %: : Seperator between If and Else - Example: - To display "Title - Artist" if there is ID3 available, or "Filename" - if there is no ID3, the following string would be used: - %?%it - %ia%:%fn%? - Yes, you are not going crazy (although I may be)... This *IS* more - confusing then Perl :-) - - -Example wps.config File (Without If/Else) ------------------------ -%pp/%pe: %fc * %fsKB - - -Example Output --------------- -ID3 Title: None -ID3 Artist: None -Playlist Position: 5 -Playlist Total Entries: 10 -Filename: My Song.mp3 -File Size: 3500 -Elapsed Track Time: 2:23 -Total Track Time: 3:01 -The output of this on the player would be: - --------------------------- -| 5/10: My Song.mp3 * 3500KB| -| 2:23/3:01 | - --------------------------- -Of course, the whole first line wouldn't fit, so it scrolls it. diff --git a/docs/FAQ b/docs/FAQ deleted file mode 100644 index e01a991428..0000000000 --- a/docs/FAQ +++ /dev/null @@ -1,353 +0,0 @@ -Q1. What is a FAQ? -A1. A rare small animal of the species 'Textius Electronicus'. It is known for - its helpful attitude and vicious misspellings. - -Q2. Okay, fine, what is _this_ FAQ? -A2. This FAQ is for questions (that we have answers too) that have been asked - repeatedly either in emails or on IRC. - -Q3. What is Rockbox? What is it's purpose? -A3. The purpose of this project is to write an Open Source replacement - firmware for the Archos Jukebox 6000, Studio 20 and Recorder MP3 players. - -Q4. I want to write code for my Archos, how do I proceed? -A4. First make sure to read the file CONTRIBUTING in the docs directory - on Sourceforge. See http://rockbox.haxx.se/docs/contributing.html - if you do not want to have to wade through the CVS directories. - -Q5: What is CVS? -A5: Concurrent Versions System (http://www.cvshome.org). We have a small - help page about how to use this to get, update and commit files on the web - at http://rockbox.haxx.se/cvs.html - -Q6. What exactly is the CONTRIBUTING file? -A6. Just like the name implies, it lists conventions that the project follows, - and in turn asks you to follow, for the formating of source code in - general. - -Q7. Okay, so I read CONTRIBUTING and although I don't agree with all your - conventions, I am going to be sensible and follow them anyway. Now what? -A7. Start by reading up on the information about the jukeboxes on our web page. - Then go into CVS and look at the code we've written. Then take what you - need and start writing. - -Q8. Okay, so how do I submit a patch? -A8. Run: "diff -ub oldfile newfile > patchfile" against the file(s) you have - changed. Then mail the output to the rockbox mailing list and - we will take it under consideration. Please remember that all - submissions are not automatically accepted. This is nothing personal. - - Preferrably, run the diff against the current cvs code: - cvs diff -ub > patchfile - -Q9. I want to join the development team, but don't have a SourceForge account, - what should I do? -A9. You don't need a SourceForge account to help developing Rockbox. Just - submit patches to the mailing list as per the instructions above. - - If your patches are consistently well-written and thus accepted, you may - ultimately be offered CVS commit access. If that should happen, you will - need to get a Sourceforge account: - http://sourceforge.net/account/register.php - -Q10. Do you have a mailing list? -A10. Sure do! As a matter of fact, we have several of them for specific - things. Please check out: http://rockbox.haxx.se/mail/ - -Q11. Great you have a mailing list! Is there anyway for me to catch up on - past posts? -A11. Check out the archives at: http://rockbox.haxx.se/mail/ - -Q12. How can I meet the developers working on the project? -A12. One way is by visiting us on IRC. Head on over to the server - irc.openprojects.net, and then join "#rockbox". There is usually at - least one person there. If you don't see any activity, feel free to post - questions anyway, serveral of us log the channel and will get you answers - when we unidle. - -Q13: Wow, you guys talk on IRC alot? I wish I had been around for those - conversations to see what happened. -A13: We are glad you mentioned that! http://rockbox.haxx.se/irc happens - to have a list of various logs we have recorded of events in the channel. - Feel free to read up, and ask questions on what you find. - -Q14. What is this "SourceForge" you keep mentioning? -A14. http://www.sourceforge.net - -Q15. Can the changes or the software that Rockbox suggests or offers - possibly damage my Archos Player? -A15. All firmware mods that are presented are still highly experimental. - Try them at your own risk. We offer no guarantee that this software, or - the hardware modifications we show, will not damage your player or void - your warranty. That said, we have not been able to damage any of our - units by modifying only the firmware. You can accidentally password - protect your harddisk, but there are ways around that. (See below.) - -Q16. I want to see what the inside of my player looks like, but I would really - like to avoid voiding my warranty. Is there anything you can suggest? -A16. We have a collection of photos of both the player and recorder. Look at - http://rockbox.haxx.se/internals/ - -Q17. What exactly are you trying to achieve with this line of development? - (A.K.A. whats your purpose for being here?) -A17. Firstly, we wouldn't start something like this if we didn't simply enjoy - it profusely. This is great fun! - Secondly, we feel the firmware is lacking some features and contain a - number of annoying bugs that we want to fix. - Some ideas would include (in no particular order): - - No pause between songs - - Mid-song resume - - Mid-playlist resume - - No-scan playlists - - Unlimited playlist size - - Autobuild playlists (ie: "all songs in this directory tree") - - Auto-continue play in the next directory - - Current folder and all sub-folder random play - - Full disk random play - - REAL random - - Multi song queue - - Faster scroll speed - - More cool features with the wire remote control (including - controlling your Archos from your car radio (req hw mod)) - - Support playing of other files types (ie: Ogg Vorbis support) - - Support for megabass switch (req hw mod) - - Player control via USB - - Memory expansion? - Note: Just because something is on this list, does not mean that it is - technically feasible. (But hey we can dream) And something not - being on the list does not mean it isn't a neat idea. Bring it to - the list. - -Q18. I don't see you mentioning other file types on your list of ideas. What - about supporting those? -A18. Pessimist's Answer: At the current time we belive this is not very likely - The Micronas chip (MAS3507) decoder in the archos does not natively - support decoding and there is very little program space in the player to - implement it ourselves. The alternative would be to write a software - decoder as part of the RockBox firmware. However, as much as we love - our players, the computing power of the Archos (SH1 microcontroller) is - not fully sufficent for this need. - - Optimist's Answer: We can play any format if only we can write code for - the DSP to decode it. The MAS 3507 (and 3587) are generic DSPs that - simply have MP3 codecs in ROM. We can download new codecs in them and - we will be the first to celebrate if we can get OGG or FLAC or anything - into these DSPs. Unfortunately, we have no docs or tools for writing new - MAS DSP code and Intermetall is very secretive about it. If anyone can - help, please get in touch! - -Q19. What about supporting playing of WMA files? -A19. Dear Mr. Gates, you have two options. Re-read question #18, or go buy - your own project. - -Q20. What is the most recent version of Rockbox? -A20. We recently released version 1.2, so head on over to - http://rockbox.haxx.se/download/ and pull it down. - Make sure to read the release notes. - (http://rockbox.haxx.se/download/rockbox-1.2-notes.txt). - -Q21. What do you plan to add to coming versions? -A21. We have a rough idea of which features we plan/expect/hope to be included - in which versions. Once again, remember that none of this is written in - stone (noticing a pattern yet?) - - Version 1.3 - Resume, persistent settings, proportional fonts, UI improvements, - Improved charging - - Version 1.4 - Autobuild playlists, Recording, Loadable fonts, Customizable WPS - - Version 1.5 - File/directory management - -Q22. I tried one of your firmware files and now I can't access my harddisk! - When I turn on my jukebox, it says: - Part. Error - Pls Chck HD -A22. Your harddisk has been password protected. We're not 100% sure why it - happens, but you can unlock it yourself. Look at: - http://rockbox.haxx.se/lock.html - -Q23: This FAQ doesn't answer the question I have. What should I do? -A23: You have a couple options here. You could forget the question, find an - easier question, or accept '42' as the answer no matter what. We don't - really recommend any of these (though I do opt for '42' often myself). - What we do recommend is stopping by IRC, reading - http://rockbox.haxx.se to see if the question was answered else - where and just not included here, or ultimatly dropping an email to the - mailing list (rockbox@cool.haxx.se) or the FAQ maintainer listed on the - project homepage. - -Q24: Are there other ways to contact the developers? -A24: Yes. - -Q25: Are you going to tell us what they are? -A25: No. Post to the mailing list and we will get back to you. - -Q26: But I _really_ want to talk with you in person. -A26: I'm sorry. My girlfriend/boyfriend/pet says I'm not allowed to, and the - doctors here won't let me have pens or pencils. They say its some rule - about us not having sharp objects. I'm sorry. Now please stop calling me - here. - -Q27: Will you ever port Quake II to the Archos? -A27: If you ask that again, I'm sending your address and phone number to the - guy that mailed us with question #24. - -Q28: Umm, was that sarcasm? -A28: That's it, I'm mailing him now. - -Q29: Is this legal? I mean, I'd just hate to see something like that - challenged under the DMCA in all its ridiculousness. Any thoughts or - ideas? -A29: We believe we are in the green on this. We are not violating anyone's - copyright and we are not circumventing any copy protection scheme. - This has been a big point for the project since its inception. Some - people wanted us to distribute patched versions of the original firmware, - but seeing as that _would_ have violated Archos' copyright, we didn't - follow that course of action. - -Q30: On the website [and various information postings] you state - "Every tiny bit was reverse engineered, disassembled and then - re-written from scratch". - If it was rewritten from scratch then why was it first reverse-engineered - and disassembled? Instead this sounds more like someone disassembled it - then used the understanding that they gained to create a new version, - which is not quite the same as "from scratch". -A30: Don't confuse the terms. Reverse engineering means examining a product - to find out how it works. Disassembling the firmware is merely one tool - used in that examination. Oscilloscopes and logic analyzers are other - tools we have used. We have written every single byte of the Rockbox - firmware. But we could not have written the software without first - researching how the hardware was put together, i.e. reverse engineer it. - All of this is completely legal. If you define "from scratch" as writing - software without first researching the surrounding interfaces, then no - software has ever been written from scratch. - -Q31: Wait a minute here. When you released version 1.0 you did not have a - single one of the ideas you have mentioned on your website actually - implimented! Calling this version 1.0 is really misleading. Whats the - story?! -A31: In simple terms, the first release was called 1.0 because it had a basic - working feature set that worked and had no known bugs. That is what 1.0 - meant. It is true that Rockbox 1.0 lacked most of the feature set that - every sane user wanted. However, we never said it was more - feature-complete or better in any way then the original firmware that - early in the project. The first release was done as a proof of concept - that our ideas are moving in the right direction. We also hoped that it - would help bring the project some attention, and some additional - developers. Adding the missing features was just a matter of time. In - more recent releases we have completed many of our desired goals, and - several new ones that were implimented to fullfill user requests. - -Q32: I've heard talk of a 'Rolo'. What is that? (Or 'All you ever wanted - to know about Rockbox boot loaders') -A32: The developers have discussed the possibility of a boot loader. (Mainly - because having one sounds cool, and isn't Rolo just a great name?) - The idea would be that a user could use the load to choose between - different verions of Rockbox or the Archo firmware itself. We have a - working version of ROLO implimented for the players, and a version in - development for the recorders. However, at this time, the patch for ROLO - is not optimal for use and is not part of the main branch of the CVS. - Once this improves and has been tested sufficently, it will become part of - the main release. Please check the mailing list logs and irc logs for - more information. - -Q33: I was thinking about making the USB a bit more usable. What are the - chances of using the USB port to [play games / share files / list - the device as something other then a hard drive / sell my soul to you - for a nickel]. What do you think? -A33: You really don't want to know what I think, it involves road flares, - microwave ovens and shaved cats. Enough said. But regarding the USB - portion of your question, this is not feasible. First, any ideas - regarding special communications over the USB port will not work because - we have no control over the USB port itself. We are capable of - dectecting if it is in use (so we know which mode to switch to) but that - is it. Second, if you would like to have your Archos as a harddrive for - another device, know that this will not work either. The Archos unit is - a slave. Most other USB devices are slaves as well. So without some - master involved there can be no communication. Sorry. Now about your - soul. Would you settle for 3 cents and a small wad of belly button lint? - -Q34: When I use RockBox my jukebox's red "error" light turns on a lot, but this - doesn't happen on the factory firmware. Why? -A34: Rockbox uses the red LED as harddisk activity light, not as an error - light. Relax and enjoy the music. - -Q35: How do I use the loadable fonts? -A35: Loadable fonts are a work in progress. We do not have full documentation - for it. The best we can do now is tell you that you need a valid .bdf - font, and to use the tool "bdf2ajf" from CVS to conver to the .ajf format. - The final .ajf font must be stored in the archos root as 'system.ajf' - We do expect more documentation on this process shortly. - -Q36: I have a question about the batteries... -A36: STOP! We have put together a completely different FAQ for battery - related questions. - Check out: http://rockbox.haxx.se/docs/battery-faq.html - -Q37: What is the WPS? -A37: That is the 'While Playing Screen'. Basically this is what is shown on - your player's display while we are playing your song. - -Q38: What good is the WPS? How usable/flexible is it? -A38: It is very good if you want information about the current item playing ;) - Currently the WPS on the Player is very flexible. By using the file - 'wps.config' you can manage exactly how/what you want data displayed on - your Archos Player. Currently this feature has not yet been added to the - Recorder version of Rockbox. Please see - http://rockbox.haxx.se/docs/custom_wps_format.html for more information. - -Q39: Can the Player LCD font be modified? -A39: The simple answer is no. This is because the Player font is character - cell based (as opposed to the Recorder's bitmap based display). This - means that we are able to choose what characters to display, but not how - to display them. We do have the ability to change/create up to 4 chars - on one model and 8 on another, however we are currently using several of - these 'letters' to store icons for the player. - -Q40: Why don't you have any games available for the Players? -A40: The display on the Players is character cell and not bitmap based. - This means we can only control what characters get displayed, not - what pixels are shown. This makes the prospect of game play very - slim (at least for anything involving graphics). - -Q41: When recording is finally implimented in Rockbox, will it be possible to - use custom codecs (like LAME) or is there a built in codec in the Archos? -A41: The MP3 encoder is in the MAS3587F chip, and nothing we can change. - -Q42: What are the max/min bitrates for recording on the Recorder's encoder? -A42: The builtin encoder is variable bit rate only with a max of 192kbit/s, - and a min of 32kbit/s. - -Q43: I have a question about the id3v1 and id3v2 tags... -A43: Stop! Here is all the information about that (if you still have - questions when done, ask then.) - - - Rockbox supports both id3v1 and id3v2 - - - The id3v2 support is limited to the first 300 bytes of the file. Some - ripper programs tend to add very big tags first and then the important - ones Rockbox wants to read end up beyond the first 300 bytes and then - they remain unknown. - - - If you believe that the tags you don't see *are* within 300 bytes, then - please make the mp3 file available for one of the developers to try out. - - - The 300-byte limit is subject to be removed in a future version - -Q44: Would it be possible to record from line in on the player? -A44: No. - -Q45: Where exactly did the name 'Rockbox' come from? -A45: Well you can follow the full line of emails at - http://rockbox.haxx.se/mail/archive/rockbox-archive-2002-01/0062.shtml - However, the brief rundown is that it was recommended first by - Tome Cvitan, and put to a vote (which it lost). - - Funny thing about democracys. This isn't one ;) Our beloved project - vetoed the winning name and chose Rockbox instead. - http://rockbox.haxx.se/mail/archive/rockbox-archive-2002-01/0134.shtml - - There you have it. Recommeded by users, decision by dictator. diff --git a/docs/FILES b/docs/FILES deleted file mode 100644 index fd08ea6ca8..0000000000 --- a/docs/FILES +++ /dev/null @@ -1,10 +0,0 @@ -API -BATTERY-FAQ -CONTRIBUTING -COPYING -CREDITS -CUSTOM_WPS_FORMAT -FAQ -FILES -README -UISIMULATOR diff --git a/docs/README b/docs/README deleted file mode 100644 index 3c53113260..0000000000 --- a/docs/README +++ /dev/null @@ -1,47 +0,0 @@ - __________ __ ___. - Open \______ \ ____ ____ | | _\_ |__ _______ ___ - Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / - Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < - Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ - \/ \/ \/ \/ \/ - -Build your own archos.mod. - -1. Check out 'firmware', 'apps' and 'tools' from CVS (or possibly from a - downloaded archive). You may possibly want 'uisimulator' too (for trying - out things on host before making target tests). If you haven't already - done so, we advise you pull down the 'docs' directory as well. - - If you do want to play with the simulator, read UISIMULATOR. - -2. Build the tools by running 'make' in the tools/ directory. - -3. Create your own build directory, preferably in the same directory as the - firmware/ and apps/ directories. This is where all generated files will be - put. - -4. In your build directory, run the 'tools/configure' script and enter what - target you want to build for and if you want a debug version or not. It'll - prompt you. The debug version is for making a gdb version out of it. It is - only useful if you run gdb towards your target Archos. - -5. Make sure you have sh-elf-gcc and siblings in the PATH. - -6. *ploink*. Now you have got a Makefile generated for you. Run 'make' and - soon the necessary pieces from the firmware and the apps directories have - been compiled and linked. - -7. Copy the archos.mod file to your archos, reboot it and *smile*. - -Whenever the tools/configure script gets updated, you can make your makefile -updated too by running 'tools/configure update' - -If you want to build for more than one target, just create a new build -directory and create a setup for another target combination in there. - -Questions anyone? Take them to the mailing list. We'll be happy to help you -out! - - - - diff --git a/docs/UISIMULATOR b/docs/UISIMULATOR deleted file mode 100644 index ddc8ca6538..0000000000 --- a/docs/UISIMULATOR +++ /dev/null @@ -1,91 +0,0 @@ - __________ __ ___. - Open \______ \ ____ ____ | | _\_ |__ _______ ___ - Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / - Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < - Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ - \/ \/ \/ \/ \/ - - How to build the UISimulators - -Terminology - - The hardware is mainly separated in two different versions. The "Player" is - the Archos Jukebox Player 6000 and Archos Studio 20, while the "Recorder" is - the Archos Recorder 20. The "Player" has a character-based LCD screen with 2 - lines of 11 letters and a big round thing on the keypad (featuring 6 - different keys), while the "Recorder" has a graphical LCD and has all its 10 - keys separate. - -1. Get Sources - - The the very latest sources off the CVS server. Get the 'tools' dir, - 'firmware' dir, the 'apps' dir and the 'uisimulator' dir on the same dir - level, to make it easier to build things (some of the files assume this - hierarchy). - - All CVS details can be found here: http://bjorn.haxx.se/rockbox/cvs.html - -2. Build Uisimulator - - For the X11 simulator: - - (This has been compiled and run on at least Solaris and Linux. It should - work on other unixes too but we haven't tried any other yet.) - - Create a new directory and run the 'tools/configure' script in - there. Select target to simulate and select simulation. The script will - then generate a Makefile for you: - - $ mkdir build-dir - $ cd build-dir - $ ../tools/configure - - [ answer to questions ] - - [ Makefile created, archos subdirectory created ] - - $ make - $ ./rockboxui - - Note that the simulator uses a local subdirectory named 'archos' as "root - directory" for the simulated box. Copy a bunch of mp3 files into that - directory, create subdirectories and do all sorts of things you want to be - able to browse when you fire up the simulator. - - - For the Win32 simulator: - - No info yet. - -3. Run Uisimulator - - To create a simulated disk drive for the simulator to see, create a - subdirectory named 'archos' and populate it with a bunch of test - files/directories. - - Run 'rockboxui'. - -4. Target Keypad Equivalents - - The keyboard's numerical keypad is used to simulate the Archos keypads: - - Keyboard Generic Archos - -------- -------------- - + ON - 8 UP - 2 DOWN - 4 LEFT - 6 RIGHT - - Keyboard Recorder-only - -------- -------------- - Enter OFF - 5 PLAY - / F1 - * F2 - - F3 - - Keyboard Player-only - -------- -------------- - Enter MENU - 6 PLAY (there's no separation between PLAY and RIGHT) |