background image

Chapter 12. Plugins

123

12.3.5. Lua scripting language

To quote from the Lua website (

http://www.lua.org

), Lua is a “powerful, fast, lightweight,

embeddable scripting 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 and math libraries are not supported.

Partially-supported libraries.

The os and package libraries are only partially supported.

Additional libraries.

The bitlib library is integrated to support bitwise operators. See

http://luaforge.net/projects/bitlib

and

http://lua-users.org/wiki/BitwiseOperators

.

Documentation of the API is still a work in progress, and the API itself is not finalised.

For the latest information, see

Z

PluginLua

.

Note:

Please note that if a script does not provide a way to exit, then the only way to

b

exit will be to reset the player.

12.3.6. Midiplay

To get MIDI file playback, a patchset is required. This file contains the instruments
required to synthesize the music. A sample patchset is available through the wiki at

Z

PluginMidiPlay

and needs to be extracted to the

.rockbox

directory in the root of

your player. There should now be a

/.rockbox/patchset/

directory, with the patchset

directory containing several

.pat

files and two

.cfg

files. Just select a MIDI file with

either the

.mid

or

.midi

extension in the file browser to start playback.

Key

Action

Volume Up

/

Volume Down

Volume up/ Volume down

Right

/

Left

Skip 3 seconds forward/ backward

Play

Pause/Resume playback

Power

Stop playback and quit

The Rockbox manual

(version 3.14)

Sansa Clip v2

Summary of Contents for Sansa Clip v2

Page 1: ...The Rockbox Manual for Sansa Clip v2 rockbox org April 30 2017...

Page 2: ...3 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 Documentat...

Page 3: ...2 3 Running Rockbox 17 2 4 Updating Rockbox 17 2 5 Uninstalling Rockbox 18 2 5 1 Automatic Uninstallation 18 2 5 2 Manual Uninstallation 18 2 6 Troubleshooting 18 3 Quick Start 19 3 1 Basic Overview...

Page 4: ...playlists 37 4 4 6 Loading saved playlists 37 5 The Main Menu 38 5 1 Introducing the Main Menu 38 5 2 Navigating the Main Menu 38 5 3 Recent Bookmarks 39 5 4 Files 39 5 5 Database 39 5 6 Now Playing...

Page 5: ...6 7 5 Fade on Stop Pause 56 7 6 Party Mode 56 7 7 Crossfade 56 7 8 Replaygain 57 7 9 Track Skip Beep 58 7 10 Auto Change Directory 58 7 11 Constrain Auto Change 59 7 12 Last fm Log 59 7 13 Cuesheet Su...

Page 6: ...8 10 1 Format 78 10 2 Encoder Settings MP3 only 78 10 3 Frequency 78 10 4 Source 78 10 5 Channels 79 10 6 Mono Mode 79 10 7 File Split Options 79 10 8 Prerecord Time 79 10 9 Clear Recording Directory...

Page 7: ...Spacerocks 104 12 1 30 Star 105 12 1 31 Sudoku 105 12 1 32 Wormlet 107 12 1 33 Xobox 109 12 1 34 XWorld 109 12 2 Demos 110 12 2 1 Bounce 110 12 2 2 Credits 111 12 2 3 Cube 111 12 2 4 Demystify 111 12...

Page 8: ...12 4 6 Clock 140 12 4 7 Dict 142 12 4 8 Disk Tidy 142 12 4 9 Keybox 143 12 4 10 Lamp 143 12 4 11 Lrcplayer 144 12 4 12 Main Menu Configuration 146 12 4 13 md5sum 147 12 4 14 Metronome 147 12 4 15 One...

Page 9: ...3 Peak Meter 166 13 5 4 Audio format and bitrate 166 13 5 5 Sound settings 166 A File formats 167 A 1 Supported file formats 168 B Audio and metadata formats 169 B 1 Supported audio formats 169 B 1 1...

Page 10: ...FM Radio 187 D 23 Alignment and language direction 188 D 24 Conditional Tags 188 D 25 Subline Tags 189 D 26 Time and Date 189 D 27 Text Translation 190 D 28 Bar Tags 190 D 28 1 Options 190 D 29 Other...

Page 11: ...n 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 You...

