Iaudio M5, Manual

Page 1: ...The Rockbox Manual for Iaudio M5 rockbox org April 30 2017...

Page 2: ...003 Jos Maria Garcia Valdecasas Bernal Peter Schlenker Version 3 14 Built using pdfL A TEX Permission is granted to copy distribute and or modify this document under the terms of the GNU Free Document...

Page 3: ...box 17 2 5 1 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...

Page 4: ...the Main Menu 39 5 2 Navigating the Main Menu 39 5 3 Recent Bookmarks 40 5 4 Files 40 5 5 Database 41 5 6 Now Playing Resume Playback 41 5 7 Settings 41 5 7 1 Sound Settings 41 5 7 2 Playback Settings...

Page 5: ...ain 58 7 10 Track Skip Beep 59 7 11 Auto Change 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 B...

Page 6: ...10 8 Prerecord Time 80 10 9 Clear Recording Directory 81 10 10 Clipping Light 81 10 11 Trigger 81 11 Time and Date 83 12 Plugins 84 12 1 Games 84 12 1 1 2048 84 12 1 2 Blackjack 85 12 1 3 Boomshine 86...

Page 7: ...Xobox 115 12 1 37 XWorld 116 12 2 Demos 116 12 2 1 Bounce 116 12 2 2 Credits 117 12 2 3 Cube 117 12 2 4 Demystify 118 12 2 5 FFT 118 12 2 6 Fire 118 12 2 7 Fractals 119 12 2 8 Logo 119 12 2 9 Matrix 1...

Page 8: ...4 10 Lamp 151 12 4 11 Lrcplayer 152 12 4 12 Main Menu Configuration 155 12 4 13 md5sum 155 12 4 14 Metronome 155 12 4 15 One Time Password Client 159 12 4 16 Advanced Settings 160 12 4 17 Periodic Ta...

Page 9: ...Audio format and bitrate 176 13 5 6 Sound settings 176 A File formats 177 A 1 Supported file formats 177 B Audio and metadata formats 178 B 1 Supported audio formats 178 B 1 1 Lossy Codecs 178 B 1 2...

Page 10: ...album art 196 D 22 Alignment and language direction 197 D 23 Conditional Tags 198 D 24 Subline Tags 198 D 25 Time and Date 199 D 26 Text Translation 199 D 27 Bar Tags 199 D 27 1 Options 200 D 28 Other...

Page 11: ...een put into 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 Y...

Page 12: ...th icons on 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 fi...

Page 13: ...graphical application that does almost everything for you However should you encounter a problem then the manual way is still available to you There are two separate components which need to be insta...

Page 14: ...wiki page When first starting Rockbox Utility run Autodetect found in the configuration dialog File Configure Autodetection can detect most player types If autodetection fails or is unable to detect t...

Page 15: ...th the release Please now go to section 2 2 3 page 16 to complete the installation procedure 2 2 2 Manual Installation The manual installation method is still available to you should you need or desir...

Page 16: ...arger 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 t...

Page 17: ...riginal Iaudio software connect the player to your computer download the original Iaudio M5 firmware from the Iaudio website and copy it to the FIRMWARE directory on your Iaudio M5 Turn off the player...

Page 18: ...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 o...

Page 19: ...the connector for the Iaudio subpack or dock On the top of the unit is a charge indicator light which may feel a bit like a button but is not From the top of the player on the left hand side is the h...

Page 20: ...a list view presented The navigation in these lists are usually the same and should be pretty intuitive In the tree view use Down and Up to move around the selection Use Select Right or Play to selec...

Page 21: ...refer to the screen from which the context menu gets called One example is the playback menu which can be called using the context menu from within the WPS 3 2 Customising Rockbox Rockbox User Interf...

Page 22: ...the music on 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...

Page 23: ...Context Menu Rec Menu Enter the Main Menu Long Rec Long Menu Switch to the Quick Screen see sec tion 5 12 page 44 4 1 2 Context Menu Figure 4 2 The Context Menu The Context Menu allows you to perform...

Page 24: ...nditions explained in section 13 1 5 page 166 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 appropria...

Page 25: ...The virtual keyboard This is the virtual keyboard that is used when entering text in Rockbox for example when renaming a file or creating a new directory The virtual keyboard can be easily changed by...

Page 26: ...your audio files Rockbox builds and maintains a database of the music files on your player and allows you to browse them by Artist Album Genre Song Name etc The criteria the database uses to sort the...

