The Rockbox Manual for Iaudio X5

rockbox.org June 7, 2011

Rockbox
http://www.rockbox.org/ Open Source Jukebox Firmware
Rockbox and this manual is the collaborative eort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2010 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 Jos Maria Garcia-Valdecasas Bernal & Peter Schlenker.
A Version r29982-110607. Built using pdfL TEX.
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 Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License.

The Rockbox manual

Iaudio X5

Contents

1. Introduction 1.1. Welcome. 1.2. Getting more help. 1.3. Naming conventions and marks. 2. Installation 2.1. Before Starting. 2.2. Installing Rockbox. 2.2.1. Automated Installation. 2.2.2. Manual Installation. 2.2.3. Finishing the install. 2.2.4. Enabling Speech Support (optional) 2.3. Running Rockbox. 2.4. Updating Rockbox. 2.5. Uninstalling Rockbox. 2.5.1. Automatic Uninstallation. 2.5.2. Manual Uninstallation. 2.6. Troubleshooting. 3. Quick Start 3.1. Basic Overview. 3.1.1. The players controls. 3.1.2. Turning the player on and o 3.1.3. Putting music on your player 3.1.4. The rst contact. 3.1.5. Basic controls. 3.1.6. Basic concepts. 3.2. Customising Rockbox. 4. Browsing and playing 4.1. File Browser. 4.1.1. File Browser Controls. 4.1.2. Context Menu. 4.1.3. Virtual Keyboard. 4.2. Database. 4.2.1. Introduction. 4.2.2. Initializing the Database 26 26
Contents 4.2.3. The Database Menu. 4.2.4. Using the Database. 4.3. While Playing Screen. 4.3.1. WPS Key Controls. 4.3.2. Peak Meter. 4.3.3. The WPS Context Menu 4.4. Working with Playlists. 4.4.1. Playlist terminology. 4.4.2. Creating playlists. 4.4.3. Adding music to playlists 4.4.4. Modifying playlists. 4.4.5. Saving playlists. 4.4.6. Loading saved playlists. 4.4.7. Helpful Hints. 5. The 5.1. 5.2. 5.3. 5.4. 5.5. 5.6. 5.7. Main Menu Introducing the Main Menu. Navigating the Main Menu. Recent Bookmarks. Files. Database. Now Playing/Resume Playback Settings. 5.7.1. Sound Settings. 5.7.2. Playback Settings. 5.7.3. General Settings. 5.7.4. Theme Settings. 5.7.5. Recording Settings. 5.7.6. Manage Settings. 5.8. Recording. 5.8.1. While Recording Screen 5.9. FM Radio. 5.10. Playlists. 5.11. Plugins. 5.12. System. 5.13. Quick Screen..
6. Sound Settings 6.1. Volume. 6.2. Bass. 6.3. Treble. 6.4. Balance. 6.5. Channels. 6.6. Stereo Width
Contents 6.7. Crossfeed. 6.8. Equalizer. 6.9. Dithering. 6.10. Timestretch 6.11. Compressor..
7. Playback Settings 7.1. Shue. 7.2. Repeat. 7.3. Play Selected First. 7.4. Fast-Forward/Rewind. 7.5. Anti-Skip Buer. 7.6. Fade on Stop/Pause. 7.7. Party Mode. 7.8. Crossfade. 7.9. Replaygain. 7.10. Track Skip Beep. 7.11. Auto-Change Directory 7.12. Last.fm Log. 7.13. Cuesheet Support. 7.14. Skip Length. 7.15. Prevent Track Skipping 7.16. Rewind Before Resume. 7.17. Rewind on Pause.
8. General Settings 8.1. Playlist. 8.2. File View. 8.3. Database. 8.4. Display. 8.5. System. 8.5.1. Start Screen. 8.5.2. Battery. 8.5.3. Disk. 8.5.4. Idle Powero. 8.5.5. Limits. 8.5.6. Car Adapter Mode 8.5.7. Keyclicks. 8.6. Bookmarking. 8.7. Automatic resume. 8.8. Language. 8.9. Voice. 9. Theme Settings
Contents 10.Recording Settings 10.1. Format. 10.2. Encoder Settings. 10.3. Frequency. 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.10. lipping Light. C 10.11. rigger. T 11.Plugins 11.1. Games. 11.1.1. Blackjack. 11.1.2. BrickMania. 11.1.3. Bubbles. 11.1.4. Chessbox. 11.1.5. Clix. 11.1.6. Chopper. 11.1.7. Codebuster. 11.1.8. Dice. 11.1.9. Doom. 11.1.10.Flipit. 11.1.11.Goban. 11.1.12.Invadrox. 11.1.13.Jackpot. 11.1.14.Jewels. 11.1.15.MazezaM. 11.1.16.Minesweeper. 11.1.17.Pacbox. 11.1.18.Pegbox. 11.1.19.Pong. 11.1.20.Reversi. 11.1.21.Robotndskitten 11.1.22.Rockblox. 11.1.23.Rockblox1d. 11.1.24.Rocklife. 11.1.25.Sliding Puzzle. 11.1.26.Snake. 11.1.27.Snake 2. 11.1.28.Sokoban. 11.1.29.Solitaire.

102 103

Contents 11.1.30.Spacerocks. 11.1.31.Star. 11.1.32.Sudoku. 11.1.33.Wormlet. 11.1.34.Xobox. 11.2. Demos. 11.2.1. Bounce. 11.2.2. Credits. 11.2.3. Cube. 11.2.4. Demystify. 11.2.5. Fire. 11.2.6. Fractals. 11.2.7. Logo. 11.2.8. Mosaique. 11.2.9. Oscilloscope. 11.2.10.PictureFlow. 11.2.11.Plasma. 11.2.12.Snow. 11.2.13.Stareld. 11.2.14.VU meter. 11.3. Viewers. 11.3.1. Shortcuts. 11.3.2. Chip-8 Emulator. 11.3.3. Frotz. 11.3.4. Image Viewer. 11.3.5. Lua scripting language 11.3.6. Midiplay. 11.3.7. MPEG Player. 11.3.8. MP3 Encoder. 11.3.9. Rockboy. 11.3.10.Search. 11.3.11.Shopper. 11.3.12.Sort. 11.3.13.Text Viewer. 11.3.14.Theme Remove. 11.3.15.VBRx. 11.3.16.ZXBox. 11.4. Applications. 11.4.1. Alarm Clock. 11.4.2. Battery Benchmark. 11.4.3. Calculator. 11.4.4. Calendar. 11.4.5. Chess Clock. 11.4.6. Clock..