Page 12: ...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 find...

Page 13: ...to access the player On Windows this means you need to know the drive letter associated with the player On Linux you need to know the mount point of your player On Mac OS X you need to know the volum...

Page 14: ...x 2 2 1 Automated Installation To automatically install Rockbox download the official installer and housekeeping tool Rockbox Utility It allows you to Automatically install all needed components for u...

Page 15: ...the release version and the current build there is also an archive of daily builds available for download These are built once a day from the latest source code in the repository For a manual install...

Page 16: ...lip Sansa Clip Firmware 01 01 35 amp 02 01 35 Release td p 144965 The bootloader http download rockbox org bootloader sandisk sansa clipv2 bootloader clipv2 sansa The version of mkamsboot for your ope...

Page 17: ...rt 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...

Page 18: ...y an unmodified original firmware to your player and then reboot into the Sandisk firmware See section 3 1 3 page 20 for more information If you wish to clean up your disk you may also wish to delete...

Page 19: ...controls are a four way pad with a button in the centre pressing this centre button functions as Select Going clockwise from the top the four way pad contains the Play Right Submenu and Left buttons...

Page 20: ...ransfer method that you would use to copy files between drives e g Drag and Drop Files may be placed wherever you like on the player but it is strongly suggested NOT to put them in the rockbox folder...

Page 21: ...every time you play an audio file a so called dynamic playlist is generated unless you play a saved playlist You can modify the dynamic playlist while playing and also save it to a file If you do not...

Page 22: ...s 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 ins...

Page 23: ...he 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 M...

Page 24: ...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 directory a...

Page 25: ...wer by hand For example this function can be used to view a text file even if the file has a non standard extension i e the file has an extension of something other than txt See section 12 3 page 118...

Page 26: ...xt page of characters if there is more than one Play Submenu Move the cursor on the virtual keyboard If you move out of the picker area you get to the line edit mode Flip to the next page of character...

Page 27: ...still be scanned place a file named database unignore in it The files in that directory and its subdirectories will be scanned and added to the database 4 2 3 The Database Menu Load To RAM The databas...

Page 28: ...t 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 fo...

Page 29: ...tem 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 ren...

Page 30: ...ning of track or if pressed while in the first seconds of a track go to the previous track Long Left Rewind in track Right Go to the next track Long Right Fast forward in track Play Toggle play pause...

Page 31: ...ors of the right and left channel there are little dots These dots represent important volume values In linear mode each dot is a 10 mark In dBFS mode the dots represent the following values from righ...

Page 32: ...ngs 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...

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

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

Page 35: ...t 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 add...

Page 36: ...t except queued tracks are deleted immediately from the playlist after they have been played Also queued tracks are not saved to the playlist file see section 5 10 page 43 Queue Next Queue track s imm...

Page 37: ...k to be moved and confirm with Select or Right To remove a track simply select Remove in the context menu 4 4 5 Saving playlists To save the current playlist either enter the Playlist submenu in the W...

Page 38: ...will save settings when it accesses the flash storage the next time for example when refilling the music buffer or navigating through the File Browser Changes to settings may therefore not be saved u...

Page 39: ...kmark Select or Right Resume from the selected bookmark Left Exit Recent Bookmark menu Home Delete the currently selected bookmark Long Select Enter the context menu for the selected bookmark There ar...

Page 40: ...roperties 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 set...

Page 41: ...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 time...

Page 42: ...ected Some preset files are available here ZFmPresets It is also possible to record the FM radio while listening To start recording enter the FM radio settings menu with Long Select and then select Re...

Page 43: ...created manually by either using the Context Menu see section 4 1 2 page 24 or using the Playlist menu Both automatically and manually created playlists can be edited using this menu Create Playlist R...

Page 44: ...x 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 13 Quick Screen Although the Quick Screen is accessible from nearly everyw...

Page 45: ...hortcut 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 when...

Page 46: ...ant 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 select...

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

Page 48: ...Custom Allows you to manually specify a stereo width with the Stereo Width setting described later in this chapter Mono Left Plays the left channel in both stereo channels Mono Right Plays the right...

Page 49: ...ced in front of the listener The result is a more natural stereo image that can be especially appreciated in older rock and jazz records where one instrument is often hard panned to just one of the sp...