Page 27: ...You can force Rockbox to rescan your disk for tagged files by using the Initialize Now function in the Database Menu Warning Initialize Now removes all database files removing runtimedb data also and...

Page 28: ...can browse your music by Artist Al bum Genre Song Name etc To use the database go to the Main Menu and select Database Note You may need to increase the value of the Max Entries in File Browser b set...

Page 29: ...ystem 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 r...

Page 30: ...track Right Forward Go to the next track Long Right Long Forward Fast forward in track Play Play Toggle play pause Long Play Long Play Stop playback Select Mode Return to the File Browser Database Lon...

Page 31: ...0 dB 50 dB 60 dB 4 3 3 The WPS Context Menu Like the context menu for the File Browser the WPS Context Menu allows you quick access to some often used functions Playlist The Playlist submenu allows yo...

Page 32: ...back 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 be displayed in the WPS an...

Page 33: ...igher 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 r...

Page 34: ...or 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...

Page 35: ...playlist By 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...

Page 36: ...Insert new tracks 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...

Page 37: ...menu in the 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 Movin...

Page 38: ...n be selected through the File Browser When loading a playlist from disk it will replace the current dynamic playlist Through the Playlist catalogue The Playlist catalogue offers a shortcut to all pla...

Page 39: ...t accesses the 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...

Page 40: ...olume Up Select the previous bookmark Select Right or Play Forward Resume from the selected bookmark Left or Power Left Exit Recent Bookmark menu Long Rec Long Rec Delete the currently selected bookma...

Page 41: ...o some other 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...

Page 42: ...apsed and the 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 a...

Page 43: ...anually created playlists can be edited using this menu Create Playlist Rockbox will create a playlist with all tracks in the current directory and all sub directories The playlist will be created one...

Page 44: ...m with Rockbox If you think you have messed up your settings by use of this menu please try to reset all settings before asking for help 5 12 Quick Screen Although the Quick Screen is accessible from...

Page 45: ...shortcut type data what the shortcut actually links to name what the shortcut should be displayed as icon number of the theme icon to use see ZCustomIcons talkclip filename of a talk clip to speak wh...

Page 46: ...want the file browser to start inside a folder make b sure the data has the trailing slash i e Music instead of Music Without the trailing slash it will cause the file browser to open with Music sele...

Page 47: ...r volume Values higher than 0 dB are available and can be used to raise the volume more than would otherwise be possible These volume levels will ordi narily lead to distorted sound but might work nic...

Page 48: ...so in what 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 m...

Page 49: ...as speakers 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 le...

Page 50: ...2 The graphical equalizer Rockbox features a parametric equalizer EQ In contrast to non parametric equalizers a parametric EQ enables adjusting the center frequency gain and width of EQ bands separat...

Page 51: ...almost always undesirable Bands 1 8 Peaking filters Peaking EQ filters boost or lower a frequency range cen tered at the centre frequency chosen Graphic equalizers in home stereos are usually peaking...

Page 52: ...aunted 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 adjust...

Page 53: ...s intended for speech playback and may significantly dilute your listening experience with more complex audio See section 4 3 3 page 33 for more details about how to use the feature 6 12 Haas Surround...

Page 54: ...ing limit This is desirable because the compressed signal without makeup gain is quieter than the input signal Makeup Gain in Auto restores the signal to the maximum possible level and brings the quie...

Page 55: ...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 c...

Page 56: ...buffer can 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 th...

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

Page 58: ...in to apply Album Gain Maintain a constant volume level between albums but keep any intentional volume variations between songs in an album If album gain value is not available uses track gain informa...

Page 59: ...e requires you to first generate a folder list via the Random Folder Advance Configuration plugin see section 12 4 19 page 161 Note You must have the Repeat option set to No for Auto Change Directory...

Page 60: ...hanges the behaviour of the Left and Right 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...

Page 61: ...ettings 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 ve...

Page 62: ...als with options 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 file...

Page 63: ...are shown No files or directories are hidden Supported The File Browser displays all directories and files supported by Rockbox see section A 1 page 177 Files and directories starting with dot or wit...

Page 64: ...unt 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 se...

Page 65: ...emote LCD Settings This sub menu contains settings that relate to the display of the remote Backlight Similar to the main unit backlight this option controls the backlight timeout for the remote contr...

