The Rockbox Manual for Sansa e200 and e200R Series rockbox.
Rockbox http://www.rockbox.org/ Open Source Jukebox Firmware Rockbox and this manual is the collaborative effort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2013 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 José Maria Garcia-Valdecasas Bernal & Peter Schlenker. Version rUnversioned. Built using pdfLATEX.
Contents Contents 1. Introduction 1.1. Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2. Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3. Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 11 11 11 12 2. Installation 2.1. Before Starting . . . . . . . . . . . . . . . . 2.2. Installing Rockbox . . . . . . . . . . . . . . 2.2.1. Automated Installation . . . . . . . 2.2.2. Manual Installation . . . . . . .
Contents 4.2. Database . . . . . . . . . . . . . 4.2.1. Introduction . . . . . . . 4.2.2. Initializing the Database . 4.2.3. The Database Menu . . . 4.2.4. Using the Database . . . 4.3. While Playing Screen . . . . . . . 4.3.1. WPS Key Controls . . . . 4.3.2. Peak Meter . . . . . . . . 4.3.3. The WPS Context Menu 4.4. Working with Playlists . . . . . . 4.4.1. Playlist terminology . . . 4.4.2. Creating playlists . . . . . 4.4.3. Adding music to playlists 4.4.4. Modifying playlists . . . . 4.4.5.
Contents 6.3. Volume Limit . . . . . . . . . 6.4. Treble . . . . . . . . . . . . . 6.5. Balance . . . . . . . . . . . . 6.6. Channels . . . . . . . . . . . 6.7. Stereo Width . . . . . . . . . 6.8. Crossfeed . . . . . . . . . . . 6.9. Equalizer . . . . . . . . . . . 6.10. Dithering . . . . . . . . . . . 6.11. Timestretch . . . . . . . . . . 6.12. Haas Surround . . . . . . . . 6.13. Perceptual Bass Enhancement 6.14. Auditory Fatigue Reduction . 6.15. Compressor . . . . . . . . . . 7. Playback Settings 7.1.
Contents 8.5.5. Wheel Light Timeout . . 8.5.6. Keyclick . . . . . . . . . . 8.5.7. USB HID . . . . . . . . . 8.5.8. USB Keypad Mode . . . . 8.5.9. USB Hide Internal Drive . 8.6. Startup/Shutdown . . . . . . . . 8.6.1. Start Screen . . . . . . . . 8.6.2. Idle Poweroff . . . . . . . 8.6.3. Sleep Timer . . . . . . . . 8.7. Bookmarking . . . . . . . . . . . 8.8. Automatic resume . . . . . . . . 8.9. Language . . . . . . . . . . . . . 8.10. Voice . . . . . . . . . . . . . . . . 8.11. Hotkey . . . . . . . . .
Contents 12.1.11.Flipit . . . . . . 12.1.12.Goban . . . . . . 12.1.13.Invadrox . . . . . 12.1.14.Jackpot . . . . . 12.1.15.Jewels . . . . . . 12.1.16.MazezaM . . . . 12.1.17.Minesweeper . . 12.1.18.Pacbox . . . . . 12.1.19.Pegbox . . . . . 12.1.20.Pong . . . . . . . 12.1.21.Reversi . . . . . 12.1.22.Robotfindskitten 12.1.23.Rockblox . . . . 12.1.24.Rockblox1d . . . 12.1.25.Sliding Puzzle . . 12.1.26.Snake . . . . . . 12.1.27.Snake 2 . . . . . 12.1.28.Sokoban . . . . . 12.1.29.Solitaire . . . . . 12.1.30.
Contents 12.3.3. Frotz . . . . . . . . . . . 12.3.4. Image Viewer . . . . . . 12.3.5. Lua scripting language . 12.3.6. Midiplay . . . . . . . . . 12.3.7. MPEG Player . . . . . . 12.3.8. MP3 Encoder . . . . . . 12.3.9. Rockboy . . . . . . . . . 12.3.10.Search . . . . . . . . . . 12.3.11.Shopper . . . . . . . . . 12.3.12.Sort . . . . . . . . . . . 12.3.13.Text Viewer . . . . . . . 12.3.14.Theme Remove . . . . . 12.3.15.VBRfix . . . . . . . . . 12.3.16.ZXBox . . . . . . . . . . 12.4. Applications . . . . .
Contents 13.1.7. UI Viewport . . . . . . . . . . . 13.2. Configuring the Theme . . . . . . . . . . 13.2.1. Themeing – General Info . . . . 13.2.2. Themes – Create Your Own . . . 13.2.3. Info Viewport (SBS only) . . . . 13.2.4. Additional Fonts . . . . . . . . . 13.3. Managing Rockbox Settings . . . . . . . 13.3.1. Introduction to .cfg Files . . . . 13.3.2. Specifications for .cfg Files . . . 13.3.3. The Manage Settings menu . 13.4. Firmware Loading . . . . . . . . . . . . 13.4.1.
Contents D.6. Misc Coloring Tags . . . . . . . . . . D.7. Power Related Information . . . . . D.8. Information about the file . . . . . . D.9. Playlist/Song Info . . . . . . . . . . D.10.Playlist Viewer . . . . . . . . . . . . D.11.Runtime Database . . . . . . . . . . D.12.Sound (DSP) settings . . . . . . . . D.13.Hold . . . . . . . . . . . . . . . . . . D.14.Virtual LED . . . . . . . . . . . . . D.15.Repeat Mode . . . . . . . . . . . . . D.16.Playback Mode . . . . . . . . . . . . D.17.Current Screen .
Chapter 1. Introduction 11 1. Introduction 1.1. Welcome This is the manual for Rockbox. Rockbox is an open source firmware replacement for a growing number of digital audio players. Rockbox aims to be considerably more functional and efficient than your device’s stock firmware while remaining easy to use and customisable. Rockbox is written by users, for users.
Chapter 1. Introduction 12 main channel for Rockbox is #rockbox on irc://irc.freenode.net. Many helpful developers and users are usually around. Just join and ask your question (don’t ask to ask!) – if someone knows the answer you’ll usually get an answer pretty quickly. More information including IRC logs can be found at http://www.rockbox.org/irc/. We also have a web client so that you can join the Rockbox IRC channel without needing to install additional software onto your computer.
Chapter 2. Installation 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 NOTE: These instructions will not work on the “Rhapsody” version of the E200 series (also known as E200R). Please follow the instructions at http: //www.rockbox.org/twiki/bin/view/Main/SansaE200RInstallation. Supported hardware versions.
Chapter 2. Installation encounter a problem, then the manual way is still available to you. There are three separate components, two of which need to be installed in order to run Rockbox: The Sansa bootloader. The Sansa bootloader is the program that tells your player how to load and start the original firmware. It is also responsible for any emergency, recovery, or disk modes on your player. This bootloader is stored in special flash memory in your Sansa and comes factory-installed.
Chapter 2. Installation Prebuilt binaries for Windows, Linux and Mac OS X are available at the ZRockboxUtility wiki page. When first starting Rockbox Utility run “Autodetect”, found in the configuration dialog (File → Configure). Autodetection can detect most player types. If autodetection fails or is unable to detect the mountpoint, make sure to enter the correct values. The mountpoint indicates the location of the player in your filesystem.
Chapter 2. Installation then you do not need to follow the next section and can skip straight to section 2.2.3 (page 17) Installing the firmware 1. Download your chosen version of Rockbox from the links in the previous section. 2. Connect your player to the computer via USB in MSC mode as described in the manual that came with your player. 3. Take the .zip file that you downloaded and use the “Extract all” command of your unzip program to extract the files onto your player.
Chapter 2. Installation installed successfully.” Press ENTER again to exit sansapatcher and then quit the Terminal application. Bootloader installation from Linux 1. Download sansapatcher from http://download.rockbox.org/bootloader/sandisk-sansa/ sansapatcher/linux32x86/sansapatcher (32-bit x86 binary) or http://download.rockbox. org/bootloader/sandisk-sansa/sansapatcher/linux64amd64/sansapatcher (64-bit amd64 binary).
Chapter 2. Installation 2.3. Running Rockbox When you turn the unit on, Rockbox should load. 2.4. Updating Rockbox Rockbox can be easily updated with Rockbox Utility. You can also update Rockbox manually – download a Rockbox build as detailed above, and unzip the build to the root directory of your player as in the manual installation stage. If your unzip program asks you whether to overwrite files, choose the “Yes to all” option. The new build will be installed over your current build.
Chapter 2. Installation 19 (Linux) “File Not Found” If you receive a “File Not Found” from the bootloader, then the bootloader cannot find the Rockbox firmware. This is usually a result of not extracting the contents of the .zip file to the proper location, and should not happen when Rockbox has been installed with Rockbox Utility.
Chapter 3. Quick Start 20 3. Quick Start 3.1. Basic Overview 3.1.1. The player’s controls Throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prefixed by “Long”, a long press of approximately one second should be performed on that button. The buttons are described in detail in the following paragraph. Additional information for blind users is available on the Rockbox website at ZBlindFAQ.
Chapter 3. Quick Start 3.1.2. Turning the player on and off To turn on and off your Rockbox enabled player use the following keys: Key Action Power Long Power Start Rockbox Shutdown Rockbox On shutdown, Rockbox automatically saves its settings. If you have problems with your settings, such as accidentally having set the colours to black on black, they can be reset at boot time. See the Reset Settings in section 13.3.3 (page 188) for details.
Chapter 3. Quick Start 22 (page 41)). To browse the files on your player, select Files (see section 4.1 (page 24)), and to browse in a view that is based on the meta-data1 of your audio files, select Database (see section 4.2 (page 28)). 3.1.6. Basic controls When browsing files and moving through menus you usually get a list view presented. The navigation in these lists are usually the same and should be pretty intuitive.
Chapter 3. Quick Start 23 3.2. Customising Rockbox Rockbox’ User Interface can be customised using “Themes”. Themes usually only affect the visual appearance, but an advanced user can create a theme that also changes various other settings like file view, LCD settings and all other settings that can be modified using .cfg files. This topic is discussed in more detail in section 13.3 (page 186). The Rockbox distribution comes with some themes that should look nice on your player.
Chapter 4. Browsing and playing 24 4. Browsing and playing 4.1. File Browser Figure 4.1.: The file browser Rockbox lets you browse your music in either of two ways. The File Browser lets you navigate through the files and directories on your player, entering directories and executing the default action on each file. To help differentiate files, each file format is displayed with an icon.
Chapter 4. Browsing and playing 4.1.1. File Browser Controls Key Action Scroll Backward/Scroll Forward Left Select or Right Go to previous/next item in list. If you are on the first/last entry, the cursor will wrap to the last/first entry. Go to the parent directory. Execute the default action on the selected file or enter a directory. If there is an audio file playing, return to the While Playing Screen (WPS) without stopping playback. Stop audio playback. Enter the Context Menu.
Chapter 4. Browsing and playing Note: The Context Menu is a context sensitive menu. If the Context Menu is invoked on a file, it will display options available for files. If the Context Menu is invoked on a directory, it will display options for directories. b The Context Menu contains the following options (unless otherwise noted, each option pertains both to files and directories): Playlist. Enters the Playlist Submenu (see section 4.4.3 (page 38)). Playlist Catalogue.
Chapter 4. Browsing and playing Start File Browser Here. This option allows users to set the currently selected directory as the default start directory for the file browser. This option is not available for files. Note: If you have Auto-Change Directory and Constrain Auto-Change enabled, the directories returned will be constrained to the directory you have chosen here and those below it. See section 7.11 (page 64) b Add to Shortcuts. Adds a link to the selected item in the shortcuts.link file.
Chapter 4. Browsing and playing Key Action Rec + Left / Rec + Right Submenu Move the line cursor within the text line. Left / Right Scroll Backward / Scroll Forward Rec + Select Select Play Power Select Delete the character before the line cursor. Move the cursor on the virtual keyboard. If you move out of the picker area, you get the previous/next page of characters (if there is more than one). Move the cursor on the virtual keyboard.
Chapter 4. Browsing and playing Ignoring Directories During Database Initialization You may have directories on your player whose contents should not be added to the database. Placing a file named database.ignore in a directory will exclude the files in that directory and all its subdirectories from scanning their tags and adding them to the database. This will speed up the database initialization. If a subdirectory of an ‘ignored’ directory should still be scanned, place a file named database.
Chapter 4. Browsing and playing 4.2.4. Using the Database Once the database has been initialized, you can browse your music by Artist, Album, Genre, Song Name, etc. To use the database, go to the Main Menu and select Database. Note: You may need to increase the value of the Max Entries in File Browser setting (Settings → General Settings → System → Limits) in order to view long lists of tracks in the ID3 database browser. There is no option to turn off database completely.
Chapter 4. Browsing and playing 4.3. While Playing Screen The While Playing Screen (WPS) displays various pieces of information about the currently playing audio file. The appearance of the WPS can be configured using WPS configuration files. The items shown depend on your configuration – all items can be turned on or off independently. Refer to section D (page 201) for details on how to change the display of the WPS.
Chapter 4. Browsing and playing 4.3.1. WPS Key Controls Key Action Scroll Backward / Scroll Forward Left Volume up/down. Long Left Right Long Right Play Power Select Long Select Submenu Long Submenu Select + Play Select + Submenu Rec Power + Right or Short Right + Long Right Power + Left or Short Left + Long Left Long Rec 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.
Chapter 4. Browsing and playing The clip indicator: This is a little black block that is displayed at the very right of the scale when an overflow occurs. It usually does not show up during normal playback unless you play an audio file that is distorted heavily. If you encounter clipping while recording, your recording will sound distorted. You should lower the gain. Note: Note that the clip detection is not very precise. Clipping might occur without being indicated.
Chapter 4. Browsing and playing Sound Settings This is a shortcut to the Sound Settings Menu, where you can configure volume, bass, treble, and other settings affecting the sound of your music. See section 6 (page 51) for more information. Playback Settings This is a shortcut to the Playback Settings Menu, where you can configure shuffle, repeat, party mode, skip length and other settings affecting the playback of your music. Rating The menu entry is only shown if Gather Runtime Information is enabled.
Chapter 4. Browsing and playing 35 Open With... This Open With function is the same as the Open With function in the file browser’s Context Menu. Delete Delete the currently playing file. The file will be deleted but the playback of the file will not stop immediately. Instead, the part of the file that has already been buffered (i.e. read into the player’s memory) will be played. This may even be the whole track. Pitch The Pitch Screen allows you to change the rate of playback (i.e.
Chapter 4. Browsing and playing Key Action Rec Toggle pitch changing mode (cycle through all available modes). Increase / Decrease pitch by 0.1% (in procentual mode) or 0.1 semitone (in semitone mode). Increase / Decrease pitch by 1% (in procentual mode) or a semitone (in semitone mode). Temporarily change pitch by 2% (beatmatch), or modify speed (in timestretch mode). Reset pitch and speed to 100%. Leave the Pitch Screen.
Chapter 4. Browsing and playing 37 By selecting (“playing”) a song from the File Browser Whenever a song is selected from the File Browser with Select or Right, Rockbox will automatically create a playlist containing all of the songs in that directory and start playback with the selected song. Note: If you already have created a dynamic playlist, playing a new song will erase the current dynamic playlist and create a new one.
Chapter 4. Browsing and playing 4.4.3. Adding music to playlists Adding music to a dynamic playlist Figure 4.5.: The Playlist Submenu The Playlist Submenu is a submenu in the Context Menu (see section 4.1.2 (page 25)), it allows you to put tracks into a “dynamic playlist”. If there is no music currently playing, Rockbox will create a new dynamic playlist and put the selected track(s) into it. If there is music currently playing, Rockbox will put the selected track(s) into the current playlist.
Chapter 4. Browsing and playing Queue Shuffled. Queue track(s) in a random order. Queue Last Shuffled. Queue tracks in a random order at the end of the playlist. Play Next. Replaces all but the current playing track with track(s). Current playing track is queued. The Playlist Submenu can be used to add either single tracks or entire directories to a playlist. If the Playlist Submenu is invoked on a single track, it will put only that track into the playlist.
Chapter 4. Browsing and playing 40 4.4.6. Loading saved playlists Through the File Browser Playlist files, like regular music tracks, can be selected through the File Browser. When loading a playlist from disk it will replace the current dynamic playlist. Through the Playlist catalogue The Playlist catalogue offers a shortcut to all playlists in your player’s specified playlist directory. It can be used like the File Browser. 4.5.
Chapter 5. The Main Menu 41 5. The Main Menu 5.1. Introducing the Main Menu Figure 5.1.: The main menu The Main Menu is the screen from which all of the Rockbox functions can be accessed. This is the first screen you will see when starting Rockbox. To return to the Main Menu, press the Submenu button. All settings are stored on the unit. However, Rockbox does not access the flash storage solely for the purpose of saving settings.
Chapter 5. The Main Menu 5.2. Navigating the Main Menu Key Action Scroll Forward Select the next option in the menu. Inside a setting, increase the value or choose next option. Select the previous option in the menu. Inside a setting,decrease the value or choose previous option. Select option. Exit menu or setting, or move to parent menu. Scroll Backward Select or Right Left 5.3. Recent Bookmarks Figure 5.2.
Chapter 5. The Main Menu Key Action Scroll Forward Scroll Backward Select or Right Left Rec Long Select Select the next bookmark. Select the previous bookmark. Resume from the selected bookmark. Exit Recent Bookmark menu. Delete the currently selected bookmark. Enter the context menu for the selected bookmark. There are two options in the context menu: Resume will commence playback of the currently selected bookmark entry. Delete will remove the currently selected bookmark entry from the list.
Chapter 5. The Main Menu 44 5.7.1. Sound Settings The Sound Settings menu offers a selection of sound properties you may change to customise your listening experience. The details of this menu are covered in section 6 (page 51). 5.7.2. Playback Settings The Playback Settings menu allows you to configure settings related to audio playback. The details of this menu are covered in section 7 (page 60). 5.7.3.
Chapter 5. The Main Menu 5.8. Recording 5.8.1. While Recording Screen Figure 5.3.: The while recording screen Selecting the Recording option in the Main Menu enters the Recording Screen, whilst pressing Long Select enters the Recording Settings (see section 10 (page 83)). The Recording Screen shows the time elapsed and the size of the file being recorded. A peak meter is present to allow you set gain correctly.
Chapter 5. The Main Menu Key Action Scroll Backward / Scroll Forward Left / Right Play Select setting. Power Rec Long Select 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 83)). 5.9. FM Radio Note: Not all Sansas have a radio receiver.
Chapter 5. The Main Menu “play” it from the file browser. Rockbox will “remember” and use it in PRESET mode until another file has been selected. Some preset files are available here: ZFmPresets. It is also possible to record the FM radio while listening. To start recording, enter the FM radio settings menu with Long Select and then select Recording. At this point, you will be switched to the Recording Screen. Further information on Recording can be found in section 5.8 (page 45).
Chapter 5. The Main Menu 5.10. Playlists This menu allows you to work with playlists. Playlists can be created in three ways. Playing a file in a directory causes all the files in it to be placed in a playlist. Playlists can be created manually by either using the Context Menu (see section 4.1.2 (page 25)) or using the Playlist menu. Both automatically and manually created playlists can be edited using this menu.
Chapter 5. The Main Menu Top Time: This item shows the cumulative overall runtime of your player since you last manually reset this item. A manual reset is done through pressing any button, followed by pressing Select or Right. Debug (Keep Out!): This sub menu is intended to be used only by Rockbox developers. It shows hardware, disk, battery status and other technical information.
Chapter 5. The Main Menu • The player can be turned off Note: Shortcuts into the database are not possible Shortcuts are loaded from the file /.rockbox/shortcuts.txt which lists each item to be displayed.
Chapter 6. Sound Settings 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 6.3. Volume Limit This setting adjusts the maximum volume of your music. The setting is by default set to the maximum volume which equals to no limit. To set a volume limit, select a volume from the list and the maximum volume will be limited to the selected value all over the system. 6.4. 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).
Chapter 6. Sound Settings 6.7. Stereo Width Stereo width allows you to manually specify the effect that is applied when the Channels setting is set to “custom”. All values below 100% will progressively mix the contents of one channel into the other. This has the effect of gradually centering the stereo image, until you have monophonic sound at 0%. 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.
Chapter 6. Sound Settings 54 High-Frequency Cutoff. Decides at which frequency the cross path audio will start to be cut by the amount described by the High-Frequency Attenuation setting. 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.
Chapter 6. Sound Settings In some ways the EQ is similar to the Bass and Treble settings described earlier, but the EQ allows you to control the sound much more carefully. Note that the parameteric EQ bands will be applied in addition to any bass or treble tone controls. Note: A maximum of 10 EQ bands are possible on most devices, but using more than are required will waste battery and introduce additional rounding noise. For best results, use the fewest number of bands required.
Chapter 6. Sound Settings quency range is. Higher Q values will affect a narrower band of frequencies, while lower Q values will affect a wider band of frequencies. Band 9: High shelf filter. A high shelf filter boosts or lowers all frequencies above a certain frequency limit, much as the “treble” control found on ordinary stereo systems does. The high shelf filter is adjusted the same way as the low shelf filter, except that it works on the high end of the frequency spectrum rather than the low end.
Chapter 6. Sound Settings Advanced EQ. This sub menu provides options for adjusting the same parameters as the Graphical EQ. The only difference is that the parameters are adjusted through textual menus rather than through a graphic interface. Save EQ Preset. This option saves the current EQ configuration in a .cfg file. Browse EQ Presets. This menu displays a list of EQ presets, as well as any EQ configurations saved using the Save EQ Preset option.
Chapter 6. Sound Settings 58 one channel and ends in the other. Therefore, four additional functions are provided to move the stage back to the center: Balance to change the left-right channel output ratio. A bypass band for frequencies that mostly contain vocals, using f(x1), and f(x2) to set frequencies which are not affected. The SIDE ONLY setting uses mid-side processing to determine and apply effect to the side channel only.
Chapter 6. Sound Settings 59 The Ratio setting determines how aggressively the compressor reduces gain above the threshold. For example, the 2:1 setting means that for each two decibels of input signal above the threshold, the compressor will only allow the output to appear as one decibel. The higher the ratio, the harder the signal is compressed. The ratio setting of Limit means essentially a ratio of infinity to one. In this case, the output signal is not allowed to exceed the threshold at all.
Chapter 7. Playback Settings 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 36). Options: Yes/No. 7.2.
Chapter 7. Playback Settings 61 7.3. Play Selected First This setting controls what happens when you select a file for playback while shuffle mode is on. If the Play Selected First setting is Yes, the file you selected will be played first. If this setting is No, a random file in the directory will be played first. 7.4. Fast-Forward/Rewind These settings control the speed and acceleration during fast forward and rewind.
Chapter 7. Playback Settings Fade In Delay. The “fade in delay” is the length of time between when the crossfade process begins and when the new track begins to fade in. Fade In Duration. The length of time, in seconds, that it takes your music to fade in once the Fade In Delay has ended. Fade Out Delay. The “fade out delay” is the length of time between when the crossfade process begins and when the old track begins to fade out. Fade Out Duration.
Chapter 7. Playback Settings 63 settings) have the same apparent volume. This prevents sudden changes in volume when changing between songs recorded at different volume levels. For replaygain to work, the songs must have been processed by a program that adds replaygain information to the ID3 tags (or Vorbis tags). Options for replaygain are: Replaygain Type. Choose the type of replaygain to apply: Album Gain.
Chapter 7. Playback Settings 64 Note: This feature only works when songs have been played from the file browser. Using it with the database may cause unexpected behaviour. b 7.11. Constrain Auto-Change If enabled and you have set Start File Browser Here to a directory other than root, Auto-Change Directory will be constrained to the directory you have chosen and those below it. See section 4.1.2 (page 27). 7.12. Last.fm Log Enables logging of your played tracks for submittal to http://www.last.fm.
Chapter 7. Playback Settings 65 7.15. Prevent Track Skipping If this option is enabled, the ability to manually skip tracks is disabled in order to avoid accidental track skips. It does not prevent changing tracks if a track ends, which can be achieved by combining this option with Repeat set to One 7.16. Rewind Before Resume When restarting a track or a bookmark, a short rewind can be done before the playback is started.
Chapter 8. General Settings 8. General Settings Figure 8.1.: The general settings screen 8.1. Playlist The Playlist sub menu allows you to configure settings related to playlists. Recursively Insert Directories. If set to On, then when a directory is inserted or queued into a dynamic playlist, all subdirectories will also be inserted. If set to Ask, Rockbox will prompt the user about whether to include sub-directories. Warn When Erasing Dynamic Playlist.
Chapter 8. General Settings Sort Files. This option controls how Rockbox sorts files. All of the options for Sort Directories are available in this option. In addition, there is a By type option which sorts files alphabetically by their type (such as .mp3) then alphabetically within each type. Interpret numbers when sorting.
Chapter 8. General Settings 68 Only when viewing all types. Only show file extensions when Show Files is set to All. Follow Playlist. This option determines what directory the File Browser displays first. If Follow Playlist is set to Yes, when you enter the File Browser from the WPS, you will find yourself in the same directory as the currently playing file.
Chapter 8. General Settings Backlight Fade In. This options turns on smooth backlight fading when the backlight is turning on. The fading time is dependent on the brightness level you have chosen. If it is turned off, the backlight will turn on immediately. Backlight Fade Out. This options turns on smooth backlight fading when the backlight is turning off. The fading time is dependent on the brightness level you have chosen. If it is turned off, the backlight will turn off immediately.
Chapter 8. General Settings Paged Scrolling. When set to Yes scrolling vertically on pages that surpass the screen size will page up/down instead of simply changing lines. This can be useful on slow displays. Peak Meter. The peak meter can be configured with a number of parameters. 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.
Chapter 8. General Settings 8.5. System 8.5.1. Disk Options relating to the hard disk. Directory Cache. Rockbox has the ability to cache the contents of your drive in RAM. The Directory Cache takes a small amount of memory away from Rockbox that would otherwise be used to buffer music, but it speeds up navigation in the file browser by eliminating the slight pause between the time a navigation button is pressed and the time Rockbox responds.
Chapter 8. General Settings 8.5.4. Car Adapter Mode This option turns On and Off the car ignition auto stop function. Car Adapter Mode. When using the player in a car, Car Adapter Mode automatically stops playback on the player when power (i.e. from cigarette lighter power adapter) to the external DC in jack is turned off. If the Car Adapter Mode is set to On, Rockbox will pause playback when the external power off condition is detected.
Chapter 8. General Settings provide different functionality. Switching modes back and forth is done by pressing the Rec and Long Rec keys, respectively. The following modes are available: Multimedia. This mode lets you control the volume, playback, and skips tracks on the host computer. It is equivalent for the multimedia keys found on top of some multimedia keyboards.
Chapter 8. General Settings Key Action Scroll Backward/ Scroll Forward Play/ Submenu Scroll up / down, respectively Long Play/ Long Submenu Long Select; Long Play+Submenu Zoom in / out, respectively Left/ Right Long Power Long Left/ Long Right Select Tab previous / next, respectively Tab close History back / forward Scroll page up / page down, respectively Zoom reset View full-screen toggle Mouse. This mode emulates a mouse.
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 76 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 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 178) 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 9. Theme Settings The Theme Settings menu offers options that you can change to customize the visual appearance of Rockbox. Browse Theme Files. This option will display all the currently installed themes on the player, press Select or Right to load the chosen theme and apply it. A theme is a configuration file, stored in a specific directory, that typically changes the WPS , font used and on some platforms additional information such as background image and text colours.
Chapter 9. Theme Settings Status Bar. Allows you to choose where to display the statusbar. Volume Display. Controls whether the volume is displayed as a graphic or a numeric value on the Status Bar. If you select a numeric display, volume is displayed in decibels. See section 6.1 (page 51) for more on the volume setting. Battery Display. Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar. Line Selector Type.
Chapter 10. 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 25)) 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 ecordings can only be made at a 22.05 kHz frequency (sample rate) on this player. 10.4. Source Choose the source of the recording. The options are: Microphone and FM Radio. For more information on recording from the radio see section 5.9 (page 46). 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 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 87 11. Time and Date Time related menu options. Pressing Long Select will voice the current time if voice support is enabled. Set Time/Date: Set current time and date. Time Format: Choose 12 or 24 hour clock.
Chapter 12. Plugins 12. Plugins Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit it to return to the Rockbox interface. Most plugins will not interfere with music playback but some of them will stop playback while running. Plugins have the file extension .rock.
Chapter 12. Plugins 12.1.2. Blackjack Figure 12.1.: Blackjack Blackjack, a game played in casinos around the world, is now available in the palm of your hand! The rules are simple: try to get as close to 21 without going over or simply beat out the dealer for the best hand. Although this may not seem difficult, blackjack is a game renowned for the strategy involved. This version includes the ability to split, buy insurance, and double down.
Chapter 12. Plugins 12.1.3. BrickMania Figure 12.2.: BrickMania BrickMania is a clone of the classic game Breakout. The aim of the game is to destroy all the bricks by hitting them with the ball once or more. Sometimes a special item falls down when you destroy a brick. For a special item to take effect, you must catch it with the paddle. Look out for the bad ones. Special items Displayed Name Description N D L F G B FL Normal Die Life Fire Glue Ball Flip Returns paddle to normal.
Chapter 12. Plugins 12.1.4. Bubbles Figure 12.3.: Bubbles The goal of the game is to beat each level as quickly as possible by clearing the board of all bubbles. Bubbles are removed from the board when a cluster of three of more of the same type is formed. The game is over when any bubbles on the board extend below the bottom line. To make things more difficult, the entire board is shifted down every time a certain number of shots have been fired.
Chapter 12. Plugins 12.1.5. Chessbox Figure 12.4.: Chessbox Chessbox is a one-person chess game with computer artificial intelligence. The chess engine is a port of GNU Chess 2 by John Stanback. It also works as a PGN file viewer. Instead of executing the game from the plugin menu, look for any file with .pgn extension in the file browser and execute it. Chessbox will show the list of matches included in the file and allow you to select the one you want to watch.
Chapter 12. Plugins 12.1.6. Clix Figure 12.5.: Clix The aim is to remove all blocks from the board. You can only remove blocks, if at least two blocks with the same color have a direct connection. The more blocks you remove per turn, the more points you get.
Chapter 12. Plugins 12.1.7. Chopper Figure 12.6.: Chopper Navigate a cavernous maze without banging into walls, the ceiling, or the floor. How long can you fly your chopper? Key Action Select Power Make chopper fly Enter menu 12.1.8. Codebuster Figure 12.7.
Chapter 12. Plugins Codebuster is a clone of the classic mastermind game. The computer selects a random combination of coloured pegs and the aim is to guess the correct combination in the smallest number of moves. After each attempt to guess the combination the results are displayed in the form of red and white pegs. A red peg signifies a correct peg in the correct position, and a white peg signifies a correct peg in the wrong position.
Chapter 12. Plugins This is the famous Doom game. Getting started For the game to run you need .wad game files located in /.rockbox/doom/ on your player. Create the directory and save the following files there: rockdoom.wad. The Rockbox .wad, based on prboom.wad from prboom-2.2.6 Your wad files. Copy all Doom wads you wish to play into that directory. The needed files can be found at ZPluginDoom To play addon wads create the addons directory within the doom directory. Place wad files in this directory.
Chapter 12. Plugins InGame Main Menu. This menu can only be accessed from within a running game, and is displayed by pressing Power New Game. Start a new game Options. In game options Load Game. Load a saved game Save Game. Save the current game Quit. Quit the game InGame Options Menu. This menu has the following options: End Game. Ends the current game Messages. Enable or Disable in game messages Screen Size. Shrink or Enlarge the displayed portion of the game Gamma.
Chapter 12. Plugins 12.1.11. Flipit Figure 12.9.: Flipit Flipping the colour of the token under the cursor also flips the tokens above, below, left and right of the cursor. The aim is to end up with a screen containing tokens of only one colour.
Chapter 12. Plugins 12.1.12. Goban Figure 12.10.: Goban Goban is a a plugin for playing, viewing and recording games of Go (also known as Weiqi, Baduk, Igo and Goe). It uses standard Smart Game Format (SGF) files for saving and loading games. You can find a short introduction to Go at http://senseis.xmp. net/?WhatIsGo and more information about SGF files can be read at http://senseis.xmp. net/?SmartGameFormat or the SGF specification at http://www.red-bean.com/sgf/.
Chapter 12. Plugins markers: Mark Meaning + * There are nodes after the current node in the SGF tree. There are sibling variations which can be navigated to using the Next Variation menu option of the Context Menu or the Rec button. There is a comment at the current node. It can be viewed/edited using the Add/Edit Comment menu option of the Context Menu.
Chapter 12. Plugins Options. Open the Options Menu. Context Menu. Open the Context Menu which allows you to set play modes and other tools. Quit. Leave the plugin. Any unsaved changes are saved to /sgf/gbn_def.sgf. Game Info. The menu for modifying game info (metadata) of the current game. This information will be saved to the SGF file and can be viewed in almost all SGF readers. Basic Info. Shows a quick view of the basic game metadata, if any has been set (otherwise does nothing).
Chapter 12. Plugins Show Child Variations? Enable this to mark child variations on he board if there are more than one. Note: variations which don’t start with a move are not visible in this way. Disable Idle Poweroff? Enable this if you do not want the player to turn off after a certain period of inactivity (depends on your global Rockbox settings). Idle Autosave Time. Set the amount of idle time to wait before automatically saving any unsaved changes. These autosaves go to the file /sgf/gbn_def.
Chapter 12. Plugins Label Mode. Add one character labels to the board. Each label starts at the letter ‘a’ and each subsequent application of a label will increment the letter. To remove a label, click on it until it cycles through the allowed letters and disappears. Add/Edit Comment. Add or edit a comment at the current node. Done. Go back to the previous screen. 12.1.13. Invadrox Figure 12.11.: Invadrox Invadrox is a clone of the classic arcade game Space Invaders.
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 Action Select Power Play Exit the game 12.1.15. Jewels Figure 12.13.
Chapter 12. Plugins Jewels is a simple yet addicting game which involves swapping pairs of jewels in order to form connected segments of three or more of the same type. The goal of the game is to score as many points as possible before running out of available moves. Higher points are awarded to larger combos. The game advances to the next level after every one hundred points and randomly clears several jewels.
Chapter 12. Plugins Key Action Play, Submenu, Left, Right Power Move Character Menu 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 12.1.18. Pacbox Figure 12.16.: Pacbox Pacbox is an emulator of the Pacman arcade machine hardware. It is a port of PIE – Pacman Instructional Emulator (http://www.ascotti.org/programming/pie/pie.htm). ROMs To use the emulator to play Pacman, you need a copy of ROMs for “Midway Pacman”. Filename MD5 checksum pacman.5e pacman.5f pacman.6e pacman.6f pacman.6h pacman.
Chapter 12. Plugins Keys Key Action Play Submenu Left Right Select+Submenu Move Up Move Down Move Left Move Right Insert Coin Select Rec Power 1-Player Start 2-Player Start Menu 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.
Chapter 12. Plugins Key Action Play, Submenu, Left, Right Select Rec Scroll Backward to move around Scroll Forward to go down a level Power to quit to choose peg to restart level to go up a level 12.1.20. Pong Figure 12.18.: Pong Pong is a simple one or two player “tennis game”. Whenever a player misses the ball the other scores. The game starts in demo mode, with the CPU controlling both sides.
Chapter 12. Plugins Key Action Left Submenu Play Right Power Left player up Left player down Right player up Right player down Quit 12.1.21. Reversi This is a simple implementation of the Reversi game. The objective of the game is to have a majority of own coloured pieces showing at the end of the game. The game rules can be found in the internet. You can choose to play manually (you place both the white and dark pieces) or to play against a (not very smart) robot. 12.1.22.
Chapter 12. Plugins 12.1.23. Rockblox Figure 12.20.: Rockblox Rockblox is a Rockbox version of the classic falling blocks game from Russia. The aim of the game is to make the falling blocks of different shapes form full rows. Whenever a row is completed, it will be cleared away, and you gain points. For every ten lines completed, the game level increases, making the blocks fall faster. If the pile of blocks reaches the ceiling, the game is over.
Chapter 12. Plugins Key Action Submenu Power or Long Power Move down faster Quit 12.1.25. Sliding Puzzle Figure 12.21.: Sliding puzzle The classic sliding puzzle game. Rearrange the pieces so that you can see the whole picture, or switch to number tiles if you like it a little easier Includes one picture puzzle, but you can switch the puzzle picture to be the album art of the currently playing music track, if one exists (see section C (page 199)).
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.
Chapter 12. Plugins 12.1.27. Snake 2 Figure 12.23.: Snake 2 – The Snake Strikes Back Another version of the Snake game. Move the snake around, and eat the apples that pop up on the screen. Each time an apple is eaten, the snake gets longer. The game ends when the snake hits a wall, or runs into itself.
Chapter 12. Plugins 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. The boxes can only be pushed, never pulled, and only one can be pushed at a time. Sokoban may be used as a viewer for viewing saved solutions and playing external level sets with the .sok extension. Level sets should be in the standard Sokoban text format or RLE (Run Length Encoded).
Chapter 12. Plugins • http://www.sourcecode.se/sokoban/levels.php • http://sokobano.de/en/levels.php Note that some level sets may contain levels that are too large for this version of Sokoban and are unplayable as a result. 12.1.29. Solitaire Figure 12.25.: Klondike solitaire This is the classic Klondike solitaire game for Rockbox. This is probably the best-known solitaire in the world. Many people do not even realize that other games exist.
Chapter 12. Plugins Key Action Scroll Forward / Scroll Backward / Left / Right Select Move Cursor around. Rec Left Rec + Right Right Power Select cards, move cards, reveal hidden cards... If a card was selected – unselect it, else Draw 3 new cards from the remains stack Put the card from the top of the remains stack on top of the cursor Put the card under the cursor on one of the 4 final colour stacks. Put the card on top of the remains stack on one of the final colour stacks. Show menu 12.1.30.
Chapter 12. Plugins Key Action Select Play Scroll Backward/ Scroll Forward Submenu Rec Power Shoot Thrust Turn left/right Teleport Pause game Quit 12.1.31. Star Figure 12.27.: Star game This is a puzzle game. It is actually a rewrite of Star, a game written by CDK designed for the hp48 calculator. Rules: Take all of the “o”s to go to the next level.
Chapter 12. Plugins Key Action Left Right Play Submenu Select Select+Left Select+Submenu Move Left Move Right Move Up Move Down Switch between circle and square Previous level Reset level Select+Right Next level Power Exit the game 12.1.32. Sudoku Figure 12.28.: Sudoku Sudoku in Rockbox can act as both a plugin and a viewer.
Chapter 12. Plugins The scratchpad When you play Sudoku on paper most people like to mark numbers in cells that are possible candidates for the cells. This can be done with the scratchpad, shown as separate column. Change the number under the cursor to the number you want to put on the scratchpad and press the scratchpad button, the number will then be added. If the number was already on the scratchpad it will get removed again. The column is stored separately for every cell on the board.
Chapter 12. Plugins 12.1.33. Wormlet Figure 12.29.: Wormlet game Wormlet is a multi-worm game on a multi-threaded multi-functional Rockbox console. You navigate a hungry little worm. Help your worm to find food and to avoid poisoned argh-tiles. The goal is to turn your tiny worm into a big worm for as long as possible. Game controls: Key Action Left Right Play Submenu Turn Turn Turn Turn left right Up Down The game Use the control keys of your worm to navigate around obstacles and find food.
Chapter 12. Plugins Thus eating an “argh” must be avoided under any circumstances. “Arghs” have the annoying tendency to accumulate. Worms. Thou shall not eat worms. Neither other worms nor thyself. Eating worms is blasphemous cannibalism, not healthy and causes instant death. And it doesn’t help anyway: the other worm isn’t hurt by the bite. It will go on creeping happily and eat all the food you left on the table. Walls. Don’t crash into the walls. Walls are not edible.
Chapter 12. Plugins Wormed: The worm tried to eat another worm or even itself. That’s why it is dead now. Making traps for other players with a worm is a good way to get them out of the game. Hints • Initially you will be busy with controlling your worm. Try to avoid other worms and crawl far away from them. Wait until they curl up themselves and collect the food afterwards. Don’t worry if the other worms grow longer than yours - you can catch up after they’ve died.
Chapter 12. Plugins Key Action Play, Submenu, Left, Right Rec Power Move around the arena Pause Open menu 12.1.35. XWorld In this cinematic, award winning platform game by Éric Chahi, you must evade capture and do your best to escape an alien planet. After an experiment goes awry the hero must team up with an unlikely ally, when they both become fugitives on another world. XWorld requires the data files, BANK* and MEMLIST.BIN, from the original “Another World” PC game to be copied into the .
Chapter 12. Plugins 12.2. Demos 12.2.1. Bounce Figure 12.31.: Bounce This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background. In Scroll mode the bouncing text is replaced by a different one scrolling from right to left. Key Action Play/ Submenu Scroll Forward / Scroll Backward Select Power or Long Power Moves to next/previous option Increases/decreases option value Toggles Scroll mode Exits bounce demo Available options are: Xdist/Ydist.
Chapter 12. Plugins 12.2.3. Cube Figure 12.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 Action Scroll Backward / Scroll Forward Play / Submenu Power Increase / decrease speed Add / remove polygon Quit 12.2.5. Fire Figure 12.34.
Chapter 12. Plugins Fire is a demo displaying a fire effect. Key Action Scroll Forward / Scroll Backward Left Right Power Increase / decrease number of flames 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.7. Logo Demo showing the Rockbox logo bouncing around the screen. Key Action Right / Left Play / Submenu Power or Long Power Increase / decrease speed on the x-axis Increase / decrease speed on the y-axis Quit 12.2.8. Mosaique Figure 12.36.: Mosaique This simple graphics demo draws a mosaic picture on the screen of the player. Key Action Play Change the gap between the drawing lines. Restart the drawing process.
Chapter 12. Plugins 12.2.9. Oscilloscope Figure 12.37.: Oscilloscope This demo shows the shape of the sound samples that make up the music being played. At faster speed rates, the player is less responsive to user input and music may start to skip.
Chapter 12. Plugins 12.2.10. PictureFlow Figure 12.38.: PictureFlow PictureFlow provides a visualisation of your albums with their associated cover art. It is possible to start playback of the selected album from PictureFlow. Playback will start from the selected track. The PictureFlow plugin will continue to run while your tracks are played. Requirements PictureFlow uses both the album art (see section C (page 199)) and database (see section 4.2 (page 28)) features of Rockbox.
Chapter 12. Plugins 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. Displays frames per second on screen. Spacing. The distance between the front edges of the side slides, i.e. changes the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom. Centre margin.
Chapter 12. Plugins 12.2.11. Plasma Figure 12.39.: Plasma Plasma is a demo displaying a 80’s style retro plasma effect. Key Action Play / Submenu/ Scroll Forward / Scroll Backward Select Power / Long Power Increase / decrease Frequency Change Color Exit 12.2.12. Rocklife This an implementation of J. H. Conway’s Game of Life (see http://en.wikipedia.org/ wiki/Conway%27s_Game_of_Life for a detailed description). Rockbox can open files with a configuration description (.cells files).
Chapter 12. Plugins Key Action Select Submenu Right Left Power Play/pause Change growth mode Next generation Status (only when paused) Exit 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 Power or Long Power to quit.
Chapter 12. Plugins 12.2.14. Starfield Figure 12.41.: Starfield Starfield simulation (like the classic screensaver). Key Action Right / Left Play / Submenu Select Power or Long Power Increase / decrease number of stars Increase / decrease speed Change colours Quit 12.2.15. VU meter Figure 12.42.
Chapter 12. Plugins This is a VU meter, which displays the volume of the left and right audio channels. There are 3 types of meter selectable. The analogue meter is a classic needle style. The digital meter is modelled after LED volume displays, and the mini-meter option allows for the display of small meters in addition to the main display (as above). From the settings menu the decay time for the meter (its memory), the meter type and the meter scale can be changed.
Chapter 12. Plugins 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 Scroll Forward 2 Right 1 Select Power 0 Left Off Scroll Backward 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.
Chapter 12. Plugins • The Frotz homepage (for the original Unix port): http://frotz.sourceforge.net/ • A Beginner’s Guide to Playing Interactive Fiction: http://www.microheaven.com/ IFGuide/ Key Action Play Select Power Display keyboard to enter text Press enter Open Frotz menu (not available at MORE prompts) Quit Long Power 12.3.4. Image Viewer This plugin opens image files from the File Browser to display them. Supported formats are as follows.
Chapter 12. Plugins The menu has the following entries. Return. Returns you to the image Toggle Slideshow Mode. Enables or disables the slideshow mode. Change Slideshow Timeout. You can set the timeout for the slideshow between 1 second and 20 seconds. 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.
Chapter 12. Plugins 12.3.6. Midiplay To get MIDI file playback, a patchset is required. This file contains the instruments required to synthesize the music. A sample patchset is available through the wiki at ZPluginMidiPlay, and needs to be extracted to the .rockbox directory in the root of your player. There should now be a /.rockbox/patchset/ directory, with the patchset directory containing several .pat files and two .cfg files. Just select a MIDI file with either the .mid or .
Chapter 12. Plugins Play from beginning Resume information is discarded and the video plays from the start. Resume at: mm:ss Resume video playback at stored resume time mm:ss (start of the video if no resume time is found). Set start time A preview screen is presented consisting of a thumbnail preview and a progress bar where the user can select a start time by ‘seeking’ through the video. The video playback is started by pressing the select button. Settings Open Settings submenu – see below.
Chapter 12. Plugins Skip frames (default: on) This option causes mpegplayer to attempt to maintain realtime playback by skipping the display of frames - but these frames are still decoded. Disabling this option can cause loss of A/V sync. Backlight Brightness (default: Use setting) Choose brightness to use during video playback. Set to Use setting to use the Brightness setting. Audio Options Menu Tone Controls (default: force off) Use the bass and treble control settings or force them off.
Chapter 12. Plugins 12.3.9. Rockboy Figure 12.43.: Rockboy Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game, open a ROM file saved as .gb or .gbc in the file browser. Default keys Key Action Play / Submenu Left / Right Select Rec Scroll Backward Direction keys Scroll Forward Select Power Open Rockboy menu A button B button Start Rockboy menu Load Game. . . Loads a previously saved game. Save Game. . .
Chapter 12. Plugins Sound. Toggle sound on or off. Stats. Toggle showing fps and current frameskip. Set Keys (BUGGY) Select this option to set a new keymapping. Note: The direction keys are set for the normal screen orientation, not the rotated orientation. Screen Size. Choose whether the original aspect ratio should be kept when scaling the picture to the screen or whether it should be displayed unscaled. Screen Rotate. Rotate the displayed picture and direction keys by 90 degrees. Set Palette.
Chapter 12. Plugins 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. The text viewer features controls to handle various styles of text formatting and has top-of-file and bottom-of-file buttons. You can view files without a .txt or .nfo extension by using Open with from the Context Menu (see section 4.1.2 (page 25)). You can also bookmark pages.
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 81)), 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 Figure 12.46.: A bookmark 12.3.14. Theme Remove This plugin offers a way to remove a theme. Open the Context Menu (see section 4.1.2 (page 25)) upon a theme.cfg file and select Open With... → theme_remove. Some files are not removed regardless of the Remove Options such as rockbox_default.wps and the font file currently in use. Theme Remove menu Remove Theme. Selecting this will delete the files specified in the Remove Options.
Chapter 12. Plugins WPS. Specifies how the .wps file belonging to a theme .cfg file is handled. Statusbar Skin. Specifies how the .sbs file belonging to a theme .cfg file is handled. Backdrop. Specifies how the backdrop .bmp file belonging to a theme .cfg file is handled. Iconset. Specifies how the iconset .bmp file belonging to a theme .cfg file is handled. Viewers Iconset. Specifies how the viewers iconset .bmp file belonging to a theme .cfg file is handled. Filetype Colours.
Chapter 12. Plugins ZXBox is a port of the “Spectemu” ZX Spectrum 48k emulator for Rockbox (Zproject’s homepage). To start a game open a tape file or snapshot saved as .tap, .tzx, .z80 or .sna in the file browser. Note: As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible. b Default keys The emulator is set up for 5 different buttons: Up, Down, Left, Right and Jump/Fire.
Chapter 12. Plugins Invert Colours. Inverts the Spectrum colour palette, sometimes helps visibility. Frameskip Sets the number of frames to skip before displaying one. With zero frameskip ZXBox tries to display 50 frames per second. Sound. Turns sound on or off. Volume. Controls volume of sound output. Predefined Keymap Select one of the predefined keymaps. For example 2w90z means: map ZXBox’s Up to 2, Down to w, Left to 9, Right to 0 and Jump/Fire to z.
Chapter 12. Plugins Setting an alarm First select a track and play it, then launch the “alarmclock” plugin. The plugin pauses the playback. Enter a 24h-time (e.g. 13:58) and set the alarm. Music playback will resume when the set time is reached. 12.4.2. Battery Benchmark The Battery Benchmark plugin enables you to test your battery’s performance whilst using your player normally. Results can be submitted to the ZBatteryRuntime wiki page.
Chapter 12. Plugins Voltage The battery voltage in mV at the moment the measurement was taken. C This stands for Charger. An “A” in that column shows if the power adapter was attached to the unit at the time of the measurement. U USB powered. Only for targets that support this. A “U” will indicate if the unit was using the USB port for power at the time of the measurement.
Chapter 12. Plugins Key Action Left / Right / Play / Submenu / Scroll Forward / Scroll Backward Select Rec Move around the keypad Long Select Power Select a button Delete last entered digit or clear after calculation Calculate Quit 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.
Chapter 12. Plugins Key Action Left / Right / Scroll Forward / Scroll Backward Move the selector Select Play / Submenu Show memos for the selected day Previous / Next month Power Quit 12.4.5. Chess Clock Figure 12.50.: Chess Clock The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players.
Chapter 12. Plugins • Then the maximum round time is entered. For example, this could be used to play Scrabble for a maximum of 15 minutes each, with each round taking no longer than one minute. • Done. Player 1 starts in paused mode. While playing The number of the current player is displayed on the top line. The time below is the time remaining for that round (and possibly also the total time left if different).
Chapter 12. Plugins Key configuration Key Action Left / Right Play / Submenu Power Select Long Select Cycle through modes Cycle through skins Main Menu Start / Stop Counter Reset Counter Clock Menu View Clock Exits the menu and returns to the current clock mode display. Mode Selector Opens a menu from which you can select a clock mode to view. Counter Settings Opens a menu from which you can adjust settings pertaining to the counter.
Chapter 12. Plugins Digital mode An imitation of an LCD, this mode shows a Clock comprised of digital “segments”. The Date readout, if enabled, is displayed at the bottom, center. The Second readout, if in “Text” mode, is displayed at the top, center; if in “Bar” mode, is displayed as a progress bar at the top of the LCD; if in “Invert” mode, will invert the LCD left-to-right as the seconds pass (a fully-inverted LCD means the entire minute has passed).
Chapter 12. Plugins Warning: Be careful when you use custom entries as you could accidentally delete important files. ! Available Options All selects all Linux, OS X, and Windows files. None deselects all file options. Linux selects Linux files. Default files are .dolphinview, .d3lphinview, and .Trash-*/. Windows selects Windows files. Default files are Thumbs.db, $RECYCLE.BIN/, Desktop.ini, Recycled/ and System Volume Information/. Mac selects OS X files. .Trashes/. Default files are ._*, .
Chapter 12. Plugins 12.4.9. Lamp Lamp is a simple plugin to use your player as a lamp (flashlight, torch). You get an empty screen with maximum brightness. Key Action Left / Right Scroll Forward / Scroll Backward Select Power or Long Power Toggle between colours Change the brightness Toggle the button light Exit to menu 12.4.10. Lrcplayer This plugin displays lyrics in .lrc files (and some other formats) synchronized with the song being played. Supported file types 1. .lrc 2. .lrc8 3. .snc 4. .
Chapter 12. Plugins The time tag must be in the form [mm:ss], [mm:ss.xx], or [mm:ss.xxx] where mm is minutes, ss is seconds, xx is tenth of milliseconds, and xxx is milliseconds. Any other tags and lines without time tags are ignored. Location of lyrics files The plugin checks the following directories for lyrics files. If no lyrics file is found and the audio file is a .mp3, it also checks for SYLT and USLT tags in the id3v2 tags. 1. The directory containing the audio file and its parent directories.
Chapter 12. Plugins Controls Key Action Scroll Backward / Scroll Forward Left Volume up/down. Long Left Right Long Right Play Power or Select Long Select Submenu Go to beginning of track, or if pressed while in the first seconds of a track, go to the previous track. Rewind in track. Go to the next track. Fast forward in track. Toggle play/pause. Exit the plugin. Enter timetag editor. Enter Lrcplayer Menu. Lrcplayer Menu Theme settings. Change theme related settings. Show Statusbar.
Chapter 12. Plugins Playback Control. Show the playback control menu. Time Offset. Set an offset for the time tags for the lyrics currently in use. Timetag Editor. Enter the timetag editor. Quit. Exit the plugin. Editing the time tags The display time for each line can be changed with the timetag editor. Selecting a line changes its time to the current position of the track. To set a specific time or to adjust the time, press Long Select to bring up a screen to adjust the time.
Chapter 12. Plugins Key Action Long Power Power Long Select Select Left / Right Scroll Forward / Scroll Backward Rec Exit plugin Stop Start Tap tempo Adjust tempo Adjust volume Sync tap 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 Action Power Long Power Open menu Exit 12.4.15. Random Folder Advance Configuration This plugin is used to configure the folders which will be considered when the AutoChange Directory feature is set to Random.
Chapter 12. Plugins Folder List Editor Keys Key Action Select or Right Long Select Delete selected folder Bring up the context menu which allows you to remove the selected folder or its entire folder tree Exit Left 12.4.16. Resistor Calculator Figure 12.52.: Resistor calculator The resistor calculator is a plugin that works in 3 modes: Colour to Resistance In Colour to Resistance mode, use the menus to select the colours of the bands of a resistor which you would like to know the resistance of.
Chapter 12. Plugins LED resistance LED resistance calculator is used to determine the resistor necessary to light an LED safely at a given voltage. First, select the voltage that the LED will use (the first option is the most common and a safe bet), and the current that it will draw (likewise with the first option). Then, use the onscreen keyboard to type in the supply voltage and, if selected, the custom forward current.
Chapter 12. Plugins screen. From top to bottom and left to right, and by section, they are as follows: Colour Picker The top left tool shows your colours that are at the ready. To swap them, “click” on the background colour. To edit the foreground colour, click on it. Preset Palette Several preset colours are available. Clicking on one changes the foreground of the Colour Picker to the selected colour. Pencil Draws as you move the cursor.
Chapter 12. Plugins Load Loads a bitmap file. Simply navigate to the file as you would in the file browser. Save Saves the current file. If it has not been saved before, you will be given a chance to name it and choose the saving location. Set Width Allows you to change the width of the image. Border to indicate the width will be shown but it doesn’t affect drawing. Set Height Allows you to change the height of the image. Border to indicate the height will be shown but it doesn’t affect drawing.
Chapter 12. Plugins 12.4.18. Stats Figure 12.54.: The stats-plugin The stats plugin counts the directories and files (the total number as well as the number of audio, playlist, image and video files) on your player. Press Power or Long Power to abort counting and exit the plugin. Press it again to quit after counting has finished. 12.4.19. Stopwatch Figure 12.55.: Stopwatch A simple stopwatch program with support for saving times.
Chapter 12. Plugins Key Action Power Right Left Select Play / Submenu Quit Plugin Start / stop Reset timer (only when timer is stopped) Take lap time Scroll through lap times 12.4.20. Text Editor This plugin allows you to view and edit simple text documents on your DAP. You can view files by using Open with from the Context Menu (see section 4.1.2 (page 25)). Usage If you start the Text Editor from the plugin browser you will be greeted with a blank screen.
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 178 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 mp2, mp3, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, spc, ape, mac, sap, mpg, mpeg, bmp, fmr, fnt, kbd All file extensions that are not either specifically listed in the .colours files or are not in the list above will be set to the colour given by ???. Extensions that are in the above list but not in the .colours file will be set to the foreground colour as normal.
Chapter 13. Advanced Topics 13.1.7. UI Viewport By default, the UI is drawn on the whole screen. This can be changed so that the UI is confined to a specific area of the screen, by use of a UI viewport. This is done by adding the following line to the .cfg file for a theme: ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour] Only the first two parameters have to be specified, the others can be omitted using ‘-’ as a placeholder. The syntax is very similar to WPS viewports (see section 13.
Chapter 13. Advanced Topics Files Locations: Each different “themeable” aspect requires its own file – WPS files have the extension .wps, FM screen files have the extension .fms, and SBS files have the extension .sbs. The main theme file has the extension .cfg. All files should have the same name. The theme .cfg file should be placed in the /.rockbox/themes directory, while the .wps, .fms and .sbs files should be placed in the /.rockbox/wps directory.
Chapter 13. Advanced Topics • ‘fgcolour’ and ‘bgcolour’ are 6-digit RGB888 colours, e.g. FF00FF. • %Vg defines a gradient fill that can then be used with the %Vs tag. ‘start’ and ‘end’ set the initial and final colours, and the optional ‘text’ sets the text colour. Colours are 6-digit RGB888, e.g. FF00FF. • ‘font’ is a number: 0 is the built-in system font, 1 is the current menu font, and 2-9 are additional skin loaded fonts (see section 13.2.4 (page 184)). • Only the coordinates have to be specified.
Chapter 13. Advanced Topics 183 Conditional Viewports Any viewport can be displayed either permanently or conditionally. Defining a viewport as %V(... will display it permanently. • %Vl(’identifier’,...) This tag preloads a viewport for later display. ‘identifier’ is a single lowercase letter (a-z) and the ‘. . . ’ parameters use the same logic as the %V tag explained above. • %Vd(’identifier’) Display the ‘identifier’ viewport.
Chapter 13. Advanced Topics 13.2.4. Additional Fonts Additional fonts can be loaded within each screen file to be used in that screen. In this way not only can you have different fonts between e.g. the menu and the WPS, but you can use multiple fonts in each of the individual screens. %Fl(’id’,filename,glyphs) • ‘id’ is the number you want to use in viewport declarations, 0 and 1 are reserved and so can’t be used. • ‘filename’ is the font filename to load. Fonts should be stored in /.
Chapter 13. Advanced Topics be available at the end of a song. We suggest you use the conditional display tag a lot when displaying information about the next song! Alternating Sublines It is possible to group items on each line into 2 or more groups or “sublines”. Each subline will be displayed in succession on the line for a specified time, alternating continuously through each defined subline. Items on a line are broken into sublines with the semicolon ‘;’ character.
Chapter 13. Advanced Topics Using Images You can have as many as 52 images in your WPS. There are various ways of displaying images: 1. Load and always show the image, using the %x tag 2. Preload the image with %xl and show it with %xd. This way you can have your images displayed conditionally. 3. Load an image and show as backdrop using the %X tag. The image must be of the same exact dimensions as your display. Example on background image use: Example %X(background.
Chapter 13. Advanced Topics while playing your jukebox in your car, and a headphones.cfg file to store the settings that you use while listening to your player through headphones. See section 13.3.2 (page 187) below for an explanation of the format for configuration files. See section 13.3.3 (page 188) for an explanation of how to create, edit and load configuration files. 13.3.2. Specifications for .cfg Files The Rockbox configuration file is a plain text file, so once you use the Save .
Chapter 13. Advanced Topics 188 13.3.3. The Manage Settings menu The Manage Settings menu can be found in the Main Menu. The Manage Settings menu allows you to save and load .cfg files. Browse .cfg Files Opens the File Browser in the /.rockbox directory and displays all .cfg (configuration) files. Selecting a .cfg file will cause Rockbox to load the settings contained in that file. Pressing Left will exit back to the Manage Settings menu. See the Write .
Chapter 13. Advanced Topics 189 components – for some of those there are settings available. Another area of savings is avoiding or reducing CPU boosting through disabling computing intense features (e.g. sound processing) or using effective audio codecs. The following provides a short overview of the most relevant settings and rules of thumb. 13.5.1. Display backlight The active backlight consumes a lot of power.
Chapter 13. Advanced Topics 190 Please do not re-encode any existing audio files from one lossy format to another based upon the above mentioned. This will reduce the audio quality. If you have the choice, select the best suiting codec when encoding the original source material. 13.5.6. Sound settings In general all kinds of sound processing will need more CPU time and therefore consume more power.
Appendix A.
Appendix A. File formats A. File formats A.1. Supported file formats Icon File Type Extension Action when selected Directory Audio file Bookmark none various (see B.1) .bmark Game of Life .cells Configuration File .cfg Enter the directory Start playing the file and show the WPS Display all bookmarks for an audio file Show the configuration with the “Rocklife” plugin Load the settings file Chip8 game Colours .ch8 .colours Cuesheet FM Presets .cue .fmr Font .fnt Image Link .jpg .
Appendix B. Audio and metadata formats B. Audio and metadata formats B.1. Supported audio formats B.1.1. Lossy Codecs Format Extension Notes ATSC A/52 (AC3) .a52, .ac3, .rm, .ra, .rmvb .adx Supports downmixing for playback of 5.1 streams in stereo ADX Advanced Audio Coding Musepack .m4a, .m4b, .mp4, .rm, .ra, .rmvb .mpa, .mp1, .mp2, .mp3 .mpc OGG/Vorbis .ogg, .oga Sony Audio .oma, .aa3, .rm, .ra, .rmvb .rm, .ra, .rmvb .spx .vox .wma, .wmv, .asf .wma, .wmv, .
Appendix B. Audio and metadata formats mance requirements. B.1.2. Lossless Codecs Format Extension Notes Audio Interchange File Format .aif, .aiff 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 Only -c1000 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 Notes 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 .
Appendix B. Audio and metadata formats B.1.4.
Appendix B. Audio and metadata formats B.2. Supported metadata tags Rockbox supports different metadata formats. In general those tag formats are ID3 (v1.0, v1.1, v2.2, v2.3 and v2.4), APE (v1 and v2), Vorbis, MP4 and ASF. Few codecs use codec specific tags, several codecs do not use any tags yet. The following table gives an overview about what tag types rockbox supports for which audio file extension. Note: There is always only one tag type supported for each file extension.
Appendix B. Audio and metadata formats B.2.2. Featureset for codec specific metadata Feature Codec specific metadata (file extension) Embedded .bmp Embedded .jpg Embedded .png Replaygain Title None None None .mpc .tta, .spc, .mmf, .sid, .rm, .ra, .rmvb, .nsf, .nsfe, .mod, .sap, .gbs, .ay, .sgc, .vgm .tta, .spc, .mmf, .sid, .rm, .ra, .rmvb, .nsf, .nsfe, .sap, .gbs, .ay, .sgc, .vgm .spc, .sid, .nsf, .nsfe, .gbs, .ay, .sgc, .vgm .tta, .spc, .sap .tta .tta .spc, .sid, .sap .mmf .spc, .rm, .ra, .rmvb, .
Appendix C. Album Art C. Album Art Rockbox allows you to put the album art, or another image related to the music on your player to display it in the PictureFlow plugin or in the theme. For this feature to work, there are a few requirements. C.1. Limitations Rockbox supports embedded album art only for some specific formats, see section B.2.1 (page 197) for full details. It additionally supports loading images located on the flash storage. PictureFlow is currently unable to use embedded album art.
Appendix C. Album Art 200 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 180), 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 215). 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 202 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 203 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 204 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 206 • ‘start’ is the offset relative to the currently playing track for the playlist to display from (0 the current track, 1 is the next track, etc.). • ‘code to render’ is a line of skin code which will be displayed for each line in the viewer. All text tags are supported (including conditionals and sublines) The entire viewport will be used, so don’t expect other tags in the same viewport to work well.
Appendix D. Theme Tags D.14. Virtual LED Tag Description %lh “h” if the flash storage is accessed D.15. Repeat Mode Tag Description %mm Repeat mode, 0-4, in the order: Off, All, One, Shuffle, A-B Example: %?mm D.16. Playback Mode Tag Description %mp Play status, 0-4, in the order: Stop, Play, Pause, Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, FM Radio muted Example: %?mp D.17.
Appendix D. Theme Tags Number Screen 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Menus WPS Recording screen FM Radio screen Current Playlist screen Settings menus File browser Database browser Plugin browser Quickscreen Pitchscreen Setting chooser Playlist Catalogue Viewer Plugin Context menu System Info screen Time and Date Screen Bookmark browser Shortcuts menu Track Info screen 208 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 210 D.21. Images Tag Description Load and set a backdrop image for the WPS. This image must be exactly the same size as your LCD. %x(n,filename[,x,y])Load and display an image n: image ID for later referencing in %xd filename: file name relative to /.rockbox/ and including “.bmp” x: x coordinate (defaults to 0 if both x and y are not specified) y: y coordinate.
Appendix D. Theme Tags 1. Load and display the image /.rockbox/bg.bmp with ID “a” at 37, 109: %x(a,bg.bmp,37,109) 2. Load a bitmap strip containing 5 volume icon images (all the same size) with image ID “M”, and then reference the individual sub-images in a conditional: %xl(M,volume.
Appendix D. Theme Tags 2. Load albumart at position 0,20 and resize it to be at most 100×100 pixels. If the image isn’t square, align it to the bottom-right corner: %Cl(0,20,100,100,r,b) For general information where to put album art see section C (page 199). 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 213 D.23. Alignment and language direction Tag Description %al %aL %ac %ar %aR %ax Align the text left Align the text left, or to the right if RTL language is in use Centre the text Align the text right Align the text right, or to the left if RTL language is in use The next tag should follow the set language direction. When prepended to a viewport declaration, the viewport will be horizontally mirrored if the user language is set to a RTL language.
Appendix D. Theme Tags %?if(%pv, >=, 0) will display “Clipping possible” if the volume is higher than or equal to 0 dB, “Volume OK” if it is lower. %?if(%ia, =, %Ia) – this artist and the next artist are the same. Note: When performing a comparison against a string tag such as %ia, only = and != work, and the comparison is not case sensitive. D.25. Subline Tags Tag Description %t(time) ; Set the subline display cycle time (%t(5) or %t(3.
Appendix D. Theme Tags D.27. Text Translation Tag Description %Sx(English) Display the translation of “English” in the current language • “English” must be a phrase used in the language file. • It should match the Source: line in the language file. Note: checkwps cannot verify that the string is correct, so please check on either the simulator or on target. D.28. Bar Tags Some tags can be used to display a bar which draws according to the value of the tag.
Appendix D. Theme Tags nofill – don’t draw the bar, only its frame (for use with the “slider” option). noborder – don’t draw the border for image-less bars, instead maximise the filling over the specified area. This doesn’t work for bars which specify an image. nobar – don’t draw the bar or its frame (for use with the “slider” option). setting – Specify the setting name to draw the bar from (bar must be %St type), the next param is the settings config name.
Appendix D. Theme Tags 217 Tag Description %( %) %, %% %< %| %> %; %# %s The character ‘(’ The character ‘)’ The character ‘,’ The character ‘%’ The character ‘<’ The character ‘|’ The character ‘>’ The character ‘;’ The character ‘#’ Indicate that the line should scroll. Can occur anywhere in a line (given that the text is displayed; see conditionals above). You can specify up to ten scrolling lines. Scrolling lines can not contain dynamic content such as timers, peak meters or progress bars.
Appendix E. Config file options E.
Appendix E. Config file options Setting Allowed Values Unit bidir limit scroll paginated hold_lr_for_scroll_in_list show path in browser contrast backlight timeout 0 to 200 on, off on, off off, current directory, full path 0 to 63 off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60, 90, 120 off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60, 90, 120 on, off % screen N/A N/A N/A N/A s normal, off, on on, off devise a way to get ranges from config-*.
Appendix E. Config file options Setting Allowed Values Unit use most-recent-bookmarks pause on headphone unplug rewind duration on pause disable autoresume if phones not present Last.
Appendix E.
Appendix E.
Appendix E.
Appendix F. Menu Overview 224 F.
Appendix G. User feedback G. User feedback G.1. Bug reports If you experience inappropriate performance from any supported feature, please file a bug report on our web page. Do not report missing features as bugs, instead file them as feature ideas (see below). For open bug reports refer to http://www.rockbox.org/tracker/index.php?type=2 G.1.1. Rules for submitting new bug reports 1. Check that the bug has not already been reported 2.
Appendix G. User feedback 226 G.2.2. Features we will not implement This is a list of Feature Requests we get repeatedly that we simply cannot do. View it as the opposite of a TODO! • Interfacing with other USB devices (like cameras) or 2 player games over USB. The USB system demands that there is a master that talks to a slave. The player can only serve as a slave, as most other USB devices such as cameras can. Thus, without a master no communication between the slaves can take place.
Appendix H. Credits H. Credits People that have contributed to the project, one way or another.
Appendix H. Credits Hand · Nick Lanham · Sebastian Henriksen · Martin Scarratt · Karl Kurbjun · Tomasz Malesinski · Andrew Pilley · Matt v.d. Westhuizen · Tim Crist · Jvo Studer · Dan Everton · Imre Herceg · Seven Le Mesle · Craig Bachelor · Nikolaj Christensen · Mikael Magnusson · Dominik Wenger · Henrico Witvliet · Andrew Scott · Miguel A. Arévalo · Aaron F.
Appendix H. Credits · Stepan Moskovchenko · John S. Gwynne · Brian J. Morey · Stijn Hisken · Bertrik Sikken · Karim Boucher · James Espinoza · Franz Rühmland · Jordan Anderson · Maurus Cuelenaere · Chris Allegretta · Alastair S · Martin Crkovský · Ariya Hidayat · Jonas Hurrelmann · Lee Kang Hyuk · Clemens Werther · Robert Menes · Henri Valta · Melba Sitjar · Mehmet Ş.
Appendix H.
Appendix I. Licenses I. Licenses I.1. GNU Free Documentation License Version 1.2, November 2002 Copyright c 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Appendix I. Licenses A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
Appendix I. Licenses ther is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
Appendix I. Licenses distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
Appendix I. Licenses on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section.
Appendix I. Licenses 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
Appendix I. Licenses 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections.
Appendix I. Licenses Copyright c YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no BackCover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”. If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with.
Appendix I. Licenses I.2. The GNU General Public License Version 2, June 1991 Copyright c 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it.
Appendix I. Licenses Terms and Conditions For Copying, Distribution and Modification 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License.
Appendix I. Licenses such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works.
Appendix I. Licenses If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License.
Appendix I. Licenses reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8.
Appendix I. Licenses and/or redistribute the program as permitted above, be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if such holder or other party has been advised of the possibility of such damages.
Appendix I. Licenses ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details. The hypothetical commands show w and show c should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than show w and show c; they could even be mouse-clicks or menu items— whatever suits your program.
