Iaudio Iaudio M3, Firmware Update Manual

Page 1: ...The Rockbox Manual for Iaudio M3 rockbox org December 16 2014 ...

Page 2: ...arcia Valdecasas Bernal Peter Schlenker Version rUnversioned Built using pdfL A 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 Sec tions no Front Cover Texts and no Back Cover Texts A copy of the license is included in the sect...

Page 3: ... Automatic Uninstallation 17 2 5 2 Manual Uninstallation 17 2 6 Troubleshooting 17 3 Quick Start 18 3 1 Basic Overview 18 3 1 1 The player s controls 18 3 1 2 Turning the player on and off 19 3 1 3 Putting music on your player 19 3 1 4 The first contact 19 3 1 5 Basic controls 20 3 1 6 Basic concepts 20 3 2 Customising Rockbox 20 4 Browsing and playing 22 4 1 File Browser 22 4 1 1 File Browser Con...

Page 4: ...ucing the Main Menu 38 5 2 Navigating the Main Menu 38 5 3 Recent Bookmarks 39 5 4 Files 39 5 5 Database 40 5 6 Now Playing Resume Playback 40 5 7 Settings 40 5 7 1 Sound Settings 40 5 7 2 Playback Settings 40 5 7 3 General Settings 40 5 7 4 Theme Settings 40 5 7 5 Recording Settings 40 5 7 6 Manage Settings 41 5 8 Recording 41 5 8 1 While Recording Screen 41 5 9 FM Radio 42 5 10 Playlists 43 5 11...

Page 5: ...ge Directory 59 7 12 Constrain Auto Change 59 7 13 Last fm Log 59 7 14 Cuesheet Support 60 7 15 Skip Length 60 7 16 Prevent Track Skipping 60 7 17 Rewind Before Resume 60 7 18 Rewind on Pause 61 8 General Settings 62 8 1 Playlist 62 8 2 File View 62 8 3 Database 64 8 4 Display 64 8 5 System 66 8 5 1 Battery 66 8 5 2 Disk 67 8 5 3 Limits 67 8 5 4 Use Shortcuts Menu Instead of Quick Screen 68 8 5 5 ...

Page 6: ...Light 79 10 11 Trigger 79 11 Plugins 81 11 1 Games 81 11 1 1 2048 81 11 1 2 Blackjack 82 11 1 3 BrickMania 82 11 1 4 Bubbles 83 11 1 5 Chessbox 84 11 1 6 Chopper 85 11 1 7 Dice 85 11 1 8 Doom 86 11 1 9 Flipit 88 11 1 10 Goban 88 11 1 11 Invadrox 92 11 1 12 Jackpot 93 11 1 13 Jewels 93 11 1 14 MazezaM 94 11 1 15 Minesweeper 95 11 1 16 Pegbox 95 11 1 17 Pong 96 11 1 18 Reversi 97 11 1 19 Robotfindsk...

Page 7: ...w 114 11 2 11 Plasma 115 11 2 12 Rocklife 116 11 2 13 Snow 116 11 2 14 Starfield 117 11 2 15 VU meter 117 11 3 Viewers 118 11 3 1 Shortcuts 118 11 3 2 Chip 8 Emulator 119 11 3 3 Frotz 120 11 3 4 Image Viewer 121 11 3 5 Lua scripting language 122 11 3 6 Midiplay 123 11 3 7 MPEG Player 123 11 3 8 MP3 Encoder 125 11 3 9 Search 125 11 3 10 Shopper 126 11 3 11 Sort 126 11 3 12 Text Viewer 126 11 3 13 T...

Page 8: ...5 Loading Backdrops 146 12 1 6 UI Viewport 146 12 2 Configuring the Theme 147 12 2 1 Themeing General Info 147 12 2 2 Themes Create Your Own 147 12 2 3 Info Viewport SBS only 150 12 2 4 Additional Fonts 150 12 3 Managing Rockbox Settings 153 12 3 1 Introduction to cfg Files 153 12 3 2 Specifications for cfg Files 153 12 3 3 The Manage Settings menu 154 12 4 Firmware Loading 155 12 4 1 Using ROLO R...

Page 9: ...om the track tags 168 D 4 Viewports 168 D 5 Additional Fonts 169 D 6 Misc Coloring Tags 169 D 7 Power Related Information 169 D 8 Information about the file 170 D 9 Playlist Song Info 171 D 10 Playlist Viewer 171 D 11 Runtime Database 172 D 12 Sound DSP settings 172 D 13 Hold 172 D 14 Virtual LED 173 D 15 Repeat Mode 173 D 16 Playback Mode 173 D 17 Current Screen 173 D 18 List Title sbs only 174 D...

Page 10: ...reports 189 G 1 1 Rules for submitting new bug reports 189 G 2 Feature ideas 189 G 2 1 Rules for submitting a new feature idea 189 G 2 2 Features we will not implement 190 H Credits 191 I Licenses 195 I 1 GNU Free Documentation License 195 I 2 The GNU General Public License 203 The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 11: ... making Rockbox sound the best it can and improvements are constantly being made All models have access to a large number of plugins including many games applications and graphical demos You can load different configurations quickly for different purposes e g a large font for in your car different sound settings for at home Rockbox features a very wide range of languages and all supported models a...

Page 12: ... the margin to help you finding important parts or parts you could skip The following icons are used Note This indicates a note A note starts always with the text Note In order to b make finding notes easier each one is accompanied by an icon in the margin as here Notes are used to mark useful information that may help you to get the most out of Rockbox Warning This is a warning In contrast to not...

Page 13: ...pplication 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 comp...

Page 14: ...hen first starting Rockbox Utility run Autodetect found in the configuration dialog File Configure Autodetection can detect most player types If autodetection fails or is unable to detect the mountpoint make sure to enter the correct values The mountpoint indicates the location of the player in your filesystem On Windows this is the drive letter the player gets assigned on other systems this is a ...

Page 15: ...ase 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 firmware...

Page 16: ...ld the Play button to turn off the player Insert the charger The Rockbox bootloader will automatically be flashed 2 2 4 Enabling Speech Support optional If you wish to use speech support you will also need a voice file Voice files allow Rockbox to speak the user interface to you Rockbox Utility can install an English voice file or you can download it from http www rockbox org daily shtml and unzip...

Page 17: ...ectively 2 5 2 Manual Uninstallation If you would like to go back to using the original Iaudio software connect the player to your computer download the original Iaudio M3 firmware from the Iaudio website and copy it to the FIRMWARE directory on your Iaudio M3 Turn off the player remove the USB cable and insert the charger The original firmware will automatically be flashed If you wish to clean up...

Page 18: ... 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 that button The buttons are described in The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 19: ...older e g music or audio 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 files are not properly tagged and you have your music organized in a way differe...

Page 20: ...g and also save it to a file If you do not want to use playlists you can simply play your files directory based Playlists are covered in detail in section 4 4 page 33 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 c...

Page 21: ...ook nice on your player Note Some of the themes shipped with Rockbox need additional fonts from the fonts b package so make sure you installed them Also if you downloaded additional themes from the Internet make sure you have the needed fonts installed as otherwise the theme may not display properly The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 22: ...n your player using categories like album artist genre etc You can select whether to browse using the File Browser or the Database Browser by selecting either Files or Database in the Main Menu If you choose the File Browser the Show Files setting lets you select what types of files you wish to view See section 8 2 page 63 for more information on the Show Files setting Note The File Browser allows...

Page 23: ... Mode Long Mode Enter the Context Menu Rec Menu Enter the Main Menu Long Rec Long Menu Switch to the Quick Screen see sec tion 5 13 page 45 Rec Mode Activate the Hotkey function see sec tion 4 5 page 37 4 1 2 Context Menu Figure 4 2 The Context Menu The Context Menu allows you to perform certain operations on files or directories To access the Context Menu position the selector over a file or dire...

Page 24: ...s feature with caution Set As Backdrop Set the selected bmp file as background image The bitmaps need to meet the conditions explained in section 12 1 5 page 146 Open with Runs a viewer plugin on the file Normally when a file is selected in Rock box Rockbox automatically detects the file type and runs the appropriate plugin The Open With function can be used to override the default action and sele...

