Iaudio M5 Manual - page 76

Manual is about: Rockbox firmware manual

Summary of M5

  • Page 1

    The rockbox manual for iaudio m5 rockbox.Org april 30, 2017.

  • Page 2: Rockbox

    2 rockbox http://www.Rockbox.Org/ open source jukebox firmware rockbox and this manual is the collaborative effort of the rockbox team and its contributors. See the appendix for a complete list of contributors. C 2003-2013 the rockbox team and its contributors, c 2004 christi alice scarborough, c 20...

  • Page 3: Contents

    Contents 3 contents 1. Introduction 11 1.1. Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 1.2. Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 1.3. Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 1...

  • Page 4

    Contents 4 4.2.3. The database menu . . . . . . . . . . . . . . . . . . . . . . . . . . 27 4.2.4. Using the database . . . . . . . . . . . . . . . . . . . . . . . . . . 28 4.3. While playing screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 4.3.1. Wps key controls . . . . . . . ....

  • Page 5

    Contents 5 6.8. Crossfeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 6.9. Equalizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 6.10. Dithering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 6.11. Timestretch ...

  • Page 6

    Contents 6 8.6.2. Idle poweroff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 8.6.3. Sleep timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 8.7. Bookmarking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 8.8. Automatic resume . . . . . ....

  • Page 7

    Contents 7 12.1.19.Pegbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 12.1.20.Pong . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 12.1.21.Puzzles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 12.1.22.Reversi . . . . . . . ....

  • Page 8

    Contents 8 12.3.7. Mpeg player . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 12.3.8. Mp3 encoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 12.3.9. Rockboy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 12.3.10.Search . . . . . . . . . . ...

  • Page 9

    Contents 9 13.2. Configuring the theme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 13.2.1. Themeing – general info . . . . . . . . . . . . . . . . . . . . . . . 167 13.2.2. Themes – create your own . . . . . . . . . . . . . . . . . . . . . . 167 13.2.3. Info viewport (sbs only) . ....

  • Page 10

    Contents 10 d.7. Power related information . . . . . . . . . . . . . . . . . . . . . . . . . . 188 d.8. Information about the file . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 d.9. Playlist/song info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 d.10.Playlist viewer ...

  • Page 11: 1. Introduction

    Chapter 1. Introduction 11 1. Introduction 1.1. Welcome this is the manual for rockbox. Rockbox is an open source firmware replacement for a growing number of digital audio players. Rockbox aims to be considerably more functional and efficient than your device’s stock firmware while remaining easy t...

  • Page 12

    Chapter 1. Introduction 12 main channel for rockbox is #rockbox on irc://irc.Freenode.Net . Many helpful developers and users are usually around. Just join and ask your question (don’t ask to ask!) – if someone knows the answer you’ll usually get an answer pretty quickly. More information including ...

  • Page 13: 2. Installation

    Chapter 2. Installation 13 2. Installation installing rockbox is generally a quick and easy procedure. However before beginning there are a few important things to know. 2.1. Before starting usb connection. To transfer rockbox to your player you need to connect it to your computer. For manual instal...

  • Page 14

    Chapter 2. Installation 14 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 ...

  • Page 15

    Chapter 2. Installation 15 development build. The development build is built at each change to the rockbox source code repository and represents the current state of rockbox development. This means that the build could contain bugs but most of the time is safe to use. For a manual install, you can d...

  • Page 16: 2.3. Running Rockbox

    Chapter 2. Installation 16 installing the bootloader the iaudio m5 has a built-in bootloader which performs the firmware update and can also access the hard drive via usb. The rockbox bootloader can therefore be very minimalistic, as it does not require its own usb mode. This makes it less dangerous...

  • Page 17: 2.5. Uninstalling Rockbox

    Chapter 2. Installation 17 directory of your player as in the manual installation stage. If your unzip program asks you whether to overwrite files, choose the “yes to all” option. The new build will be installed over your current build. The bootloader only changes rarely, and should not normally nee...

  • Page 18: 3. Quick Start

    Chapter 3. Quick start 18 3. Quick start 3.1. Basic overview 3.1.1. The player’s controls throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prefixed by “long”, a long press of approx- imately one second should be performed on tha...

  • Page 19

    Chapter 3. Quick start 19 detail in the following paragraph. Additional information for blind users is available on ¸ the rockbox website at z blindfaq . 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 th...

  • Page 20

    Chapter 3. Quick start 20 directory structure that is assumed by some parts of rockbox (album art searching, and missing-tag fallback in some wpses) uses the parent directory of a song as the album name, and the parent directory of that folder as the artist name. Wpses may display information incorr...

  • Page 21: 3.2. Customising Rockbox

    Chapter 3. Quick start 21 menu from the menu you can customise rockbox. Rockbox itself is very customisable. Also there are some special menus for quick access to frequently used functions. Context menu some views, especially the file browser and the wps have a context menu. From the file browser th...

  • Page 22: 4. Browsing And Playing

    Chapter 4. Browsing and playing 22 4. Browsing and playing 4.1. File browser figure 4.1.: the file browser rockbox lets you browse your music in either of two ways. The file browser lets you navigate through the files and directories on your player, entering directories and executing the default act...

  • Page 23

    Chapter 4. Browsing and playing 23 4.1.1. File browser controls key remote key action up/down volume up/volume down go to previous/next item in list. If you are on the first/last entry, the cursor will wrap to the last/first entry. Left rewind go to the parent directory. Select or right play or forw...

  • Page 24

    Chapter 4. Browsing and playing 24 playlist. Enters the playlist submenu (see section 4.4.3 (page 36 )). Playlist catalogue. Enters the playlist catalogue submenu (see section 4.4.2 (page 35 )). Rename. This function lets the user modify the name of a file or directory. Cut. Copies the name of the c...

  • Page 25

    Chapter 4. Browsing and playing 25 add to shortcuts. Adds a link to the selected item in the shortcuts.Link file. If the file does not already exist it will be created in the root directory. Note that if you create a shortcut to a file, rockbox will not open it upon selecting, but simply bring you t...

  • Page 26: 4.2. Database

    Chapter 4. Browsing and playing 26 key remote key action left / right rewind / forward move the cursor on the virtual keyboard. If you move out of the picker area, you get the previous/next page of characters (if there is more than one). Up / down volume up / volume down move the cursor on the virtu...

  • Page 27

    Chapter 4. Browsing and playing 27 that directory and all its subdirectories from scanning their tags and adding them to the database. This will speed up the database initialization. If a subdirectory of an ‘ignored’ directory should still be scanned, place a file named database.Unignore in it. The ...

  • Page 28

    Chapter 4. Browsing and playing 28 import modifications. Allows the /.Rockbox/database_changelog.Txt backup to be conveniently loaded into the database. If auto update is enabled this is per- formed automatically when the database is initialized. 4.2.4. Using the database once the database has been ...

  • Page 29: 4.3. While Playing Screen

    Chapter 4. Browsing and playing 29 tag type origin filename string system album string id tag albumartist string id tag artist string id tag comment string id tag composer string id tag genre string id tag grouping string id tag title string id tag bitrate numeric id tag discnum numeric id tag year ...

  • Page 30

    Chapter 4. Browsing and playing 30 • the id3 album name. • the id3 artist name. • bit rate. Vbr files display average bitrate and “(avg)” • elapsed and total time. • a slidebar progress meter representing where in the song you are. • peak meter. See section 13.2 (page 167 ) for details of customisin...

  • Page 31

    Chapter 4. Browsing and playing 31 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 b...

  • Page 32

    Chapter 4. Browsing and playing 32 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. Sound settings this is a shortcut to the sound settings menu, where you can configure volume, bass, treb...

  • Page 33

    Chapter 4. Browsing and playing 33 open with... This open with function is the same as the open with function in the file browser’s context menu. Delete delete the currently playing file. The file will be deleted but the playback of the file will not stop immediately. Instead, the part of the file t...

  • Page 34

    Chapter 4. Browsing and playing 34 key remote key action select mode toggle pitch changing mode (cycle through all available modes). Up / down volume up / volume down increase / decrease pitch by 0.1% (in procentual mode) or 0.1 semitone (in semitone mode). Long up / long down long volume up / long ...

  • Page 35

    Chapter 4. Browsing and playing 35 by selecting (“playing”) a song from the file browser whenever a song is selected from the file browser with select or right, rockbox will automatically create a playlist containing all of the songs in that directory and start playback with the selected song. Note:...

  • Page 36

    Chapter 4. Browsing and playing 36 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 23 )), it allows you to put tracks into a “dynamic playlist”. If there is no music c...

  • Page 37

    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...

  • Page 38

    Chapter 4. Browsing and playing 38 4.4.6. Loading saved playlists through the file browser playlist files, like regular music tracks, can be selected through the file browser. When loading a playlist from disk it will replace the current dynamic playlist. Through the playlist catalogue the playlist ...

  • Page 39: 5. The Main Menu

    Chapter 5. The main menu 39 5. The main menu 5.1. Introducing the main menu figure 5.1.: the main menu the main menu is the screen from which all of the rockbox functions can be accessed. This is the first screen you will see when starting rockbox. To return to the main menu, press the rec button. A...

  • Page 40: 5.3. Recent Bookmarks

    Chapter 5. The main menu 40 5.3. Recent bookmarks figure 5.2.: the list bookmarks screen if the save a list of recently created bookmarks option is enabled then you can view a list of several recent bookmarks here and select one to jump straight to that track. Note: bookmarking only works when track...

  • Page 41: 5.5. Database

    Chapter 5. The main menu 41 5.5. Database browse by the meta-data in your audio files (see section 4.2 (page 26 )). 5.6. Now playing/resume playback go to the while playing screen and resume if music playback is stopped or paused and there is something to resume (see section 4.3 (page 29 )). 5.7. Se...

  • Page 42: 5.8. Recording

    Chapter 5. The main menu 42 5.7.6. Manage settings the manage settings option allows the saving and re-loading of user configuration settings, browsing the hard drive for alternate firmwares, and finally resetting your player back to initial configuration. The details of this menu are covered in sec...

  • Page 43: 5.9. Playlists

    Chapter 5. The main menu 43 key remote key action up / down volume up / volume down select setting. Left / right rewind / right adjust selected setting. Play play start recording. While recording: pause recording (press again to continue). Long play long play exit recording screen. While recording: ...

  • Page 44: 5.11. System

    Chapter 5. The main menu 44 5.11. System rockbox info: displays some basic system information. This is, from top to bottom, the amount of memory rockbox has available for storing music (the buffer). The battery status. Hard disk size and the amount of free space on the disk. Credits: display the lis...

  • Page 45

    Chapter 5. The main menu 45 • a file can be “run” (i.E. A music file played, plugin started or a .Cfg loaded) • the file browser can be opened with the cursor positioned at a specified file or folder • a file’s or folder’s “current playlist” context menu item can be displayed • a setting can be conf...

  • Page 46

    Chapter 5. The main menu 46 time data needs to be either “talk” to talk the time, or “sleep x” where x is the number of minutes to run the sleep timer for (0 to disable). Name is required for this shortcut type. Shutdown data is ignored; name can be used to display text if the name/icon items are no...

  • Page 47: 6. Sound Settings

    Chapter 6. Sound settings 47 6. Sound settings figure 6.1.: the sound settings screen the sound settings menu offers a selection of sound settings you may change to customise your listening experience. 6.1. Volume this setting adjusts the volume of your music. Like most professional audio gear and m...

  • Page 48: 6.4. Treble

    Chapter 6. Sound settings 48 from the list and the maximum volume will be limited to the selected value all over the system. 6.4. Treble this setting emphasises or suppresses the higher (treble) frequencies in the sound. A value of 0 db means that treble sounds are unaltered (flat response). The min...

  • Page 49: 6.8. Crossfeed

    Chapter 6. Sound settings 49 of one channel into the other. This has the effect of gradually centering the stereo im- age, until you have monophonic sound at 0%. Values above 100% will progressively remove components in one channel that is also present in the other. This has the effect of widening t...

  • Page 50: 6.9. Equalizer

    Chapter 6. Sound settings 50 most users will find the default settings to yield satisfactory results, but for the more adventurous user the settings can be fine-tuned to provide a virtual speaker placement suited to ones preference. Beware that the crossfeed function is capable of making the audio d...

  • Page 51

    Chapter 6. Sound settings 51 in some ways the eq is similar to the bass and treble settings described earlier, but the eq allows you to control the sound much more carefully. Note that the parameteric eq bands will be applied in addition to any bass or treble tone controls. Note: a maximum of 10 eq ...

  • Page 52: 6.10. Dithering

    Chapter 6. Sound settings 52 key remote key action right forward raises the highlighted parameter. Left rewind lowers the highlighted parameter. Up volume up moves to the previous eq band. Down volume down moves to the next eq band. Select play toggles the cursor among the three pa- rameters (gain, ...

  • Page 53: 6.11. Timestretch

    Chapter 6. Sound settings 53 dithering adds low-level noise to the signal prior to throwing away the surplus bits, which gives the resulting signal a uniform noise floor which is independent of the sig- nal. Most people find this noise preferable to the time-varying noise heard when not performing d...

  • Page 54: 6.15. Compressor

    Chapter 6. Sound settings 54 6.14. Auditory fatigue reduction human hearing is more senstive to some frequency bands. This setting applies additional equalization and bi-shelf filtering to reduce signals in these bands to minimize the chance that temporary threshold shift (auditory fatigue) occurs. ...

  • Page 55: 7. Playback Settings

    Chapter 7. Playback settings 55 7. Playback settings the playback settings menu allows you to configure settings related to audio play- back. 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...

  • Page 56: 7.3. Play Selected First

    Chapter 7. Playback settings 56 7.3. Play selected first this setting controls what happens when you select a file for playback while shuffle mode is on. If the play selected first setting is yes, the file you selected will be played first. If this setting is no, a random file in the directory will ...

  • Page 57

    Chapter 7. Playback settings 57 the track, moving to the next track in the playlist without user intervention. A man- ual track skip goes to the next track immediately when the appropriate button is pressed. Options for crossfade settings are: enable crossfade. If set to off, crossfade is disabled a...

  • Page 58: 7.9. Replaygain

    Chapter 7. Playback settings 58 7.9. Replaygain this allows you to control the replaygain function. The purpose of replaygain is to adjust the volume of the music played so that all songs (or albums, depending on your settings) have the same apparent volume. This prevents sudden changes in volume wh...

  • Page 59: 7.10. Track Skip Beep

    Chapter 7. Playback settings 59 pre-amp. This allows you to adjust the volume when replaygain is applied. Replaygain often lowers the volume, sometimes quite much, so here you can compensate for that. Please note that a (large) positive pre-amp setting can cause clipping, unless prevent clipping is ...

  • Page 60: 7.14. Cuesheet Support

    Chapter 7. Playback settings 60 7.14. Cuesheet support enables reading of cuesheet files for played tracks. If a cuesheet is found for a track, track markers are displayed on the progressbar and it is possible to skip between the tracks within the cuesheet. Also the information found in the cuesheet...

  • Page 61: 7.18. Rewind On Pause

    Chapter 7. Playback settings 61 7.18. Rewind on pause this option rewinds the current track by a small amount whenever it is paused (not stopped). The amount to rewind can be set between 0 and 15 seconds. The rockbox manual (version 3.14) iaudio m5.

  • Page 62: 8. General Settings

    Chapter 8. General settings 62 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, al...

  • Page 63

    Chapter 8. General settings 63 interpret numbers when sorting. As whole numbers enables a sorting algorithm which is similar to the default sorting of, for example, windows explorer, mac os x’s finder or nautilus, with regards to numbers at the beginning or within filenames. It combines consecutive ...

  • Page 64: 8.3. Database

    Chapter 8. General settings 64 if follow playlist is set to no, when you enter the file browser from the wps, you will find yourself in the directory you were in when you last left the file browser. Show path. If this setting is set to full path the full path to the current directory will be display...

  • Page 65

    Chapter 8. General settings 65 enabled. Enables/disables the feature. Settings. Allows to select actions that will not activate backlight. Volume. Volume up/down. Play. Toggling play/pause. Seek. Seeking in a track. Skip. Skipping of a track. Disable unmapped keys. Buttons that have no action assign...

  • Page 66

    Chapter 8. General settings 66 contrast. Changes the contrast of your remote’s lcd display. Warning: setting the contrast too dark or too light can make it hard to find ! This menu option again! Lcd mode. This setting lets you invert the whole screen, so now you get a black background and light text...

  • Page 67

    Chapter 8. General settings 67 list acceleration speed. This setting controls how fast the scroll speed acceler- ates. The scroll speed will increase every n seconds. For example, selecting speed up every 3s will increase the scroll speed every 3 seconds while up or down is held. Peak meter. The pea...

  • Page 68: 8.5. System

    Chapter 8. General settings 68 8.5. System 8.5.1. Battery options relating to the battery in the player. Battery capacity. This setting can be used to tell rockbox what capacity (in mah) the battery being used has. The default is 950 mah, which is the capacity value for the standard battery shipped ...

  • Page 69

    Chapter 8. General settings 69 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 ve...

  • Page 70: 8.6. Startup/shutdown

    Chapter 8. General settings 70 8.5.7. Advanced key lock this option allows users to select actions that when within wps or fms will not be blocked by the key lock (software hold switch). Enabled. Enables/disables the feature. Settings. Allows to select actions that will not be blocked by the key loc...

  • Page 71

    Chapter 8. General settings 71 database. Show the default database view. Resume playback. Go to the wps and and resume playback from where it was before turning off (if there is a playlist to resume). Settings. Display the main settings menu. Recording. Start the player in the recording screen (reco...

  • Page 72: 8.7. Bookmarking

    Chapter 8. General settings 72 8.7. Bookmarking bookmarks allow you to save your current position within a track so that you can return to it at a later time. Bookmarks also store rate, pitch and speed information from the pitch screen (see section 4.3.3 (page 33 )). Bookmarks are saved on a per dir...

  • Page 73: 8.8. Automatic Resume

    Chapter 8. General settings 73 yes automatically return to the position of the last bookmark. Start from the beginning if there are no bookmarks. Ask ask if playback should start from the beginning of the track or from one of the bookmarks. Maintain a list of recent bookmarks. If this option is enab...

  • Page 74: 8.9. Language

    Chapter 8. General settings 74 resumed whether they are navigated to through the database browser or file 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 bookma...

  • Page 75

    Chapter 8. General settings 75 /.Rockbox/langs/ directory on the player. Voice files are large and are not shipped with rockbox by default. The voice file is the name of the language for which it is made, followed by the extension .Voice. So for english, the file name would be english.Voice. This op...

  • Page 76

    Chapter 8. General settings 76 use of a .Talk clip takes precedence over other filename voicing. Otherwise (e.G. If a .Talk clip is not available), voicing uses the method set under voice filenames above. Say file type. This option turns on voicing of file types when voice filenames is set to spell ...

  • Page 77: 9. Theme Settings

    Chapter 9. Theme settings 77 9. Theme settings the theme settings menu offers options that you can change to customize the visual appearance of rockbox. Browse theme files. This option will display all the currently installed themes on the player, press select or right to load the chosen theme and a...

  • Page 78

    Chapter 9. Theme settings 78 status/scrollbar. Settings related to on screen status display and the scrollbar. Scroll bar. Allows you to choose where the vertical scroll bar should appear. Scroll bar width. Allows you to choose the width of the scroll bar (in pixels). Default value is 6. Status bar....

  • Page 79: 10. Recording Settings

    Chapter 10. Recording settings 79 10. Recording settings figure 10.1.: the recording settings screen note: to change the location where recordings are stored open the context menu b (see section 4.1.2 (page 23 )) on the directory where you want to store them in the file browser and select set as rec...

  • Page 80: 10.4. Source

    Chapter 10. Recording settings 80 10.4. Source choose the source of the recording. The options are: microphone and line in. 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 ...

  • Page 81: 10.10. Clipping Light

    Chapter 10. Recording settings 81 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, rem...

  • Page 82

    Chapter 10. Recording settings 82 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 t...

  • Page 83: 11. Time And Date

    Chapter 11. Time and date 83 11. Time and date time related menu options. Pressing long select will voice the current time if voice support is enabled. Set time/date: set current time and date. Time format: choose 12 or 24 hour clock. The rockbox manual (version 3.14) iaudio m5.

  • Page 84: 12. Plugins

    Chapter 12. Plugins 84 12. Plugins plugins are programs that rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and rockbox. When a plugin is loaded, you need to exit ...

  • Page 85

    Chapter 12. Plugins 85 note: on players with a small screen tiles with a value greater than 1000 are shortened b to “1k”, “2k” and so forth (k is the abbreviation of kilo, which – in computer talk – means a multiple of 1024). Key remote key action up, down, left, right forward, rewind, volume down, ...

  • Page 86

    Chapter 12. Plugins 86 12.1.3. Boomshine this is a game coded in lua that’s a clone of http://www.Yvoschaap.Com/chainrxn/ . It is a rather basic game, but probably a good way to show off some of lua’s features in rockbox. 12.1.4. Brickmania figure 12.3.: brickmania brickmania is a clone of the class...

  • Page 87

    Chapter 12. Plugins 87 12.1.5. Bubbles figure 12.4.: bubbles the goal of the game is to beat each level as quickly as possible by clearing the board of all bubbles. Bubbles are removed from the board when a cluster of three of more of the same type is formed. The game is over when any bubbles on the...

  • Page 88

    Chapter 12. Plugins 88 it also works as a pgn file viewer. Instead of executing the game from the plugin menu, look for any file with .Pgn extension in the file browser and execute it. Chessbox will show the list of matches included in the file and allow you to select the one you want to watch. Afte...

  • Page 89

    Chapter 12. Plugins 89 key remote key action select / up make chopper fly power enter menu 12.1.8. Dice dice is a simple dice rolling simulator. Select number and type of dice to roll in a menu and start by choosing “roll dice”. The result is shown as individual numbers as well as the total of the r...

  • Page 90

    Chapter 12. Plugins 90 a free alternative for doom 2 is freedoom ( http://freedoom.Sourceforge.Net ). This can be used in place of doom2.Wad, or it may be used as an addon in doom, by placing it in the addons directory. Menus rockdoom menu. The rockdoom menu is shown when doom is first launched. Thi...

  • Page 91

    Chapter 12. Plugins 91 gamma. Change the brightness (gamma) of the game sound volume. Change the sound, music and system volume note: in game music is not currently supported b keys key remote key action up move forward down down left turn left right turn right select shoot play open power ingame me...

  • Page 92

    Chapter 12. Plugins 92 key remote key action up / down / left / right move the cursor select flip play+left shuffle play+right solve play+up solve step by step power quit the game 12.1.11. Goban figure 12.9.: goban goban is a a plugin for playing, viewing and recording games of go (also known as wei...

  • Page 93

    Chapter 12. Plugins 93 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 an...

  • Page 94

    Chapter 12. Plugins 94 game info. View and modify the metadata of the current game. Playback control. Control the playback of the current playlist and modify the volume of your player. Zoom level. Zoom in or out on the board. If you set the zoom level, it will be saved and used again the next time y...

  • Page 95

    Chapter 12. Plugins 95 round. If part of a tournament, the round number for this game. Done. Return to the previous menu. Options. Customize the behavior of the plugin in certain ways. Show child variations? Enable this to mark child variations on he board if there are more than one. Note: variation...

  • Page 96

    Chapter 12. Plugins 96 square mode. Add square marks to the board, or remove them. Triangle mode. Add triangle marks to the board, or remove them. Label mode. Add one character labels to the board. Each label starts at the letter ‘a’ and each subsequent application of a label will increment the lett...

  • Page 97

    Chapter 12. Plugins 97 12.1.13. Jackpot figure 12.11.: jackpot this is a jackpot slot machine game. At the beginning of the game you have 20$. Payouts are given when three matching symbols come up. Key remote key action select mode play rec rec exit the game 12.1.14. Jewels figure 12.12.: jewels jew...

  • Page 98

    Chapter 12. Plugins 98 key remote key action left/right/ up/down move the cursor around the jewels select select a jewel power menu 12.1.15. Maze this is a simple maze generator that creates perfect mazes that have only one solution. Key remote key action up/down/left/right forward, rewind, volume d...

  • Page 99

    Chapter 12. Plugins 99 key remote key action up, down, left, right forward, rewind, volume down, volume up move character rec rec menu 12.1.17. Minesweeper figure 12.14.: minesweeper plugin the classic game of minesweeper. The aim of the game is to uncover all of the squares on the board. If a mine ...

  • Page 100

    Chapter 12. Plugins 100 12.1.18. Pacbox figure 12.15.: pacbox pacbox is an emulator of the pacman arcade machine hardware. It is a port of pie – pacman instructional emulator by alessandro scotti. Roms to use the emulator to play pacman, you need a copy of roms for “midway pacman”. Filename md5 chec...

  • Page 101

    Chapter 12. Plugins 101 keys key remote key action right move up left move down up move left down move right rec insert coin select 1-player start power 2-player start play menu 12.1.19. Pegbox figure 12.16.: pegbox to beat each level, you must destroy all of the pegs. If two like pegs are pushed in...

  • Page 102

    Chapter 12. Plugins 102 12.1.20. Pong figure 12.17.: pong pong is a simple one or two player “tennis game”. Whenever a player misses the ball the other scores. The game starts in demo mode, with the cpu controlling both sides. As soon as a button to control one of the paddles is pressed, control of ...

  • Page 103

    Chapter 12. Plugins 103 “puzzles” is a port of simon tatham’s portable puzzle collection. For documenta- tion on the games included, please visit ( http://www.Chiark.Greenend.Org.Uk/~sgtatham/ puzzles/ ). 12.1.22. Reversi this is a simple implementation of the reversi game. The objective of the game...

  • Page 104

    Chapter 12. Plugins 104 12.1.24. Rockblox figure 12.21.: rockblox rockblox is a rockbox version of the classic falling blocks game from russia. The aim of the game is to make the falling blocks of different shapes form full rows. Whenever a row is completed, it will be cleared away, and you gain poi...

  • Page 105

    Chapter 12. Plugins 105 12.1.26. Sliding puzzle figure 12.22.: sliding puzzle the classic sliding puzzle game. Rearrange the pieces so that you can see the whole picture, or switch to number tiles if you like it a little easier includes one picture puzzle, but you can switch the puzzle picture to be...

  • Page 106

    Chapter 12. Plugins 106 this is the popular snake game. The aim is to grow your snake as large as possible by eating the dots that appear on the screen. The game will end when the snake touches either the borders of the screen or itself. Key remote key action up / down / left / right move snake play...

  • Page 107

    Chapter 12. Plugins 107 12.1.29. Sokoban figure 12.25.: sokoban the object of the game is to push boxes into their correct position in a crowded warehouse with a minimal number of pushes and moves. The boxes can only be pushed, never pulled, and only one can be pushed at a time. Sokoban may be used ...

  • Page 108

    Chapter 12. Plugins 108 12.1.30. Solitaire figure 12.26.: klondike solitaire this is the classic klondike solitaire game for rockbox. This is probably the best-known solitaire in the world. Many people do not even realize that other games exist. Though the name may not be familiar, the game itself c...

  • Page 109

    Chapter 12. Plugins 109 12.1.31. Spacerocks figure 12.27.: spacerocks spacerocks is a clone of the old arcade game asteroids. The goal of the game is to blow up the asteroids and avoid being hit by them. Once in a while, a ufo will appear – shoot this for extra points. Key remote key action select s...

  • Page 110

    Chapter 12. Plugins 110 rules: take all of the “o”s to go to the next level. You can switch control between the filled circle, which can take “o”s, and the filled square, which is used as a mobile wall to allow your filled circle to get to places on the screen it could not otherwise reach. The block...

  • Page 111

    Chapter 12. Plugins 111 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 scratchpa...

  • Page 112

    Chapter 12. Plugins 112 during the war phase you can attack the enemy. This is where the strengths come into play. Each tile has its own strength for both the computer, and the human player. If you attack a square owned by the computer player where your strength is greater than the computer’s, you w...

  • Page 113

    Chapter 12. Plugins 113 12.1.35. Wormlet figure 12.30.: 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 ...

  • Page 114

    Chapter 12. Plugins 114 help anyway: the other worm isn’t hurt by the bite. It will go on creeping happily and eat all the food you left on the table. Walls. Don’t crash into the walls. Walls are not edible. Crashing a worm against a wall causes it a headache it doesn’t survive. Game over. The game ...

  • Page 115

    Chapter 12. Plugins 115 hints • initially you will be busy with controlling your worm. Try to avoid other worms and crawl far away from them. Wait until they curl up themselves and collect the food afterwards. Don’t worry if the other worms grow longer than yours - you can catch up after they’ve die...

  • Page 116: 12.2. Demos

    Chapter 12. Plugins 116 12.1.37. Xworld in this cinematic, award winning platform game by Éric chahi, you must evade capture and do your best to escape an alien planet. After an experiment goes awry the hero must team up with an unlikely ally, when they both become fugitives on another world. Xworld...

  • Page 117

    Chapter 12. Plugins 117 key remote key action up/ down moves to next/previous option right / left increases/decreases option value select toggles scroll mode rec or power exits bounce demo available options are: xdist/ydist. The distance to x axis and y axis respectively xadd/yadd. How fast the code...

  • Page 118

    Chapter 12. Plugins 118 12.2.4. Demystify figure 12.34.: demystify demystify is a screen saver like demo. Key remote key action left / right volume down / volume up increase / decrease speed up / down forward / rewind add / remove polygon rec rec quit 12.2.5. Fft this plugin is a basic frequency ana...

  • Page 119

    Chapter 12. Plugins 119 key remote key action up / down forward / rewind increase / decrease number of flames left volume down toggle flame type right volume up toggle moving flames rec rec quit 12.2.7. Fractals figure 12.36.: fractals: mandelbrot set this demonstration draws fractal images from the...

  • Page 120

    Chapter 12. Plugins 120 key remote key action right / left increase / decrease speed on the x-axis up / down increase / decrease speed on the y-axis rec or power quit 12.2.9. Matrix this plugin is a visual demo resembling the scrolling code from “the matrix” ( https: //en.Wikipedia.Org/wiki/the_matr...

  • Page 121

    Chapter 12. Plugins 121 12.2.11. Oscilloscope figure 12.38.: 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 remote key action select toggle fille...

  • Page 122

    Chapter 12. Plugins 122 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....

  • Page 123

    Chapter 12. Plugins 123 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 s...

  • Page 124

    Chapter 12. Plugins 124 rockbox can open files with a configuration description (.Cells files). Just “play” such file and the game configuration stored in it will be loaded into this plugin. A .Cells file is a text file. A capital ‘o’ marks a live cell, a dot marks a dead cell, all other characters ...

  • Page 125: 12.3. Viewers

    Chapter 12. Plugins 125 starfield simulation (like the classic screensaver). Key remote key action right / left increase / decrease number of stars up / down increase / decrease speed rec or power quit 12.2.17. Vu meter figure 12.43.: vu-meter this is a vu meter, which displays the volume of the lef...

  • Page 126

    Chapter 12. Plugins 126 note: some viewer plugins can only be used by selecting the open with... Option b from the context menu (see section 4.1.2 (page 23 )). Viewer plugin associated filetype(s) context menu only shortcuts .Link chip-8 emulator .Ch8 frotz .Z1 - .Z8 image viewer .Bmp, .Jpg, .Jpeg, ...

  • Page 127

    Chapter 12. Plugins 127 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 loca...

  • Page 128

    Chapter 12. Plugins 128 chip8 off 0 1 2 3 4 5 6 7 8 9 a b c d e f key p o w er up left select righ t do wn some places where can you can find .Ch8 files: • the pluginchip8 page on www.Rockbox.Org has several attached: z pluginchip8 • check out the hp48 chip games section: http://www.Hpcalc.Org/hp48/...

  • Page 129

    Chapter 12. Plugins 129 key remote key action up forward display keyboard to enter text select mode press enter rec rec open frotz menu (not available at more prompts) power quit 12.3.4. Image viewer this plugin opens image files from the file browser to display them using rockbox’s greyscale librar...

  • Page 130

    Chapter 12. Plugins 130 show playback menu. From the playback menu you can control the playback of the currently loaded playlist and change the volume of your player. Quit. Quits the viewer and returns to the file browser. Note: progressive scan and other unusual jpeg files are not supported, and wi...

  • Page 131

    Chapter 12. Plugins 131 key remote key action up/ down volume up/ volume down right/ left skip 3 seconds forward/ backward play pause/resume playback power stop playback and quit 12.3.7. Mpeg player the mpeg player is a video player plugin capable of playing back mpeg-1 and mpeg-2 video streams with...

  • Page 132

    Chapter 12. Plugins 132 settings open settings submenu – see below. Resume playback return to playback screen. Quit mpegplayer exit the plugin. Settings menu display options open display options submenu – see below. Audio options open audio options submenu – see below. Resume options (default: start...

  • Page 133

    Chapter 12. Plugins 133 12.3.8. Mp3 encoder this plugin encodes a .Wav file to mp3 format. The supported input format is uncom- pressed, 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 de...

  • Page 134

    Chapter 12. Plugins 134 default keys key remote key action up / down left / right direction keys play a button rec b button select start hold switch cycle display scaling modes power open rockboy menu rockboy menu load game. . . Loads a previously saved game. Save game. . . Saves your current state....

  • Page 135

    Chapter 12. Plugins 135 example #groceries bananas cucumber 4 apples 6 apples #dairy milk cheese note that it isn’t possible to choose exact quantities, but you can create a number of entries with different quantities in the name of the item, such as for the apples in the above example. There are tw...

  • Page 136

    Chapter 12. Plugins 136 12.3.13. Speedread figure 12.45.: speedread this plugin is designed for reading plain-text files such as ebooks. It works by using a form of rapid serial visual presentation (rsvp) that has optimized word placement to reduce or eliminate eye movement (saccades) when reading. ...

  • Page 137

    Chapter 12. Plugins 137 default keys key remote key action up scroll-up down scroll-down left top of file (narrow mode) / one screen left (wide mode) right bottom of file (narrow mode) / one screen right (wide mode) play toggle autoscroll rec set/reset bookmarks select enter menu power exit text vie...

  • Page 138

    Chapter 12. Plugins 138 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 file path. No do not display the header. Yes di...

  • Page 139

    Chapter 12. Plugins 139 overlap pages set whether the last line from the previous screen is re- tained 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 li...

  • Page 140

    Chapter 12. Plugins 140 figure 12.48.: a bookmark 12.3.15. Theme remove this plugin offers a way to remove a theme. Open the context menu (see section 4.1.2 (page 23 )) upon a theme.Cfg file and select open with... → theme_remove. Some files are not removed regardless of the remove options such as r...

  • Page 141

    Chapter 12. Plugins 141 remote wps. Specifies how the .Rwps file belonging to a theme .Cfg file is han- dled. Remote statusbar skin. Specifies how the .Rsbs file belonging to a theme .Cfg file is handled. Backdrop. Specifies how the backdrop .Bmp file belonging to a theme .Cfg file is handled. Icons...

  • Page 142

    Chapter 12. Plugins 142 zxbox is a port of the “spectemu” zx spectrum 48k emulator for rockbox ( https: //sourceforge.Net/projects/spectemu/ ). To start a game open a tape file or snapshot saved as .Tap, .Tzx, .Z80 or .Sna in the file browser. Note: as zxbox is a 48k emulator only loading of 48k z80...

  • Page 143: 12.4. Applications

    Chapter 12. Plugins 143 invert colours. Inverts the spectrum colour palette, sometimes helps visibility. Frameskip sets the number of frames to skip before displaying one. With zero frameskip zxbox tries to display 50 frames per second. Sound. Turns sound on or off. Volume. Controls volume of sound ...

  • Page 144

    Chapter 12. Plugins 144 12.4.2. Battery benchmark the battery benchmark plugin enables you to test your battery’s performance whilst using your player normally. Results can be submitted to the z batteryruntime wiki page. How it works once loaded, battery benchmark runs in the background recording va...

  • Page 145

    Chapter 12. Plugins 145 usage the log file can be used to tell you how long the battery lasted (with some limitations, see below), but it is most useful for graphing discharge curves in order to improve rockbox’s estimation of battery level and time remaining. The battery log (battery_bench.Txt) is ...

  • Page 146

    Chapter 12. Plugins 146 12.4.4. Calendar figure 12.51.: calendar this is a small and simple calendar application with memo saving function. Dots indicate dates with memos. The available memo types are: one off, yearly, monthly, and weekly memos. You can select what day is first day of week by the se...

  • Page 147

    Chapter 12. Plugins 147 setup key remote key action right / left increase / decrease displayed value select move to next screen rec move to previous screen • first enter the number of players (1–10) • then set the total game time in mm:ss • then the maximum round time is entered. For example, this c...

  • Page 148

    Chapter 12. Plugins 148 12.4.6. Clock figure 12.53.: clock this is a fully featured analogue and digital clock plugin. Key configuration key remote key action left / right volume down / volume up cycle through modes up / down forward / rewind cycle through skins rec rec main menu select mode start /...

  • Page 149

    Chapter 12. Plugins 149 backlight choose whether to disable the backlight, use the user’s timeout setting, or keep the backlight on. Idle poweroff toggle idle poweroff. Note: this setting is not saved to disk. B help opens a brief help screen with key mappings and functionality. Credits displays a c...

  • Page 150

    Chapter 12. Plugins 150 binary mode this mode shows a binary clock. The hour is displayed on the top line, the minute is displayed on the middle line, and the seconds are on the last line. Circle mode, if enabled, draws empty and full circles, instead of zeros and ones. For help on reading binary, p...

  • Page 151

    Chapter 12. Plugins 151 available options all selects all linux, os x, and windows files. None deselects all file options. Linux selects linux files. Default files are .Dolphinview, .D3lphinview, and .Trash-*/. Windows selects windows files. Default files are thumbs.Db, $recycle.Bin/, desktop.Ini, r...

  • Page 152

    Chapter 12. Plugins 152 key remote key action rec or power exit to menu 12.4.11. Lrcplayer this plugin displays lyrics in .Lrc files (and some other formats) synchronized with the song being played. Supported file types 1. .Lrc 2. .Lrc8 3. .Snc 4. .Txt 5. Id3v2 sylt or uslt tags in mp3 files .Lrc8 f...

  • Page 153

    Chapter 12. Plugins 153 location of lyrics files the plugin checks the following directories for lyrics files. If no lyrics file is found and the audio file is a .Mp3, it also checks for sylt and uslt tags in the id3v2 tags. 1. The directory containing the audio file and its parent directories. 2. F...

  • Page 154

    Chapter 12. Plugins 154 controls key remote key action up / down volume up / volume down volume up/down. Left rewind go to beginning of track, or if pressed while in the first seconds of a track, go to the previous track. Long left long rewind rewind in track. Right forward go to the next track. Lon...

  • Page 155

    Chapter 12. Plugins 155 playback control. Show the playback control menu. Time offset. Set an offset for the time tags for the lyrics currently in use. Timetag editor. Enter the timetag editor. Quit. Exit the plugin. Editing the time tags the display time for each line can be changed with the timeta...

  • Page 156

    Chapter 12. Plugins 156 simple interactive mode this is the mode of operation that is active when starting the plugin directly from the menu. It offers a uniform metronome sound at a constant tempo. You can adjust the tempo through the interface or by tapping it out on the appropriate button. Key re...

  • Page 157

    Chapter 12. Plugins 157 key remote key action power exit plugin rec rec stop (stay at position) select mode start from / stop at current position left / right volume down / volume up seek in track up / down forward / rewind adjust volume navigation the display indicates the part properties and posit...

  • Page 158

    Chapter 12. Plugins 158 the same acceleration as in the first line. The last one is a part of 16 bars length that changes tempo from 100 to 200 smoothly during its whole lifetime (6.25 bpm/bar). For details on how the acceleration works, see http://thomas.Orgis.Org/science/metronome- tempomath/tempo...

  • Page 159

    Chapter 12. Plugins 159 12.4.15. One-time password client this plugin provides the ability to generate one-time passwords (otps) for authenti- cation purposes. It implements an hmac-based one-time password algorithm (rfc 4226), and on targets which support it, a time-based one-time password algorith...

  • Page 160

    Chapter 12. Plugins 160 restricted to hmac-based (hotp) accounts only. If this is the case, the plugin will prompt you for information regarding the hotp setup. 12.4.16. Advanced settings time zone configuration in order for totp accounts to work properly, the plugin must be able to determine the cu...

  • Page 161

    Chapter 12. Plugins 161 12.4.19. Random folder advance configuration this plugin is used to configure the folders which will be considered when the auto- change directory feature is set to random. Menu generate folder list generates a list of all folders found on the player. You can filter the direc...

  • Page 162

    Chapter 12. Plugins 162 12.4.20. Resistor calculator figure 12.54.: resistor calculator the resistor calculator is a plugin that works in 3 modes: colour to resistance in colour to resistance mode, use the menus to select the colours of the bands of a resistor which you would like to know the resist...

  • Page 163

    Chapter 12. Plugins 163 12.4.21. Stats figure 12.55.: the stats-plugin the stats plugin counts the directories and files (the total number as well as the number of audio, playlist, image and video files) on your player. Press rec or power to abort counting and exit the plugin. Press it again to quit...

  • Page 164

    Chapter 12. Plugins 164 12.4.23. Text editor this plugin allows you to view and edit simple text documents on your dap. You can view files by using open with from the context menu (see section 4.1.2 (page 23 )). Usage if you start the text editor from the plugin browser you will be greeted with a bl...

  • Page 165: 13. Advanced Topics

    Chapter 13. Advanced topics 165 13. Advanced topics 13.1. Customising the user interface 13.1.1. Customising the main menu it is possible to customise the main menu, i.E. To reorder or to hide some of its items (only the main menu can be customised, submenus can not). To accomplish this, load a .Cfg...

  • Page 166

    Chapter 13. Advanced topics 166 settings → theme settings → font in the main menu. Note: advanced users only: any bdf font should be usable with rockbox. To convert b from .Bdf to .Fnt, use the convbdf tool. This tool can be found in the tools directory of the rockbox source code. See z createfonts#...

  • Page 167

    Chapter 13. Advanced topics 167 only the first two parameters have to be specified, the others can be omitted using ‘-’ as a placeholder. The syntax is very similar to wps viewports (see section 13.2.2 (page 168 )). Briefly: • ‘fgshade’ and ‘bgshade’ are numbers in the range 0 (= black) to 3 (= whit...

  • Page 168

    Chapter 13. Advanced topics 168 all full list of the available tags are given in appendix section d (page 186 ); 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 ignore...

  • Page 169

    Chapter 13. Advanced topics 169 example %v(12,20,-,-,1) %vf(0) %vb(3) %sthis viewport is displayed permanently. It starts 12px from the left and %s20px from the top of the screen, and fills the rest of the screen from %sthat point. The lines will scroll if this text does not fit in the viewport. %st...

  • Page 170

    Chapter 13. Advanced topics 170 %cd %vl(a,0,70,70,14,1) %s%acthere you have it: album art. %vl(b,20,14,50,14,1) %t(1)%acwarning:;%t(.1) %vl(b,20,30,50,50,1) %sno album art found %scheck your filenames. This example checks for album art. Album art will be displayed in viewport ‘a’, if it is found. Ot...

  • Page 172

    Chapter 13. Advanced topics 172 %t set the subline display time. The ‘%t’ is followed by either integer seconds (%t5), or seconds and tenths of a second within () e.G. (%t(3.5)). Each alternating subline can still be optionally scrolled while it is being displayed, and scrollable formats can be disp...

  • Page 173

    Chapter 13. Advanced topics 173 example on background image use: example %x(background.Bmp) the image with filename background.Bmp is loaded and used in the wps. Example on bitmap preloading and use: example %x(a,static_icon.Bmp,50,50) %xl(b,rep_off.Bmp,16,64) %xl(c,rep_all.Bmp,16,64) %xl(d,rep_one....

  • Page 174

    Chapter 13. Advanced topics 174 1. Each setting must be on a separate line. 2. Each line has the format “setting: value”. 3. Values must be within the ranges specified in this manual for each setting. 4. Lines starting with # are ignored. This lets you write comments into your config- uration files....

  • Page 175: 13.4. Firmware Loading

    Chapter 13. Advanced topics 175 reset settings this wipes the saved settings in the player and resets all settings to their default values. Note: you can also reset all settings to their default values by turning off the b player, turning it back on, and holding the rec button immediately after the ...

  • Page 176

    Chapter 13. Advanced topics 176 13.5.2. Anti-skip buffer having a large anti-skip buffer tends to use more power, and may reduce your battery life. It is recommended to always use the lowest possible setting that allows correct and continuous playback (see section 7.5 (page 56 )). 13.5.3. Replaygain...

  • Page 177: A. File Formats

    Appendix a. File formats 177 a. File formats a.1. Supported file formats icon file type extension action when selected directory none enter the directory audio file various (see b.1 ) start playing the file and show the wps bookmark .Bmark display all bookmarks for an audio file game of life .Cells ...

  • Page 178

    Appendix b. Audio and metadata formats 178 b. Audio and metadata formats b.1. Supported audio formats b.1.1. Lossy codecs format extension notes atsc a/52 (ac3) .A52, .Ac3, .Rm, .Ra, .Rmvb supports downmixing for play- back of 5.1 streams in stereo adx .Adx encrypted adx is not sup- ported. Advanced...

  • Page 179

    Appendix b. Audio and metadata formats 179 mance requirements. B.1.2. Lossless codecs format extension notes audio interchange file format .Aif, .Aiff linear pcm 8/16/24/32 bit, ieee float 32/64 bit, itu-t g.711 a- law/µ-law, quicktime ima ad- pcm monkey’s audio .Ape, .Mac -c1000 to -c3000 files dec...

  • Page 180

    Appendix b. Audio and metadata formats 180 b.1.3. Other codecs format extension notes atari sound format .Cmc, .Cm3, .Cmr, .Cms, .Dmc, .Dlt, .Mpt, .Mpd synthetic music mobile application format .Mmf pcm/adpcm only game boy sound format .Gbs progress bar and seek use subtracks instead of seconds. Ay ...

  • Page 181

    Appendix b. Audio and metadata formats 181 b.1.4. Codec featureset format seek resume gapless atsc a/52 (ac3) x x adx x advanced audio coding x x x mpeg audio x x x musepack x x x ogg/vorbis x x x sony audio x x realaudio x x dialogic telephony type x x windows media audio standard x x windows media...

  • Page 182

    Appendix b. Audio and metadata formats 182 b.2. Supported metadata tags rockbox supports different metadata formats. In general those tag formats are id3 (v1.0, v1.1, v2.2, v2.3 and v2.4), ape (v1 and v2), vorbis, mp4 and asf. Few codecs use codec specific tags, several codecs do not use any tags ye...

  • Page 183

    Appendix b. Audio and metadata formats 183 b.2.2. Featureset for codec specific metadata feature codec specific metadata (file extension) embedded .Bmp none embedded .Jpg none embedded .Png none replaygain .Mpc title .Tta, .Spc, .Mmf, .Sid, .Rm, .Ra, .Rmvb, .Nsf, .Nsfe, .Mod, .Sap, .Gbs, .Ay, .Sgc, ...

  • Page 184: C. Album Art

    Appendix c. Album art 184 c. Album art rockbox allows you to put the album art, or another image related to the music on your player to display it in the pictureflow plugin or in the theme. For this feature to work, there are a few requirements. C.1. Limitations rockbox supports embedded album art o...

  • Page 186: D. Theme Tags

    Appendix d. Theme tags 186 d. Theme tags themeing is discussed in detail in section section 13.2 (page 167 ), what follows is a list of the available tags. Note: the “bar-type tags” (such as %pb, %pv, %bl etc.) can be further themed – see b section d.27 (page 199 ). D.1. Status bar tag description %...

  • Page 187: D.4. Viewports

    Appendix d. Theme tags 187 d.3. Information from the track tags tag description %ia artist %ic composer %ia album artist %id album name %ig grouping %ig genre name %in track number %it track title %ic comment %iv id3 version (1.0, 1.1, 2.2, 2.3, 2.4, or empty if not an id3 tag) %iy year %ik disc num...

  • Page 188: D.5. Additional Fonts

    Appendix d. Theme tags 188 d.5. Additional fonts tag description %fl(’id’,filename) see section 13.2.4 . D.6. Misc coloring tags tag description %dr(x,y,width,height,[color1,color2]) color a rectangle. Width and height can be - to fill the viewport. If no color is specified the viewports foreground ...

  • Page 190: D.9. Playlist/song Info

    Appendix d. Theme tags 190 d.9. Playlist/song info tag description %pb progress bar. This will replace the entire line with a progress bar. You can set the position, width and height of the progressbar (in pixels) and load a custom image for it: %pb(x,y,[width],[height],image.Bmp) %px percentage pla...

  • Page 191: D.11. Runtime Database

    Appendix d. Theme tags 191 • ‘start’ is the offset relative to the currently playing track for the playlist to display from (0 the current track, 1 is the next track, etc.). • ‘code to render’ is a line of skin code which will be displayed for each line in the viewer. All text tags are supported (in...

  • Page 192: D.14. Virtual Led

    Appendix d. Theme tags 192 d.14. Virtual led tag description %lh “h” if the hard disk is accessed d.15. Repeat mode tag description %mm repeat mode, 0-4, in the order: off, all, one, shuffle, a-b example: %?Mm d.16. Playback mode tag description %mp play status, 0-4, in the order: stop, play, pause,...

  • Page 193

    Appendix d. Theme tags 193 number screen 1 menus 2 wps 3 recording screen 4 fm radio screen 5 current playlist screen 6 settings menus 7 file browser 8 database browser 9 plugin browser 10 quickscreen 11 pitchscreen 12 setting chooser 13 playlist catalogue viewer 14 plugin 15 context menu 16 system ...

  • Page 194: D.19. Changing Volume

    Appendix d. Theme tags 194 d.19. Changing volume tag description %mv(t) “v” if the volume is being changed the tag produces the letter “v” while the volume is being changed and some amount of time after that, i.E. After the volume button has been released. The optional parameter t specifies that amo...

  • Page 195: D.21. Images

    Appendix d. Theme tags 195 d.21. 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. %x(n,filename[,x,y])load and display an image n: image id for later referencing in %xd filename: file name relative to /.Rockbox/ ...

  • Page 196

    Appendix d. Theme tags 196 1. Load and display the image /.Rockbox/bg.Bmp with id “a” at 37, 109: %x(a,bg.Bmp,37,109) 2. Load a bitmap strip containing 5 volume icon images (all the same size) with image id “m”, and then reference the individual sub-images in a conditional: %xl(m,volume.Bmp,134,153,...

  • Page 197

    Appendix d. Theme tags 197 2. Load albumart at position 0,20 and resize it to be at most 100×100 pixels. If the image isn’t square, align it to the bottom-right corner: %cl(0,20,100,100,r,b) for general information where to put album art see section c (page 184 ). D.22. Alignment and language direct...

  • Page 199: D.25. Time And Date

    Appendix d. Theme tags 199 d.25. Time and date tag description %cd day of month from 01 to 31 %ce zero padded day of month from 1 to 31 %cf a conditional for 12/24 hour format. %?Cf %ch zero padded hour from 00 to 23 (24 hour format) %ck hour from 0 to 23 (24 hour format) %ci zero padded hour from 0...

  • Page 200

    Appendix d. Theme tags 200 tag description %xx(x, y, width, height, [options]) draw the specified tag as a bar x: x co-ordinate at which to start drawing the bar. Y: y co-ordinate at which to start drawing the bar (- to make the bar appear on the line of the tag, as if it was a text tag) . Width: wi...

  • Page 201: D.28. Other Tags

    Appendix d. Theme tags 201 d.28. Other tags tag description %ss(start, length, tag [,number] get a substring from another tag. Use this tag to get a substring from another tag. Start – first character to take (0 being the start of the string, negative means from the end of the string) length – lengt...

  • Page 202: E. Config File Options

    Appendix e. Config file options 202 e. Config file options setting allowed values unit volume -73 to +6 db bass -24 to +24 db treble -24 to +24 db balance -100 to +100 % channels stereo, mono, custom, mono left, mono right, karaoke n/a stereo_width 0 to 250 % shuffle on, off n/a repeat off, all, one...

  • Page 203

    Appendix e. Config file options 203 setting allowed values unit bidir limit 0 to 200 % screen scroll paginated on, off n/a hold_lr_for_scroll_in_list on, off n/a show path in browser off, current directory, full path n/a contrast 0 to 63 n/a backlight timeout off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...

  • Page 204

    Appendix e. Config file options 204 setting allowed values unit disable autoresume if phones not present off, on n/a last.Fm logging off, on n/a talk dir off, number, spell n/a talk dir clip off, on n/a talk file off, number, spell n/a talk file clip off, on n/a talk filetype off, on n/a talk menu o...

  • Page 205

    Appendix e. Config file options 205 setting allowed values unit crossfeed direct gain 0 to 60 0.1 db crossfeed cross gain 30 to 120 0.1 db crossfeed hf attenuation 60 to 240 0.1 db crossfeed hf cutoff 500 to 2000 hz eq enabled on, off n/a eq precut 0 to 240 0.1 db eq low shelf filter cutoff (in hz),...

  • Page 206

    Appendix e. Config file options 206 setting allowed values unit peak meter dbfs on, off on: dbfs, off: lin- ear peak meter min 0 to 89 (db) or 0 to 100 (%) db or % peak meter max 0 to 89 /(db) or 0 to 100 (%) db or % statusbar off, top, bottom n/a remote statusbar off, top, bottom n/a scrollbar off,...

  • Page 207

    Appendix e. Config file options 207 setting allowed values unit rec source mic, line, spdif n/a rec channels mono, stereo n/a rec mic gain 0 to 15 n/a rec left gain 0 to 15 n/a rec right gain 0 to 15 n/a editable recordings off,on n/a rec timesplit off, 0:05, 0:10, 0:15, 0:30, 1:00, 2:00, 4:00, 6:00...

  • Page 208: F. Menu Overview

    Appendix f. Menu overview 208 f. Menu overview include an overview of the menu structure here the rockbox manual (version 3.14) iaudio m5.

  • Page 209: G. User Feedback

    Appendix g. User feedback 209 g. User feedback g.1. Bug reports if you experience inappropriate performance from any supported feature, please file a bug report on our web page. Do not report missing features as bugs, instead file them as feature ideas (see below). For open bug reports refer to http...

  • Page 210

    Appendix g. User feedback 210 g.2.2. Features we will not implement this is a list of feature requests we get repeatedly that we simply cannot do. View it as the opposite of a todo! • interfacing with other usb devices (like cameras) or 2 player games over usb. The usb system demands that there is a...

  • Page 211: H. Credits

    Appendix h. Credits 211 h. Credits people that have contributed to the project, one way or another. Friends! · björn stenberg · linus nielsen feltz- ing · andy choi · andrew jamieson · paul suade · joachim schiffer · daniel stenberg · alan korr · gary czvitkovicz · stuart martin · fe- lix arends · u...

  • Page 212

    Appendix h. Credits 212 hand · nick lanham · sebastian hen- riksen · martin scarratt · karl kurbjun · tomasz malesinski · an- drew pilley · matt v.D. Westhuizen · tim crist · jvo studer · dan ever- ton · imre herceg · seven le mesle · craig bachelor · nikolaj chris- tensen · mikael magnusson · domin...

  • Page 213

    Appendix h. Credits 213 · stepan moskovchenko · john s. Gwynne · brian j. Morey · stijn hisken · bertrik sikken · karim boucher · james espinoza · franz rühmland · jordan anderson · maurus cuele- naere · chris allegretta · alastair s · martin crkovský · ariya hidayat · jonas hurrelmann · lee kang hy...

  • Page 214

    Appendix h. Credits 214 · delyan kratunov · purling nayuki · marek salaba · altay oz · mark borgerding · tobias diedrich · andrew engelbrecht · kevin schoedel · jens theeß · alexey nemtsev · pascal be- low · danny attar · philipp stephani · tore johnny bråtveit · marcin bukat · andrew rodland · luca...

  • Page 215: I. Licenses

    Appendix i. Licenses 215 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, ...

  • Page 216

    Appendix i. Licenses 216 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. A “secondary section” is a named appendix or a front-matter section of the doc- ument that d...

  • Page 217

    Appendix i. Licenses 217 ther is precisely xyz or contains xyz in parentheses following text that translates xyz in another language. (here xyz stands for a specific section name mentioned below, such as “acknowledgements”, “dedications”, “endorsements”, or “history”.) to “preserve the title” of suc...

  • Page 218

    Appendix i. Licenses 218 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 ...

  • Page 219

    Appendix i. Licenses 219 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 do...

  • Page 220

    Appendix i. Licenses 220 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...

  • Page 221

    Appendix i. Licenses 221 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 tran...

  • Page 222

    Appendix i. Licenses 222 copyright c year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the gnu free documenta- tion license, version 1.2 or any later version published by the free software foundation; with no invariant sections, no front-cover t...

  • Page 223

    Appendix i. Licenses 223 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 i...

  • Page 224

    Appendix i. Licenses 224 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. The “program”, below, refe...

  • Page 225

    Appendix i. Licenses 225 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 ...

  • Page 226

    Appendix i. Licenses 226 if distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy...

  • Page 227

    Appendix i. Licenses 227 reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to b...

  • Page 228

    Appendix i. Licenses 228 and/or redistribute the program as permitted above, be liable to you for damages, including any general, special, incidental or con- sequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered in...

  • Page 229

    Appendix i. Licenses 229 ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details. The hypothetical commands show w and show c should show the appropriate parts of the general public license. Of course, the commands you use may be ca...