Page 66: ...ling methods 1 always scrolling the text to the left until the line has ended and then beginning again at the start and 2 moving to the left until you can read the end of the line and then scrolling r...

Page 67: ...to Logarithmic dB scale the volume values are scaled logarithmically The volume meters of digital audio devices usually are scaled this way On the other hand if you are interested in the power level t...

Page 68: ...ng through the File Browser When the hard disk spins up to fill the audio buffer it automatically spins down afterwards Directory Cache Rockbox has the ability to cache the contents of your drive in R...

Page 69: ...in a car Car Adapter Mode automat ically stops playback on the player when power i e from cigarette lighter power adapter to the external DC in jack is turned off If the Car Adapter Mode is set to On...

Page 70: ...Lock Off device locked Lock Button Pressed 3 device unlocked Disable Notify Suppresses the notification Buttons Locked still will if power button is pressed Note This is a pre requisite for selective...

Page 71: ...ilable 8 6 3 Sleep Timer The Sleep Timer powers off your player after a given time whether playing or not Start Sleep Timer duration Shown when the Sleep Timer is inactive this option will initiate a...

Page 72: ...No Do not create bookmarks Yes Always create bookmarks Ask Ask if a bookmark should be created Yes Recent Only Always create a bookmark but only in the recent bookmarks list Ask Recent Only Ask if a...

Page 73: ...g keys can be used to navigate in any bookmark list Key Remote Key Action Down Volume Down Selects the next bookmark Up Volume Up Selects the previous bookmark Select Right or Play Forward Resumes fro...

Page 74: ...resume This option enables or disables automatic resume globally When Rockbox detects that the database which is needed for this feature has not been initialized yet it asks whether it should be initi...

Page 75: ...see below Use Directory talk Clips This option turns on the use of talk clips for directories On Use special pre recorded files _dirname talk in each directory These must be generated in advance and...

Page 76: ...option turns on voicing of file types when Voice Filenames is set to Spell or Numbers When Voice Directories is set to Spell Directory will be voiced after each spelled out directory Announce Battery...

Page 77: ...e installed fonts on your player Selecting one will activate it See section 13 1 3 page 165 for further details about fonts While Playing Screen Opens the File Browser in the rockbox wps directory and...

Page 78: ...ar on the remote display Volume Display Controls whether the volume is displayed as a graphic or a nu meric value on the Status Bar If you select a numeric display volume is displayed in decibels See...

Page 79: ...our recording 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 bit...

Page 80: ...e 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 Splittin...

Page 81: ...trigger features 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...

Page 82: ...triangular 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 t...

Page 83: ...e 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 Roc...

Page 84: ...Menu 12 1 Games See also the Chip 8 emulator in section 12 3 2 page 127 Frotz in section 12 3 3 page 128 Rockboy in section 12 3 9 page 133 and ZXBox in section 12 3 17 page 141 12 1 1 2048 Figure 12...

Page 85: ...e palm of your hand The rules are simple try to get as close to 21 without going over or simply beat out the dealer for the best hand Although this may not seem difficult blackjack is a game renowned...

Page 86: ...r more Sometimes a special item falls down when you destroy a brick For a special item to take effect you must catch it with the paddle Look out for the bad ones Special items Displayed Name Descripti...

Page 87: ...e things more difficult the entire board is shifted down every time a certain number of shots have been fired Points are awarded depending on how quickly the level was completed Key Remote Key Action...

Page 88: ...hile it s your turn the computer will move for you and flip the board so that you are playing from the other side If you want you can force play an entire game and watch the artificial intelligence fi...

Page 89: ...12 7 Doom This is the famous Doom game Getting started For the game to run you need wad game files located in rockbox doom on your player Create the directory and save the following files there rockdo...

Page 90: ...ptions Menu This menu has the following options Sound Enable or Disable sound in Doom Set Keys Change the game key configuration Time Demo Run a timed demo to test game speed on a player Only runs on...

Page 91: ...ght Select Shoot Play Open Power InGame Menu Select Enter Rec Change Weapon Playing the game After installation of the wad files is complete you can start the game more description is needed 12 1 10 F...

Page 92: ...can load all modern SGF files file format 3 or 4 with few problems It attempts to preserve SGF properties which it doesn t understand and most common SGF properties are handled fully It is possible t...