Page 25: ...t file with the required layout More information on how to achieve this can be found on the Rockbox website at ZLoadableKeyboardLayouts Note When the cursor is on the input line Play deletes the preceding character b Key Remote Key Action Rewind Forward 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...

Page 26: ...tabase Initialization You may have directories on your player whose contents should not be added to the database Placing a file named database ignore in a directory will exclude the files in that directory and all its subdirectories from scanning their tags and adding them to the database This will speed up the database initialization If a subdirectory of an ignored directory should still be scann...

Page 27: ...odifications exported to ASCII format should be readable by all database versions 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 initialized you can browse your music by Artist Al bum Genre...

Page 28: ...length numeric system Lm track len min numeric system Ls track len sec numeric system 4 3 While Playing Screen The While Playing Screen WPS displays various pieces of information about the cur rently playing audio file The appearance of the WPS can be configured using WPS configuration files The items shown depend on your configuration all items can be turned on or off independently Refer to secti...

Page 29: ... track go to the previous track Long Rewind Long Rewind Rewind in track Forward Forward Go to the next track Long Forward Long Forward Fast forward in track Play Play Toggle play pause Long Play Long Play Stop playback Mode Mode Return to the File Browser Database Long Mode Long Mode Enter WPS Context Menu Rec Menu Enter Main Menu Long Rec Long Menu Switch to the Quick Screen see sec tion 5 13 pag...

Page 30: ...he 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 fu...

Page 31: ...und of your music See section 6 page 47 for more information Playback Settings This is a shortcut to the Playback Settings Menu where you can configure shuffle repeat party mode skip length and other settings affecting the playback of your music Rating The menu entry is only shown if Gather Runtime Information is enabled It allows the assignment of a personal rating value 0 10 to a track which can...

Page 32: ...al pitch 200 means double playback speed and a pitch that is an octave higher than the normal pitch The rate can be changed in two modes procentual and semitone Initially procentual mode is active If you ve enabled the Timestretch option in Sound Settings and have since re booted you can also use timestretch mode This allows you to change the playback speed without affecting the pitch and vice ver...

Page 33: ... For example if you are playing the contents of a directory Rockbox will automatically create a playlist containing all songs in it This means that just about anything that is described in this chapter with respect to playlists also applies to directories Dynamic playlist A dynamic playlist is a playlist that is created On the fly Any time you insert or queue tracks using the Playlist submenu see ...

Page 34: ...using the Playlist catalogue The Playlist catalogue makes it possible to modify and create playlists that are not currently playing To do this select Playlist catalogue in the Context Menu There you will have two choices Add to playlist adds the selected track or directory to an existing playlist and Add to a new playlist creates a new playlist containing the selected track or directory Note All p...

Page 35: ...racks will be added immediately after the current playing track If playback is stopped a new dynamic playlist will get created with the selected tracks Insert Next Add track s immediately after current playing track no matter what else has been inserted Insert Last Add track s to end of playlist Insert Shuffled Add track s to the playlist in a random order Insert Last Shuffled Add tracks in a rand...

Page 36: ...he WPS context menu or in the Main Menu 4 4 4 Modifying playlists Reshuffling Reshuffling the current playlist is easily done from the Playlist sub menu in the WPS just select Reshuffle Moving and removing tracks To move or remove a track from the current playlist enter the Playlist Viewer by selecting View Current Playlist in the Playlist submenu in the WPS context menu or the Main Menu Once in t...

Page 37: ...s Hotkeys are shortcut keys for use in the File Browser and WPS screen To use one press Rec Mode within the File Browser or Rec Mode within the WPS screen The assigned function will launch with reference to the current file or directory if applicable Each screen has its own assignment If there is no assignment for a given screen the hotkey is ignored The default assignment for the File Browser hot...

Page 38: ... hard disk the next time for example when refilling the music buffer or navigating through the File Browser Changes to settings may therefore not be saved unless the player is shut down safely see section 3 1 2 page 19 5 2 Navigating the Main Menu Key Remote Key Action Volume Down Volume Down Select the next option in the menu Inside a setting increase the value or choose next option Volume Up Vol...

Page 39: ...Volume Up Select the previous bookmark Play or Forward Forward Resume from the selected bookmark Rewind Rewind Exit Recent Bookmark menu Long Rec Long Rec Delete the currently selected bookmark Long Mode Long Mode Enter the context menu for the selected bookmark There are two options in the context menu Resume will commence playback of the currently selected bookmark entry Delete will remove the c...

Page 40: ...value and would like to restore the default value 5 7 1 Sound Settings The Sound Settings menu offers a selection of sound properties you may change to customise your listening experience The details of this menu are covered in section 6 page 47 5 7 2 Playback Settings The Playback Settings menu allows you to configure settings related to audio play back The details of this menu are covered in sec...

Page 41: ...e size of the file being recorded A peak meter is present to allow you set gain correctly There is also a volume setting this will only affect the output level of the player and does not affect the recorded sound If enabled in the peak meter settings a counter in front of the peak meters shows the number of times the clip indicator was activated during recording The counter is reset to zero when s...

Page 42: ...le to load these settings from a file Such files should have the filename extension fmr and reside in the directory rockbox fmpresets note that this directory does not exist after the initial Rockbox installation you should create it manually To load the settings i e a set of FM stations from a preset file just play it from the file browser Rockbox will remember and use it in PRESET mode until ano...

Page 43: ...et Enter the name maximum number of characters is 32 Press Long Play to save Selecting a preset Mode to go to the presets list Use Volume Up and Volume Down to move the cursor and then press Play or Forward to select Use Rewind to leave the preset list without selecting anything Removing a preset Mode to go to the presets list Use Volume Up and Volume Down to move the cursor and then press Long Mo...

Page 44: ...tom 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 list of contributors Running Time Shows the runtime of your player in hours minutes and seconds Running Time This item shows the cumulative overall runtime of your player since you either disconnected it from charging in Rockbox ...

Page 45: ...quickscreen then pressing up and down will cycle through this setting in opposite directions 5 14 Shortcuts This menu item is a container for user defined shortcuts to files folders or settings With a shortcut 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 ...

Page 46: ...o be 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 not specified a sensible default will be used Note For the browse type if you want the file browser to start inside a folder make b sure the data has the trailing slash i e Music instead of...

Page 47: ...lues higher than 0 dB are available and can be used to raise the volume more than would otherwise be possible These volume levels will ordi narily 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...

Page 48: ...manner they will be combined Available options are Stereo Leave the audio signal unmodified 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 r...

Page 49: ... and might for that reason sound unnatural to some listeners The crossfeed function uses an algorithm to feed a delayed and filtered portion of the signal from the right channel into the left channel and vice versa in order to simulate the spatial cues that the ear and brain receive when listening to a set of loudspeakers placed in front of the listener The result is a more natural stereo image th...

Page 50: ...ic equalizer EQ In contrast to non parametric equalizers a parametric EQ enables adjusting the center frequency gain and width of EQ bands separately The ability to adjust the frequency and width of bands enables more precise control of the EQ frequency response while avoiding the use of a large number of bands often 12 needed in a non parametric EQ The graphic below illustrates how the width of 1...

Page 51: ...aking EQ filters boost or lower a frequency range cen tered at the centre frequency chosen Graphic equalizers in home stereos are usually peaking filters The peaking filters in Rockbox s EQ lets you adjust three different parameters for EQ bands 1 through 8 The centre parameter controls the centre frequency of the frequency range that is affected as described above The gain parameter controls how ...

Page 52: ...by all of the parameters that can be adjusted using the graphical EQ With the Simple EQ the only parameter that can be adjusted is the gain Advanced EQ This sub menu provides options for adjusting the same parameters as the Graphical EQ The only difference is that the parameters are adjusted through textual menus rather than through a graphic interface Save EQ Preset This option saves the current ...

Page 53: ...l This makes the quieter and louder sections closer to the same volume level by progressively reducing the gain of louder signals When subsequently amplified this has the effect of making the quieter sections louder while keeping the louder sections from clipping This allows listening to the quiet sections of dynamic material in noisy environments while preventing sudden loud sections from being o...