Page 50: ...justed to cover a wider lower Q or narrower higher Q range of frequencies In some ways the EQ is similar to the Bass and Treble settings described earlier but the EQ allows you to control the sound mu...

Page 51: ...ow much each band is adjusted and works as for the low shelf filter Finally the Q parameter controls how wide or narrow the affected fre quency range is Higher Q values will affect a narrower band of...

Page 52: ...ametric EQ may wish to use the presets instead of trying to configure the EQ or use the presets for designing their own custom EQ settings 6 10 Dithering This setting controls the dithering and noise...

Page 53: ...proportion mixed from the original dry and effected wet signals 6 13 Perceptual Bass Enhancement This setting implements a group delay correction and an additional biophonic EQ to emphasize to boost...

Page 54: ...hreshold For example the 2 1 setting means that for each two decibels of input signal above the threshold the compressor will only allow the output to appear as one decibel The higher the ratio the ha...

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: ...s and launching plugins 7 7 Crossfade This section controls the behavior of the crossfader The crossfader when enabled smoothly fades one track into the next This can occur in two situations an automa...

Page 57: ...t and the next song will simultaneously fade in If set to Mix the ending song will not fade out at all and will continue to play as normal until its end with the starting song fading in from under it...

Page 58: ...uld clip during playback the volume is lowered for that song Replaygain information is needed for this to work Pre amp This allows you to adjust the volume when replaygain is applied Replaygain often...

Page 59: ...ers are displayed on the progressbar and it is possible to skip between the tracks within the cuesheet Also the information found in the cuesheet file will replace the information from the ID3 tags Wh...

Page 60: ...nd 60 seconds Note This option does not apply to resuming a paused track Use the next option for b rewinding on pause Note The actual rewind distance may differ a little from the requested value depen...

Page 61: ...s 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 files...

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

Page 63: ...t 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 sett...

Page 64: ...the following parameters Scroll Speed Sets how many times per second the automatic horizontal scrolling text will move a step Scroll Start Delay Controls how many milliseconds Rockbox should wait befo...

Page 65: ...the peak indicator displays the loudest volume value that occurred within the last 5 seconds Larger values are useful if you want to find the peak level of a song which might be of interest when copyi...

Page 66: ...time Rockbox responds Turning this setting on activates the directory cache and turning it off deactivates the directory cache Note The first time you enable the directory cache Rockbox will request...

Page 67: ...e DC in jack is turned back on before the Idle Poweroff function has shut the player off playback will be resumed 5 seconds after the power is applied This delay is to allow for the time while the car...

Page 68: ...n is pressed Note This is a pre requisite for selectivebacklight section 8 4 page 63 b to work also during key lock Selected actions are indicated by a leading Note If all options get de selected the...

Page 69: ...ayer a wired remote control device This mode is can be useful for lecturers who does not have a wireless remote control for this purpose Key Action Play Slideshow start Home Slideshow leave Left Slide...

Page 70: ...l start in The default is the main menu but the following options are available Previous Screen Start Rockbox in the same screen as when it was shut off Main Menu Show the main menu Files Display the...

Page 71: ...ersistent see section E page 193 Start Sleep Timer On Boot If set a Sleep Timer will be initiated when the device starts Restart Sleep Timer On Keypress If set when a Sleep Timer is active and a key i...

Page 72: ...reate bookmarks but only want to add them to already existing bookmark files In this case you should set the setting Bookmark on Stop to No and the setting Update on Stop to Yes Load Last Bookmark Thi...

Page 73: ...through tracks in the current playlist As an exception when a track is resumed by loading a bookmark the playback position saved in the bookmark takes precedence Optionally you can also enable automat...

Page 74: ...the cursor In order for this to work a voice file must be present in the rockbox langs directory on the player Voice files are large and are not shipped with Rockbox by default The voice file is the n...

Page 75: ...this explicitly see below Use File talk Clips This option turns on the use of talk clips for files On Use special pre recorded files for each file This functions the same as for directories except th...

Page 76: ...page 156 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 Left will exit back to the m...

Page 77: ...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 in...

Page 78: ...pressed 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 96 kHz 88 2...

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