3.1.2. Turning the player on and o
To turn on and o your Rockbox enabled player use the following keys: Key Power Long Power Remote Key Play Long Play Action 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 164) for details. In the unlikely event of a software failure, hardware powero or reset can be performed by holding down Power until the player shuts o or reboots.
3.1.3. Putting music on your player
With the player connected to the computer as an MSC/UMS device (like a USB Drive), music les can be put on the player via any standard le transfer method that you would use to copy les between drives (e.g. Drag-and-Drop). Files may be placed wherever you like on the player, but it is strongly suggested not to place them in the /.rockbox folder. The default directory structure that is assumed by some parts of Rockbox (album art searching, and missing-tag fallback in some WPSes) uses the parent directory of a song as the Album name, and the parent directory of that folder as the Artist name. WPSes may display information incorrectly if your les are not properly tagged, and you have your music organized in a way dierent than they assume when attempting to guess the Artist and Album names from your letree. See section C.21 (page 183) for the requirements for Album Art to work properly. See section B.1 (page 169) for a list of supported audio formats.

3.1.4. The rst contact

After you have rst started the player, youll be presented by the Main Menu. From this menu you can reach every function of Rockbox, for more information (see section 5.1 (page 38)). To browse the les on your player, select Files (see section 4.1 (page 22)),
and to browse in a view that is based on the meta-data1 of your audio les, select Database (see section 4.2 (page 26)).

3.1.5. Basic controls

When browsing les 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 Down and Up to move around the selection. Use Select, Right or Play to select an item. When browsing the le system selecting an audio le plays it. The view switches to the While playing screen, usually abbreviated as WPS (see section 4.3 (page 28). The dynamic playlist gets replaced with the contents of the current directory. This way you can easily treat directories as playlists. The created dynamic playlist can be extended or modied while playing. This is also known as onthe-y playlist. To go back to the File Browser stop the playback with the Long Play button or return to the le browser while keeping playback running using Select. In list views you can go back one step with Left.

Chapter 4. Browsing and playing Tag lename album albumartist artist comment composer genre grouping title bitrate discnum year tracknum autoscore lastplayed playcount Pm (play time min) Ps (play time - sec) rating commitid entryage length Lm (track len min) Ls (track len - sec) Type string string string string string string string string string numeric numeric numeric numeric numeric numeric numeric numeric numeric numeric numeric numeric numeric numeric numeric Origin system id tag id tag id tag id tag id tag id tag id tag id tag id tag id tag id tag id tag/lename runtime db runtime db runtime db runtime db runtime db runtime db system system system system system
4.3. While Playing Screen
The While Playing Screen (WPS) displays various pieces of information about the currently playing audio le. The appearance of the WPS can be congured using WPS conguration les. The items shown depend on your conguration all items can be turned on or o independently. Refer to section C (page 175) for details on how to change the display of the WPS. Status bar: The Status bar shows Battery level, charger status, volume, play mode, repeat mode, shue mode and clock. In contrast to all other items, the status bar is always at the top of the screen. (Scrolling) path and lename of the current song. The ID3 track name.
Chapter 4. Browsing and playing The ID3 album name. The ID3 artist name. Bit rate. VBR les 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 157) for details of customising your WPS (While Playing Screen).

4.3.1. WPS Key Controls

Key Up / Down Left Remote Key Volume Up / Volume Down Rewind Action Volume up/down. Go to beginning of track, or if pressed while in the rst seconds of a track, go to the previous track. Rewind in track. Go to the next track. Fast forward in track. Toggle play/pause. Stop playback. Return to the File Browser / Database. Enter WPS Context Menu. Enter Main Menu. Switch to the Quick Screen (see section 5.13 (page 45)). Skip to the next directory.

Chapter 6. Sound Settings

6. Sound Settings

Figure 6.1.: The sound settings screen
The sound settings menu oers 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). All values lower than this reference will be negative and yield a progressively softer volume. Values higher than 0 dB are available and can be used to raise the volume more than would otherwise be possible. These volume levels will ordinarily lead to distorted sound, but might work nicely for music that has an otherwise low volume level. The volume can be adjusted from a minimum of -73 dB to a maximum of +6 dB.

6.2. Bass

This setting emphasises or suppresses the lower (bass) frequencies in the sound. A value of 0 dB means that bass sounds are unaltered (at response). The minimum setting is -24 dB and the maximum is 24 dB.

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 (at response). The minimum
Chapter 6. Sound Settings 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. Negative numbers increase the volume of the left channel relative to the right, positive numbers increase the volume of the right channel relative to the left.

6.5. Channels

A stereo audio signal consists of two channels, left and right. The Channels setting determines if these channels are to be combined in any way, and if so, in what manner they will be combined. Available options are: Stereo. Leave the audio signal unmodied. Mono. Combine both channels and send the resulting signal to both stereo channels, resulting in a monophonic output. Custom. Allows you to manually specify a stereo width with the Stereo Width setting described later in this chapter. Mono Left. Plays the left channel in both stereo channels. Mono Right. Plays the right channel in both stereo channels. Karaoke. Removes all sound that is common to both channels. Since most music is recorded with vocals being equally present in both channels to make the singer sound centrally placed, this often (but not always) has the eect of removing the voice track from a song. This setting also very often has other undesirable eects on the sound.

6.6. Stereo Width

Stereo width allows you to manually specify the eect 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 eect 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 eect of widening the stereo eld. A value of 100% will leave the stereo eld unaltered.

7.9. Replaygain

This allows you to control the replaygain function. The purpose of replaygain is to adjust the volume of the music played so that all songs (or albums, depending on your settings) have the same apparent volume. This prevents sudden changes in volume when changing between songs recorded at dierent 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. Maintain a constant volume level between albums, but keep any intentional volume variations between songs in an album. (If album gain value is not available, uses track gain information). Track Gain. Maintain a constant volume level between tracks. If track gain value is not available, no replaygain is applied. Track Gain If Shuing. Maintains a constant volume between tracks if Shuffle is set to Yes. Reverts to album mode if Shuffle is set to No. O. Do not process replaygain information, i.e. turn o the replaygain function. Prevent Clipping. Avoid clipping of a songs waveform. If a song would clip during playback, the volume is lowered for that song. Replaygain information is needed for this to work.
Pre-amp. This allows you to adjust the volume when replaygain is applied. Replaygain often lowers the volume, sometimes quite much, so here you can compensate for that. Please note that a (large) positive pre-amp setting can cause clipping, unless prevent clipping is enabled. The pre-amp can be set to any decibel (dB) value between -12 dB and +12 dB, in increments of 0.5 dB.

7.10. Track Skip Beep

Controls the volume of the beep that is heard when skipping forward or backward between tracks. The beep is disabled when set to Off.
7.11. Auto-Change Directory
Control what Rockbox does when it reaches the end of a directory. If Auto-Change Directory is set to Yes, Rockbox will continue to the next directory. If Auto-Change Directory is set to No, playback will stop at the end of the current playlist. Using the Random feature requires you to rst generate a folder list via the Random Folder Advance Conguration plugin (see section 11.4.14 (page 147)). Note: You must have the Repeat option set to No for Auto-Change Directory to function properly. Note: This feature only works when songs have been played from the le browser. Using it with the database may cause unexpected behaviour.

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.