Page 54: ...nee setting smoothes the transition from plus or minus three decibels around the threshold The Attack Time setting sets the delay in milliseconds between the input signal exceeding the activation threshold and acting upon it The Release Time setting sets the recovery time after the signal is compressed Once the compressor determines that compression is necessary the input signal is reduced appropr...

Page 55: ...finished Note If you have the Auto Change Directory option set to Yes Rockbox b will move on to the next directory on your hard drive If the Auto Change Directory option is set to No playback will stop when the current directory or playlist is finished All The current playlist will repeat when it is finished One Repeat one track over and over Shuffle When the current playlist has finished playing ...

Page 56: ...be set to various values between 5 seconds and 10 minutes Note Having a large anti skip buffer tends to use more power and may reduce your b battery life It is recommended to always use the lowest possible setting that allows correct and continuous playback 7 6 Fade on Stop Pause Enables and disables a fade effect when you pause or stop playing a song If the Fade on Stop Pause option is set to Yes...

Page 57: ...een when the crossfade process begins and when the new track begins to fade in Fade In Duration The length of time in seconds that it takes your music to fade in once the Fade In Delay has ended Fade Out Delay The fade out delay is the length of time between when the crossfade process begins and when the old track begins to fade out Fade Out Duration The length of time in seconds that it takes you...

Page 58: ...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 Shuffling Maintains a constant volume between tracks if Shuffle is set t...

Page 59: ...to first generate a folder list via the Random Folder Advance Configuration plugin see section 11 4 12 page 141 Note You must have the Repeat option set to No for Auto Change Directory to b function properly Note This feature only works when songs have been played from the file browser Using b it with the database may cause unexpected behaviour 7 12 Constrain Auto Change If enabled and you have se...

Page 60: ...aviour of the Rewind and Forward buttons so that they skip by a given time instead of skipping to a new track The Skip to Outro option changes the behaviour so that the buttons skip to just before the end of the track so that the last few seconds are played before the next track 7 16 Prevent Track Skipping If this option is enabled the ability to manually skip tracks is disabled in order to avoid ...

Page 61: ... 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 rUnversioned directory 141216 Iaudio M3 ...

Page 62: ...ions relating to how the File Browser displays files Sort Case Sensitive If this option is set to Yes all files that start with upper case letters will be listed first followed by all files that begin with lower case letters If this option is set to NO then case will be ignored when sorting files Sort Directories This option controls how Rockbox sorts directories The default is to sort them alphab...

Page 63: ...o files or directories are hidden Supported The File Browser displays all directories and files supported by Rockbox see section A 1 page 158 Files and directories starting with dot or with the hidden flag set are hidden Music The File Browser displays only directories playlists and the supported audio file formats Extensions are stripped Files and directories starting with or with the hidden flag...

Page 64: ...ount of time after a button press Backlight While Plugged In This setting is equivalent to the Backlight set ting except it applies when the player is plugged into the charger Backlight on Hold This setting controls the behavior of the backlight when the Hold switch is toggled If set to Normal the backlight will behave as usual If set to Off the backlight will be turned off immediately when the Ho...

Page 65: ...u tell Rockbox where that limit is expressed in percentage of the line length Screen Scrolls Out of View Screens can be manually scrolled horizontally by pressing Long Forward Rewind Setting this option to Yes will keep the list entries at their fixed positions and allow them to be scrolled out of view whereas No will only scroll those entries which surpass the right margin Screen Scroll Step Size...

Page 66: ...s applied to your headphones you should choose Linear display This setting cannot be displayed in units like volts or watts because such units depend on your headphones Minimum and maximum range These two options define the full value range that the peak meter displays Recommended values for the Logarithmic dB setting are 40 dB for minimum and 0 dB for maximum Recommended values for Linear display...

Page 67: ...ur drive in RAM The Directory Cache takes a small amount of memory away from Rockbox that would otherwise be used to buffer music but it speeds up navigation in the file browser by eliminating the slight pause between the time a navigation button is pressed and the time Rockbox responds Turning this setting on activates the directory cache and turning it off deactivates the directory cache Note Th...

Page 68: ...e disabled Keyclick repeats This setting turns keyclick repeats On and Off If set to On the keyclicks will be repeated when you hold down a button If set to Off you will hear only one click 8 6 Startup Shutdown The Startup Shutdown sub menu allows you to configure items which are run at startup or initiate a shutdown when conditions are met 8 6 1 Start Screen Set the screen that Rockbox will start...

Page 69: ...on will cancel the current Sleep Timer The time remaining before completion is shown in brackets Default Sleep Timer Duration The default number of minutes a new Sleep Timer will run for The values range from 5 minutes to 5 hours in 5 minute steps If a timer is currently active the timer s duration will be set to the newly entered value The value set is persistent see section E page 183 Start Slee...

Page 70: ...ion in the most recently ac b cessed track regardless of how the Bookmark on Stop option is set Update on Stop If set to No this setting has no effect and does not affect any other settings If set to Yes and the file to which a new bookmark would be added already exists this option overrides the previous setting Bookmark on Stop and unconditionally creates a bookmark This is useful if you don t ge...

Page 71: ...st 8 8 Automatic resume The automatic resume feature stores and recalls resume positions for all tracks without user intervention These resume points are stored in the database and thus automatic resume only works when the database has been initialized When automatic resume is enabled manually selected tracks resume playback at their last playback position It does not matter in which way you start...

Page 72: ...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 files in directories PODCAST Podcast or podcast and their subdirectories but not in directories podcasts mind the trailing s or audio podcast 8 9 Language This setting controls the language of the Rockbox user interface Selecting a language will acti...

Page 73: ...et under Voice Directories above Voice Filenames This option controls voicing of filenames Again a voice file must be present for this to work The options provided are Spell Numbers and Off which function the same as for Voice Directories You can use pre generated talk clips to have filenames spoken properly but you must enable this explicitly see below Use File talk Clips This option turns on the...

Page 74: ...port in Rockbox 8 11 Hotkey WPS Hotkey File Browser Hotkey These options set the hotkey function for their respective screens see section 4 5 page 37 The default for the WPS is View Playlist The File Browser default is Off The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 75: ...our player Selecting one will activate it See section 12 1 3 page 145 for further details about fonts While Playing Screen Opens the File Browser in the rockbox wps directory and displays all wps files Selecting one will activate it Rewind will exit back to the menu For further information about the WPS see section 4 3 page 28 For information about editing a wps file see section 12 2 page 147 Show...

Page 76: ...ls See section 6 1 page 47 for more on the volume set ting Battery Display Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar Line Selector Type This option allows you to select which type of line selector to use Pointer A small arrow to the left of the menu text Bar inverse A bar with inverted foreground and background colour The R...

Page 77: ...ng in The available choices are the two un compressed formats PCM Wave and AIFF the losslessly compressed WavPack and the lossy MPEG Layer 3 10 2 Encoder Settings MP3 only This sets the bitrate when using the MPEG Layer 3 format 10 3 Frequency Choose the recording frequency sample rate 88 2 kHz 44 1 kHz 22 05 kHz and 11 025 kHz are available Higher sample rates use up more disk space but give bett...

Page 78: ...quired to stop and restart the recording on the order of 2 4 seconds Split Measure This option controls whether to split the recording when the Split Filesize is reached or when the Split Time has elapsed What to do when Splitting This controls what will happen when the splitting condi tion is fulfilled the two available options here are Start a new file or Stop recording Split Time Set the time t...

Page 79: ...tures numerous parameters to adapt its behaviour to the desired situation Trigger This parameter specifies the trigger mode When set to Off the recording must be started manually and apart from the Prerecord time no other parameter has any effect Once will have the trigger start one recording only after the recording has finished the input signal will not start another recording Repeat will have t...

Page 80: ...marker in the peak meter at the bottom of the screen In contrast to the start threshold marker it points to the left The value Off turns the stop condition off With this setting you have to stop the recording manually for at least This time specifies the duration the signal must drop below the stop thresh old to stop the recording By selecting high values you can ensure that for example trailing f...

Page 81: ...es See also the Chip 8 emulator in section 11 3 2 page 119 11 1 1 2048 2048 is a simple addictive puzzle game played by moving tiles in around on a 4x4 grid Tiles slide as far as possible in the direction chosen by the player each turn until they are stopped by either another tile or the edge of the grid If two tiles of the same number collide while moving they merge into a tile with the total val...