Page 80: ...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 the trigger s...

Page 81: ...ion 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 v...

Page 82: ...rt up at the specified time Use Right and Left to adjust the minutes setting Left and Right to adjust the hours Select confirms the alarm and Power cancels setting an alarm If the player is turned on...

Page 83: ...n section 12 3 3 page 121 and ZXBox in section 12 3 16 page 133 12 1 1 2048 Figure 12 1 2048 2048 is a simple addictive puzzle game played by moving tiles in around on a 4x4 grid Tiles slide as far as...

Page 84: ...egy 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...

Page 85: ...must catch it with the paddle Look out for the bad ones Special items Displayed Name Description N Normal Returns paddle to normal D Die Ball dies lose a life L Life Gain a life F Fire Allows you to...

Page 86: ...ight Aim the bubble Select Fire bubble Power or Long Power Exit to menu 12 1 6 Chessbox Figure 12 5 Chessbox Chessbox is a one person chess game with computer artificial intelligence The chess engine...

Page 87: ...me saved save the current position and start a new game without having to quit the game Keys Key Action Direction keys Move the cursor Select Pick up Drop piece Home Change level Volume Up Force play...

Page 88: ...orts a maximum number of 10 addons A free alternative for Doom 2 is FreeDoom http freedoom sourceforge net This can be used in place of doom2 wad or it may be used as an addon in Doom by placing it in...

Page 89: ...Headsup Display Show the player status when in fullscreen Statusbar Always Red Disable colour response statusbar InGame Main Menu This menu can only be accessed from within a running game and is displ...

Page 90: ...tart the game more description is needed 12 1 10 Flipit Figure 12 8 Flipit Flipping the colour of the token under the cursor also flips the tokens above below left and right of the cursor The aim is t...

Page 91: ...on the order of a minute or two on particularly slow devices Large SGF files may stop audio playback for the duration of the plugin s run in order to free up more memory and some very large SGF files...

Page 92: ...tree Power Main Menu Home Go to the next variation when at the first node in a branch Menus Main Menu The main menu for game setup and access to other menus New Create a new game with your choice of b...

Page 93: ...The NZ and GOE rulesets include suicide as a legal move for multi stone suicide only the rest do not Black Player The name of the black player Black Rank Black s rank in dan or kyu Black Team The nam...

Page 94: ...perform captures or count as ko threats Erase Stone Mode Remove stones from the board as desired These removed stones are not counted as captured they are simply removed Pass Play a single pass move T...

Page 95: ...r to form connected segments of three or more of the same type The goal of the game is to score as many points as possible before running out of available moves Higher points are awarded to larger com...

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

Page 97: ...lay Submenu Left Right Move the cursor across the minefield Select Volume Down Toggle flag on off Long Select Volume Up Reveal the contents of the current square Select Play Display the current game s...

Page 98: ...control the side you want to play For a two player game both players should just press the appropriate buttons for their side Key Action Volume Up Left player up Volume Down Left player down Play Rig...

Page 99: ...cated by the existence of various things which are not kitten Robot must touch items to determine if they are kitten or not The game ends when robotfindskitten Key Action Play Submenu Left Right Move...

Page 100: ...to move the bricks down No horizontal moving anymore and no need to rotate the brick Key Action Submenu Move down faster Power or Long Power Quit 12 1 24 Sliding Puzzle Figure 12 20 Sliding puzzle Th...

Page 101: ...igure 12 21 Snake This is the popular snake game The aim is to grow your snake as large as possible by eating the dots that appear on the screen The game will end when the snake touches either the bor...

Page 102: ...maze is replaced by a new one 12 1 27 Sokoban Figure 12 23 Sokoban The object of the game is to push boxes into their correct position in a crowded warehouse with a minimal number of pushes and moves...

Page 103: ...evel sets may contain levels that are too large for this version of Sokoban and are unplayable as a result 12 1 28 Solitaire Figure 12 24 Klondike solitaire This is the classic Klondike solitaire game...

Page 104: ...sor on one of the 4 final colour stacks Volume Up Put the card on top of the remains stack on one of the final colour stacks Power Show menu 12 1 29 Spacerocks Figure 12 25 Spacerocks Spacerocks is a...