Page 93: ...g variations which can be navigated to using the Next Vari ation menu option of the Context Menu C There is a comment at the current node It can be viewed edited using the Add Edit Comment menu option...

Page 94: ...result of the current game This text must follow the format specified at http www red bean com sgf properties html RE to be read by other SGF readers Some examples are B R Black wins by resignation B...

Page 95: ...llow variations by simply playing the first move in the sequence Unless it is following a variation this mode will not allow you to play illegal moves This is the default mode before another is set af...

Page 96: ...click on it until it cycles through the allowed letters and disappears Add Edit Comment Add or edit a comment at the current node Done Go back to the previous screen 12 1 12 Invadrox Figure 12 10 Inva...

Page 97: ...addicting game which involves swapping pairs of jewels in order to form connected segments of three or more of the same type The goal of the game is to score as many points as possible before running...

Page 98: ...New Maze Select Mode Display solution toggle 12 1 16 MazezaM Figure 12 13 MazezaM The goal of this puzzle game is to escape a dungeon consisting of ten mazezams These are rooms containing rows of blo...

Page 99: ...uncovered then the number of mines adjacent to the current square is revealed The aim is to use the information you are given to work out where the mines are and avoid them When the player is certain...

Page 100: ...1455babaf26e0b396c78d2b45f8f6 pacman 5f 9240f35d1d2beee0ff17195653b5e405 pacman 6e 290aa5eae9e2f63587b5dd5a7da932da pacman 6f 19a886fcd8b5e88b0ed1b97f9d8659c0 pacman 6h d7cce8bffd9563b133ec17ebbb6373d...

Page 101: ...16 pegbox To beat each level you must destroy all of the pegs If two like pegs are pushed into each other they disappear except for triangles which form a solid block and crosses which allow you to c...

Page 102: ...le 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...

Page 103: ...an be found in the internet You can choose to play manually you place both the white and dark pieces or to play against a not very smart robot 12 1 23 Robotfindskitten Figure 12 20 Robotfindskitten In...

Page 104: ...ter If the pile of blocks reaches the ceiling the game is over Key Remote Key Action Play Restart game Left Move left Right Move right Down Move down Select Power Rotate anticlockwise Up Rotate clockw...

Page 105: ...album art of the currently playing music track if one exists see section C page 184 You can also use the sliding puzzle plugin as a viewer for supported image types to turn your own pictures into a pu...

Page 106: ...2 1 28 Snake 2 Figure 12 24 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 ge...

Page 107: ...nformation about the level format see http sokobano de wiki index php title Level_format Key Remote Key Action In game Up Down Left Right Move the sokoban up down left or right Power Menu Rec Restart...

Page 108: ...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 Up Down Left Right...

Page 109: ...being hit by them Once in a while a UFO will appear shoot this for extra points Key Remote Key Action Select Shoot Up Thrust Left Right Turn left right Down Teleport Play Pause game Power Quit 12 1 32...

Page 110: ...n and a viewer When starting Sudoku from the Browse Plugins menu a random game will be generated automatically and an estimate of its difficulty very easy easy medium hard or fiendish will be displaye...

Page 111: ...and 2 located near the bottom of that page http www angusj com sudoku Kjell s Sudoku generator solver http kjell haxx se sudoku 12 1 34 Superdom Superdom is a turn based strategy game where the aim i...

Page 112: ...on food Each year you are allocated an amount of food based on the number of farms you control Food is used to feed your men but if you do not have enough food to feed your population of men some will...

Page 113: ...that you steer it across It won t distinguish whether it is edible or not Food The small square hollow pieces are food Move the worm over a food tile to eat it After eating the worm grows Each time a...

Page 114: ...the state of worm 1 the second worm 2 and the third worm 3 When a worm dies its entry on the score board turns black Len Here the current length of the worm is displayed When a worm is eating food it...

Page 115: ...e opponent and that food From now on you can control the other worm by blocking it You could trap it by making a 1 pixel wide U turn You also could move from food to food and make sure you keep betwee...

Page 116: ...directory before the game can be played Additionally extra data files that modify the in game strings and font can be placed in the rockbox xworld directory with the names xworld strings and xworld fo...

Page 117: ...dits 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...

Page 118: ...olume 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 analyzer with 3 different frequency amplitude plots line...

Page 119: ...t This demonstration draws fractal images from the Mandelbrot set using the greyscale engine Key Remote Key Action Direction keys Move about the image Select Zoom in Long Select Zoom out Long Play Dec...