Page 82: ...difficult blackjack is a game renowned for the strategy involved This version includes the ability to split buy insurance and double down For the full set of rules to the game and other fascinating information visit http www blackjackinfo com blackjack rules php Key Remote Key Action Enter betting amount Hit Draw new card Select Stay End hand Double down Pause game and go to menu Cancel 11 1 3 Bri...

Page 83: ... shoot bricks with paddle G Glue Ball sticks to paddle each time it hits B Ball Immediately fires another ball FL Flip Flip left right movement Key Remote Key Action Moves the paddle Release the ball Fire Open menu Quit 11 1 4 Bubbles Figure 11 3 Bubbles The goal of the game is to beat each level as quickly as possible by clearing the board of all bubbles Bubbles are removed from the board when a ...

Page 84: ...ded in the file and allow you to select the one you want to watch After that you can scroll back and forth through the moves of the game If the menu is invoked while in the viewer the user is allowed to select a new match from the same file or quit the game Force play while the computer is thinking will cause it to make its move immediately If done while it s your turn the computer will move for y...

Page 85: ...or the floor How long can you fly your chopper Key Remote Key Action Make chopper fly Enter menu 11 1 7 Dice Dice is a simple dice rolling simulator Select number and type of dice to roll in a menu and start by choosing Roll Dice The result is shown as individual numbers as well as the total of the rolled dice Key Remote Key Action Mode Mode Roll dice again Rec Rec Quit The Rockbox manual version ...

Page 86: ...om 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 This is the only time it can be accessed before starting the game To re adjust Rockdoom options you will need to quit your current game and restart the plugin Main Menu The Doom...

Page 87: ...nse statusbar InGame Main Menu This menu can only be accessed from within a running game and is displayed by New Game Start a new game Options In game options Load Game Load a saved game Save Game Save the current game Quit Quit the game InGame Options Menu This menu has the following options End Game Ends the current game Messages Enable or Disable in game messages Screen Size Shrink or Enlarge t...

Page 88: ...lipping the colour of the token under the cursor also flips the tokens above below left and right of the cursor The aim is to end up with a screen containing tokens of only one colour Key Remote Key Action Move the cursor Flip Shuffle Solve Solve step by step Quit the game 11 1 10 Goban Figure 11 8 Goban The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 89: ... very large SGF files will not even load on devices with little available memory Note The plugin does NOT support SGF files with multiple games in one file These b are rare but if you have one don t even try it the file will most likely be corrupted if you save over it You have been warned The file sgf gbn_def sgf is used by the plugin to store any unsaved changes in the most recently loaded game ...

Page 90: ...layback 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 you open this plugin Options Open the Options Menu Context Menu Open the Context Menu which allows you to set play modes and other tools Quit Leave the plugin Any unsaved changes are saved to sgf gbn_def sgf Game Info Th...

Page 91: ...e event which this game was a part of if any Place The place that this game took place Round If part of a tournament the round number for this game Done Return to the previous menu Options Customize the behavior of the plugin in certain ways Show Child Variations Enable this to mark child variations on he board if there are more than one Note variations which don t start with a move are not visibl...

Page 92: ...ding or removing stones as you cannot follow them by playing the same move Force Play Mode The same as Play Mode except that this mode will allow you to play illegal moves such as retaking a ko immediately without a ko threat suicide on rulesets which don t allow it including single stone suicide and playing a move where there is already a stone Mark Mode Add generic marks to the board or remove t...

Page 93: ...10 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 Mode Mode Play Rec Rec Exit the game 11 1 13 Jewels Figure 11 11 Jewels The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 94: ...Action Move the cursor around the jewels Select a jewel Menu 11 1 14 MazezaM Figure 11 12 MazezaM The goal of this puzzle game is to escape a dungeon consisting of ten mazezams These are rooms containing rows of blocks which can be shifted left or right You can move the rows only by pushing them and if you move the rows carelessly you will get stuck You can have another go by selecting retry level...

Page 95: ...ines are and avoid them When the player is certain that they know the location of a mine it can be tagged to avoid accidentally stepping on it Key Remote Key Action Move the cursor across the minefield Toggle flag on off Reveal the contents of the current square Display the current game status Exit the game 11 1 16 Pegbox Figure 11 14 pegbox To beat each level you must destroy all of the pegs If t...

Page 96: ... 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 that paddle passes to the player so for a single player game just press the appropriate buttons to control the side you want to play For a two player game both players should just press the appropriate buttons for their side Key Remote Key Action Left player up Left play...

Page 97: ...to play against a not very smart robot 11 1 19 Robotfindskitten Figure 11 16 Robotfindskitten In this game you are robot Your job is to find kitten This task is complicated by the existence of various things which are not kitten Robot must touch items to determine if they are kitten or not The game ends when robotfindskitten Key Remote Key Action Volume Up Volume Down Rewind Forward Forward Rewind...

Page 98: ...ll faster If the pile of blocks reaches the ceiling the game is over Key Remote Key Action Restart game Move left Move right Move down Rotate anticlockwise Rotate clockwise Drop Hold switch Pause Quit 11 1 21 Rockblox1d Rockblox1d is a game for people who find rockblox too hard In this version the second dimension is missing so the user only has to move the bricks down No horizontal moving anymore...

Page 99: ...be the album art of the currently playing music track if one exists see section C page 165 You can also use the sliding puzzle plugin as a viewer for supported image types to turn your own pictures into a puzzle Key controls Key Remote Key Action Move Tile Shuffle Switch between pictures default puz zle album art and your own image if launched via Open With and numbered tiles Stop the game 11 1 23...

Page 100: ... menu 11 1 24 Snake 2 Figure 11 20 Snake 2 The Snake Strikes Back Another version of the Snake game Move the snake around and eat the apples that pop up on the screen Each time an apple is eaten the snake gets longer The game ends when the snake hits a wall or runs into itself Key Remote Key Action Steer the snake Pause and resume the game Quit In game A the maze stays the same in game B after an ...

Page 101: ...re information about the level format see http sokobano de wiki index php title Level_format Key Remote Key Action In game Move the sokoban up down left or right Menu Back to previous level Restart level Go to next level Undo last movement Redo previously undone move Solution playback Pause resume Increase decrease playback speed Go backward forward while paused Quit Some places where can you can ...

Page 102: ... winning are rather low perhaps one in thirty hands For the full set of rules to the game and other interesting information visit http www solitairecentral com rules klondike html Key Remote Key Action Move Cursor around Select cards move cards reveal hidden cards If a card was selected unselect it else Draw 3 new cards from the remains stack Put the card from the top of the remains stack on top o...

Page 103: ...Key Remote Key Action Shoot Thrust Turn left right Teleport Pause game Quit 11 1 28 Star Figure 11 24 Star game This is a puzzle game It is actually a rewrite of Star a game written by CDK designed for the hp48 calculator 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 The ...

Page 104: ...es can be generated from the Generate menu option When playing an existing Sudoku game file from Rockbox file browser the plugin is invoked as viewer The selected Sudoku will get loaded and you can start solving it The sudoku games need to be stored as text files with the extension ss as single file per game You can create and save your own grids under the New menu option Enter the menu as describ...

Page 105: ...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 find ss files Simple Sudoku Advanced Puzzle Packs 1 and 2 located near the bottom of that page http www angusj com sudoku Kjell s Sudoku generator solver http kjell haxx se sudoku 11 1 30 Wormlet Figure 11 26 Wormlet game Wormlet is a multi worm game ...

Page 106: ...umstances Arghs have the annoying tendency to accumulate Worms Thou shall not eat worms Neither other worms nor thyself Eating worms is blasphemous cannibalism not healthy and causes instant death And it doesn t help anyway the other worm isn t hurt by the bite It will go on creeping happily and eat all the food you left on the table Walls Don t crash into the walls Walls are not edible Crashing a...

Page 107: ...rd entry displays Argh it means the worm is dead because it tried to eat an argh Until we can make the worm say Argh it is your job to say Argh aloud Wormed The worm tried to eat another worm or even itself That s why it is dead now Making traps for other players with a worm is a good way to get them out of the game Hints Initially you will be busy with controlling your worm Try to avoid other wor...