Page 105: ...filled circle to get to places on the screen it could not otherwise reach The block cannot take o s Key Action Left Move Left Right Move Right Play Move Up Submenu Move Down Select Switch between cir...

Page 106: ...be done with the scratchpad shown as separate column Change the number under the cursor to the number you want to put on the scratchpad and press the scratchpad button the number will then be added If...

Page 107: ...or not Food The small square hollow pieces are food Move the worm over a food tile to eat it After eating the worm grows Each time a piece of food has been eaten a new piece of food will pop up somewh...

Page 108: ...its entry on the score board turns black Len Here the current length of the worm is displayed When a worm is eating food it grows by one pixel for each step it moves Hungry That s the normal state of...

Page 109: ...n You also could move from food to food and make sure you keep between your opponent and the food So you can always reach it before your opponent 12 1 33 Xobox Figure 12 29 Xobox Xobox is a simple clo...

Page 110: ...d Crouch Left Right Move Left and Right Select Action and Fire Power Menu 12 2 Demos 12 2 1 Bounce Figure 12 30 Bounce This demo is of the word Rockbox bouncing across the screen There is also an anal...

Page 111: ...is plugin is called when selecting Version from the System section of the Rockbox main menu Exit at any time by pressing Left 12 2 3 Cube Figure 12 31 Cube This is a rotating cube screen saver in 3D K...

Page 112: ...ic frequency analyzer with 3 different frequency amplitude plots lines bars and spectrogram 12 2 6 Fire Figure 12 33 Fire Fire is a demo displaying a fire effect Key Action Play Submenu Increase decre...

Page 113: ...h more detail Home Reset and return to the default image Power Quit 12 2 8 Logo Demo showing the Rockbox logo bouncing around the screen Key Action Right Left Increase decrease speed on the x axis Pla...

Page 114: ...scope This demo shows the shape of the sound samples that make up the music being played At faster speed rates the player is less responsive to user input and music may start to skip Keys Key Action S...

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

Page 116: ...ll 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...

Page 117: ...rks 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 Action Select Play pause Submenu Change growth...

Page 118: ...ters in addition to the main display as above From the settings menu the decay time for the meter its memory the meter type and the meter scale can be changed Key Action Power Save settings and quit H...

Page 119: ...you can use the context menu on either a file or a directory in the file browser tree and use the Add to shortcuts menu option This will append a line with the full name of the file or the directory...

Page 120: ...bly language for a long gone architecture This plugin runs games written using the chip8 instructions To start a game open a ch8 file in the File Browser There are lots of tiny Chip8 games usually onl...

Page 121: ...d Unicode are not currently supported but the interpreter informs the game of this and almost all games will adapt so that they are still playable This port of Frotz attempts to be compliant with the...

Page 122: ...Down Previous image in directory Home Toggle slide show mode Power Show menu Abort The menu has the following entries Return Returns you to the image Toggle Slideshow Mode Enables or disables the sli...

Page 123: ...d http lua users org wiki BitwiseOperators Documentation of the API is still a work in progress and the API itself is not finalised For the latest information see ZPluginLua Note Please note that if a...

Page 124: ...via the Resume Options see below In the latter case the video will start playing immediately Start Menu Play from beginning Resume information is discarded and the video plays from the start Resume a...

Page 125: ...nt frame is due to be displayed Limit FPS default on With this option disabled mpegplayer will display the video as fast as it can Useful for benchmarking Skip frames default on This option causes mpe...

Page 126: ...es 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 open...

Page 127: ...ch This plugin can be used on playlists It searches through the playlist that it opened on looking for any occurrences of the string entered by the user The results of this search are saved to a new p...

Page 128: ...f you select an item in view 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...

Page 129: ...op of file Narrow mode One screen left Wide mode Right Bottom of file Narrow mode One screen right Wide mode Play One line up Submenu One line down Home Toggle autoscroll Submenu Select Set Reset book...

Page 130: ...ges such as Arabic or Hebrew Left Set the text alignment to the left Show Header Select whether to show the header The header displays the file path No Do not display the header Yes Display the header...