8.7. 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. It does not matter in which way you start the track; tracks are resumed whether they are navigated to through the database browser or le browser, by starting a playlist, or by skipping through tracks in the current playlist. (As an exception, when a track is resumed by loading a bookmark, the playback position saved in the bookmark takes precedence.) Optionally, you can also enable automatic resume for automatic track transitions. In this case, the next track will be resumed as well instead of starting playback at its beginning. This is most useful for podcasts, and can be enabled on a per-directory basis. A tracks resume position is updated whenever playback of that track stops, including when explicitly stopping the track, powering o the player, or starting playback of another track. If you intend to start a track from its beginning but notice that it was resumed, you can press Left in the WPS to skip back to its beginning. When pressing Left again in the rst few seconds of a track to go to the previous track, the previously (on rst button press) saved resume position is retained. Therefore, you can also use Left and Right to skip across tracks in a playlist without losing their resume position. Automatic resume. This option enables or disables automatic resume globally. When Rockbox detects that the database (which is needed for this feature) has not been initialized yet, it asks whether it should be initialized right away.
Resume on automatic track change. Controls whether the next track in an automatic track transition should be resumed at its last playback position as well. No. Automatic resume works only for manual track selection. Yes. Always attempt to resume for both manual and automatic track changes. In custom directories only. Congure directories in which to enable resume on automatic track change. Selecting this option starts the text editor, in which you can enter the (absolute, case-insensitive) directory names separated by colons (:). A typical value is /podcast, which matches all les in directories /PODCAST, /Podcast or /podcast and their subdirectories, but not in directories /podcasts (mind the trailing s) or /audio/podcast.

Key Up / Down / Left / Right Select Long Select Play Rec Power
Action Move the cursor Change number under the cursor Constantly changing the number under the cursor Open Menu Add/Remove number to scratchpad Quit
Some places where can you can nd.ss les: Simple Sudoku (Advanced Puzzle Packs 1 and 2 located near the bottom of that page): http://www.angusj.com/sudoku/ Kjells Sudoku generator/solver: http://kjell.haxx.se/sudoku/

11.1.33. Wormlet

Figure 11.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 nd 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 Game controls: Key Left Right Up Down Remote Key Action Turn Turn Turn Turn left right Up Down
The game Use the control keys of your worm to navigate around obstacles and nd food. Worms do not stop moving except when dead. Dead worms are no fun. Be careful as your worm will try to eat anything that you steer it across. It wont distinguish whether it is edible or not. Food. The small square hollow pieces are food. Move the worm over a food tile to eat it. After eating the worm grows. Each time a piece of food has been eaten a new piece of food will pop up somewhere. 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. Eating worms is blasphemous cannibalism, not healthy and causes instant death. And it doesnt help anyway: the other worm isnt hurt by the bite. It will go on creeping happily and eat all the food you left on the table. Walls. Dont crash into the walls. Walls are not edible. Crashing a worm against a wall causes it a headache it doesnt survive. Game over. The game is over when all worms are dead. The longest worm wins the game. Pause the game. Press Play to pause the game. Press it again to resume the game.

Stop the game. There are two ways to stop a running game. If you want to quit Wormlet entirely simply hit Power. The game will stop immediately and you will return to the game menu. If you want to stop the game and still see the screen hit Rec. This freezes the game. If you hit Rec button again a new game starts with the same conguration. To return to the games menu you can hit Power. A stopped game can not be resumed.
Chapter 11. Plugins The scoreboard
On the right side of the game eld is the score board. For each worm it displays its status and its length. The top most entry displays the state of worm 1, the second worm 2 and the third worm 3. When a worm dies its entry on the score board turns black. Len: Here the current length of the worm is displayed. When a worm is eating food it grows by one pixel for each step it moves. Hungry: Thats the normal state of a worm. Worms are always hungry and want to eat. It is good to have a hungry worm since it means that your worm is alive. But it is better to get your worm growing. Growing: When a worm has eaten a piece of food it starts growing. For each step it moves over food it can grow by one pixel. One piece of food lasts for 7 steps. After your worm has moved 7 steps the food is used up. If another piece of food is eaten while growing it will increase the size of the worm for another 7 steps. 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. Thats 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. Dont worry if the other worms grow longer than yours - you can catch up after theyve died. When you are more experienced watch the tactics of other worms. Those worms controlled by articial stupidity head straight for the nearest piece of food. Let the other worm have its next piece of food and head for the food it would probably want next. Try to put yourself between the opponent and that food. From now on you can control the other worm by blocking it. You could trap it by making a 1 pixel wide U-turn. You also could move from food to food and make sure you keep between your opponent and the food. So you can always reach it before your opponent.

11.2.8. Mosaique

Figure 11.36.: Mosaique
This simple graphics demo draws a mosaic picture on the screen of the player. Press Power to quit.

11.2.9. Oscilloscope

Figure 11.37.: Oscilloscope
This demo shows the shape of the sound samples that make up the music being played. At faster speed rates, the player is less responsive to user input and music may start to skip. Keys Key Select Rec Long Select Play Up / Down Right / Left Power Remote Key Action Toggle lled / curve / plot Toggle whether to scroll or not Toggle drawing orientation Pause the demo Increase / decrease volume Increase / decrease speed Exit demo

11.2.10. PictureFlow

Figure 11.38.: PictureFlow
PictureFlow provides a visualisation of your albums with their associated cover art. It is possible to start playback of the selected album from PictureFlow. Playback will start from the selected track. The PictureFlow plugin will continue to run while your tracks are played. Requirements PictureFlow uses both the album art (see section C.21 (page 183)) and database (see section 4.2 (page 26)) features of Rockbox. It is therefore important that these are working correctly before attempting to use PictureFlow. In addition, there are some other points of which to be aware: PictureFlow will accept album art larger than the dimensions of the screen, but the larger the dimensions, the longer they will take to scale. Keys Key Left / Right Up / Down Select Left Rec Power Remote Key Action Scroll through albums Scroll through track list Enter track list / Play album from selected track Exit track list Enter menu Exit PictureFlow
Main Menu Go to WPS. Leave PictureFlow and enter the while playing screen.
Chapter 11. Plugins Playback Control. Control music playback from within the plugin. Settings. Enter the settings menu. Return. Exit menu. Quit. Exit PictureFlow plugin. Settings Menu Show FPS. Displays frames per second on screen.
Spacing. The distance between the front edges of the side slides, i.e. changes the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom. Centre margin. The distance, in screen pixels, with zoom at 100, between the centre and side slides. Scales with zoom. Number of slides. Sets the number of slides at each side, including the centre slide. Therefore if set to 4, there will be 3 slides on the left, the centre slide, and then 3 slides on the right. Zoom. Changes the distance at which slides are rendered from the camera. Show album title. Allows setting the album title to be shown above or below the cover art, or not at all. Resize Covers. Set whether to automatically resize the covers or to leave them at their original size. Rebuild cache. Rebuild the PictureFlow cache. This is needed in order for PictureFlow to pick up new albums, and may occasionally be needed if albums are removed.

