The Rockbox Manual for Sansa Clip Zip rockbox.
Rockbox http://www.rockbox.org/ Open Source Jukebox Firmware Rockbox and this manual is the collaborative effort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2013 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 José Maria Garcia-Valdecasas Bernal & Peter Schlenker. Version rUnversioned. Built using pdfLATEX.
Contents Contents 1. Introduction 1.1. Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2. Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3. Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 11 11 11 12 2. Installation 2.1. Before Starting . . . . . . . . . . . . . . . . . . . . 2.2. Installing Rockbox . . . . . . . . . . . . . . . . . . 2.2.1. Automated Installation . . . . . . . . . . . 2.2.2.
Contents 4.1.3. Virtual Keyboard . . . . . 4.2. Database . . . . . . . . . . . . . 4.2.1. Introduction . . . . . . . 4.2.2. Initializing the Database . 4.2.3. The Database Menu . . . 4.2.4. Using the Database . . . 4.3. While Playing Screen . . . . . . . 4.3.1. WPS Key Controls . . . . 4.3.2. Peak Meter . . . . . . . . 4.3.3. The WPS Context Menu 4.4. Working with Playlists . . . . . . 4.4.1. Playlist terminology . . . 4.4.2. Creating playlists . . . . . 4.4.3. Adding music to playlists 4.4.4.
Contents 6.3. Volume Limit . . . . . . . . . 6.4. Treble . . . . . . . . . . . . . 6.5. Balance . . . . . . . . . . . . 6.6. Channels . . . . . . . . . . . 6.7. Stereo Width . . . . . . . . . 6.8. Crossfeed . . . . . . . . . . . 6.9. Equalizer . . . . . . . . . . . 6.10. Dithering . . . . . . . . . . . 6.11. Timestretch . . . . . . . . . . 6.12. Haas Surround . . . . . . . . 6.13. Perceptual Bass Enhancement 6.14. Auditory Fatigue Reduction . 6.15. Compressor . . . . . . . . . . 7. Playback Settings 7.1.
Contents 8.5.5. Keyclick . . . . . . . . . . 8.5.6. USB Hide Internal Drive . 8.6. Startup/Shutdown . . . . . . . . 8.6.1. Start Screen . . . . . . . . 8.6.2. Idle Poweroff . . . . . . . 8.6.3. Sleep Timer . . . . . . . . 8.7. Bookmarking . . . . . . . . . . . 8.8. Automatic resume . . . . . . . . 8.9. Language . . . . . . . . . . . . . 8.10. Voice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 12.1.15.MazezaM . . . . . . . 12.1.16.Minesweeper . . . . . 12.1.17.Pegbox . . . . . . . . 12.1.18.Pong . . . . . . . . . . 12.1.19.Reversi . . . . . . . . 12.1.20.Robotfindskitten . . . 12.1.21.Rockblox . . . . . . . 12.1.22.Rockblox1d . . . . . . 12.1.23.Sliding Puzzle . . . . . 12.1.24.Snake . . . . . . . . . 12.1.25.Snake 2 . . . . . . . . 12.1.26.Sokoban . . . . . . . . 12.1.27.Solitaire . . . . . . . . 12.1.28.Spacerocks . . . . . . 12.1.29.Star . . . . . . . . . . 12.1.30.Sudoku . . . . .
Contents 12.3.9. Rockboy . . . . . . . . . 12.3.10.Search . . . . . . . . . . 12.3.11.Shopper . . . . . . . . . 12.3.12.Sort . . . . . . . . . . . 12.3.13.Text Viewer . . . . . . . 12.3.14.Theme Remove . . . . . 12.3.15.VBRfix . . . . . . . . . 12.3.16.ZXBox . . . . . . . . . . 12.4. Applications . . . . . . . . . . . 12.4.1. Alarm Clock . . . . . . 12.4.2. Battery Benchmark . . 12.4.3. Calculator . . . . . . . . 12.4.4. Calendar . . . . . . . . 12.4.5. Chess Clock . . . . . . . 12.4.6. Clock . . . . . .
Contents 13.3. Managing Rockbox Settings . . . . . . . 13.3.1. Introduction to .cfg Files . . . . 13.3.2. Specifications for .cfg Files . . . 13.3.3. The Manage Settings menu . 13.4. Firmware Loading . . . . . . . . . . . . 13.4.1. Using ROLO (Rockbox Loader) . 13.5. Optimising battery runtime . . . . . . . 13.5.1. Display backlight . . . . . . . . . 13.5.2. Replaygain . . . . . . . . . . . . 13.5.3. Peak Meter . . . . . . . . . . . . 13.5.4. Audio format and bitrate . . . . 13.5.5. Sound settings . . .
Contents D.13.Hold . . . . . . . . . . . . . . . . . . D.14.Virtual LED . . . . . . . . . . . . . D.15.Repeat Mode . . . . . . . . . . . . . D.16.Playback Mode . . . . . . . . . . . . D.17.Current Screen . . . . . . . . . . . . D.18.List Title (.sbs only) . . . . . . . . D.19.Changing Volume . . . . . . . . . . . D.20.Settings . . . . . . . . . . . . . . . . D.21.Images . . . . . . . . . . . . . . . . . D.21.1. How to display the album art D.22.FM Radio . . . . . . . . . . . . . . . D.23.
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 DRM capability. It is possible that installation of the bootloader may lead to you permanently losing the ability to playback files with DRM. USB connection. To transfer Rockbox to your player you need to connect it to your computer.
Chapter 2. Installation directory called .rockbox which contains all of the Rockbox files, and is located in the root of your player’s drive. Apart from the required parts there are some addons you might be interested in installing. Fonts. Rockbox can load custom fonts. The fonts are distributed as a separate package and thus need to be installed separately. They are not required to run Rockbox itself but a lot of themes require the fonts package to be installed. Themes.
Chapter 2. Installation Release. The release version is the latest stable release, free of known critical bugs. For a manual install, the current stable release of Rockbox is available at http: //www.rockbox.org/download/. Development Build. The development build is built at each change to the Rockbox source code repository and represents the current state of Rockbox development. This means that the build could contain bugs but most of the time is safe to use.
Chapter 2. Installation If the contents of the .zip file are extracted correctly, you will have a directory called .rockbox, which contains all the files needed by Rockbox, in the main directory of your player’s drive. Installing the bootloader In order to install the bootloader, you will need to download the following files: • An original firmware (OF) from http://forums.sandisk.com/t5/Clip-Zip/SansaClip-Zip-Firmware-01-01-18/td-p/254122 • The bootloader: http://download.rockbox.
Chapter 2. Installation If mkamsboot does not report success, then retry or abort. 4. Copy the output file (“patched.bin” in the example given above) to the root of the device and rename it to the same name as the OF file you downloaded earlier (“clpza.bin” above). 2.2.5. Finishing the install Safely eject the device, unplug USB and wait for the firmware update to finish. Don’t try to power off the device, it will shutdown by itself after a minute. 2.2.6.
Chapter 2. Installation 18 2.5.1. Automatic Uninstallation You can uninstall Rockbox automatically by using Rockbox Utility. If you installed Rockbox manually you can still use Rockbox Utility for uninstallation but will not be able to do this selectively. 2.5.2. Manual Uninstallation Copy an unmodified original firmware to your player, and then reboot into the Sandisk firmware. See section 3.1.3 (page 20) for more information. If you wish to clean up your disk, you may also wish to delete the .
Chapter 3. Quick Start 3. Quick Start 3.1. Basic Overview 3.1.1. The player’s controls Power Volume Up Volume Down Home Play Select Left Right Submenu Throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prefixed by “Long”, a long press of approximately one second should be performed on that button. The buttons are described in detail in the following paragraph.
Chapter 3. Quick Start 3.1.2. Turning the player on and off To turn on and off your Rockbox enabled player use the following keys: Key Action Power Long Power Start Rockbox Shutdown Rockbox On shutdown, Rockbox automatically saves its settings. 3.1.3. Starting the original firmware Rockbox has a dual-boot feature. To boot into the original firmware, press and hold the Left button while turning on the player. 3.1.4.
Chapter 3. Quick Start 21 tree view use Submenu and Play to move around the selection. Use Select or 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. The created dynamic playlist can be extended or modified while playing.
Chapter 3. Quick Start 22 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. 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. Your player must already be in Rockbox for this to function.
Chapter 4. Browsing and playing 23 4. Browsing and playing 4.1. File Browser Figure 4.1.: The file browser Rockbox lets you browse your music in either of two ways. The File Browser lets you navigate through the files and directories on your player, entering directories and executing the default action on each file. To help differentiate files, each file format is displayed with an icon.
Chapter 4. Browsing and playing 4.1.1. File Browser Controls Key Action Play/Submenu Go to previous/next item in list. If you are on the first/last entry, the cursor will wrap to the last/first entry. Go to the parent directory. Execute the default action on the selected file or enter a directory. If there is an audio file playing, return to the While Playing Screen (WPS) without stopping playback. Stop audio playback. Enter the Context Menu. Enter the Main Menu.
Chapter 4. Browsing and playing Playlist. Enters the Playlist Submenu (see section 4.4.3 (page 36)). Playlist Catalogue. Enters the Playlist Catalogue Submenu (see section 4.4.2 (page 35)). Rename. This function lets the user modify the name of a file or directory. Cut. Copies the name of the currently selected file or directory to the clipboard and marks it to be ‘cut’. Copy. Copies the name of the currently selected file or directory to the clipboard and marks it to be ‘copied’. Paste.
Chapter 4. Browsing and playing Add to Shortcuts. Adds a link to the selected item in the shortcuts.link file. If the file does not already exist it will be created in the root directory. Note that if you create a shortcut to a file, Rockbox will not open it upon selecting, but simply bring you to its location in the File Browser. 4.1.3. Virtual Keyboard Figure 4.3.
Chapter 4. Browsing and playing 4.2. Database 4.2.1. Introduction This chapter describes the Rockbox music database system. Using the information contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your audio files, Rockbox builds and maintains a database of the music files on your player and allows you to browse them by Artist, Album, Genre, Song Name, etc. The criteria the database uses to sort the songs can be completely customised.
Chapter 4. Browsing and playing 28 Unlike Initialize Now, the Update Now function does not remove runtime database information. Gather Runtime Data When enabled, rockbox will record how often and how long a track is being played, when it was last played and its rating. This information can be displayed in the WPS and is used in the database browser to, for example, show the most played, unplayed and most recently played tracks.
Chapter 4.
Chapter 4. Browsing and playing • 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 13.2 (page 161) for details of customising your WPS (While Playing Screen). 4.3.1. WPS Key Controls Key Action Volume Up / Volume Down Left Volume up/down.
Chapter 4. Browsing and playing 4.3.2. Peak Meter The peak meter can be displayed on the While Playing Screen and consists of several indicators. For a picture of the peak meter, please see the While Recording Screen in section 5.8.1 (page 42). The bar: This is the wide horizontal bar. It represents the current volume value. 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.
Chapter 4. Browsing and playing 32 Playlist catalogue View catalogue. This lists all playlists that are part of the Playlist catalogue. You can load a new playlist directly from this list. Add to playlist. Adds the currently playing file to a playlist. Select the playlist you want the file to be added to and it will get appended to that playlist. Add to new playlist. Similar to the previous entry this will add the currently playing track to a playlist. You need to enter a name for the new playlist first.
Chapter 4. Browsing and playing 33 is stored in audio file formats to keep information on artist, album etc. To access this screen, press Long Select to access the WPS Context Menu and select Show Track Info. 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.
Chapter 4. Browsing and playing Key Action Home 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). Increase / Decrease pitch by 1% (in procentual mode) or a semitone (in semitone mode). Temporarily change pitch by 2% (beatmatch), or modify speed (in timestretch mode). Reset pitch and speed to 100%. Leave the Pitch Screen. Play / Submenu Long Play / Long Submenu Left / Right Select Power 4.4.
Chapter 4. Browsing and playing 35 By selecting (“playing”) a song from the File Browser Whenever a song is selected from the File Browser with Select or Right, Rockbox will automatically create a playlist containing all of the songs in that directory and start playback with the selected song. Note: If you already have created a dynamic playlist, playing a new song will erase the current dynamic playlist and create a new one.
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 37 Play Next. Replaces all but the current playing track with track(s). Current playing track is queued. The Playlist Submenu can be used to add either single tracks or entire directories to a playlist. If the Playlist Submenu is invoked on a single track, it will put only that track into the playlist. On the other hand, if the Playlist Submenu is invoked on a directory, Rockbox adds all of the tracks in that directory to the playlist.
Chapter 4. Browsing and playing 38 4.4.6. Loading saved playlists Through the File Browser Playlist files, like regular music tracks, can be selected through the File Browser. When loading a playlist from disk it will replace the current dynamic playlist. Through the Playlist catalogue The Playlist catalogue offers a shortcut to all playlists in your player’s specified playlist directory. It can be used like the File Browser.
Chapter 5. The Main Menu 5. The Main Menu 5.1. Introducing the Main Menu Figure 5.1.: The main menu The Main Menu is the screen from which all of the Rockbox functions can be accessed. This is the first screen you will see when starting Rockbox. To return to the Main Menu, press the Home button. All settings are stored on the unit. However, Rockbox does not access the flash storage solely for the purpose of saving settings.
Chapter 5. The Main Menu 5.3. Recent Bookmarks Figure 5.2.: The list bookmarks screen If the Save a list of recently created bookmarks option is enabled then you can view a list of several recent bookmarks here and select one to jump straight to that track. Note: Bookmarking only works when tracks are launched from the file browser, and does not currently work for tracks launched via the database. In addition, they do not currently work with dynamic playlists.
Chapter 5. The Main Menu 5.5. Database Browse by the meta-data in your audio files (see section 4.2 (page 27)). 5.6. Now Playing/Resume Playback Go to the While Playing Screen and resume if music playback is stopped or paused and there is something to resume (see section 4.3 (page 29)). 5.7. Settings The Settings menu allows you to set or adjust many parameters that affect the way your player works. There are many submenus for different parameter areas.
Chapter 5. The Main Menu 42 5.7.6. Manage Settings The Manage Settings option allows the saving and re-loading of user configuration settings, browsing the hard drive for alternate firmwares, and finally resetting your player back to initial configuration. The details of this menu are covered in section 13.3 (page 167). 5.8. Recording 5.8.1. While Recording Screen Figure 5.3.
Chapter 5. The Main Menu Key Action Submenu / Play Left / Right Select Select setting. Adjust selected setting. Start recording. While recording: pause recording (press again to continue). Exit Recording Screen. While recording: Stop recording. Open Recording Settings (see section 10 (page 76)). Power Long Submenu 5.9. FM Radio Figure 5.4.: The FM radio screen This menu option switches to the radio screen. The FM radio has the ability to remember station frequency settings (presets).
Chapter 5. The Main Menu Key Action Left, Right Change frequency in SCAN mode or jump to next/previous station in PRESET mode. Seek to next station in SCAN mode. Long Left, Long Right Volume Up, Volume Down Home Power Play Submenu Select Long Select Home+Select Change volume. Leave the radio screen with the radio playing. Stop the radio and return to Main Menu. Mute radio playback. Switch between SCAN and PRESET mode. Open a list of radio presets.
Chapter 5. The Main Menu Create Playlist: Rockbox will create a playlist with all tracks in the current directory and all sub-directories. The playlist will be created one directory level “up” from where you currently are. View Current Playlist: Displays the contents of the playlist currently stored in memory. Save Current Playlist: Saves the current dynamic playlist, excluding queued tracks, to the specified file. If no path is provided then playlist is saved to the current directory.
Chapter 5. The Main Menu 5.13. Quick Screen Although the Quick Screen is accessible from nearly everywhere, not just the Main Menu, it is worth mentioning here. It allows rapid access to your four favourite settings. The default settings are Shuffle (section 7 (page 56)), Repeat (section 7 (page 56)) and the Show Files (section 8.2 (page 63)) options, but almost all configurable options in Rockbox can be placed on this screen.
Chapter 5. The Main Menu icon: talkclip: Only “type” and “data” are required (except if type is “separator” in which case “data” is also not required).
Chapter 6. Sound Settings 48 6. Sound Settings Figure 6.1.: The sound settings screen The sound settings menu offers a selection of sound settings you may change to customise your listening experience. 6.1. Volume This setting adjusts the volume of your music. Like most professional audio gear and many consumer audio products, Rockbox uses a decibel scale where 0 dB is a reference that indicates the maximum volume that the player can produce without possible distortion (clipping).
Chapter 6. Sound Settings 49 from the list and the maximum volume will be limited to the selected value all over the system. 6.4. Treble This setting emphasises or suppresses the higher (treble) frequencies in the sound. A value of 0 dB means that treble sounds are unaltered (flat response). The minimum setting is -24 dB and the maximum is 24 dB. 6.5. Balance This setting controls the balance between the left and right channels. The default, 0, means that the left and right outputs are equal in volume.
Chapter 6. Sound Settings of one channel into the other. This has the effect of gradually centering the stereo image, until you have monophonic sound at 0%. Values above 100% will progressively remove components in one channel that is also present in the other. This has the effect of widening the stereo field. A value of 100% will leave the stereo field unaltered. 6.8.
Chapter 6. Sound Settings 51 Most users will find the default settings to yield satisfactory results, but for the more adventurous user the settings can be fine-tuned to provide a virtual speaker placement suited to ones preference. Beware that the crossfeed function is capable of making the audio distort if you choose settings which result in a too high output level. 6.9. Equalizer Figure 6.2.: The graphical equalizer Rockbox features a parametric equalizer (EQ).
Chapter 6. Sound Settings 52 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. Rockbox’s parametric EQ is composed of up to ten different bands: Band 0: Low shelf filter.
Chapter 6. Sound Settings Key Action Right Left Play Submenu Select Raises the highlighted parameter. Lowers the highlighted parameter. Moves to the previous EQ band. Moves to the next EQ band. Toggles the cursor among the three parameters (gain, centre frequency, Q) for the selected EQ band Exits the graphic EQ screen. Power Pre-cut. If too much positive gain is added through the graphical EQ, your music may distort.
Chapter 6. Sound Settings 54 nal. Most people find this noise preferable to the time-varying noise heard when not performing dithering. After dithering, noise shaping is performed. This basically just pushes the dithering noise to the parts of the frequency spectrum humans cannot hear so easily. In Rockbox’ case, some of the noise is pushed up to above 10 kHz.
Chapter 6. Sound Settings 55 6.14. Auditory Fatigue Reduction Human hearing is more senstive to some frequency bands. This setting applies additional equalization and bi-shelf filtering to reduce signals in these bands to minimize the chance that temporary threshold shift (auditory fatigue) occurs. 6.15. Compressor The Compressor reduces, or compresses, the dynamic range of the audio signal.
Chapter 7. Playback Settings 56 7. Playback Settings The Playback Settings menu allows you to configure settings related to audio playback. 7.1. Shuffle Turning shuffle on will cause Rockbox to randomly re-order the playlist. Thus, to shuffle all of the audio files on the player, you first need to create a playlist containing all of them. For more information on creating playlists refer to section 4.4 (page 34). Options: Yes/No. 7.2.
Chapter 7. Playback Settings 57 7.3. Play Selected First This setting controls what happens when you select a file for playback while shuffle mode is on. If the Play Selected First setting is Yes, the file you selected will be played first. If this setting is No, a random file in the directory will be played first. 7.4. Fast-Forward/Rewind These settings control the speed and acceleration during fast forward and rewind.
Chapter 7. Playback Settings Fade In Delay. The “fade in delay” is the length of time between when the crossfade process begins and when the new track begins to fade in. Fade In Duration. The length of time, in seconds, that it takes your music to fade in once the Fade In Delay has ended. Fade Out Delay. The “fade out delay” is the length of time between when the crossfade process begins and when the old track begins to fade out. Fade Out Duration.
Chapter 7. Playback Settings 59 settings) have the same apparent volume. This prevents sudden changes in volume when changing between songs recorded at different volume levels. For replaygain to work, the songs must have been processed by a program that adds replaygain information to the ID3 tags (or Vorbis tags). Options for replaygain are: Replaygain Type. Choose the type of replaygain to apply: Album Gain.
Chapter 7. Playback Settings 60 Note: This feature only works when songs have been played from the file browser. Using it with the database may cause unexpected behaviour. b 7.11. Constrain Auto-Change If enabled and you have set Start File Browser Here to a directory other than root, Auto-Change Directory will be constrained to the directory you have chosen and those below it. See section 4.1.2 (page 25). 7.12. Last.fm Log Enables logging of your played tracks for submittal to http://www.last.fm.
Chapter 7. Playback Settings 61 7.15. Prevent Track Skipping If this option is enabled, the ability to manually skip tracks is disabled in order to avoid accidental track skips. It does not prevent changing tracks if a track ends, which can be achieved by combining this option with Repeat set to One 7.16. Rewind Before Resume When restarting a track or a bookmark, a short rewind can be done before the playback is started.
Chapter 8. General Settings 8. General Settings Figure 8.1.: The general settings screen 8.1. Playlist The Playlist sub menu allows you to configure settings related to playlists. Recursively Insert Directories. If set to On, then when a directory is inserted or queued into a dynamic playlist, all subdirectories will also be inserted. If set to Ask, Rockbox will prompt the user about whether to include sub-directories. Warn When Erasing Dynamic Playlist.
Chapter 8. General Settings Interpret numbers when sorting. As whole numbers enables a sorting algorithm which is similar to the default sorting of, for example, Windows Explorer, Mac OS X’s Finder or Nautilus, with regards to numbers at the beginning or within filenames. It combines consecutive digits to a number used for sorting, taking leading zeros into account. As digits disables this algorithm, and causes every digit to be compared separately.
Chapter 8. General Settings 64 If Follow Playlist is set to No, when you enter the File Browser from the WPS, you will find yourself in the directory you were in when you last left the File Browser. Show Path. If this setting is set to Full Path the full path to the current directory will be displayed on the first line in the File Browser. If set to Current Directory Only only the name of the current directory will be displayed. This has a similar effect on the Database browser.
Chapter 8. General Settings Scrolling. This feature controls how text will scroll in Rockbox. You can configure the following parameters: Scroll Speed. Sets how many times per second the automatic horizontal scrolling text will move a step. Scroll Start Delay. Controls how many milliseconds Rockbox should wait before a new text begins automatically scrolling. Scroll Step Size. Defines the number of pixels the text should move for each step, as used by the Scroll Speed setting.
Chapter 8. General Settings 66 copying music from the player via the analogue output to some other recording device. Clip Hold Time. The number of seconds that the clipping indicator will be visible after clipping is detected. Clip Counter. Show the number of times the clip indicator went active during recording in front of the peak meters. Scale. Select whether the peak meter displays linear or logarithmic values. The human ear perceives loudness on a logarithmic scale.
Chapter 8. General Settings 67 Note: The first time you enable the directory cache, Rockbox will request a reboot of the player and upon restarting take a few minutes to scan the drive. After this, the directory cache will work in the background. b 8.5.2. Limits This sub menu relates to limits in the Rockbox operating system. Max Entries in File Browser. This setting controls the limit on the number of files that you can see in any particular directory in the file browser.
Chapter 8. General Settings Once the player is shut off either manually, or automatically with the Idle Poweroff function, it must be powered up manually to resume playback. 8.5.5. Keyclick This menu controls key clicks on button presses. Keyclick. This setting controls how strong the keyclicks are. If set to Off, the keyclicks will be disabled. Keyclick repeats. This setting turns keyclick repeats On and Off. If set to On, the keyclicks will be repeated when you hold down a button.
Chapter 8. General Settings 69 8.6.2. Idle Poweroff Rockbox can be configured to turn off power after the unit has been idle for a defined number of minutes. The player is idle when playback is stopped or paused. It is not idle while the USB or charger is connected , or while recording. Settings are either Off or 1 to 10 minutes in 1 minute steps. Then 15, 30, 45 or 60 minutes are available. 8.6.3. Sleep Timer The Sleep Timer powers off your player after a given time, whether playing or not.
Chapter 8. General Settings 70 Bookmark on Stop. This option controls whether Rockbox creates a bookmark when playback is stopped manually. No. Do not create bookmarks. Yes. Always create bookmarks. Ask. Ask if a bookmark should be created. Yes – Recent Only. Always create a bookmark, but only in the recent bookmarks list. Ask – Recent Only. Ask if a bookmark should be created, but only add it to the recent bookmarks list.
Chapter 8. General Settings The following keys can be used to navigate in any bookmark list. Key Action Submenu Play Select or Right Left Home Long Select Selects the next bookmark. Selects the previous bookmark. Resumes from the selected bookmark. Exits Recent Bookmark menu Deletes the currently selected bookmark Enters the context menu for the selected bookmark. There are two options in the context menu: • Resume will commence playback of the currently selected bookmark entry.
Chapter 8. General Settings Resume on automatic track change. Controls whether the next track in an automatic track transition should be resumed at its last playback position as well. No. Automatic resume works only for manual track selection. Yes. Always attempt to resume – for both manual and automatic track changes. In custom directories only. Configure directories in which to enable resume on automatic track change.
Chapter 8. General Settings Use Directory .talk Clips. This option turns on the use of .talk clips for directories. On. Use special pre-recorded files (_dirname.talk) in each directory. These must be generated in advance, and are typically produced synthetically using a text-to-speech engine on a PC. Off. No checking is made for directory .talk clips; they are not used even if present. This can reduce disk activity. Use of a .talk clip takes precedence over other directory name voicing. Otherwise (e.g.
Chapter 9. Theme Settings 9. Theme Settings The Theme Settings menu offers options that you can change to customize the visual appearance of Rockbox. Browse Theme Files. This option will display all the currently installed themes on the player, press Select or Right to load the chosen theme and apply it. A theme is a configuration file, stored in a specific directory, that typically changes the WPS , font used and on some platforms additional information such as background image and text colours.
Chapter 9. Theme Settings Volume Display. Controls whether the volume is displayed as a graphic or a numeric value on the Status Bar. If you select a numeric display, volume is displayed in decibels. See section 6.1 (page 48) for more on the volume setting. Battery Display. Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar. Line Selector Type. This option allows you to select which type of line selector to use. Pointer.
Chapter 10. Recording Settings 10. Recording Settings Figure 10.1.: The recording settings screen Note: To change the location where recordings are stored open the Context Menu (see section 4.1.2 (page 24)) on the directory where you want to store them in the File Browser and select Set As Recording Directory. b 10.1. Format Choose which format to save your recording in.
Chapter 10. Recording Settings 77 10.4. Source Choose the source of the recording. The options are: Microphone and FM Radio. For more information on recording from the radio see section 5.9 (page 43). 10.5. Channels This allows you to select mono or stereo recording. Please note that for mono recording, only the left channel is recorded. Mono recordings are usually somewhat smaller than stereo. 10.6.
Chapter 10. Recording Settings 10.9. Clear Recording Directory Resets the location where the recorded files are saved to the root of your player’s drive. 10.10. Clipping Light Causes the backlight to flash on when clipping has been detected. Options: Off, Main unit only, Main and remote unit, Remote unit only. 10.11. Trigger When you record a source you often are only interested in the sound and not the silence in between.
Chapter 10. Recording Settings 79 pointing to the right. There are two special values. The value Off turns the start condition off. With this setting you have to start the recording manually and the trigger only stops the recording according to the stop condition. The setting -inf sets the trigger to the absolute minimum. This setting only makes sense when you record via a digital input as even the noise of the device itself would exceed this threshold immediately. for at least.
Chapter 11. Time and Date 80 11. Time and Date Time related menu options. Pressing Long Select will voice the current time if voice support is enabled. Set Time/Date: Set current time and date. Wake-Up Alarm: This option will make the player start up at the specified time. Use Right and Left to adjust the minutes setting, Left and Right to adjust the hours. Select confirms the alarm, and Power cancels setting an alarm. If the player is turned on again before the alarm occurs, the alarm will be cancelled.
Chapter 12. Plugins 12. Plugins Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit it to return to the Rockbox interface. Most plugins will not interfere with music playback but some of them will stop playback while running. Plugins have the file extension .rock.
Chapter 12. Plugins 12.1.2. Blackjack Figure 12.1.: Blackjack Blackjack, a game played in casinos around the world, is now available in the palm of your hand! The rules are simple: try to get as close to 21 without going over or simply beat out the dealer for the best hand. Although this may not seem difficult, blackjack is a game renowned for the strategy involved. This version includes the ability to split, buy insurance, and double down.
Chapter 12. Plugins 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. Ball dies; lose a life. Gain a life.
Chapter 12. Plugins same type is formed. The game is over when any bubbles on the board extend below the bottom line. To make things more difficult, the entire board is shifted down every time a certain number of shots have been fired. Points are awarded depending on how quickly the level was completed. Key Action Play Left / Right Select Power or Long Power Pause game Aim the bubble Fire bubble Exit to menu 12.1.5. Chessbox Figure 12.4.
Chapter 12. Plugins Keys Key Action Direction keys Select Home Volume Up Power Move the cursor Pick up / Drop piece Change level Force play Show the menu 12.1.6. Clix Figure 12.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 12. Plugins 12.1.7. Chopper Figure 12.6.: Chopper Navigate a cavernous maze without banging into walls, the ceiling, or the floor. How long can you fly your chopper? Key Action Select Power Make chopper fly Enter menu 12.1.8. Codebuster Figure 12.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.
Chapter 12. Plugins Key Action Power Select Left / Right Play / Submenu Show menu Check suggestion and move to next line Select a peg Change current peg 12.1.9. Dice Dice is a simple dice rolling simulator. Select number and type of dice to roll in a menu and start by choosing “Roll Dice”. The result is shown as individual numbers as well as the total of the rolled dice. Key Action Select Power Roll dice again Quit 12.1.10. Doom Figure 12.8.: Doom This is the famous Doom game.
Chapter 12. Plugins The needed files can be found at ZPluginDoom To play addon wads create the addons directory within the doom directory. Place wad files in this directory. Currently doom only supports a maximum number of 10 addons. A free alternative for Doom 2 is FreeDoom (http://freedoom.sourceforge.net). This can be used in place of doom2.wad, or it may be used as an addon in Doom, by placing it in the addons directory. Menus Rockdoom Menu. The Rockdoom menu is shown when Doom is first launched.
Chapter 12. Plugins Screen Size. Shrink or Enlarge the displayed portion of the game Gamma. Change the brightness (Gamma) of the game Sound Volume. Change the sound, music and system volume b Note: In game music is not currently supported Keys Key Action Play Submenu Left Right Select Home Power Select Volume Up Move Forward Down Turn Left Turn Right Shoot Open InGame Menu Enter Change Weapon Playing the game After installation of the wad files is complete you can start the game.
Chapter 12. Plugins Key Action Play / Submenu / Left / Right Home Home+Left Home+Right Move the cursor Home+Select Solve step by step Power Quit the game Flip Shuffle Solve 12.1.12. Goban Figure 12.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 12. Plugins you save over it). You have been warned. The file /sgf/gbn_def.sgf is used by the plugin to store any unsaved changes in the most recently loaded game. This means that if you forget to save your changes, you should load /sgf/gbn_def.sgf immediately to offload the changes to another file. If you load another file first then your changes will be lost permanently. The /sgf/gbn_def.sgf file is also the file loaded if another is not selected.
Chapter 12. Plugins Save As. Save to a specified file. Game Info. View and modify the metadata of the current game. Playback Control. Control the playback of the current playlist and modify the volume of your player. Zoom Level. Zoom in or out on the board. If you set the zoom level, it will be saved and used again the next time you open this plugin. Options. Open the Options Menu. Context Menu. Open the Context Menu which allows you to set play modes and other tools. Quit. Leave the plugin.
Chapter 12. Plugins Place. The place that this game took place. Round. If part of a tournament, the round number for this game. Done. Return to the previous menu. Options. Customize the behavior of the plugin in certain ways. Show Child Variations? Enable this to mark child variations on he board if there are more than one. Note: variations which don’t start with a move are not visible in this way.
Chapter 12. Plugins Circle Mode. Add circle marks to the board, or remove them. Square Mode. Add square marks to the board, or remove them. Triangle Mode. Add triangle marks to the board, or remove them. Label Mode. Add one character labels to the board. Each label starts at the letter ‘a’ and each subsequent application of a label will increment the letter. To remove a label, click on it until it cycles through the allowed letters and disappears. Add/Edit Comment.
Chapter 12. Plugins 12.1.14. Jewels Figure 12.12.: Jewels Jewels is a simple yet addicting game which involves swapping pairs of jewels in order to form connected segments of three or more of the same type. The goal of the game is to score as many points as possible before running out of available moves. Higher points are awarded to larger combos. The game advances to the next level after every one hundred points and randomly clears several jewels.
Chapter 12. Plugins 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. Luckily, there are checkpoints at levels four and eight. Key Action Play, Submenu, Left, Right Power Move Character Menu 12.1.16. Minesweeper Figure 12.14.: Minesweeper plugin The classic game of minesweeper.
Chapter 12. Plugins 12.1.17. Pegbox Figure 12.15.: 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. Key Action Play, Submenu, Left, Right Select Home Volume Up Volume Down Power to move around to to to to to choose peg restart level go up a level go down a level quit 12.1.18. Pong Figure 12.16.
Chapter 12. Plugins The game starts in demo mode, with the CPU controlling both sides. As soon as a button to control one of the paddles is pressed, control of that paddle passes to the player, so for a single player game, just press the appropriate buttons to control the side you want to play. For a two player game, both players should just press the appropriate buttons for their side.
Chapter 12. Plugins 12.1.21. Rockblox Figure 12.18.: Rockblox Rockblox is a Rockbox version of the classic falling blocks game from Russia. The aim of the game is to make the falling blocks of different shapes form full rows. Whenever a row is completed, it will be cleared away, and you gain points. For every ten lines completed, the game level increases, making the blocks fall faster. If the pile of blocks reaches the ceiling, the game is over.
Chapter 12. Plugins 12.1.23. Sliding Puzzle Figure 12.19.: 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 179)).
Chapter 12. Plugins This is the popular snake game. The aim is to grow your snake as large as possible by eating the dots that appear on the screen. The game will end when the snake touches either the borders of the screen or itself. Key Action Play / Submenu / Left / Right Select Move snake Toggle Play/Pause Go to the plugin’s menu 12.1.25. Snake 2 Figure 12.21.: Snake 2 – The Snake Strikes Back Another version of the Snake game.
Chapter 12. Plugins 12.1.26. Sokoban Figure 12.22.: 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 12. Plugins Note that some level sets may contain levels that are too large for this version of Sokoban and are unplayable as a result. 12.1.27. Solitaire Figure 12.23.: 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.
Chapter 12. Plugins 12.1.28. Spacerocks Figure 12.24.: 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. Key Action Select Play Left/ Right Submenu Home Power Shoot Thrust Turn left/right Teleport Pause game Quit 12.1.29. Star Figure 12.25.: Star game This is a puzzle game.
Chapter 12. Plugins allow your filled circle to get to places on the screen it could not otherwise reach. The block cannot take “o”s. Key Action Left Right Play Submenu Select Select+Left Select+Submenu Move Left Move Right Move Up Move Down Switch between circle and square Previous level Reset level Select+Right Next level Power Exit the game 12.1.30. Sudoku Figure 12.26.: Sudoku Sudoku in Rockbox can act as both a plugin and a viewer.
Chapter 12. Plugins The scratchpad When you play Sudoku on paper most people like to mark numbers in cells that are possible candidates for the cells. This can be done with the scratchpad, shown as separate column. Change the number under the cursor to the number you want to put on the scratchpad and press the scratchpad button, the number will then be added. If the number was already on the scratchpad it will get removed again. The column is stored separately for every cell on the board.
Chapter 12. Plugins Wormlet is a multi-worm game on a multi-threaded multi-functional Rockbox console. You navigate a hungry little worm. Help your worm to find food and to avoid poisoned argh-tiles. The goal is to turn your tiny worm into a big worm for as long as possible. Game controls: Key Action Left Right Play Submenu Turn Turn Turn Turn left right Up Down The game Use the control keys of your worm to navigate around obstacles and find food. Worms do not stop moving except when dead.
Chapter 12. Plugins • If you want to stop the game and still see the screen hit . This freezes the game. If you hit button again a new game starts with the same configuration. To return to the games menu you can hit . A stopped game can not be resumed. 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.
Chapter 12. Plugins 12.1.32. Xobox Figure 12.28.: Xobox Xobox is a simple clone of the well known arcade game Qix. The aim of the game is to section off parts of the arena with your trail in order to remove that section from the game. Be careful not to get in the way of enemy balls because, if they hit you or your trail, you lose a life. To finish a level you have to section off more than 75%. Key Action Play, Submenu, Left, Right Home Power Move around the arena Pause Open menu 12.1.33.
Chapter 12. Plugins 12.2. Demos 12.2.1. Bounce Figure 12.29.: Bounce This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background. In Scroll mode the bouncing text is replaced by a different one scrolling from right to left. Key Action Play/ Submenu Right / Left Select Power or Long Power Moves to next/previous option Increases/decreases option value Toggles Scroll mode Exits bounce demo Available options are: Xdist/Ydist.
Chapter 12. Plugins 12.2.3. Cube Figure 12.30.: Cube This is a rotating cube screen saver in 3D. Key Action Select Play Submenu Right / Left Volume Down / Volume Up 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 12.2.4. Demystify Figure 12.31.: Demystify Demystify is a screen saver like demo.
Chapter 12. Plugins Key Action Left / Right Play / Submenu Power Increase / decrease speed Add / remove polygon Quit 12.2.5. Fire Figure 12.32.: Fire Fire is a demo displaying a fire effect. Key Action Play / Submenu Left Right Power Increase / decrease number of flames Toggle flame type Toggle moving flames Quit 12.2.6. Fractals Figure 12.33.: Fractals: Mandelbrot set This demonstration draws fractal images from the Mandelbrot set.
Chapter 12. Plugins Key Action Direction keys Volume Up Volume Down Move about the image Zoom in Zoom out Select+Left Decrease iteration depth (less detail) Select+Right Increase iteration depth (more detail) Home Power Reset and return to the default image Quit 12.2.7. Logo Demo showing the Rockbox logo bouncing around the screen. Key Action Right / Left Play / Submenu Power or Long Power Increase / decrease speed on the x-axis Increase / decrease speed on the y-axis Quit 12.2.8.
Chapter 12. Plugins Key Action Play Change the gap between the drawing lines. Restart the drawing process. Exits Mosaique demo Select Power or Long Power 12.2.9. Oscilloscope Figure 12.35.: Oscilloscope This demo shows the shape of the sound samples that make up the music being played. At faster speed rates, the player is less responsive to user input and music may start to skip.
Chapter 12. Plugins 12.2.10. PictureFlow Figure 12.36.: 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 179)) and database (see section 4.2 (page 27)) features of Rockbox.
Chapter 12. Plugins Playback Control. Control music playback from within the plugin. Settings. Enter the settings menu. Return. Exit menu. Quit. Exit PictureFlow plugin. Settings Menu Show FPS. Displays frames per second on screen. Spacing. The distance between the front edges of the side slides, i.e. changes the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom. Centre margin.
Chapter 12. Plugins Key Action Play / Submenu Select Power / Long Power Increase / decrease Frequency Change Color Exit 12.2.12. Rocklife This an implementation of J. H. Conway’s Game of Life (see http://en.wikipedia.org/ wiki/Conway%27s_Game_of_Life for a detailed description). Rockbox can open files with a configuration description (.cells files). Just “play” such file and the game configuration stored in it will be loaded into this plugin. A .cells file is a text file.
Chapter 12. Plugins 12.2.14. Starfield Figure 12.39.: Starfield Starfield simulation (like the classic screensaver). Key Action Right / Left Play / Submenu Select Power or Long Power Increase / decrease number of stars Increase / decrease speed Change colours Quit 12.2.15. VU meter Figure 12.40.: 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.
Chapter 12. Plugins Key Action Power Home Select Volume Up Volume Down Save settings and quit Help Settings Raise Volume Lower Volume 12.3. Viewers Viewers are plugins which are associated with specific file extensions. They cannot be run directly but are started by “playing” the associated file. Viewers are stored in the /.rockbox/rocks/viewers/ directory. Note: Some viewer plugins can only be used by selecting the Open With... option from the Context Menu (see section 4.1.2 (page 24)).
Chapter 12. Plugins text file with every line containing the name of the file or the directory you want to quickly jump to. All names should be full absolute names, i.e. they should start with a /. Directory names should also end with a /. How to create .link files You can use your favourite text editor to create a .link file on the PC an then copy the file to the player.
Chapter 12. Plugins There are lots of tiny Chip8 games (usually only about 256 bytes to a couple of KB) which were made popular by the HP48 calculator’s emulator for them. The original Chip8 had 64×32 pixel graphics, and the new superchip emulator supports 128×64 graphics. The only problem is that they are based on a 4×4 keyboard, but since most games do not use all of the buttons, this can easily be worked around. To do this, one may put a .
Chapter 12. Plugins This port of Frotz attempts to be compliant with the Z-Machine Specification version 1.0. Some places where you can find Z-Machine games, and information about interactive fiction: • The Interactive Fiction Archive, where many free modern works can be downloaded: http://www.ifarchive.org/ • The specific folder on the if-archive containing Z-Machine games: http://www. ifarchive.org/indexes/if-archiveXgamesXzcode.
Chapter 12. Plugins Key Action Play / Submenu / Left / Right Select Long Select Volume Up Volume Down Move around in zoomed in image Home Power Toggle slide show mode Show menu / Abort Zoom in Zoom out Next image in directory Previous image in directory The menu has the following entries. Return. Returns you to the image Toggle Slideshow Mode. Enables or disables the slideshow mode. Change Slideshow Timeout. You can set the timeout for the slideshow between 1 second and 20 seconds.
Chapter 12. Plugins Non-supported libraries. The coroutine, debug and math libraries are not supported. Partially-supported libraries. The os and package libraries are only partially supported. Additional libraries. The bitlib library is integrated to support bitwise operators. See http://luaforge.net/projects/bitlib and http://lua-users.org/wiki/BitwiseOperators. Documentation of the API is still a work in progress, and the API itself is not finalised. For the latest information, see ZPluginLua.
Chapter 12. Plugins Key Action Play Power Volume Up / Volume Down Left / Right Select Pause / Resume Stop Adjust volume up / down Rewind / Fast Forward Open the MPEG Player menu When a video file is selected, the Start Menu will be displayed, unless it is disabled via the Resume Options (see below). In the latter case the video will start playing immediately. Start Menu Play from beginning Resume information is discarded and the video plays from the start.
Chapter 12. Plugins Display Options Menu Dithering (default: off) Prevent banding effects in gradients by blending of colours.
Chapter 12. Plugins Remark: Bitrates above 160 kbps cannot be used in MPEG 2 Layer 3 bitstreams. The encoder plugin automatically limits the output bitrate to 160 kbps for input files with a sample rate of 16, 22.05 or 24 kHz. The same limitation is valid for mono files. The output .mp3 file is written to the same path as the .wav file using the same filename. To use this plugin, open the Context Menu (see section 4.1.2 (page 24)) on a .wav file and select Open With. . . → mp3_encoder.
Chapter 12. Plugins Rockboy menu Load Game. . . Loads a previously saved game. Save Game. . . Saves your current state. Options. . . Max Frameskip. Change frameskip setting to improve speed. Sound. Toggle sound on or off. Stats. Toggle showing fps and current frameskip. Set Keys (BUGGY) Select this option to set a new keymapping. Note: The direction keys are set for the normal screen orientation, not the rotated orientation. Screen Size.
Chapter 12. Plugins 12.3.13. Text Viewer Figure 12.42.: 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 12. Plugins Encoding Set the codepage in the text viewer. Available settings: ISO-8859-1 (Latin 1). ISO-8859-7 (Greek), ISO-8859-8 (Hebrew), CP1251 (Cyrillic), ISO-8859-11 (Thai), CP1256 (Arabic), ISO-8859-9 (Turkish), ISO-88592 (Latin Extended), CP1250 (Central European), SJIS (Japanese), GB2312 (Simple Chinese), KSX-1001 (Korean), BIG5 (Traditional Chinese), UTF-8 (Unicode), This setting only applies to the plugin and is independent from the Default Codepage setting (see section 8.
Chapter 12. Plugins Scroll Settings The scrolling settings submenu. Horizontal Submenu for horizontal scrolling settings. Scrollbar Toggle the horizontal scrollbar for the current mode. If the file fits on one screen, there is no scrollbar and this setting has no effect. No Do not display the horizontal scroll bar. Yes Display the horizontal scroll bar. Scroll Mode Change the function of the “Left” and “Right” buttons. Scroll by Screen Move to the previous/next screen.
Chapter 12. Plugins Select Bookmark Select a saved bookmark. In the screenshot below, the “*” denotes the current page. Figure 12.43.: The select bookmark menu Global Settings Set the default settings for the text viewer. The setting items are the same as Viewer Options. The global settings are stored in .rockbox/rocks/viewers/viewer.dat. Quit Exits the plugin. The text viewer automatically stores its settings, the current position and bookmarks in .rockbox/rocks/viewers/viewer_file.dat.
Chapter 12. Plugins which items have been deleted and which are being kept. Exit this screen by pressing any key. A file called theme_remove_log.txt is created in the root directory of your player listing all the changes. Remove Options. This menu specifies which items are removed if Remove Theme is selected in the menu. One of the following options can be chosen for each setting. Ask for Removal.
Chapter 12. Plugins Note: VBRfix can only run when music is turned off (since it uses the same memory as the player) and can take a while to complete if run on big files. b 12.3.16. ZXBox Figure 12.45.: 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.
Chapter 12. Plugins 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. You would enter the full path and desired name - for example /games/zx/snapshots/chuckie.sna. The snapshot format will be chosen after the extension you specified, per default .z80 will be taken in case you leave it open. Toggle Fast Mode.
Chapter 12. Plugins Key configuration Key Action Left / Right Play / Submenu Select Power Switch between hours/minutes selection Increase/Decrease hours/minutes Set the alarm Exit Setting an alarm First select a track and play it, then launch the “alarmclock” plugin. The plugin pauses the playback. Enter a 24h-time (e.g. 13:58) and set the alarm. Music playback will resume when the set time is reached. 12.4.2.
Chapter 12. Plugins Information explained At the top of the battery_bench.txt file is various information on how to use the plugin, followed by the data themselves. Time This column reports the total time of operation of the player. It is not the time that you started the plug-in. If you have your player on for 5 minutes and then start the plugin, it will start measuring from 5 minutes. Seconds The same as Time, except measured in seconds.
Chapter 12. Plugins 12.4.3. Calculator Figure 12.46.: Calculator This is a simple scientific calculator for use on the player. It works like a standard calculator. Pressing the “1st” and “2nd” buttons will toggle between other available math functions. Key Action Left / Right / Play / Submenu Move around the keypad Select Home Select a button Delete last entered digit or clear after calculation Calculate Quit Long Select Power 12.4.4. Calendar Figure 12.47.
Chapter 12. Plugins You can select what day is first day of week by the setting First Day of Week in the menu. Key Action Left / Right / Play / Submenu Move the selector Select Volume Up / Volume Down Show memos for the selected day Previous / Next month Power Quit 12.4.5. Chess Clock Figure 12.48.: Chess Clock The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players.
Chapter 12. Plugins • Then the maximum round time is entered. For example, this could be used to play Scrabble for a maximum of 15 minutes each, with each round taking no longer than one minute. • Done. Player 1 starts in paused mode. While playing The number of the current player is displayed on the top line. The time below is the time remaining for that round (and possibly also the total time left if different).
Chapter 12. Plugins Key configuration Key Action Left / Right Play / Submenu Power Select Long Select Cycle through modes Cycle through skins Main Menu Start / Stop Counter Reset Counter Clock Menu View Clock Exits the menu and returns to the current clock mode display. Mode Selector Opens a menu from which you can select a clock mode to view. Counter Settings Opens a menu from which you can adjust settings pertaining to the counter.
Chapter 12. Plugins Digital mode An imitation of an LCD, this mode shows a Clock comprised of digital “segments”. The Date readout, if enabled, is displayed at the bottom, center. The Second readout, if in “Text” mode, is displayed at the top, center; if in “Bar” mode, is displayed as a progress bar at the top of the LCD; if in “Invert” mode, will invert the LCD left-to-right as the seconds pass (a fully-inverted LCD means the entire minute has passed).
Chapter 12. Plugins Warning: Be careful when you use custom entries as you could accidentally delete important files. ! Available Options All selects all Linux, OS X, and Windows files. None deselects all file options. Linux selects Linux files. Default files are .dolphinview, .d3lphinview, and .Trash-*/. Windows selects Windows files. Default files are Thumbs.db, $RECYCLE.BIN/, Desktop.ini, Recycled/ and System Volume Information/. Mac selects OS X files. .Trashes/. Default files are ._*, .
Chapter 12. Plugins 12.4.9. Lamp Lamp is a simple plugin to use your player as a lamp (flashlight, torch). You get an empty screen with maximum brightness. Key Action Left / Right Play / Submenu Power or Long Power Toggle between colours Change the brightness Exit to menu 12.4.10. Lrcplayer This plugin displays lyrics in .lrc files (and some other formats) synchronized with the song being played. Supported file types 1. .lrc 2. .lrc8 3. .snc 4. .txt 5. id3v2 SYLT or USLT tags in mp3 files .
Chapter 12. Plugins Location of lyrics files The plugin checks the following directories for lyrics files. If no lyrics file is found and the audio file is a .mp3, it also checks for SYLT and USLT tags in the id3v2 tags. 1. The directory containing the audio file and its parent directories. 2. For each of the above directories, the plugin searches for a subdirectory named “Lyrics”. 3. Finally, the plugin will search as above, but within a directory called “/Lyrics”.
Chapter 12. Plugins Controls Key Action Volume Up / Volume Down Left Volume up/down. Long Left Right Long Right Play Power or Select Long Select Home Go to beginning of track, or if pressed while in the first seconds of a track, go to the previous track. Rewind in track. Go to the next track. Fast forward in track. Toggle play/pause. Exit the plugin. Enter timetag editor. Enter Lrcplayer Menu. Lrcplayer Menu Theme settings. Change theme related settings. Show Statusbar.
Chapter 12. Plugins Playback Control. Show the playback control menu. Time Offset. Set an offset for the time tags for the lyrics currently in use. Timetag Editor. Enter the timetag editor. Quit. Exit the plugin. Editing the time tags The display time for each line can be changed with the timetag editor. Selecting a line changes its time to the current position of the track. To set a specific time or to adjust the time, press Long Select to bring up a screen to adjust the time.
Chapter 12. Plugins Programmed Track Mode When starting the plugin as a viewer for tempomap files (ending in .tempo), it starts in the track mode that offers playback of a preprogrammed metronome track consisting out of multiple parts, each with possibly different properties. In contrast to the simple mode, there exists the notion of meter and bars, along with emphasis on certain beats.
Chapter 12. Plugins The syntax of programmed tracks in tempomap files follows the format defined by http://das.nasophon.de/klick/. Actually, the goal is to keep compatibility between klick and this Rockbox metronome. The parts of a track are specified one line each in this scheme (pieces in [] optional): [name:] bars [meter ]tempo[-tempo2[*accel|/accel] [pattern] [volume] The bar count and tempo always have to be specified, the rest is optional.
Chapter 12. Plugins The 12/12 for the shuffle create 1/4 triplets. Just do a bit of math;-) This is still a metronome, not a drum machine, but it can act like a basic one, helping you to figure out a certain rhythm within the meter. The UI is developed so that it fits into the display of a Sansa Clip+ and that is the hardware device it is tested on. It seems to work reasonably on some other models in the simulator.
Chapter 12. Plugins 12.4.15. Random Folder Advance Configuration This plugin is used to configure the folders which will be considered when the AutoChange Directory feature is set to Random. Menu Generate Folder List Generates a list of all folders found on the player. You can filter the directories which are scanned by creating a file called /.rockbox/folder_advance_dir.txt. Only the directories in this file and any contained directories will be scanned.
Chapter 12. Plugins 12.4.16. Resistor Calculator Figure 12.50.: Resistor calculator The resistor calculator is a plugin that works in 3 modes: Colour to Resistance In Colour to Resistance mode, use the menus to select the colours of the bands of a resistor which you would like to know the resistance of.
Chapter 12. Plugins 12.4.17. Rockpaint Figure 12.51.: Rockpaint Rockpaint is a bitmap (.bmp) editor for Rockbox. It can open any .bmp file whose dimensions are the same size as your device’s screen or smaller; it can also create empty bitmaps for you to work with. Opening A File To open a file, you may use either the context menu option “Open With” in the File Browser, or you may enter Rockpaint first using the Plugins menu and open a file from there.
Chapter 12. Plugins Curve tool Allows you to draw a line and curve it. Rectangle tool Draws an unfilled rectangle. Circle tool Draws an unfilled circle. Gradient fill To use this tool, click at the starting and ending points. Starting with the background and going to the foreground colour, Rockpaint will fill the region with a gradual colour change. Bucket fill Fills an same-colour or empty region with a colour. Dropper Click on a colour in the image to change the foreground colour to it.
Chapter 12. Plugins Choose colour Allows you to manually edit the foreground colour. You can edit the RBG and/or the HSV values. Grid size Allows you to show or hide a grid over the canvas, and to specify its size. Exit Exits Rockpaint. Warning: BE CAREFUL. Rockpaint will NOT prompt you to save if you select Exit, so any unsaved changes will be lost. Key Action Power Left / Right / Play / Submenu Quits Rockpaint immediately. Moves the cursor around. Home Volume Up Select Displays the Main Menu.
Chapter 12. Plugins 12.4.19. Stopwatch Figure 12.53.: Stopwatch A simple stopwatch program with support for saving times. Key Action Power Right Left Select Play / Submenu Quit Plugin Start / stop Reset timer (only when timer is stopped) Take lap time Scroll through lap times 12.4.20. Text Editor This plugin allows you to view and edit simple text documents on your DAP. You can view files by using Open with from the Context Menu (see section 4.1.2 (page 24)).
Chapter 12.
Chapter 13. Advanced Topics 13. Advanced Topics 13.1. Customising the User Interface 13.1.1. Customising The Main Menu It is possible to customise the main menu, i.e. to reorder or to hide some of its items (only the main menu can be customised, submenus can not). To accomplish this, load a .cfg file (as described in section 13.
Chapter 13. Advanced Topics 159 Note: Advanced Users Only: Any BDF font should be usable with Rockbox. To convert from .bdf to .fnt, use the convbdf tool. This tool can be found in the tools directory of the Rockbox source code. See ZCreateFonts#ConvBdf for more details. Or just run convbdf without any parameters to see the possible options. b 13.1.4. Loading Languages Rockbox can load language files at runtime. Simply copy the .lng file (do not use the .
Chapter 13. Advanced Topics 160 mp2, mp3, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, spc, ape, mac, sap, mpg, mpeg, bmp, fmr, fnt, kbd All file extensions that are not either specifically listed in the .colours files or are not in the list above will be set to the colour given by ???. Extensions that are in the above list but not in the .colours file will be set to the foreground colour as normal.
Chapter 13. Advanced Topics 13.1.7. UI Viewport By default, the UI is drawn on the whole screen. This can be changed so that the UI is confined to a specific area of the screen, by use of a UI viewport. This is done by adding the following line to the .cfg file for a theme: ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour] Only the first two parameters have to be specified, the others can be omitted using ‘-’ as a placeholder. The syntax is very similar to WPS viewports (see section 13.
Chapter 13. Advanced Topics Files Locations: Each different “themeable” aspect requires its own file – WPS files have the extension .wps, FM screen files have the extension .fms, and SBS files have the extension .sbs. The main theme file has the extension .cfg. All files should have the same name. The theme .cfg file should be placed in the /.rockbox/themes directory, while the .wps, .fms and .sbs files should be placed in the /.rockbox/wps directory.
Chapter 13. Advanced Topics • ‘fgcolour’ and ‘bgcolour’ are 6-digit RGB888 colours, e.g. FF00FF. • %Vg defines a gradient fill that can then be used with the %Vs tag. ‘start’ and ‘end’ set the initial and final colours, and the optional ‘text’ sets the text colour. Colours are 6-digit RGB888, e.g. FF00FF. • ‘font’ is a number: 0 is the built-in system font, 1 is the current menu font, and 2-9 are additional skin loaded fonts (see section 13.2.4 (page 165)). • Only the coordinates have to be specified.
Chapter 13. Advanced Topics 164 Conditional Viewports Any viewport can be displayed either permanently or conditionally. Defining a viewport as %V(... will display it permanently. • %Vl(’identifier’,...) This tag preloads a viewport for later display. ‘identifier’ is a single lowercase letter (a-z) and the ‘. . . ’ parameters use the same logic as the %V tag explained above. • %Vd(’identifier’) Display the ‘identifier’ viewport.
Chapter 13. Advanced Topics 13.2.4. Additional Fonts Additional fonts can be loaded within each screen file to be used in that screen. In this way not only can you have different fonts between e.g. the menu and the WPS, but you can use multiple fonts in each of the individual screens. %Fl(’id’,filename,glyphs) • ‘id’ is the number you want to use in viewport declarations, 0 and 1 are reserved and so can’t be used. • ‘filename’ is the font filename to load. Fonts should be stored in /.
Chapter 13. Advanced Topics 166 be available at the end of a song. We suggest you use the conditional display tag a lot when displaying information about the next song! Alternating Sublines It is possible to group items on each line into 2 or more groups or “sublines”. Each subline will be displayed in succession on the line for a specified time, alternating continuously through each defined subline. Items on a line are broken into sublines with the semicolon ‘;’ character.
Chapter 13. Advanced Topics Using Images You can have as many as 52 images in your WPS. There are various ways of displaying images: 1. Load and always show the image, using the %x tag 2. Preload the image with %xl and show it with %xd. This way you can have your images displayed conditionally. 3. Load an image and show as backdrop using the %X tag. The image must be of the same exact dimensions as your display. Example on background image use: Example %X(background.
Chapter 13. Advanced Topics while playing your jukebox in your car, and a headphones.cfg file to store the settings that you use while listening to your player through headphones. See section 13.3.2 (page 168) below for an explanation of the format for configuration files. See section 13.3.3 (page 169) for an explanation of how to create, edit and load configuration files. 13.3.2. Specifications for .cfg Files The Rockbox configuration file is a plain text file, so once you use the Save .
Chapter 13. Advanced Topics 169 13.3.3. The Manage Settings menu The Manage Settings menu can be found in the Main Menu. The Manage Settings menu allows you to save and load .cfg files. Browse .cfg Files Opens the File Browser in the /.rockbox directory and displays all .cfg (configuration) files. Selecting a .cfg file will cause Rockbox to load the settings contained in that file. Pressing Left will exit back to the Manage Settings menu. See the Write .
Chapter 13. Advanced Topics 170 13.5.1. Display backlight The active backlight consumes a lot of power. Therefore choose a setting that disables the backlight after timeout (for setting Backlight see section 8.4 (page 64)). Avoid to have the backlight enabled all the time. 13.5.2. Replaygain Replaygain is a post processing that equalises the playback volume of audio files to the same perceived loudness.
Appendix A.
Appendix A. File formats A. File formats A.1. Supported file formats Icon File Type Extension Action when selected Directory Audio file Bookmark none various (see B.1) .bmark Game of Life .cells Configuration File .cfg Enter the directory Start playing the file and show the WPS Display all bookmarks for an audio file Show the configuration with the “Rocklife” plugin Load the settings file Chip8 game Colours .ch8 .colours Cuesheet FM Presets .cue .fmr Font .fnt Image Link .jpg .
Appendix B. Audio and metadata formats B. Audio and metadata formats B.1. Supported audio formats B.1.1. Lossy Codecs Format Extension Notes ATSC A/52 (AC3) .a52, .ac3, .rm, .ra, .rmvb .adx Supports downmixing for playback of 5.1 streams in stereo ADX Advanced Audio Coding Musepack .m4a, .m4b, .mp4, .rm, .ra, .rmvb .mpa, .mp1, .mp2, .mp3 .mpc OGG/Vorbis .ogg, .oga Sony Audio .oma, .aa3, .rm, .ra, .rmvb .rm, .ra, .rmvb .spx .vox .wma, .wmv, .asf .wma, .wmv, .
Appendix B. Audio and metadata formats mance requirements. B.1.2. Lossless Codecs Format Extension Notes Audio Interchange File Format .aif, .aiff Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.711 alaw/µ-law, QuickTime IMA ADPCM Monkey’s Audio Sun Audio .ape, .mac .au, .snd Free Lossless Audio .flac Apple Lossless Shorten True Audio Wave64 .m4a, .mp4 .shn .tta .w64 Waveform audio format .wav Wavpack .wv Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.
Appendix B. Audio and metadata formats B.1.3. Other Codecs Format Extension Atari Sound Format Synthetic music Mobile Application Format Game Boy Sound Format .cmc, .cmr, .dmc, .mpt, .mmf .gbs AY Sound Chip Music .ay Hudson Entertainment System Sound Format .hes MSX Konami Sound System .kss SMS/GG/CV Sound Format .sgc Video Game Music Format Gzipped Video Game Music Format MOD NES Sound Format .vgm .vgz .mod .nsf, .nsfe Atari SAP Sound Interface Device .sap .sid SPC700 .spc Notes .
Appendix B. Audio and metadata formats B.1.4.
Appendix B. Audio and metadata formats B.2. Supported metadata tags Rockbox supports different metadata formats. In general those tag formats are ID3 (v1.0, v1.1, v2.2, v2.3 and v2.4), APE (v1 and v2), Vorbis, MP4 and ASF. Few codecs use codec specific tags, several codecs do not use any tags yet. The following table gives an overview about what tag types rockbox supports for which audio file extension. Note: There is always only one tag type supported for each file extension.
Appendix B. Audio and metadata formats 178 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 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 177) 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 180 The following characters will be replaced with an underscore (_) when looking for albumtitle.bmp or albumartist-albumtitle.bmp: \ / : < > ? * |. Doublequotes will be replaced by single quotes. If no album artist is set, artist will be used instead. See ZAlbumArt in the wiki for programs that will help you automate the process of putting album art on your player.
Appendix D. Theme Tags D. Theme Tags Themeing is discussed in detail in section section 13.2 (page 161), what follows is a list of the available tags. Note: The “bar-type tags” (such as %pb, %pv, %bl etc.) can be further themed – see section D.28 (page 195). 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 182 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 183 D.5. Additional Fonts Tag Description %Fl(’id’,filename) See section 13.2.4. D.6. Misc Coloring Tags Tag Description %dr(x,y,width,height,[color1,color2]) Color a rectangle. width and height can be - to fill the viewport. If no color is specified the viewports foreground color will be used. If two colors are specified it will do a gradient fill. D.7. Power Related Information Tag Description %bl Numeric battery level in percents.
Appendix D. Theme Tags 184 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 186 • ‘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 188 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 190 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 179). 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 193 D.23. Alignment and language direction Tag Description %al %aL %ac %ar %aR %ax Align the text left Align the text left, or to the right if RTL language is in use Centre the text Align the text right Align the text right, or to the left if RTL language is in use The next tag should follow the set language direction. When prepended to a viewport declaration, the viewport will be horizontally mirrored if the user language is set to a RTL language.
Appendix D. Theme Tags %?if(%pv, >=, 0) will display “Clipping possible” if the volume is higher than or equal to 0 dB, “Volume OK” if it is lower. %?if(%ia, =, %Ia) – this artist and the next artist are the same. Note: When performing a comparison against a string tag such as %ia, only = and != work, and the comparison is not case sensitive. D.25. Subline Tags Tag Description %t(time) ; Set the subline display cycle time (%t(5) or %t(3.
Appendix D. Theme Tags D.27. Text Translation Tag Description %Sx(English) Display the translation of “English” in the current language • “English” must be a phrase used in the language file. • It should match the Source: line in the language file. Note: checkwps cannot verify that the string is correct, so please check on either the simulator or on target. D.28. Bar Tags Some tags can be used to display a bar which draws according to the value of the tag.
Appendix D. Theme Tags nofill – don’t draw the bar, only its frame (for use with the “slider” option). noborder – don’t draw the border for image-less bars, instead maximise the filling over the specified area. This doesn’t work for bars which specify an image. nobar – don’t draw the bar or its frame (for use with the “slider” option). setting – Specify the setting name to draw the bar from (bar must be %St type), the next param is the settings config name.
Appendix D. Theme Tags 197 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 rewind duration on pause 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 E.
Appendix F. Menu Overview 204 F.
Appendix G. User feedback 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 206 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.