Page 131: ...n is re tained when scrolling pages No Do not retain previous line Yes Retain previous line Auto scroll Speed Control the speed of auto scrolling in number of lines per second Available options are 1...

Page 132: ...heme Open the Context Menu see section 4 1 2 page 24 upon a theme cfg file and select Open With theme_remove Some files are not removed regardless of the Remove Options such as rockbox_default wps and...

Page 133: ...heme cfg file is han dled Iconset Specifies how the iconset bmp file belonging to a theme cfg file is han dled Viewers Iconset Specifies how the viewers iconset bmp file belonging to a theme cfg file...

Page 134: ...trum 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 Saves...

Page 135: ...aphics Due to ZXBox s simple but fast scaling to the screen by dropping lines and columns some games can become unplayable It is possible to hack graphics to make them better visible with the help of...

Page 136: ...u 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 h...

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

Page 138: ...n select what day is first day of week by the setting First Day of Week in the menu Key Action Left Right Play Submenu Move the selector Select Show memos for the selected day Volume Up Volume Down Pr...

Page 139: ...e below is the time remaining for that round and possibly also the total time left if different Keys are as follows Key Action Power Exit plugin Submenu Restart round for the current player Select Pau...

Page 140: ...which you can adjust settings pertaining to the counter Mode Settings Opens a menu from which you can adjust settings pertaining to the current clock mode analog digital binary General Settings Reset...

Page 141: ...onds pass a fully inverted LCD means the entire minute has passed The Counter if displayed is shown at the upper left The Blinking Colon if enabled blinks the colon once every second 12 hour mode if e...

Page 142: ...ption meaning contained in the dict desc file If no matches are found on the dictionary a Not found message will be displayed and the plugin will exit You can do another search by relaunching the plug...

Page 143: ...of the master password The master password is the password that you must use to access your stored passwords Once inside enter the context menu by pressing Long Select From the context menu you can c...

Page 144: ...d time tag word time tag The time tag must be in the form mm ss mm ss xx or mm ss xxx where mm is minutes ss is seconds xx is tenth of milliseconds and xxx is milliseconds Any other tags and lines wit...

Page 145: ...tle ext Lyrics Musics Title ext Lyrics Title ext Controls Key Action Volume Up Volume Down Volume up down Left Go to beginning of track or if pressed while in the first seconds of a track go to the pr...

Page 146: ...nges its time to the current position of the track To set a specific time or to adjust the time press Long Select to bring up a screen to adjust the time Changes will be saved automatically when the s...

Page 147: ...ead of wearing headphones at a concert Simple Interactive Mode This is the mode of operation that is active when starting the plugin directly from the menu It offers a uniform metronome sound at a con...

Page 148: ...label is Interlude the meter is 3 4 and the tempo 120 quarter beats per minute bpm The volume setting is at 25 and this is the second part of a track with 13 total In that part the position is at the...

Page 149: ...pattern that controls how the beats are played Symbol Meaning X emphasized beat Tick x normal beat Tock silent beat Some examples default 0 4 4 120 Xxxx rockon2 0 4 4 120 xXxX solea 0 12 4 180 xxXxxXx...

Page 150: ...o be on a line by itself in the following format otpauth hotp OR totp account name secret Base32 secret counter X period X di An example is shown below provisioning a TOTP key for an account called bo...

Page 151: ...ronized with UTC time and second that the plugin knows what time zone the clock is using The plugin will prompt you on its first run for this piece of information However should this setting need chan...

Page 152: ...ng in the CDs directory to be ignored If you just want CDs to be ignored but want to include the folders within it you need to have both CDs and CDs as entries Edit Folder List Enter the folder list e...

Page 153: ...e 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 safely at a given voltage Fir...

Page 154: ...or This plugin allows you to view and edit simple text documents on your DAP You can view files by using Open with from the Context Menu see section 4 1 2 page 24 Usage If you start the Text Editor fr...

Page 155: ...u have not changed the file the Text Editor will quit immediately b Key Action Select or Right Edit Line Select Character Left Exit Abort Editing Home Show Item Menu Long Select Delete Line The Rockbo...

Page 156: ...t 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 157: ...ximum of 24 characters long If your language is not yet supported and you want to write your own language file find the instructions on the Rockbox website ZLangFiles 13 1 5 UI Viewport By default the...