Chapter 11. Plugins Audio Options Menu
Tone Controls (default: force o) Use the bass and treble control settings or force them o. Channel Modes (default: force o) Use the channel conguration setting or force Stereo mode. Crossfeed (default: force o) Use the Crossfeed setting or force crossfeed o. Equalizer (default: force o) Use the Equalizer setting or force the equalizer o. Dithering (default: force o) Use the Dithering setting or force audio dithering o. See this page in the Rockbox wiki for information on how to encode your videos to the supported format. ZPluginMpegplayer

11.3.8. MP3 Encoder

This plugin encodes a.wav le to MP3 format. The supported input format is uncompressed, linear PCM with 16 bit per sample and a maximum of 2 channels. Allowed sample rates are 16, 22.05, 24, 32, 44.1 and 48 kHz. The user will be asked to select the desired output bitrate of the compressed MP3 le. Select Bitrate The following bitrates can be selected: 64, 80, 96, 112, 128, 160, 192, 224, 256, 320 kbps. Remark: Bitrates above 160 kbps cannot be used in MPEG 2 Layer 3 bitstreams. The encoder plugin automatically limits the output bitrate to 160 kbps for input les with a sample rate of 16, 22.05 or 24 kHz. The same limitation is valid for mono les. The output.mp3 le is written to the same path as the.wav le using the same lename. To use this plugin, open the Context Menu (see section 4.1.2 (page 23)) on a.wav le and select Open With. mp3_encoder. Note: The encoder will choose the appropriate bitstream format from the sample rate of the input le. The output bitstream format is MPEG 1 Layer 3 for 32, 44.1 and 48 kHz, and MPEG 2 Layer 3 for 16, 22.05 and 24 kHz. MPEG 2.5 Layer 3 is not supported.

11.3.9. Rockboy

Figure 11.43.: Rockboy
Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game, open a ROM le saved as.gb or.gbc in the le browser.
Default keys Key Up / Down Left / Right Play Rec Select Power Remote Key Action Direction keys A button B button Start Open Rockboy menu
Rockboy menu Load Game. Loads a previously saved game. Save Game. Saves your current state. Options. Max Frameskip. Change frameskip setting to improve speed. Sound. Toggle sound on or o. Stats. Toggle showing fps and current frameskip. Set Keys (BUGGY) Select this option to set a new keymapping. Note: The direction keys are set for the normal screen orientation, not the rotated orientation.
Screen Size. Choose whether the original aspect ratio should be kept when scaling the picture to the screen. Screen Rotate. Rotate the displayed picture and direction keys by 90 degrees. Set Palette. Pick one of a few predened colour palettes. Reset. Resets the Emulator. Quit RockBoy. Quits the Rockboy plugin.

11.3.10. Search

This plugin can be used on playlists. It searches through the playlist that it opened on looking for any occurrences of the string entered by the user. The results of this search are saved to a new playlist, search_results.m3u, within the same directory as the original playlist.

11.4.3. Calculator

Figure 11.48.: Calculator
This is a simple scientic 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 Left / Right / Up / Down Select Rec Play Power Remote Key Action Move around the keypad Select a button Delete last entered digit or clear after calculation Calculate Quit

11.4.4. Calendar

Figure 11.49.: Calendar
This is a small and simple calendar application with memo saving function. Dots indicate dates with memos. The available memo types are: one o, yearly, monthly, and weekly memos.
You can select what day is rst day of week by the setting First Day of Week in the menu. Key Left / Right / Up / Down Select Rec / Play Power Remote Key Action Move the selector Show memos for the selected day Previous / Next month Quit

11.4.5. Chess Clock

Figure 11.50.: Chess Clock
The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players. Setup Key Right / Left Select Rec Remote Key Action Increase / decrease displayed Value Move to next screen Move to previous screen
First enter the number of players (110) Then set the total game time in mm:ss Then the maximum round time is entered. For example, this could be used to play Scrabble for a maximum of 15 minutes each, with each round taking no longer than one minute.
Chapter 11. Plugins 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 dierent). Keys are as follows:
Key Rec Power Play Right Left Select
Action Exit plugin Restart round for the current player Pause the time (press again to continue) Switch to next player Switch to previous player Open menu (press again to select.)
From the menu it is possible to delete a player, modify the round time for the current player or set the total time for the game. When the round time is up for a player the message ROUND UP! is shown (press NEXT to continue). When the total time is up for a player the message TIME UP!is shown. The player will then be removed from the timer.

11.4.6. Clock

Figure 11.51.: Clock
This is a fully featured analogue and digital clock plugin.
Chapter 11. Plugins Key conguration Key Left / Right Up / Down Rec Select Long Select 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. Remote Key Volume Down / Volume Up Forward / Rewind Rec Mode Long Mode Action Cycle through modes Cycle through skins Main Menu Start / Stop Counter Reset Counter

%ff %fk %fm %fn %fp %fs %fv %d(N)
Example for the %d(N) commands: If the le is /Rock/Kent/Isola/11 - 747.mp3, %d(1) is Isola, %d(2) is Kent and %d(3) is Rock.
These tags, when written with the rst letter capitalized (e.g. %Fn or %D(2)), produce the information for the next le to be played.

C.8. Playlist/Song Info

Tag %pb Description 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. Can be used as a value, a conditional tag or a bar tag. Peak meter for the right channel. Can be used as a value, a conditional tag or a bar tag. Playlist name (without path or extension) Playlist position Remaining time in song s if shue mode is enabled Total track time Current volume (in dB). Can also be used in a conditional: %?pv<0|1|2|.|N> 0 is used for mute, the last option is used for values greater than zero. This can also be used like %pb to provide a continuous scale: %pv(x,y,[width],[height],image.bmp) Track is starting. An optional number gives how many seconds the tag remains true for after the start of the track. The default is 10 seconds if no number is specied. %?pS(7)<in the first 7 seconds of track|in the rest of the track> Track is ending. An optional number gives how many seconds before the end of the track the tag becomes true. The default is 10 seconds if no number is specied. %?pE(7)<in the last 7 seconds of track|in the rest of the track> Current playback pitch
%px %pc %pe %pm %pL %pR %pn %pp %pr %ps %pt %pv

C.9. Playlist Viewer

