The Rockbox Manual for Archos Recorder 6, 10, 15 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 1.1. Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2. Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3. Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 11 11 11 12 2. Installation 2.1. Before Starting . . . . . . . . . . . . . . . . 2.2. Installing Rockbox . . . . . . . . . . . . . . 2.2.1. Automated Installation . . . . . . . 2.2.2. Manual Installation . . . . . . .
Contents 4.3. 4.4. 4.5. 4.6. 4.2.3. The Database Menu . . . 4.2.4. Using the Database . . . While Playing Screen . . . . . . . 4.3.1. WPS Key Controls . . . . 4.3.2. Peak Meter . . . . . . . . 4.3.3. The WPS Context Menu Quick Screens . . . . . . . . . . . Working with Playlists . . . . . . 4.5.1. Playlist terminology . . . 4.5.2. Creating playlists . . . . . 4.5.3. Adding music to playlists 4.5.4. Modifying playlists . . . . 4.5.5. Saving playlists . . . . . . 4.5.6. Loading saved playlists .
Contents 6.6. Channels . . . . . . . . . . . . . 6.7. Stereo Width . . . . . . . . . . . 6.8. Loudness . . . . . . . . . . . . . 6.9. Auto Volume . . . . . . . . . . . 6.10. Super Bass . . . . . . . . . . . . 6.11. MDB – Micronas Dynamic Bass 7. Playback Settings 7.1. Shuffle . . . . . . . . . . 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.
Contents 10.Recording Settings 10.1. Quality . . . . . . . . . . 10.2. Frequency . . . . . . . . . 10.3. Source . . . . . . . . . . . 10.4. Channels . . . . . . . . . 10.5. Independent Frames . . . 10.6. File Split Options . . . . . 10.7. Prerecord Time . . . . . . 10.8. Clear Recording Directory 10.9. Clipping Light . . . . . . 10.10.Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 12.1.29.Xobox . . . . . . . . 12.1.30.XWorld . . . . . . . 12.2. Demos . . . . . . . . . . . . 12.2.1. Bounce . . . . . . . 12.2.2. Credits . . . . . . . 12.2.3. Cube . . . . . . . . . 12.2.4. Demystify . . . . . . 12.2.5. Fire . . . . . . . . . 12.2.6. Fractals . . . . . . . 12.2.7. Logo . . . . . . . . . 12.2.8. Mosaique . . . . . . 12.2.9. Oscilloscope . . . . . 12.2.10.PictureFlow . . . . . 12.2.11.Plasma . . . . . . . 12.2.12.Rocklife . . . . . . . 12.2.13.Snow . . . . . . . . . 12.2.14.
Contents 12.4.13.Periodic Table . . . . . 12.4.14.Random Folder Advance 12.4.15.Resistor Calculator . . . 12.4.16.Stats . . . . . . . . . . . 12.4.17.Stopwatch . . . . . . . . 12.4.18.Text Editor . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents C. Theme Tags C.1. Status Bar . . . . . . . . . . . . . . C.2. Hardware Capabilities . . . . . . . C.3. Information from the track tags . . C.4. Viewports . . . . . . . . . . . . . . C.5. Additional Fonts . . . . . . . . . . C.6. Misc Coloring Tags . . . . . . . . . C.7. Power Related Information . . . . C.8. Information about the file . . . . . C.9. Playlist/Song Info . . . . . . . . . C.10.Playlist Viewer . . . . . . . . . . . C.11.Runtime Database . . . . . . . . . C.12.Hold . . . . . . . . .
Contents H. Licenses 182 H.1. GNU Free Documentation License . . . . . . . . . . . . . . . . . . . . . . 182 H.2. The GNU General Public License . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1. Introduction 11 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 12 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 13 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 • Automatically install all suggested components (“Complete Installation”). • Selectively install optional components. • Install additional fonts and themes. • Install voice files and generate talk clips. • Uninstall all components you installed using Rockbox Utility. 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).
Chapter 2. Installation greatest features at the price of possibly greater instability, or you wish to help with development, you should stick with the release. Please now go to section 2.2.3 (page 15) to complete the installation procedure. 2.2.2. Manual Installation The manual installation method is still available to you, should you need or desire it by following the instructions below.
Chapter 2. Installation 16 2.3. Running Rockbox When you turn the unit on, Rockbox should load. 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 17 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 On the top of the player is the headphone socket on the left and the line-out jack on the right. On the bottom of the player is the line-in jack on the left, the DC-In jack on the right, and the USB connector in the centre. 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 Double tap Off when playback is stopped Start Rockbox Shutdown Rockbox On shutdown, Rockbox automatically saves its settings.
Chapter 3. Quick Start 19 3.1.5. Basic controls When browsing files and moving through menus you usually get a list view presented. The navigation in these lists are usually the same and should be pretty intuitive. In the tree view use Down and Up to move around the selection. Use Right or On to select an item. When browsing the file system selecting an audio file plays it. The view switches to the “While playing screen”, usually abbreviated as “WPS” (see section 4.3 (page 27).
Chapter 3. Quick Start 20 using .cfg files. This topic is discussed in more detail in section 13.3 (page 145). The Rockbox distribution comes with some themes that should look nice on your player. Note: Some of the themes shipped with Rockbox need additional fonts from the fonts package, so make sure you installed them. Also, if you downloaded additional themes from the Internet make sure you have the needed fonts installed as otherwise the theme may not display properly.
Chapter 4. Browsing and playing 21 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 Up/Down Go to previous/next item in list. If you are on the first/last entry, the cursor will wrap to the last/first entry. Move one page up/down in the list. 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. Stop audio playback. Enter the Context Menu. Enter the Main Menu.
Chapter 4. Browsing and playing invoked on a directory, it will display options for directories. The Context Menu contains the following options (unless otherwise noted, each option pertains both to files and directories): Playlist. Enters the Playlist Submenu (see section 4.5.3 (page 35)). Playlist Catalogue. Enters the Playlist Catalogue Submenu (see section 4.5.2 (page 35)). Rename. This function lets the user modify the name of a file or directory. Cut.
Chapter 4. Browsing and playing enabled, the directories returned will be constrained to the directory you have chosen here and those below it. See section 7.9 (page 52) Add to Shortcuts. Adds a link to the selected item in the shortcuts.link file. If the file does not already exist it will be created in the root directory. Note that if you create a shortcut to a file, Rockbox will not open it upon selecting, but simply bring you to its location in the File Browser. 4.1.3. Virtual Keyboard Figure 4.
Chapter 4. Browsing and playing Key Action On + Left / On + Right F3 Move the line cursor within the text line. Left / Right Up / Down F1 Play F2 Off Delete the character before the line cursor. Move the cursor on the virtual keyboard. If you move out of the picker area, you get the previous/next page of characters (if there is more than one). Move the cursor on the virtual keyboard. If you move out of the picker area you get to the line edit mode.
Chapter 4. Browsing and playing 26 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.ignore in a directory will exclude the files in that directory and all its subdirectories from scanning their tags and adding them to the database. This will speed up the database initialization. If a subdirectory of an ‘ignored’ directory should still be scanned, place a file named database.
Chapter 4. Browsing and playing 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. If you do not want to use it just do not do the initial build of the database and do not load it to RAM.
Chapter 4. Browsing and playing • Status bar: The Status bar shows Battery level, charger status, volume, play mode, repeat mode, shuffle mode and clock. In contrast to all other items, the status bar is always at the top of the screen. • (Scrolling) path and filename of the current song. • The ID3 track name. • The ID3 album name. • The ID3 artist name. • Bit rate. VBR files display average bitrate and “(avg)” • Elapsed and total time.
Chapter 4. Browsing and playing 4.3.1. WPS Key Controls Key Action Up / Down Left Volume up/down. Go to beginning of track, or if pressed while in the first seconds of a track, go to the previous track. Rewind in track. Go to the next track. Fast forward in track. Toggle play/pause. Stop playback. Return to the File Browser / Database. Enter WPS Context Menu. Enter Main Menu. Switch to the Quick Screen (see section 5.12 (page 43)). Key lock (software hold switch) on/off.
Chapter 4. Browsing and playing The clip indicator: This is a little black block that is displayed at the very right of the scale when an overflow occurs. It usually does not show up during normal playback unless you play an audio file that is distorted heavily. If you encounter clipping while recording, your recording will sound distorted. You should lower the gain. Note: Note that the clip detection is not very precise. Clipping might occur without being indicated.
Chapter 4. Browsing and playing Sound Settings This is a shortcut to the Sound Settings Menu, where you can configure volume, bass, treble, and other settings affecting the sound of your music. See section 6 (page 46) for more information. Playback Settings This is a shortcut to the Playback Settings Menu, where you can configure shuffle, repeat, party mode, skip length and other settings affecting the playback of your music. Rating The menu entry is only shown if Gather Runtime Information is enabled.
Chapter 4. Browsing and playing Delete Delete the currently playing file. The file will be deleted but the playback of the file will not stop immediately. Instead, the part of the file that has already been buffered (i.e. read into the player’s memory) will be played. This may even be the whole track. Pitch The Pitch Screen allows you to change the rate of playback (i.e. the playback speed and at the same time the pitch) of your player. The rate value can be adjusted between 50% and 200%.
Chapter 4. Browsing and playing Figure 4.6.: The F3 quick screen Rockbox handles function buttons in a different way to the Archos software. F1 is always bound to the menu function, while F2 and F3 enable two quick screens. F2 displays some browse and play settings which are likely to be changed frequently. This settings are Shuffle mode, Repeat mode and the Show files options Shuffle mode plays each track in the currently playing list in a random order rather than in the order shown in the browser.
Chapter 4. Browsing and playing 4.5. Working with Playlists 4.5.1. Playlist terminology Some common terms that are used in Rockbox when referring to playlists: Directory. A playlist! One of the keys to getting the most out of Rockbox is understanding that Rockbox always considers the song that it is playing to be part of a playlist, and in some situations, Rockbox will create a playlist automatically.
Chapter 4. Browsing and playing 35 By using the Playlist catalogue The Playlist catalogue makes it possible to modify and create playlists that are not currently playing. To do this select Playlist catalogue in the Context Menu. There you will have two choices, Add to playlist adds the selected track or directory to an existing playlist and Add to a new playlist creates a new playlist containing the selected track or directory.
Chapter 4. Browsing and playing Insert Last. Add track(s) to end of playlist. Insert Shuffled. Add track(s) to the playlist in a random order. Insert Last Shuffled. Add tracks in a random order to the end of the playlist. Queue. Queue is the same as Insert except queued tracks are deleted immediately from the playlist after they have been played. Also, queued tracks are not saved to the playlist file (see section 5.9 (page 42)). Queue Next. Queue track(s) immediately after current playing track.
Chapter 4. Browsing and playing 37 Moving and removing tracks To move or remove a track from the current playlist enter the Playlist Viewer by selecting View Current Playlist in the Playlist submenu in the WPS context menu or the Main Menu. Once in the Playlist Viewer open the context menu on the track you want to move or remove. If you want to move the track, select Move in the context menu and then move the blinking cursor to the place where you want the track to be moved and confirm with Right or On.
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 F1 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 25)). 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 27)). 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 5.7.6. Manage Settings The Manage Settings option allows the saving and re-loading of user configuration settings, browsing the hard drive for alternate firmwares, and finally resetting your player back to initial configuration. The details of this menu are covered in section 13.3 (page 145). 5.8. Recording 5.8.1. While Recording Screen Figure 5.3.
Chapter 5. The Main Menu Key Action Up / Down Left / Right Play Select setting. Adjust selected setting. Start recording. While recording: pause recording (press again to continue). Exit Recording Screen. While recording: Stop recording. Open Recording Settings (see section 10 (page 68)). Quick menu for recording settings. A quick press will leave the screen up (press F2 again to exit), while holding it will close the screen when you release it. Quick menu for source setting.
Chapter 5. The Main Menu 5.10. Plugins With this option you can load and run various plugins that have been written for Rockbox. There are a wide variety of these supplied with Rockbox, including several games, some impressive demos and a number of utilities. A detailed description of the different plugins is to be found in section 12 (page 73). 5.11. System Rockbox Info: Displays some basic system information.
Chapter 5. The Main Menu you select the same setting at e.g. the top and bottom of the quickscreen, then pressing up and down will cycle through this setting in opposite directions. 5.13. Shortcuts This menu item is a container for user defined shortcuts to files, folders or settings. With a shortcut, • A file can be “run” (i.e. a music file played, plugin started or a .
Chapter 5. The Main Menu setting data is the config name of the setting you want to change (see section D (page 170) for the list of the possible settings) debug data is the name of the debug menu item to display separator data is ignored; name can be used to display text, or left blank to make the list more accessible with visual gaps time data needs to be either “talk” to talk the time, or “sleep X” where X is the number of minutes to run the sleep timer for (0 to disable).
Chapter 6. Sound Settings 46 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 47 from the list and the maximum volume will be limited to the selected value all over the system. 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 -12 dB and the maximum is 12 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 6. Sound Settings 48 of one channel into the other. This has the effect of gradually centering the stereo image, until you have monophonic sound at 0%. Values above 100% will progressively remove components in one channel that is also present in the other. This has the effect of widening the stereo field. A value of 100% will leave the stereo field unaltered. 6.8. Loudness When listening at low volumes, the ear will tend to make bass and treble frequencies sound quieter than they really are.
Chapter 6. Sound Settings The MDB parameters are as follows: MDB enable. This turns the MDB feature on or off. For many users this will be the only setting they need, since Rockbox picks sensible defaults for the other parameters. MDB is turned off by default. MDB strength. How loud the harmonics generated by MDB will be. MDB Harmonics. The percentage of the low notes that is converted into harmonics.
Chapter 7. Playback Settings 50 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.5 (page 34). Options: Yes/No. 7.2.
Chapter 7. Playback Settings 51 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 52 the Random feature requires you to first generate a folder list via the Random Folder Advance Configuration plugin (see section 12.4.14 (page 134)). 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 53 7.12. Skip Length Designed to speed up navigation when listening to long audio tracks, Skip Length changes the behaviour of the Left and Right 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 56 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 this menu option again! LCD Mode. This setting lets you invert the colours of the display. 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. Scroll Step Size.
Chapter 8. General Settings 58 Peak Hold Time. Specifies the time after which the peak indicator will reset. For example, if you set this value to 5 s, the peak indicator displays the loudest volume value that occurred within the last 5 seconds. Larger values are useful if you want to find the peak level of a song, which might be of interest when copying music from the player via the analogue output to some other recording device. Clip Hold Time.
Chapter 8. General Settings 59 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. Disk Options relating to the hard disk. Disk Spindown. Rockbox has a timer that makes it spin down the hard disk after it is idle for a certain amount of time.
Chapter 8. General Settings 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 61 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 , or while recording. 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 62 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 Down Up Right or On Left or Off 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 65 File Browser Hotkey. These options set the hotkey function for their respective screens (see section 4.6 (page 37)). The default for the WPS is View Playlist. The File Browser default is Off.
Chapter 9. Theme Settings 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 Right 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 9. Theme Settings Volume Display. Controls whether the volume is displayed as a graphic or a numeric value on the Status Bar. If you select a numeric display, volume is displayed in decibels. See section 6.1 (page 46) for more on the volume setting. Battery Display. Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar. Line Selector Type. This option allows you to select which type of line selector to use. Pointer.
Chapter 10. Recording Settings 10. Recording Settings Figure 10.1.: The recording settings screen Note: To change the location where recordings are stored open the Context Menu (see section 4.1.2 (page 22)) on the directory where you want to store them in the File Browser and select Set As Recording Directory. 10.1. Quality Choose the quality here (0 to 7). Default is 5, best quality is 7, smallest file size is 0. This setting affects how much your sound sample will be compressed.
Chapter 10. Recording Settings 69 give better sound quality. The frequency setting also determines which version of the MPEG standard the sound is recorded using: MPEG 1 for 48 kHz, 44.1 kHz and 32 kHz. MPEG 2 for 24 kHz, 22.05 kHz and 16 kHz. b Note: You cannot change the sample rate for digital recordings. 10.3. Source Choose the source of the recording. The options are: Digital (SPDIF), Microphone and Line In. 10.4. Channels This allows you to select mono or stereo recording.
Chapter 10. Recording Settings 10.7. Prerecord Time This setting buffers a small amount of audio so that when the record button is pressed, the recording will begin from that number of seconds earlier. This is useful for ensuring that a recording begins before a cue that is being waited for. 10.8. Clear Recording Directory Resets the location where the recorded files are saved to the root of your player’s drive. 10.9. Clipping Light Causes the backlight to flash on when clipping has been detected.
Chapter 10. Recording Settings Start Above. The start threshold defines the minimal volume a sound must have to start the recording. It is displayed numerically in the line “Start Above”. Note that the unit of the threshold depends on the settings of the peak meter. (i.e. When the peak meter displays dB you can adjust the level in dB and when the peak meter is set to linear the threshold is displayed as percentage.
Chapter 11. Time and Date 72 11. Time and Date Time related menu options. Pressing Long Play will voice the current time if voice support is enabled. Set Time/Date: Set current time and date. Time Format: Choose 12 or 24 hour clock.
Chapter 12. Plugins 12. 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 12. Plugins 12.1.2. Blackjack Figure 12.1.: Blackjack Blackjack, a game played in casinos around the world, is now available in the palm of your hand! The rules are simple: try to get as close to 21 without going over or simply beat out the dealer for the best hand. Although this may not seem difficult, blackjack is a game renowned for the strategy involved. This version includes the ability to split, buy insurance, and double down.
Chapter 12. Plugins the paddle. Look out for the bad ones. Special items Displayed Name Description N D L F G B FL Normal Die Life Fire Glue Ball Flip Returns paddle to normal. Ball dies; lose a life. Gain a life. Allows you to shoot bricks with paddle. Ball sticks to paddle each time it hits. Immediately fires another ball. Flip left / right movement. Key Action Left / Right Play / Up Off Moves the paddle Release the ball / Fire Open menu / Quit 12.1.4. Bubbles Figure 12.3.
Chapter 12. Plugins Key Action Up Left / Right Play On or Off Pause game Aim the bubble Fire bubble Exit to menu 12.1.5. Chessbox Figure 12.4.: Chessbox Chessbox is a one-person chess game with computer artificial intelligence. The chess engine is a port of GNU Chess 2 by John Stanback. It also works as a PGN file viewer. Instead of executing the game from the plugin menu, look for any file with .pgn extension in the file browser and execute it.
Chapter 12. Plugins 12.1.6. Chopper Figure 12.5.: Chopper Navigate a cavernous maze without banging into walls, the ceiling, or the floor. How long can you fly your chopper? Key Action Play Off Make chopper fly Enter menu 12.1.7. Dice Dice is a simple dice rolling simulator. Select number and type of dice to roll in a menu and start by choosing “Roll Dice”. The result is shown as individual numbers as well as the total of the rolled dice. Key Action Play On Roll dice again Quit 12.1.8.
Chapter 12. Plugins Flipping the colour of the token under the cursor also flips the tokens above, below, left and right of the cursor. The aim is to end up with a screen containing tokens of only one colour. Key Action Up / Down / Left / Right Play F1 F2 F3 Off Move the cursor Flip Shuffle Solve Solve step by step Quit the game 12.1.9. Goban Figure 12.7.: Goban Goban is a a plugin for playing, viewing and recording games of Go (also known as Weiqi, Baduk, Igo and Goe).
Chapter 12. Plugins you save over it). You have been warned. The file /sgf/gbn_def.sgf is used by the plugin to store any unsaved changes in the most recently loaded game. This means that if you forget to save your changes, you should load /sgf/gbn_def.sgf immediately to offload the changes to another file. If you load another file first then your changes will be lost permanently. The /sgf/gbn_def.sgf file is also the file loaded if another is not selected.
Chapter 12. Plugins Save As. Save to a specified file. Game Info. View and modify the metadata of the current game. Playback Control. Control the playback of the current playlist and modify the volume of your player. Zoom Level. Zoom in or out on the board. If you set the zoom level, it will be saved and used again the next time you open this plugin. Options. Open the Options Menu. Context Menu. Open the Context Menu which allows you to set play modes and other tools. Quit. Leave the plugin.
Chapter 12. Plugins Place. The place that this game took place. Round. If part of a tournament, the round number for this game. Done. Return to the previous menu. Options. Customize the behavior of the plugin in certain ways. Show Child Variations? Enable this to mark child variations on he board if there are more than one. Note: variations which don’t start with a move are not visible in this way.
Chapter 12. Plugins Circle Mode. Add circle marks to the board, or remove them. Square Mode. Add square marks to the board, or remove them. Triangle Mode. Add triangle marks to the board, or remove them. Label Mode. Add one character labels to the board. Each label starts at the letter ‘a’ and each subsequent application of a label will increment the letter. To remove a label, click on it until it cycles through the allowed letters and disappears. Add/Edit Comment.
Chapter 12. Plugins Jewels is a simple yet addicting game which involves swapping pairs of jewels in order to form connected segments of three or more of the same type. The goal of the game is to score as many points as possible before running out of available moves. Higher points are awarded to larger combos. The game advances to the next level after every one hundred points and randomly clears several jewels.
Chapter 12. Plugins 12.1.13. Minesweeper Figure 12.11.: Minesweeper plugin The classic game of minesweeper. The aim of the game is to uncover all of the squares on the board. If a mine is uncovered then the game is over. If a mine is not uncovered, then the number of mines adjacent to the current square is revealed. The aim is to use the information you are given to work out where the mines are and avoid them.
Chapter 12. Plugins Key Action Up, Down, Left, Right On F2 F1 F3 Off to move around to to to to to choose peg restart level go up a level go down a level quit 12.1.15. Pong Figure 12.13.: Pong Pong is a simple one or two player “tennis game”. Whenever a player misses the ball the other scores. The game starts in demo mode, with the CPU controlling both sides.
Chapter 12. Plugins You can choose to play manually (you place both the white and dark pieces) or to play against a (not very smart) robot. 12.1.17. Robotfindskitten Figure 12.14.: Robotfindskitten In this game, you are robot (#). Your job is to find kitten. This task is complicated by the existence of various things which are not kitten. Robot must touch items to determine if they are kitten or not. The game ends when robotfindskitten. Key Action Up, Down, Left, Right On Move robot Quit 12.1.
Chapter 12. Plugins Key Action F1 Left Right Down Play Up On Off Restart game Move left Move right Move down Rotate anticlockwise Rotate clockwise Drop Quit 12.1.19. Rockblox1d Rockblox1d is a game for people who find rockblox too hard. In this version the second dimension is missing so the user only has to move the bricks down. No horizontal moving anymore and no need to rotate the brick! Key Action Down On or Off Move down faster Quit 12.1.20. Sliding Puzzle Figure 12.16.
Chapter 12. Plugins Key Action Left, Right, Up and Down F1 F2 Move Tile Off Shuffle Switch between pictures (default puzzle, and your own image if launched via Open With), and numbered tiles Stop the game 12.1.21. Snake Figure 12.17.: Snake This is the popular snake game. The aim is to grow your snake as large as possible by eating the dots that appear on the screen. The game will end when the snake touches either the borders of the screen or itself.
Chapter 12. Plugins Another version of the Snake game. Move the snake around, and eat the apples that pop up on the screen. Each time an apple is eaten, the snake gets longer. The game ends when the snake hits a wall, or runs into itself. Key Action Up / Down / Left / Right Play Off Steer the snake Pause and resume the game Quit In game A, the maze stays the same, in game B after an increasing number of apples eaten the maze is replaced by a new one. 12.1.23. Sokoban Figure 12.19.
Chapter 12. Plugins Key Action Up, Down, Left, Right Off F1 F2 F3 On Play Play Up/Down Left/Right Off In game Move the “sokoban” up, down, left, or right Menu Back to previous level Restart level Go to next level Undo last movement Redo previously undone move Solution playback Pause/resume Increase/decrease playback speed Go backward/forward (while paused) Quit Some places where can you can find level sets: • http://www.sourcecode.se/sokoban/levels.php • http://sokobano.de/en/levels.
Chapter 12. Plugins Key Action Up / Down / Left / Right On Move Cursor around. F1 Play F2 F3 Off Select cards, move cards, reveal hidden cards... If a card was selected – unselect it, else Draw 3 new cards from the remains stack Put the card from the top of the remains stack on top of the cursor Put the card under the cursor on one of the 4 final colour stacks. Put the card on top of the remains stack on one of the final colour stacks. Show menu 12.1.25. Spacerocks Figure 12.21.
Chapter 12. Plugins 12.1.26. Star Figure 12.22.: Star game This is a puzzle game. It is actually a rewrite of Star, a game written by CDK designed for the hp48 calculator. Rules: Take all of the “o”s to go to the next level. You can switch control between the filled circle, which can take “o”s, and the filled square, which is used as a mobile wall to allow your filled circle to get to places on the screen it could not otherwise reach. The block cannot take “o”s.
Chapter 12. Plugins estimate of its difficulty (very easy, easy, medium, hard or fiendish) will be displayed on the screen. New games can be generated from the Generate menu option. When “playing” an existing Sudoku game file from Rockbox’ file browser the plugin is invoked as viewer. The selected Sudoku will get loaded and you can start solving it. The sudoku games need to be stored as text files with the extension .ss as single file per game.
Chapter 12. Plugins 12.1.28. Wormlet Figure 12.24.: Wormlet game Wormlet is a multi-user multi-worm game on a multi-threaded multi-functional Rockbox console. You navigate a hungry little worm. Help your worm to find food and to avoid poisoned argh-tiles. The goal is to turn your tiny worm into a big worm for as long as possible. For 2-player games a remote control is not necessary but recommended. If you try to hold the player in the four hands of two players you’ll find out why.
Chapter 12. Plugins Players 0 Modes Player 1 Out of control With no player taking part in the game all worms are out of control and steered by artificial stupidity.
Chapter 12. Plugins Worms. Thou shall not eat worms. Neither other worms nor thyself. Eating worms is blasphemous cannibalism, not healthy and causes instant death. And it doesn’t help anyway: the other worm isn’t hurt by the bite. It will go on creeping happily and eat all the food you left on the table. Walls. Don’t crash into the walls. Walls are not edible. Crashing a worm against a wall causes it a headache it doesn’t survive. Game over. The game is over when all worms are dead.
Chapter 12. Plugins Hints • Initially you will be busy with controlling your worm. Try to avoid other worms and crawl far away from them. Wait until they curl up themselves and collect the food afterwards. Don’t worry if the other worms grow longer than yours - you can catch up after they’ve died. • When you are more experienced watch the tactics of other worms. Those worms controlled by artificial stupidity head straight for the nearest piece of food.
Chapter 12. Plugins 12.1.30. XWorld In this cinematic, award winning platform game by Éric Chahi, you must evade capture and do your best to escape an alien planet. After an experiment goes awry the hero must team up with an unlikely ally, when they both become fugitives on another world. XWorld requires the data files, BANK* and MEMLIST.BIN, from the original “Another World” PC game to be copied into the .rockbox/xworld/ directory before the game can be played.
Chapter 12. Plugins Available options are: Xdist/Ydist. The distance to X axis and Y axis respectively Xadd/Yadd. How fast the code moves on the sine curve on each axis Xsane/Ysane. Changes the appearance of the bouncing. 12.2.2. Credits The credits plugin scrolls the entire list of the names of all the Rockbox contributors after displaying the Rockbox logo and version. This plugin is called when selecting Version from the System section of the Rockbox main menu.
Chapter 12. Plugins 12.2.4. Demystify Figure 12.28.: Demystify Demystify is a screen saver like demo. Key Action Left / Right Up / Down On Increase / decrease speed Add / remove polygon Quit 12.2.5. Fire Figure 12.29.: Fire Fire is a demo displaying a fire effect.
Chapter 12. Plugins 12.2.6. Fractals Figure 12.30.: Fractals: Mandelbrot set This demonstration draws fractal images from the Mandelbrot set using the greyscale engine. Key Action Direction keys Play On F1 F2 F3 Off Move about the image Zoom in Zoom out Decrease iteration depth (less detail) Increase iteration depth (more detail) Reset and return to the default image Quit 12.2.7. Logo Demo showing the Rockbox logo bouncing around the screen.
Chapter 12. Plugins 12.2.8. Mosaique Figure 12.31.: Mosaique This simple graphics demo draws a mosaic picture on the screen of the player. Key Action Up Change the gap between the drawing lines. Restart the drawing process. Exits Mosaique demo Play On or Off 12.2.9. Oscilloscope Figure 12.32.: Oscilloscope This demo shows the shape of the sound samples that make up the music being played.
Chapter 12. Plugins Keys Key Action F1 F2 F3 Play Up / Down Right / Left Off Toggle filled / curve / plot Toggle whether to scroll or not Toggle drawing orientation Pause the demo Increase / decrease volume Increase / decrease speed Exit demo 12.2.10. PictureFlow Figure 12.33.: PictureFlow PictureFlow provides a visualisation of your albums with their associated cover art. Note: PictureFlow is a visualisation only. It cannot be used to select and play music.
Chapter 12. Plugins Keys Key Action Left / Right Up / Down On Scroll through albums Scroll through track list Enter track list / Play album from selected track Exit track list Enter menu Exit PictureFlow Left F1 Off Main Menu Go to WPS. Leave PictureFlow and enter the while playing screen. Settings. Enter the settings menu. Return. Exit menu. Quit. Exit PictureFlow plugin. Settings Menu Show FPS. Displays frames per second on screen. Spacing.
Chapter 12. Plugins 12.2.11. Plasma Figure 12.34.: Plasma Plasma is a demo displaying a 80’s style retro plasma effect. Key Action Up / Down On / Off Increase / decrease Frequency Exit 12.2.12. Rocklife This an implementation of J. H. Conway’s Game of Life (see http://en.wikipedia.org/ wiki/Conway%27s_Game_of_Life for a detailed description). Rockbox can open files with a configuration description (.cells files).
Chapter 12. Plugins 12.2.13. Snow Figure 12.35.: 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 On or Off to quit. 12.2.14. Starfield Figure 12.36.: Starfield Starfield simulation (like the classic screensaver). Key Action Right / Left Up / Down On or Off Increase / decrease number of stars Increase / decrease speed Quit 12.2.15. VU meter Figure 12.37.
Chapter 12. Plugins This is a VU meter, which displays the volume of the left and right audio channels. There are 3 types of meter selectable. The analogue meter is a classic needle style. The digital meter is modelled after LED volume displays, and the mini-meter option allows for the display of small meters in addition to the main display (as above). From the settings menu the decay time for the meter (its memory), the meter type and the meter scale can be changed.
Chapter 12. Plugins 12.3.1. Shortcuts The Shortcuts Plugin allows you to jump to places within the file browser without having to navigate there manually. The plugin works with .link files. A .link file is just a text file with every line containing the name of the file or the directory you want to quickly jump to. All names should be full absolute names, i.e. they should start with a /. Directory names should also end with a /. How to create .
Chapter 12. Plugins 12.3.2. Chip-8 Emulator Chip8 is a kind of assembly language for a long-gone architecture. This plugin runs games written using the chip8 instructions. To start a game open a .ch8 file in the File Browser There are lots of tiny Chip8 games (usually only about 256 bytes to a couple of KB) which were made popular by the HP48 calculator’s emulator for them. The original Chip8 had 64×32 pixel graphics, and the new superchip emulator supports 128×64 graphics.
Chapter 12. Plugins Browser. Most modern games are in the .z5 or .z8 format but the older formats used by Infocom are supported. Z-Machine games are text based and most depend heavily on typed commands. The virtual keyboard is used for text entry, both for typing entire lines and for typing single characters when the game requires single character input.
Chapter 12. Plugins Format File-extension(s) BMP JPEG PNG GIF .bmp .jpg, .jpe, .jpeg .png .gif b Note: This plugin will cause playback to stop. Key Action Up / Down / Left / Right Play On F3 F2 Off Move around in zoomed in image Zoom in Zoom out Next image in directory Previous image in directory Show menu / Abort The menu has the following entries. Return. Returns you to the image Toggle Slideshow Mode. Enables or disables the slideshow mode. Change Slideshow Timeout.
Chapter 12. Plugins Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game, open a ROM file saved as .gb or .gbc in the file browser. Default keys Key Action Up / Down Left / Right F1 F2 F3 Play On Off Direction keys A button B button Start Select Cycle display scaling modes Open Rockboy menu Rockboy menu Load Game. . . Loads a previously saved game. Save Game. . . Saves your current state. Options. . . Max Frameskip.
Chapter 12. Plugins 12.3.8. 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.9 (page 42)). 12.3.9. Text Viewer Figure 12.39.: 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 12. Plugins Menu Return Return to the file being viewed. Viewer Options Change settings for the current file. Encoding Set the codepage in the text viewer. Available settings: ISO-8859-1 (Latin 1).
Chapter 12. Plugins Show Statusbar Select whether to show the status bar. If you select a theme settings that the status bar does not display (see section 9 (page 66)), the status bar is not displayed even if you select Yes. No Do not display the status bar. Yes Display the status bar. Scroll Settings The scrolling settings submenu. Horizontal Submenu for horizontal scrolling settings. Scrollbar Toggle the horizontal scrollbar for the current mode.
Chapter 12. Plugins Indent Spaces Set the number of spaces to indent the text when line mode is set to Reflow Lines. Available options are 0 to 5 spaces. If you select 0, a blank line is displayed as an indent. Show Playback Menu Display the playback menu to allow control of the currently playing music without leaving the plugin. Select Bookmark Select a saved bookmark. In the screenshot below, the “*” denotes the current page. Figure 12.40.
Chapter 12. Plugins Theme Remove menu Remove Theme. Selecting this will delete the files specified in the Remove Options. After a theme has been successfully removed, a log message is displayed listing which items have been deleted and which are being kept. Exit this screen by pressing any key. A file called theme_remove_log.txt is created in the root directory of your player listing all the changes. Remove Options. This menu specifies which items are removed if Remove Theme is selected in the menu.
Chapter 12. Plugins the player) and can take a while to complete if run on big files. 12.3.12. ZXBox Figure 12.42.: ZXBox ZXBox is a port of the “Spectemu” ZX Spectrum 48k emulator for Rockbox (Zproject’s homepage). To start a game open a tape file or snapshot saved as .tap, .tzx, .z80 or .sna in the file browser. Note: As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible. Default keys The emulator is set up for 5 different buttons: Up, Down, Left, Right and Jump/Fire.
Chapter 12. Plugins Load Quick Snapshot. Loads snapshot from /.rockbox/zxboxq.z80. Save Snapshot. Saves a snapshot of the current state. You would enter the full path and desired name - for example /games/zx/snapshots/chuckie.sna. The snapshot format will be chosen after the extension you specified, per default .z80 will be taken in case you leave it open. Toggle Fast Mode. Toggles fastest possible emulation speed (no sound, maximum frameskip etc.).
Chapter 12. Plugins Key configuration Key Action Left / Right Up / Down Play On Switch between hours/minutes selection Increase/Decrease hours/minutes Set the alarm Exit Setting an alarm First select a track and play it, then launch the “alarmclock” plugin. The plugin pauses the playback. Enter a 24h-time (e.g. 13:58) and set the alarm. Music playback will resume when the set time is reached. 12.4.2.
Chapter 12. Plugins Information explained At the top of the battery_bench.txt file is various information on how to use the plugin, followed by the data themselves. Time This column reports the total time of operation of the player. It is not the time that you started the plug-in. If you have your player on for 5 minutes and then start the plugin, it will start measuring from 5 minutes. Seconds The same as Time, except measured in seconds.
Chapter 12. Plugins 12.4.3. Calculator Figure 12.43.: Calculator This is a simple scientific calculator for use on the player. It works like a standard calculator. Pressing the “1st” and “2nd” buttons will toggle between other available math functions. Key Action Left / Right / Up / Down Play F1 Move around the keypad F2 F3 Off Select a button Delete last entered digit or clear after calculation Cycle through the 4 basic operators Calculate Quit 12.4.4. Calendar Figure 12.44.
Chapter 12. Plugins Key Action Left / Right / Up / Down Play On + Up / Down Off Move the selector Show memos for the selected day Previous / Next month Quit 12.4.5. Chess Clock Figure 12.45.: Chess Clock The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players.
Chapter 12. Plugins 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). Keys are as follows: Key Action Off Left Play Up Down F1 Exit plugin Restart round for the current player Pause the time (press again to continue) Switch to next player Switch to previous player Open menu (Play to select.
Chapter 12. Plugins Clock Menu View Clock Exits the menu and returns to the current clock mode display. Mode Selector Opens a menu from which you can select a clock mode to view. Counter Settings Opens a menu from which you can adjust settings pertaining to the counter. Mode Settings Opens a menu from which you can adjust settings pertaining to the current clock mode (analog, digital, binary). General Settings Reset Settings Reset all settings to their default values.
Chapter 12. Plugins LCD mode Based on the Digital Mode, the LCD mode is another imitation of an LCD. The settings available in this mode are exactly the same as Digital Mode, but they are independent of Digital Mode. For example, you can have the Date Readout enabled in Digital Mode and disabled in LCD Mode. Fullscreen A Fullscreen clock is displayed. Show Border, if enabled, will draw a small box at every hour position (1 to 12 inclusive).
Chapter 12. Plugins 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. Key Action Left or Off Exit / Abort 12.4.8. Keybox Keybox is an encrypted password storage using the “Tiny Encryption Algorithm” with a key derived using md5.
Chapter 12. Plugins 12.4.10. Lrcplayer This plugin displays lyrics in .lrc files (and some other formats) synchronized with the song being played. Supported file types 1. .lrc 2. .lrc8 3. .snc 4. .txt 5. id3v2 SYLT or USLT tags in mp3 files .lrc8 files are the same as .lrc files except that they are UTF8 encoded. The Lyrics3 tag is not supported. Supported tags and formats for .
Chapter 12. Plugins If the audio file currently playing is /Music/Artist/Album/Title.mp3, then the following files will be searched for, in this order. .ext is one of the supported extensions from the list above, and will be searched for in the same order as in that list. /Music/Artist/Album/Title.ext /Music/Artist/Title.ext /Music/Title.ext /Title.ext /Music/Artist/Album/Lyrics/Title.ext /Music/Artist/Lyrics/Title.ext /Music/Lyrics/Title.ext /Lyrics/Title.ext /Lyrics/Musics/Artist/Album/Title.
Chapter 12. Plugins Display Settings. Change how the lyrics are displayed. Wrap. Breaks lines at white space. Wipe. Wipes the text. Alignment. Align text to the left, centre, or right. Activate Only Current Line. Activate only the current line, or the current and previous lines. Lyrics Settings. Change how the lyrics files are loaded. Encoding. Sets the codepage used in the plugin. Lrc Directory. Set the directory where lyrics files are stored, must be a maximum of 63 bytes. Playback Control.
Chapter 12. Plugins Simple Interactive Mode This is the mode of operation that is active when starting the plugin directly from the menu. It offers a uniform metronome sound at a constant tempo. You can adjust the tempo through the interface or by tapping it out on the appropriate button. Key Action Off On Long Play Play Left / Right Up / Down Exit plugin Stop Start Tap tempo Adjust tempo Adjust volume Programmed Track Mode When starting the plugin as a viewer for tempomap files (ending in .
Chapter 12. Plugins Navigation The display indicates the part properties and position in track as such: Metronome Track --------------"Interlude" 3/4@120 V-25 P2/13: B1/5+2 In this example, the part label is “Interlude”, the meter is 3/4 and the tempo 120 quarter beats per minute (bpm). The volume setting is at -25 and this is the second part of a track with 13 total. In that part, the position is at the second beat of the first bar of five.
Chapter 12. Plugins Symbol X x . Meaning emphasized beat (Tick) normal beat (Tock) silent beat Some examples: default: rockon2: solea: shuffle: funky: 0 0 0 0 0 4/4 120 Xxxx 4/4 120 xXxX 12/4 180 xxXxxXxXxXxX 12/12 120 x.xX.xx.xX.. 16/16 120 x.x.X..X.Xx.X..X The 12/12 for the shuffle create 1/4 triplets. Just do a bit of math;-) This is still a metronome, not a drum machine, but it can act like a basic one, helping you to figure out a certain rhythm within the meter.
Chapter 12. Plugins 12.4.14. Random Folder Advance Configuration This plugin is used to configure the folders which will be considered when the AutoChange Directory feature is set to Random. Menu Generate Folder List Generates a list of all folders found on the player. You can filter the directories which are scanned by creating a file called /.rockbox/folder_advance_dir.txt. Only the directories in this file and any contained directories will be scanned.
Chapter 12. Plugins 12.4.15. Resistor Calculator Figure 12.47.: Resistor calculator The resistor calculator is a plugin that works in 3 modes: Colour to Resistance In Colour to Resistance mode, use the menus to select the colours of the bands of a resistor which you would like to know the resistance of.
Chapter 12. Plugins 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 On or Off to abort counting and exit the plugin. Press it again to quit after counting has finished. 12.4.17. Stopwatch Figure 12.49.: Stopwatch A simple stopwatch program with support for saving times.
Chapter 12. Plugins Note: When you have not changed the file the Text Editor will quit immediately.
Chapter 13. Advanced Topics 13. Advanced Topics 13.1. Customising the User Interface 13.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 13.
Chapter 13. Advanced Topics Note: Advanced Users Only: Any BDF font should be usable with Rockbox. To convert from .bdf to .fnt, use the convbdf tool. This tool can be found in the tools directory of the Rockbox source code. See ZCreateFonts#ConvBdf for more details. Or just run convbdf without any parameters to see the possible options. b 13.1.4. Loading Languages Rockbox can load language files at runtime. Simply copy the .lng file (do not use the .
Chapter 13. Advanced Topics 140 and the SBS or Base Skin. The WPS is the name used to describe the information displayed on the player’s screen whilst an audio track is being played, the FMS is the screen shown while listening to the radio, and the SBS lets you specify a base skin that is shown in the menus and browsers, as well as the WPS and FMS. The SBS also allows you to control certain aspects of the appearance of the menus/browsers.
Chapter 13. Advanced Topics this section. All elements placed before the line defining a viewport are displayed in the default viewport. Elements defined after a viewport declaration are drawn within that viewport. Loading images (see Appendix section C.20 (page 164)) should be done within the default viewport. A viewport ends either with the end of the file, or with the next viewport declaration line. Viewports sharing the same coordinates and dimensions cannot be displayed at the same time.
Chapter 13. Advanced Topics 142 Example %?mh<%Vd(a)|%Vd(b)> %Vl(a,10,10,50,50,-) %sYou could now show a hold icon using the %%xl and %%xd tags. %Vl(a,0,70,70,14,1) %s%acYour DAP is locked. %Vl(b,20,14,50,14,1) %t(1)%acWarning:;%t(.1) %Vl(b,20,30,50,50,0) %sYou’ve unlocked your player. This example checks for hold. Viewport ‘a’ will be displayed if it is on, otherwise viewport ‘b’ will display a flashing warning.
Chapter 13. Advanced Topics An example would be: %Fl(2,12-Nimbus.fnt,100) 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.
Chapter 13. 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 13. 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 13. 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 13. Advanced Topics 147 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 D (page 170) 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 .
Chapter 13. Advanced Topics 148 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. With that it’s possible to reflash independently from the outside, even if the flash ROM is completely erased. This won’t work if you have one of the rare “ROMless” boxes. These have no boot ROM and boot directly from flash. If the first ≈2 KB of the flash ROM are flashed OK, Minimon can be used for the same purpose. 13.5.
Chapter 13. Advanced Topics 149 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 part is slighty different from that in the .zip file name.) The flash plugin will select the correct one for your player.
Chapter 13. Advanced Topics 3. Go to the file browser, and enter the .rockbox directory (you might need to set the File View option to All.) 4. Play the file rockbox.ucl, and follow the instructions. The plugin handling this is rockbox_flash, a viewer plugin. 13.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.
Chapter 13. Advanced Topics 151 13.6.4. Audio format and bitrate Your target uses a hard disk which consumes a large amount of power while spinning – up to several hundred mA. The less often the hard disk needs to spin up for buffering and the shorter the buffering duration is, the lower is the power consumption. Therefore the bitrate of the audio files does have an impact on the battery runtime as well. Lower bitrate audio files will result in longer battery runtime.
Appendix A.
Appendix A. File formats A. File formats A.1. Supported file formats Icon File Type Extension Action when selected Directory Rockbox firmware Bookmark none .ajz .bmark Game of Life .cells Configuration File .cfg Enter the directory Load the new firmware with ROLO Display all bookmarks for an audio file Show the configuration with the “Rocklife” plugin Load the settings file Chip8 game Cuesheet Font .ch8 .cue .
Appendix B. Album Art B. Album Art Rockbox allows you to put the album art, or another image related to the music on your player to display it in the PictureFlow plugin. For this feature to work, there are a few requirements. B.1. Limitations Rockbox currently only supports loading images located on the hard disk for use in PictureFlow. The image files must be in either BMP or JPEG format. Rockbox does not support RLE-compressed BMP files, nor does it support progressive and multi-scan JPEG files.
Appendix B. Album Art 155 The following characters will be replaced with an underscore (_) when looking for albumtitle.bmp or albumartist-albumtitle.bmp: \ / : < > ? * |. Doublequotes will be replaced by single quotes. If no album artist is set, artist will be used instead. See ZAlbumArt in the wiki for programs that will help you automate the process of putting album art on your player.
Appendix C. Theme Tags C. Theme Tags Themeing is discussed in detail in section section 13.2 (page 139), 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 C.26 (page 167). C.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 C. Theme Tags 157 C.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 C. Theme Tags 158 C.6. Misc Coloring Tags Tag Description %dr(x,y,width,height,[color1,color2]) Color a rectangle. width and height can be - to fill the viewport. If no color is specified the viewports foreground color will be used. If two colors are specified it will do a gradient fill. C.7. Power Related Information Tag Description %bl Numeric battery level in percents. Can also be used in a conditional: %?bl<-1|0|1|2|...
Appendix C. Theme Tags 159 C.8. 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 C. Theme Tags C.9. Playlist/Song Info Tag Description %pb Progress Bar. This will replace the entire line with a progress bar. You can set the position, width and height of the progressbar (in pixels) and load a custom image for it: %pb(x,y,[width],[height],image.bmp) Percentage played in song Current time in song Total number of playlist entries Peak Meter. The entire line is used as volume peak meter. Peak meter for the left channel.
Appendix C. Theme Tags 161 • ‘start’ is the offset relative to the currently playing track for the playlist to display from (0 the current track, 1 is the next track, etc.). • ‘code to render’ is a line of skin code which will be displayed for each line in the viewer. All text tags are supported (including conditionals and sublines) The entire viewport will be used, so don’t expect other tags in the same viewport to work well.
Appendix C. Theme Tags C.15. Playback Mode Tag Description %mp Play status, 0-4, in the order: Stop, Play, Pause, Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, FM Radio muted Example: %?mp C.16.
Appendix C. Theme Tags 163 %?if(%cs, =, 2) C.17. List Title (.sbs only) Tag Description %Lt Title text. Should be used in a conditional so that non-list screens don’t show a title when they shouldn’t Title icon. This uses the same order as custom icons (see ZCustomIcons in the wiki) except that here 0 is “no icon” %Li This tag can be used to give custom formatting to list titles.
Appendix C. Theme Tags 1. As a simple tag: %St(skip length) 2. As a conditional: %?St(eq enabled) C.20. Images Tag Description %x(n,filename[,x,y])Load and display an image n: image ID for later referencing in %xd filename: file name relative to /.rockbox/ and including “.bmp” x: x coordinate (defaults to 0 if both x and y are not specified) y: y coordinate.
Appendix C. Theme Tags Examples: 1. Load and display the image /.rockbox/bg.bmp with ID “a” at 37, 109: %x(a,bg.bmp,37,109) 2. Load a bitmap strip containing 5 volume icon images (all the same size) with image ID “M”, and then reference the individual sub-images in a conditional: %xl(M,volume.
Appendix C. Theme Tags 166 C.22. Conditional Tags Tag Description %?xx %?xx %if(tag, operator, operand, [option count]) %and(tag1, tag2, ..., tagN) If / Else: Evaluate for true or false case Enumerations: Evaluate for first / second / third / . . . / last condition Allows very simple comparisons with other tags. tag: the tag to check against.
Appendix C. Theme Tags C.24. Time and Date Tag Description %cd %ce %cf Day of month from 01 to 31 Zero padded day of month from 1 to 31 A conditional for 12/24 hour format.
Appendix C. 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 C. Theme Tags C.27. 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 D. Config file options D.
Appendix D. Config file options Setting Allowed Values Unit bidir limit scroll paginated hold_lr_for_scroll_in_list show path in browser contrast backlight timeout 0 to 200 on, off on, off off, current directory, full path 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 N/A s normal, off, on on, off devise a way to from config-*.
Appendix D. Config file options Setting Allowed Values Unit disable autoresume if phones not present Last.
Appendix D.
Appendix E. Menu Overview 174 E.
Appendix F. User feedback F. User feedback F.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 F.1.1. Rules for submitting new bug reports 1. Check that the bug has not already been reported 2.
Appendix F. User feedback F.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 F. User feedback 177 • 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 G. Credits G. Credits People that have contributed to the project, one way or another.
Appendix G. 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 G. 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 G.
Appendix H. Licenses H. Licenses H.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 H. 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 H. 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 H. 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 H. 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 H. 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 H. 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 H. 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 H. Licenses H.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 H. 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 H. 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 H. 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 H. 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 H. 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 H. 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.