Page 158: ...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 Files Locations Each different...

Page 159: ...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 font is a number 0 is the built in system font 1 is the...

Page 160: ...ort through the SBS file and to conditionally select different UI viewports Vi label This viewport is used as Custom UI Viewport in the case that the theme doesn t have a ui viewport set in the theme...

Page 161: ...f the tag has no value The WPS parser will always display the last part if the tag has no value or if the list of alternatives is too short Next Song Info You can display information about the next so...

Page 162: ...or 2 seconds Display current and remaining track time for 3 seconds repeat Conditionals can be used with sublines to display a different set and or number of sublines on the line depending on the eval...

Page 163: ...ia id id pb pc pt That is tracknum title artist album where most fields are only displayed if avail able Could also be rendered as filename or tracknum title artist 13 3 Managing Rockbox Settings 13 3...

Page 164: ...Rockbox options You can create configuration files that change only certain set tings So for example suppose you typically use the player at one volume in the car and another when using headphones Fu...

Page 165: ...n and is used to store all of the sound related settings Save Theme Settings This option writes a cfg file to your player s disk The config uration file has the cfg extension and is used to store all...

Page 166: ...est in terms of battery runtime on your player An overview of different codec s performance on different players can be found at ZCodecPerformanceComparison Your target uses flash that consumes a cert...

Page 167: ...Appendix A File formats 167 The Rockbox manual version 3 14 Sansa Clip v2...

Page 168: ...ets previous are discarded Font fnt Change the user interface font to this one Image jpg View the JPEG image Link link Display list of target files and di rectories selecting one jumps to the target S...

Page 169: ...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 will...

Page 170: ...pports 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...

Page 171: ...tracks 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 Progress...

Page 172: ...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 Sound...

Page 173: ...F 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 gener...

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

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

Page 176: ...lbumtitle 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 y...

Page 177: ...ine 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 Indi...

Page 178: ...wports Tag Description V x y width height font See section 13 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...

Page 179: ...here 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...

Page 180: ...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 i...

Page 181: ...ack 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 Thi...

Page 182: ...the playlist position 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 playco...

Page 183: ...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 184: ...dio 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 b...

Page 185: ...nged 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 s...

Page 186: ...lts 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 n...

Page 187: ...quency region specific in MHz tb Maximum frequency region specific in MHz tf Current frequency in MHz Ti Current preset id i e 1 based number of the preset within the presets list usable in playlist v...

Page 188: ...the order 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...

Page 189: ...s sublines onto one line with the display cycling round the defined sublines See section 13 2 4 page 161 for details D 26 Time and Date Tag Description cd Day of month from 01 to 31 ce Zero padded day...

Page 190: ...r to make the bar appear on the line of the tag as if it was a text tag width width of the bar for the full viewport width height height of the bar to set to the font height for horizontal bars and to...

Page 191: ...te If the slider option is used the bar will be shrunk so that the slider fits inside b the specified width and height Example A 100px bar image with a 16px slider image needs the bar to be 116px wide...

Page 192: ...ter 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 specify up to ten scrolling lines Sc...

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

Page 194: ...y capacity devise a way to get ranges from config h mAh car adapter mode on off N A usb hid on off N A usb keypad mode multimedia presentation browser N A qs top any setting name for none N A qs botto...

Page 195: ...list 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...

Page 196: ...0 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...

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

Page 198: ...Appendix F Menu Overview 198 F Menu Overview include an overview of the menu structure here The Rockbox manual version 3 14 Sansa Clip v2...

Page 199: ...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 idea...

Page 200: ...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 connect...

Page 201: ...r 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 Ch...

Page 202: ...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 Y...

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

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

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

Page 206: ...fication 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 drawi...

Page 207: ...ies 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 Document...

Page 208: ...evious 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 Mod...

Page 209: ...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 invariant...

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

Page 211: ...istribute 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 licens...

Page 212: ...ections 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 T...

Page 213: ...ons 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 yo...

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

Page 215: ...t 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 customari...

Page 216: ...ms 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 License...

Page 217: ...hat 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 Sof...

Page 218: ...e 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 free...

Page 219: ...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 p...

Reviews: