The Rockbox Manual for Cowon D2 rockbox.
Rockbox http://www.rockbox.org/ Open Source Jukebox Firmware Rockbox and this manual is the collaborative effort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2013 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 José Maria Garcia-Valdecasas Bernal & Peter Schlenker. Version rUnversioned. Built using pdfLATEX.
Contents Contents 1. Introduction 1.1. Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2. Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3. Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 11 11 11 12 2. Installation 2.1. Before Starting . . . . . . . . . . . . . . . . 2.2. Installing Rockbox . . . . . . . . . . . . . . 2.2.1. Automated Installation . . . . . . . 2.2.2. Manual Installation . . . . . . .
Contents 4.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. Modifying playlists . . . . 4.4.5.
Contents 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 . . . . . . . . . . 7. Playback Settings 7.1. Shuffle . . . . . . . . . . 7.2. Repeat . . . . . . . . . . 7.3. Play Selected First . . . 7.4.
Contents 8.6.2. Idle Poweroff 8.6.3. Sleep Timer . 8.7. Bookmarking . . . . 8.8. Automatic resume . 8.9. Language . . . . . . 8.10. Voice . . . . . . . . . 8.11. Hotkey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 11.1.31.Star . . . . . . . . . . 11.1.32.Sudoku . . . . . . . . 11.1.33.Wormlet . . . . . . . . 11.1.34.Xobox . . . . . . . . . 11.1.35.XWorld . . . . . . . . 11.2. Demos . . . . . . . . . . . . . 11.2.1. Bounce . . . . . . . . 11.2.2. Credits . . . . . . . . 11.2.3. Cube . . . . . . . . . . 11.2.4. Demystify . . . . . . . 11.2.5. Fire . . . . . . . . . . 11.2.6. Fractals . . . . . . . . 11.2.7. Logo . . . . . . . . . . 11.2.8. Mosaique . . . . . . . 11.2.9. Oscilloscope . . . . . . 11.2.10.
Contents 11.4.6. Clock . . . . . . . . . . 11.4.7. Disk Tidy . . . . . . . . 11.4.8. Keybox . . . . . . . . . 11.4.9. Lamp . . . . . . . . . . 11.4.10.Lrcplayer . . . . . . . . 11.4.11.md5sum . . . . . . . . . 11.4.12.Metronome . . . . . . . 11.4.13.Periodic Table . . . . . 11.4.14.Random Folder Advance 11.4.15.Resistor Calculator . . . 11.4.16.Rockpaint . . . . . . . . 11.4.17.Stats . . . . . . . . . . . 11.4.18.Stopwatch . . . . . . . . 11.4.19.Text Editor . . . . . . . . . . . . . . . . . . . . . . .
Contents B. Audio and metadata formats B.1. Supported audio formats . . . . . . . . . . . . B.1.1. Lossy Codecs . . . . . . . . . . . . . . B.1.2. Lossless Codecs . . . . . . . . . . . . . B.1.3. Other Codecs . . . . . . . . . . . . . . B.1.4. Codec featureset . . . . . . . . . . . . B.2. Supported metadata tags . . . . . . . . . . . B.2.1. Featureset for generic metadata tags . B.2.2. Featureset for codec specific metadata B.2.3. Limitations of metadata handling . . . . . . . . . . . . . . . . . . . .
Contents D.28.Touchscreen Areas . . . D.28.1. Options . . . . . D.29.Last Touchscreen Press D.30.Bar Tags . . . . . . . . . D.30.1. Options . . . . . D.31.Other Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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. Rockbox runs on all Cowon D2 and D2+ variants (2 / 4 / 8 / 16 GB, with or without DAB/DMB). Note: Newer D2+ hardware revisions use an updated power management chip, and some functionality is not yet implemented on these players (e.g. touchscreen support). b Current limitations.
Chapter 2. Installation 2.2. Installing Rockbox There are two ways to install Rockbox: automated and manual. The automated way is the preferred method of installing Rockbox for the majority of people. Rockbox Utility is a graphical application that does almost everything for you. However, should you encounter a problem, then the manual way is still available to you. There are two separate components which need to be installed in order to run Rockbox: The Rockbox bootloader.
Chapter 2. Installation Prebuilt binaries for Windows, Linux and Mac OS X are available at the ZRockboxUtility wiki page. When first starting Rockbox Utility run “Autodetect”, found in the configuration dialog (File → Configure). Autodetection can detect most player types. If autodetection fails or is unable to detect the mountpoint, make sure to enter the correct values. The mountpoint indicates the location of the player in your filesystem.
Chapter 2. Installation then you do not need to follow the next section and can skip straight to section 2.2.3 (page 17) Installing the firmware 1. Download your chosen version of Rockbox from the links in the previous section. 2. Connect your player to the computer via USB as described in the manual that came with your player. 3. Take the .
Chapter 2. Installation FW / HW 1.xx, 4.xx 2.xx, 3.xx D2 D2+ D2.bin D2N.bin D2_P.bin D2N_P.bin 5. Copy the output file (“D2N-patched.bin” in our example) to the root of the player’s internal memory and rename it according to the above table. 2.2.3. Finishing the install Safely eject / unmount the USB drive, unplug the cable and restart. 2.2.4. Enabling Speech Support (optional) If you wish to use speech support you will also need a voice file.
Chapter 2. Installation 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 Power / Hold Minus Menu Plus PORTABLE MULTIMEDIA PLAYER Throughout this manual, the buttons on the player are labelled according to the picture above.
Chapter 3. Quick Start 3.1.2. Turning the player on and off Rockbox has a dual-boot feature with the original firmware being the default. To turn on and off your Rockbox enabled player use the following keys: Key Action Power, then Hold Long Power Start Rockbox Shutdown Rockbox On shutdown, Rockbox automatically saves its settings. 3.1.3. Starting the original firmware Use Power to boot the original Cowon firmware. 3.1.4.
Chapter 3. Quick Start 21 tree view use Plus or Bottom-Middle and Minus or Top-Middle to move around the selection. Use Menu or Centre or Middle-Right to select an item. When browsing the file system selecting an audio file plays it. The view switches to the “While playing screen”, usually abbreviated as “WPS” (see section 4.3 (page 29). The dynamic playlist gets replaced with the contents of the current directory. This way you can easily treat directories as playlists.
Chapter 3. Quick Start 22 Note: Some of the themes shipped with Rockbox need additional fonts from the fonts package, so make sure you installed them. Also, if you downloaded additional themes from the Internet make sure you have the needed fonts installed as otherwise the theme may not display properly. b 3.3. USB Charging To charge your player over USB, hold any button while plugging it in. This will prevent it from connecting to your computer and let you continue to use it normally.
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 24 4.1.1. File Browser Controls Key Action Minus or TopMiddle/Plus or Bottom-Middle Middle-Left Menu or Centre or Middle-Right Plus+Menu or Top-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.
Chapter 4. Browsing and playing The Context Menu allows you to perform certain operations on files or directories. To access the Context Menu, position the selector over a file or directory and access the context menu with Long Menu or Long Centre or Long Middle-Right. Note: The Context Menu is a context sensitive menu. If the Context Menu is invoked on a file, it will display options available for files. If the Context Menu is invoked on a directory, it will display options for directories.
Chapter 4. Browsing and playing Properties. Shows properties such as size and the time and date of the last modification for the selected file. If used on a directory, the number of files and subdirectories will be shown, as well as the total size. Start File Browser Here. This option allows users to set the currently selected directory as the default start directory for the file browser. This option is not available for files.
Chapter 4. Browsing and playing Key Action Middle-Left / Middle-Right Move the cursor on the virtual keyboard. If you move out of the picker area, you get the previous/next page of characters (if there is more than one). Move the cursor on the virtual keyboard. If you move out of the picker area you get to the line edit mode. Flip to the next page of characters (if there is more than one). Insert the selected keyboard letter at the current line cursor position.
Chapter 4. Browsing and playing If a subdirectory of an ‘ignored’ directory should still be scanned, place a file named database.unignore in it. The files in that directory and its subdirectories will be scanned and added to the database. 4.2.3. The Database Menu Auto Update If Auto update is set to on, each time the player boots, the database will automatically be updated.
Chapter 4. Browsing and playing lists of tracks in the ID3 database browser. There is no option to turn off database completely. If you do not want to use it just do not do the initial build of the database and do not load it to RAM.
Chapter 4. Browsing and playing 30 repeat mode, shuffle mode and clock. In contrast to all other items, the status bar is always at the top of the screen. • (Scrolling) path and filename of the current song. • The ID3 track name. • The ID3 album name. • The ID3 artist name. • Bit rate. VBR files display average bitrate and “(avg)” • Elapsed and total time. • A slidebar progress meter representing where in the song you are. • Peak meter. See section 12.
Chapter 4. Browsing and playing 4.3.1. WPS Key Controls Key Action Plus or Top-Middle / Minus or Bottom-Middle Middle-Left Volume up/down. Long Middle-Left Middle-Right Long Middle-Right Centre Long Centre Minus+Power or Top-Right Long Menu or Long Top-Right Menu or Top-Left Bottom-Left Bottom-Right or Short Middle-Right + Long Middle-Right or Short Middle-Left + Long Middle-Left Go to beginning of track, or if pressed while in the first seconds of a track, go to the previous track.
Chapter 4. Browsing and playing The peak indicator: This is a little vertical line at the right end of the bar. It indicates the peak volume value that occurred recently. The clip indicator: This is a little black block that is displayed at the very right of the scale when an overflow occurs. It usually does not show up during normal playback unless you play an audio file that is distorted heavily. Note: Note that the clip detection is not very precise. Clipping might occur without being indicated.
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 49) 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 34 Open With... This Open With function is the same as the Open With function in the file browser’s Context Menu. 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.
Chapter 4. Browsing and playing Key Action Top-Right or Bottom-Right Plus or Top-Middle / Minus or Bottom-Middle Long Plus or Long Top-Middle / Long Minus or Long Bottom-Middle Middle-Left / Middle-Right Toggle pitch changing mode (cycle through all available modes). Increase / Decrease pitch by 0.1% (in procentual mode) or 0.1 semitone (in semitone mode). Centre Power or Top-Left or Bottom-Left 35 Increase / Decrease pitch by 1% (in procentual mode) or a semitone (in semitone mode).
Chapter 4. Browsing and playing 36 between Insert and Queue is that the Queue option removes the song from the playlist once it has been played, and the Insert option does not. 4.4.2. Creating playlists Rockbox can create playlists in four different ways.
Chapter 4. Browsing and playing 4.4.3. Adding music to playlists Adding music to a dynamic playlist Figure 4.5.: The Playlist Submenu The Playlist Submenu is a submenu in the Context Menu (see section 4.1.2 (page 24)), it allows you to put tracks into a “dynamic playlist”. If there is no music currently playing, Rockbox will create a new dynamic playlist and put the selected track(s) into it. If there is music currently playing, Rockbox will put the selected track(s) into the current playlist.
Chapter 4. Browsing and playing Queue Last. Queue track(s) at end of playlist. Queue Shuffled. Queue track(s) in a random order. Queue Last Shuffled. Queue tracks in a random order at the end of the playlist. Play Next. Replaces all but the current playing track with track(s). Current playing track is queued. The Playlist Submenu can be used to add either single tracks or entire directories to a playlist.
Chapter 4. Browsing and playing 39 Either method will bring you to the Virtual Keyboard (see section 4.1.3 (page 26)), enter a filename for your playlist and accept it and you are done. 4.4.6. Loading saved playlists Through the File Browser Playlist files, like regular music tracks, can be selected through the File Browser. When loading a playlist from disk it will replace the current dynamic playlist.
Chapter 5. The Main Menu 40 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 Top-Left 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.2. Navigating the Main Menu Key Action Plus or Bottom-Middle Select the next option in the menu. Inside a setting, increase the value or choose next option. Select the previous option in the menu. Inside a setting,decrease the value or choose previous option. Select option. Minus or Top-Middle Menu or Centre or Middle-Right Power or Middle-Left Exit menu or setting, or move to parent menu. 5.3. Recent Bookmarks Figure 5.2.
Chapter 5. The Main Menu Key Action Plus or Bottom-Middle Minus or Top-Middle Menu or Centre or Middle-Right Power or Middle-Left Bottom-Right Long Menu or Long Centre or Long Middle-Right Select the next bookmark. Select the previous bookmark. Resume from the selected bookmark. Exit Recent Bookmark menu. Delete the currently selected bookmark. Enter the context menu for the selected bookmark.
Chapter 5. The Main Menu 43 predefined available values, you can press Long Menu or Long Centre or Long MiddleRight, and the selection cursor will jump to the default value for the parameter. You can then confirm or cancel the value. This is useful if you have changed the value of the parameter from the default to some other value and would like to restore the default value. 5.7.1.
Chapter 5. The Main Menu 44 5.8. FM Radio Figure 5.3.: The FM radio screen This menu option switches to the radio screen. The FM radio has the ability to remember station frequency settings (presets). Since stations and their frequencies vary depending on location, it is possible to load these settings from a file. Such files should have the filename extension .fmr and reside in the directory /.
Chapter 5. The Main Menu Key Action Middle-Left, Middle-Right Change frequency in SCAN mode or jump to next/previous station in PRESET mode. Seek to next station in SCAN mode. Long Middle-Left, Long Middle-Right Top-Middle or Plus, Bottom-Middle or Minus Top-Left Bottom-Right or Power Top-Right Bottom-Left Long Menu or Centre Menu or Long Centre Change volume. Leave the radio screen with the radio playing. Stop the radio and return to Main Menu. Mute radio playback.
Chapter 5. The Main Menu 5.9. Playlists This menu allows you to work with playlists. Playlists can be created in three ways. Playing a file in a directory causes all the files in it to be placed in a playlist. Playlists can be created manually by either using the Context Menu (see section 4.1.2 (page 24)) or using the Playlist menu. Both automatically and manually created playlists can be edited using this menu.
Chapter 5. The Main Menu Top Time: This item shows the cumulative overall runtime of your player since you last manually reset this item. A manual reset is done through pressing any button, followed by pressing Menu or Centre or Middle-Right. Debug (Keep Out!): This sub menu is intended to be used only by Rockbox developers. It shows hardware, disk, battery status and other technical information.
Chapter 5. The Main Menu 48 • The sleep timer can be configured • The player can be turned off Note: Shortcuts into the database are not possible Shortcuts are loaded from the file /.rockbox/shortcuts.txt which lists each item to be displayed.
Chapter 6. Sound Settings 49 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 50 6.2. Bass This setting emphasises or suppresses the lower (bass) frequencies in the sound. A value of 0 dB means that bass sounds are unaltered (flat response). 6.3. Volume Limit This setting adjusts the maximum volume of your music. The setting is by default set to the maximum volume which equals to no limit. To set a volume limit, select a volume from the list and the maximum volume will be limited to the selected value all over the system. 6.4.
Chapter 6. Sound Settings 51 voice track from a song. This setting also very often has other undesirable effects on the sound. 6.7. Stereo Width Stereo width allows you to manually specify the effect that is applied when the Channels setting is set to “custom”. All values below 100% will progressively mix the contents of one channel into the other. This has the effect of gradually centering the stereo image, until you have monophonic sound at 0%.
Chapter 6. Sound Settings 52 High-Frequency Attenuation. How much the upper frequencies of the cross path audio will be dampened. Note that the total level of the higher frequencies will be a combination of both this setting and the Cross Gain setting. High-Frequency Cutoff. Decides at which frequency the cross path audio will start to be cut by the amount described by the High-Frequency Attenuation setting.
Chapter 6. Sound Settings 53 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 quency range is. Higher Q values will affect a narrower band of frequencies, while lower Q values will affect a wider band of frequencies. Band 9: High shelf filter. A high shelf filter boosts or lowers all frequencies above a certain frequency limit, much as the “treble” control found on ordinary stereo systems does. The high shelf filter is adjusted the same way as the low shelf filter, except that it works on the high end of the frequency spectrum rather than the low end.
Chapter 6. Sound Settings Advanced EQ. This sub menu provides options for adjusting the same parameters as the Graphical EQ. The only difference is that the parameters are adjusted through textual menus rather than through a graphic interface. Save EQ Preset. This option saves the current EQ configuration in a .cfg file. Browse EQ Presets. This menu displays a list of EQ presets, as well as any EQ configurations saved using the Save EQ Preset option.
Chapter 6. Sound Settings 56 one channel and ends in the other. Therefore, four additional functions are provided to move the stage back to the center: Balance to change the left-right channel output ratio. A bypass band for frequencies that mostly contain vocals, using f(x1), and f(x2) to set frequencies which are not affected. The SIDE ONLY setting uses mid-side processing to determine and apply effect to the side channel only.
Chapter 6. Sound Settings 57 The Ratio setting determines how aggressively the compressor reduces gain above the threshold. For example, the 2:1 setting means that for each two decibels of input signal above the threshold, the compressor will only allow the output to appear as one decibel. The higher the ratio, the harder the signal is compressed. The ratio setting of Limit means essentially a ratio of infinity to one. In this case, the output signal is not allowed to exceed the threshold at all.
Chapter 7. Playback Settings 58 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 59 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 60 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 61 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 62 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 26). 7.12. Last.fm Log Enables logging of your played tracks for submittal to http://www.last.fm.
Chapter 7. Playback Settings 63 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 Sort Directories. This option controls how Rockbox sorts directories. The default is to sort them alphabetically. By date sorts them with the oldest directory first. By newest date sorts them with the newest directory first. Sort Files. This option controls how Rockbox sorts files. All of the options for Sort Directories are available in this option. In addition, there is a By type option which sorts files alphabetically by their type (such as .
Chapter 8. General Settings On. The file extensions are always shown. Only unknown types. Only the extensions of unknown filetypes are shown. Only when viewing all types. Only show file extensions when Show Files is set to All. Follow Playlist. This option determines what directory the File Browser displays first. If Follow Playlist is set to Yes, when you enter the File Browser from the WPS, you will find yourself in the same directory as the currently playing file.
Chapter 8. General Settings 67 amount of time is determined by the value of the backlight timeout setting, but is no less than 5 seconds. Backlight Fade In. This options turns on smooth backlight fading when the backlight is turning on. The fading time is dependent on the brightness level you have chosen. If it is turned off, the backlight will turn on immediately. Backlight Fade Out. This options turns on smooth backlight fading when the backlight is turning off.
Chapter 8. General Settings When set to Off the acceleration is disabled. When any other value is set the acceleration will start to accelerate after holding Minus or Top-Middle or Plus or Bottom-Middle for the chosen time (in seconds). List Acceleration Speed. This setting controls how fast the scroll speed accelerates. The scroll speed will increase every N seconds.
Chapter 8. General Settings 69 getting garbled extended characters you should adjust this settings. In most cases sticking to “ISO-8859-1” would be sufficient. 8.5. System 8.5.1. Battery Options relating to the battery in the player. Battery Capacity. This setting can be used to tell Rockbox what capacity (in mAh) the battery being used has. The default is 1600 mAh, which is the capacity value for the standard battery shipped with the player.
Chapter 8. General Settings 70 Glyphs To Cache. This sets the default memory allocation size for fonts in unique glyphs. This should be set to the number of unique language glyphs and punctuation marks that are frequently displayed. The default is 250. Note: You will need to restart your player for changes to Max Entries in File Browser or Max Playlist Size to take effect while Glyphs To Cache will affect the next font load. 8.5.4.
Chapter 8. General Settings 8.6.1. Start Screen Set the screen that Rockbox will start in. The default is the main menu but the following options are available: Previous Screen. Start Rockbox in the same screen as when it was shut off. Main Menu. Show the main menu. Files. Display the file browser, starting in the root directory of your player. Database. Show the default database view. Resume Playback.
Chapter 8. General Settings 72 Restart Sleep Timer On Keypress: If set, when a Sleep Timer is active and a key is pressed, the Sleep Timer will be restarted with the initial duration. 8.7. Bookmarking Bookmarks allow you to save your current position within a track so that you can return to it at a later time. Bookmarks also store rate, pitch and speed information from the Pitch Screen (see section 4.3.3 (page 34)). Bookmarks are saved on a per directory basis or for individual (saved) playlists.
Chapter 8. General Settings Load Last Bookmark. This option controls if Rockbox should automatically load a bookmark for a file, when that file is played. No Always start from the beginning of the track or playlist. Yes Automatically return to the position of the last bookmark. Start from the beginning if there are no bookmarks. Ask Ask if playback should start from the beginning of the track or from one of the bookmarks. Maintain a list of Recent Bookmarks.
Chapter 8. General Settings 74 8.8. Automatic resume The automatic resume feature stores and recalls resume positions for all tracks without user intervention. These resume points are stored in the database, and thus automatic resume only works when the database has been initialized. When automatic resume is enabled, manually selected tracks resume playback at their last playback position.
Chapter 8. General Settings 8.9. Language This setting controls the language of the Rockbox user interface. Selecting a language will activate it. The language files must be in the /.rockbox/langs/ directory. See section 12.1.4 (page 174) for further details about languages. 8.10. Voice Voice Menus. This option controls the voicing of menus/settings as they are selected by the cursor. In order for this to work, a voice file must be present in the /.rockbox/langs/ directory on the player.
Chapter 8. General Settings .talk clips to have filenames spoken properly, but you must enable this explicitly (see below). Use File .talk Clips. This option turns on the use of .talk clips for files. On. Use special pre-recorded files for each file. This functions the same as for directories except that the .talk clip file must have the same name as the described file with an extra .talk extension (e.g. Punkadiddle.mp3 would require a file called Punkadiddle.mp3.talk). Off.
Chapter 9. Theme Settings 9. Theme Settings The Theme Settings menu offers options that you can change to customize the visual appearance of Rockbox. Browse Theme Files. This option will display all the currently installed themes on the player, press Menu or Centre or Middle-Right to load the chosen theme and apply it.
Chapter 9. Theme Settings Status Bar. Allows you to choose where to display the statusbar. 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 49) 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.
Chapter 10. Time and Date 79 10. Time and Date Time related menu options. Pressing Long Menu or Long Centre or Long MiddleRight 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 11. Plugins 11. 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 11. Plugins 11.1.2. Blackjack Figure 11.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 11. Plugins 11.1.3. BrickMania Figure 11.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 11. Plugins Key Action Minus or Bottom-Left / Plus or Bottom-Right Menu or Centre Power Moves the paddle Release the ball / Fire Open menu / Quit 11.1.4. Bubbles Figure 11.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.
Chapter 11. Plugins Key Action Top-Middle Middle-Left / Middle-Right Minus or Centre Power or Bottom-Right or Long Power Pause game Aim the bubble Fire bubble Exit to menu 11.1.5. Chessbox Figure 11.4.: Chessbox Chessbox is a one-person chess game with computer artificial intelligence. The chess engine is a port of GNU Chess 2 by John Stanback. It also works as a PGN file viewer. Instead of executing the game from the plugin menu, look for any file with .
Chapter 11. Plugins position and start a new game without having to quit the game. Keys Key Action Direction keys Centre Plus Long Centre Menu Move the cursor Pick up / Drop piece Change level Force play Show the menu 11.1.6. Clix Figure 11.5.: Clix The aim is to remove all blocks from the board. You can only remove blocks, if at least two blocks with the same color have a direct connection. The more blocks you remove per turn, the more points you get.
Chapter 11. Plugins 11.1.7. Chopper Figure 11.6.: Chopper Navigate a cavernous maze without banging into walls, the ceiling, or the floor.
Chapter 11. Plugins 11.1.8. Codebuster Figure 11.7.: Codebuster 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 11. Plugins Key Action Minus or Centre Power or Bottom-Right Roll dice again Quit 11.1.10. Doom Figure 11.8.: Doom This is the famous Doom game. 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.
Chapter 11. Plugins Menus Rockdoom Menu. The Rockdoom menu is shown when Doom is first launched. This is the only time it can be accessed (before starting the game). To re-adjust Rockdoom options, you will need to quit your current game and restart the plugin. Main Menu. The Doom plugin has a main menu, which is brought up before a game is started. It has the following entries: Game. Select which (official) wad to launch Addon. Select which unofficial addon wad to launch (From /.
Chapter 11. Plugins Keys Key Action Top-Middle Middle-Left Middle-Right Bottom-Right Move Forward Turn Left Turn Right Shoot Open InGame Menu Enter Change Weapon Top-Left Centre Bottom-Left Playing the game After installation of the wad files is complete you can start the game. more description is needed 11.1.11. Flipit Figure 11.9.: Flipit Flipping the colour of the token under the cursor also flips the tokens above, below, left and right of the cursor.
Chapter 11. Plugins Key Action Top-Middle / Bottom-Middle / Middle-Left / Middle-Right Centre Top-Right Bottom-Left Bottom-Right Power Move the cursor Flip Shuffle Solve Solve step by step Quit the game 11.1.12. Goban Figure 11.10.: Goban 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.
Chapter 11. Plugins free up more memory and some very large SGF files will not even load on devices with little available memory. Note: The plugin does NOT support SGF files with multiple games in one file. These are rare, but if you have one don’t even try it (the file will most likely be corrupted if you save over it). You have been warned. The file /sgf/gbn_def.sgf is used by the plugin to store any unsaved changes in the most recently loaded game.
Chapter 11. Plugins Menus Main Menu. The main menu for game setup and access to other menus. New. Create a new game with your choice of board size and handicaps. Save. Save the current state of the game. It will be saved to /sgf/gbn_def.sgf unless otherwise set. Save As. Save to a specified file. Game Info. View and modify the metadata of the current game. Playback Control. Control the playback of the current playlist and modify the volume of your player. Zoom Level. Zoom in or out on the board.
Chapter 11. Plugins White Team. The name of white’s team, if any. Date. The date that this game took place. This text must follow the format specified at http://www.red-bean.com/sgf/properties.html#DT to be read by other SGF readers. Event. The name of the event which this game was a part of, if any. Place. The place that this game took place. Round. If part of a tournament, the round number for this game. Done. Return to the previous menu. Options. Customize the behavior of the plugin in certain ways.
Chapter 11. Plugins Force Play Mode. The same as Play Mode except that this mode will allow you to play illegal moves such as retaking a ko immediately without a ko threat, suicide on rulesets which don’t allow it (including single stone suicide), and playing a move where there is already a stone. Mark Mode. Add generic marks to the board, or remove them. Circle Mode. Add circle marks to the board, or remove them. Square Mode. Add square marks to the board, or remove them. Triangle Mode.
Chapter 11. Plugins Key Action Middle-Left, Bottom-Left or Minus Middle-Right, Bottom-Right or Plus Bottom-Middle, Centre or Menu Top-Left or Power Move left Move right Fire Quit 11.1.14. Jackpot Figure 11.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 11. Plugins 11.1.15. Jewels Figure 11.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 11. Plugins 11.1.16. MazezaM Figure 11.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 11. Plugins 11.1.17. Minesweeper Figure 11.15.: Minesweeper plugin The classic game of minesweeper. The aim of the game is to uncover all of the squares on the board. If a mine is uncovered then the game is over. If a mine is not uncovered, then the number of mines adjacent to the current square is revealed. The aim is to use the information you are given to work out where the mines are and avoid them.
Chapter 11. Plugins 11.1.18. Pacbox Figure 11.16.: Pacbox Pacbox is an emulator of the Pacman arcade machine hardware. It is a port of PIE – Pacman Instructional Emulator (http://www.ascotti.org/programming/pie/pie.htm). ROMs To use the emulator to play Pacman, you need a copy of ROMs for “Midway Pacman”. Filename MD5 checksum pacman.5e pacman.5f pacman.6e pacman.6f pacman.6h pacman.
Chapter 11. Plugins Keys Key Action Top-Middle Bottom-Middle Middle-Left Middle-Right Centre Bottom-Left Bottom-Right Menu Move Up Move Down Move Left Move Right Insert Coin 1-Player Start 2-Player Start Menu 11.1.19. Pegbox Figure 11.17.: pegbox 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.
Chapter 11. Plugins Key Action Top-Middle, Bottom-Middle, Middle-Left, Middle-Right Centre Top-Right Bottom-Left Bottom-Right Power to move around to to to to to choose peg restart level go up a level go down a level quit 11.1.20. Pong Figure 11.18.: Pong Pong is a simple one or two player “tennis game”. Whenever a player misses the ball the other scores. The game starts in demo mode, with the CPU controlling both sides.
Chapter 11. Plugins Key Action Top-Left Bottom-Left Top-Right Bottom-Right Power Left player up Left player down Right player up Right player down Quit 11.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. 11.1.22.
Chapter 11. Plugins Key Action Top-Middle, Bottom-Middle, Middle-Left, Middle-Right Power or Bottom-Right Move robot Quit 11.1.23. Rockblox Figure 11.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.
Chapter 11. Plugins Key Action Menu Middle-Left Middle-Right Bottom-Middle Bottom-Left Bottom-Right / Top-Middle Centre Hold switch Power Restart game Move left Move right Move down Rotate anticlockwise Rotate clockwise Drop Pause Quit 11.1.24. Rockblox1d Rockblox1d is a game for people who find rockblox too hard. In this version the second dimension is missing so the user only has to move the bricks down.
Chapter 11. Plugins 11.1.25. Sliding Puzzle Figure 11.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 194)).
Chapter 11. Plugins 11.1.26. Snake Figure 11.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.
Chapter 11. Plugins 11.1.27. Snake 2 Figure 11.23.: Snake 2 – The Snake Strikes Back Another version of the Snake game. Move the snake around, and eat the apples that pop up on the screen. Each time an apple is eaten, the snake gets longer. The game ends when the snake hits a wall, or runs into itself.
Chapter 11. Plugins 11.1.28. Sokoban Figure 11.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. The boxes can only be pushed, never pulled, and only one can be pushed at a time. Sokoban may be used as a viewer for viewing saved solutions and playing external level sets with the .sok extension. Level sets should be in the standard Sokoban text format or RLE (Run Length Encoded).
Chapter 11.
Chapter 11. Plugins 11.1.29. Solitaire Figure 11.25.: Klondike solitaire This is the classic Klondike solitaire game for Rockbox. This is probably the best-known solitaire in the world. Many people do not even realize that other games exist. Though the name may not be familiar, the game itself certainly is. This is due in no small part to Microsoft’s inclusion of the the game in every version of Windows. Though popular, the odds of winning are rather low, perhaps one in thirty hands.
Chapter 11. Plugins 11.1.30. Spacerocks Figure 11.26.: Spacerocks Spacerocks is a clone of the old arcade game Asteroids. The goal of the game is to blow up the asteroids and avoid being hit by them. Once in a while, a UFO will appear – shoot this for extra points.
Chapter 11. Plugins 11.1.31. Star Figure 11.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. You can switch control between the filled circle, which can take “o”s, and the filled square, which is used as a mobile wall to allow your filled circle to get to places on the screen it could not otherwise reach. The block cannot take “o”s.
Chapter 11. Plugins 11.1.32. Sudoku Figure 11.28.: Sudoku Sudoku in Rockbox can act as both a plugin and a viewer. When starting Sudoku from the Browse Plugins menu, a random game will be generated automatically, and an estimate of its difficulty (very easy, easy, medium, hard or fiendish) will be displayed on the screen. New games can be generated from the Generate menu option. When “playing” an existing Sudoku game file from Rockbox’ file browser the plugin is invoked as viewer.
Chapter 11. Plugins Key Action Top-Middle / Bottom-Middle / Middle-Left / Middle-Right Centre Long Centre Move the cursor Menu Long Bottom-Left Long Power Change number under the cursor Constantly changing the number under the cursor Open Menu Add/Remove number to scratchpad Quit Some places where can you can find .ss files: • Simple Sudoku (Advanced Puzzle Packs 1 and 2 located near the bottom of that page): http://www.angusj.com/sudoku/ • Kjell’s Sudoku generator/solver: http://kjell.haxx.
Chapter 11. Plugins Key Action Middle-Left Middle-Right Top-Middle Bottom-Middle 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 11. 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 11. Plugins 11.1.34. Xobox Figure 11.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%.
Chapter 11. Plugins Additionally, “extra” data files that modify the in-game strings and font can be placed in the .rockbox/xworld/ directory with the names xworld.strings and xworld.font, respectively. Key Action Up and Jump Down and Crouch Move Left and Right Action and Fire Menu 11.2. Demos 11.2.1. Bounce Figure 11.31.: Bounce This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background.
Chapter 11. Plugins Key Action Top-Middle/ Bottom-Middle Middle-Right / Middle-Left Minus or Centre Power or Bottom-Right or Long Power Moves to next/previous option Increases/decreases option value Toggles Scroll mode Exits bounce demo Available options are: Xdist/Ydist. The distance to X axis and Y axis respectively Xadd/Yadd. How fast the code moves on the sine curve on each axis Xsane/Ysane. Changes the appearance of the bouncing. 11.2.2.
Chapter 11. Plugins This is a rotating cube screen saver in 3D. Key Action Bottom-Right Centre Top-Right Middle-Right / Middle-Left Top-Middle / Bottom-Middle Power Display at maximum frame rate Pause Cycle draw mode Select axis to adjust Change speed/angle (speed can not be changed while paused) Quit 11.2.4. Demystify Figure 11.33.: Demystify Demystify is a screen saver like demo.
Chapter 11. Plugins 11.2.5. Fire Figure 11.34.: Fire Fire is a demo displaying a fire effect.
Chapter 11. Plugins 11.2.6. Fractals Figure 11.35.: Fractals: Mandelbrot set This demonstration draws fractal images from the Mandelbrot set. Key Action Direction keys Top-Right Top-Left Bottom-Left Bottom-Right Move about the image Zoom in Zoom out Decrease iteration depth (less detail) Increase iteration depth (more detail) Centre Power Reset and return to the default image Quit 11.2.7. Logo Demo showing the Rockbox logo bouncing around the screen.
Chapter 11. Plugins Key Action Middle-Right / Middle-Left Top-Middle / Bottom-Middle Power or Bottom-Right or Long Power Increase / decrease speed on the x-axis Increase / decrease speed on the y-axis Quit 11.2.8. Mosaique Figure 11.36.: Mosaique This simple graphics demo draws a mosaic picture on the screen of the player. Key Action Top-Middle Change the gap between the drawing lines. Restart the drawing process.
Chapter 11. Plugins 11.2.9. Oscilloscope Figure 11.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 11. Plugins 11.2.10. PictureFlow Figure 11.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 194)) and database (see section 4.2 (page 27)) features of Rockbox.
Chapter 11. Plugins Keys Key Action Middle-Left / Middle-Right Minus or Top-Middle / Plus or Bottom-Middle Centre Scroll through albums Power or Bottom-Right Top-Left Long Power or Bottom-Right (in album view) Scroll through track list Enter track list / Play album from selected track Exit track list Enter menu Exit PictureFlow Main Menu Go to WPS. Leave PictureFlow and enter the while playing screen. Playback Control. Control music playback from within the plugin. Settings.
Chapter 11. Plugins Zoom. Changes the distance at which slides are rendered from the “camera”. Show album title. Allows setting the album title to be shown above or below the cover art, or not at all. Resize Covers. Set whether to automatically resize the covers or to leave them at their original size. Rebuild cache. Rebuild the PictureFlow cache. This is needed in order for PictureFlow to pick up new albums, and may occasionally be needed if albums are removed. 11.2.11. Plasma Figure 11.39.
Chapter 11. Plugins 11.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 .cells file is a text file. A capital ‘O’ marks a live cell, a dot marks a dead cell, all other characters are ignored.
Chapter 11. Plugins 11.2.14. Starfield Figure 11.41.: Starfield Starfield simulation (like the classic screensaver).
Chapter 11. Plugins 11.2.15. VU meter Figure 11.42.: VU-Meter This is a VU meter, which displays the volume of the left and right audio channels. There are 3 types of meter selectable. The analogue meter is a classic needle style. The digital meter is modelled after LED volume displays, and the mini-meter option allows for the display of small meters in addition to the main display (as above).
Chapter 11. Plugins Viewer gin Plu- Shortcuts Chip-8 Emulator Frotz Image Viewer Lua scripting language Midiplay MPEG Player MP3 Encoder Rockboy Search Sort Text Viewer VBRfix ZXBox Shopping list Associated filetype(s) Context Menu only .link .ch8 .z1 - .z8 .bmp, .jpg, .jpeg, .png, .ppm .lua .mid, .midi .mpg, .mpeg, .mpv, .m2v .wav .gb, .gbc .m3u, .m3u8 .* .txt,.nfo, .* .mp3 .tap, .tax, .sna, .z80 .shopper x x x x 11.3.1.
Chapter 11. Plugins the directory selected, or with the file selected in the file browser. You can then play the file or do with it whatever you want. The file will not be “played” automatically. If the .link file contains only one entry no list will be shown, you will directly jump to that location. The file shortcuts.link in the root directory is an exception. After “playing” it, the list will be shown even if the file contains just one entry. If the list you are seeing is from shortcuts.
Chapter 11. Plugins Off 0 1 2 3 4 5 6 7 8 9 A B C D E F Key Chip8 Some places where can you can find .ch8 files: • The PluginChip8 page on www.rockbox.org has several attached: ZPluginChip8 • Check out the HP48 chip games section: http://www.hpcalc.org/hp48/games/chip/ • PC emulator by the guy who wrote the HP48 emulator: http://www.pdc.kth.se/ ~lfo/chip8/CHIP8.htm • Links to other chip8 emulators: http://www.zophar.net/chip8.html 11.3.3.
Chapter 11. Plugins Key Action Top-Middle Minus or Centre Power or Bottom-Right Long Power Display keyboard to enter text Press enter Open Frotz menu (not available at MORE prompts) Quit 11.3.4. Image Viewer This plugin opens image files from the File Browser to display them. Supported formats are as follows. Format File-extension(s) BMP JPEG PNG GIF PPM .bmp .jpg, .jpe, .jpeg .png .gif .
Chapter 11. Plugins Change Slideshow Timeout. You can set the timeout for the slideshow between 1 second and 20 seconds. Show Playback Menu. From the playback menu you can control the playback of the currently loaded playlist and change the volume of your player. Display Options. From this menu you can force the viewer to render the image in greyscale using the Greyscale option or set the method of dithering used in the Dithering submenu. These settings only take effect for JPEG images. Quit.
Chapter 11. Plugins 11.3.6. Midiplay To get MIDI file playback, a patchset is required. This file contains the instruments required to synthesize the music. A sample patchset is available through the wiki at ZPluginMidiPlay, and needs to be extracted to the .rockbox directory in the root of your player. There should now be a /.rockbox/patchset/ directory, with the patchset directory containing several .pat files and two .cfg files. Just select a MIDI file with either the .mid or .
Chapter 11. Plugins Play from beginning Resume information is discarded and the video plays from the start. Resume at: mm:ss Resume video playback at stored resume time mm:ss (start of the video if no resume time is found). Set start time A preview screen is presented consisting of a thumbnail preview and a progress bar where the user can select a start time by ‘seeking’ through the video. The video playback is started by pressing the select button. Settings Open Settings submenu – see below.
Chapter 11. Plugins Skip frames (default: on) This option causes mpegplayer to attempt to maintain realtime playback by skipping the display of frames - but these frames are still decoded. Disabling this option can cause loss of A/V sync. Backlight Brightness (default: Use setting) Choose brightness to use during video playback. Set to Use setting to use the Brightness setting. Audio Options Menu Tone Controls (default: force off) Use the bass and treble control settings or force them off.
Chapter 11. Plugins 11.3.9. Rockboy Figure 11.43.: Rockboy Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game, open a ROM file saved as .gb or .gbc in the file browser. Default keys Key Action Top-Middle / Bottom-Middle / Middle-Left / Middle-Right Plus Minus Top-Right Centre Menu Direction keys A button B button Start Select Open Rockboy menu Rockboy menu Load Game. . . Loads a previously saved game. Save Game. . .
Chapter 11. Plugins 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. Note: The direction keys are set for the normal screen orientation, not the rotated orientation. Screen Size. Choose whether the original aspect ratio should be kept when scaling the picture to the screen. Screen Rotate.
Chapter 11. Plugins 11.3.13. Text Viewer Figure 11.44.: Text Viewer This is a Viewer for text files with word wrap. Just open a .txt or .nfo file to display it. The text viewer features controls to handle various styles of text formatting and has top-of-file and bottom-of-file buttons. You can view files without a .txt or .nfo extension by using Open with from the Context Menu (see section 4.1.2 (page 24)). You can also bookmark pages.
Chapter 11. Plugins Menu Return Return to the file being viewed. Viewer Options Change settings for the current file. Encoding Set the codepage in the text viewer. Available settings: ISO-8859-1 (Latin 1).
Chapter 11. Plugins Show Statusbar Select whether to show the status bar. If you select a theme settings that the status bar does not display (see section 9 (page 77)), the status bar is not displayed even if you select Yes. No Do not display the status bar. Yes Display the status bar. Scroll Settings The scrolling settings submenu. Horizontal Submenu for horizontal scrolling settings. Scrollbar Toggle the horizontal scrollbar for the current mode.
Chapter 11. Plugins Indent Spaces Set the number of spaces to indent the text when line mode is set to Reflow Lines. Available options are 0 to 5 spaces. If you select 0, a blank line is displayed as an indent. Show Playback Menu Display the playback menu to allow control of the currently playing music without leaving the plugin. Select Bookmark Select a saved bookmark. In the screenshot below, the “*” denotes the current page. Figure 11.45.
Chapter 11. Plugins Figure 11.46.: A bookmark 11.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. Theme Remove menu Remove Theme. Selecting this will delete the files specified in the Remove Options.
Chapter 11. Plugins Font. Specifies how the .fnt file belonging to a theme .cfg file is handled. If this option is set to Remove if not Used, the fonts came from rockbox-fonts.zip will not be removed as themes may depend on those fonts. 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.
Chapter 11. Plugins 11.3.16. ZXBox Figure 11.47.: ZXBox ZXBox is a port of the “Spectemu” ZX Spectrum 48k emulator for Rockbox (Zproject’s homepage). To start a game open a tape file or snapshot saved as .tap, .tzx, .z80 or .sna in the file browser. Note: As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible. Default keys The emulator is set up for 5 different buttons: Up, Down, Left, Right and Jump/Fire.
Chapter 11. Plugins ZXBox menu Vkeyboard. This is a virtual keyboard representing the Spectrum keyboard. Controls are the same as in standard Rockbox, but you just press one key instead of entering a phrase. Play/Pause Tape. Toggles playing of the tape (if it is loaded). Save Quick Snapshot. Saves snapshot into /.rockbox/zxboxq.z80. Load Quick Snapshot. Loads snapshot from /.rockbox/zxboxq.z80. Save Snapshot. Saves a snapshot of the current state.
Chapter 11. Plugins 11.4. Applications 11.4.1. Alarm Clock This plugin is an alarm clock, which resumes a paused song at a given time. Key configuration Key Action Middle-Left / Middle-Right Top-Middle / Bottom-Middle Minus or Centre Power or Bottom-Right Switch between hours/minutes selection Increase/Decrease hours/minutes Set the alarm Exit Setting an alarm First select a track and play it, then launch the “alarmclock” plugin. The plugin pauses the playback. Enter a 24h-time (e.g.
Chapter 11. Plugins • The battery is empty. Benchmarks can be resumed if you accidentally load a plugin, or turn off your player, so long as the log file battery_bench.txt is not deleted. Information explained At the top of the battery_bench.txt file is various information on how to use the plugin, followed by the data themselves. Time This column reports the total time of operation of the player. It is not the time that you started the plug-in.
Chapter 11. Plugins 11.4.3. Calculator Figure 11.48.: Calculator This is a simple scientific calculator for use on the player. It works like a standard calculator. Pressing the “1st” and “2nd” buttons will toggle between other available math functions.
Chapter 11. Plugins 11.4.4. Calendar Figure 11.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 11. Plugins 11.4.5. Chess Clock Figure 11.50.: Chess Clock The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players. Setup Key Action 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 11. Plugins Keys are as follows: Key Action Exit plugin Restart round for the current player Pause the time (press again to continue) Switch to next player Switch to previous player Open menu From the menu it is possible to delete a player, modify the round time for the current player or set the total time for the game. When the round time is up for a player the message “ROUND UP!” is shown (press NEXT to continue). When the total time is up for a player the message “TIME UP!”is shown.
Chapter 11. Plugins Key configuration Key Action Middle-Left / Middle-Right Top-Middle / Bottom-Middle Power or Bottom-Right Minus or Centre Long Minus or Long Centre 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. Counter Settings Opens a menu from which you can adjust settings pertaining to the counter.
Chapter 11. Plugins 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. The Counter, if enabled, is displayed at the lower right. The second hand, if enabled, is displayed along with the hour and minute hands.
Chapter 11. Plugins 11.4.7. Disk Tidy Disk Tidy deletes junk files commonly left behind by Windows, Linux and OS X after connecting your player over USB. Select the files you want to delete in the “Files to Clean” menu and select “Start Cleaning” to begin the process. The settings are stored in the plain text file .rockbox/rocks/apps/disktidy.config that is user-modifiable to allow custom entries to be added.
Chapter 11. 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 Menu or Long Centre or Long Middle-Right. From the context menu you can create new entries, delete entries and edit entries.
Chapter 11. Plugins .lrc8 files are the same as .lrc files except that they are UTF8 encoded. The Lyrics3 tag is not supported. Supported tags and formats for .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.
Chapter 11. Plugins Controls Key Action Plus or Top-Middle / Minus or Bottom-Middle Middle-Left Volume up/down. Long Middle-Left Middle-Right Long Middle-Right Centre Long Centre or Minus+Power or Top-Right Long Menu or Long Top-Right Menu or Top-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. Exit the plugin. Enter timetag editor. Enter Lrcplayer Menu.
Chapter 11. Plugins Lyrics Settings. Change how the lyrics files are loaded. Encoding. Sets the codepage used in the plugin. Read ID3 tag. Read lyrics from id3 tags in mp3 files. Lrc Directory. Set the directory where lyrics files are stored, must be a maximum of 63 bytes. 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.
Chapter 11. Plugins Key Action Long Power Power or Bottom-Right Long Minus or Long Centre Minus or Centre Middle-Left / Middle-Right Top-Middle / Bottom-Middle Exit plugin Stop Start Tap tempo Adjust tempo Adjust volume Programmed Track Mode When starting the plugin as a viewer for tempomap files (ending in .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.
Chapter 11. Plugins Navigation The display indicates the part properties and position in track as such: Metronome Track --------------"Interlude" 3/4@120 V-25 P2/13: B1/5+2 In this example, the part label is “Interlude”, the meter is 3/4 and the tempo 120 quarter beats per minute (bpm). The volume setting is at -25 and this is the second part of a track with 13 total. In that part, the position is at the second beat of the first bar of five.
Chapter 11. Plugins Symbol X x . Meaning emphasized beat (Tick) normal beat (Tock) silent beat Some examples: default: rockon2: solea: shuffle: funky: 0 0 0 0 0 4/4 120 Xxxx 4/4 120 xXxX 12/4 180 xxXxxXxXxXxX 12/12 120 x.xX.xx.xX.. 16/16 120 x.x.X..X.Xx.X..X The 12/12 for the shuffle create 1/4 triplets. Just do a bit of math;-) This is still a metronome, not a drum machine, but it can act like a basic one, helping you to figure out a certain rhythm within the meter.
Chapter 11. Plugins Key Action Top-Middle, Bottom-Middle, Middle-Left, Middle-Right Power or Bottom-Right Move cursor Quit 11.4.14. Random Folder Advance Configuration This plugin is used to configure the folders which will be considered when the AutoChange Directory feature is set to Random. Menu Generate Folder List Generates a list of all folders found on the player. You can filter the directories which are scanned by creating a file called /.rockbox/folder_advance_dir.txt.
Chapter 11. Plugins Folder List Editor Keys Key Action Menu or Centre or Middle-Right Long Menu or Long Centre or Long Middle-Right Power or Middle-Left Delete selected folder Bring up the context menu which allows you to remove the selected folder or its entire folder tree Exit 11.4.15. Resistor Calculator Figure 11.52.
Chapter 11. Plugins the value of the resistor that you would like to know the colour code of. The colour codes are presented graphically and textually. LED resistance LED resistance calculator is used to determine the resistor necessary to light an LED safely at a given voltage. First, select the voltage that the LED will use (the first option is the most common and a safe bet), and the current that it will draw (likewise with the first option).
Chapter 11. Plugins Tools Rockpaint offers several tools to aid you in editing; you can view them by either pressing Rockpaint’s “Menu” key or by attempting to move the cursor beyond the bottom of the screen. From top to bottom and left to right, and by section, they are as follows: Colour Picker The top left tool shows your colours that are at the ready. To swap them, “click” on the background colour. To edit the foreground colour, click on it. Preset Palette Several preset colours are available.
Chapter 11. Plugins Main Menu The main menu consists of the following: Resume Closes the Main Menu. New Creates a new canvas and discards the current file. BE CAREFUL. You will lose any unsaved changes in the file that is currently open. Load Loads a bitmap file. Simply navigate to the file as you would in the file browser. Save Saves the current file. If it has not been saved before, you will be given a chance to name it and choose the saving location.
Chapter 11. Plugins 11.4.17. Stats Figure 11.54.: The stats-plugin The stats plugin counts the directories and files (the total number as well as the number of audio, playlist, image and video files) on your player. Press Power or BottomRight or Long Power to abort counting and exit the plugin. Press it again to quit after counting has finished. 11.4.18. Stopwatch Figure 11.55.: Stopwatch A simple stopwatch program with support for saving times.
Chapter 11. Plugins Key Action Quit Plugin Start / stop Reset timer (only when timer is stopped) Take lap time Scroll through lap times 11.4.19. 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)). Usage If you start the Text Editor from the plugin browser you will be greeted with a blank screen. When started from the Open with menu item your file should be shown on the screen.
Chapter 12. Advanced Topics 12. Advanced Topics 12.1. Customising the User Interface 12.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 12.
Chapter 12. Advanced Topics 174 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 12.1.4. Loading Languages Rockbox can load language files at runtime. Simply copy the .lng file (do not use the .
Chapter 12. Advanced Topics 175 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 12. Advanced Topics 12.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 12.
Chapter 12. 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 12. 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 12.2.4 (page 180)). • Only the coordinates have to be specified.
Chapter 12. Advanced Topics 179 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 12. Advanced Topics 12.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 12. Advanced Topics 181 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 12. 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 12. 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 12.3.2 (page 183) below for an explanation of the format for configuration files. See section 12.3.3 (page 184) for an explanation of how to create, edit and load configuration files. 12.3.2. Specifications for .cfg Files The Rockbox configuration file is a plain text file, so once you use the Save .
Chapter 12. Advanced Topics 184 12.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 Power or Middle-Left will exit back to the Manage Settings menu. See the Write .
Chapter 12. Advanced Topics 185 12.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 66)). Avoid to have the backlight enabled all the time. 12.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. b Note: There is always only one tag type supported for each file extension.
Appendix B. Audio and metadata formats 193 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 194 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 192) 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 195 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 12.2 (page 176), 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.30 (page 212). 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 197 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 198 D.5. Additional Fonts Tag Description %Fl(’id’,filename) See section 12.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 199 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 201 • ‘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 203 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 205 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 194). 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 208 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 209 %?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 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.
Appendix D. Theme Tags voldown – Decrease the volume by one step. volup – Increase the volume by one step. mute – Un/Mute playback. createbookmark – Create a bookmark in the currently-playing track. hotkey – Performs the action assigned to the hotkey (see Hotkeys section). menu – Go to the main menu. browse – Go back to the file browser or database. resumeplayback – Go back to the last music screen (WPS or radio screen). quickscreen – Go to the quickscreen. contextmenu – Open the context menu.
Appendix D. Theme Tags 212 D.29. Last Touchscreen Press Tag Description %Tl Indicates that the touchscreen is pressed. This tag can be used to display text or images or a viewport when the touchscreen is pressed (like an On Screen Display). If you put a number straight after %Tl it will be used as a timeout in seconds (e.g %Tl(2.5) will give a 2.5 second timeout) between the touchscreen press being released and the tag going false. If no number is specified it will use a 1 second timeout.
Appendix D. Theme Tags backdrop – draw a preloaded image under the bar. The full image will be displayed and must be the same size as the bar. This must be followed by the label of the desired image. 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.
Appendix D. Theme Tags 214 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 from config-*.
Appendix E. Config file options Setting Allowed Values Unit disable autoresume if phones not present Last.
Appendix E.
Appendix E. Config file options Setting Allowed Values Unit peak meter busy peak meter dbfs on, off on, off peak meter min peak meter max statusbar scrollbar scrollbar width 0 to 89 (dB) or 0 to 100 (%) 0 to 89 /(dB) or 0 to 100 (%) off, top, bottom off, left, right 3 to LCD width / 10 (devise a way to get ranges from config-*.h) graphic, numeric graphic, numeric /path/filename.fnt /path/filename.kbd pointer, bar (inverse) , bar (color), bar (gradient) on, off /path/filename.bmp /path/filename.
Appendix F. Menu Overview 220 F.
Appendix G. User feedback 221 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 222 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.