Tag %Vp(start,code to render) Description Display the playlist viewer in the current viewport.
start is the oset 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 supporte (including conditionals and sublines) The entire viewport will be used, so dont expect other tags in the same viewport to work well. Supported tags are %pp, all tags starting with %i, most tags starting with %f, %pt and %s. Example: %Vp(1,%pp - %it,%pp - %fn) Display the playlist position, then either the track title (from the tags) or the lename. The viewer will display as many tracks as will t in the viewport.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms dened in section 4 above for modied versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodied, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but dierent contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled History in the various original documents, forming one section Entitled History; likewise combine any sections Entitled Acknowledgements, and any sections Entitled Dedications. You must delete all sections Entitled Endorsements.
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an aggregate if the copyright resulting from the compilation is not used to limit the legal rights of the compilations users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Documents Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

The Rockbox Manual for Iaudio X5

rockbox.org May 12, 2011

Rockbox
http://www.rockbox.org/ Open Source Jukebox Firmware
Rockbox and this manual is the collaborative eort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2010 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 Jos Maria Garcia-Valdecasas Bernal & Peter Schlenker.
A Version r29859-110512. Built using pdfL TEX.
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 Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License.

The Rockbox manual

Iaudio X5

Contents

1. Introduction 1.1. Welcome. 1.2. Getting more help. 1.3. Naming conventions and marks. 2. Installation 2.1. Before Starting. 2.2. Installing Rockbox. 2.2.1. Automated Installation. 2.2.2. Manual Installation. 2.2.3. Finishing the install. 2.2.4. Enabling Speech Support (optional) 2.3. Running Rockbox. 2.4. Updating Rockbox. 2.5. Uninstalling Rockbox. 2.5.1. Automatic Uninstallation. 2.5.2. Manual Uninstallation. 2.6. Troubleshooting. 3. Quick Start 3.1. Basic Overview. 3.1.1. The players controls. 3.1.2. Turning the player on and o 3.1.3. Putting music on your player 3.1.4. The rst contact. 3.1.5. Basic controls. 3.1.6. Basic concepts. 3.2. Customising Rockbox. 4. Browsing and playing 4.1. File Browser. 4.1.1. File Browser Controls. 4.1.2. Context Menu. 4.1.3. Virtual Keyboard. 4.2. Database. 4.2.1. Introduction. 4.2.2. Initializing the Database 26 26
Contents 4.2.3. The Database Menu. 4.2.4. Using the Database. 4.3. While Playing Screen. 4.3.1. WPS Key Controls. 4.3.2. Peak Meter. 4.3.3. The WPS Context Menu 4.4. Working with Playlists. 4.4.1. Playlist terminology. 4.4.2. Creating playlists. 4.4.3. Adding music to playlists 4.4.4. Modifying playlists. 4.4.5. Saving playlists. 4.4.6. Loading saved playlists. 4.4.7. Helpful Hints. 5. The 5.1. 5.2. 5.3. 5.4. 5.5. 5.6. 5.7. Main Menu Introducing the Main Menu. Navigating the Main Menu. Recent Bookmarks. Files. Database. Now Playing/Resume Playback Settings. 5.7.1. Sound Settings. 5.7.2. Playback Settings. 5.7.3. General Settings. 5.7.4. Theme Settings. 5.7.5. Recording Settings. 5.7.6. Manage Settings. 5.8. Recording. 5.8.1. While Recording Screen 5.9. FM Radio. 5.10. Playlists. 5.11. Plugins. 5.12. System. 5.13. Quick Screen..
6. Sound Settings 6.1. Volume. 6.2. Bass. 6.3. Treble. 6.4. Balance. 6.5. Channels. 6.6. Stereo Width
Contents 6.7. Crossfeed. 6.8. Equalizer. 6.9. Dithering. 6.10. Timestretch 6.11. Compressor..
7. Playback Settings 7.1. Shue. 7.2. Repeat. 7.3. Play Selected First. 7.4. Fast-Forward/Rewind. 7.5. Anti-Skip Buer. 7.6. Fade on Stop/Pause. 7.7. Party Mode. 7.8. Crossfade. 7.9. Replaygain. 7.10. Track Skip Beep. 7.11. Auto-Change Directory 7.12. Last.fm Log. 7.13. Cuesheet Support. 7.14. Skip Length. 7.15. Prevent Track Skipping 7.16. Rewind Before Resume.
8. General Settings 8.1. Playlist. 8.2. File View. 8.3. Database. 8.4. Display. 8.5. System. 8.5.1. Start Screen. 8.5.2. Battery. 8.5.3. Disk. 8.5.4. Idle Powero. 8.5.5. Limits. 8.5.6. Car Adapter Mode 8.6. Bookmarking. 8.7. Automatic resume. 8.8. Language. 8.9. Voice. 9. Theme Settings
Contents 10.Recording Settings 10.1. Format. 10.2. Encoder Settings. 10.3. Frequency. 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.10. lipping Light. C 10.11. rigger. T 11.Plugins 11.1. Games. 11.1.1. Blackjack. 11.1.2. BrickMania. 11.1.3. Bubbles. 11.1.4. Chessbox. 11.1.5. Clix. 11.1.6. Chopper. 11.1.7. Codebuster. 11.1.8. Dice. 11.1.9. Doom. 11.1.10.Flipit. 11.1.11.Goban. 11.1.12.Invadrox. 11.1.13.Jackpot. 11.1.14.Jewels. 11.1.15.MazezaM. 11.1.16.Minesweeper. 11.1.17.Pacbox. 11.1.18.Pegbox. 11.1.19.Pong. 11.1.20.Reversi. 11.1.21.Robotndskitten 11.1.22.Rockblox. 11.1.23.Rockblox1d. 11.1.24.Rocklife. 11.1.25.Sliding Puzzle. 11.1.26.Snake. 11.1.27.Snake 2. 11.1.28.Sokoban. 11.1.29.Solitaire.

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

USB connection. To transfer Rockbox to your player you need to connect it to your computer. For manual installation/uninstallation, or should autodetection fail during automatic installation, you need to know where to access the player. On Windows this means you need to know the drive letter associated with the player. On Linux you need to know the mount point of your player. On Mac OS X you need to know the volume name of your player. When instructed to connect/disconnect the USB cable, always use the USB port through the subpack, not the side USB Host port. The side port is intended to be used for USB OTG connections only (digital cameras, memory sticks, etc.).

2.2. Installing Rockbox

