The Rockbox Manual for Sansa Fuze 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.
Contents 4.1.3. Virtual Keyboard . . . . . 4.2. Database . . . . . . . . . . . . . 4.2.1. Introduction . . . . . . . 4.2.2. Initializing the Database . 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. Peak Meter . . . . . . . . 4.3.3. 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.
Contents 6.2. Bass . . . . . . . . . . . . . . 6.3. Volume Limit . . . . . . . . . 6.4. Treble . . . . . . . . . . . . . 6.5. Balance . . . . . . . . . . . . 6.6. Channels . . . . . . . . . . . 6.7. Stereo Width . . . . . . . . . 6.8. Crossfeed . . . . . . . . . . . 6.9. Equalizer . . . . . . . . . . . 6.10. Dithering . . . . . . . . . . . 6.11. Timestretch . . . . . . . . . . 6.12. Haas Surround . . . . . . . . 6.13. Perceptual Bass Enhancement 6.14. Auditory Fatigue Reduction . 6.15. Compressor . . . .
Contents 8.5.4. Car Adapter Mode . . . . 8.5.5. Button Light Timeout . . 8.5.6. Keyclick . . . . . . . . . . 8.5.7. USB HID . . . . . . . . . 8.5.8. USB Keypad Mode . . . . 8.5.9. USB Hide Internal Drive . 8.6. Startup/Shutdown . . . . . . . . 8.6.1. Start Screen . . . . . . . . 8.6.2. Idle Poweroff . . . . . . . 8.6.3. Sleep Timer . . . . . . . . 8.7. Bookmarking . . . . . . . . . . . 8.8. Automatic resume . . . . . . . . 8.9. Language . . . . . . . . . . . . . 8.10. Voice . . . . . . . . . . . . . . .
Contents 12.1.10.Doom . . . . . . 12.1.11.Flipit . . . . . . 12.1.12.Goban . . . . . . 12.1.13.Invadrox . . . . . 12.1.14.Jackpot . . . . . 12.1.15.Jewels . . . . . . 12.1.16.MazezaM . . . . 12.1.17.Minesweeper . . 12.1.18.Pacbox . . . . . 12.1.19.Pegbox . . . . . 12.1.20.Pong . . . . . . . 12.1.21.Reversi . . . . . 12.1.22.Robotfindskitten 12.1.23.Rockblox . . . . 12.1.24.Rockblox1d . . . 12.1.25.Sliding Puzzle . . 12.1.26.Snake . . . . . . 12.1.27.Snake 2 . . . . . 12.1.28.Sokoban . . . . . 12.1.29.
Contents 12.3.2. Chip-8 Emulator . . . . 12.3.3. Frotz . . . . . . . . . . . 12.3.4. Image Viewer . . . . . . 12.3.5. Lua scripting language . 12.3.6. Midiplay . . . . . . . . . 12.3.7. MPEG Player . . . . . . 12.3.8. MP3 Encoder . . . . . . 12.3.9. Rockboy . . . . . . . . . 12.3.10.Search . . . . . . . . . . 12.3.11.Shopper . . . . . . . . . 12.3.12.Sort . . . . . . . . . . . 12.3.13.Text Viewer . . . . . . . 12.3.14.Theme Remove . . . . . 12.3.15.VBRfix . . . . . . . . . 12.3.16.ZXBox . . . . . . . . .
Contents 13.1.6. Loading Backdrops . . . . . . . . 13.1.7. UI Viewport . . . . . . . . . . . 13.2. Configuring the Theme . . . . . . . . . . 13.2.1. Themeing – General Info . . . . 13.2.2. Themes – Create Your Own . . . 13.2.3. Info Viewport (SBS only) . . . . 13.2.4. Additional Fonts . . . . . . . . . 13.3. Managing Rockbox Settings . . . . . . . 13.3.1. Introduction to .cfg Files . . . . 13.3.2. Specifications for .cfg Files . . . 13.3.3. The Manage Settings menu . 13.4. Firmware Loading . . . . . . .
Contents D.6. Misc Coloring Tags . . . . . . . . . . D.7. Power Related Information . . . . . D.8. Information about the file . . . . . . D.9. Playlist/Song Info . . . . . . . . . . D.10.Playlist Viewer . . . . . . . . . . . . D.11.Runtime Database . . . . . . . . . . D.12.Sound (DSP) settings . . . . . . . . D.13.Hold . . . . . . . . . . . . . . . . . . D.14.Virtual LED . . . . . . . . . . . . . D.15.Repeat Mode . . . . . . . . . . . . . D.16.Playback Mode . . . . . . . . . . . . D.17.Current Screen .
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 Supported hardware versions. The Fuze is available in multiple versions, and you need to make sure which you have by checking the Sandisk firmware version number under Settings → System Settings → Info. The v1 firmware is named 01.xx.xx, while the v2 firmware begins with 02.
Chapter 2. Installation function. This is the component of Rockbox that is installed to the flash memory of your Sansa. The Rockbox firmware. Unlike the Sansa firmware, which runs entirely from flash memory, most of the Rockbox code is contained in a “build” that resides on your player’s drive. This makes it easy to update Rockbox. The build consists of a directory called .rockbox which contains all of the Rockbox files, and is located in the root of your player’s drive.
Chapter 2. Installation Choosing a Rockbox version There are three different versions of Rockbox available from the Rockbox website: Release version, current build and archived daily build. You need to decide which one you want to install and get the appropriate version for your player. If you select either “Minimal Installation” or “Complete Installation” from the “Quick Start” tab, then Rockbox Utility will automatically install the release version of Rockbox.
Chapter 2. Installation 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 .zip file should be extracted directly to the root of your player’s drive. Do not try to create a separate directory on your player for the Rockbox files! The .zip file already contains the internal structure that Rockbox needs. b If the contents of the .
Chapter 2. Installation 17 2.2.4. Bootloader installation from Mac OS X and Linux 1. Create a folder called “rbinstall” in your home directory, and then extract the OF, the bootloader and mkamsboot into it. 2. Open a new terminal, and navigate to the “rbinstall” folder. 3. Run mkamsboot, passing the name of the OF and bootloader files that you downloaded, in addition to a name for the output file. Code ./mkamsboot fuzea.bin bootloader-fuze.sansa patched.
Chapter 2. Installation installed over your current build. The bootloader only changes rarely, and should not normally need to be updated. Note: If you use Rockbox Utility be aware that it cannot detect manually installed components. b 2.5. Uninstalling Rockbox Note: The Rockbox bootloader allows you to choose between Rockbox and the original firmware. (See section 3.1.3 (page 20) for more information.) 2.5.1. Automatic Uninstallation You can uninstall Rockbox automatically by using Rockbox Utility.
Chapter 3. Quick Start 3. Quick Start 3.1. Basic Overview 3.1.1. The player’s controls Play Home Power Scroll Back Scroll Fwd Hold Left Right Select Submenu 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.
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 Power Long Power Start Rockbox Shutdown Rockbox On shutdown, Rockbox automatically saves its settings. 3.1.3. Starting the original firmware Rockbox has a dual-boot feature. To boot into the original firmware, press and hold the Left button while turning on the player. 3.1.4.
Chapter 3. Quick Start 21 3.1.6. 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 Scroll Forward and Scroll Backward to move around the selection. Use Select or Right to select an item. Note that the scroll speed is accelerating the faster you rotate the wheel. When browsing the file system selecting an audio file plays it.
Chapter 3. Quick Start 22 other settings like file view, LCD settings and all other settings that can be modified using .cfg files. This topic is discussed in more detail in section 13.3 (page 173). 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.
Chapter 4. Browsing and playing 23 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 Scroll Backward/Scroll Forward Left Select or Right 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. Stop audio playback. Enter the Context Menu.
Chapter 4. Browsing and playing 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.4.3 (page 36)). Playlist Catalogue. Enters the Playlist Catalogue Submenu (see section 4.4.2 (page 36)). 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.
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.11 (page 60) 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 Home + Left / Home + Right Submenu Move the line cursor within the text line. Left / Right Scroll Backward / Scroll Forward Home + Select Select Play Long Home Select 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.
Chapter 4. Browsing and playing 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 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 30 4.3. While Playing Screen The While Playing Screen (WPS) displays various pieces of information about the currently playing audio file. The appearance of the WPS can be configured using WPS configuration files. The items shown depend on your configuration – all items can be turned on or off independently. Refer to section D (page 187) for details on how to change the display of the WPS.
Chapter 4. Browsing and playing 4.3.1. WPS Key Controls Key Action Scroll Forward / Scroll Backward Left Volume up/down. Long Left Right Long Right Play Long Play Select Long Select Submenu Long Submenu Home Home + Right or Short Right + Long Right Home + Left or Short Left + Long Left 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.
Chapter 4. Browsing and playing 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. The scale: Between the indicators of the right and left channel there are little dots. These dots represent important volume values. In linear mode each dot is a 10% mark.
Chapter 4. Browsing and playing 33 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 48) 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 4.4. Working with Playlists 4.4.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 36 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 Next. Add track(s) immediately after current playing track, no matter what else has been inserted. 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.
Chapter 4. Browsing and playing 38 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.
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 Submenu button. All settings are stored on the unit. However, Rockbox does not access the flash storage 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 41 5.5. Database Browse by the meta-data in your audio files (see section 4.2 (page 27)). 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 30)). 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 42 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 173). 5.8. Recording 5.8.1. While Recording Screen Figure 5.3.
Chapter 5. The Main Menu Key Action Scroll Backward / Scroll Forward Left / Right Play Select setting. Submenu Long Select 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 78)). 5.9. FM Radio Figure 5.4.: The FM radio screen This menu option switches to the radio screen.
Chapter 5. The Main Menu Key Action Left, Right Change frequency in SCAN mode or jump to next/previous station in PRESET mode. Seek to next station in SCAN mode. Long Left, Long Right Scroll Forward, Scroll Backward Submenu Long Play Play Long Home Home Long Select Change volume. Leave the radio screen with the radio playing. Stop the radio and return to Main Menu. Mute radio playback. Switch between SCAN and PRESET mode. Open a list of radio presets.
Chapter 5. The Main Menu Create Playlist: Rockbox will create a playlist with all tracks in the current directory and all sub-directories. The playlist will be created one directory level “up” from where you currently are. View Current Playlist: Displays the contents of the playlist currently stored in memory. Save Current Playlist: Saves the current dynamic playlist, excluding queued tracks, to the specified file. If no path is provided then playlist is saved to the current directory.
Chapter 5. The Main Menu 5.13. Quick Screen Although the Quick Screen is accessible from nearly everywhere, not just the Main Menu, it is worth mentioning here. It allows rapid access to your four favourite settings. The default settings are Shuffle (section 7 (page 56)), Repeat (section 7 (page 56)) and the Show Files (section 8.2 (page 63)) options, but almost all configurable options in Rockbox can be placed on this screen.
Chapter 5. The Main Menu 47 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 48 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 49 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 -24 dB and the maximum is 24 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 50 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.
Chapter 6. Sound Settings 51 Most users will find the default settings to yield satisfactory results, but for the more adventurous user the settings can be fine-tuned to provide a virtual speaker placement suited to ones preference. Beware that the crossfeed function is capable of making the audio distort if you choose settings which result in a too high output level. 6.9. Equalizer Figure 6.2.: The graphical equalizer Rockbox features a parametric equalizer (EQ).
Chapter 6. Sound Settings 52 In some ways the EQ is similar to the Bass and Treble settings described earlier, but the EQ allows you to control the sound much more carefully. Note that the parameteric EQ bands will be applied in addition to any bass or treble tone controls. Note: A maximum of 10 EQ bands are possible on most devices, but using more than are required will waste battery and introduce additional rounding noise. For best results, use the fewest number of bands required.
Chapter 6. Sound Settings Key Action Scroll Forward Raises the highlighted parameter. Scroll Backward Lowers the highlighted parameter. Play Submenu Select Moves to the previous EQ band. Moves to the next EQ band. Toggles the cursor among the three parameters (gain, centre frequency, Q) for the selected EQ band Exits the graphic EQ screen. Left Pre-cut. If too much positive gain is added through the graphical EQ, your music may distort.
Chapter 6. Sound Settings 54 Dithering adds low-level noise to the signal prior to throwing away the surplus bits, which gives the resulting signal a uniform noise floor which is independent of the signal. Most people find this noise preferable to the time-varying noise heard when not performing dithering. After dithering, noise shaping is performed. This basically just pushes the dithering noise to the parts of the frequency spectrum humans cannot hear so easily.
Chapter 6. Sound Settings 55 6.14. Auditory Fatigue Reduction Human hearing is more senstive to some frequency bands. This setting applies additional equalization and bi-shelf filtering to reduce signals in these bands to minimize the chance that temporary threshold shift (auditory fatigue) occurs. 6.15. Compressor The Compressor reduces, or compresses, the dynamic range of the audio signal.
Chapter 7. Playback Settings 56 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 35). Options: Yes/No. 7.2.
Chapter 7. Playback Settings 57 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 Fade In Delay. The “fade in delay” is the length of time between when the crossfade process begins and when the new track begins to fade in. Fade In Duration. The length of time, in seconds, that it takes your music to fade in once the Fade In Delay has ended. Fade Out Delay. The “fade out delay” is the length of time between when the crossfade process begins and when the old track begins to fade out. Fade Out Duration.
Chapter 7. Playback Settings 59 settings) have the same apparent volume. This prevents sudden changes in volume when changing between songs recorded at different volume levels. For replaygain to work, the songs must have been processed by a program that adds replaygain information to the ID3 tags (or Vorbis tags). Options for replaygain are: Replaygain Type. Choose the type of replaygain to apply: Album Gain.
Chapter 7. Playback Settings 60 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.11. Constrain Auto-Change If enabled and you have set Start File Browser Here to a directory other than root, Auto-Change Directory will be constrained to the directory you have chosen and those below it. See section 4.1.2 (page 25). 7.12. Last.fm Log Enables logging of your played tracks for submittal to http://www.last.fm.
Chapter 7. Playback Settings 61 7.15. Prevent Track Skipping If this option is enabled, the ability to manually skip tracks is disabled in order to avoid accidental track skips. It does not prevent changing tracks if a track ends, which can be achieved by combining this option with Repeat set to One 7.16. Rewind Before Resume When restarting a track or a bookmark, a short rewind can be done before the playback is started.
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 64 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 First Keypress Enables Backlight Only. With this option enabled the first keypress while the backlight is turned off will only turn the backlight on without having any other effect. When disabled the first keypress will also perform its appropriate action. Brightness. Changes the brightness of your LCD display. LCD Mode. This setting lets you invert the colours of the display. Upside Down. Displays the screen so that the top of the display is nearest the buttons.
Chapter 8. General Settings 66 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. The number of seconds that the clipping indicator will be visible after clipping is detected. Clip Counter. Show the number of times the clip indicator went active during recording in front of the peak meters. Scale.
Chapter 8. General Settings 67 is pressed and the time Rockbox responds. Turning this setting on activates the directory cache, and turning it off deactivates the directory cache. Note: The first time you enable the directory cache, Rockbox will request a reboot of the player and upon restarting take a few minutes to scan the drive. After this, the directory cache will work in the background. b 8.5.2. Limits This sub menu relates to limits in the Rockbox operating system. Max Entries in File Browser.
Chapter 8. General Settings 68 playback will be resumed 5 seconds after the power is applied. This delay is to allow for the time while the car engine is being started. Once the player is shut off either manually, or automatically with the Idle Poweroff function, it must be powered up manually to resume playback. 8.5.5. Button Light Timeout This setting controls the amount of time the button lights shine after a button press. If set to Off, the LEDs will not light when a button is pressed.
Chapter 8. General Settings Key Action Volume up / down, respectively Volume mute Play / Pause Stop Scan previous track Scan next track Presentation. This mode lets you control a presentation program (e.g. OpenOffice Impress, and some other popular application), making the player a wired remote control device. This mode is can be useful for lecturers who does not have a wireless remote control for this purpose.
Chapter 8. General Settings Mouse. This mode emulates a mouse. Features supported: Mouse movement; left and right button clicking; and dragging and dropping. Key Action Cursor move up / down / left / right, respectively Left mouse button click Right mouse button click Mouse wheel scroll up / down, respectively 8.5.9. USB Hide Internal Drive If this option is turned On, the internal storage drive will not be exposed on the USB Mass Storage Device. This e.g.
Chapter 8. General Settings 71 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 72 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 Scroll Forward Scroll Backward Select or Right Left Home Long Select 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 74 Resume on automatic track change. Controls whether the next track in an automatic track transition should be resumed at its last playback position as well. No. Automatic resume works only for manual track selection. Yes. Always attempt to resume – for both manual and automatic track changes. In custom directories only. Configure directories in which to enable resume on automatic track change.
Chapter 8. General Settings 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. No checking is made for directory .talk clips; they are not used even if present. This can reduce disk activity. Use of a .talk clip takes precedence over other directory name voicing. Otherwise (e.g.
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 Select or 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 48) 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 24)) on the directory where you want to store them in the File Browser and select Set As Recording Directory. b 10.1. Format Choose which format to save your recording in.
Chapter 10. Recording Settings 79 10.4. Source Choose the source of the recording. The options are: Microphone and FM Radio. For more information on recording from the radio see section 5.9 (page 43). 10.5. Channels This allows you to select mono or stereo recording. Please note that for mono recording, only the left channel is recorded. Mono recordings are usually somewhat smaller than stereo. 10.6.
Chapter 10. Recording Settings 10.9. Clear Recording Directory Resets the location where the recorded files are saved to the root of your player’s drive. 10.10. Clipping Light Causes the backlight to flash on when clipping has been detected. Options: Off, Main unit only, Main and remote unit, Remote unit only. 10.11. Trigger When you record a source you often are only interested in the sound and not the silence in between.
Chapter 10. Recording Settings 81 pointing to the right. There are two special values. The value Off turns the start condition off. With this setting you have to start the recording manually and the trigger only stops the recording according to the stop condition. The setting -inf sets the trigger to the absolute minimum. This setting only makes sense when you record via a digital input as even the noise of the device itself would exceed this threshold immediately. for at least.
Chapter 11. Time and Date 82 11. Time and Date Time related menu options. Pressing Long Select 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 12.1.3. BrickMania Figure 12.2.: BrickMania BrickMania is a clone of the classic game Breakout. The aim of the game is to destroy all the bricks by hitting them with the ball once or more. Sometimes a special item falls down when you destroy a brick. For a special item to take effect, you must catch it with 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.
Chapter 12. Plugins 12.1.4. Bubbles Figure 12.3.: Bubbles The goal of the game is to beat each level as quickly as possible by clearing the board of all bubbles. Bubbles are removed from the board when a cluster of three of more of the same type is formed. The game is over when any bubbles on the board extend below the bottom line. To make things more difficult, the entire board is shifted down every time a certain number of shots have been fired.
Chapter 12. Plugins 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. Chessbox will show the list of matches included in the file and allow you to select the one you want to watch. After that, you can scroll back and forth through the moves of the game.
Chapter 12. Plugins Key Action Left/Right/ Play/Submenu Select Home Move the cursor around the blocks Remove a block Exit 12.1.7. Chopper Figure 12.6.: Chopper Navigate a cavernous maze without banging into walls, the ceiling, or the floor. How long can you fly your chopper? Key Action Select Home Make chopper fly Enter menu 12.1.8. Codebuster Figure 12.7.
Chapter 12. Plugins Codebuster is a clone of the classic mastermind game. The computer selects a random combination of coloured pegs and the aim is to guess the correct combination in the smallest number of moves. After each attempt to guess the combination the results are displayed in the form of red and white pegs. A red peg signifies a correct peg in the correct position, and a white peg signifies a correct peg in the wrong position.
Chapter 12. Plugins Getting started For the game to run you need .wad game files located in /.rockbox/doom/ on your player. Create the directory and save the following files there: rockdoom.wad. The Rockbox .wad, based on prboom.wad from prboom-2.2.6 Your wad files. Copy all Doom wads you wish to play into that directory. The needed files can be found at ZPluginDoom To play addon wads create the addons directory within the doom directory. Place wad files in this directory.
Chapter 12. Plugins New Game. Start a new game Options. In game options Load Game. Load a saved game Save Game. Save the current game Quit. Quit the game InGame Options Menu. This menu has the following options: End Game. Ends the current game Messages. Enable or Disable in game messages Screen Size. Shrink or Enlarge the displayed portion of the game Gamma. Change the brightness (Gamma) of the game Sound Volume.
Chapter 12. Plugins 12.1.11. Flipit Figure 12.9.: Flipit 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 Play / Submenu / Left / Right Select Select+Left Select+Submenu Move the cursor Select+Right Solve step by step Long Home Quit the game Flip Shuffle Solve 12.1.12. Goban Figure 12.10.
Chapter 12. Plugins Goban is a a plugin for playing, viewing and recording games of Go (also known as Weiqi, Baduk, Igo and Goe). It uses standard Smart Game Format (SGF) files for saving and loading games. You can find a short introduction to Go at http://senseis.xmp. net/?WhatIsGo and more information about SGF files can be read at http://senseis.xmp. net/?SmartGameFormat or the SGF specification at http://www.red-bean.com/sgf/.
Chapter 12. Plugins Controls Key Action Play Submenu Left Right Select Move cursor up Move cursor down Move cursor left Move cursor right Play a move (or use a tool if play-mode has been changed). Retreat one node in the game tree Scroll Backward Scroll Forward Power Long Select Home Advance one node in the game tree Main Menu Context Menu Go to the next variation when at the first node in a branch Menus Main Menu. The main menu for game setup and access to other menus. New.
Chapter 12. Plugins Time Limit. The time limit of the current game. Overtime. The overtime settings of the current game. Result. The result of the current game. This text must follow the format specified at http://www.red-bean.com/sgf/properties.html#RE to be read by other SGF readers. Some examples are B+R (Black wins by resignation), B+5.5 (Black wins by 5.5 points), W+T (White wins on Time). Handicap. The handicap of the current game. Komi.
Chapter 12. Plugins Context Menu. The menu for choosing different play modes and tools, adding or editing comments, adding pass moves, or switching between sibling variations. Play Mode. Play moves normally on the board. If there are child moves from the current node, this mode will let you follow variations by simply playing the first move in the sequence. Unless it is following a variation, this mode will not allow you to play illegal moves.
Chapter 12. Plugins 12.1.13. Invadrox Figure 12.11.: Invadrox Invadrox is a clone of the classic arcade game Space Invaders. Kill those pesky aliens before they get to you. Remember, they increase speed, drop down and reverse direction after every pass! Key Action Left Right Select Long Home Move left Move right Fire Quit 12.1.14. Jackpot Figure 12.12.: 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.
Chapter 12. Plugins Key Action Select Home Play Exit the game 12.1.15. Jewels Figure 12.13.: Jewels 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.16. MazezaM Figure 12.14.: MazezaM The goal of this puzzle game is to escape a dungeon consisting of ten “mazezams”. These are rooms containing rows of blocks which can be shifted left or right. You can move the rows only by pushing them and if you move the rows carelessly, you will get stuck. You can have another go by selecting “retry level” from the menu, but this will cost you a life. You start the game with three lives.
Chapter 12. Plugins the information you are given to work out where the mines are and avoid them. When the player is certain that they know the location of a mine, it can be tagged to avoid accidentally “stepping” on it. Key Action Play / Submenu / Left / Right Scroll Forward Move the cursor across the minefield Select Scroll Backward Reveal the contents of the current square Display the current game status Long Home Exit the game Toggle flag on / off 12.1.18. Pacbox Figure 12.16.
Chapter 12. Plugins Filename MD5 checksum pacman.5e pacman.5f pacman.6e pacman.6f pacman.6h pacman.6j 2791455babaf26e0b396c78d2b45f8f6 9240f35d1d2beee0ff17195653b5e405 290aa5eae9e2f63587b5dd5a7da932da 19a886fcd8b5e88b0ed1b97f9d8659c0 d7cce8bffd9563b133ec17ebbb6373d4 33c0e197be4c787142af6c3be0d8f6b0 These need to be stored in the /.rockbox/pacman/ directory on your player. In the MAME ROMs collection the necessary files can be found in pacman.zip and puckman.zip.
Chapter 12. Plugins To beat each level, you must destroy all of the pegs. If two like pegs are pushed into each other they disappear except for triangles which form a solid block and crosses which allow you to choose a replacement block. Key Action Play, Submenu, Left, Right Select Select + Left to move around Select + Submenu Long Home to choose peg to restart level to go up a level to go down a level to quit 12.1.20. Pong Figure 12.18.: Pong Pong is a simple one or two player “tennis game”.
Chapter 12. Plugins Key Action Left Submenu Play Right Home Left player up Left player down Right player up Right player down Quit 12.1.21. Reversi This is a simple implementation of the Reversi game. The objective of the game is to have a majority of own coloured pieces showing at the end of the game. The game rules can be found in the internet. 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.22.
Chapter 12. Plugins 12.1.23. Rockblox Figure 12.20.: Rockblox 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 12. Plugins Key Action Submenu Home or Long Home Move down faster Quit 12.1.25. Sliding Puzzle Figure 12.21.: Sliding puzzle The classic sliding puzzle game. Rearrange the pieces so that you can see the whole picture, or switch to number tiles if you like it a little easier Includes one picture puzzle, but you can switch the puzzle picture to be the album art of the currently playing music track, if one exists (see section C (page 185)).
Chapter 12. Plugins 12.1.26. Snake Figure 12.22.: 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. Key Action Play / Submenu / Left / Right Select Move snake Toggle Play/Pause Go to the plugin’s menu 12.1.27. Snake 2 Figure 12.23.: Snake 2 – The Snake Strikes Back Another version of the Snake game.
Chapter 12. Plugins Key Action Play / Submenu / Left / Right Select Long Home 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.28. Sokoban Figure 12.24.: Sokoban The object of the game is to push boxes into their correct position in a crowded warehouse with a minimal number of pushes and moves.
Chapter 12. Plugins Key Action Play, Submenu, Left, Right Long Home Select+Submenu In game Move the “sokoban” up, down, left, or right Menu Back to previous level Select+Right Select+Play Select Select+Left Select Play/Submenu Left/Right Long Home 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.
Chapter 12. Plugins For the full set of rules to the game, and other interesting information visit http: //www.solitairecentral.com/rules/klondike.html Key Action Scroll Forward / Scroll Backward / Left / Right Select Move Cursor around. Home Left Right Long Left Long Home Select cards, move cards, reveal hidden cards...
Chapter 12. Plugins Key Action Select Play Scroll Backward/ Scroll Forward Submenu Select+Play Long Home Shoot Thrust Turn left/right Teleport Pause game Quit 12.1.31. Star Figure 12.27.: 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.
Chapter 12. Plugins Key Action Left Right Play Submenu Select Select+Left Select+Submenu Move Left Move Right Move Up Move Down Switch between circle and square Previous level Reset level Select+Right Next level Long Home Exit the game 12.1.32. Sudoku Figure 12.28.: Sudoku Sudoku in Rockbox can act as both a plugin and a viewer.
Chapter 12. Plugins scratchpad and press the scratchpad button, the number will then be added. If the number was already on the scratchpad it will get removed again. The column is stored separately for every cell on the board. The stored values can be displayed inline as small dots by enabling the Show Markings settings. b Note: The scratchpad is not saved when saving the game.
Chapter 12. Plugins Game controls: Key Action Left Right Play Submenu Turn Turn Turn Turn left right Up Down The game Use the control keys of your worm to navigate around obstacles and find food. Worms do not stop moving except when dead. Dead worms are no fun. Be careful as your worm will try to eat anything that you steer it across. It won’t distinguish whether it is edible or not. Food. The small square hollow pieces are food. Move the worm over a food tile to eat it.
Chapter 12. Plugins The scoreboard On the right side of the game field is the score board. For each worm it displays its status and its length. The top most entry displays the state of worm 1, the second worm 2 and the third worm 3. When a worm dies its entry on the score board turns black. Len: Here the current length of the worm is displayed. When a worm is eating food it grows by one pixel for each step it moves. Hungry: That’s the normal state of a worm. Worms are always hungry and want to eat.
Chapter 12. Plugins 12.1.34. Xobox Figure 12.30.: Xobox Xobox is a simple clone of the well known arcade game Qix. The aim of the game is to section off parts of the arena with your trail in order to remove that section from the game. Be careful not to get in the way of enemy balls because, if they hit you or your trail, you lose a life. To finish a level you have to section off more than 75%. Key Action Left, Right Select Long Home Move around the arena Pause Open menu 12.1.35.
Chapter 12. Plugins 12.2. Demos 12.2.1. Bounce Figure 12.31.: Bounce This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background. In Scroll mode the bouncing text is replaced by a different one scrolling from right to left. Key Action Play/ Submenu Scroll Forward / Scroll Backward Select Home or Long Home Moves to next/previous option Increases/decreases option value Toggles Scroll mode Exits bounce demo Available options are: Xdist/Ydist.
Chapter 12. Plugins 12.2.3. Cube Figure 12.32.: Cube This is a rotating cube screen saver in 3D. Key Action Select Play Submenu Right / Left Scroll Forward / Scroll Backward Display at maximum frame rate Pause Cycle draw mode Select axis to adjust Change speed/angle (speed can not be changed while paused) Long Home Quit 12.2.4. Demystify Figure 12.33.: Demystify Demystify is a screen saver like demo.
Chapter 12. Plugins Key Action Scroll Backward / Scroll Forward Play / Submenu Home Increase / decrease speed Add / remove polygon Quit 12.2.5. Fire Figure 12.34.: Fire Fire is a demo displaying a fire effect. Key Action Scroll Forward / Scroll Backward Left Right Home Increase / decrease number of flames Toggle flame type Toggle moving flames Quit 12.2.6. Fractals Figure 12.35.
Chapter 12. Plugins This demonstration draws fractal images from the Mandelbrot set. Key Action Direction keys Scroll Forward Move about the image Zoom in Scroll Backward Zoom out Select+Right Decrease iteration depth (less detail) Increase iteration depth (more detail) Long Select Long Home Reset and return to the default image Quit 12.2.7. Logo Demo showing the Rockbox logo bouncing around the screen.
Chapter 12. Plugins Key Action Play Change the gap between the drawing lines. Restart the drawing process. Exits Mosaique demo Select Home or Long Home 12.2.9. Oscilloscope Figure 12.37.: Oscilloscope This demo shows the shape of the sound samples that make up the music being played. At faster speed rates, the player is less responsive to user input and music may start to skip.
Chapter 12. Plugins 12.2.10. PictureFlow Figure 12.38.: PictureFlow PictureFlow provides a visualisation of your albums with their associated cover art. It is possible to start playback of the selected album from PictureFlow. Playback will start from the selected track. The PictureFlow plugin will continue to run while your tracks are played. Requirements PictureFlow uses both the album art (see section C (page 185)) and database (see section 4.2 (page 27)) features of Rockbox.
Chapter 12. Plugins Playback Control. Control music playback from within the plugin. Settings. Enter the settings menu. Return. Exit menu. Quit. Exit PictureFlow plugin. Settings Menu Show FPS. Displays frames per second on screen. Spacing. The distance between the front edges of the side slides, i.e. changes the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom. Centre margin.
Chapter 12. Plugins Key Action Play / Submenu/ Scroll Forward / Scroll Backward Select Home / Long Home Increase / decrease Frequency Change Color 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). Just “play” such file and the game configuration stored in it will be loaded into this plugin. A .
Chapter 12. Plugins This demo replicates snow falling on your screen. If you love winter, you will love this demo. Or maybe not. Press Home or Long Home to quit. 12.2.14. Starfield Figure 12.41.: Starfield Starfield simulation (like the classic screensaver). Key Action Right / Left Play / Submenu Select Home or Long Home Increase / decrease number of stars Increase / decrease speed Change colours Quit 12.2.15. VU meter Figure 12.42.
Chapter 12. Plugins 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. Key Action Long Home Long Select Select Scroll Forward Scroll Backward Save settings and quit Help Settings Raise Volume Lower Volume 12.3. Viewers Viewers are plugins which are associated with specific file extensions.
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 12.3.3. Frotz Frotz is a Z-Machine interpreter for playing Infocom’s interactive fiction games, and newer games using the same format. To start a game open a .z1 - .z8 file in the File 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.
Chapter 12. Plugins Format File-extension(s) BMP JPEG PNG GIF PPM .bmp .jpg, .jpe, .jpeg .png .gif .ppm Note: When an audio file is playing the size of the image is limited as the decoding process needs to share memory with audio tracks. To be able to view a bigger file you may need to stop playback.
Chapter 12. Plugins in various “unsupported xx” messages. Processing could also fail if the image is too big to decode which will be explained by a respective message. Supported PPM files are both ASCII PPM (P3) and raw PPM (P6). For more information about PPM files, see http://netpbm.sourceforge.net/doc/ppm.html 12.3.5. Lua scripting language To quote from the Lua website (http://www.lua.org), Lua is a “powerful, fast, lightweight, embeddable scripting language”. Select a .
Chapter 12. Plugins 12.3.7. MPEG Player The Mpeg Player is a video player plugin capable of playing back MPEG-1 and MPEG-2 video streams with MPEG audio multiplexed into .mpg files. To play a video file, you just select it in the Rockbox File Browser. If your file does not have the .mpg extension but is encoded in the supported format, you will need to use the Open With... context menu option and choose mpegplayer.
Chapter 12. Plugins Audio Options Open Audio Options submenu – see below. Resume Options (default: Start menu) Enable/disable the start menu. Play Mode (default: Single) Set to All to play multiple .mpg files in the directory continuously. Clear all resumes: x Discard all x resume points. Display Options Menu Dithering (default: off) Prevent banding effects in gradients by blending of colours.
Chapter 12. Plugins 12.3.8. MP3 Encoder This plugin encodes a .wav file to MP3 format. The supported input format is uncompressed, linear PCM with 16 bit per sample and a maximum of 2 channels. Allowed sample rates are 16, 22.05, 24, 32, 44.1 and 48 kHz. The user will be asked to select the desired output bitrate of the compressed MP3 file. Select Bitrate The following bitrates can be selected: 64, 80, 96, 112, 128, 160, 192, 224, 256, 320 kbps.
Chapter 12. Plugins Default keys Key Action Play / Submenu Left / Right Select Home Scroll Backward Direction keys Scroll Forward Select Power Open Rockboy menu A button B button Start Rockboy menu Load Game. . . Loads a previously saved game. Save Game. . . Saves your current state. Options. . . Max Frameskip. Change frameskip setting to improve speed. Sound. Toggle sound on or off. Stats. Toggle showing fps and current frameskip. Set Keys (BUGGY) Select this option to set a new keymapping.
Chapter 12. Plugins 12.3.11. Shopper Shopper is a shopping list plugin which allows you to maintain reusable shopping lists. 12.3.12. 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.10 (page 44)). 12.3.13. Text Viewer Figure 12.44.: Text Viewer This is a Viewer for text files with word wrap. Just open a .txt or .nfo file to display it.
Chapter 12. Plugins Default keys Key Action Play Submenu Left Scroll Backward Scroll-up Scroll-down Top of file (Narrow mode) / One screen left (Wide mode) Bottom of file (Narrow mode) / One screen right (Wide mode) One line up Scroll Forward Submenu+Select One line down Toggle autoscroll Play+Select Long Select Long Home Set/Reset bookmarks Enter menu Exit text viewer Right Menu Return Return to the file being viewed. Viewer Options Change settings for the current file.
Chapter 12. Plugins Screens Per Page Set the number of screens per page. Available options are 1 to 5 screens per page. Alignment Set the text alignment. Right Set the text alignment to the right. (Useful for displaying right-to-left languages, such as Arabic or Hebrew) Left Set the text alignment to the left. Show Header Select whether to show the header. The header displays the file path. No Do not display the header. Yes Display the header. Show Footer Select whether to show the footer.
Chapter 12. Plugins Scroll by Page Scroll up or down one full screen. Scroll by Line Scroll up or down one line. Overlap Pages Set whether the last line from the previous screen is retained when scrolling pages. No Do not retain previous line. Yes Retain previous 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.
Chapter 12. Plugins Bookmarks To add a bookmark, press Play+Select. The bookmark will be displayed as shown below. To delete the bookmark press the same button again. Figure 12.46.: A bookmark 12.3.14. Theme Remove This plugin offers a way to remove a theme. Open the Context Menu (see section 4.1.2 (page 24)) 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 and the font file currently in use.
Chapter 12. Plugins WPS. Specifies how the .wps file belonging to a theme .cfg file is handled. Statusbar Skin. Specifies how the .sbs file belonging to a theme .cfg file is handled. Backdrop. Specifies how the backdrop .bmp file belonging to a theme .cfg file is handled. Iconset. Specifies how the iconset .bmp file belonging to a theme .cfg file is handled. Viewers Iconset. Specifies how the viewers iconset .bmp file belonging to a theme .cfg file is handled. Filetype Colours.
Chapter 12. Plugins .sna in the file browser. Note: As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible. b Default keys The emulator is set up for 5 different buttons: Up, Down, Left, Right and Jump/Fire. Each one of these can be mapped to one key of the Spectrum Keyboard or they can be used like a “Kempston” joystick.
Chapter 12. Plugins Frameskip Sets the number of frames to skip before displaying one. With zero frameskip ZXBox tries to display 50 frames per second. Sound. Turns sound on or off. Volume. Controls volume of sound output. Predefined Keymap Select one of the predefined keymaps. For example 2w90z means: map ZXBox’s Up to 2, Down to w, Left to 9, Right to 0 and Jump/Fire to z. This example keymap is used in the “Chuckie Egg” game.
Chapter 12. Plugins 12.4.2. Battery Benchmark The Battery Benchmark plugin enables you to test your battery’s performance whilst using your player normally. Results can be submitted to the ZBatteryRuntime wiki page. How it works Once loaded, Battery Benchmark runs in the background recording various information about your battery to memory. A new point is written to memory every minute.
Chapter 12. Plugins Usage The log file can be used to tell you how long the battery lasted (with some limitations, see below), but it is most useful for graphing discharge curves in order to improve Rockbox’s estimation of battery level and time remaining. The battery log (battery_bench.txt) is in CSV format (comma separated variables) and thus can be easily imported into a spreadsheet or similar program.
Chapter 12. Plugins 12.4.4. Calendar Figure 12.49.: Calendar This is a small and simple calendar application with memo saving function. Dots indicate dates with memos. The available memo types are: one off, yearly, monthly, and weekly memos. You can select what day is first day of week by the setting First Day of Week in the menu.
Chapter 12. Plugins 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. Setup Key Action Right / Left Select Long Home Increase / decrease displayed Value Move to next screen Move to previous screen • First enter the number of players (1–10) • Then set the total game time in mm:ss • Then the maximum round time is entered.
Chapter 12. Plugins 12.4.6. Clock Figure 12.51.: Clock This is a fully featured analogue and digital clock plugin. Key configuration Key Action Left / Right Play / Submenu Home Select Long Select Cycle through modes Cycle through skins Main Menu Start / Stop Counter Reset Counter 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.
Chapter 12. Plugins Idle Poweroff Toggle Idle Poweroff. b Note: This setting is not saved to disk. Help Opens a brief help screen with key mappings and functionality. Credits Displays a credits roll. Analog mode Small, round, analog clock is displayed in the middle of the LCD. Time readout, if enabled, is displayed at the upper left. If Time readout is in 12-hour (“12h”) mode, AM or PM will be displayed at the upper right. The Date readout, if enabled, is displayed at the lower left.
Chapter 12. Plugins enabled, draws empty and full circles, instead of zeros and ones. For help on reading binary, please visit: http://en.wikipedia.org/wiki/Binary_numeral_system Plain mode This mode shows a “plain” clock in large text that takes up nearly the whole LCD. 12.4.7. Disk Tidy Disk Tidy deletes junk files commonly left behind by Windows, Linux and OS X after connecting your player over USB.
Chapter 12. Plugins Using Keybox To get started, start up the plugin and select Enter Keybox. The first time you enter Keybox you will be prompted for a master password and for confirmation of the master password. The master password is the password that you must use to access your stored passwords. Once inside, enter the context menu by pressing Long Select. From the context menu you can create new entries, delete entries and edit entries. Each entry has a “title”, a “user name” and a “password”.
Chapter 12. Plugins Supported tags and formats for .lrc files The following tags are supported: [ti:title] [ar:artist] [offset:offset (msec)] Each line should resemble one of the following: [time tag]line [time tag]...[time tag]line [time tag]word... The time tag must be in the form [mm:ss], [mm:ss.xx], or [mm:ss.xxx] where mm is minutes, ss is seconds, xx is tenth of milliseconds, and xxx is milliseconds.
Chapter 12. Plugins Controls Key Action Scroll Forward / Scroll Backward Left Volume up/down. Long Left Right Long Right Play Long Play or Select Long Select Submenu 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. Exit the plugin. Enter timetag editor. Enter Lrcplayer Menu. Lrcplayer Menu Theme settings. Change theme related settings. Show Statusbar.
Chapter 12. Plugins Playback Control. Show the playback control menu. Time Offset. Set an offset for the time tags for the lyrics currently in use. Timetag Editor. Enter the timetag editor. Quit. Exit the plugin. Editing the time tags The display time for each line can be changed with the timetag editor. Selecting a line changes its time to the current position of the track. To set a specific time or to adjust the time, press Long Select to bring up a screen to adjust the time.
Chapter 12. Plugins Programmed Track Mode When starting the plugin as a viewer for tempomap files (ending in .tempo), it starts in the track mode that offers playback of a preprogrammed metronome track consisting out of multiple parts, each with possibly different properties. In contrast to the simple mode, there exists the notion of meter and bars, along with emphasis on certain beats.
Chapter 12. Plugins The syntax of programmed tracks in tempomap files follows the format defined by http://das.nasophon.de/klick/. Actually, the goal is to keep compatibility between klick and this Rockbox metronome. The parts of a track are specified one line each in this scheme (pieces in [] optional): [name:] bars [meter ]tempo[-tempo2[*accel|/accel] [pattern] [volume] The bar count and tempo always have to be specified, the rest is optional.
Chapter 12. Plugins 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. The UI is developed so that it fits into the display of a Sansa Clip+ and that is the hardware device it is tested on. It seems to work reasonably on some other models in the simulator.
Chapter 12. Plugins 12.4.15. 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.16. Resistor Calculator Figure 12.52.: 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 12.4.17. Rockpaint Figure 12.53.: Rockpaint Rockpaint is a bitmap (.bmp) editor for Rockbox. It can open any .bmp file whose dimensions are the same size as your device’s screen or smaller; it can also create empty bitmaps for you to work with. Opening A File To open a file, you may use either the context menu option “Open With” in the File Browser, or you may enter Rockpaint first using the Plugins menu and open a file from there.
Chapter 12. Plugins Curve tool Allows you to draw a line and curve it. Rectangle tool Draws an unfilled rectangle. Circle tool Draws an unfilled circle. Gradient fill To use this tool, click at the starting and ending points. Starting with the background and going to the foreground colour, Rockpaint will fill the region with a gradual colour change. Bucket fill Fills an same-colour or empty region with a colour. Dropper Click on a colour in the image to change the foreground colour to it.
Chapter 12. Plugins Choose colour Allows you to manually edit the foreground colour. You can edit the RBG and/or the HSV values. Grid size Allows you to show or hide a grid over the canvas, and to specify its size. Exit Exits Rockpaint. Warning: BE CAREFUL. Rockpaint will NOT prompt you to save if you select Exit, so any unsaved changes will be lost. Key Action Long Home Left / Right / Play / Submenu Quits Rockpaint immediately. Moves the cursor around.
Chapter 12. Plugins 12.4.19. Stopwatch Figure 12.55.: Stopwatch A simple stopwatch program with support for saving times. Key Action Long Home Right Left Select Play / Submenu Quit Plugin Start / stop Reset timer (only when timer is stopped) Take lap time Scroll through lap times 12.4.20. Text Editor This plugin allows you to view and edit simple text documents on your DAP. You can view files by using Open with from the Context Menu (see section 4.1.2 (page 24)).
Chapter 12.
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 165 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 166 mp2, mp3, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, spc, ape, mac, sap, mpg, mpeg, bmp, fmr, fnt, kbd All file extensions that are not either specifically listed in the .colours files or are not in the list above will be set to the colour given by ???. Extensions that are in the above list but not in the .colours file will be set to the foreground colour as normal.
Chapter 13. Advanced Topics 13.1.7. UI Viewport By default, the UI is drawn on the whole screen. This can be changed so that the UI is confined to a specific area of the screen, by use of a UI viewport. This is done by adding the following line to the .cfg file for a theme: ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour] Only the first two parameters have to be specified, the others can be omitted using ‘-’ as a placeholder. The syntax is very similar to WPS viewports (see section 13.
Chapter 13. Advanced Topics Files Locations: Each different “themeable” aspect requires its own file – WPS files have the extension .wps, FM screen files have the extension .fms, and SBS files have the extension .sbs. The main theme file has the extension .cfg. All files should have the same name. The theme .cfg file should be placed in the /.rockbox/themes directory, while the .wps, .fms and .sbs files should be placed in the /.rockbox/wps directory.
Chapter 13. Advanced Topics • ‘fgcolour’ and ‘bgcolour’ are 6-digit RGB888 colours, e.g. FF00FF. • %Vg defines a gradient fill that can then be used with the %Vs tag. ‘start’ and ‘end’ set the initial and final colours, and the optional ‘text’ sets the text colour. Colours are 6-digit RGB888, e.g. FF00FF. • ‘font’ is a number: 0 is the built-in system font, 1 is the current menu font, and 2-9 are additional skin loaded fonts (see section 13.2.4 (page 171)). • Only the coordinates have to be specified.
Chapter 13. Advanced Topics 170 Conditional Viewports Any viewport can be displayed either permanently or conditionally. Defining a viewport as %V(... will display it permanently. • %Vl(’identifier’,...) This tag preloads a viewport for later display. ‘identifier’ is a single lowercase letter (a-z) and the ‘. . . ’ parameters use the same logic as the %V tag explained above. • %Vd(’identifier’) Display the ‘identifier’ viewport.
Chapter 13. Advanced Topics 13.2.4. Additional Fonts Additional fonts can be loaded within each screen file to be used in that screen. In this way not only can you have different fonts between e.g. the menu and the WPS, but you can use multiple fonts in each of the individual screens. %Fl(’id’,filename,glyphs) • ‘id’ is the number you want to use in viewport declarations, 0 and 1 are reserved and so can’t be used. • ‘filename’ is the font filename to load. Fonts should be stored in /.
Chapter 13. Advanced Topics 172 be available at the end of a song. We suggest you use the conditional display tag a lot when displaying information about the next song! Alternating Sublines It is possible to group items on each line into 2 or more groups or “sublines”. Each subline will be displayed in succession on the line for a specified time, alternating continuously through each defined subline. Items on a line are broken into sublines with the semicolon ‘;’ character.
Chapter 13. Advanced Topics Using Images You can have as many as 52 images in your WPS. There are various ways of displaying images: 1. Load and always show the image, using the %x tag 2. Preload the image with %xl and show it with %xd. This way you can have your images displayed conditionally. 3. Load an image and show as backdrop using the %X tag. The image must be of the same exact dimensions as your display. Example on background image use: Example %X(background.
Chapter 13. Advanced Topics while playing your jukebox in your car, and a headphones.cfg file to store the settings that you use while listening to your player through headphones. See section 13.3.2 (page 174) below for an explanation of the format for configuration files. See section 13.3.3 (page 175) for an explanation of how to create, edit and load configuration files. 13.3.2. Specifications for .cfg Files The Rockbox configuration file is a plain text file, so once you use the Save .
Chapter 13. Advanced Topics 175 13.3.3. The Manage Settings menu The Manage Settings menu can be found in the Main Menu. The Manage Settings menu allows you to save and load .cfg files. Browse .cfg Files Opens the File Browser in the /.rockbox directory and displays all .cfg (configuration) files. Selecting a .cfg file will cause Rockbox to load the settings contained in that file. Pressing Left will exit back to the Manage Settings menu. See the Write .
Chapter 13. Advanced Topics 176 13.5.1. Display backlight The active backlight consumes a lot of power. Therefore choose a setting that disables the backlight after timeout (for setting Backlight see section 8.4 (page 64)). Avoid to have the backlight enabled all the time. 13.5.2. Replaygain Replaygain is a post processing that equalises the playback volume of audio files to the same perceived loudness.
Appendix A.
Appendix A. File formats A. File formats A.1. Supported file formats Icon File Type Extension Action when selected Directory Audio file Bookmark none various (see B.1) .bmark Game of Life .cells Configuration File .cfg Enter the directory Start playing the file and show the WPS Display all bookmarks for an audio file Show the configuration with the “Rocklife” plugin Load the settings file Chip8 game Colours .ch8 .colours Cuesheet FM Presets .cue .fmr Font .fnt Image Link .jpg .
Appendix B. Audio and metadata formats B. Audio and metadata formats B.1. Supported audio formats B.1.1. Lossy Codecs Format Extension Notes ATSC A/52 (AC3) .a52, .ac3, .rm, .ra, .rmvb .adx Supports downmixing for playback of 5.1 streams in stereo ADX Advanced Audio Coding Musepack .m4a, .m4b, .mp4, .rm, .ra, .rmvb .mpa, .mp1, .mp2, .mp3 .mpc OGG/Vorbis .ogg, .oga Sony Audio .oma, .aa3, .rm, .ra, .rmvb .rm, .ra, .rmvb .spx .vox .wma, .wmv, .asf .wma, .wmv, .
Appendix B. Audio and metadata formats mance requirements. B.1.2. Lossless Codecs Format Extension Notes Audio Interchange File Format .aif, .aiff Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.711 alaw/µ-law, QuickTime IMA ADPCM Monkey’s Audio Sun Audio .ape, .mac .au, .snd Free Lossless Audio .flac Apple Lossless Shorten True Audio Wave64 .m4a, .mp4 .shn .tta .w64 Waveform audio format .wav Wavpack .wv Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.
Appendix B. Audio and metadata formats B.1.3. Other Codecs Format Extension Atari Sound Format Synthetic music Mobile Application Format Game Boy Sound Format .cmc, .cmr, .dmc, .mpt, .mmf .gbs AY Sound Chip Music .ay Hudson Entertainment System Sound Format .hes MSX Konami Sound System .kss SMS/GG/CV Sound Format .sgc Video Game Music Format Gzipped Video Game Music Format MOD NES Sound Format .vgm .vgz .mod .nsf, .nsfe Atari SAP Sound Interface Device .sap .sid SPC700 .spc Notes .
Appendix B. Audio and metadata formats B.1.4.
Appendix B. Audio and metadata formats B.2. Supported metadata tags Rockbox supports different metadata formats. In general those tag formats are ID3 (v1.0, v1.1, v2.2, v2.3 and v2.4), APE (v1 and v2), Vorbis, MP4 and ASF. Few codecs use codec specific tags, several codecs do not use any tags yet. The following table gives an overview about what tag types rockbox supports for which audio file extension. Note: There is always only one tag type supported for each file extension.
Appendix B. Audio and metadata formats 184 B.2.2. Featureset for codec specific metadata Feature Codec specific metadata (file extension) Embedded .bmp Embedded .jpg Embedded .png Replaygain Title None None None .mpc .tta, .spc, .mmf, .sid, .rm, .ra, .rmvb, .nsf, .nsfe, .mod, .sap, .gbs, .ay, .sgc, .vgm .tta, .spc, .mmf, .sid, .rm, .ra, .rmvb, .nsf, .nsfe, .sap, .gbs, .ay, .sgc, .vgm .spc, .sid, .nsf, .nsfe, .gbs, .ay, .sgc, .vgm .tta, .spc, .sap .tta .tta .spc, .sid, .sap .mmf .spc, .rm, .ra, .rmvb, .
Appendix C. Album Art 185 C. 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 or in the theme. For this feature to work, there are a few requirements. C.1. Limitations Rockbox supports embedded album art only for some specific formats, see section B.2.1 (page 183) for full details. It additionally supports loading images located on the flash storage. PictureFlow is currently unable to use embedded album art.
Appendix C. Album Art 186 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 D. Theme Tags D. Theme Tags Themeing is discussed in detail in section section 13.2 (page 167), 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 D.28 (page 201). D.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 D. Theme Tags 188 D.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 D. Theme Tags 189 D.5. Additional Fonts Tag Description %Fl(’id’,filename) See section 13.2.4. D.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. D.7. Power Related Information Tag Description %bl Numeric battery level in percents.
Appendix D. Theme Tags 190 D.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 D. Theme Tags D.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 D. Theme Tags 192 • ‘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 D. Theme Tags D.14. Virtual LED Tag Description %lh “h” if the flash storage is accessed D.15. Repeat Mode Tag Description %mm Repeat mode, 0-4, in the order: Off, All, One, Shuffle, A-B Example: %?mm D.16. 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 D.17.
Appendix D. Theme Tags Number Screen 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Menus WPS Recording screen FM Radio screen Current Playlist screen Settings menus File browser Database browser Plugin browser Quickscreen Pitchscreen Setting chooser Playlist Catalogue Viewer Plugin Context menu System Info screen Time and Date Screen Bookmark browser Shortcuts menu Track Info screen 194 The tag can also be used as the switch in a conditional tag. For players without certain capabilities (e.g.
Appendix D. Theme Tags D.19. 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. after the volume button has been released. The optional parameter t specifies that amount of time, in seconds. If it is not specified, 1 second is assumed. The tag can be used as the switch in a conditional tag to display different things depending on whether the volume is being changed.
Appendix D. Theme Tags 196 D.21. Images Tag Description Load and set a backdrop image for the WPS. This image must be exactly the same size as your LCD. %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 D. Theme Tags 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 D. Theme Tags 2. Load albumart at position 0,20 and resize it to be at most 100×100 pixels. If the image isn’t square, align it to the bottom-right corner: %Cl(0,20,100,100,r,b) For general information where to put album art see section C (page 185). D.22. FM Radio Tag Description %tt %tm %ts %ta %tb %tf %Ti Is the tuner tuned? Scan or preset mode? Scan is “true”, preset is “false”. Is the station in stereo? Minimum frequency (region specific) in MHz.
Appendix D. Theme Tags 199 D.23. 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 D. 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. D.25. Subline Tags Tag Description %t(time) ; Set the subline display cycle time (%t(5) or %t(3.
Appendix D. Theme Tags 201 D.27. Text Translation Tag Description %Sx(English) Display the translation of “English” in the current language • “English” must be a phrase used in the language file. • It should match the Source: line in the language file. Note: checkwps cannot verify that the string is correct, so please check on either the simulator or on target. D.28. Bar Tags Some tags can be used to display a bar which draws according to the value of the tag.
Appendix D. Theme Tags nofill – don’t draw the bar, only its frame (for use with the “slider” option). noborder – don’t draw the border for image-less bars, instead maximise the filling over the specified area. This doesn’t work for bars which specify an image. nobar – don’t draw the bar or its frame (for use with the “slider” option). setting – Specify the setting name to draw the bar from (bar must be %St type), the next param is the settings config name.
Appendix D. Theme Tags 203 Tag Description %( %) %, %% %< %| %> %; %# %s The character ‘(’ The character ‘)’ The character ‘,’ The character ‘%’ The character ‘<’ The character ‘|’ The character ‘>’ The character ‘;’ The character ‘#’ Indicate that the line should scroll. Can occur anywhere in a line (given that the text is displayed; see conditionals above). You can specify up to ten scrolling lines. Scrolling lines can not contain dynamic content such as timers, peak meters or progress bars.
Appendix E. Config file options E.
Appendix E. 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 get ranges from config-*.
Appendix E. Config file options Setting Allowed Values Unit use most-recent-bookmarks pause on headphone unplug rewind duration on pause disable autoresume if phones not present Last.
Appendix E.
Appendix E.
Appendix E.
Appendix F. Menu Overview 210 F.
Appendix G. User feedback 211 G. User feedback G.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 G.1.1. Rules for submitting new bug reports 1. Check that the bug has not already been reported 2.
Appendix G. User feedback 212 G.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! • 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 H. Credits H. Credits People that have contributed to the project, one way or another.
Appendix H. 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 H. 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 H.
Appendix I. Licenses I. Licenses I.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 I. 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 I. 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 I. 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 I. 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 I. 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 I. 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 I. 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 I. Licenses I.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 I. 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 I. 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 I. 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 I. 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 I. 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 I. 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.