Page 108: ...n the way of enemy balls because if they hit you or your trail you lose a life To finish a level you have to section off more than 75 Key Remote Key Action Move around the arena Pause Open menu 11 2 Demos 11 2 1 Bounce Figure 11 28 Bounce This demo is of the word Rockbox bouncing across the screen In Scroll mode the bouncing text is replaced by a different one scrolling from right to left The Rock...

Page 109: ...ode moves on the sine curve on each axis Xsane Ysane Changes the appearance of the bouncing 11 2 2 Credits The credits plugin scrolls the entire list of the names of all the Rockbox contributors after displaying the Rockbox logo and version This plugin is called when selecting Version from the System section of the Rockbox main menu Exit at any time by pressing Rewind 11 2 3 Cube Figure 11 29 Cube...

Page 110: ...speed can not be changed while paused Quit 11 2 4 Demystify Figure 11 30 Demystify Demystify is a screen saver like demo Key Remote Key Action Rewind Forward Volume Down Volume Up Increase decrease speed Volume Up Volume Down Forward Rewind Add remove polygon Rec Rec Quit The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 111: ...rd Rewind Increase decrease number of flames Rewind Volume Down Toggle flame type Forward Volume Up Toggle moving flames Rec Rec Quit 11 2 6 Fractals Figure 11 32 Fractals Mandelbrot set This demonstration draws fractal images from the Mandelbrot set using the greyscale engine The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 112: ...Quit 11 2 7 Logo Demo showing the Rockbox logo bouncing around the screen Key Remote Key Action Forward Rewind Increase decrease speed on the x axis Volume Up Volume Down Increase decrease speed on the y axis Rec or Long Rec Quit 11 2 8 Mosaique Figure 11 33 Mosaique This simple graphics demo draws a mosaic picture on the screen of the player The Rockbox manual version rUnversioned directory 14121...

Page 113: ...o 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 Toggle filled curve plot Toggle whether to scroll or not Toggle drawing orientation Pause the demo Increase decrease volume Increase decrease speed Exit demo The Rockbox manual version rUnversioned direct...

Page 114: ... 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 Remote Key Action Volume Up Volume Down Scroll throug...

Page 115: ...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 Co...

Page 116: ...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 are ignored Everything on a line starting with an exclamation sign and including it is a comment and is ignored Key Remote Key Action Mode Mode Play pause Volume Down Rewind Change growth mode Forward Volume Up Next generation Rewind Volume Down Status only when...

Page 117: ... a VU meter which displays the volume of the left and right audio channels There are 3 types of meter selectable The analogue meter is a classic needle style The digital meter is modelled after LED volume displays and the mini meter option allows for the display of small meters in addition to the main display as above From the settings menu the decay time for the meter its memory the meter type an...

Page 118: ...Emulator ch8 Frotz z1 z8 Image Viewer bmp jpg jpeg png Lua scripting language lua Midiplay mid midi MPEG Player mpg mpeg mpv m2v MP3 Encoder wav x Rockboy gb gbc Search m3u m3u8 x Sort x Text Viewer txt nfo VBRfix mp3 x ZXBox tap tax sna z80 Shopping list shopper 11 3 1 Shortcuts The Shortcuts Plugin allows you to jump to places within the file browser without having to navigate there manually The...

Page 119: ...s just one entry If the list you are seeing is from shortcuts link in the root directory you can delete the selected entry by pressing Rec Deleting entries from other link files is not possible Advanced Usage Placing the line Display last path segments n where n is a number in the beginning of a link file will leave just the last n segments of the entries when they are shown For example if n is ch...

Page 120: ...ip8 emulators http www zophar net chip8 html 11 3 3 Frotz Frotz is a Z Machine interpreter for playing Infocom s interactive fiction games and newer games using the same format To start a game open a z1 z8 file in the File Browser Most modern games are in the z5 or z8 format but the older formats used by Infocom are supported Z Machine games are text based and most depend heavily on typed commands...

Page 121: ...e Press enter Rec Rec Open Frotz menu not available at MORE prompts Long Rec Quit 11 3 4 Image Viewer This plugin opens image files from the File Browser to display them using Rockbox s greyscale library Supported formats are as follows Format File extension s BMP bmp JPEG jpg jpe jpeg PNG png GIF gif Note When an audio file is playing the size of the image is limited as the decoding b process nee...

Page 122: ...ting language Select a lua file in the File Browser to run it For more information on programming in Lua please see http www lua org manual 5 1 and http www lua org pil There are a few exceptions additions to the Lua support in Rockbox No floating point support The number type in Lua is usually float however in the Rockbox implementation it is integer Non supported libraries The coroutine debug an...

Page 123: ...e Mpeg Player is a video player plugin capable of playing back MPEG 1 and MPEG 2 video streams with MPEG audio multiplexed into mpg files To play a video file you just select it in the Rockbox File Browser If your file does not have the mpg extension but is encoded in the supported format you will need to use the Open With context menu option and choose mpegplayer Key Remote Key Action Play Pause ...

Page 124: ...n the directory continuously Clear all resumes x Discard all x resume points Display Options Menu Dithering default off Prevent banding effects in gradients by blending of colours only available on Sansa e200 Sansa c200 and Gigabeat F X Display FPS default off This option displays once a second if your video is full screen this means it will get overwritten by the video and appear to flash once pe...

Page 125: ...wing 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 files with a sample rate of 16 22 05 or 24 kHz The same limitation is valid for mono files The output mp3 file is written to the same path as the wav file using the same fi...

Page 126: ... file to display it The text viewer features controls to handle various styles of text formatting and has top of file and bottom of file buttons You can view files without a txt or nfo extension by using Open with from the Context Menu see section 4 1 2 page 23 You can also bookmark pages Default keys Key Remote Key Action Volume Up Scroll up Volume Down Scroll down Rewind Top of file Narrow mode ...

Page 127: ...e Change how lines are displayed Normal Break lines at newline characters Join Join lines together Expand Add a blank line at newlines Useful for making paragraphs clearer in some book style text files Reflow Lines Justify the text Screens Per Page Set the number of screens per page Available options are 1 to 5 screens per page Alignment Set the text alignment Right Set the text alignment to the r...

Page 128: ...ar Toggle the vertical scrollbar for the current mode If the file fits on one screen there is no scrollbar and this setting has no effect 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 wh...

Page 129: ...ettings 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 Play Mode The bookmark will be displayed as shown below To delete the book...

Page 130: ...sed Never Remove Selecting this option will always skip deleting the file Always Remove Selecting this option will remove the file with no regard to whether it s used by another theme or not Font Specifies how the fnt file belonging to a theme cfg file is handled If this option is set to Remove if not Used the fonts came from rockbox fonts zip will not be removed as themes may depend on those font...

Page 131: ...1 43 ZXBox ZXBox is a port of the Spectemu ZX Spectrum 48k emulator for Rockbox Zproject s homepage To start a game open a tape file or snapshot saved as tap tzx z80 or sna in the file browser Note As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible b Default keys The emulator is set up for 5 different buttons Up Down Left Right and Jump Fire Each one of these can be mapped to...

Page 132: ...um keyboard Display Speed Toggle displaying the emulation speed in percent Invert Colours Inverts the Spectrum colour palette sometimes helps visibility Frameskip Sets the number of frames to skip before displaying one With zero frameskip ZXBox tries to display 50 frames per second Sound Turns sound on or off Volume Controls volume of sound output Predefined Keymap Select one of the predefined key...

Page 133: ...layer is shut down The battery is empty Benchmarks can be resumed if you accidentally load a plugin or turn off your player so long as the log file battery_bench txt is not deleted Information explained At the top of the battery_bench txt file is various information on how to use the plugin followed by the data themselves Time This column reports the total time of operation of the player It is not...

Page 134: ...ilar program Limitations As Battery Benchmark needs to write the data held in memory to disk in order to save them it is possible that should Rockbox shut down due to low battery then there will not be enough power remaining to write the data to disk Therefore all measurements since the previous save will be lost 11 4 2 Calculator Figure 11 44 Calculator This is a simple scientific calculator for ...