There are two ways to install Rockbox: automated and manual. The automated way is the preferred method of installing Rockbox for the majority of people. Rockbox Utility is a graphical application that does almost everything for you. However, should you encounter a problem, then the manual way is still available to you. There are two separate components which need to be installed in order to run Rockbox: The Rockbox bootloader. The bootloader is the program that tells your player how to load and start other components of Rockbox and for providing the dual boot function. This is the component of Rockbox that is installed to the ash memory of your Iaudio. Note: Dual boot does not currently work on the X5. The Rockbox rmware. Unlike the Iaudio rmware, which runs entirely from ash memory, most of the Rockbox code is contained in a build that resides on your players drive. This makes it easy to update Rockbox. The build consists of a directory called.rockbox which contains all of the Rockbox les, and is located in the root of your players drive.
Apart from the required parts there are some addons you might be interested in installing. Fonts. Rockbox can load custom fonts. The fonts are distributed as a separate package and thus need to be installed separately. They are not required to run Rockbox itself but a lot of themes require the fonts package to be installed. Themes. The appearance of Rockbox can be customised by themes. Depending on your taste you might want to install additional themes to change the look of Rockbox.
2.2.1. Automated Installation
To automatically install Rockbox, download the ocial installer and housekeeping tool Rockbox Utility. It allows you to: Automatically install all needed components for using Rockbox (Minimal Installation). Automatically install all suggested components (Complete Installation). Selectively install optional components. Install additional fonts and themes. Install voice les and generate talk clips. Uninstall all components you installed using Rockbox Utility. Prebuilt binaries for Windows, Linux and Mac OS X are available at the ZRockboxUtility wiki page. When rst starting Rockbox Utility run Autodetect, found in the conguration dialog (File Congure). 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 lesystem. On Windows, this is the drive letter the player gets assigned, on other systems this is a path in the lesystem.

Choosing a Rockbox version There are three dierent versions of Rockbox available from the Rockbox website: Release version, current build and archived daily build. You need to decide which one you want to install and get the appropriate version for your player. If you select either Minimal Installation or Complete Installation from the Quick Start tab, then Rockbox Utility will automatically install the release version of Rockbox. Using the Installation tab will allow you to select which version you wish to install.
Release. The release version is the latest stable release, free of known critical bugs. For a manual install, the current stable release of Rockbox is available at http: //www.rockbox.org/download/. Current Build. The current build is built at each source code change to the Rockbox SVN repository and represents the current state of Rockbox development. This means that the build could contain bugs but most of the time is safe to use. For a manual install, you can download the current build from http://build.rockbox.org/. Archived Build. In addition to the release version and the current build, there is also an archive of daily builds available for download. These are built once a day from the latest source code in the SVN repository. For a manual install, you can download archived builds from http://www.rockbox.org/daily.shtml. Note: Because current and archived builds are development versions that change frequently, they may behave dierently than described in this manual, or they may introduce new (and potentially annoying) bugs. Unless you wish to try the latest and greatest features at the price of possibly greater instability, or you wish to help with development, you should stick with the release. Please now go to section 2.2.3 (page 16) to complete the installation procedure.
2.2.2. Manual Installation
The manual installation method is still available to you, should you need or desire it by following the instructions below. If you have used Rockbox Utility to install Rockbox, then you do not need to follow the next section and can skip straight to section 2.2.3 (page 16) Installing the rmware 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 le that you downloaded and use the Extract all command of your unzip program to extract the les onto your player. Note: The entire contents of the.zip le should be extracted directly to the root of your players drive. Do not try to create a separate directory on your player for the Rockbox les! The.zip le already contains the internal structure that Rockbox needs. If the contents of the.zip le are extracted correctly, you will have a directory called.rockbox, which contains all the les needed by Rockbox, in the main directory of your players drive.

2.6. Troubleshooting

File Not Found If you receive a File Not Found from the bootloader, then the bootloader cannot nd the Rockbox rmware. This is usually a result of not extracting the contents of the.zip le to the proper location, and should not happen when Rockbox has been installed with Rockbox Utility. To x 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 les need to be located.

Chapter 3. Quick Start

3. Quick Start

3.1. Basic Overview

3.1.1. The players controls
Throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prexed 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. The player is curved so that the end with the screen on it is thicker than the other end. Hold the player wih the thick end towards the top and the screen facing towards you. Half way up the front of the unit on the right hand side is a four way joystick which is the Up, Down, Left, and Right buttons. When pressed it serves as Select. On the right hand side of the player from top to bottom, rst there is a two way switch. the Power button is activated by pushing this switch up, and pushing this switch down until it clicks slightly will activate the Hold button. When the switch is in this position, none of the other keys will have an eect. Below the switch is a lozenge shaped button which is the Rec button, and below that the nal button on this side of the unit, the Play button. Just below this is a small
hole which is dicult to locate by touch which is the internal microphone. At the very bottom of this side of the unit is the reset hole, which can be used to perform a hard reset by inserting a paper clip. On the bottom of the unit is the connector for the Iaudio subpack or dock. On the top of the unit is a charge indicator light, which may feel a bit like a button, but is not. From the top of the player on the left hand side is the headphone socket, then the remote connector. Below this is a cover which protects the USB host connector.
3.1.2. Turning the player on and o
To turn on and o your Rockbox enabled player use the following keys: Key Power Long Power Remote Key Play Long Play Action Start Rockbox Shutdown Rockbox

Long Rewind Forward Long Forward Play Long Play Mode Long Mode Menu Long Menu Short Forward + Long Forward Short Rewind + Long Rewind
Skip to the previous directory.

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 41).
Chapter 4. Browsing and playing 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. The clip indicator: This is a little black block that is displayed at the very right of the scale when an overow occurs. It usually does not show up during normal playback unless you play an audio le 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. The scale: Between the indicators of the right and left channel there are little dots. These dots represent important volume values. In linear mode each dot is a 10% mark. In dBFS mode the dots represent the following values (from right to left): 0 dB, -3 dB, -6 dB, -9 dB, -12 dB, -18 dB, -24 dB, -30 dB, -40 dB, -50 dB, -60 dB.
4.3.3. The WPS Context Menu
Like the context menu for the File Browser, the WPS Context Menu allows you quick access to some often used functions. Playlist The Playlist submenu allows you to view, save, search and reshue the current playlist. To change settings for the Playlist Viewer press Long Select while viewing the current playlist to bring up the Playlist Viewer Menu. In this menu, you can nd the Playlist Viewer Settings. Playlist Viewer Settings Show Icons. This toggles display of the icon for the currently selected playlist entry and the icon for moving a playlist entry Show Indicies. This toggles display of the line numbering for the playlist Track Display. This toggles between lename only and full path for playlist entries Save Current Playlist. Allows the current playlist to be saved as a.m3u8 playlist le 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 le to a playlist. Select the playlist you want the le 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 rst. Sound Settings This is a shortcut to the Sound Settings Menu, where you can congure volume, bass, treble, and other settings aecting the sound of your music. See section 6 (page 46) for more information. Playback Settings This is a shortcut to the Playback Settings Menu, where you can congure shue, repeat, party mode, skip length and other settings aecting the playback of your music. Rating The menu entry is only shown if Gather Runtime Information is enabled. It allows the asignment of a personal rating value (0 10) to a track which can be displayed in the WPS and used in the Database browser. The value wraps at 10. Bookmarks This allows you to create a bookmark in the currently-playing track. Show Track Info