Page 120: ...visual demo resembling the scrolling code from The Matrix https en wikipedia org wiki The_Matrix 12 2 10 Mosaique Figure 12 37 Mosaique This simple graphics demo draws a mosaic picture on the screen o...

Page 121: ...is less responsive to user input and music may start to skip Keys Key Remote Key Action Select Toggle filled curve plot Rec Toggle whether to scroll or not Long Select Toggle drawing orientation Play...

Page 122: ...m 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 Left Right Scroll through albums Up Down Scroll through track...

Page 123: ...cover art or not at all Resize Covers Set whether to automatically resize the covers or to leave them at their original size Rebuild cache Rebuild the PictureFlow cache This is needed in order for Pic...

Page 124: ...ne starting with an exclamation sign and including it is a comment and is ignored Key Remote Key Action Select Mode Play pause Down Rewind Change growth mode Right Volume Up Next generation Left Volum...

Page 125: ...lled 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...

Page 126: ...mes should be full absolute names i e they should start with a Directory names should also end with a How to create link files You can use your favourite text editor to create a link file on the PC an...

Page 127: ...ollowed by your custom name That name will then be used for showing the entry For example Example MyMusic collection song mp3 TAB My favourite song 12 3 2 Chip 8 Emulator Chip8 is a kind of assembly l...

Page 128: ...nes and for typing single characters when the game requires single character input Sounds pictures colour and Unicode are not currently supported but the interpreter informs the game of this and almos...

Page 129: ...ying the size of the image is limited as the decoding b process needs to share memory with audio tracks To be able to view a bigger file you may need to stop playback Key Remote Key Action Up Down Lef...

Page 130: ...Non supported libraries The coroutine debug and math libraries are not supported Partially supported libraries The os and package libraries are only partially supported Additional libraries The bitlib...

Page 131: ...n Adjust volume up down Left Right Rewind Fast Forward Rec Open the MPEG Player menu When a video file is selected the Start Menu will be displayed unless it is disabled via the Resume Options see bel...

Page 132: ...mes skipped see the Skip Frames option the current time in 100 Hz ticks and the time the current frame is due to be displayed Limit FPS default on With this option disabled mpegplayer will display the...

Page 133: ...iles 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 filename To use this plugin ope...

Page 134: ...12 3 10 Search This plugin can be used on playlists It searches through the playlist that it opened on looking for any occurrences of the string entered by the user The results of this search are sav...

Page 135: ...iew mode then that item will be removed from the list When you exit Shopper the last view is saved including which items you have se lected so if you re open the shopping list it will be as you left i...

Page 136: ...saccades when reading 12 3 14 Text Viewer Figure 12 46 Text Viewer This is a Viewer for text files with word wrap Just open a txt or nfo file to display it The text viewer features controls to handle...

Page 137: ...in Extended CP1250 Central European SJIS Japanese GB 2312 Simple Chinese KSX 1001 Korean BIG5 Traditional Chinese UTF 8 Unicode This setting only applies to the plugin and is independent from the Defa...

Page 138: ...ttings The scrolling settings submenu Horizontal Submenu for horizontal scrolling settings Scrollbar Toggle the horizontal scrollbar for the current mode If the file fits on one screen there is no scr...

Page 139: ...mode is set to Reflow Lines Available options are 0 to 5 spaces If you select 0 a blank line is displayed as an indent Show Playback Menu Display the playback menu to allow control of the currently p...

Page 140: ...ove Theme is selected in the menu One of the following options can be chosen for each setting Ask for Removal Selecting this option brings up a dialogue with two options press Select to confirm deleti...

Page 141: ...heme cfg file is handled Create Log File Setting this to No prevents the log file from being created Quit Exits this plugin 12 3 16 VBRfix This function scans a VBR Variable Bitrate MP3 file and updat...

Page 142: ...Spectrum keyboard Controls are the same as in standard Rockbox but you just press one key instead of entering a phrase Play Pause Tape Toggles playing of the tape if it is loaded Save Quick Snapshot S...

Page 143: ...imple but fast scaling to the screen by dropping lines and columns some games can become unplayable It is possible to hack graphics to make them better visible with the help of an utility such as the...

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

Page 145: ...ory 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 sin...

Page 146: ...ou can select what day is first day of week by the setting First Day of Week in the menu Key Remote Key Action Left Right Up Down Move the selector Select Show memos for the selected day Rec Play Prev...