Page 135: ... players 1 10 Then set the total game time in mm ss Then the maximum round time is entered For example this could be used to play Scrabble for a maximum of 15 minutes each with each round taking no longer than one minute Done Player 1 starts in paused mode 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 al...

Page 136: ...the process The settings are stored in the plain text file rockbox rocks apps disktidy config that is user modifiable to allow custom entries to be added The asterisk character can be used as a wild card which will match any string however only the first asterisk will be recognised as a wild card with any additional uses being taken as literal Warning Be careful when you use custom entries as you ...

Page 137: ...te new entries delete entries and edit entries Each entry has a title a user name and a password Selecting Reset Keybox from the main menu will delete the current list of passwords and a new empty list will be created the next time you select Enter Keybox after prompting for a new master password Entries are automatically saved when the plugin is exited 11 4 6 Lamp Lamp is a simple plugin to use y...

Page 138: ...s 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 For each of the above directories the plugin searches for a subdirectory named Lyrics 3 Finally the plugin will search as above but within a directory call...

Page 139: ...d Go to the next track Long Forward Long Forward Fast forward in track Play Play Toggle play pause Long Play or Mode Long Play or Mode Exit the plugin Long Mode Long Mode Enter timetag editor Rec Menu Enter Lrcplayer Menu Lrcplayer Menu Theme settings Change theme related settings Show Statusbar Show hide the statusbar Display Title Show hide the track title Display Time Show hide the current time...

Page 140: ...ust the time press Long Mode to bring up a screen to adjust the time Changes will be saved automatically when the song is changed Editing words in lyrics is not supported 11 4 8 md5sum Open a file a directory or just launch it from the plugin menu to create an md5sum of the file the directory s contents or the whole filesystem If the file s extension is md5 or md5sum it will check the md5 sums in ...

Page 141: ... Open menu Long Rec Exit 11 4 12 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 directories which are scanned by creating a file called rockbox folder_advance_dir txt Only the directories ...

Page 142: ...e selected folder or its entire folder tree Rewind Rewind Exit 11 4 13 Resistor Calculator WARNING Image not found Figure 11 46 Resistor calculator The resistor calculator is a plugin that works in 3 modes Colour to Resistance In Colour to Resistance mode use the menus to select the colours of the bands of a resistor which you would like to know the resistance of Resistance to Colour In Resistance...

Page 143: ...on produces safe estimates but use your own judgement when using these output values Power rating and displayed resistance are rounded up to the nearest common value 11 4 14 Stats Figure 11 47 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 Long Rec to abort counting and ex...

Page 144: ...e shown on the screen You can now edit the file The Text Editor is line based This means you can edit one line at a time using the Virtual Keyboard see section 4 1 3 page 25 Move the selection bar to the line you want to edit Edit the highlighted text line or insert a new one using the Item Menu When finished editing exit the Text Editor You ll be shown a list of save options Note When you have no...

Page 145: ...item then The following configuration example will change the main menu so that it will contain only the items for the file browser for resuming the playback and for changing the settings the latter will be added automatically Example root menu order files wps To reset the menu items to the default use root menu order i e use a hyphen instead of items This configuration entry can only be created a...

Page 146: ...op in the File Browser and the menus The backdrop image must be a bmp file of the exact same dimensions as the display in your player 128 96 2 with the last number giving the colour depth in bits To use an image as a backdrop browse to it in the File Browser and open the Context Menu see section 4 1 2 page 23 on it and select the option Set As Backdrop If you want rockbox to remember your backdrop...

Page 147: ...hin the Settings Theme Settings menu 12 2 2 Themes Create Your Own The theme files are simple text files and can be created or edited in your favourite text editor To make sure non English characters display correctly in your theme you must save the theme files with UTF 8 character encoding This can be done in most editors for example Notepad in Windows 2000 or XP but not in 9x ME can do this File...

Page 148: ...her with the end of the file or with the next viewport declaration line Viewports sharing the same coordinates and dimensions cannot be displayed at the same time Viewports cannot be layered transparently over one another Subsequent viewports will be drawn over any other viewports already drawn onto that area of the screen Viewport Declaration Syntax V x y width height font Vf fgshade Vb bgshade V...

Page 149: ...ts Any viewport can be displayed either permanently or conditionally Defining a viewport as V will display it permanently Vl identifier This tag preloads a viewport for later display identifier is a single lowercase letter a z and the parameters use the same logic as the V tag explained above Vd identifier Display the identifier viewport Viewports can share identifiers so that you can display mult...

Page 150: ...V tag explained above VI label Set the Info Viewport to use the viewport called label as declared with the previous tag 12 2 4 Additional Fonts Additional fonts can be loaded within each screen file to be used in that screen In this way not only can you have different fonts between e g the menu and the WPS but you can use multiple fonts in each of the individual screens Fl id filename glyphs id is...

Page 151: ... but will most likely b be available at the end of a song We suggest you use the conditional display tag a lot when displaying information about the next song Alternating Sublines It is possible to group items on each line into 2 or more groups or sublines Each subline will be displayed in succession on the line for a specified time alternating continuously through each defined subline Items on a ...

Page 152: ...D3 artist and title are not present Display the filename continuously Note that by using a subline display time of 0 in one branch of a conditional a subline can be skipped not displayed when that condition is met Using Images You can have as many as 52 images in your WPS There are various ways of displaying images 1 Load and always show the image using the x tag 2 Preload the image with xl and sh...

Page 153: ...ultiple configuration files are permitted So for example you could have a car cfg file for the settings that you use while playing your jukebox in your car and a headphones cfg file to store the settings that you use while listening to your player through headphones See section 12 3 2 page 153 below for an explanation of the format for configuration files See section 12 3 3 page 154 for an explana...

Page 154: ...change settings A special case configuration file can be used to force a particular setting or settings every time Rockbox starts up e g to set the volume to a safe level Format a new configuration file as above with the required setting s and save it into the rockbox directory with the filename fixed cfg 12 3 3 The Manage Settings menu The Manage Settings menu can be found in the Main Menu The Ma...

Page 155: ... the battery runtime of your player The largest power savings can be achieved through disabling unneeded hardware components for some of those there are settings available Another area of savings is avoiding or reducing CPU boosting through disabling computing intense features e g sound processing or using effective audio codecs The following provides a short overview of the most relevant settings...

Page 156: ...rd disk which consumes a large amount of power while spinning up to several hundred mA The less often the hard disk needs to spin up for buffering and the shorter the buffering duration is the lower is the power consumption Therefore the bitrate of the audio files does have an impact on the battery runtime as well Lower bitrate audio files will result in longer battery runtime Please do not re enc...

Page 157: ...Appendix A File formats 157 The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 158: ...us are discarded Font fnt Change the user interface font to this one Rockbox firmware iaudio Load the new firmware with ROLO Image jpg View the JPEG image Link link Display list of target files and di rectories selecting one jumps to the target See section 11 3 1 page 118 Language File lng Load the language file Playlist m3u m3u8 Load the playlist and start playing the first file Video mpg mpeg mp...

Page 159: ... 2 3 Musepack mpc Supports SV7 and SV8 in mono stereo OGG Vorbis ogg oga Playback of some old floor 0 files may fail on low memory targets Files with album art larger than available RAM will be skipped Chained Ogg files are not supported Sony Audio oma aa3 rm ra rmvb Supports ATRAC3 RealAudio rm ra rmvb Supports RealAudio G2 Cook Speex spx Dialogic telephony type vox Windows Media Audio Standard w...

Page 160: ...less Audio flac Supports multichannel playback in cluding downmixing to stereo Apple Lossless m4a mp4 Shorten shn Seeking not supported True Audio tta Wave64 w64 Supports same formats as Wave form audio format Waveform audio format wav Linear PCM 8 16 24 32 bit IEEE float 32 64 bit ITU T G 711 a law µ law Microsoft ADPCM In tel DVI ADPCM IMA ADPCM 2 3 4 5 bit Dialogic OKI AD PCM YAMAHA ADPCM Adobe...

Page 161: ...stead of seconds MSX Konami Sound System kss Progress bar and seek use subtracks instead of seconds SMS GG CV Sound Format sgc Supports Sega Mas ter System and Game Gear Sound Format Progress bar and seek use subtracks instead of seconds Video Game Music Format vgm Gzipped Video Game Music Format vgz MOD mod NES Sound Format nsf nsfe Progress bar and seek use subtracks instead of seconds Atari SAP...

Page 162: ... x Wavpack x x x Atari Sound Format x Synthetic music Mobile Application Format x x Game Boy Sound Format x AY Sound Chip Music x Hudson Entertainment System Sound Format x MSX Konami Sound System x SMS GG CV Sound Format x Video Game Music Format x x Gzipped Video Game Music Format x x MOD x NES Sound Format x Atari SAP x Sound Interface Device x SPC700 x Note The seek implementations of NES Soun...

Page 163: ...asf Codec specific mmf mod nsf nsfe sap sid spc gbs ay kss sgc vgm None a52 ac3 adx oma aa3 aif aiff au snd shn vox w64 wav cmc cm3 cmr cms dmc dlt mpt mpd hes vgz B 2 1 Featureset for generic metadata tags Feature ID3 APE Vorbis MP4 ASF Embedded albumart bmp Embedded albumart jpg x x x x Embedded albumart png Embedded cuesheet x x Replaygain information x x x x x Title string x x x x x Artist str...

Page 164: ... nsfe gbs ay sgc vgm Genre tta spc sap Disc tta Track tta Year spc sid sap Composer mmf Comment spc rm ra rmvb vgm Albumartist None Grouping None B 2 3 Limitations of metadata handling 1 Multiple tags e g for Genre are not supported The first tag item of a set of multiple tags is used 2 Only one tag type is supported for each audio format 3 Overall there are 900 bytes available to load metadata st...

Page 165: ...ti scan JPEG files JPEG files must consist of a single scan with interleaved components as progessive and multi scan images require much more memory to decode C 2 Where to put album art The pictures can be named a number of different ways and placed to a number of different locations You can have pictures specific to the file or the album or use a generic picture You can place the picture in the s...

Page 166: ... bmp or albumartist albumtitle bmp Doublequotes will be replaced by single quotes If no album artist is set artist will be used instead See ZAlbumArt in the wiki for programs that will help you automate the process of putting album art on your player The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 167: ... will not be shown in the WPS D 2 Hardware Capabilities Tag Description cc Check for presence of a real time clock returns c when used unconditionally tp Does this target have a radio Tp Indicates that the target has a touchscreen With the above tags it is possible to find out about the presence of certain hardware and make the theme adapt to it This can be very useful for designing a theme that w...

Page 168: ...ports Tag Description V x y width height font Vf fgshade Vb bgshade See section 12 2 2 Vs mode param See section 12 2 2 Vl identifier Preloads a viewport for later display identifier is a single lowercase letter a z and the parameters use the same logic as the V tag explained above Vd identifier Display the identifier viewport E g C Vd a Vd b will show viewport a if album art is found and b if it ...

Page 169: ...conditional bl 1 0 1 2 N where the value 1 is used when the battery level isn t known it usually is The value N is only used when the battery level is ex actly 100 percent An image can also be used the propor tion of the image shown corresponds to the battery level bl x y width height image bmp bv The battery level in volts bt Estimated battery time left bp p if the charger is connected only on ta...

Page 170: ...che ay gbs hes sgc vgm kss unknown The codec or der is as shown above ff File Frequency in Hz fk File Frequency in kHz fm File Name fn File Name without extension fp File Path fs File Size in Kilobytes fv avg if variable bit rate or empty string if constant bit rate d N N th segment from the end of the file s directory N can be 1 2 3 Example for the d N commands If the file is Rock Kent Isola 11 7...

Page 171: ...pv Current volume in dB Can also be used in a conditional pv Mute 0 dB Above 0 dB Mute is 0 volume is the values between Mute and max 0 dB is max volume and Above 0 dB is amplified volume This can also be used like pb to provide a continuous scale pv x y width height image bmp pS Track is starting An optional number gives how many seconds the tag remains true for after the start of the track The d...

Page 172: ... either the track title from the tags or the filename The viewer will display as many tracks as will fit in the viewport D 11 Runtime Database Tag Description rp Song playcount rr 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 ra Autoscore for the song D 12 Sound DSP settings Tag Description Sp Current playback pitch xf Crossfade setting in the order Off ...

Page 173: ...ll One Shuffle A B D 16 Playback Mode Tag Description mp Play status 0 4 in the order Stop Play Pause Fast For ward Rewind Recording Recording paused FM Radio play ing FM Radio muted Example mp Stop Play Pause Ffwd Rew Rec Rec pause FM FM pause D 17 Current Screen Tag Description cs The current screen 1 20 in the order shown below The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 174: ...values will never be returned Examples You are in the cs Main menu WPS Recording screen FM Radio screen if cs 2 This is the WPS D 18 List Title sbs only Tag Description Lt Title text Should be used in a conditional so that non list screens don t show a title when they shouldn t Li Title icon This uses the same order as custom icons see ZCustomIcons in the wiki except that here 0 is no icon This ta...

Page 175: ...n produce neat effects when used with conditional viewports Example mv 2 5 Volume changing pv The example above will display the text Volume changing if the volume is being changed and 2 5 seconds after the volume button has been released After that it will display the volume value D 20 Settings Tag Description St setting name The value of the Rockbox setting with the specified name See section E ...

Page 176: ...if both x and y are not speci fied nimages optional number of sub images tiled vertically of the same height contained in the bitmap Default is 1 xd n i tag offset Display a preloaded image n image ID as it was specified in x or xl i optional number of the sub image to display a z for 1 26 and A Z for 27 52 ignored when tag is used Only useable if the ID is a single letter By default the first i e...

Page 177: ...n your player they can be displayed as follows Tag Description Cl x y maxwidth maxheight hor_align vert_align Define the settings for album art x x coordinate y y coordinate maxwidth Maximum height maxheight Maximum width hor_align Horizontal alignment enter as l c or r for left centre or right Centre is default vert_align Vertical alignment enter as t c or b for top centre or bottom Centre is def...

Page 178: ...ist usable in playlist viewer Tn Current preset name usable in playlist viewer Tf Current preset frequency usable in playlist viewer Tc Preset count i e the number of stations in the current preset list tx Is RDS available ty RDS name tz RDS text tr Signal strength RSSI Can be used in a conditional or as a bar It is also possible to show Radio Art which can be used to display images associated wit...

Page 179: ... left centre right If the aligned texts overlap they are merged Example ax V D 24 Conditional Tags Tag Description xx true false If Else Evaluate for true or false case xx alt1 alt2 alt3 else Enumerations Evaluate for first second third last condition if tag operator operand option count Allows very simple comparisons with other tags tag the tag to check against operator the comparison to perform ...

Page 180: ...l items sublines onto one line with the display cycling round the defined sublines See section 12 2 4 page 151 for details D 26 Text Translation Tag Description Sx English Display the translation of English in the current language English must be a phrase used in the language file It should match the Source line in the language file Note checkwps cannot verify that the string is correct so please ...

Page 181: ...the desired image backdrop draw a preloaded image under the bar The full image will be displayed and must be the same size as the bar This must be followed by the label of the desired image nofill don t draw the bar only its frame for use with the slider option noborder don t draw the border for image less bars instead maximise the filling over the specified area This doesn t work for bars which s...

Page 182: ...nt it will assume the substring is a number so it can be used with conditionals i e cM 0 is the first conditional option Tag Description The character The character The character The character The character The character The character The character The character s Indicate that the line should scroll Can occur anywhere in a line given that the text is displayed see conditionals above You can speci...

Page 183: ...iskip 5s 15s 30s 1min 2min 3min 5min 10min N A volume fade on off N A sort case on off N A show files all supported music playlists N A show filename exts off on unknown view_all N A follow playlist on off N A playlist viewer icons on off N A playlist viewer indices on off N A playlist viewer track display track name full path N A recursive directory insert on off ask N A scroll speed 1 to 25 Hz s...

Page 184: ...city devise a way to get ranges from config h mAh qs top any setting name for none N A qs bottom any setting name for none N A qs left any setting name for none N A qs right any setting name for none N A shortcuts instead of quickscreen off on N A idle poweroff off 1 2 3 4 5 6 7 8 9 10 15 30 45 60 min sleeptimer duration 5 to 300 in steps of 5 min sleeptimer on startup off on N A keypress restarts...

Page 185: ...A warn when erasing dynamic playlist on off N A cuesheet support on off N A folder navigation off on random N A constrain next folder off on N A gather runtime data off on N A skip length outro track 1s 2s 3s 5s 7s 10s 15s 20s 1min 90s 2min 3min 5min 10min 15min N A prevent track skip on off N A start in screen previous root files dB wps menu recording radio bookmarks N A playlist catalog director...

Page 186: ...240 to 240 eq peak filter 5 cutoff in Hz q 0 to 64 gain 240 to 240 eq peak filter 6 cutoff in Hz q 0 to 64 gain 240 to 240 eq peak filter 7 cutoff in Hz q 0 to 64 gain 240 to 240 eq peak filter 8 cutoff in Hz q 0 to 64 gain 240 to 240 eq high shelf filter cutoff in Hz q 0 to 64 gain 240 to 240 0 1 dB dithering enabled on off N A timestretch enabled on off N A compressor threshold 0 to 24 3 dB comp...

Page 187: ...N A font path filename fnt N A kbd path filename kbd N A invert on off N A flip display on off N A selector type pointer bar inverse N A show icons on off N A iconset path filename bmp N A viewers iconset path filename bmp N A backdrop path filename bmp N A rec quality 0 to 7 0 small size 7 high quality rec frequency 48 44 32 24 22 16 kHz rec source mic line spdif N A rec channels mono stereo N A ...

Page 188: ...Appendix F Menu Overview 188 F Menu Overview include an overview of the menu structure here The Rockbox manual version rUnversioned directory 141216 Iaudio M3 ...

Page 189: ...hat happened Whether the problem is repeatable or a one time occurrence All relevant data regarding the problem such as playlists MP3 files etc IMPORTANT G 2 Feature ideas To suggest an idea for a feature or to read those made by others see http forums rockbox org index php board 49 0 Please keep in mind that this forum is for the dis cussion of feature ideas they are not requests and there is no ...

Page 190: ...d them Add scandisk like features It would be a very slow operation that would drain the batteries and take a lot of useful ram for something that is much better and faster done when connected to a host computer Alphabetical list skipping Skipping around the lists by jumping letters i e skip all C s and go straight to the first D This isn t feasible with the current list implementation if you real...

Page 191: ... Dang Ngoc Pierre De lore Huw Smith Garrett Derner Barry McIntosh Leslie Donald son Lee Pilgrim Zakk Roberts Francois Boucher Matthias Wien tapper Brent Coutts Jens Arnold Gerald Vanbaren Christi Scarbor ough Steve Cundari Mat Holton Jan Gajdos Antoine Cellerier Brian King Jiri Jurecek Jacob Erl beck Jean Philippe Bernardy Dave Hooper Jonas Häggqvist Thom Johansen Rinat Zakirov Manuel Dejonghe Mar...

Page 192: ...dam Gashlin Robert Kukla David Quesada Jared Stafford Martin Hensel Stéphane Doyon Austin Appel Andre Smith Travis Hyyppa Ian Webber Pavel Gnelitsa Lutz Böhne Will Robertson Robert Carboneau Ye Wei Bryan Childs Mike Schmitt Chris Taylor Tobias Langhoff Steve Gotthardt Greg White Mattieu Favréaux Malcolm Tyrrell Piotr Jafis zow Gary Allen John BouAntoun Tomasz Mon Jakub Matoušek Al bert Veli Chris ...

Page 193: ...Eric Lassauge François Dinel Francesco Rigoni Joël Puik Klaas Bosteels Teruaki Kawashima Marcin Łukasik Le Jin Alex Ben nee Stéphane Quertinmont Bartosz Fabianowski Adam Hogan Andrew Mahone Anton Veretenenko Vi cente Ibarra Rui Araújo Brian Cloutier Olivier Barbut Yoshi hisa Uchida Sanggon Lee Kaspar Rothenfußer Ryan Press Craig El liott Kenderes Tamas Eric Shat tow Joshua Simmons Sei Aoyumi Marti...

Page 194: ...r Arsuaga Vencislav Atanasov Mauricio Garrido Nick Peskett Michael Goerner Richard Brittain Andrew Ryabinin Maksim Postolati Stanislav Chizhik Desu Rozen Olivier Kaloudoff Kessia Pinheiro Jean Louis Biasini Lorenzo Miori James Hunt Artur Juraszek Wieland Hoffmann Nathan Ko rth Igor Petelin Cástor Muñoz Albert Barca Fukuda Takafumi Dimitar Dimitrov Osborne Jacobs Marty Miller Eduardo Gonzalez Enric...

Page 195: ...copyleft license designed for free software We have designed this License in order to use it for manuals for free software be cause free software needs free documentation a free program should come with manuals providing the same freedoms that the software does But this License is not limited to software manuals it can be used for any textual work regardless of subject matter or whether it is publ...

Page 196: ...s available to the general public that is suitable for re vising the document straightforwardly with generic text editors or for images composed of pixels generic paint programs or for drawings some widely available drawing edi tor 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...

Page 197: ...the same conditions stated above and you may publicly display copies 3 COPYING IN QUANTITY If you publish printed copies or copies in media that commonly have printed covers of the Document numbering more than 100 and the Document s license notice requires Cover Texts you must enclose the copies in covers that carry clearly and legibly all these Cover Texts Front Cover Texts on the front cover and...

Page 198: ...rsion if the original publisher of that version gives permission B List on the Title Page as authors one or more persons or entities responsible for authorship of the modifications in the Modified Version together with at least five of the principal authors of the Document all of its principal authors if it has fewer than five unless they release you from this requirement C State on the Title page...

Page 199: ... matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document you may at your option designate some or all of these sections as invariant To do this add their titles to the list of Invariant Sections in the Modified Version s license notice These titles must be distinct from any other section titles You may add a section Entitled Endorsements pr...

Page 200: ...ased under this License and replace the individual copies of this License in the various docu ments 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 individ ually under this License provided you insert...

Page 201: ... the Document is void and will automatically terminate your rights under this License However parties who have received copies or rights from you under this License will not have their licenses terminated so long as such parties remain in full compliance 10 FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new revised versions of the GNU Free Doc umentation License from tim...

Page 202: ...ont Cover Texts and Back Cover Texts replace the with Texts line with this with the Invariant Sections being LIST THEIR TITLES with the Front Cover 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 prog...

Page 203: ...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 ...

Page 204: ...t all the notices that refer to this License and to the absence of any warranty and give any other recipients of the Program a copy of this License along with the Program You may charge a fee for the physical act of transferring a copy and you may at your option offer warranty protection in exchange for a fee 2 You may modify your copy or copies of the Program or any portion of it thus forming a w...

Page 205: ...o do one of the following a Accompany it with the complete corresponding machine readable source code which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange or b Accompany it with a written offer valid for at least three years to give any third party for a charge no more than your cost of physically performing source distribution a...

Page 206: ...nditions You may not impose any further restrictions on the recipients exercise of the rights granted herein You are not responsible for enforcing compliance by third parties to this License 7 If as a consequence of a court judgment or allegation of patent infringement or for any other reason not limited to patent issues conditions are imposed on you whether by court order agreement or otherwise t...

Page 207: ...on or of any later version published by the Free Software Foundation If the Program does not specify a version number of this License you may choose any version ever published by the Free Software Foundation 10 If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different write to the author to ask for permission For software which is copyrigh...

Page 208: ... the copyright line and a pointer to where the full notice is found one line to give the program s name and a brief idea of what it does Copyright C year name of author This program is free software you can redistribute it and or modify it un der the terms of the GNU General Public License as published by the Free Software Foundation either version 2 of the License or at your option any later vers...

Page 209: ... any to sign a copyright disclaimer for the program if necessary Here is a sample alter the names Yoyodyne Inc hereby disclaims all copyright interest in the program Gnomovision which makes passes at compilers written by James Hacker signature of Ty Coon 1 April 1989 Ty Coon President of Vice This General Public License does not permit incorporating your program into propri etary programs If your ...