7.9. Replaygain

This allows you to control the replaygain function. The purpose of replaygain is to adjust the volume of the music played so that all songs (or albums, depending on your settings) have the same apparent volume. This prevents sudden changes in volume when changing between songs recorded at dierent 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. Maintain a constant volume level between albums, but keep any intentional volume variations between songs in an album. (If album gain value is not available, uses track gain information). Track Gain. Maintain a constant volume level between tracks. If track gain value is not available, no replaygain is applied. Track Gain If Shuing. Maintains a constant volume between tracks if Shuffle is set to Yes. Reverts to album mode if Shuffle is set to No. O. Do not process replaygain information, i.e. turn o the replaygain function. Prevent Clipping. Avoid clipping of a songs waveform. If a song would clip during playback, the volume is lowered for that song. Replaygain information is needed for this to work.
Pre-amp. This allows you to adjust the volume when replaygain is applied. Replaygain often lowers the volume, sometimes quite much, so here you can compensate for that. Please note that a (large) positive pre-amp setting can cause clipping, unless prevent clipping is enabled. The pre-amp can be set to any decibel (dB) value between -12 dB and +12 dB, in increments of 0.5 dB.

7.10. Track Skip Beep

Controls the volume of the beep that is heard when skipping forward or backward between tracks. The beep is disabled when set to Off.
7.11. Auto-Change Directory
Control what Rockbox does when it reaches the end of a directory. If Auto-Change Directory is set to Yes, Rockbox will continue to the next directory. If Auto-Change Directory is set to No, playback will stop at the end of the current playlist. Using the Random feature requires you to rst generate a folder list via the Random Folder Advance Conguration plugin (see section 11.4.14 (page 147)). Note: You must have the Repeat option set to No for Auto-Change Directory to function properly. Note: This feature only works when songs have been played from the le browser. Using it with the database may cause unexpected behaviour.

Right Set the text alignment to the right. (Useful for displaying right-to-left languages, such as Arabic or Hebrew) Left Set the text alignment to the left. Show Header Select whether to show the header. The header displays the le path. No Do not display the header. Yes Display the header. Show Footer Select whether to show the footer. The footer dispays the page number. No Do not display the footer. Yes Display the footer. Font Select the font to be used by the Text Viewer. 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 72)), 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. If the le ts on one screen, there is no scrollbar and this setting has no eect. No Do not display the horizontal scroll bar. Yes Display the horizontal scroll bar. Scroll Mode Change the function of the Left and Right buttons. Scroll by Screen Move to the previous/next screen. Scroll by Column Move to the previous/next column. Vertical Submenu for vertical scrolling settings. Scrollbar Toggle the vertical scrollbar for the current mode. If the le ts on one screen, there is no scrollbar and this setting has no eect. No Do not display the vertical scroll bar. Yes Display the vertical scroll bar. Scroll Mode Change the function of the Scroll-up and Scroll-down buttons. Scroll by Page Scroll up or down one full screen. Scroll by Line Scroll up or down one line.
Overlap Pages Set whether the last line from the previous screen is retained when scrolling pages. No Do not retain previous line. Yes Retain previous line. Auto-scroll Speed Control the speed of auto-scrolling in number of lines per second. Available options are 1 to 10 lines per second. As an example, 4 will scroll the text at four lines per second. Left/Right Key (Narrow mode) Change the function of the Left and Right buttons when the screen is in narrow mode (i.e. one screen per page). Previous/Next Page Scroll up or down one full screen. Top/Bottom Page Move to the top or bottom page. Indent Spaces Set the number of spaces to indent the text when line mode is set to Reflow Lines. Available options are 0 to 5 spaces. If you select 0, a blank line is displayed as an indent. Show Playback Menu Display the playback menu to allow control of the currently playing music without leaving the plugin. Select Bookmark Select a saved bookmark. In the screenshot below, the * denotes the current page.
Figure 11.45.: The select bookmark menu
Global Settings Set the default settings for the text viewer. The setting items are the same as Viewer Options. The global settings are stored in.rockbox/rocks/viewers/viewer.dat. Quit Exits the plugin. The text viewer automatically stores its settings, the current position and bookmarks in.rockbox/rocks/viewers/viewer_file.dat. Bookmarks To add a bookmark, press Rec. The bookmark will be displayed as shown below. To delete the bookmark press the same button again.

11.4.3. Calculator

Figure 11.48.: Calculator
This is a simple scientic 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 Left / Right / Up / Down Select Rec Play Power Remote Key Action Move around the keypad Select a button Delete last entered digit or clear after calculation Calculate Quit

11.4.4. Calendar

Figure 11.49.: Calendar
This is a small and simple calendar application with memo saving function. Dots indicate dates with memos. The available memo types are: one o, yearly, monthly, and weekly memos.
You can select what day is rst day of week by the setting First Day of Week in the menu. Key Left / Right / Up / Down Select Rec / Play Power Remote Key Action Move the selector Show memos for the selected day Previous / Next month Quit

11.4.5. Chess Clock

Figure 11.50.: Chess Clock
The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players. Setup Key Right / Left Select Rec Remote Key Action Increase / decrease displayed Value Move to next screen Move to previous screen
First enter the number of players (110) Then set the total game time in mm:ss Then the maximum round time is entered. For example, this could be used to play Scrabble for a maximum of 15 minutes each, with each round taking no longer than one minute.
Chapter 11. Plugins 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 dierent). Keys are as follows:
Key Rec Power Play Right Left Select
Action Exit plugin Restart round for the current player Pause the time (press again to continue) Switch to next player Switch to previous player Open menu (press again to select.)
From the menu it is possible to delete a player, modify the round time for the current player or set the total time for the game. When the round time is up for a player the message ROUND UP! is shown (press NEXT to continue). When the total time is up for a player the message TIME UP!is shown. The player will then be removed from the timer.

11.4.6. Clock

Figure 11.51.: Clock
This is a fully featured analogue and digital clock plugin.

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 specic time or to adjust the time, press Long Select to bring up a screen to adjust the time. Changes will be saved automatically when the song is changed. Edting words in lyrics is not supported.

11.4.11. md5sum

Open a le, a directory or just launch it from the plugin menu to create an md5sum of the le, the directorys contents or the whole lesystem. If the les extension is.md5 or.md5sum, it will check the md5 sums in the le instead. If the les extension is.md5list it will compute md5 sums for all the les listed.

11.4.12. Metronome