Page 147: ...e below is the time remaining for that round and possibly also the total time left if different Keys are as follows Key Remote Key Action Rec Exit plugin Power Restart round for the current player Pla...

Page 148: ...mode display Mode Selector Opens a menu from which you can select a clock mode to view Counter Settings Opens a menu from which you can adjust settings pertaining to the counter Mode Settings Opens a...

Page 149: ...he Date readout if enabled is displayed at the bottom center The Second readout if in Text mode is displayed at the top center if in Bar mode is displayed as a progress bar at the top of the LCD if in...

Page 150: ...thing you will see is the text input screen Type part of a word or the whole word or anything the dict files have a definition to and accept the text input The plugin will search for matching entries...

Page 151: ...start up the plugin and select Enter Keybox The first time you enter Keybox you will be prompted for a master password and for confirmation of the master password The master password is the password t...

Page 152: ...8 encoded The Lyrics3 tag is not supported Supported tags and formats for lrc files The following tags are supported ti title ar artist offset offset msec Each line should resemble one of the followin...

Page 153: ...ed Lyrics The name of this directory can be customized see below If the audio file currently playing is Music Artist Album Title mp3 then the fol lowing files will be searched for in this order ext is...

Page 154: ...settings Show Statusbar Show hide the statusbar Display Title Show hide the track title Display Time Show hide the current time Backlight Force On Do not turn off the backlight while displaying the ly...

Page 155: ...n Move Item Up Swap the selected menu item with the previous one Move Item down Swap the selected menu item with the next one Load Default Configuration Discards all customization Exit Save your chang...

Page 156: ...yback of a preprogrammed metronome track consisting out of multiple parts each with possibly different properties In contrast to the simple mode there exists the notion of meter and bars along with em...

Page 157: ...s in tempomap files follows the format defined by http das nasophon de klick Actually the goal is to keep compatibility between klick and this Rockbox metronome The parts of a track are specified one...

Page 158: ...xXxX shuffle 0 12 12 120 x xX xx xX funky 0 16 16 120 x x X X Xx X X The 12 12 for the shuffle create 1 4 triplets Just do a bit of math This is still a metronome not a drum machine but it can act lik...

Page 159: ...ovide a scannable QR code that encodes a OTP URI In order to use those first scan the QR code separately and save the URI to a file on your device If necessary rewrite the URI so it is in the format s...

Page 160: ...ime adjustment it is located under the Advanced submenu NOTE in the UI simulator use the UTC setting no matter what the clock may read 12 4 17 Periodic Table The periodic table plugin allows easy brow...

Page 161: ...y to be ignored If you just want CDs to be ignored but want to include the folders within it you need to have both CDs and CDs as entries Edit Folder List Enter the folder list editor Export List To T...

Page 162: ...istor that you would like to know the colour code of The colour codes are presented textually LED resistance LED resistance calculator is used to determine the resistor necessary to light an LED safel...

Page 163: ...ayer Press Rec or Power to abort counting and exit the plugin Press it again to quit after counting has finished 12 4 22 Stopwatch Figure 12 56 Stopwatch A simple stopwatch program with support for sa...

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

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

Page 166: ...e ZLangFiles 13 1 5 Loading Backdrops Rockbox supports showing an image as a backdrop in the File Browser and the menus The backdrop image must be a bmp file of the exact same dimensions as the displa...

Page 167: ...also allows you to control certain aspects of the appearance of the menus browsers There are a number of themes included in Rockbox and you can load one of these at any time by selecting it in Setting...

Page 168: ...e full syntax will be explained later in this section All elements placed before the line defining a viewport are displayed in the default viewport Elements defined after a viewport declaration are dr...

Page 169: ...style to mode from this point forward Mode can be the following Mode Description clear Restore the default style invert Draw lines inverted color Draw the text coloured by the value given in param Fun...

Page 170: ...g this is strongly recommended since it makes you able to use the SBS with other themes If label is set this viewport can be selectivly used as the Info Viewport using the VI tag The parameters use th...

Page 171: ...about to play after the one currently playing unless you change the plan If you use the upper case versions of the three tags F I and D they will instead refer to the next song instead of the current...

Page 172: ...on of the conditional Example subline with conditionals Example it t 8 s it s fn ia t 3 s ia t 0 The format above will do two different things depending if ID3 tags are present If the ID3 artist and t...

Page 173: ...iple settings through the use of configuration files A configuration file is simply a text file with the extension cfg A configuration file may reside anywhere on the disk Multiple configuration files...

Page 174: ...guration files that control only the volume and LCD settings Create a few different files with different settings give each file a different name such as car cfg headphones cfg etc and you can then us...

Page 175: ...he cfg extension and is used to store all of the theme related settings 13 4 Firmware Loading 13 4 1 Using ROLO Rockbox Loader Rockbox is able to load and start another firmware file without rebooting...

Page 176: ...the fastest decoding audio format will be the best in terms of battery runtime on your player An overview of different codec s performance on different players can be found at ZCodecPerformanceCompar...

Page 177: ...ont 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 selecti...

Page 178: ...2 5 Layer 1 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 wi...

Page 179: ...w Free Lossless 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 Wa...

Page 180: ...ubtracks instead 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 Progre...

Page 181: ...o format x x 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 Soun...

Page 182: ...ASF wma wmv 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 gen...

Page 183: ...spc sid nsf 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 Mu...

Page 184: ...ive and multi scan JPEG files JPEG files must consist of a single scan with interleaved components as progressive and multi scan images require much more memory to decode C 2 Where to put album art Th...

Page 185: ...albumtitle bmp or albumartist albumtitle bmp Doublequotes will be replaced by single quotes If no album artist is set artist will be used instead See ZAlbumArt in the wiki for programs that will help...

Page 186: ...line which 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 In...

Page 187: ...ed D 4 Viewports Tag Description V x y width height font Vf fgshade Vb bgshade See section 13 2 2 Vs mode param See section 13 2 2 Vl identifier Preloads a viewport for later display identifier is a s...

Page 188: ...used in a 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...

Page 189: ...ce mpcsv8 aache 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...

Page 190: ...track time 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 T...

Page 191: ...sition then 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 rati...

Page 192: ...ple mm Off All 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 Examp...

Page 193: ...radio some 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...

Page 194: ...hanged It can 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...

Page 195: ...aults to 0 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...

Page 196: ...e present on 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 Maximu...

Page 197: ...ar Align the text right aR Align the text right or to the left if RTL language is in use ax The next tag should follow the set language direction When prepended to a viewport declaration the viewport...

Page 198: ...ll the tag parameters are true or tag1 tag2 tagN Logical or operator Will be evaluate to true if any of the tag parameters are true Examples of the if tag if pv 0 Clipping possible Volume OK will disp...

Page 199: ...a Weekday name cb Month name cu Day of week from 1 to 7 1 is Monday cw Day of week from 0 to 6 0 is Sunday D 26 Text Translation Tag Description Sx English Display the translation of English in the cu...

Page 200: ...e label of 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...

Page 201: ...his is present 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 chara...

Page 202: ...low N A antiskip 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...

Page 203: ...y devise a way to get ranges from config h mAh car adapter mode on off N A 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 a...

Page 204: ...xt 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 ro...

Page 205: ...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 of...

Page 206: ...ilename bmp N A viewers iconset path filename bmp N A backdrop path filename bmp N A rwps path filename rwps N A remote contrast 5 to 63 N A remote invert on off N A remote flip display on off N A rem...

Page 207: ...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 8 00 16 00 24 00...

Page 208: ...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: ...u did and what 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 ide...

Page 210: ...to understand 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 conne...

Page 211: ...ler Frederic 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...

Page 212: ...r Ginkel Adam 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...

Page 213: ...Wallace 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 An...

Page 214: ...av 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...

Page 215: ...which is a 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 sh...

Page 216: ...cification is 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 dra...

Page 217: ...opies under 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 Documen...

Page 218: ...previous version 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 M...

Page 219: ...s new front 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 invarian...

Page 220: ...cuments released 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...

Page 221: ...distribute 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 lice...

Page 222: ...Sections Front Cover Texts and Back Cover Texts replace the with Texts line with this with the Invariant Sections being LIST THEIR TITLES with the Front Cover Texts being LIST and with the Back Cover...

Page 223: ...tions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the software or if...

Page 224: ...y keep intact 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...

Page 225: ...hat you also 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 customa...

Page 226: ...erms and conditions 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 Licens...

Page 227: ...that version 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 S...

Page 228: ...ave at least 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 fre...

Page 229: ...r school if 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...