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-2009 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 José Maria Garcia-Valdecasas Bernal & Peter Schlenker. Version 3.3. Built using pdfLATEX.
Contents Contents 1 Introduction 1.1 Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3 Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 10 10 10 11 2 Installation 2.1 Before Starting . . . . . . . . . . . . . . . . 2.2 Installing Rockbox . . . . . . . . . . . . . . 2.2.1 Automated Installation . . . . . . . 2.2.2 Manual Installation . . . . . . . . . 2.2.
Contents 4.3 4.4 5 The 5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 5.11 5.12 5.13 4.2.1 Introduction . . . . . . . 4.2.2 Initializing the Database . 4.2.3 The Database Menu . . . 4.2.4 Using the Database . . . While Playing Screen . . . . . . . 4.3.1 WPS Key Controls . . . . 4.3.2 Peak Meter . . . . . . . . 4.3.3 The WPS Context Menu 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.
Contents 6.5 6.6 6.7 6.8 6.9 Channels . . Stereo Width Crossfeed . . Equalizer . . Dithering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Playback Settings 7.1 Shuffle . . . . . . . . . . 7.2 Repeat . . . . . . . . . . 7.3 Play Selected First . . . 7.4 Fast-Forward/Rewind . 7.5 Fade on Stop/Pause . . 7.6 Party Mode . . . . . . . 7.7 Crossfade . . . . . . . . 7.8 Replaygain . . . . . . . 7.9 Track Skip Beep . . . . 7.10 Auto-Change Directory 7.11 Last.fm Log . . . . . . . 7.
Contents 10.4 Source . . . . . . . . . . . 10.5 Channels . . . . . . . . . 10.6 Mono Mode . . . . . . . . 10.7 File Split Options . . . . . 10.8 Prerecord Time . . . . . . 10.9 Clear Recording Directory 10.10Clipping Light . . . . . . 10.11Trigger . . . . . . . . . . . 11 Plugins 11.1 Games . . . . . . . . . . 11.1.1 Blackjack . . . . 11.1.2 BrickMania . . . 11.1.3 Bubbles . . . . . 11.1.4 Chessbox . . . . 11.1.5 Chopper . . . . . 11.1.6 Dice . . . . . . . 11.1.7 Doom . . . . . . 11.1.8 Flipit . . . . .
Contents 11.2.3 Cube . . . . . . . . . . . 11.2.4 Demystify . . . . . . . . 11.2.5 Fire . . . . . . . . . . . 11.2.6 Logo . . . . . . . . . . . 11.2.7 Mandelbrot . . . . . . . 11.2.8 Mosaique . . . . . . . . 11.2.9 Oscilloscope . . . . . . . 11.2.10 PictureFlow . . . . . . . 11.2.11 Plasma . . . . . . . . . 11.2.12 Snow . . . . . . . . . . . 11.2.13 Starfield . . . . . . . . . 11.2.14 VU meter . . . . . . . . 11.3 Viewers . . . . . . . . . . . . . 11.3.1 Shortcuts . . . . . . . . 11.3.2 Chip-8 Emulator .
Contents 12.1 Customising the User Interface . . . . . 12.1.1 Getting Extras . . . . . . . . . . 12.1.2 Loading Fonts . . . . . . . . . . 12.1.3 Loading Languages . . . . . . . . 12.1.4 Changing Filetype Colours . . . 12.1.5 Loading Backdrops . . . . . . . . 12.2 Configuring the WPS . . . . . . . . . . 12.2.1 WPS – General Info . . . . . . . 12.2.2 WPS – Build Your Own . . . . . 12.3 Managing Rockbox Settings . . . . . . . 12.3.1 Introduction to .cfg Files. . . . 12.3.2 Specifications for .cfg Files. . .
Contents C.3 Where to put album art . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 D Config file options 164 E Menu Overview 169 F User feedback F.1 Bug reports . . . . . . . . . . . . . . . . . . . . F.1.1 Rules for submitting new bug reports . F.2 Feature ideas . . . . . . . . . . . . . . . . . . . F.2.1 Rules for submitting a new feature idea F.2.2 Features we will not implement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1. Introduction 10 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 11 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 things it is important 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 16) Installing the firmware 1. Download your chosen version of Rockbox from the links in the previous section. 2. Connect your player to the computer via USB as described in the manual that came with your player. 3. Take the .zip file that you downloaded and use the “Extract all” command of your unzip program to extract the files onto your player. Note: The entire contents of the .
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 18 “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. To fix this, either install Rockbox with the Rockbox Utility which will take care of this for you, or recheck the Manual Install section to see where the files need to be located.
Chapter 3. Quick Start 19 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 12.3.3 (page 148) for details.
Chapter 3. Quick Start 21 3.1.6 Basic controls When browsing files and moving through menus you usually get a list view presented. The navigation in these lists are usually the same and should be pretty intuitive. In the tree view use Scroll Forward and Scroll Backward to move around the selection. Use Select or Right to select an item. When browsing the file system selecting an audio file plays it. The view switches to the “While playing screen”, usually abbreviated as “WPS” (see section 4.3 (page 29).
Chapter 3. Quick Start 22 using .cfg files. This topic is discussed in more detail in section 12.3 (page 146). The Rockbox distribution comes with some themes that should look nice on your player. Note: Some of the themes shipped with Rockbox need additional fonts from the fonts package, so make sure you installed them. Also, if you downloaded additional themes from the Internet make sure you have the needed fonts installed as otherwise the theme may get displayed garbled. 3.
Chapter 4. Browsing and playing 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. Executes the default action on the selected file or enters a directory. If there is an audio file playing, returns to the While Playing Screen (WPS) without stopping playback. Stops audio playback.
Chapter 4. Browsing and playing The Context Menu contains the following options (unless otherwise noted, each option pertains both to files and directories): Playlist. Enters the Playlist Submenu (see section 4.4.3 (page 36)). Playlist Catalog. Enters the Playlist Catalog Submenu (see section 4.4.2 (page 35)). Rename. This function lets the user modify the name of a file or directory. Cut. Copies the name of the currently selected file or directory to the clipboard and marks it to be ‘cut’. Copy.
Chapter 4. Browsing and playing 4.1.3 Virtual Keyboard Figure 4.3: The virtual keyboard This is the virtual keyboard that is used when entering text in Rockbox, for example when renaming a file or creating a new directory. The virtual keyboard can be easily changed by making a text file with the required layout. More information on how to achieve this can be found on the Rockbox website at ZLoadableKeyboardLayouts.
Chapter 4. Browsing and playing 27 4.2 Database 4.2.1 Introduction This chapter describes the Rockbox music database system. Using the information contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your audio files, Rockbox builds and maintains a database of the music files on your player and allows you to browse them by Artist, Album, Genre, Song Name, etc. The criteria the database uses to sort the songs can be completely customised.
Chapter 4. Browsing and playing Cache) is enabled. Update now includes that check whether dircache has been enabled or not. Initialize Now You can force Rockbox to rescan your disk for tagged files by using the Initialize Now function in the Database Menu. Warning: Initialize Now removes all database files (removing runtimedb data also) and rebuilds the database from scratch.
Chapter 4.
Chapter 4. Browsing and playing • The ID3 album name. • The ID3 artist name. • Bit rate. VBR files display average bitrate and “(avg)” • Elapsed and total time. • A slidebar progress meter representing where in the song you are. • Peak meter. See section 12.2 (page 143) for details of customising your WPS (While Playing Screen). 4.3.1 WPS Key Controls Key Action Scroll Backward / Scroll Forward Left Volume up/down.
Chapter 4. Browsing and playing 4.3.2 Peak Meter The peak meter can be displayed on the While Playing Screen and consists of several indicators. For a picture of the peak meter, please see the While Recording Screen in section 5.8.1 (page 43). The bar: This is the wide horizontal bar. It represents the current volume value. The peak indicator: This is a little vertical line at the right end of the bar. It indicates the peak volume value that occurred recently.
Chapter 4. Browsing and playing Playlist catalog View catalog. This lists all playlists that are part of the Playlist catalog. You can load a new playlist directly from this list. Add to playlist. Adds the currently playing file to a playlist. Select the playlist you want the file to be added to and it will get appended to that playlist. Add to new playlist. Similar to the previous entry this will add the currently playing track to a playlist. You need to enter a name for the new playlist first.
Chapter 4. Browsing and playing Show Track Info Figure 4.4: The track info viewer This screen is accessible from the WPS screen, and provides a detailed view of all the identity information about the current track. This info is known as meta data and is stored in audio file formats to keep information on artist, album etc. To access this screen, 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.
Chapter 4. Browsing and playing Key Action Rec Scroll Backward / Scroll Forward Toggle pitch changing mode Increase / Decrease pitch by 0.1% (in procentual mode) or a semitone (in semitone mode) Increase / Decrease pitch by 1% (in procentual mode) or a semitone (in semitone mode) Temporarily increase / decrease pitch by 2.0% Reset pitch to 100% Leave the Pitch Screen Long Scroll Backward / Long Scroll Forward Right / Left Select Power or Play 4.
Chapter 4. Browsing and playing 4.4.2 Creating playlists Rockbox can create playlists in four different ways. By selecting (“playing”) a song from the File Browser Whenever a song is selected from the File Browser with Select or Right, Rockbox will automatically create a playlist containing all of the songs in that directory and start playback with the selected song. Note: If you already have created a dynamic playlist, playing a new song will erase the current dynamic playlist and create a new one.
Chapter 4. Browsing and playing 4.4.3 Adding music to playlists Adding music to a dynamic playlist Figure 4.5: The Playlist Submenu The Playlist Submenu is a submenu in the Context Menu (see section 4.1.2 (page 24)), it allows you to put tracks into a “dynamic playlist”. If there is no music currently playing, Rockbox will create a new dynamic playlist and put the selected track(s) into it. If there is music currently playing, Rockbox will put the selected track(s) into the current playlist.
Chapter 4. Browsing and playing 37 Play Next. Replaces all but the current playing track with track(s). Current playing track is queued. The Playlist Submenu can be used to add either single tracks or entire directories to a playlist. If the Playlist Submenu is invoked on a single track, it will put only that track into the playlist. On the other hand, if the Playlist Submenu is invoked on a directory, Rockbox adds all of the tracks in that directory to the playlist.
Chapter 4. Browsing and playing 38 4.4.6 Loading saved playlists Through the File Browser Playlist files, like regular music tracks, can be selected through the File Browser. When loading a playlist from disk it will replace the current dynamic playlist. Through the Playlist catalog The Playlist catalog offers a shortcut to all playlists in your player’s specified playlist directory. It can be used like the File Browser. 4.4.
Chapter 5. The Main Menu 5 The Main Menu 5.1 Introducing the Main Menu Figure 5.1: The main menu The Main Menu is the screen from which all of the Rockbox functions can be accessed. This is the first screen you will see when starting Rockbox. To return to the Main Menu, press the Submenu button. All settings are stored on the unit. However, Rockbox does not spin up the disk solely for the purpose of saving settings.
Chapter 5. The Main Menu 5.2 Navigating the Main Menu Key Action Scroll Forward Selects the next option in the menu. Inside a setting, increases the value or chooses next option Selects the previous option in the menu. Inside a setting, decreases the value or chooses previous option Selects option Exits menu, setting or moves to parent menu Scroll Backward Select or Right Left 5.3 Recent Bookmarks Figure 5.
Chapter 5. The Main Menu Key Action Scroll Forward Scroll Backward Select or Right Left Rec Long Select Selects the next bookmark. Selects the previous bookmark. Resumes from the selected bookmark. Exits Recent Bookmark menu Deletes the currently selected bookmark Enters the context menu for the selected bookmark. There are two options in the context menu: Resume will commence playback of the currently selected bookmark entry. Delete will remove the currently selected bookmark entry from the list.
Chapter 5. The Main Menu 42 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 48). 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 54). 5.7.
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 71)). 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. While recording: close the current file and open a new one. Open Recording Settings (see section 10 (page 71)). 5.9 FM Radio Note: Not all Sansas have a radio receiver.
Chapter 5. The Main Menu Key Action Right, Left Change frequency in SCAN mode or jump to next/previous station in PRESET mode Seek to next station or preset in SCAN mode. Change volume. Leave the radio screen with the radio playing. Stops the radio and returns to Main Menu. Mutes radio playback. Switches between SCAN and PRESET mode. Opens a list of radio presets. You can view all the presets that you have, and switch to the station. Displays the FM radio settings menu.
Chapter 5. The Main Menu 46 Create Playlist: Rockbox will create a playlist with all tracks in the current directory and all sub-directories. The playlist will be created one directory level “up” from where you currently are. View Current Playlist: Displays the contents of the playlist currently stored in memory. Save Current Playlist: Saves the current dynamic playlist, excluding queued tracks, to the specified file. If no path is provided then playlist is saved to the current directory.
Chapter 5. The Main Menu 47 5.13 Quick Screen Although the Quick Screen is accessible from nearly everywhere, not just the Main Menu, it is worth mentioning here. It allows rapid access to your three favourite settings. The default settings are Shuffle (section 7 (page 54)), Repeat (section 7 (page 54)) and the Show Files (section 8.2 (page 60)) options, but almost all configurable options in Rockbox can be placed on this screen.
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 49 6.3 Treble This setting emphasises or suppresses the higher (treble) frequencies in the sound. A value of 0 dB means that treble sounds are unaltered (flat response). The minimum setting is -24 dB and the maximum is 24 dB. 6.4 Balance This setting controls the balance between the left and right channels. The default, 0, means that the left and right outputs are equal in volume.
Chapter 6. Sound Settings 6.7 Crossfeed Crossfeed attempts to make the experience of listening to music on headphones more similar to listening to music with stereo speakers. When you listen to music through speakers, each ear will hear sound originating from both speakers. However, the sound from the left speaker reaches your right ear slightly later than it does your left ear, and vice versa.
Chapter 6. Sound Settings 6.8 Equalizer Figure 6.2: The graphical equalizer Rockbox features a parametric equalizer (EQ). As the name suggests, a parametric EQ lets you control several different parameters for each band of the EQ. 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.
Chapter 6. Sound Settings certain frequency limit, much like what a “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. As a general guide, EQ band 0 should be used for low frequencies, EQ bands 1 through 3 should be used for mids, and EQ band 4 should be used for highs. Enable EQ: This option controls whether the EQ is on or off.
Chapter 6. Sound Settings 53 6.9 Dithering This setting controls the dithering and noise shaping functionality of Rockbox. Most of Rockbox’ audio file decoders work at a higher bit depth than the 16 bits used for output on the player’s audio connectors. The simplest way to convert from one bit depth to another is simply discarding all the surplus bits. This is the default behaviour, and adds distortion to the signal that will vary in character along with the desired sound.
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 34). Options: Yes/No. 7.
Chapter 7. Playback Settings 55 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 56 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 The length of time, in seconds, that it takes your music to fade out once the Fade Out Delay has ended. Fade Out Mode If set to Crossfade, one song will fade out and the next song will simultaneously fade in.
Chapter 7. Playback Settings Enable Replaygain This turns on/off the replaygain function. Prevent Clipping Avoid clipping of a song’s waveform. If a song would clip during playback, the volume is lowered for that song. Replaygain information is needed for this to work. Replaygain Type Choose the type of replaygain to apply: Album Gain Maintain a constant volume level between albums, but keep any intentional volume variations between songs in an album.
Chapter 7. Playback Settings 58 reboot to start the logging. The log-file is called .scrobbler.log,and is to be found in the root directory of your player. Note: See ZLastFMLog for a further description, and for tools you can use to submit your Last.fm log. 7.12 Cuesheet Support Enables reading of cuesheet files for played tracks. If a cuesheet is found for a track, track markers are displayed on the progressbar and it is possible to skip between the tracks within the cuesheet.
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.
Chapter 8. General Settings 61 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. If Follow Playlist is set to No, when you enter the File Browser from the WPS, you will find yourself in the directory you were in when you last left the File Browser.
Chapter 8. General Settings 62 Backlight Fade Out: This options turns on smooth backlight fading when the backlight is turning off. The fading time may dependent on the brightness level you have chosen. If it is turned off, the backlight will turn off immediately. First Keypress Enables Backlight Only: With this option enabled the first keypress while the backlight is turned off will only turn the backlight on without having any other effect.
Chapter 8. General Settings Status/Scrollbar: Settings related to on screen status display and the scrollbar. Scroll Bar: Enables or disables the scroll bar at the left. Status Bar: Enables or disables the status bar at the upper side. Volume Display: Controls whether the volume is displayed as a graphic or a numeric value on the Status Bar. If you select a numeric display, volume is displayed in decibels. See section 6.1 (page 48) for more on the volume setting.
Chapter 8. General Settings used when generating these tags. This should be “ISO-8859-1” but to support languages outside Western Europe most applications use the setting of your operating system instead. If your operating system uses a different codepage and you are getting garbled extended characters you should adjust this settings. In most cases sticking to “ISO-8859-1” would be sufficient. 8.5 System 8.5.1 Start Screen Set the screen that Rockbox will start in.
Chapter 8. General Settings Max Playlist Size: This setting controls the maximum size of a playlist. The playlist size can be between 1,000 and 32,000 files, in steps of 1,000 (default is 10,000). Higher values will shorten the music buffer, so you should increase this setting only if you have very large playlists. 8.5.5 Car Adapter Mode This option turns On and Off the car ignition auto stop function.
Chapter 8. General Settings Yes – Recent Only. Turns on automatic bookmarking – One bookmark only Ask – Recent Only. Asks if a bookmark should be created when stopping track – One bookmark only With the two Recent Only options, nothing is written to the .bmark file. If the Maintain a list of Recently Used Bookmarks option is enabled, the bookmarking information will however be added to recent bookmarks list.
Chapter 8. General Settings Resume will commence playback of the currently selected bookmark entry. Delete will remove the currently selected bookmark entry from the list. 8.7 Language This setting controls the language of the Rockbox user interface. Selecting a language will activate it. The language files must be in the /.rockbox/langs/ directory. See section 12.1.3 (page 141) for further details about languages. 8.8 Voice Voice Menus.
Chapter 8. General Settings Voice Filenames. This option controls voicing of filenames. Again, a voice file must be present for this to work. The options provided are Spell, Numbers, and Off which function the same as for Voice Directories. You can use pre-generated .talk clips to have filenames spoken properly, but you must enable this explicitly (see below). Use File .talk Clips. This option turns on the use of .talk clips for files. On. Use special pre-recorded MP3 files for each file.
Chapter 9. Theme Settings 69 9 Theme Settings The Theme Settings menu offers options that you can change to customize the visual apperance of Rockbox. Browse Themes. 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 Bar (Gradient Colour): A bar with a colour gradient, the colours are set in the Colours submenu. Colours. The options in this menu sets the colours for visual elements in Rockbox. Line Selector Colours. These options sets the colours for the line selector bars. Primary Colour: Set the primary colour used for the gradient line selector bar and the colour used for the solid color line selector bar.
Chapter 10. Recording Settings 10 Recording Settings Figure 10.1: The recording settings screen Note: To change the location where recordings are stored open the Context Menu (see section 4.1.2 (page 24)) on the directory where you want to store them in the File Browser and select Set As Recording Directory. 10.1 Format Choose which format to save your recording in. The available choices are the two uncompressed formats PCM Wave and AIFF, the losslessly compressed WavPack and the lossy MPEG Layer 3.
Chapter 10. Recording Settings 72 10.4 Source Choose the source of the recording. The options are: Mic. For recording from the radio see section 5.9 (page 44). 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 Mono Mode When configured to record to mono and the source is a stereo signal, use this setting to configure how the mono signal is created.
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.
Chapter 11. Plugins 11 Plugins Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit it to return to the Rockbox interface. Most plugins will not interfere with music playback but some of them will stop playback while running. Plugins have the file extension .rock.
Chapter 11. Plugins For the full set of rules to the game, and other facinating information visit http://www.blackjackinfo.com/blackjack-rules.php Key Action Select Rec Play Power In menu Start new game Resume saved game Show high scores Quit In game Left / Right / Scroll Forward / Scroll Backward Select Right Left Rec Power Enter betting amount Hit (Draw new card) Stay (End hand) Double down Save game Return to menu or cancel 11.1.2 BrickMania Figure 11.
Chapter 11. Plugins Special items Displayed Name Description N D L F G B FL Normal Die Life Fire Glue Ball Flip Returns paddle to normal. Ball dies; lose a life. Gain a life. Allows you to shoot bricks with paddle. Ball sticks to paddle each time it hits. Immediately fires another ball. Flip left / right movement. Key Left / Right Scroll Backward / Scroll Forward Select Power Action Moves the paddle Release the ball / Fire Open menu / Quit 11.1.3 Bubbles Figure 11.
Chapter 11. Plugins time a certain number of shots have been fired. Points are awarded depending on how quickly the level was completed. Key Action Play Left / Right Select Submenu Power Pause game Aim the bubble Fire bubble Save game Exit to menu 11.1.4 Chessbox Figure 11.4: Chessbox Chessbox is a one-person chess game with computer artificial intelligence. The chess engine is a port of GNU Chess 2 by John Stanback. It also works as a PGN file viewer.
Chapter 11. Plugins Keys Key Action Direction keys Select Rec Select+Right Power Move the cursor Pick up / Drop piece Change level Force play Show the menu 11.1.5 Chopper Figure 11.5: 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 11.1.6 Dice Dice is a simple dice rolling simulator. Select number and type of dice to roll in a menu and start by choosing “Roll Dice”.
Chapter 11. Plugins Key Action Play Power Roll dice again Quit 11.1.7 Doom Figure 11.6: Doom This is the famous Doom game. Getting started For the game to run you need .wad game files located in /.rockbox/doom/ on your player. Create the directory and save the following files there: rockdoom.wad. The Rockbox .wad, based on prboom.wad from prboom-2.2.6 Your wad files. Copy all Doom wads you wish to play into that directory.
Chapter 11. Plugins Main Menu. The Doom plugin has a main menu, which is brought up before a game is started. It has the following entries: Game. Select which (official) wad to launch Addon. Select which unofficial addon wad to launch (From /.rockbox/doom/addons directory) Demos. Select which demo file to play on game start Options. Configure low-level Doom options Play Game. Launch the wad/addon/Demo chosen Options Menu. This menu has the following options: Sound.
Chapter 11. Plugins Keys Key Action Play Submenu Left Right Select Rec Power Select Scroll Forward Move Forward Down Turn Left Turn Right Shoot Open InGame Menu Enter Change Weapon Playing the game After installation of the wad files is complete you can start the game. more description is needed 11.1.8 Flipit Figure 11.7: Flipit Flipping the colour of the token under the cursor also flips the tokens above, below, left and right of the cursor.
Chapter 11. Plugins Key Action Play / Submenu / Left / Right Select Rec+Left Rec+Right Rec+Select Power Move the cursor Flip Shuffle Solve Solve step by step Quit the game 11.1.9 Goban Figure 11.8: Goban Goban is a a plugin for playing, viewing and recording games of Go (also known as Weiqi, Baduk, Igo and Goe). It uses standard Smart Game Format (SGF) files for saving and loading games. You can find a short introduction to Go at http://senseis.xmp.
Chapter 11. Plugins you save over it). You have been warned. The file "/sgf/gbn def.sgf" is used by the plugin to store any unsaved changes in the most recently loaded game. This means that if you forget to save your changes, you should load "/sgf/gbn def.sgf" immediately to offload the changes to another file. If you load another file first then your changes will be lost permanently. The "/sgf/gbn def.sgf" file is also the file loaded if another is not selected.
Chapter 11. Plugins Zoom Level. Zoom in or out on the board. If you set the zoom level, it will be saved and used again the next time you open this plugin. Options. Open the Options Menu. Context Menu. Open the Context Menu which allows you to set play modes and other tools. Quit. Leave the plugin. Any unsaved changes are saved to "/sgf/gbn def.sgf". Game Info. The menu for modifying game info (metadata) of the current game.
Chapter 11. Plugins 86 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.sgf" regardless of if you have loaded a game or used Save As to save the game before or not. Set to Off to disable this functionality completely.
Chapter 11. Plugins 11.1.10 Invadrox Figure 11.9: Invadrox Invadrox is a clone of the classic arcade game Space Invaders. Kill those pesky aliens before they get to you. Remember, they increase speed, drop down and reverse direction after every pass! Key Action Left and Right Select Power Move left and right Fire Quit 11.1.11 Jewels Figure 11.
Chapter 11. 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 11. Plugins Key Action Scroll Forward, Scroll Backward, Left, Right Power Move Character Menu 11.1.13 Minesweeper Figure 11.12: Minesweeper plugin The classic game of minesweeper. Use the Play and Submenu keys to select the required percentage of mines to set the difficulty then press the Select key to begin. 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.
Chapter 11. Plugins Key Action Play / Submenu / Left / Right Scroll Forward / Scroll Backward Rec Select Long Rec Power Move the cursor across the minefield Scroll through the entire minefield Toggle flag on / off Reveal the contents of the current square Display the current game status Exit the game 11.1.14 Pacbox Figure 11.13: 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).
Chapter 11. Plugins These need to be stored in the /.rockbox/pacman/ directory on your player. In the MAME ROMs collection the necessary files can be found in pacman.zip and puckman.zip. The MAME project itself can be found at http://www.mame.net. Keys Key Action Right Left Play Submenu Select+Submenu Move Up Move Down Move Left Move Right Insert Coin Select Rec Power 1-Player Start 2-Player Start Menu 11.1.15 Pegbox Figure 11.14: pegbox To beat each level, you must destroy all of the pegs.
Chapter 11. Plugins Key Action Play, Submenu, In game to move around Left, Right Select Rec Scroll Backward to select/save to restart level to go up a level Scroll Forward Power to go down a level to quit 11.1.16 Pong Figure 11.15: Pong Pong is a simple two player “tennis game”. Whenever a player misses the ball the other scores.
Chapter 11. Plugins 11.1.17 Robotfindskitten Figure 11.16: Robotfindskitten In this game, you are robot (#). Your job is to find kitten. This task is complicated by the existence of various things which are not kitten. Robot must touch items to determine if they are kitten or not. The game ends when robotfindskitten. Key Action Scroll Forward, Scroll Backward, Left, Right Power Move robot Quit 11.1.18 Rockblox Figure 11.
Chapter 11. Plugins 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 11. Plugins 11.1.21 Sliding Puzzle Figure 11.18: Sliding puzzle The classic sliding puzzle game.
Chapter 11. Plugins 11.1.22 Snake Figure 11.19: Snake This is the popular snake game. The aim is to grow your snake as large as possible by eating the dots that appear on the screen. The game will end when the snake touches either the borders of the screen or itself. Key Action Play/Submenu Select Change levels (1 is slowest, 9 is fastest) Toggle Play/Pause 11.1.23 Snake 2 Figure 11.
Chapter 11. Plugins Another version of the Snake game. Move the snake around, and eat the apples that pop up on the screen. Each time an apple is eaten, the snake gets longer. The game ends when the snake hits a wall, or runs into itself.
Chapter 11. Plugins format or RLE (Run Length Encoded). For more information about the level format, see http://sokobano.de/wiki/index.
Chapter 11. Plugins This is the classic Klondike solitaire game for Rockbox. This is probably the best-known solitaire in the world. Many people do not even realize that other games exist. Though the name may not be familiar, the game itself certainly is. This is due in no small part to Microsoft’s inclusion of the the game in every version of Windows. Though popular, the odds of winning are rather low, perhaps one in thirty hands.
Chapter 11. Plugins Spacerocks is a clone of the old arcade game Asteroids. The goal of the game is to blow up the asteroids and avoid being hit by them. Once in a while, a UFO will appear – shoot this for extra points. Key Action Select Play Scroll Backward/ Scroll Forward Submenu Rec Power Shoot Thrust Turn left/right Teleport Pause game Quit 11.1.27 Star Figure 11.24: Star game This is a puzzle game. It is actually a rewrite of Star, a game written by CDK designed for the hp48 calculator.
Chapter 11. 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 Power Next level Exit the game 11.1.28 Sudoku Figure 11.25: Sudoku Sudoku in Rockbox can act as both a plugin and a viewer.
Chapter 11. 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 seperatly for every cell on the board.
Chapter 11. Plugins 11.1.29 Wormlet Figure 11.26: 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.
Chapter 11. Plugins piece of food will pop up somewhere. Unfortunately for each new piece of food that appears two new “argh” pieces will appear, too. Argh. An “argh” is a black square poisoned piece - slightly bigger than food - that makes a worm say “Argh!” when run into. A worm that eats an “argh” is dead. 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.
Chapter 11. Plugins Crashed: This indicates that a worm has crashed against a wall. Argh: If the score board entry displays “Argh!” it means the worm is dead because it tried to eat an “argh”. Until we can make the worm say “Argh!” it is your job to say “Argh!” aloud. 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.
Chapter 11. Plugins game. Be careful not to get in the way of enemy balls because, if they hit you or your trail, you lose a life. To finish a level you have to section off more than 75%. Key Action Play, Submenu, Left, Right Rec Power Move around the arena Pause Open menu 11.2 Demos 11.2.1 Bounce Figure 11.28: Bounce This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background.
Chapter 11. Plugins Xdist/Ydist. The distance to X axis and Y axis respectively Xadd/Yadd. How fast the code moves on the sine curve on each axis Xsane/Ysane. Changes the appearance of the bouncing. 11.2.2 Credits The credits plugin scrolls the entire list of the names of all the Rockbox contributors after displaying the Rockbox logo and version. This plugin is called when selecting Version from the System section of the Rockbox main menu. Exit at any time by pressing Left. 11.2.3 Cube Figure 11.
Chapter 11. Plugins 11.2.4 Demystify Figure 11.30: Demystify Demystify is a screen saver like demo. Key Action Right / Left Scroll Forward / Scroll Backward Power Increase / decrease speed Add / remove polygon Quit 11.2.5 Fire Figure 11.
Chapter 11. 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 11.2.6 Logo Demo showing the Rockbox logo bouncing around the screen. Key Action Right / Left Play / Submenu Power Increase / decrease speed on the x-axis Increase / decrease speed on the y-axis Quit 11.2.7 Mandelbrot Figure 11.
Chapter 11. Plugins Key Action Direction keys Scroll Forward Scroll Backward Move about the image Zoom in Zoom out Select+Left Select+Right Rec Power Decrease iteration depth (less detail) Increase iteration depth (more detail) Reset and return to the default image Quit 11.2.8 Mosaique Figure 11.33: Mosaique This simple graphics demo draws a mosaic picture on the screen of the player. Press Power to quit.
Chapter 11. Plugins 11.2.9 Oscilloscope Figure 11.34: Oscilloscope This demo shows the shape of the sound samples that make up the music being played. At faster speed rates, the player is less responsive to user input and music may start to skip.
Chapter 11. Plugins 11.2.10 PictureFlow Figure 11.35: PictureFlow PictureFlow is a plugin that provides a visualisation of your albums with their associated cover art. Requirements PictureFlow uses both the album art (see section C (page 162)) and database (see section 4.2 (page 27)) features of Rockbox. It is therefore important that these are working correctly before attempting to use PictureFlow.
Chapter 11. Plugins Main Menu 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. The distance, in screen pixels, with zoom at 100, between the centre and side slides. Scales with zoom. Number of slides.
Chapter 11. Plugins 11.2.11 Plasma Figure 11.36: Plasma Plasma is a demo displaying a 80’s style retro plasma effect. Key Action Play / Submenu Select Power Adjust frequency Change colours Quit 11.2.12 Snow Figure 11.37: 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 to quit.
Chapter 11. Plugins 11.2.13 Starfield Figure 11.38: Starfield Starfield simulation (like the classic screensaver). Key Action Right / Left Play / Submenu Select Power Increase / decrease number of stars Increase / decrease speed Change colours Quit 11.2.14 VU meter Figure 11.
Chapter 11. 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 11. Plugins the directory selected, or with the file selected in the file browser. You can then play the file or do with it whatever you want. The file will not be “played” automatically. If the .link file contains only one entry no list will be shown, you will directly jump to that location. The file shortcuts.link in the root directory is an exception. After “playing” it, the list will be shown even if the file contains just one entry. If the list you are seeing is from shortcuts.
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 11. 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 11. Plugins 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. From this menu you can force the viewer to render the image in greyscale using the Greyscale option or set the method of dithering used in the Dithering submenu.
Chapter 11. Plugins 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 .midi extension in the file browser to start playback. Note: Currently playing MIDI files is still in its early stages and you might experience “Buffer miss!” with many files, except simple ones.
Chapter 11. Plugins Set start time (min) 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. Quit mpegplayer Exit the plugin. Resume Menu Yes (min): x.x Resume video playback at stored resume time x.x. No Play video from the beginning. Main Menu Display Options Opens ”Display Options” submenu - see below.
Chapter 11. Plugins 11.3.8 Rockboy Figure 11.40: 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 Power Select Open Rockboy menu A button B button Start Rockboy menu Load Game. . . Loads a previously saved game. Save Game. . .
Chapter 11. Plugins Stats. Toggle showing fps and current frameskip. Set Keys (BUGGY) Select this option to set a new keymapping. Screen Size. Chose 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 by 90 degrees. Set Palette. Pick one of a few predefined colour palettes. Quit RockBoy. Quits the Rockboy plugin. 11.3.9 Search This plugin can be used on playlists.
Chapter 11. Plugins 124 The Viewer’s Menu Quit Exits the plugin. Viewer Options Encoding sets the codepage in the text viewer. Available settings: UTF-8 (Unicode), BIG5 (Traditional Chinese), KSX-1001 (Korean), GB2312 (Simple Chinese), SJIS (Japanese), CP1250 (Central European), ISO8859-2 (Latin Extended), ISO-8859-9 (Turkish), ISO-8859-6 (Arabic), ISO8859-11 (Thai), CP1251 (Cyrillic), ISO-8859-8 (Hebrew), ISO-8859-7 (Greek), ISO-8859-1 (Latin 1).
Chapter 11. Plugins Note: The text viewer automatically saves its settings and also stores the current position in the viewed text files (up to the last 46 files). b Compatibility • Currently messages are in English • Does not currently support right-to-left languages. 11.3.12 VBRfix This function scans a VBR (Variable Bitrate) MP3 file and updates/creates the Xing VBR header.
Chapter 11. Plugins used like a “Kempston” joystick. Per default the buttons, including an additional but fixed menu button, are assigned as follows: Key Action Play/Submenu/ Left/Right Select Power Directional movement Jump/Fire Open ZXBox menu ZXBox menu Vkeyboard. This is a virtual keyboard representing the Spectrum keyboard. Controls are the same as in standard Rockbox, but you just press one key instead of entering a phrase. Play/Pause Tape. Toggles playing of the tape (if it is loaded).
Chapter 11. Plugins Hacking graphics Due to ZXBox’s simple (but fast) scaling to the screen by dropping lines and columns some games can become unplayable. It is possible to hack graphics to make them better visible with the help of an utility such as the “Spectrum Graphics Editor”. Useful tools can be found at the “World of Spectrum” site (http://www.worldofspectrum.org/utilities. html). 11.4 Applications 11.4.
Chapter 11. Plugins Level The percent level of the battery estimated by Rockbox, and not the actual battery level. The actual battery level can be seen from the Voltage column Time Left This shows the time remaining until the battery is empty, again as estimated by Rockbox. 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.
Chapter 11. Plugins This is a simple scientific calculator for use on the player. It works like a standard calculator. Pressing the “1st” and “2nd” buttons will toggle between other available math functions. Key Action Left / Right / Play / Submenu / 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 11.4.3 Calendar Figure 11.
Chapter 11. Plugins Key Action Left / Right / Scroll Forward / Scroll Backward Select Play / Submenu Power Move the selector Show memos for the selected day Previous / Next month Quit 11.4.4 Chess Clock Figure 11.44: 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 11. 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 11. Plugins This is a fully featured analogue and digital clock plugin. Key configuration Key Action Left / Right Scroll Forward / Scroll Backward Submenu Select Long Select Power Cycle through modes Cycle through skins Main Menu Start / Stop Counter Reset Counter Save Settings (if enabled) and Exit Clock Menu View Clock Exits the menu and returns to the current clock mode display. Mode Selector Opens a menu from which you can select a clock mode to view.
Chapter 11. Plugins or PM will be displayed at the upper right. The Date readout, if enabled, is displayed at the lower left. The Counter, if enabled, is displayed at the lower right. The second hand, if enabled, is displayed along with the hour and minute hands. Digit display, if enabled, places “12”, “3”, “6”, and “9” around the face of the clock in their respective positions. Digital mode An imitation of an LCD, this mode shows a Clock comprised of digital “segments”.
Chapter 11. Plugins Cleaning’ to begin to process. The settings are stored in .rockbox/rocks/apps/disktidy.config, in a plain text file that is user-modifiable to allow more entries to be added. 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.
Chapter 11. Plugins 11.4.8 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 Power Toggle between colours Quit 11.4.9 md5sum Open a file, a directory or just launch it from the plugin menu to create an md5sum of the file, the directory’s contents or the whole filesystem. If the file’s extension is .md5 or .md5sum, it will check the md5 sums in the file instead. If the file’s extension is .
Chapter 11. Plugins ignored but want to include the folders within it you need to have both -/CDs and CDs as entries. Edit Folder List Enter the folder list editor Export List To Textfile Exports the list to /.rockbox/folder advance list.txt Import List From Textfile Imports the list from /.rockbox/folder advance list.
Chapter 11. Plugins Opening A File To open a file, you may use either the context menu option ”Open With” in the File Browser, or you may enter Rockpaint first using the Plugins menu and open a file from there. To perform the latter, simply press Rockpaint’s Menu button or move the cursor beyond the bottom of the screen; then move the cursor onto ”Menu” and select it. Finally, select ”Load” and navigate to the image you wish to open.
Chapter 11. Plugins Curved Gradient Fill Same as Gradient fill, but you must draw two lines. Rockpaint will draw a curved, gradual change of colour in the region. Menu This opens the Main Menu. You can also press the Menu key to open it. Main Menu The main menu consists of the following: Resume Closes the Main Menu. New Creates a new canvas and discards the current file. BE CAREFUL. You will lose any unsaved changes in the file that is currently open. Load Loads a bitmap file.
Chapter 11. Plugins 11.4.13 Stats Figure 11.47: The stats-plugin The stats-plugin simply counts the number of files, music files and directories on your player. Press Power to abort counting and exit the plugin. Press it again to quit after counting has finished. 11.4.14 Stopwatch Figure 11.48: Stopwatch A simple stopwatch program with support for saving times.
Chapter 11. 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 11.4.15 Text Editor This plugin allows you to view and edit simple text documents on your DAP. You can view files by using Open with from the Context Menu (see section 4.1.2 (page 24)). Usage If you start the Text Editor from the plugin browser you will be greeted with a blank screen.
Chapter 12. Advanced Topics 141 12 Advanced Topics 12.1 Customising the User Interface 12.1.1 Getting Extras Rockbox supports custom fonts. A collection of fonts is available for download in the font package at http://www.rockbox.org/daily.shtml. 12.1.2 Loading Fonts Rockbox can load fonts dynamically. Simply copy the .fnt file to the player and “play” it in the File Browser. If you want a font to be loaded automatically every time you start up, it must be located in the /.
Chapter 12. Advanced Topics in the /.rockbox/themes/ directory. The .colours file is just a text file, and can be edited with your text editor of choice. Creating the .colours file The .
Chapter 12. Advanced Topics Extension Colour If Extension is selected, the virtual keyboard (see section 4.1.3 (page 26)) appears, allowing the file extension to be modified. If Colour is selected, the colour selector screen appears. Choose the desired colour, then save the .colours file using the standard Text Editor controls. 12.1.5 Loading Backdrops Rockbox supports showing an image as a backdrop in the File Browser and the menus. The backdrop image must be a .
Chapter 12. Advanced Topics • All characters not preceded by % are displayed as typed. • Lines beginning with # are comments and will be ignored. • Maximum file size used is 1600 bytes. If you have a bigger WPS file, only the first part of it will be loaded and used. Note: Keep in mind that your player resolution is 176x220x16 (with the last number giving the colour depth in bits) when designing your own WPS, or if you use a WPS designed for another target.
Chapter 12. Advanced Topics Items on a line are broken into sublines with the semicolon ’;’ character. The display time for each subline defaults to 2 seconds unless modified by using the ’%t’ tag to specify an alternate time (in seconds and optional tenths of a second) for the subline to be displayed. Subline related special characters and tags: ; Split items on a line into separate sublines %t Set the subline display time.
Chapter 12. Advanced Topics Using Images You can have as many as 52 images in your WPS. There are various ways of displaying images: 1. Load and always show the image, using the %x tag 2. Preload the image with %xl and show it with %xd. This way you can have your images displayed conditionally. 3. Load an image and show as backdrop using the %X tag. The image must be of the same exact dimensions as your display. Example on background image use: Example %X|background.
Chapter 12. Advanced Topics while playing your jukebox in your car, and a headphones.cfg file to store the settings that you use while listening to your player through headphones. See section 12.3.2 (page 147) below for an explanation of the format for configuration files. See section 12.3.3 (page 148) for an explanation of how to create, edit and load configuration files. 12.3.2 Specifications for .cfg Files. The Rockbox configuration file is a plain text file, so once you use the Save .
Chapter 12. Advanced Topics 148 12.3.3 The Manage Settings menu The Manage Settings menu can be found in the Main Menu. The Manage Settings menu allows you to save and load .cfg files. Browse .cfg Files Opens the File Browser in the /.rockbox directory and displays all .cfg (configuration) files. Selecting a .cfg file will cause Rockbox to load the settings contained in that file. Pressing Left will exit back to the Manage Settings menu. See the Write .
Appendix A.
Appendix A. File formats A File formats A.1 Supported file formats Icon File Type Extension Action when selected Directory Audio file Cuesheet Playlist none various (see A.2) .cue .m3u, .m3u8 Rockbox firmware While Playing Screen .mi4 .wps Language File Text File .lng .txt Configuration File Font .cfg .
Appendix A. File formats A.2 Supported audio formats Format Extension Notes Lossy codecs MPEG audio OGG/Vorbis Musepack Advanced Audio Coding .mp1, .mpa, .mp2, .mp3 .ogg, .oga ATSC A/52 .mpc .m4a, .m4b, .mp4 .wma, .wmv, .asf .a52, .ac3 ADX Speex .adx .spx Windows Media Audio Some old “floor 0” files may crash Rockbox. Supports downmixing for playback of 5.1 streams in stereo.
Appendix B. WPS Tags B WPS Tags B.1 Status Bar Tag Description %we %wd Display Status Bar Hide Status Bar These tags override the player setting for the display of the status bar. They must be noted on their own line (which will not be shown in the WPS). B.2 Information from the track tags Tag Description %ia %ic %id %ig %in %it %iv %iy Artist Composer Album Name Genre Name Track Number Track Title ID3 version (1.0, 1.1, 2.2, 2.3, 2.
Appendix B. WPS Tags 153 B.3 Power Related Information Tag Description %bl Numeric battery level in percents Can also be used in a conditional: %?bl<-1|0|1|2|...
Appendix B. WPS Tags 154 B.5 Playlist/Song Info Tag Description %pb Progress Bar This will replace the entire line with a progress bar. You can set the height, position and width of the progressbar (in pixels): %pb|height|leftpos|rightpos|toppos| Percentage Played In Song Current Time In Song Total Number of Playlist Entries Peak Meter. The entire line is used as volume peak meter.
Appendix B. WPS Tags B.8 Virtual LED Tag Description %lh “h” if the flash storage is accessed B.9 Repeat Mode Tag Description %mm Repeat mode, 0-4, in the order: Off, All, One, Shuffle Example: %?mm B.10 Playback Mode Tags Tag Description %mp Play status, 0-4, in the order: Stop, Play, Pause, Fast Forward, Rewind Example: %?mp B.
Appendix B. WPS Tags The example above will display the text “Volume changing” if the volume is being changed and 2.5 secs after the volume button has been released. After that, it will display the volume value. B.12 Settings Tag Description %St|| The value of the Rockbox setting with the specified name. See section D (page 164) for the list of the available settings. Examples: 1. As a simple tag: %St|skip length| 2.
Appendix B. WPS Tags B.13 Images Tag Description %X|filename.bmp| Load and set a backdrop image for the WPS. This image must be exactly the same size as your LCD. Load a Progress Bar image for the WPS. Use %pb tag to show the progress bar Load and display an image n: image ID (a-z and A-Z) for later referencing in %xd filename: file name relative to /.rockbox/ and including “.bmp” x: x coordinate y: y coordinate.
Appendix B. WPS Tags • The images must be in BMP format • The image tag must be on its own line • The ID is case sensitive, giving 52 different ID’s • The size of the LCD screen for each player varies. See table below for appropriate sizes of each device. The x and y coordinates must repect each of the players’ limits. B.
Appendix B. WPS Tags B.15 Alignment Tag Description %al %ac %ar Align the text left Center the text Align the text right All alignment tags may be present in one line, but they need to be in the order left – center – right. If the aligned texts overlap, they are merged. B.16 Conditional Tags Tag Description %?xx %?xx If / Else: Evaluate for true or false case Enumerations: Evaluate for first / second / third / . . . / last condition B.
Appendix B. WPS Tags B.
Appendix B. WPS Tags 161 B.19 Other Tags Tag Description %% %< %| %> %; %s 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 C. Album Art C Album Art C.1 Introduction Rockbox allows you to put the album art, or another image related to the music on your playerto display it in the PictureFlow plugin or in the WPS. For this feature to work, you must observe a few rules. C.2 Limitations Rockbox does not support album art embedded in your files’ tags, and will instead look for a picture located in the filesystem. In addition to this, the pictures must be in the BMP or JPEG formats.
Appendix C. Album Art 163 The following characters will be replaced with an underscore ( ) when looking for albumtitle.bmp or artist-albumtitle.bmp: \ / : < > ? * |. Doublequotes will be replaced by single qutoes. See ZAlbumArt in the wiki for more details and programs that will help you automate the process of putting album art on your player.
Appendix D.
Appendix D.
Appendix D.
Appendix D. Config file options Setting Allowed Values eq band 4 q eq band 0 gain eq band 1 gain eq band 2 gain eq band 3 gain eq band 4 gain dithering enabled beep keyclick keyclick repeats dircache tagcache ram peak meter release peak meter hold 0 to 64 N/A -240 to 240 0.1dB -240 to 240 0.1dB -240 to 240 0.1dB -240 to 240 0.1dB -240 to 240 0.
Appendix D.
Appendix E.
Appendix F. User feedback F User feedback F.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 F.1.1 Rules for submitting new bug reports 1. Check that the bug has not already been reported 2.
Appendix F. User feedback 171 F.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 G. Changelog G Changelog G.1 What is new since v3.0? G.1.1 New features ? 2008-12-09: Album Art resizing. ? 2008-12-09: FM radio support on Gigabeat S. ? 2008-11-26: Software controlled backlight fading for targets without hardware fading (e200v1, c200v1, X5, Cowon D2 and H300) G.1.
Appendix G.
Appendix G.
Appendix G. Changelog 175 G.2.
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 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 180 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 181 A section ”Entitled XYZ” means a named subunit of the Document whose title either 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 you use the latter option, you must take reasonably prudent steps, when you begin 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 183 create one stating the title, year, authors, and publisher of the Document as given 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 188 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 189 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 190 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. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License.
Appendix I. Licenses 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 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 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. You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc.