This plugin can be used as a metronome to keep time during music practice. Adjust the tempo through the interface or by tapping it out on the appropriate button.
Key Power Rec Long Select Select Left / Right Up / Down
Remote Key Rec Rec Mode Volume Down / Volume Up Forward / Rewind
Action Exit plugin Stop Start Tap tempo Adjust tempo Adjust volume

11.4.13. 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.
Chapter 11. Plugins Key Rec Power Remote Key Rec Action Open menu Exit
11.4.14. Random Folder Advance Conguration
This plugin is used to congure the folders which will be considered when the AutoChange Directory feature is set to Random. Menu Generate Folder List Generates a list of all folders found on the player. You can lter the directories which are scanned by creating a le called /.rockbox/folder_advance_dir.txt. Only the directories in this le and any contained directories will be scanned. You can have up to 10 directories ignored by the scan by placing a minus sign before them in the list (i.e. -/CDs will cause everything in the /CDs directory to be ignored.). If you just want /CDs to be 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 Textle Exports the list to /.rockbox/folder_advance_list.txt Import List From Textle Imports the list from /.rockbox/folder_advance_list.txt Play Shued Starts playback with the selected directories in random order. Tracks within a directory will be played in normal order. The plugin will exit after starting playback. Quit Folder List Editor Keys Key Select, Right or Play Long Select Remote Key Forward Long Mode Action Delete selected folder Bring up the context menu which allows you to remove the selected folder or its entire folder tree Exit

12.1.6. UI Viewport

By default, the UI is drawn on the whole screen. This can be changed so that the UI is conned to a specic area of the screen, by use of a UI viewport. This is done by adding the following line to the.cfg le for a theme: ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]
The dimensions of the menu that is displayed on the remote control of your player can be set in the same way. The line to be added to the theme.cfg is the following: remote ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]
Only the rst two parameters have to be specied, the others can be omitted using - as a placeholder. The syntax is very similar to WPS viewports (see section 12.2.2 (page 158)). Briey: fgcolour and bgcolour are 6-digit RGB888 colours, e.g. FF00FF. font is a number: 0 is the built-in system font, 1 is the user-selected font.
Example ui viewport: 15,20,100,150,-,-,-
This displays the menu starting at 15px from the left of the screen and 20px from the top of the screen. It is 100px wide and 150px high. The font and the foreground/background colours are dened in the theme.cfg le or in the Theme Settings menu.
12.2. Conguring the Theme
12.2.1. Themeing General Info
There are various dierent aspects of the Rockbox interface that can be themed the WPS or While Playing Screen, the FMS or FM Screen (if the player has a tuner), and the SBS or Base Skin. The WPS is the name used to describe the information displayed on the players screen whilst an audio track is being played, the FMS is the screen shown while listening to the radio, and the SBS lets you specify a base skin that is shown in the menus and browsers, as well as the WPS and FMS. The SBS also allows you to control certain aspects of the appearance of the menus/browsers. There are a number of themes included in Rockbox, and you can load one of these at any time by selecting it in Settings Theme Settings Browse Theme Files. It is also possible to set individual items of a theme from within the Settings Theme Settings menu.
12.2.2. Themes Create Your Own
The theme les are simple text les, and can be created (or edited) in your favourite text editor. To make sure non-English characters display correctly in your theme you must save the theme les with UTF-8 character encoding. This can be done in most editors, for example Notepad in Windows 2000 or XP (but not in 9x/ME) can do this. Files Locations: Each dierent themeable aspect requires its own le WPS les have the extension.wps, FM screen les have the extension.fms, and SBS les have the extension.sbs. The main theme le has the extension.cfg. All les should have the same name. The theme.cfg le should be placed in the /.rockbox/themes directory, while the.wps,.fms and.sbs les should be placed in the /.rockbox/wps directory. Any images used by the theme should be placed in a subdirectory of /.rockbox/wps with the same name as the theme, e.g. if the theme les are named mytheme.wps, mytheme.sbs etc., then the images should be placed in /.rockbox/wps/mytheme. All full list of the available tags are given in appendix section B (page 172); some of the more powerful concepts in theme design are discussed below. All characters not preceded by % are displayed as typed. Lines beginning with # are comments and will be ignored.

Tag %Vp(start,code to render) Description Display the playlist viewer in the current viewport.
start is the oset 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 supporte (including conditionals and sublines) The entire viewport will be used, so dont expect other tags in the same viewport to work well. Supported tags are %pp, all tags starting with %i, most tags starting with %f, %pt and %s. Example: %Vp(1,%pp - %it,%pp - %fn) Display the playlist position, then either the track title (from the tags) or the lename. The viewer will display as many tracks as will t in the viewport.

B.10. Runtime Database

Tag %rp %rr %ra Description Song playcount Song rating (0-10). This tag can also be used in a conditional tag: %?rr<0|1|2|3|4|5|6|7|8|9|10> Autoscore for the song
B.11. Sound (DSP) settings
Tag %Sp %xf %rg Description Current playback pitch Crossfade setting, in the order: O, Auto Skip, Man Skip, Shue, Shue and Man Skip, Always ReplayGain value in use (x.y dB). If used as a conditional, Replaygain type in use: %?rg<Off|Track|Album|TrackShuffle|AlbumShuffle|No tag>

B.12. Hold

Tag %mh %mr Description h if the main unit keys are locked r if the remote keys are locked

B.13. Virtual LED

Tag %lh Description h if the hard disk is accessed

B.14. Repeat Mode

Tag %mm Description Repeat mode, 0-4, in the order: O, All, One, Shue, A-B
Example: %?mm<Off|All|One|Shuffle|A-B>

B.15. Playback Mode

Tag %mp Description Play status, 0-4, in the order: Stop, Play, Pause, Fast Forward, Rewind, Recording, Recording paused, FM Radio playing, FM Radio muted
Example: %?mp<Stop|Play|Pause|Ffwd|Rew|Rec|Rec pause|FM|FM pause>

B.16. Current Screen

Tag %cs Description The current screen, 1-5, in the order: Menus, WPS, Recording screen, FM Radio screen, Current Playlist screen

1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The Document, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as you. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A Modied Version of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modications and/or translated into another language. A Secondary Section is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Documents overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The Invariant Sections are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not t the above denition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The Cover Texts are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A Transparent copy of the Document means a machine-readable copy, represented in a format whose specication is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent le format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modication by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not Transparent is called Opaque. Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modication. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The Title Page means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, Title Page means the text near the most prominent appearance of the works title, preceding the beginning of the body of the text. A section Entitled XYZ means a named subunit of the Document whose title ei-

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the with.Texts. line with this:
with the Invariant Sections being LIST THEIR TITLES, with the FrontCover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
G.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.
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free softwareto make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundations software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) oer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each authors protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modied by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reect on the original authors reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in eect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyones free use or not licensed at all. The precise terms and conditions for copying, distribution and modication follow.