The Rockbox Manual for Iaudio X5 rockbox.
Rockbox http://www.rockbox.org/ Open Source Jukebox Firmware Rockbox and this manual is the collaborative effort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2013 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 José Maria Garcia-Valdecasas Bernal & Peter Schlenker. Version rUnversioned. Built using pdfLATEX.
Contents Contents 1. Introduction 1.1. Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2. Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3. Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 11 11 11 12 2. Installation 2.1. Before Starting . . . . . . . . . . . . . . . . 2.2. Installing Rockbox . . . . . . . . . . . . . . 2.2.1. Automated Installation . . . . . . . 2.2.2. Manual Installation . . . . . . .
Contents 4.2.3. The Database Menu . . . 4.2.4. Using the Database . . . 4.3. While Playing Screen . . . . . . . 4.3.1. WPS Key Controls . . . . 4.3.2. Peak Meter . . . . . . . . 4.3.3. The WPS Context Menu 4.4. Working with Playlists . . . . . . 4.4.1. Playlist terminology . . . 4.4.2. Creating playlists . . . . . 4.4.3. Adding music to playlists 4.4.4. Modifying playlists . . . . 4.4.5. Saving playlists . . . . . . 4.4.6. Loading saved playlists . 5. The 5.1. 5.2. 5.3. 5.4. 5.5. 5.6. 5.7.
Contents 6.7. Stereo Width . . . . . . . . . 6.8. Crossfeed . . . . . . . . . . . 6.9. Equalizer . . . . . . . . . . . 6.10. Dithering . . . . . . . . . . . 6.11. Timestretch . . . . . . . . . . 6.12. Haas Surround . . . . . . . . 6.13. Perceptual Bass Enhancement 6.14. Auditory Fatigue Reduction . 6.15. Compressor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 8.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.19.Pegbox . . . . . . . . 12.1.20.Pong . . . . . . . . . . 12.1.21.Reversi . . . . . . . . 12.1.22.Robotfindskitten . . . 12.1.23.Rockblox . . . . . . . 12.1.24.Rockblox1d . . . . . . 12.1.25.Sliding Puzzle . . . . . 12.1.26.Snake . . . . . . . . . 12.1.27.Snake 2 . . . . . . . . 12.1.28.Sokoban . . . . . . . . 12.1.29.Solitaire . . . . . . . . 12.1.30.Spacerocks . . . . . . 12.1.31.Star . . . . . . . . . . 12.1.32.Sudoku . . . . . . . . 12.1.33.Wormlet . . . . . . . . 12.1.34.Xobox . . . .
Contents 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 . . . . . . . . . . 12.4.7. Disk Tidy . . . . . . . . 12.4.8. Keybox . . . . . .
Contents 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. Display power-off . . . . . . . . . 13.5.3. Anti-Skip Buffer . . . . . . . . . 13.5.4. Replaygain . . . . . . . . . . . . 13.5.5. Peak Meter . . . . . . . . . . . . 13.5.6. Audio format and bitrate . . . . 13.5.7. 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 USB connection. To transfer Rockbox to your player you need to connect it to your computer. For manual installation/uninstallation, or should autodetection fail during automatic installation, you need to know where to access the player.
Chapter 2. Installation 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. The appearance of Rockbox can be customised by 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 The Iaudio X5 has a built-in bootloader which performs the firmware update and can also access the hard drive via USB. The Rockbox bootloader can therefore be very minimalistic, as it does not require its own USB mode.
Chapter 2. Installation 2.4. Updating Rockbox Rockbox can be easily updated with Rockbox Utility. You can also update Rockbox manually – download a Rockbox build as detailed above, and unzip the build to the root directory of your player as in the manual installation stage. If your unzip program asks you whether to overwrite files, choose the “Yes to all” option. The new build will be installed over your current build. The bootloader only changes rarely, and should not normally need to be updated.
Chapter 3. Quick Start 18 3. Quick Start 3.1. Basic Overview 3.1.1. The player’s controls Throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prefixed by “Long”, a long press of approximately one second should be performed on that button.
Chapter 3. Quick Start detail in the following paragraph. Additional information for blind users is available on the Rockbox website at ZBlindFAQ. The player is curved so that the end with the screen on it is thicker than the other end. Hold the player wih the thick end towards the top and the screen facing towards you. Half way up the front of the unit on the right hand side is a four way joystick which is the Up, Down, Left, and Right buttons. When pressed it serves as Select.
Chapter 3. Quick Start 20 directory structure that is assumed by some parts of Rockbox (album art searching, and missing-tag fallback in some WPSes) uses the parent directory of a song as the Album name, and the parent directory of that folder as the Artist name. WPSes may display information incorrectly if your files are not properly tagged, and you have your music organized in a way different than they assume when attempting to guess the Artist and Album names from your filetree.
Chapter 3. Quick Start 21 Menu From the menu you can customise Rockbox. Rockbox itself is very customisable. Also there are some special menus for quick access to frequently used functions. Context Menu Some views, especially the file browser and the WPS have a context menu. From the file browser this can be accessed with Long Select. The contents of the context menu vary, depending on the situation it gets called.
Chapter 4. Browsing and playing 22 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 Remote Key Action Up/Down Play Volume Up/Volume Down Rewind Play or Forward Play Long Play Long Select Rec Long Rec Long Play Long Mode Menu Long Menu 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.
Chapter 4. Browsing and playing Playlist. Enters the Playlist Submenu (see section 4.4.3 (page 35)). Playlist Catalogue. Enters the Playlist Catalogue Submenu (see section 4.4.2 (page 34)). 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 Key Remote Key Action Left / Right Rewind / Forward Up / Down Volume Up / Volume Down Move the cursor on the virtual keyboard. If you move out of the picker area, you get the previous/next page of characters (if there is more than one). Move the cursor on the virtual keyboard. If you move out of the picker area you get to the line edit mode. Flip to the next page of characters (if there is more than one).
Chapter 4. Browsing and playing that directory and all its subdirectories from scanning their tags and adding them to the database. This will speed up the database initialization. If a subdirectory of an ‘ignored’ directory should still be scanned, place a file named database.unignore in it. The files in that directory and its subdirectories will be scanned and added to the database. 4.2.3.
Chapter 4. Browsing and playing Note: You may need to increase the value of the Max Entries in File Browser setting (Settings → General Settings → System → Limits) in order to view long lists of tracks in the ID3 database browser. There is no option to turn off database completely. If you do not want to use it just do not do the initial build of the database and do not load it to RAM.
Chapter 4. Browsing and playing 29 change the display of the WPS. • Status bar: The Status bar shows Battery level, charger status, volume, play mode, repeat mode, shuffle mode and clock. In contrast to all other items, the status bar is always at the top of the screen. • (Scrolling) path and filename of the current song. • The ID3 track name. • The ID3 album name. • The ID3 artist name. • Bit rate. VBR files display average bitrate and “(avg)” • Elapsed and total time.
Chapter 4. Browsing and playing 4.3.1. WPS Key Controls Key Remote Key Action Up / Down Volume up/down.
Chapter 4. Browsing and playing without being indicated. The scale: Between the indicators of the right and left channel there are little dots. These dots represent important volume values. In linear mode each dot is a 10% mark. In dBFS mode the dots represent the following values (from right to left): 0 dB, -3 dB, -6 dB, -9 dB, -12 dB, -18 dB, -24 dB, -30 dB, -40 dB, -50 dB, -60 dB. 4.3.3.
Chapter 4. Browsing and playing 32 Playback Settings This is a shortcut to the Playback Settings Menu, where you can configure shuffle, repeat, party mode, skip length and other settings affecting the playback of your music. Rating The menu entry is only shown if Gather Runtime Information is enabled. It allows the assignment of a personal rating value (0 – 10) to a track which can be displayed in the WPS and used in the Database browser. The value wraps at 10.
Chapter 4. Browsing and playing Pitch The Pitch Screen allows you to change the rate of playback (i.e. the playback speed and at the same time the pitch) of your player. The rate value can be adjusted between 50% and 200%. 50% means half the normal playback speed and a pitch that is an octave lower than the normal pitch. 200% means double playback speed and a pitch that is an octave higher than the normal pitch. The rate can be changed in two modes: procentual and semitone.
Chapter 4. Browsing and playing 34 Directory. A playlist! One of the keys to getting the most out of Rockbox is understanding that Rockbox always considers the song that it is playing to be part of a playlist, and in some situations, Rockbox will create a playlist automatically. For example, if you are playing the contents of a directory, Rockbox will automatically create a playlist containing all songs in it.
Chapter 4. Browsing and playing 35 to an existing playlist and Add to a new playlist creates a new playlist containing the selected track or directory. Note: All playlists in the Playlist catalogue are stored by default in the /Playlists directory in the root of your player’s disk and playlists stored in other locations are not included in the catalogue. It is however possible to move existing playlists there (see section 4.1.2 (page 23)).
Chapter 4. Browsing and playing Insert Shuffled. Add track(s) to the playlist in a random order. Insert Last Shuffled. Add tracks in a random order to the end of the playlist. Queue. Queue is the same as Insert except queued tracks are deleted immediately from the playlist after they have been played. Also, queued tracks are not saved to the playlist file (see section 5.10 (page 43)). Queue Next. Queue track(s) immediately after current playing track. Queue Last. Queue track(s) at end of playlist.
Chapter 4. Browsing and playing 37 the context menu and then move the blinking cursor to the place where you want the track to be moved and confirm with Select, Right or Play. To remove a track, simply select Remove in the context menu. 4.4.5. Saving playlists To save the current playlist either enter the Playlist submenu in the WPS Context Menu (see section 4.3.3 (page 31)) and select Save Current Playlist or enter the Playlist Options menu in the Main Menu and select Save Current Playlist.
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 Rec button. All settings are stored on the unit. However, Rockbox does not access the hard disk solely for the purpose of saving settings.
Chapter 5. The Main Menu 5.3. Recent Bookmarks Figure 5.2.: The list bookmarks screen If the Save a list of recently created bookmarks option is enabled then you can view a list of several recent bookmarks here and select one to jump straight to that track. Note: Bookmarking only works when tracks are launched from the file browser, and does not currently work for tracks launched via the database. In addition, they do not currently work with dynamic playlists.
Chapter 5. The Main Menu 40 5.5. Database Browse by the meta-data in your audio files (see section 4.2 (page 26)). 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 28)). 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 41 5.7.6. Manage Settings The Manage Settings option allows the saving and re-loading of user configuration settings, browsing the hard drive for alternate firmwares, and finally resetting your player back to initial configuration. The details of this menu are covered in section 13.3 (page 173). 5.8. Recording 5.8.1. While Recording Screen Figure 5.3.
Chapter 5. The Main Menu Key Remote Key Action Up / Down Select setting. Play Volume Up / Volume Down Rewind / Right Play Long Play Long Play Rec Rec Long Rec Menu Left / Right Adjust selected setting. Start recording. While recording: pause recording (press again to continue). Exit Recording Screen. While recording: Stop recording. Start recording. While recording: close the current file and open a new one. Open Recording Settings (see section 10 (page 78)). 5.9. FM Radio Figure 5.4.
Chapter 5. The Main Menu Key Remote Key Action Left, Right Rewind, Forward Long Left, Long Right Up, Down Rec Long Rewind, Long Forward Volume Up, Volume Down Menu Change frequency in SCAN mode or jump to next/previous station in PRESET mode. Seek to next station in SCAN mode. Power Long Play Play Long Play Play Long Rec Select Mode Long Select Long Mode Change volume. Leave the radio screen with the radio playing. Stop the radio and return to Main Menu. Mute radio playback.
Chapter 5. The Main Menu 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 55)), Repeat (section 7 (page 55)) 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 46 Only “type” and “data” are required (except if type is “separator” in which case “data” is also not required).
Chapter 6. Sound Settings 47 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 48 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 49 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 50 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 51 In some ways the EQ is similar to the Bass and Treble settings described earlier, but the EQ allows you to control the sound much more carefully. Note that the parameteric EQ bands will be applied in addition to any bass or treble tone controls. Note: A maximum of 10 EQ bands are possible on most devices, but using more than are required will waste battery and introduce additional rounding noise. For best results, use the fewest number of bands required.
Chapter 6. Sound Settings Key Remote Key Action Right Left Up Down Select Forward Rewind Volume Up Volume Down Play Power/Rec Rec 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. Pre-cut. If too much positive gain is added through the graphical EQ, your music may distort.
Chapter 6. Sound Settings 53 Dithering adds low-level noise to the signal prior to throwing away the surplus bits, which gives the resulting signal a uniform noise floor which is independent of the signal. Most people find this noise preferable to the time-varying noise heard when not performing dithering. After dithering, noise shaping is performed. This basically just pushes the dithering noise to the parts of the frequency spectrum humans cannot hear so easily.
Chapter 6. Sound Settings 54 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 55 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 33). Options: Yes/No. 7.2.
Chapter 7. Playback Settings 56 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 57 the track, moving to the next track in the playlist without user intervention. A manual track skip goes to the next track immediately when the appropriate button is pressed. Options for crossfade settings are: Enable Crossfade. If set to Off, crossfade is disabled and all track changes are gapless. If set to Automatic Track Change Only, crossfade occurs for automatic track changes, but not for manual track skips.
Chapter 7. Playback Settings 58 7.9. Replaygain This allows you to control the replaygain function. The purpose of replaygain is to adjust the volume of the music played so that all songs (or albums, depending on your 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).
Chapter 7. Playback Settings 59 Pre-amp. This allows you to adjust the volume when replaygain is applied. Replaygain often lowers the volume, sometimes quite much, so here you can compensate for that. Please note that a (large) positive pre-amp setting can cause clipping, unless prevent clipping is enabled. The pre-amp can be set to any decibel (dB) value between -12 dB and +12 dB, in increments of 0.5 dB. 7.10.
Chapter 7. Playback Settings 60 7.14. Cuesheet Support Enables reading of cuesheet files for played tracks. If a cuesheet is found for a track, track markers are displayed on the progressbar and it is possible to skip between the tracks within the cuesheet. Also the information found in the cuesheet file will replace the information from the ID3 tags. When you enable this option, you’ll have to reboot for it to come into effect.
Chapter 7. Playback Settings 61 7.18. Rewind on Pause This option rewinds the current track by a small amount whenever it is paused (not stopped). The amount to rewind can be set between 0 and 15 seconds.
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 65 First Keypress Enables Backlight Only. With this option enabled the first keypress while the backlight is turned off will only turn the backlight on without having any other effect. When disabled the first keypress will also perform its appropriate action. Sleep (After Backlight Off). This setting controls how long rockbox will wait before turning off the display after the backlight is turned off.
Chapter 8. General Settings Upside Down. Displays the screen so that the top of the display is nearest the buttons. This is sometimes useful when carrying the player in a pocket for easy access to the headphone socket. 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.
Chapter 8. General Settings 67 Peak Release. This determines how fast the bar shrinks when the music becomes softer. Lower values make the peak meter look smoother. Expressed in scale units per 10 ms. Peak Hold Time. Specifies the time after which the peak indicator will reset. For example, if you set this value to 5 s, the peak indicator displays the loudest volume value that occurred within the last 5 seconds.
Chapter 8. General Settings 68 Battery Capacity. This setting can be used to tell Rockbox what capacity (in mAh) the battery being used has. The default is 950 mAh, which is the capacity value for the standard battery shipped with the player. Rockbox uses this value for runtime estimation, not battery percentage calculation. Changing this setting has no effect whatsoever on actual battery life. This setting only affects the accuracy of the runtime estimation as shown on screen.
Chapter 8. General Settings 69 Glyphs To Cache. This sets the default memory allocation size for fonts in unique glyphs. This should be set to the number of unique language glyphs and punctuation marks that are frequently displayed. The default is 250. Note: You will need to restart your player for changes to Max Entries in File Browser or Max Playlist Size to take effect while Glyphs To Cache will affect the next font load. 8.5.4.
Chapter 8. General Settings 8.6.1. Start Screen Set the screen that Rockbox will start in. The default is the main menu but the following options are available: Previous Screen. Start Rockbox in the same screen as when it was shut off. Main Menu. Show the main menu. Files. Display the file browser, starting in the root directory of your player. Database. Show the default database view. Resume Playback.
Chapter 8. General Settings 71 Start Sleep Timer On Boot: If set, a Sleep Timer will be initiated when the device starts. Restart Sleep Timer On Keypress: If set, when a Sleep Timer is active and a key is pressed, the Sleep Timer will be restarted with the initial duration. 8.7. Bookmarking Bookmarks allow you to save your current position within a track so that you can return to it at a later time. Bookmarks also store rate, pitch and speed information from the Pitch Screen (see section 4.3.
Chapter 8. General Settings files. In this case you should set the setting Bookmark on Stop to “No” and the setting Update on Stop to “Yes”. Load Last Bookmark. This option controls if Rockbox should automatically load a bookmark for a file, when that file is played. No Always start from the beginning of the track or playlist. Yes Automatically return to the position of the last bookmark. Start from the beginning if there are no bookmarks.
Chapter 8. General Settings 73 8.8. Automatic resume The automatic resume feature stores and recalls resume positions for all tracks without user intervention. These resume points are stored in the database, and thus automatic resume only works when the database has been initialized. When automatic resume is enabled, manually selected tracks resume playback at their last playback position.
Chapter 8. General Settings section 13.1.4 (page 164) for further details about languages. 8.10. Voice Voice Menus. This option controls the voicing of menus/settings as they are selected by the cursor. In order for this to work, a voice file must be present in the /.rockbox/langs/ directory on the player. Voice files are large and are not shipped with Rockbox by default. The voice file is the name of the language for which it is made, followed by the extension .voice.
Chapter 8. General Settings On. Use special pre-recorded files for each file. This functions the same as for directories except that the .talk clip file must have the same name as the described file with an extra .talk extension (e.g. Punkadiddle.mp3 would require a file called Punkadiddle.mp3.talk). Off. No checking is made for file .talk clips; they are not used even if present. This can reduce disk activity. Use of a .talk clip takes precedence over other filename voicing. Otherwise (e.g. if a .
Chapter 9. Theme Settings 76 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.
Chapter 9. Theme Settings Status/Scrollbar. Settings related to on screen status display and the scrollbar. Scroll Bar. Allows you to choose where the vertical scroll bar should appear. Scroll Bar Width. Allows you to choose the width of the scroll bar (in pixels). Default value is 6. Status Bar. Allows you to choose where to display the statusbar on the main display. Remote Status Bar. Allows you to choose where to display the statusbar on the remote display. Volume Display.
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 23)) on the directory where you want to store them in the File Browser and select Set As Recording Directory. b 10.1. Format Choose which format to save your recording in.
Chapter 10. Recording Settings 79 10.4. Source Choose the source of the recording. The options are: Microphone, Line In and FM Radio. For more information on recording from the radio see section 5.9 (page 42). 10.5. Channels This allows you to select mono or stereo recording. Please note that for mono recording, only the left channel is recorded. Mono recordings are usually somewhat smaller than stereo. 10.6.
Chapter 10. Recording Settings 10.9. Clear Recording Directory Resets the location where the recorded files are saved to the root of your player’s drive. 10.10. Clipping Light Causes the backlight to flash on when clipping has been detected. Options: Off, Main unit only, Main and remote unit, Remote unit only. 10.11. Trigger When you record a source you often are only interested in the sound and not the silence in between.
Chapter 10. Recording Settings 81 pointing to the right. There are two special values. The value Off turns the start condition off. With this setting you have to start the recording manually and the trigger only stops the recording according to the stop condition. The setting -inf sets the trigger to the absolute minimum. This setting only makes sense when you record via a digital input as even the noise of the device itself would exceed this threshold immediately. for at least.
Chapter 11. Time and Date 82 11. Time and Date Time related menu options. Pressing Long Select will voice the current time if voice support is enabled. Set Time/Date: Set current time and date. Time Format: Choose 12 or 24 hour clock.
Chapter 12. Plugins 12. Plugins Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit it to return to the Rockbox interface. Most plugins will not interfere with music playback but some of them will stop playback while running. Plugins have the file extension .rock.
Chapter 12. Plugins 12.1.2. Blackjack Figure 12.1.: Blackjack Blackjack, a game played in casinos around the world, is now available in the palm of your hand! The rules are simple: try to get as close to 21 without going over or simply beat out the dealer for the best hand. Although this may not seem difficult, blackjack is a game renowned for the strategy involved. This version includes the ability to split, buy insurance, and double down.
Chapter 12. Plugins 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 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 Remote Key Action Up Left / Right Forward Volume Down / Volume Up Mode Rec Pause game Aim the bubble Select Rec or Power Fire bubble Exit to menu 12.1.5. Chessbox Figure 12.4.: Chessbox Chessbox is a one-person chess game with computer artificial intelligence.
Chapter 12. Plugins Keys Key Remote Key Direction keys Select Rec Play Power Action 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 Remote Key Select / Up Power Action 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 Remote Key Action Rec Select Left / Right Rec Mode Volume Down / Volume Up Forward / Rewind Show menu Check suggestion and move to next line Select a peg Up / Down 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 Remote Key Action Select Rec Mode Rec Roll dice again Quit 12.
Chapter 12. Plugins Your wad files. Copy all Doom wads you wish to play into that directory. The needed files can be found at ZPluginDoom To play addon wads create the addons directory within the doom directory. Place wad files in this directory. 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.
Chapter 12. Plugins InGame Options Menu. This menu has the following options: End Game. Ends the current game Messages. Enable or Disable in game messages Screen Size. Shrink or Enlarge the displayed portion of the game Gamma. Change the brightness (Gamma) of the game Sound Volume.
Chapter 12. Plugins Flipping the colour of the token under the cursor also flips the tokens above, below, left and right of the cursor. The aim is to end up with a screen containing tokens of only one colour. Key Remote Key Action Up / Down / Left / Right Select Play+Left Play+Right Move the cursor Play+Up Power Solve step by step Quit the game Flip Shuffle Solve 12.1.12. Goban Figure 12.10.
Chapter 12. Plugins little available memory. Note: The plugin does NOT support SGF files with multiple games in one file. These are rare, but if you have one don’t even try it (the file will most likely be corrupted if you save over it). You have been warned. The file /sgf/gbn_def.sgf is used by the plugin to store any unsaved changes in the most recently loaded game. 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.
Chapter 12. Plugins New. Create a new game with your choice of board size and handicaps. Save. Save the current state of the game. It will be saved to /sgf/gbn_def.sgf unless otherwise set. Save As. Save to a specified file. Game Info. View and modify the metadata of the current game. Playback Control. Control the playback of the current playlist and modify the volume of your player. Zoom Level. Zoom in or out on the board.
Chapter 12. Plugins Date. The date that this game took place. This text must follow the format specified at http://www.red-bean.com/sgf/properties.html#DT to be read by other SGF readers. Event. The name of the event which this game was a part of, if any. Place. The place that this game took place. Round. If part of a tournament, the round number for this game. Done. Return to the previous menu. Options. Customize the behavior of the plugin in certain ways.
Chapter 12. Plugins Force Play Mode. The same as Play Mode except that this mode will allow you to play illegal moves such as retaking a ko immediately without a ko threat, suicide on rulesets which don’t allow it (including single stone suicide), and playing a move where there is already a stone. Mark Mode. Add generic marks to the board, or remove them. Circle Mode. Add circle marks to the board, or remove them. Square Mode. Add square marks to the board, or remove them. Triangle Mode.
Chapter 12. Plugins 12.1.14. Jackpot Figure 12.12.: Jackpot This is a jackpot slot machine game. At the beginning of the game you have 20$. Payouts are given when three matching symbols come up. Key Remote Key Action Select Rec Mode Rec Play Exit the game 12.1.15. Jewels Figure 12.13.: Jewels Jewels is a simple yet addicting game which involves swapping pairs of jewels in order to form connected segments of three or more of the same type.
Chapter 12. Plugins Key Remote Key Left/Right/ Up/Down Select Power Action Move the cursor around the jewels Select a jewel Menu 12.1.16. MazezaM Figure 12.14.: MazezaM The goal of this puzzle game is to escape a dungeon consisting of ten “mazezams”. These are rooms containing rows of blocks which can be shifted left or right. You can move the rows only by pushing them and if you move the rows carelessly, you will get stuck.
Chapter 12. Plugins 12.1.17. Minesweeper Figure 12.15.: Minesweeper plugin The classic game of minesweeper. The aim of the game is to uncover all of the squares on the board. If a mine is uncovered then the game is over. If a mine is not uncovered, then the number of mines adjacent to the current square is revealed. The aim is to use the information you are given to work out where the mines are and avoid them.
Chapter 12. Plugins Pacbox is an emulator of the Pacman arcade machine hardware. It is a port of PIE – Pacman Instructional Emulator (http://www.ascotti.org/programming/pie/pie.htm). ROMs To use the emulator to play Pacman, you need a copy of ROMs for “Midway Pacman”. Filename MD5 checksum pacman.5e pacman.5f pacman.6e pacman.6f pacman.6h pacman.
Chapter 12. Plugins 12.1.19. Pegbox Figure 12.17.: pegbox To beat each level, you must destroy all of the pegs. If two like pegs are pushed into each other they disappear except for triangles which form a solid block and crosses which allow you to choose a replacement block. Key Remote Key Up, Down, Left, Right Select Rec Play Power Action to move around to to to to choose peg restart level go up a level quit 12.1.20. Pong Figure 12.18.: Pong Pong is a simple one or two player “tennis game”.
Chapter 12. Plugins 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. Key Remote Key Up Down Rec Play Power Action Left player up Left player down Right player up Right player down Quit 12.1.21.
Chapter 12. Plugins Key Remote Key Action Up, Down, Left, Right Forward, Rewind, Volume Down, Volume Up Rec Move robot Rec Quit 12.1.23. Rockblox Figure 12.20.: Rockblox Rockblox is a Rockbox version of the classic falling blocks game from Russia. The aim of the game is to make the falling blocks of different shapes form full rows. Whenever a row is completed, it will be cleared away, and you gain points. For every ten lines completed, the game level increases, making the blocks fall faster.
Chapter 12. Plugins 12.1.24. Rockblox1d Rockblox1d is a game for people who find rockblox too hard. In this version the second dimension is missing so the user only has to move the bricks down. No horizontal moving anymore and no need to rotate the brick! Key Remote Key Down Rec or Power Action Move down faster Quit 12.1.25. Sliding Puzzle Figure 12.21.: Sliding puzzle The classic sliding puzzle game.
Chapter 12. Plugins 12.1.26. Snake Figure 12.22.: Snake This is the popular snake game. The aim is to grow your snake as large as possible by eating the dots that appear on the screen. The game will end when the snake touches either the borders of the screen or itself. Key Remote Key Up / Down / Left / Right Play Action Move snake Toggle Play/Pause Go to the plugin’s menu 12.1.27. Snake 2 Figure 12.23.: Snake 2 – The Snake Strikes Back Another version of the Snake game.
Chapter 12. Plugins Key Remote Key Up / Down / Left / Right Select Power Action Steer the snake Pause and resume the game Quit In game A, the maze stays the same, in game B after an increasing number of apples eaten the maze is replaced by a new one. 12.1.28. Sokoban Figure 12.24.: Sokoban The object of the game is to push boxes into their correct position in a crowded warehouse with a minimal number of pushes and moves.
Chapter 12. Plugins Key Remote Key Action In game Up, Down, Left, Right Power Rec Select Play Solution playback Play Up/Down Left/Right Power Move the “sokoban” up, down, left, or right Menu Restart level Undo last movement Redo previously undone move Pause/resume Increase/decrease playback speed Go backward/forward (while paused) Quit Some places where can you can find level sets: • http://www.sourcecode.se/sokoban/levels.php • http://sokobano.de/en/levels.
Chapter 12. Plugins Key Remote Key Up / Down / Left / Right Select Action Move Cursor around. Select cards, move cards, reveal hidden cards... If a card was selected – unselect it, else Draw 3 new cards from the remains stack Put the card from the top of the remains stack on top of the cursor Put the card under the cursor on one of the 4 final colour stacks. Put the card on top of the remains stack on one of the final colour stacks. Show menu Play Long Play Long Select Rec Power 12.1.30.
Chapter 12. Plugins 12.1.31. Star Figure 12.27.: Star game This is a puzzle game. It is actually a rewrite of Star, a game written by CDK designed for the hp48 calculator. Rules: Take all of the “o”s to go to the next level. You can switch control between the filled circle, which can take “o”s, and the filled square, which is used as a mobile wall to allow your filled circle to get to places on the screen it could not otherwise reach. The block cannot take “o”s.
Chapter 12. Plugins 12.1.32. Sudoku Figure 12.28.: Sudoku Sudoku in Rockbox can act as both a plugin and a viewer. When starting Sudoku from the Browse Plugins menu, a random game will be generated automatically, and an estimate of its difficulty (very easy, easy, medium, hard or fiendish) will be displayed on the screen. New games can be generated from the Generate menu option. When “playing” an existing Sudoku game file from Rockbox’ file browser the plugin is invoked as viewer.
Chapter 12. Plugins Key Remote Key Up / Down / Left / Right Select Long Select Action Move the cursor Change number under the cursor Constantly changing the number under the cursor Open Menu Add/Remove number to scratchpad Quit Play Rec Power Some places where can you can find .ss files: • Simple Sudoku (Advanced Puzzle Packs 1 and 2 located near the bottom of that page): http://www.angusj.com/sudoku/ • Kjell’s Sudoku generator/solver: http://kjell.haxx.se/sudoku/ 12.1.33. Wormlet Figure 12.29.
Chapter 12. Plugins The game Use the control keys of your worm to navigate around obstacles and find food. Worms do not stop moving except when dead. Dead worms are no fun. Be careful as your worm will try to eat anything that you steer it across. It won’t distinguish whether it is edible or not. Food. The small square hollow pieces are food. Move the worm over a food tile to eat it. After eating the worm grows. Each time a piece of food has been eaten a new piece of food will pop up somewhere.
Chapter 12. Plugins Hungry: That’s the normal state of a worm. Worms are always hungry and want to eat. It is good to have a hungry worm since it means that your worm is alive. But it is better to get your worm growing. Growing: When a worm has eaten a piece of food it starts growing. For each step it moves over food it can grow by one pixel. One piece of food lasts for 7 steps. After your worm has moved 7 steps the food is used up.
Chapter 12. Plugins 12.1.34. Xobox Figure 12.30.: Xobox Xobox is a simple clone of the well known arcade game Qix. The aim of the game is to section off parts of the arena with your trail in order to remove that section from the game. Be careful not to get in the way of enemy balls because, if they hit you or your trail, you lose a life. To finish a level you have to section off more than 75%. Key Remote Key Up, Down, Left, Right Play Power Action Move around the arena Pause Open menu 12.1.35.
Chapter 12. Plugins Key Remote Key Up Down Left / Right Action Up and Jump Down and Crouch Move Left and Right Action and Fire Menu 12.2. Demos 12.2.1. Bounce Figure 12.31.: Bounce This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background. In Scroll mode the bouncing text is replaced by a different one scrolling from right to left.
Chapter 12. Plugins 12.2.2. Credits The credits plugin scrolls the entire list of the names of all the Rockbox contributors after displaying the Rockbox logo and version. This plugin is called when selecting Version from the System section of the Rockbox main menu. Exit at any time by pressing Left or Power. 12.2.3. Cube Figure 12.32.: Cube This is a rotating cube screen saver in 3D.
Chapter 12. Plugins 12.2.4. Demystify Figure 12.33.: Demystify Demystify is a screen saver like demo. Key Remote Key Action Left / Right Volume Down / Volume Up Forward / Rewind Rec Increase / decrease speed Up / Down Rec Add / remove polygon Quit 12.2.5. Fire Figure 12.34.: Fire Fire is a demo displaying a fire effect.
Chapter 12. Plugins Key Remote Key Action Up / Down Forward / Rewind Volume Down Volume Up Rec Increase / decrease number of flames Left Right Rec Toggle flame type Toggle moving flames Quit 12.2.6. Fractals Figure 12.35.: Fractals: Mandelbrot set This demonstration draws fractal images from the Mandelbrot set.
Chapter 12. Plugins 12.2.8. Mosaique Figure 12.36.: Mosaique This simple graphics demo draws a mosaic picture on the screen of the player. Key Remote Key Up Change the gap between the drawing lines. Restart the drawing process. Exits Mosaique demo Select Rec or Power Action 12.2.9. Oscilloscope Figure 12.37.: Oscilloscope This demo shows the shape of the sound samples that make up the music being played.
Chapter 12. Plugins Keys Key Remote Key Action Select Rec Long Select Toggle filled / curve / plot Toggle whether to scroll or not Toggle drawing orientation Play Up / Down Right / Left Power Pause the demo Increase / decrease volume Increase / decrease speed Exit demo 12.2.10. PictureFlow Figure 12.38.: PictureFlow PictureFlow provides a visualisation of your albums with their associated cover art. It is possible to start playback of the selected album from PictureFlow.
Chapter 12. Plugins Keys Key Remote Key Left / Right Up / Down Select Action Scroll through albums Scroll through track list Enter track list / Play album from selected track Exit track list Enter menu Exit PictureFlow Left Rec Power Main Menu Go to WPS. Leave PictureFlow and enter the while playing screen. 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.
Chapter 12. Plugins Rebuild cache. Rebuild the PictureFlow cache. This is needed in order for PictureFlow to pick up new albums, and may occasionally be needed if albums are removed. 12.2.11. Plasma Figure 12.39.: Plasma Plasma is a demo displaying a 80’s style retro plasma effect. Key Remote Key Action Up / Down Forward / Rewind Mode Rec / Long Rec Increase / decrease Frequency Select Rec / Power Change Color Exit 12.2.12. Rocklife This an implementation of J. H.
Chapter 12. Plugins 12.2.13. Snow Figure 12.40.: Have you ever seen snow falling? This demo replicates snow falling on your screen. If you love winter, you will love this demo. Or maybe not. Press Rec or Power to quit. 12.2.14. Starfield Figure 12.41.: Starfield Starfield simulation (like the classic screensaver).
Chapter 12. Plugins 12.2.15. VU meter Figure 12.42.: VU-Meter This is a VU meter, which displays the volume of the left and right audio channels. There are 3 types of meter selectable. The analogue meter is a classic needle style. The digital meter is modelled after LED volume displays, and the mini-meter option allows for the display of small meters in addition to the main display (as above).
Chapter 12. Plugins Viewer gin Plu- Shortcuts Chip-8 Emulator Frotz Image Viewer Lua scripting language Midiplay MPEG Player MP3 Encoder Rockboy Search Sort Text Viewer VBRfix ZXBox Shopping list Associated filetype(s) Context Menu only .link .ch8 .z1 - .z8 .bmp, .jpg, .jpeg, .png, .ppm .lua .mid, .midi .mpg, .mpeg, .mpv, .m2v .wav .gb, .gbc .m3u, .m3u8 .* .txt,.nfo, .* .mp3 .tap, .tax, .sna, .z80 .shopper x x x x 12.3.1.
Chapter 12. Plugins the directory selected, or with the file selected in the file browser. You can then play the file or do with it whatever you want. The file will not be “played” automatically. If the .link file contains only one entry no list will be shown, you will directly jump to that location. The file shortcuts.link in the root directory is an exception. After “playing” it, the list will be shown even if the file contains just one entry. If the list you are seeing is from shortcuts.
3 4 5 6 7 8 9 A B C D E F Down 2 Right 1 Select Power 0 Left Off Up Chip8 Key Chapter 12. Plugins Some places where can you can find .ch8 files: • The PluginChip8 page on www.rockbox.org has several attached: ZPluginChip8 • Check out the HP48 chip games section: http://www.hpcalc.org/hp48/games/chip/ • PC emulator by the guy who wrote the HP48 emulator: http://www.pdc.kth.se/ ~lfo/chip8/CHIP8.htm • Links to other chip8 emulators: http://www.zophar.net/chip8.html 12.3.3.
Chapter 12. Plugins Key Remote Key Action Up Select Rec Forward Mode Rec Display keyboard to enter text Press enter Open Frotz menu (not available at MORE prompts) Quit Power 12.3.4. Image Viewer This plugin opens image files from the File Browser to display them. Supported formats are as follows. Format File-extension(s) BMP JPEG PNG GIF PPM .bmp .jpg, .jpe, .jpeg .png .gif .
Chapter 12. Plugins Show Playback Menu. From the playback menu you can control the playback of the currently loaded playlist and change the volume of your player. Display Options. From this menu you can force the viewer to render the image in greyscale using the Greyscale option or set the method of dithering used in the Dithering submenu. These settings only take effect for JPEG images. Quit. Quits the viewer and returns to the File Browser.
Chapter 12. Plugins directory containing several .pat files and two .cfg files. Just select a MIDI file with either the .mid or .midi extension in the file browser to start playback. Key Remote Key Up/ Down Right/ Left Play Power Action Volume up/ Volume down Skip 3 seconds forward/ backward Pause/Resume playback Stop playback and quit 12.3.7. MPEG Player The Mpeg Player is a video player plugin capable of playing back MPEG-1 and MPEG-2 video streams with MPEG audio multiplexed into .mpg files.
Chapter 12. Plugins Quit mpegplayer Exit the plugin. Main Menu Settings Open Settings submenu – see below. Resume playback Return to playback screen. Quit mpegplayer Exit the plugin. Settings Menu Display Options Open Display Options submenu – see below. Audio Options Open Audio Options submenu – see below. Resume Options (default: Start menu) Enable/disable the start menu. Play Mode (default: Single) Set to All to play multiple .mpg files in the directory continuously.
Chapter 12. Plugins Channel Modes (default: force off) Use the channel configuration setting or force Stereo mode. Crossfeed (default: force off) Use the Crossfeed setting or force crossfeed off. Equalizer (default: force off) Use the Equalizer setting or force the equalizer off. Dithering (default: force off) Use the Dithering setting or force audio dithering off. See this page in the Rockbox wiki for information on how to encode your videos to the supported format. ZPluginMpegplayer 12.3.8.
Chapter 12. Plugins Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game, open a ROM file saved as .gb or .gbc in the file browser. Default keys Key Remote Key Up / Down Left / Right Play Rec Select Power Action Direction keys A button B button Start Open Rockboy menu Rockboy menu Load Game. . . Loads a previously saved game. Save Game. . . Saves your current state. Options. . . Max Frameskip.
Chapter 12. Plugins 12.3.11. Shopper Shopper is a shopping list plugin which allows you to maintain reusable shopping lists. 12.3.12. Sort This plugin takes a file and sorts it in ascending alphabetical order. Case is ignored. This is useful for ordering playlists generated by the Create Playlist menu option (see section 5.10 (page 43)). 12.3.13. Text Viewer Figure 12.44.: Text Viewer This is a Viewer for text files with word wrap. Just open a .txt or .nfo file to display it.
Chapter 12. Plugins Menu Return Return to the file being viewed. Viewer Options Change settings for the current file. Encoding Set the codepage in the text viewer. Available settings: ISO-8859-1 (Latin 1).
Chapter 12. Plugins Show Statusbar Select whether to show the status bar. If you select a theme settings that the status bar does not display (see section 9 (page 76)), the status bar is not displayed even if you select Yes. No Do not display the status bar. Yes Display the status bar. Scroll Settings The scrolling settings submenu. Horizontal Submenu for horizontal scrolling settings. Scrollbar Toggle the horizontal scrollbar for the current mode.
Chapter 12. Plugins Indent Spaces Set the number of spaces to indent the text when line mode is set to Reflow Lines. Available options are 0 to 5 spaces. If you select 0, a blank line is displayed as an indent. Show Playback Menu Display the playback menu to allow control of the currently playing music without leaving the plugin. Select Bookmark Select a saved bookmark. In the screenshot below, the “*” denotes the current page. Figure 12.45.
Chapter 12. Plugins files are not removed regardless of the Remove Options such as rockbox_default.wps and the font file currently in use. Theme Remove menu Remove Theme. Selecting this will delete the files specified in the Remove Options. After a theme has been successfully removed, a log message is displayed listing which items have been deleted and which are being kept. Exit this screen by pressing any key. A file called theme_remove_log.
Chapter 12. Plugins Remote Viewers Iconset. Specifies how the remote viewers iconset .bmp file belonging to a theme .cfg file is handled. Filetype Colours. Specifies how the colours .colours file belonging to a theme .cfg file is handled. Create Log File. Setting this to No prevents the log file from being created. Quit. Exits this plugin. 12.3.15. VBRfix This function scans a VBR (Variable Bitrate) MP3 file and updates/creates the Xing VBR header.
Chapter 12. Plugins used like a “Kempston” joystick. Per default the buttons, including an additional but fixed menu button, are assigned as follows: Key Remote Key Up/Down/ Left/Right Select Play Action Directional movement Jump/Fire Open ZXBox menu ZXBox menu Vkeyboard. This is a virtual keyboard representing the Spectrum keyboard. Controls are the same as in standard Rockbox, but you just press one key instead of entering a phrase. Play/Pause Tape. Toggles playing of the tape (if it is loaded).
Chapter 12. Plugins Hacking graphics Due to ZXBox’s simple (but fast) scaling to the screen by dropping lines and columns some games can become unplayable. It is possible to hack graphics to make them better visible with the help of an utility such as the “Spectrum Graphics Editor”. Useful tools can be found at the “World of Spectrum” site (http://www.worldofspectrum.org/utilities. html). 12.4. Applications 12.4.1.
Chapter 12. Plugins to disk anyway. This is done so that the data are not biased by excessive additional disk accesses. The file is written to the root directory of your player and is called battery_bench.txt. The plugin will continue to log info until: • Another plugin is loaded. • The player is shut down. • The battery is empty. Benchmarks can be resumed if you accidentally load a plugin, or turn off your player, so long as the log file battery_bench.txt is not deleted.
Chapter 12. Plugins Limitations As Battery Benchmark needs to write the data held in memory to disk in order to save them, it is possible that should Rockbox shut down due to low battery then there will not be enough power remaining to write the data to disk. Therefore all measurements since the previous save will be lost. 12.4.3. Calculator Figure 12.48.: Calculator This is a simple scientific calculator for use on the player. It works like a standard calculator.
Chapter 12. Plugins 12.4.4. Calendar Figure 12.49.: Calendar This is a small and simple calendar application with memo saving function. Dots indicate dates with memos. The available memo types are: one off, yearly, monthly, and weekly memos. You can select what day is first day of week by the setting First Day of Week in the menu. Key Remote Key Left / Right / Up / Down Select Rec / Play Power Action Move the selector Show memos for the selected day Previous / Next month Quit 12.4.5.
Chapter 12. Plugins Setup Key Remote Key Right / Left Select Rec Action Increase / decrease displayed Value Move to next screen Move to previous screen • First enter the number of players (1–10) • Then set the total game time in mm:ss • Then the maximum round time is entered. 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.
Chapter 12. Plugins 12.4.6. Clock Figure 12.51.: Clock This is a fully featured analogue and digital clock plugin. Key configuration Key Remote Key Action Left / Right Volume Down / Volume Up Forward / Rewind Rec Mode Long Mode Cycle through modes Up / Down Rec Select Long Select 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.
Chapter 12. Plugins Backlight Choose whether to disable the backlight, use the user’s timeout setting, or keep the backlight on. Idle Poweroff Toggle Idle Poweroff. b Note: This setting is not saved to disk. Help Opens a brief help screen with key mappings and functionality. Credits Displays a credits roll. Analog mode Small, round, analog clock is displayed in the middle of the LCD. Time readout, if enabled, is displayed at the upper left.
Chapter 12. Plugins Binary mode This mode shows a Binary clock. The hour is displayed on the top line, the minute is displayed on the middle line, and the seconds are on the last line. Circle mode, if enabled, draws empty and full circles, instead of zeros and ones. For help on reading binary, please visit: http://en.wikipedia.org/wiki/Binary_numeral_system Plain mode This mode shows a “plain” clock in large text that takes up nearly the whole LCD. 12.4.7.
Chapter 12. Plugins 12.4.8. Keybox Keybox is an encrypted password storage using the “Tiny Encryption Algorithm” with a key derived using md5. Using Keybox To get started, start up the plugin and select Enter Keybox. The first time you enter Keybox you will be prompted for a master password and for confirmation of the master password. The master password is the password that you must use to access your stored passwords. Once inside, enter the context menu by pressing Long Select.
Chapter 12. Plugins .lrc8 files are the same as .lrc files except that they are UTF8 encoded. The Lyrics3 tag is not supported. Supported tags and formats for .lrc files The following tags are supported: [ti:title] [ar:artist] [offset:offset (msec)] Each line should resemble one of the following: [time tag]line [time tag]...[time tag]line [time tag]word... The time tag must be in the form [mm:ss], [mm:ss.xx], or [mm:ss.
Chapter 12. Plugins Controls Key Remote Key Action Up / Down Volume up/down. Left Volume Up / Volume Down Rewind Long Left Right Long Right Play Long Play or Select Long Select Rec Long Rewind Forward Long Forward Play Long Play or Mode Long Mode Menu 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.
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 Key Remote Key Power Rec Long Select Select Left / Right Up / Down Rec Rec Mode Volume Down / Volume Up Forward / Rewind Action Exit plugin Stop Start Tap tempo Adjust tempo Adjust volume Programmed Track Mode When starting the plugin as a viewer for tempomap files (ending in .tempo), it starts in the track mode that offers playback of a preprogrammed metronome track consisting out of multiple parts, each with possibly different properties.
Chapter 12. Plugins Navigation The display indicates the part properties and position in track as such: Metronome Track --------------"Interlude" 3/4@120 V-25 P2/13: B1/5+2 In this example, the part label is “Interlude”, the meter is 3/4 and the tempo 120 quarter beats per minute (bpm). The volume setting is at -25 and this is the second part of a track with 13 total. In that part, the position is at the second beat of the first bar of five.
Chapter 12. Plugins Symbol X x . Meaning emphasized beat (Tick) normal beat (Tock) silent beat Some examples: default: rockon2: solea: shuffle: funky: 0 0 0 0 0 4/4 120 Xxxx 4/4 120 xXxX 12/4 180 xxXxxXxXxXxX 12/12 120 x.xX.xx.xX.. 16/16 120 x.x.X..X.Xx.X..X The 12/12 for the shuffle create 1/4 triplets. Just do a bit of math;-) This is still a metronome, not a drum machine, but it can act like a basic one, helping you to figure out a certain rhythm within the meter.
Chapter 12. Plugins 12.4.14. Pitch Detector With the Pitch Detector, you can play a note on a musical instrument, and the plugin will tell you what note it is (e.g. A, A#, B, etc.) The frequency will also be displayed. This may be a great assistance when tuning a musical instrument. Key Remote Key Action Rec Power Rec Open menu Exit 12.4.15.
Chapter 12. Plugins Folder List Editor Keys Key Remote Key Action Select, Right or Play Long Select Forward Delete selected folder Long Mode Left or Power Left Bring up the context menu which allows you to remove the selected folder or its entire folder tree Exit 12.4.16. Resistor Calculator Figure 12.52.
Chapter 12. Plugins with the first option). Then, use the onscreen keyboard to type in the supply voltage and, if selected, the custom forward current. This function produces safe estimates, but use your own judgement when using these output values. Power rating and displayed resistance are rounded up to the nearest common value. 12.4.17. Rockpaint Figure 12.53.: Rockpaint Rockpaint is a bitmap (.bmp) editor for Rockbox. It can open any .
Chapter 12. Plugins Selection tool Allows you to select a rectangular region; once you do, you will be shown a menu of options (including “cancel” if you make a mistake). Line tool Draws a straight line. 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.
Chapter 12. Plugins Brush speed Changes the speed at which the selection cursor moves when you hold down a movement button. Brush size Allows you to adjust the drawing size of the pencil tool. 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.
Chapter 12. Plugins 12.4.19. Stopwatch Figure 12.55.: Stopwatch A simple stopwatch program with support for saving times. Key Remote Key Power Play Rec Select Up / Down Action 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 23)).
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 164 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 165 mp1, 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, rwps, 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] The dimensions of the menu that is displayed on the remote control of your player can be set in the same way. The line to be added to the theme .
Chapter 13. Advanced Topics 167 13.2.2. Themes – Create Your Own The theme files are simple text files, and can be created (or edited) in your favourite text editor. To make sure non-English characters display correctly in your theme you must save the theme files with UTF-8 character encoding. This can be done in most editors, for example Notepad in Windows 2000 or XP (but not in 9x/ME) can do this. Files Locations: Each different “themeable” aspect requires its own file – WPS files have the extension .
Chapter 13. Advanced Topics Viewport Declaration Syntax %V(x,y,[width],[height],[font]) %Vf([fgcolour]) %Vb([bgcolour]) %Vg(start, end [,text]) • %Vf and %Vb set the foreground and background colours respectively. • ‘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.
Chapter 13. Advanced Topics Mode Description clear invert color Restore the default style Draw lines inverted Draw the text coloured by the value given in ‘param’. Functionally equivalent to using the %Vf() tag Draw the next ‘param’ lines using a gradient as defined by %Vg. By default the gradient is drawn over 1 line.
Chapter 13. Advanced Topics 170 13.2.3. Info Viewport (SBS only) As mentioned above, it is possible to set a UI viewport via the theme .cfg file. It is also possible to set the UI viewport through the SBS file, and to conditionally select different UI viewports. • %Vi(’label’,...) This viewport is used as Custom UI Viewport in the case that the theme doesn’t have a ui viewport set in the theme .cfg file. Having this is strongly recommended since it makes you able to use the SBS with other themes.
Chapter 13. Advanced Topics Example %?mp The last else part is optional, and will be displayed if the tag has no value. The WPS parser will always display the last part if the tag has no value, or if the list of alternatives is too short. Next Song Info You can display information about the next song – the song that is about to play after the one currently playing (unless you change the plan).
Chapter 13. Advanced Topics Conditionals can be used with sublines to display a different set and/or number of sublines on the line depending on the evaluation of the conditional. Example subline with conditionals: Example %?it<%t(8)%s%it|%s%fn>;%?ia<%t(3)%s%ia|%t(0)> The format above will do two different things depending if ID3 tags are present. If the ID3 artist and title are present: • Display id3 title for 8 seconds, • Display id3 artist for 3 seconds, • repeat. . .
Chapter 13. Advanced Topics Example File Example %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]> %pb%pc/%pt That is, “tracknum – title [artist, album]”, where most fields are only displayed if available. Could also be rendered as “filename” or “tracknum – title [artist]”. 13.3. Managing Rockbox Settings 13.3.1. Introduction to .cfg Files Rockbox allows users to store and load multiple settings through the use of configuration files. A configuration file is simply a text file with the extension .
Chapter 13. Advanced Topics 174 show files: supported wps: /.rockbox/car.wps lang: /.rockbox/afrikaans.lng Note: As you can see from the example, configuration files do not need to contain all of the Rockbox options. You can create configuration files that change only certain settings. So, for example, suppose you typically use the player at one volume in the car, and another when using headphones.
Chapter 13. Advanced Topics 175 Save Sound Settings This option writes a .cfg file to your player’s disk. The configuration file has the .cfg extension and is used to store all of the sound related settings. Save Theme Settings This option writes a .cfg file to your player’s disk. The configuration file has the .cfg extension and is used to store all of the theme related settings. 13.4. Firmware Loading 13.4.1.
Chapter 13. Advanced Topics 176 13.5.4. Replaygain Replaygain is a post processing that equalises the playback volume of audio files to the same perceived loudness. This post processing applies a factor to each single PCM sample and is therefore consuming additional CPU time. If you want to achieve some (minor) savings in runtime, switch this feature off (see section 7.9 (page 58)). 13.5.5. Peak Meter The peak meter is a feature of the While Playing Screen and will be updated with a high framerate.
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 Rockbox firmware .
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 Monkey’s Audio .ape, .mac Sun Audio .au, .snd Free Lossless Audio .flac Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.711 alaw/µ-law, QuickTime IMA ADPCM -c1000 to -c3000 files decode fast enough to be useful. Linear PCM 8/16/24/32 bit, IEEE float 32/64 bit, ITU-T G.
Appendix B. Audio and metadata formats B.1.3. Other Codecs Format Extension Atari Sound Format Synthetic music Mobile Application Format Game Boy Sound Format .cmc, .cmr, .dmc, .mpt, .mmf .gbs AY Sound Chip Music .ay Hudson Entertainment System Sound Format .hes MSX Konami Sound System .kss SMS/GG/CV Sound Format .sgc Video Game Music Format Gzipped Video Game Music Format MOD NES Sound Format .vgm .vgz .mod .nsf, .nsfe Atari SAP Sound Interface Device .sap .sid SPC700 .spc Notes .
Appendix B. Audio and metadata formats B.1.4.
Appendix B. Audio and metadata formats B.2. Supported metadata tags Rockbox supports different metadata formats. In general those tag formats are ID3 (v1.0, v1.1, v2.2, v2.3 and v2.4), APE (v1 and v2), Vorbis, MP4 and ASF. Few codecs use codec specific tags, several codecs do not use any tags yet. The following table gives an overview about what tag types rockbox supports for which audio file extension. b Note: There is always only one tag type supported for each file extension.
Appendix B. Audio and metadata formats 184 B.2.2. Featureset for codec specific metadata Feature Codec specific metadata (file extension) Embedded .bmp Embedded .jpg Embedded .png Replaygain Title None None None .mpc .tta, .spc, .mmf, .sid, .rm, .ra, .rmvb, .nsf, .nsfe, .mod, .sap, .gbs, .ay, .sgc, .vgm .tta, .spc, .mmf, .sid, .rm, .ra, .rmvb, .nsf, .nsfe, .sap, .gbs, .ay, .sgc, .vgm .spc, .sid, .nsf, .nsfe, .gbs, .ay, .sgc, .vgm .tta, .spc, .sap .tta .tta .spc, .sid, .sap .mmf .spc, .rm, .ra, .rmvb, .
Appendix C. Album Art 185 C. Album Art Rockbox allows you to put the album art, or another image related to the music on your player to display it in the PictureFlow plugin or in the theme. For this feature to work, there are a few requirements. C.1. Limitations Rockbox supports embedded album art only for some specific formats, see section B.2.1 (page 183) for full details. It additionally supports loading images located on the hard disk. PictureFlow is currently unable to use embedded album art.
Appendix C. Album Art 186 The following characters will be replaced with an underscore (_) when looking for albumtitle.bmp or albumartist-albumtitle.bmp: \ / : < > ? * |. Doublequotes will be replaced by single quotes. If no album artist is set, artist will be used instead. See ZAlbumArt in the wiki for programs that will help you automate the process of putting album art on your player.
Appendix D. Theme Tags D. Theme Tags Themeing is discussed in detail in section section 13.2 (page 166), what follows is a list of the available tags. Note: The “bar-type tags” (such as %pb, %pv, %bl etc.) can be further themed – see section D.28 (page 201). D.1. Status Bar Tag Description %we %wd %wi Display Status Bar Hide Status Bar Display the inbuilt Status Bar in the current viewport These tags override the player setting for the display of the status bar.
Appendix D. Theme Tags 188 D.3. Information from the track tags Tag Description %ia %ic %iA %id %iG %ig %in %it %iC %iv %iy %ik Artist Composer Album Artist Album Name Grouping Genre Name Track Number Track Title Comment ID3 version (1.0, 1.1, 2.2, 2.3, 2.4, or empty if not an ID3 tag) Year Disc Number Remember that this information is not always available, so use the conditionals to show alternate information in preference to assuming. These tags, when written with a capital “I” (e.g.
Appendix D. Theme Tags 189 D.5. Additional Fonts Tag Description %Fl(’id’,filename) See section 13.2.4. D.6. Misc Coloring Tags Tag Description %dr(x,y,width,height,[color1,color2]) Color a rectangle. width and height can be - to fill the viewport. If no color is specified the viewports foreground color will be used. If two colors are specified it will do a gradient fill. D.7. Power Related Information Tag Description %bl Numeric battery level in percents.
Appendix D. Theme Tags 190 D.8. Information about the file Tag Description %fb %fc File Bitrate (in kbps) File Codec (e.g. “MP3” or “FLAC”). This tag can also be used in a conditional tag: %?fc.
Appendix D. Theme Tags D.9. Playlist/Song Info Tag Description %pb Progress Bar. This will replace the entire line with a progress bar. You can set the position, width and height of the progressbar (in pixels) and load a custom image for it: %pb(x,y,[width],[height],image.bmp) Percentage played in song Current time in song Total number of playlist entries Peak Meter. The entire line is used as volume peak meter. Peak meter for the left channel.
Appendix D. Theme Tags 192 • ‘start’ is the offset relative to the currently playing track for the playlist to display from (0 the current track, 1 is the next track, etc.). • ‘code to render’ is a line of skin code which will be displayed for each line in the viewer. All text tags are supported (including conditionals and sublines) The entire viewport will be used, so don’t expect other tags in the same viewport to work well.
Appendix D. Theme Tags D.14. Virtual LED Tag Description %lh “h” if the hard disk is accessed D.15. Repeat Mode Tag Description %mm Repeat mode, 0-4, in the order: Off, All, One, Shuffle, A-B Example: %?mm D.16. Playback Mode Tag Description %mp Play status, 0-4, in the order: Stop, Play, Pause, Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, FM Radio muted Example: %?mp D.17.
Appendix D. Theme Tags Number Screen 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Menus WPS Recording screen FM Radio screen Current Playlist screen Settings menus File browser Database browser Plugin browser Quickscreen Pitchscreen Setting chooser Playlist Catalogue Viewer Plugin Context menu System Info screen Time and Date Screen Bookmark browser Shortcuts menu Track Info screen 194 The tag can also be used as the switch in a conditional tag. For players without certain capabilities (e.g.
Appendix D. Theme Tags D.19. Changing Volume Tag Description %mv(t) “v” if the volume is being changed The tag produces the letter “v” while the volume is being changed and some amount of time after that, i.e. after the volume button has been released. The optional parameter t specifies that amount of time, in seconds. If it is not specified, 1 second is assumed. The tag can be used as the switch in a conditional tag to display different things depending on whether the volume is being changed.
Appendix D. Theme Tags 196 D.21. Images Tag Description Load and set a backdrop image for the WPS. This image must be exactly the same size as your LCD. %x(n,filename[,x,y])Load and display an image n: image ID for later referencing in %xd filename: file name relative to /.rockbox/ and including “.bmp” x: x coordinate (defaults to 0 if both x and y are not specified) y: y coordinate.
Appendix D. Theme Tags 1. Load and display the image /.rockbox/bg.bmp with ID “a” at 37, 109: %x(a,bg.bmp,37,109) 2. Load a bitmap strip containing 5 volume icon images (all the same size) with image ID “M”, and then reference the individual sub-images in a conditional: %xl(M,volume.
Appendix D. Theme Tags 198 2. Load albumart at position 0,20 and resize it to be at most 100×100 pixels. If the image isn’t square, align it to the bottom-right corner: %Cl(0,20,100,100,r,b) For general information where to put album art see section C (page 185). D.22. FM Radio Tag Description %tt %tm %ts %ta %tb %tf %Ti Is the tuner tuned? Scan or preset mode? Scan is “true”, preset is “false”. Is the station in stereo? Minimum frequency (region specific) in MHz.
Appendix D. Theme Tags 199 D.23. Alignment and language direction Tag Description %al %aL %ac %ar %aR %ax Align the text left Align the text left, or to the right if RTL language is in use Centre the text Align the text right Align the text right, or to the left if RTL language is in use The next tag should follow the set language direction. When prepended to a viewport declaration, the viewport will be horizontally mirrored if the user language is set to a RTL language.
Appendix D. Theme Tags 200 %?if(%pv, >=, 0) will display “Clipping possible” if the volume is higher than or equal to 0 dB, “Volume OK” if it is lower. %?if(%ia, =, %Ia) – this artist and the next artist are the same. Note: When performing a comparison against a string tag such as %ia, only = and != work, and the comparison is not case sensitive. D.25. Subline Tags Tag Description %t(time) ; Set the subline display cycle time (%t(5) or %t(3.
Appendix D. Theme Tags 201 D.27. Text Translation Tag Description %Sx(English) Display the translation of “English” in the current language • “English” must be a phrase used in the language file. • It should match the Source: line in the language file. Note: checkwps cannot verify that the string is correct, so please check on either the simulator or on target. D.28. Bar Tags Some tags can be used to display a bar which draws according to the value of the tag.
Appendix D. Theme Tags nofill – don’t draw the bar, only its frame (for use with the “slider” option). noborder – don’t draw the border for image-less bars, instead maximise the filling over the specified area. This doesn’t work for bars which specify an image. nobar – don’t draw the bar or its frame (for use with the “slider” option). setting – Specify the setting name to draw the bar from (bar must be %St type), the next param is the settings config name.
Appendix D. Theme Tags 203 Tag Description %( %) %, %% %< %| %> %; %# %s The character ‘(’ The character ‘)’ The character ‘,’ The character ‘%’ The character ‘<’ The character ‘|’ The character ‘>’ The character ‘;’ The character ‘#’ Indicate that the line should scroll. Can occur anywhere in a line (given that the text is displayed; see conditionals above). You can specify up to ten scrolling lines. Scrolling lines can not contain dynamic content such as timers, peak meters or progress bars.
Appendix E. Config file options E.
Appendix E. Config file options Setting Allowed Values Unit bidir limit scroll paginated hold_lr_for_scroll_in_list show path in browser contrast backlight timeout 0 to 200 on, off on, off off, current directory, full path 0 to 63 off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60, 90, 120 off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60, 90, 120 on, off % screen N/A N/A N/A N/A s normal, off, on on, off devise a way to from config-*.
Appendix E. Config file options Setting Allowed Values Unit disable autoresume if phones not present Last.
Appendix E.
Appendix E. Config file options Setting Allowed Values Unit peak meter dbfs on, off peak meter min peak meter max statusbar remote statusbar scrollbar scrollbar width 0 to 89 (dB) or 0 to 100 (%) 0 to 89 /(dB) or 0 to 100 (%) off, top, bottom 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.
Appendix E. Config file options Setting Allowed Values Unit backlight filters first remote keypress remote iconset remote viewers iconset time format rec quality on, off N/A /path/filename.bmp /path/filename.
Appendix F. Menu Overview 210 F.
Appendix G. User feedback 211 G. User feedback G.1. Bug reports If you experience inappropriate performance from any supported feature, please file a bug report on our web page. Do not report missing features as bugs, instead file them as feature ideas (see below). For open bug reports refer to http://www.rockbox.org/tracker/index.php?type=2 G.1.1. Rules for submitting new bug reports 1. Check that the bug has not already been reported 2.
Appendix G. User feedback 212 G.2.2. Features we will not implement This is a list of Feature Requests we get repeatedly that we simply cannot do. View it as the opposite of a TODO! • Support other file systems than FAT32 (like NTFS or ext2 etc.). No. support for more file systems will just take away valuable ram for unnecessary features. You can partition your player fine, just make sure the first one is FAT32 and then make the other ones whatever file system you want.
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.
