The Rockbox Manual for Archos Jukebox 5000, 6000, Studio 10 and 20 rockbox.
Rockbox http://www.rockbox.org/ Open Source Jukebox Firmware Rockbox and this manual is the collaborative effort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2013 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 José Maria Garcia-Valdecasas Bernal & Peter Schlenker. Version rUnversioned. Built using pdfLATEX.
Contents Contents 1. Introduction 9 1.1. Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 1.2. Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 1.3. Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 10 2. Installation 2.1. Before Starting . . . . . . . . . . . . . . . . 2.2. Installing Rockbox . . . . . . . . . . . . . . 2.2.1. Automated Installation . . . . . . . 2.2.2. Manual Installation . . . . . . . . .
Contents 4.2.3. The Database Menu . . . 4.2.4. Using the Database . . . 4.3. While Playing Screen . . . . . . . 4.3.1. WPS Key Controls . . . . 4.3.2. The WPS Context Menu 4.4. Working with Playlists . . . . . . 4.4.1. Playlist terminology . . . 4.4.2. Creating playlists . . . . . 4.4.3. Adding music to playlists 4.4.4. Modifying playlists . . . . 4.4.5. Saving playlists . . . . . . 4.4.6. Loading saved playlists . 4.5. Hotkeys . . . . . . . . . . . . . . 5. The 5.1. 5.2. 5.3. 5.4. 5.5. 5.6. 5.7.
Contents 7.2. Repeat . . . . . . . . . . 7.3. Play Selected First . . . 7.4. Fast-Forward/Rewind . 7.5. Anti-Skip Buffer . . . . 7.6. Fade on Stop/Pause . . 7.7. Party Mode . . . . . . . 7.8. Auto-Change Directory 7.9. Constrain Auto-Change 7.10. Last.fm Log . . . . . . . 7.11. Cuesheet Support . . . . 7.12. Skip Length . . . . . . . 7.13. Prevent Track Skipping 7.14. Rewind on Pause . . . . . . . . . . . . . . . . . 8. General Settings 8.1. Playlist . . . . . . . . . . 8.2. File View . . . . . . . . .
Contents 10.2.2. Cube . . . . . . . . . . . 10.2.3. Logo . . . . . . . . . . . 10.2.4. Mosaique . . . . . . . . 10.2.5. Snow . . . . . . . . . . . 10.3. Viewers . . . . . . . . . . . . . 10.3.1. Shortcuts . . . . . . . . 10.3.2. Search . . . . . . . . . . 10.3.3. Shopper . . . . . . . . . 10.3.4. Sort . . . . . . . . . . . 10.3.5. Text Viewer . . . . . . . 10.3.6. Theme Remove . . . . . 10.3.7. VBRfix . . . . . . . . . 10.4. Applications . . . . . . . . . . . 10.4.1. Battery Benchmark . . 10.4.2.
Contents 11.6. Optimising battery runtime . . . 11.6.1. Display backlight . . . . . 11.6.2. Anti-Skip Buffer . . . . . 11.6.3. Audio format and bitrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 84 84 84 A. File formats 86 A.1. Supported file formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 B. Theme Tags B.1.
Contents G. Licenses 109 G.1. GNU Free Documentation License . . . . . . . . . . . . . . . . . . . . . . 109 G.2. The GNU General Public License . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1. Introduction 9 1. Introduction 1.1. Welcome This is the manual for Rockbox. Rockbox is an open source firmware replacement for a growing number of digital audio players. Rockbox aims to be considerably more functional and efficient than your device’s stock firmware while remaining easy to use and customisable. Rockbox is written by users, for users.
Chapter 1. Introduction 10 main channel for Rockbox is #rockbox on irc://irc.freenode.net. Many helpful developers and users are usually around. Just join and ask your question (don’t ask to ask!) – if someone knows the answer you’ll usually get an answer pretty quickly. More information including IRC logs can be found at http://www.rockbox.org/irc/. We also have a web client so that you can join the Rockbox IRC channel without needing to install additional software onto your computer.
Chapter 2. Installation 2. Installation Installing Rockbox is generally a quick and easy procedure. However before beginning there are a few important things to know. 2.1. Before Starting USB connection. To transfer Rockbox to your player you need to connect it to your computer. For manual installation/uninstallation, or should autodetection fail during automatic installation, you need to know where to access the player.
Chapter 2. Installation Prebuilt binaries for Windows, Linux and Mac OS X are available at the ZRockboxUtility wiki page. When first starting Rockbox Utility run “Autodetect”, found in the configuration dialog (File → Configure). Autodetection can detect most player types. If autodetection fails or is unable to detect the mountpoint, make sure to enter the correct values. The mountpoint indicates the location of the player in your filesystem.
Chapter 2. Installation then you do not need to follow the next section and can skip straight to section 2.2.3 (page 13) Installing the firmware 1. Download your chosen version of Rockbox from the links in the previous section. 2. Connect your player to the computer via USB as described in the manual that came with your player. 3. Take the .zip file that you downloaded and use the “Extract all” command of your unzip program to extract the files onto your player. Note: The entire contents of the .
Chapter 2. Installation 14 2.4. Updating Rockbox Rockbox can be easily updated with Rockbox Utility. You can also update Rockbox manually – download a Rockbox build as detailed above, and unzip the build to the root directory of your player as in the manual installation stage. If your unzip program asks you whether to overwrite files, choose the “Yes to all” option. The new build will be installed over your current build.
Chapter 3. Quick Start 15 3. Quick Start 3.1. Basic Overview 3.1.1. The player’s controls Throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prefixed by “Long”, a long press of approximately one second should be performed on that button. The buttons are described in detail in the following paragraph. Additional information for blind users is available on the Rockbox website at ZBlindFAQ.
Chapter 3. Quick Start 3.1.2. Turning the player on and off To turn on and off your Rockbox enabled player use the following keys: Key Action Long On From the Main Menu, select Shutdown Start Rockbox Shutdown Rockbox On shutdown, Rockbox automatically saves its settings. In the unlikely event of a software failure, hardware poweroff or reset can be performed by holding down Stop until the player shuts off or reboots. 3.1.3.
Chapter 3. Quick Start 17 “While playing screen”, usually abbreviated as “WPS” (see section 4.3 (page 24). The dynamic playlist gets replaced with the contents of the current directory. This way you can easily treat directories as playlists. The created dynamic playlist can be extended or modified while playing. This is also known as “on-the-fly playlist”. To go back to the File Browser stop the playback with the Stop button or return to the file browser while keeping playback running using On.
Chapter 4. Browsing and playing 18 4. Browsing and playing 4.1. File Browser Figure 4.1.: The file browser Rockbox lets you browse your music in either of two ways. The File Browser lets you navigate through the files and directories on your player, entering directories and executing the default action on each file. To help differentiate files, each file format is displayed with an icon.
Chapter 4. Browsing and playing 4.1.1. File Browser Controls Key Action Minus/Plus Go to previous/next item in list. If you are on the first/last entry, the cursor will wrap to the last/first entry. Go to the parent directory. Execute the default action on the selected file or enter a directory. If there is an audio file playing, return to the While Playing Screen (WPS) without stopping playback. Enter the Context Menu. Enter the Main Menu. Activate the Hotkey function (see section 4.5 (page 30)).
Chapter 4. Browsing and playing Rename. This function lets the user modify the name of a file or directory. Cut. Copies the name of the currently selected file or directory to the clipboard and marks it to be ‘cut’. Copy. Copies the name of the currently selected file or directory to the clipboard and marks it to be ‘copied’. Paste. Only visible if a file or directory name is on the clipboard. When selected it will move or copy the clipboard to the current directory. Delete.
Chapter 4. Browsing and playing 4.1.3. Virtual Keyboard Figure 4.3.: The virtual keyboard This is the virtual keyboard that is used when entering text in Rockbox, for example when renaming a file or creating a new directory. The current text line to be entered or edited is always listed on the first line of the display. The second line of the display can contain the character selection bar, as in the screenshot above. Key Action On Minus / Plus Toggle picker- and line edit mode.
Chapter 4. Browsing and playing 22 to music. If you shut down your player, the scan will continue next time you turn it on. After the scan is finished you may be prompted to restart your player before you can use the database. Ignoring Directories During Database Initialization You may have directories on your player whose contents should not be added to the database. Placing a file named database.
Chapter 4. Browsing and playing 4.2.4. Using the Database Once the database has been initialized, you can browse your music by Artist, Album, Genre, Song Name, etc. To use the database, go to the Main Menu and select Database. Note: You may need to increase the value of the Max Entries in File Browser setting (Settings → General Settings → System → Limits) in order to view long lists of tracks in the ID3 database browser. There is no option to turn off database completely.
Chapter 4. Browsing and playing 4.3. While Playing Screen The While Playing Screen (WPS) displays various pieces of information about the currently playing audio file. b Note: • Playlist index/Playlist size: Artist - Title. • Current-time Progress-indicator Left. See section 11.2 (page 76) for details of customising your WPS (While Playing Screen). 4.3.1. WPS Key Controls Key Action Menu + Plus / Menu + Minus Minus Volume up/down.
Chapter 4. Browsing and playing Playlist The Playlist submenu allows you to view, save, search and reshuffle the current playlist. These and other operations are detailed in section 4.4 (page 26). To change settings for the Playlist Viewer press Long Play while viewing the current playlist to bring up the Playlist Viewer Menu. In this menu, you can find the Playlist Viewer Settings. Playlist Viewer Settings Show Icons.
Chapter 4. Browsing and playing Show Track Info Figure 4.4.: The track info viewer This screen is accessible from the WPS screen, and provides a detailed view of all the identity information about the current track. This info is known as meta data and is stored in audio file formats to keep information on artist, album etc. To access this screen, press Long Play to access the WPS Context Menu and select Show Track Info. Use Minus and Plus to move through the information. Open With...
Chapter 4. Browsing and playing 27 Insert. In Rockbox, to Insert an item into a playlist means putting an item into a playlist and leaving it there, even after it is played. As you will see later in this chapter, Rockbox can Insert into a playlist in several places. Queue. In Rockbox, to Queue a song means to put the song into a playlist and then to remove the song from the playlist once it has been played.
Chapter 4. Browsing and playing By using the Main Menu To create a playlist containing all music on your player, you can use the Create Playlist command in the Playlists menu found in the Main Menu. The created playlist will be named root.m3u8 and saved in the root of your player’s disk. 4.4.3. Adding music to playlists Adding music to a dynamic playlist Figure 4.5.: The Playlist Submenu The Playlist Submenu is a submenu in the Context Menu (see section 4.1.
Chapter 4. Browsing and playing Queue Last Shuffled. Queue tracks in a random order at the end of the playlist. Play Next. Replaces all but the current playing track with track(s). Current playing track is queued. The Playlist Submenu can be used to add either single tracks or entire directories to a playlist. If the Playlist Submenu is invoked on a single track, it will put only that track into the playlist.
Chapter 4. Browsing and playing 30 4.4.6. Loading saved playlists Through the File Browser Playlist files, like regular music tracks, can be selected through the File Browser. When loading a playlist from disk it will replace the current dynamic playlist. Through the Playlist catalogue The Playlist catalogue offers a shortcut to all playlists in your player’s specified playlist directory. It can be used like the File Browser. 4.5.
Chapter 5. The Main Menu 5. The Main Menu 5.1. Introducing the Main Menu Figure 5.1.: The main menu The Main Menu is the screen from which all of the Rockbox functions can be accessed. This is the first screen you will see when starting Rockbox. To return to the Main Menu, press the Menu button. All settings are stored on the unit. However, Rockbox does not access the hard disk solely for the purpose of saving settings.
Chapter 5. The Main Menu 5.3. Recent Bookmarks Figure 5.2.: The list bookmarks screen If the Save a list of recently created bookmarks option is enabled then you can view a list of several recent bookmarks here and select one to jump straight to that track. Note: Bookmarking only works when tracks are launched from the file browser, and does not currently work for tracks launched via the database. In addition, they do not currently work with dynamic playlists.
Chapter 5. The Main Menu 5.5. Database Browse by the meta-data in your audio files (see section 4.2 (page 21)). 5.6. Now Playing/Resume Playback Go to the While Playing Screen and resume if music playback is stopped or paused and there is something to resume (see section 4.3 (page 24)). 5.7. Settings The Settings menu allows you to set or adjust many parameters that affect the way your player works. There are many submenus for different parameter areas.
Chapter 5. The Main Menu player back to initial configuration. The details of this menu are covered in section 11.3 (page 79). 5.8. Playlists This menu allows you to work with playlists. Playlists can be created in three ways. Playing a file in a directory causes all the files in it to be placed in a playlist. Playlists can be created manually by either using the Context Menu (see section 4.1.2 (page 19)) or using the Playlist menu.
Chapter 5. The Main Menu Top Time: This item shows the cumulative overall runtime of your player since you last manually reset this item. A manual reset is done through pressing any button, followed by pressing Play. Debug (Keep Out!): This sub menu is intended to be used only by Rockbox developers. It shows hardware, disk, battery status and other technical information. Warning: It is not recommended that users access this menu unless instructed to do so in the course of fixing a problem with Rockbox.
Chapter 5. The Main Menu name: icon: talkclip: Only “type” and “data” are required (except if type is “separator” in which case “data” is also not required).
Chapter 6. Sound Settings 6. Sound Settings Figure 6.1.: The sound settings screen The sound settings menu offers a selection of sound settings you may change to customise your listening experience. 6.1. Volume This setting adjusts the volume of your music. Like most professional audio gear and many consumer audio products, Rockbox uses a decibel scale where 0 dB is a reference that indicates the maximum volume that the player can produce without possible distortion (clipping).
Chapter 6. Sound Settings 6.4. Treble This setting emphasises or suppresses the higher (treble) frequencies in the sound. A value of 0 dB means that treble sounds are unaltered (flat response). The minimum setting is -15 dB and the maximum is 15 dB. 6.5. Balance This setting controls the balance between the left and right channels. The default, 0, means that the left and right outputs are equal in volume.
Chapter 7. Playback Settings 7. Playback Settings The Playback Settings menu allows you to configure settings related to audio playback. 7.1. Shuffle Turning shuffle on will cause Rockbox to randomly re-order the playlist. Thus, to shuffle all of the audio files on the player, you first need to create a playlist containing all of them. For more information on creating playlists refer to section 4.4 (page 26). Options: Yes/No. 7.2.
Chapter 7. Playback Settings 40 7.3. Play Selected First This setting controls what happens when you select a file for playback while shuffle mode is on. If the Play Selected First setting is Yes, the file you selected will be played first. If this setting is No, a random file in the directory will be played first. 7.4. Fast-Forward/Rewind These settings control the speed and acceleration during fast forward and rewind.
Chapter 7. Playback Settings 41 the Random feature requires you to first generate a folder list via the Random Folder Advance Configuration plugin (see section 10.4.8 (page 72)). Note: You must have the Repeat option set to No for Auto-Change Directory to function properly. b Note: This feature only works when songs have been played from the file browser. Using it with the database may cause unexpected behaviour. b 7.9.
Chapter 7. Playback Settings 42 7.12. Skip Length Designed to speed up navigation when listening to long audio tracks, Skip Length changes the behaviour of the Minus and Plus buttons so that they skip by a given time instead of skipping to a new track. The Skip to Outro option changes the behaviour so that the buttons skip to just before the end of the track, so that the last few seconds are played before the next track. 7.13.
Chapter 8. General Settings 8. General Settings Figure 8.1.: The general settings screen 8.1. Playlist The Playlist sub menu allows you to configure settings related to playlists. Recursively Insert Directories. If set to On, then when a directory is inserted or queued into a dynamic playlist, all subdirectories will also be inserted. If set to Ask, Rockbox will prompt the user about whether to include sub-directories. Warn When Erasing Dynamic Playlist.
Chapter 8. General Settings Interpret numbers when sorting. As whole numbers enables a sorting algorithm which is similar to the default sorting of, for example, Windows Explorer, Mac OS X’s Finder or Nautilus, with regards to numbers at the beginning or within filenames. It combines consecutive digits to a number used for sorting, taking leading zeros into account. As digits disables this algorithm, and causes every digit to be compared separately.
Chapter 8. General Settings 45 If Follow Playlist is set to No, when you enter the File Browser from the WPS, you will find yourself in the directory you were in when you last left the File Browser. Show Path. If this setting is set to Full Path the full path to the current directory will be displayed on the first line in the File Browser. If set to Current Directory Only only the name of the current directory will be displayed. This has a similar effect on the Database browser.
Chapter 8. General Settings 46 this menu option again! Scrolling. This feature controls how text will scroll in Rockbox. You can configure the following parameters: Scroll Speed. Sets how many times per second the automatic horizontal scrolling text will move a step. Scroll Start Delay. Controls how many milliseconds Rockbox should wait before a new text begins automatically scrolling. Bidirectional Scroll Limit.
Chapter 8. General Settings Battery Capacity. This setting can be used to tell Rockbox what capacity (in mAh) the battery being used has. The default is 1500 mAh, which is the capacity value for the standard batteries shipped with the player. Rockbox uses this value for runtime estimation, not battery percentage calculation. Changing this setting has no effect whatsoever on actual battery life. This setting only affects the accuracy of the runtime estimation as shown on screen. 8.5.2.
Chapter 8. General Settings • laptop → player→ human • LAN party computer → player→ human 8.5.5. Car Adapter Mode This option turns On and Off the car ignition auto stop function. Car Adapter Mode. When using the player in a car, Car Adapter Mode automatically stops playback on the player when power (i.e. from cigarette lighter power adapter) to the external DC in jack is turned off. If the Car Adapter Mode is set to On, Rockbox will pause playback when the external power off condition is detected.
Chapter 8. General Settings 49 8.6.2. Idle Poweroff Rockbox can be configured to turn off power after the unit has been idle for a defined number of minutes. The player is idle when playback is stopped or paused. It is not idle while the USB or charger is connected . Settings are either Off or 1 to 10 minutes in 1 minute steps. Then 15, 30, 45 or 60 minutes are available. 8.6.3. Sleep Timer The Sleep Timer powers off your player after a given time, whether playing or not.
Chapter 8. General Settings Bookmark on Stop. This option controls whether Rockbox creates a bookmark when playback is stopped manually. No. Do not create bookmarks. Yes. Always create bookmarks. Ask. Ask if a bookmark should be created. Yes – Recent Only. Always create a bookmark, but only in the recent bookmarks list. Ask – Recent Only. Ask if a bookmark should be created, but only add it to the recent bookmarks list.
Chapter 8. General Settings The following keys can be used to navigate in any bookmark list. Key Action Plus Minus Play Stop On + Play Long Play Selects the next bookmark. Selects the previous bookmark. Resumes from the selected bookmark. Exits Recent Bookmark menu Deletes the currently selected bookmark Enters the context menu for the selected bookmark. There are two options in the context menu: • Resume will commence playback of the currently selected bookmark entry.
Chapter 8. General Settings Off. No attempt will be made to speak directory names. You can use pre-generated .talk clips to have directory names spoken properly, but you must enable this explicitly (see below). Use Directory .talk Clips. This option turns on the use of .talk clips for directories. On. Use special pre-recorded files (_dirname.talk) in each directory. These must be generated in advance, and are typically produced synthetically using a text-to-speech engine on a PC. Off.
Chapter 8. General Settings 53 File Browser Hotkey. These options set the hotkey function for their respective screens (see section 4.5 (page 30)). The default for the WPS is View Playlist. The File Browser default is Off.
Chapter 9. Theme Settings 54 9. Theme Settings The Theme Settings menu offers options that you can change to customize the visual appearance of Rockbox. Browse Theme Files. This option will display all the currently installed themes on the player, press Play to load the chosen theme and apply it. A theme is a configuration file, stored in a specific directory, that typically changes the WPS , font used and on some platforms additional information such as background image and text colours.
Chapter 10. Plugins 10. Plugins Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit it to return to the Rockbox interface. Most plugins will not interfere with music playback but some of them will stop playback while running. Plugins have the file extension .rock.
Chapter 10. Plugins Key Action On / Menu / Minus / Plus Play On+Minus Move the cursor On+Plus Solve On+Play Solve step by step Stop Quit the game Flip Shuffle 10.1.3. Jackpot Figure 10.2.: Jackpot This is a jackpot slot machine game. At the beginning of the game you have 20$. Payouts are given when three matching symbols come up. Key Action On Menu Play Exit the game 10.1.4. Rockblox Figure 10.3.
Chapter 10. Plugins Rockblox is a Rockbox version of the classic falling blocks game from Russia. The aim of the game is to make the falling blocks of different shapes form full rows. Whenever a row is completed, it will be cleared away, and you gain points. For every ten lines completed, the game level increases, making the blocks fall faster. If the pile of blocks reaches the ceiling, the game is over.
Chapter 10. Plugins Key Action On Play Menu On+Plus / On+Minus Plus / Minus Display at maximum frame rate Pause Cycle draw mode Select axis to adjust Stop Change speed/angle (speed can not be changed while paused) Quit 10.2.3. Logo Demo showing the Rockbox logo bouncing around the screen. Key Action Plus / Minus Play / Stop Menu or Long Menu Increase / decrease speed on the x-axis Increase / decrease speed on the y-axis Quit 10.2.4. Mosaique Figure 10.5.
Chapter 10. Plugins 10.2.5. Snow Figure 10.6.: Have you ever seen snow falling? This demo replicates snow falling on your screen. If you love winter, you will love this demo. Or maybe not. Press Menu or Long Menu to quit. 10.3. Viewers Viewers are plugins which are associated with specific file extensions. They cannot be run directly but are started by “playing” the associated file. Viewers are stored in the /.rockbox/rocks/viewers/ directory.
Chapter 10. Plugins How to create .link files You can use your favourite text editor to create a .link file on the PC an then copy the file to the player. Or you can use the context menu on either a file or a directory in the file browser tree, and use the “Add to shortcuts” menu option. This will append a line with the full name of the file or the directory to the shortcuts.link file in the root directory of the player. (The file will be created if it does not exist yet.
Chapter 10. Plugins 10.3.4. Sort This plugin takes a file and sorts it in ascending alphabetical order. Case is ignored. This is useful for ordering playlists generated by the Create Playlist menu option (see section 5.8 (page 34)). 10.3.5. Text Viewer Figure 10.7.: Text Viewer This is a Viewer for text files with word wrap. Just open a .txt or .nfo file to display it. The text viewer features controls to handle various styles of text formatting and has top-of-file and bottom-of-file buttons.
Chapter 10. Plugins Encoding Set the codepage in the text viewer. Available settings: ISO-8859-1 (Latin 1). ISO-8859-7 (Greek), CP1251 (Cyrillic), ISO-8859-9 (Turkish), ISO-8859-2 (Latin Extended), CP1250 (Central European), UTF-8 (Unicode), This setting only applies to the plugin and is independent from the Default Codepage setting (see section 8.4 (page 46)). Word Wrap Toggle word wrap mode. On Break lines at the maximum column limit. Off (Chop Words) Break lines at white space or hyphen.
Chapter 10. Plugins Scroll by Line Scroll up or down one line. Auto-scroll Speed Control the speed of auto-scrolling in number of lines per second. Available options are 1 to 10 lines per second. As an example, 4 will scroll the text at four lines per second. Left/Right Key (Narrow mode) Change the function of the “Left” and “Right” buttons when the screen is in narrow mode (i.e. one screen per page). Previous/Next Page Scroll up or down one full screen. Top/Bottom Page Move to the top or bottom page.
Chapter 10. Plugins Figure 10.9.: A bookmark 10.3.6. Theme Remove This plugin offers a way to remove a theme. Open the Context Menu (see section 4.1.2 (page 19)) upon a theme.cfg file and select Open With... → theme_remove. Some files are not removed regardless of the Remove Options such as rockbox_default.wps. Theme Remove menu Remove Theme. Selecting this will delete the files specified in the Remove Options.
Chapter 10. Plugins not work correctly or the time display is incorrect. To use this plugin, open the Context Menu (see section 4.1.2 (page 19)) upon a .mp3 file and select Open With. . . → vbrfix. Note: VBRfix can only run when music is turned off (since it uses the same memory as the player) and can take a while to complete if run on big files. 10.4. Applications 10.4.1. Battery Benchmark The Battery Benchmark plugin enables you to test your battery’s performance whilst using your player normally.
Chapter 10. Plugins Time Left This shows the time remaining until the battery is empty, again as estimated by Rockbox. Voltage The battery voltage in mV at the moment the measurement was taken. C This stands for Charger. An “A” in that column shows if the power adapter was attached to the unit at the time of the measurement. U USB powered. Only for targets that support this. A “U” will indicate if the unit was using the USB port for power at the time of the measurement.
Chapter 10. Plugins • First enter the number of players (1–10) • Then set the total game time in mm:ss • Then the maximum round time is entered. For example, this could be used to play Scrabble for a maximum of 15 minutes each, with each round taking no longer than one minute. • Done. Player 1 starts in paused mode. While playing The number of the current player is displayed on the top line. The time below is the time remaining for that round (and possibly also the total time left if different).
Chapter 10. Plugins Available Options All selects all Linux, OS X, and Windows files. None deselects all file options. Linux selects Linux files. Default files are .dolphinview, .d3lphinview, and .Trash-*/. Windows selects Windows files. Default files are Thumbs.db, $RECYCLE.BIN/, Desktop.ini, Recycled/ and System Volume Information/. Mac selects OS X files. .Trashes/. Default files are ._*, .DS_Store, .Spotlight-V100/ and Other selects additional files added to the configuration file by the user.
Chapter 10. Plugins Key Action Menu or Long Menu Exit to menu 10.4.6. md5sum Open a file, a directory or just launch it from the plugin menu to create an md5sum of the file, the directory’s contents or the whole filesystem. If the file’s extension is .md5 or .md5sum, it will check the md5 sums in the file instead. If the file’s extension is .md5list it will compute md5 sums for all the files listed. 10.4.7. Metronome This plugin can be used as a metronome to keep time during music practice.
Chapter 10. Plugins In contrast to the simple mode, there exists the notion of meter and bars, along with emphasis on certain beats. Parts can have these properties: • finite or infinite duration in bars (navigation only jumps to the beginning of infinite parts), • differing meters (4/4, 3/4, 6/8, etc.
Chapter 10. Plugins The bar count and tempo always have to be specified, the rest is optional. One example is part I: 12 3/4 133 for a part named “part I” , 12 bars long, in 3/4 meter with a tempo of 133 quarter beats per minute. Tempo changes are indicated by specifying a tempo range and the acceleration in one of these ways: 0 4/4 90-150*0.25 0 4/4 150-90/4 16 4/4 100-200 The first one goes from 90 to 150 bpm in an endless part with 0.25 bpm increase per bar.
Chapter 10. Plugins # An example track exercising the programmable Rockbox metronome # or also http://das.nasophon.de/klick/. lead-in: 1 4/4 120 XXXX 0.5 # 4 emphasized but less loud ticks intro: 4 4/4 120 # standard beat tearing down: 4 120-90 # changing tempo from 120 to 90 break: 2 1/4 90 # 2 1/4 bars at 90 rolling: 2 6/8 90 # 2 6/8 at same tempo (quarters!) rumbling: 4 3/4 90 X.
Chapter 10. Plugins Folder List Editor Keys Key Action Play Long Play Delete selected folder Bring up the context menu which allows you to remove the selected folder or its entire folder tree Exit Stop 10.4.9. Resistor Calculator WARNING! Image not found Figure 10.11.
Chapter 10. Plugins 10.4.10. Stats Figure 10.12.: The stats-plugin The stats plugin counts the directories and files (the total number as well as the number of audio, playlist, image and video files) on your player. Press Menu or Long Menu to abort counting and exit the plugin. Press it again to quit after counting has finished. 10.4.11. Stopwatch Figure 10.13.: Stopwatch A simple stopwatch program with support for saving times.
Chapter 11. Advanced Topics 11. Advanced Topics 11.1. Customising the User Interface 11.1.1. Customising The Main Menu It is possible to customise the main menu, i.e. to reorder or to hide some of its items (only the main menu can be customised, submenus can not). To accomplish this, load a .cfg file (as described in section 11.
Chapter 11. Advanced Topics 11.2. Configuring the Theme 11.2.1. Themeing – General Info There are various different aspects of the Rockbox interface that can be themed – the WPS or While Playing Screen, the FMS or FM Screen (if the player has a tuner), and the SBS or Base Skin.
Chapter 11. Advanced Topics Conditional Tags If/else: Syntax: %?xx If the tag specified by “xx” has a value, the text between the “<” and the “|” is displayed (the true part), else the text between the “|” and the “>” is displayed (the false part). The else part is optional, so the “|” does not have to be specified if no else part is desired. The conditionals nest, so the text in the if and else part can contain all % commands, including conditionals.
Chapter 11. Advanced Topics %t Set the subline display time. The ‘%t’ is followed by either integer seconds (%t5), or seconds and tenths of a second within () e.g. (%t(3.5)). Each alternating subline can still be optionally scrolled while it is being displayed, and scrollable formats can be displayed on the same line with non-scrollable formats (such as track elapsed time) as long as they are separated into different sublines.
Chapter 11. Advanced Topics Example %x(a,static_icon.bmp,50,50) %xl(b,rep_off.bmp,16,64) %xl(c,rep_all.bmp,16,64) %xl(d,rep_one.bmp,16,64) %xl(e,rep_shuffle.bmp,16,64) %?mm<%xd(b)|%xd(c)|%xd(d)|%xd(e)> Four images at the same x and y position are preloaded in the example. Which image to display is determined by the %mm tag (the repeat mode).
Chapter 11. Advanced Topics 4. Lines starting with # are ignored. This lets you write comments into your configuration files. Example of a configuration file: Example volume: 70 bass: 11 treble: 12 balance: 0 time format: 12hour volume display: numeric show files: supported wps: /.rockbox/car.wps lang: /.rockbox/afrikaans.lng Note: As you can see from the example, configuration files do not need to contain all of the Rockbox options.
Chapter 11. Advanced Topics 81 Hint: Use the Save .cfg File feature (Main Menu → Manage Settings) to save the current settings, then use a text editor to customize the settings file. See Appendix section C (page 98) for the full reference of available options. Save Sound Settings This option writes a .cfg file to your player’s disk. The configuration file has the .cfg extension and is used to store all of the sound related settings. Save Theme Settings This option writes a .cfg file to your player’s disk.
Chapter 11. Advanced Topics 82 dead box. We take no responsibility of any kind, you do that at your own risk. However, we tried as carefully as possible to bulletproof this code. There are a lot of sanity checks. If any of them fails, it will not program. There’s an ultimate safety net to bring back boxes with even completely garbled flash content: the UART boot mod, which in turn requires the serial mod.
Chapter 11. Advanced Topics 83 Flashing 1. Download the correct package for your player from http://download.rockbox.org/ bootloader/archos/. It is named flash--.zip. The current packages are v3. 2. Unzip the flash package to the root of your player. This will extract two files to the root, firmware_.bin and firmware__norom.bin. The flash plugin will select the correct one for your player. Now safely disconnect USB. 3.
Chapter 11. Advanced Topics 4. Play the file rockbox.ucl, or preferably rombox.ucl, and follow the instructions. The plugin handling this is rockbox_flash, a viewer plugin. 11.5.5. Restoring the Original Flash ROM Contents In case you ever want to restore the original flash contents, you will need the backup file. The procedure is very similar to initial flashing, with the following differences: 1. Check that you do not have any firmware_*.bin files in your player’s root. 2.
Chapter 11. Advanced Topics 85 Please do not re-encode any existing audio files from one lossy format to another based upon the above mentioned. This will reduce the audio quality. If you have the choice, select the best suiting codec when encoding the original source material.
Appendix A. File formats A. File formats A.1. Supported file formats Icon File Type Extension Action when selected Directory Bookmark none .bmark Configuration File .cfg Enter the directory Display all bookmarks for an audio file Load the settings file Chip8 game Cuesheet Font .ch8 .cue .fnt Play the Chip8 game View the cuesheet file Change the user interface font to this one Image Link .jpg .link Language File Playlist .lng .m3u, .m3u8 Rockbox firmware Audio file .mod .mp2, .
Appendix B. Theme Tags B. Theme Tags Themeing is discussed in detail in section section 11.2 (page 76), what follows is a list of the available tags. Note: The “bar-type tags” (such as %pb, %pv, %bl etc.) can be further themed – see section B.21 (page 95). B.1. Status Bar Tag Description %we %wd %wi Display Status Bar Hide Status Bar Display the inbuilt Status Bar in the current viewport These tags override the player setting for the display of the status bar.
Appendix B. Theme Tags 88 B.3. Information from the track tags Tag Description %ia %ic %iA %id %iG %ig %in %it %iC %iv %iy %ik Artist Composer Album Artist Album Name Grouping Genre Name Track Number Track Title Comment ID3 version (1.0, 1.1, 2.2, 2.3, 2.4, or empty if not an ID3 tag) Year Disc Number Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming. These tags, when written with a capital “I” (e.g.
Appendix B. Theme Tags 89 B.5. Information about the file Tag Description %fb %fc File Bitrate (in kbps) File Codec (e.g. “MP3” or “FLAC”). This tag can also be used in a conditional tag: %?fc.
Appendix B. Theme Tags B.6. Playlist/Song Info Tag Description %pb Progress Bar. This will display a one character “cup” that empties as the time progresses. Full-line progress bar & time display Percentage played in song Current time in song Total number of playlist entries Playlist name (without path or extension) Playlist position Remaining time in song “s” if shuffle mode is enabled Total track time Current volume (in dB). Can also be used in a conditional: %?pv
Appendix B. Theme Tags %f, %pt and %s. Example: %Vp(1,%pp - %it,%pp - %fn) – Display the playlist position, then either the track title (from the tags) or the filename. The viewer will display as many tracks as will fit in the viewport. B.8. Runtime Database Tag Description %rp %rr Song playcount Song rating (0-10). This tag can also be used in a conditional tag: %?rr<0|1|2|3|4|5|6|7|8|9|10> Autoscore for the song %ra B.9. Hold Tag Description %mh “h” if the main unit keys are locked B.10.
Appendix B. Theme Tags B.13.
Appendix B. Theme Tags This tag can be used to give custom formatting to list titles. Define a viewport with the font and formatting desired, and then use %?Lt<%Lt> to display the title within the viewport. If %Lt is present anywhere in the .sbs, then the %Vi viewport will not show the title. B.15. Changing Volume Tag Description %mv(t) “v” if the volume is being changed The tag produces the letter “v” while the volume is being changed and some amount of time after that, i.e.
Appendix B. Theme Tags 94 B.17. Alignment and language direction Tag Description %al %aL %ac %ar %aR %ax Align the text left Align the text left, or to the right if RTL language is in use Centre the text Align the text right Align the text right, or to the left if RTL language is in use The next tag should follow the set language direction. When prepended to a viewport declaration, the viewport will be horizontally mirrored if the user language is set to a RTL language.
Appendix B. Theme Tags %?if(%pv, >=, 0) will display “Clipping possible” if the volume is higher than or equal to 0 dB, “Volume OK” if it is lower. %?if(%ia, =, %Ia) – this artist and the next artist are the same. Note: When performing a comparison against a string tag such as %ia, only = and != work, and the comparison is not case sensitive. b B.19. Subline Tags Tag Description %t(time) ; Set the subline display cycle time (%t(5) or %t(3.
Appendix B. Theme Tags Tag Description %XX(x, y, width, height, [options]) Draw the specified tag as a bar x: x co-ordinate at which to start drawing the bar. y: y co-ordinate at which to start drawing the bar (- to make the bar appear on the line of the tag, as if it was a text tag) . width: width of the bar (- for the full viewport width). height: height of the bar (- to set to the font height for horizontal bars and to the viewport height for vertical bars).
Appendix B. Theme Tags B.22. Other Tags Tag Description %ss(start, length, tag [,number] Get a substring from another tag. Use this tag to get a substring from another tag. start – first character to take (0 being the start of the string, negative means from the end of the string) length – length of the substring to return (- for the rest of the string) tag – tag to get number – OPTIONAL. if this is present it will assume the substring is a number so it can be used with conditionals. (i.e %cM).
Appendix C. Config file options C.
Appendix C. Config file options Setting Allowed Values Unit bidir limit scroll paginated hold_lr_for_scroll_in_list contrast backlight timeout 0 to 200 on, off on, off 0 to 63 off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60, 90, 120 off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60, 90, 120 on, off % screen N/A N/A N/A s normal, off, on on, off devise a way to get ranges from config-*.h 3 to 254 devise a way to get ranges from config-*.
Appendix C.
Appendix D. Menu Overview 101 D.
Appendix E. User feedback E. User feedback E.1. Bug reports If you experience inappropriate performance from any supported feature, please file a bug report on our web page. Do not report missing features as bugs, instead file them as feature ideas (see below). For open bug reports refer to http://www.rockbox.org/tracker/index.php?type=2 E.1.1. Rules for submitting new bug reports 1. Check that the bug has not already been reported 2.
Appendix E. User feedback E.2.2. Features we will not implement This is a list of Feature Requests we get repeatedly that we simply cannot do. View it as the opposite of a TODO! • Record to WAV (uncompressed) or MP3pro format. The recording hardware (the MAS) does not allow us to do this • Crossfade between tracks. Crossfading would require two mp3 decoders, and we only have one. This is not possible. • Support MP3pro, WMA or other sound format playback. The mp3-decoding hardware can only play MP3.
Appendix E. User feedback 104 • Interfacing with other USB devices (like cameras) or 2 player games over USB. The USB system demands that there is a master that talks to a slave. The player can only serve as a slave, as most other USB devices such as cameras can. Thus, without a master no communication between the slaves can take place.
Appendix F. Credits F. Credits People that have contributed to the project, one way or another.
Appendix F. Credits Hand · Nick Lanham · Sebastian Henriksen · Martin Scarratt · Karl Kurbjun · Tomasz Malesinski · Andrew Pilley · Matt v.d. Westhuizen · Tim Crist · Jvo Studer · Dan Everton · Imre Herceg · Seven Le Mesle · Craig Bachelor · Nikolaj Christensen · Mikael Magnusson · Dominik Wenger · Henrico Witvliet · Andrew Scott · Miguel A. Arévalo · Aaron F.
Appendix F. Credits · Stepan Moskovchenko · John S. Gwynne · Brian J. Morey · Stijn Hisken · Bertrik Sikken · Karim Boucher · James Espinoza · Franz Rühmland · Jordan Anderson · Maurus Cuelenaere · Chris Allegretta · Alastair S · Martin Crkovský · Ariya Hidayat · Jonas Hurrelmann · Lee Kang Hyuk · Clemens Werther · Robert Menes · Henri Valta · Melba Sitjar · Mehmet Ş.
Appendix F.
Appendix G. Licenses G. Licenses G.1. GNU Free Documentation License Version 1.2, November 2002 Copyright c 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Appendix G. Licenses A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
Appendix G. Licenses ther is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
Appendix G. Licenses distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
Appendix G. Licenses on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section.
Appendix G. Licenses 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
Appendix G. Licenses 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections.
Appendix G. Licenses Copyright c YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no BackCover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”. If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with.
Appendix G. Licenses G.2. The GNU General Public License Version 2, June 1991 Copyright c 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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.
Appendix G. Licenses 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.
Appendix G. Licenses 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.
Appendix G. Licenses 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.
Appendix G. Licenses 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.
Appendix G. Licenses 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.
Appendix G. Licenses ‘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.
