The Rockbox Manual for Archos Recorder 6, 10, 15 and 20 rockbox.
Rockbox http://www.rockbox.org/ Open Source Jukebox Firmware Rockbox and this manual is the collaborative effort of the Rockbox team and its contributors. See the appendix for a complete list of contributors. c 2003-2009 The Rockbox Team and its contributors, c 2004 Christi Alice Scarborough, c 2003 José Maria Garcia-Valdecasas Bernal & Peter Schlenker. Version 3.2-090323. Built using pdfLATEX.
Contents Contents 1 Introduction 1.1 Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Getting more help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3 Naming conventions and marks . . . . . . . . . . . . . . . . . . . . . . . . 10 10 10 11 2 Installation 2.1 Before Starting . . . . . . . . . . . . . . . . 2.2 Installing Rockbox . . . . . . . . . . . . . . 2.2.1 Automated Installation . . . . . . . 2.2.2 Manual Installation . . . . . . . . . 2.2.
Contents 4.3 4.4 4.5 5 The 5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 5.11 5.12 4.2.3 The Database Menu . . . 4.2.4 Using the Database . . . While Playing Screen . . . . . . . 4.3.1 WPS Key Controls . . . . 4.3.2 Peak Meter . . . . . . . . 4.3.3 The WPS Context Menu Quick Screens . . . . . . . . . . . Working with Playlists . . . . . . 4.5.1 Playlist terminology . . . 4.5.2 Creating playlists . . . . . 4.5.3 Adding music to playlists 4.5.4 Modifying playlists . . . . 4.5.5 Saving playlists . . . . . .
Contents 6.7 6.8 6.9 6.10 Loudness . . . . . . . . . . . . . Auto Volume . . . . . . . . . . . Super Bass . . . . . . . . . . . . MDB – Micronas Dynamic Bass 7 Playback Settings 7.1 Shuffle . . . . . . . . . . 7.2 Repeat . . . . . . . . . . 7.3 Play Selected First . . . 7.4 Fast-Forward/Rewind . 7.5 Anti-Skip Buffer . . . . 7.6 Fade on Stop/Pause . . 7.7 Party Mode . . . . . . . 7.8 Auto-Change Directory 7.9 Last.fm Log . . . . . . . 7.10 Cuesheet Support . . . . 7.11 Skip Length . . . . . . . . . . .
Contents 10.8 Clear Recording Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 10.9 Clipping Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 10.10Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 11 Plugins 11.1 Games . . . . . . . . . . 11.1.1 Blackjack . . . . 11.1.2 BrickMania . . . 11.1.3 Bubbles . . . . . 11.1.4 Chessbox . . . . 11.1.5 Chopper . . . . . 11.1.6 Dice . . . . . . . 11.1.7 Flipit . . . . . . 11.1.
Contents 11.2.12 Snow . . . . . . . . . . . . . . . . . . . . 11.2.13 Starfield . . . . . . . . . . . . . . . . . . 11.2.14 VU meter . . . . . . . . . . . . . . . . . 11.3 Viewers . . . . . . . . . . . . . . . . . . . . . . 11.3.1 Shortcuts . . . . . . . . . . . . . . . . . 11.3.2 Chip-8 Emulator . . . . . . . . . . . . . 11.3.3 JPEG viewer . . . . . . . . . . . . . . . 11.3.4 Movie Player . . . . . . . . . . . . . . . 11.3.5 Rockbox flash . . . . . . . . . . . . . . . 11.3.6 Rockboy . . . . . . . . . .
Contents 12.3.1 Introduction to .cfg Files. . . . . . . . . . . 12.3.2 Specifications for .cfg Files. . . . . . . . . . 12.3.3 The Manage Settings menu . . . . . . . . 12.4 Firmware Loading . . . . . . . . . . . . . . . . . . . 12.4.1 Using ROLO (Rockbox Loader) . . . . . . . . 12.5 Rockbox in Flash . . . . . . . . . . . . . . . . . . . . 12.5.1 Introduction . . . . . . . . . . . . . . . . . . 12.5.2 Terminology and Basic Operation . . . . . . 12.5.3 Initial Flashing Procedure . . . . . . . . . . . 12.5.
Contents E.2.1 Rules for submitting a new feature idea . . . . . . . . . . . . . . . 143 E.2.2 Features we will not implement . . . . . . . . . . . . . . . . . . . . 144 F Changelog F.1 What F.1.1 F.1.2 F.2 What F.2.1 F.2.2 F.3 What F.3.1 F.3.2 F.3.3 is new since v3.1? . . . New features . . . . . Enhancements . . . . is new since v3.0? . . . New features . . . . . Enhancements . . . . is new since v2.5? . . . New features . . . . . Enhancements . . . . New codecs supported G Credits . . . . . . . .
Chapter 1. Introduction 10 1 Introduction 1.1 Welcome This is the manual for Rockbox. Rockbox is an open source firmware replacement for a growing number of digital audio players. Rockbox aims to be considerably more functional and efficient than your device’s stock firmware while remaining easy to use and customisable. Rockbox is written by users, for users.
Chapter 1. Introduction 11 channel for Rockbox is #rockbox on irc://irc.freenode.net. A bunch of helpful developers and users are usually around. Just join and ask – if someone knows the answer you’ll usually get an answer pretty quickly. More information including IRC logs can be found at http://www.rockbox.org/irc/. We also have a web client for joining the rockbox IRC channel so there is no need for you to install additional software to your computer.
Chapter 2. Installation 12 2 Installation Installing Rockbox is generally a quick and easy procedure. However before beginning there are a few things it is important to know. 2.1 Before Starting USB connection. To transfer Rockbox to your player you need to connect it to your computer. For manual installation/uninstallation, or should autodetection fail during automatic installation, you need to know where to access the player.
Chapter 2. Installation • Automatically install all suggested components (“Complete Installation”). • Selectively install optional components. • Install additional fonts and themes. • Install voice files and generate talk clips. • Uninstall all components you installed using Rockbox Utility. Prebuilt binaries for Windows, Linux and Mac OS X are available at the ZRockboxUtility wiki page. When first starting Rockbox Utility run “Autodetect”, found in the configuration dialog (File → Configure).
Chapter 2. Installation development, you should stick with the release. Please now go to section 2.2.3 (page 14) to complete the installation procedure. 2.2.2 Manual Installation The manual installation method is still available to you, should you need or desire it by following the instructions below. If you have used Rockbox Utility to install Rockbox, then you do not need to follow the next section and can skip straight to section 2.2.3 (page 14) Installing the firmware 1.
Chapter 2. Installation 2.3 Running Rockbox When you turn the unit on, Rockbox should load. 2.4 Updating Rockbox Rockbox can be easily updated with Rockbox Utility. You can also update Rockbox manually - download a Rockbox build as detailed above, and unzip the build to the root directory of your player as in the manual installation stage. If your unzip program asks you whether to overwrite files, choose the “Yes to all” option. The new build will be installed over your current build.
Chapter 3. Quick Start 16 3 Quick Start 3.1 Basic Overview 3.1.1 The player’s controls Throughout this manual, the buttons on the player are labelled according to the picture above. Whenever a button name is prefixed by “Long”, a long press of approximately one second should be performed on that button. The buttons are described in detail in the following paragraph. Additional information for blind users is available on the Rockbox website at ZBlindFAQ.
Chapter 3. Quick Start On the top of the player is the headphone jack on the left and the Line-Out jack on the right. On the bottom of the player is the Line-In jack on the left, the DC-In jack on the right, and the USB connector in the centre. 3.1.2 Turning the player on and off To turn on and off your Rockbox enabled player use the following keys: Key Action Long On Double tap Off when playback is stopped Start Rockbox Shutdown Rockbox On shutdown, Rockbox automatically saves its settings.
Chapter 3. Quick Start 18 the tree view use Down and Up to move around the selection. Use Right or On to select an item. When browsing the file system selecting an audio file plays it. The view switches to the “While playing screen”, usually abbreviated as “WPS” (see section 4.3 (page 26). The dynamic playlist gets replaced with the contents of the current directory. This way you can easily treat directories as playlists. The created dynamic playlist can be extended or modified while playing.
Chapter 3. Quick Start 19 from the Internet make sure you have the needed fonts installed as otherwise the theme may get displayed garbled.
Chapter 4. Browsing and playing 20 4 Browsing and playing 4.1 File Browser Figure 4.1: The file browser Rockbox lets you browse your music in either of two ways. The File Browser lets you navigate through the files and directories on your player, entering directories and executing the default action on each file. To help differentiate files, each file format is displayed with an icon.
Chapter 4. Browsing and playing 4.1.1 File Browser Controls Key Action Up/Down Go to previous/next item in list. If you are on the first/last entry, the cursor will wrap to the last/first entry. Move one page up/down in the list. Go to the parent directory. Executes the default action on the selected file or enters a directory. If there is an audio file playing, returns to the While Playing Screen (WPS) without stopping playback. Stops audio playback.
Chapter 4. Browsing and playing Playlist. Enters the Playlist Submenu (see section 4.5.3 (page 34)). Playlist Catalog. Enters the Playlist Catalog Submenu (see section 4.5.2 (page 33)). Rename. This function lets the user modify the name of a file or directory. Cut. Copies the name of the currently selected file or directory to the clipboard and marks it to be ‘cut’. Copy. Copies the name of the currently selected file or directory to the clipboard and marks it to be ‘copied’. Paste.
Chapter 4. Browsing and playing 4.1.3 Virtual Keyboard Figure 4.3: 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 making a text file with the required layout. More information on how to achieve this can be found on the Rockbox website at ZLoadableKeyboardLayouts.
Chapter 4. Browsing and playing 24 completely customised. More information on how to achieve this can be found on the Rockbox website at ZDataBase. 4.2.2 Initializing the Database The first time you use the database, Rockbox will scan your disk for audio files. This can take quite a while depending on the number of files on your player. This scan happens in the background, so you can choose to return to the Main Menu and continue to listen to music.
Chapter 4. Browsing and playing 25 read old database code. But, all modifications exported to ASCII format should be readable by all database versions. Import Modifications. Allows the /.rockbox/database changelog.txt backup to be conveniently loaded into the database. If Auto Update is enabled this is performed automatically when the database is initialized. 4.2.4 Using the Database Once the database has been initialized, you can browse your music by Artist, Album, Genre, Song Name, etc.
Chapter 4.
Chapter 4. Browsing and playing • The ID3 album name. • The ID3 artist name. • Bit rate. VBR files display average bitrate and “(avg)” • Elapsed and total time. • A slidebar progress meter representing where in the song you are. • Peak meter. b Note: • The number of lines shown depends on the size of the font used. • The peak meter is only visible if you turn off the status bar or if using a small font that gives 8 or more display lines. See section 12.
Chapter 4. Browsing and playing 4.3.1 WPS Key Controls Key Action Up / Down Left Volume up/down. Go to beginning of track, or if pressed while in the first seconds of a track, go to previous track. Rewind in track. Go to next track. Fast forward in track. Toggle play/pause. Stop playback. Return to the File Browser. Enter WPS Context Menu. Enter Main Menu. Switches to the Quick Screen. (see section 5.12 (page 42)) Toggles Display quick screen. Key lock on/off. Mute on/off.
Chapter 4. Browsing and playing unless you play an audio file that is distorted heavily. If you encounter clipping while recording, your recording will sound distorted. You should lower the gain. Note: Note that the clip detection is not very precise. Clipping might occur without being indicated. The scale: Between the indicators of the right and left channel there are little dots. These dots represent important volume values. In linear mode each dot is a 10% mark.
Chapter 4. Browsing and playing Playback Settings This is a shortcut to the Playback Settings Menu, where you can configure shuffle, repeat, party mode, study mode and other settings affecting the playback of your music. Rating The menu entry is only shown if Gather Runtime Information is enabled. It allows the asignment of a personal rating value (0 – 10) to a track which can be displayed in the WPS and used in the Database browser. Press Right to increment the value. The value wraps at 10.
Chapter 4. Browsing and playing normal pitch. 200% means double playback speed and the pitch that is an octave higher than the normal pitch. It is not possible to change the pitch without changing the playback speed and vice versa. Changing the pitch can be done in two modes: procentual and semitone. Initially (after the player is switched on), procentual mode is active. Key Action F1 Up / Down Toggle pitch changing mode Increase / Decrease pitch by 0.
Chapter 4. Browsing and playing Rockbox handles function buttons in a different way to the Archos software. F1 is always bound to the menu function, while F2 and F3 enable two quick screens. F2 displays some browse and play settings which are likely to be changed frequently. This settings are Shuffle mode, Repeat mode and the Show files options Shuffle mode plays each track in the currently playing list in a random order rather than in the order shown in the browser.
Chapter 4. Browsing and playing 33 create a playlist containing all songs in it. This means that just about anything that is described in this chapter with respect to playlists also applies to directories. Dynamic playlist. A dynamic playlist is a playlist that is created “On the fly.” Any time you insert or queue tracks using the Playlist submenu (see section 4.5.3 (page 34)), you are creating (or adding to) a dynamic playlist. Insert.
Chapter 4. Browsing and playing By using the Main Menu To create a playlist containing all music on your player, you can use the Create Playlist command in the Playlist Options menu found in the Main Menu. The created playlist will be named root.m3u and saved in the root of your player’s disk. 4.5.3 Adding music to playlists Adding music to a dynamic playlist Figure 4.7: The Playlist Submenu The Playlist Submenu is a submenu in the Context Menu (see section 4.1.
Chapter 4. Browsing and playing 35 Play Next. Replaces all but the current playing track with track(s). Current playing track is queued. The Playlist Submenu can be used to add either single tracks or entire directories to a playlist. If the Playlist Submenu is invoked on a single track, it will put only that track into the playlist. On the other hand, if the Playlist Submenu is invoked on a directory, Rockbox adds all of the tracks in that directory to the playlist.
Chapter 4. Browsing and playing 36 4.5.6 Loading saved playlists Through the File Browser Playlist files, like regular music tracks, can be selected through the File Browser. When loading a playlist from disk it will replace the current dynamic playlist. Through the Playlist catalog The Playlist catalog offers a shortcut to all playlists in your player’s specified playlist directory. It can be used like the File Browser. 4.5.
Chapter 5. The Main Menu 5 The Main Menu 5.1 Introducing the Main Menu Figure 5.1: The main menu The Main Menu is the screen from which all of the Rockbox functions can be accessed. This is the first screen you will see when starting Rockbox. To return to the Main Menu, press the F1 button. All settings are stored on the unit. However, Rockbox does not spin up the disk solely for the purpose of saving settings.
Chapter 5. The Main Menu 5.3 Recent Bookmarks Figure 5.2: The list bookmarks screen If the Save a list of recently created bookmarks option is enabled then you can view a list of several recent bookmarks here and select one to jump straight to that track. Key Action Down Up Right or On Left or Off On + Play Long Play Selects the next bookmark. Selects the previous bookmark. Resumes from the selected bookmark.
Chapter 5. The Main Menu 39 5.6 Now Playing/Resume Playback Go to the While Playing Screen and resume if music playback is stopped or paused and there is something to resume (see section 4.3 (page 26)). 5.7 Settings The Settings menu allows to set or adjust many parameters that affect the way your player works. There are many submenus for different parameter areas.
Chapter 5. The Main Menu 40 5.7.6 Recording Settings The Recording Settings menu allows you to configure settings related to recording. The details of this menu are covered in detail in section 10 (page 60). 5.8 Recording 5.8.1 While Recording Screen Figure 5.3: The while recording screen Entering the Recording option in the Main Menu brings up a screen in which you can choose to enter the Recording Screen or the Recording Settings (see section 10 (page 60)).
Chapter 5. The Main Menu Key Action Up / Down Left / Right Play Select setting. Adjust selected setting. Start recording. While recording: pause recording (press again to continue). Exit Recording Screen. While recording: Stop recording. Open Recording Settings (see section 10 (page 60)). Quick menu for recording settings. A quick press will leave the screen up (press F2 again to exit), while holding it will close the screen when you release it. Quick menu for source setting.
Chapter 5. The Main Menu 42 5.10 Plugins With this option you can load and run various plugins that have been written for Rockbox. There are a wide variety of these supplied with Rockbox, including several games, some impressive demos and a number of utilities. A detailed description of the different plugins is to be found in section 11 (page 64). 5.11 System Time and Date: Time related menu options.
Chapter 6. Sound Settings 43 6 Sound Settings Figure 6.1: The sound settings screen The sound settings menu offers a selection of sound settings you may change to customise your listening experience. 6.1 Volume This setting adjusts the volume of your music. Like most professional audio gear and many consumer audio products, Rockbox uses a decibel scale where 0 dB is a reference that indicates the maximum volume that the player can produce without possible distortion (clipping).
Chapter 6. Sound Settings 44 6.4 Balance This setting controls the balance between the left and right channels. The default, 0, means that the left and right outputs are equal in volume. Negative numbers increase the volume of the left channel relative to the right, positive numbers increase the volume of the right channel relative to the left. 6.5 Channels A stereo audio signal consists of two channels, left and right.
Chapter 6. Sound Settings vocal range are unaffected, since the human ear picks these up very easily at any sound level. It is of course also possible to use this effect at higher volumes for enhanced bass and treble. 6.8 Auto Volume Auto volume is a feature that automatically lowers the volume on loud parts, and then slowly restores the volume to the previous level over a time interval. This setting allows this time interval to be configured.
Chapter 6. Sound Settings MDB Centre Frequency: The cutoff frequency of your headphones or speakers. This is usually given in the specification for the headphones/speakers. MDB shape: It is recommended that this parameter be set to 1.5 times the centre frequency. This is the frequency up to which harmonics are generated. Some of the lower fundamentals near the cut-off range will have their lower harmonics cut, since they will be below the range of the speakers.
Chapter 7. Playback Settings 47 7 Playback Settings The Playback Settings menu allows you to configure settings related to audio playback. 7.1 Shuffle Turning shuffle on will cause Rockbox to randomly re-order the playlist. Thus, to shuffle all of the audio files on the player, you first need to create a playlist containing all of them. For more information on creating playlists refer to section 4.5 (page 32). Options: Yes/No. 7.
Chapter 7. Playback Settings 48 7.3 Play Selected First This setting controls what happens when you select a file for playback while shuffle mode is on. If the Play Selected First setting is Yes, the file you selected will be played first. If this setting is No, a random file in the directory will be played first. 7.4 Fast-Forward/Rewind These settings control the speed and acceleration during fast forward and rewind.
Chapter 7. Playback Settings 49 Note: You must have the Repeat option set to No for Auto-Change Directory to function properly. Note: This feature only works when songs have been played from the file browser. Using it with the database may cause unexpected behavior. b b 7.9 Last.fm Log Enables logging of your played tracks for submittal to http://www.last.fm. This service was formely known as Audioscrobbler. When you enable this option, you’ll have to reboot to start the logging.
Chapter 8. General Settings 8 General Settings Figure 8.1: The general settings screen 8.1 Playlist The Playlist sub menu allows you to configure settings related to playlists. Recursively Insert Directories. If set to On, then when a directory is inserted or queued into a dynamic playlist, all subdirectories will also be inserted. If set to Ask, Rockbox will prompt the user about whether to include sub-directories. Warn When Erasing Dynamic Playlist.
Chapter 8. General Settings Show Files: This option controls which files are displayed in the File Browser. All: The File Browser displays all files and directories. Extensions 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 130)). Files and directories starting with . (dot) or with the hidden flag set are hidden.
Chapter 8. General Settings 52 Backlight: The amount of time the backlight shines after a key press. If set to Off, the backlight will not light when a button is pressed. If set to On, the backlight will never shut off. If set to a time (1 to 90 seconds), the backlight will stay lit for that amount of time after a button press. Backlight (While Plugged In): This setting is equivalent to the Backlight setting except it applies when the player is plugged into the charger.
Chapter 8. General Settings Screen Scrolls Out of View: Screens can be manually scrolled horizontally by pressing On+Right/Left . Setting this option to Yes will keep the list entries at their fixed positions and allow them to be scrolled out of view, whereas No will only scroll those entries which surpass the right margin. Screen Scroll Step Size: Defines the number of pixels the horizontal manual screen scroll should move for each step.
Chapter 8. General Settings 54 be displayed in units like volts or watts because such units depend on your headphones. Minimum and maximum range: These two options define the full value range that the peak meter displays. Recommended values for the Logarithmic (dB) setting are -40 dB for minimum and 0 dB for maximum. Recommended values for Linear display are 0 and 100%.
Chapter 8. General Settings the last user activity and the time that the disk spins down. This idle time is only affected by user activity, like navigating through the File Browser. When the hard disk spins up to fill the audio buffer, it automatically spins down afterwards. 8.5.4 Idle Poweroff Rockbox can be configured to turn off power after the unit has been idle for a defined number of minutes. The player is idle when playback is stopped or paused.
Chapter 8. General Settings 56 or for individual (saved) playlists. They are stored next to the directory/playlist they reference. You can store multiple bookmarks for the same track. Bookmark on Stop. This option controls whether Rockbox writes a bookmark to the disk when playback is stopped. Setting this to No turns automatic bookmarking completely off. In contrast Yes turns automatic bookmarking on while Ask asks on stopping the track if a bookmark should be created.
Chapter 8. General Settings Key Action Down Up Right or On Left or Off On + Play Long Play Selects the next bookmark. Selects the previous bookmark. Resumes from the selected bookmark. Exits Recent Bookmark menu Deletes the currently selected bookmark Enters the context menu for the selected bookmark. There are two options in the context menu: Resume will commence playback of the currently selected bookmark entry. Delete will remove the currently selected bookmark entry from the list. 8.
Chapter 8. General Settings You can use pre-generated .talk clips to have directory names spoken properly, but you must enable this explicitly (see below). Use Directory .talk Clips. This option turns on the use of .talk clips for directories. On. Use special pre-recorded MP3 files ( dirname.talk) in each directory. These must be generated in advance, and are typically produced synthetically using a text-to-speech engine on a PC. Off. No checking is made for directory .
Chapter 9. Theme Settings 9 Theme Settings The Theme Settings menu offers options that you can change to customize the visual apperance of Rockbox. Browse Themes. This option will display all the currently installed themes on the player, press Right to load the chosen theme and apply it. A theme is a configuration file, stored in a specific directory, that typically changes the WPS , font used and on some platforms additional information such as background image and text colours.
Chapter 10. Recording Settings 10 Recording Settings Figure 10.1: The recording settings screen Note: To change the location where recordings are stored open the Context Menu (see section 4.1.2 (page 21)) on the directory where you want to store them in the File Browser and select Set As Recording Directory. 10.1 Quality Choose the quality here (0 to 7). Default is 5, best quality is 7, smallest file size is 0. This setting effects how much your sound sample will be compressed.
Chapter 10. Recording Settings 61 the sound is recorded using: MPEG v1 for 48, 44.1 and 32 MPEG v2 for 24, 22.05 and 16 b Note: You cannot change the sample rate for digital recordings. 10.3 Source Choose the source of the recording. The options are: SPDIF (digital), Mic, and Line In. 10.4 Channels This allows you to select mono or stereo recording. Please note that for mono recording, only the left channel is recorded. Mono recordings are usually somewhat smaller than stereo. 10.
Chapter 10. Recording Settings 10.7 Prerecord Time This setting buffers a small amount of audio so that when the record button is pressed, the recording will begin from that number of seconds earlier. This is useful for ensuring that a recording begins before a cue that is being waited for. 10.8 Clear Recording Directory Resets the location where the recorded files are saved to the root of your player’s drive. 10.9 Clipping Light Causes the backlight to flash on when clipping has been detected.
Chapter 10. Recording Settings Start Above The start threshold defines the minimal volume a sound must have to start the recording. It is displayed numerically in the line ”Start Above”. Note that the unit of the threshold depends on the settings of the peak meter. (i.e. When the peak meter displays db you can adjust the level in db and when the peak meter is set to linear the threshold is displayed as percentage.
Chapter 11. Plugins 11 Plugins Plugins are programs that Rockbox can load and run. Only one plugin can be loaded at a time. Plugins have exclusive control over the user interface. This means you cannot switch back and forth between a plugin and Rockbox. When a plugin is loaded, you need to exit it to return to the Rockbox interface. Most plugins will not interfere with music playback but some of them will stop playback while running. Plugins have the file extension .rock.
Chapter 11. Plugins Key Action On Play Right Off In menu Start new game Resume saved game Show high scores Quit In game Left / Right / Up / Down F1 F2 F3 Play Off Enter betting amount Hit (Draw new card) Stay (End hand) Double down Save game Return to menu or cancel 11.1.2 BrickMania Figure 11.2: BrickMania BrickMania is a clone of the classic game Breakout. The aim of the game is to destroy all the bricks by hitting them with the ball once or more.
Chapter 11. Plugins Special items Displayed Name Description N D L F G B FL Normal Die Life Fire Glue Ball Flip Returns paddle to normal. Ball dies; lose a life. Gain a life. Allows you to shoot bricks with paddle. Ball sticks to paddle each time it hits. Immediately fires another ball. Flip left / right movement. Key Action Left / Right Play / Up Off Moves the paddle Release the ball / Fire Open menu / Quit 11.1.3 Bubbles Figure 11.
Chapter 11. Plugins Key Action On Left / Right Play F1 Off Pause game Aim the bubble Fire bubble Save game Exit to menu 11.1.4 Chessbox Figure 11.4: Chessbox Chessbox is a one-person chess game with computer artificial intelligence. The chess engine is a port of GNU Chess 2 by John Stanback. It also works as a PGN file viewer. Instead of executing the game from the plugin menu, look for any file with .pgn extension in the file browser and execute it.
Chapter 11. Plugins Keys Key Action Direction keys Play F1 On Off Move the cursor Pick up / Drop piece Change level Force play Show the menu 11.1.5 Chopper Navigate a cavernous maze without banging into walls, the ceiling, or the floor. How long can you fly your chopper? Key Action Play Off Make chopper fly Enter menu 11.1.6 Dice Dice is a simple dice rolling simulator. Select number and type of dice to roll in a menu and start by choosing “Roll Dice”.
Chapter 11. Plugins Flipping the colour of the token under the cursor also flips the tokens above, below, left and right of the cursor. The aim is to end up with a screen containing tokens of only one colour. Key Action Up / Down / Left / Right Play F1 F2 F3 Off Move the cursor Flip Shuffle Solve Solve step by step Quit the game 11.1.8 Goban Figure 11.6: Goban Goban is a a plugin for playing, viewing and recording games of Go (also known as Weiqi, Baduk, Igo and Goe).
Chapter 11. Plugins The file "/sgf/gbn def.sgf" is used by the plugin to store any unsaved changes in the most recently loaded game. This means that if you forget to save your changes, you should load "/sgf/gbn def.sgf" immediately to offload the changes to another file. If you load another file first then your changes will be lost permanently. The "/sgf/gbn def.sgf" file is also the file loaded if another is not selected.
Chapter 11. Plugins 71 Options. Open the Options Menu. Context Menu. Open the Context Menu which allows you to set play modes and other tools. Quit. Leave the plugin. Any unsaved changes are saved to "/sgf/gbn def.sgf". Game Info. The menu for modifying game info (metadata) of the current game. This information will be saved to the SGF file and can be viewed in almost all SGF readers. Basic Info. Shows a quick view of the basic game metadata, if any has been set (otherwise does nothing).
Chapter 11. Plugins 72 saving any unsaved changes. These autosaves go to the file "/sgf/gbn def.sgf" regardless of if you have loaded a game or used Save As to save the game before or not. Set to Off to disable this functionality completely. Automatically Show Comments? If this is enabled and you navigate to a node containing game comments, they will automatically be displayed. Context Menu.
Chapter 11. Plugins 11.1.9 Jewels Figure 11.7: Jewels Jewels is a simple yet 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 out of available moves. Higher points are awarded to larger combos. The game advances to the next level after every one hundred points and randomly clears several jewels.
Chapter 11. Plugins Key Action Up, Down, Left, Right Off Move Character Menu 11.1.11 Minesweeper Figure 11.9: Minesweeper plugin The classic game of minesweeper. Use the Up and Down keys to select the required percentage of mines to set the difficulty then press the On key to begin. The aim of the game is to uncover all of the squares on the board. If a mine is uncovered then the game is over. If a mine is not uncovered, then the number of mines adjacent to the current square is revealed.
Chapter 11. Plugins 11.1.12 Pegbox Figure 11.10: 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 choose a replacement block. Key Up, Down, Left, Right On F2 F1 F3 Off Action In game to move around to to to to to select/save restart level go up a level go down a level quit 11.1.13 Pong Figure 11.11: Pong Pong is a simple two player “tennis game”.
Chapter 11. Plugins Key Action F1 Left F3 Right Off Left player up Left player down Right player up Right player down Quit 11.1.14 Robotfindskitten Figure 11.12: Robotfindskitten In this game, you are robot (#). Your job is to find kitten. This task is complicated by the existence of various things which are not kitten. Robot must touch items to determine if they are kitten or not. The game ends when robotfindskitten. Key Action Up, Down, Left, Right Off Move robot Quit 11.1.
Chapter 11. Plugins a row is completed, it will be cleared away, and you gain points. For every ten lines completed, the game level increases, making the blocks fall faster. If the pile of blocks reaches the ceiling, the game is over. Key Action F1 Left Right Down Play Up On Off Restart game Move left Move right Move down Rotate left Rotate right Drop Quit 11.1.16 Rockblox1d Rockblox1d is a game for people who find rockblox too hard.
Chapter 11. Plugins Key Action Left, Right, Up and Down F1 F2 Move Tile Off Shuffle Change between picture and numbered tiles Stop the game 11.1.18 Snake Figure 11.15: 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 borders of the screen or itself. Key Action Up/Down Play Change levels (1 is slowest, 9 is fastest) Toggle Play/Pause 11.1.
Chapter 11. Plugins ends when the snake hits a wall, or runs into itself. Key Up / Down Right / Left F3 Play Up / Down / Left / Right Play Off Action In menu Set game speed Select starting maze Select game type (A or B) Start the game In game Steer the snake Pause and resume the game Quit In game A, the maze stays the same, in game B after an increasing number of apples eaten the maze is replaced by a new one. 11.1.20 Sokoban Figure 11.
Chapter 11. Plugins Key Action Up, Down, Left, Right Off F1 F2 F3 On Play Play Up/Down Left/Right Off In game Move the “sokoban” up, down, left, or right Menu Back to previous level Restart level Go to next level Undo last movement Redo previously undone move Solution playback Pause/resume Increase/decrease playback speed Go backward/forward (while paused) Quit Some places where can you can find level sets: • http://www.sourcecode.se/sokoban/levels.php • http://sokobano.de/en/levels.
Chapter 11. Plugins Key Action Up / Down / Left / Right On Move Cursor around. F1 Play F2 F3 Off Select cards, move cards, reveal hidden cards... If a card was selected – unselect it, else Draw 3 new cards from the remains stack Put the card from the top of the remains stack on top of the cursor Put the card under the cursor on one of the 4 final colour stacks. Put the card on top of the remains stack on one of the final colour stacks. Show menu 11.1.22 Spacerocks Figure 11.
Chapter 11. Plugins 11.1.23 Star Figure 11.20: Star game This is a puzzle game. It is actually a rewrite of Star, a game written by CDK designed for the hp48 calculator. Rules: Take all of the “o”s to go to the next level. You can switch control between the filled circle, which can take “o”s, and the filled square, which is used as a mobile wall to allow your filled circle to get to places on the screen it could not otherwise reach. The block cannot take “o”s.
Chapter 11. Plugins estimate of its difficulty (very easy, easy, medium, hard or fiendish) will be displayed on the screen. New games can be generated from the Generate menu option. When “playing” an existing Sudoku game file from Rockbox’ file browser the plugin is invoked as viewer. The selected Sudoku will get loaded and you can start solving it. The sudoku games need to be stored as text files with the extension .ss as single file per game.
Chapter 11. Plugins 11.1.25 Wormlet Figure 11.22: Wormlet game Wormlet is a multi-user multi-worm game on a multi-threaded multi-functional Rockbox console. You navigate a hungry little worm. Help your worm to find food and to avoid poisoned argh-tiles. The goal is to turn your tiny worm into a big worm for as long as possible. For 2-player games a remote control is not necessary but recommended. If you try to hold the player in the four hands of two players you’ll find out why.
Chapter 11. Plugins Players 0 Modes Player 1 Out of control With no player taking part in the game all worms are out of control and steered by artificial stupidity.
Chapter 11. Plugins Thus eating an “argh” must be avoided under any circumstances. “Arghs” have the annoying tendency to accumulate. Worms. Thou shall not eat worms. Neither other worms nor thyself. Eating worms is blasphemous cannibalism, not healthy and causes instant death. And it doesn’t help anyway: the other worm isn’t hurt by the bite. It will go on creeping happily and eat all the food you left on the table. Walls. Don’t crash into the walls. Walls are not edible.
Chapter 11. Plugins Wormed: The worm tried to eat another worm or even itself. That’s why it is dead now. Making traps for other players with a worm is a good way to get them out of the game. Hints • Initially you will be busy with controlling your worm. Try to avoid other worms and crawl far away from them. Wait until they curl up themselves and collect the food afterwards. Don’t worry if the other worms grow longer than yours - you can catch up after they’ve died.
Chapter 11. Plugins Key Action Up, Down, Left, Right Play Off Move around the arena Pause Open menu 11.2 Demos 11.2.1 Bounce Figure 11.24: Bounce This demo is of the word “Rockbox” bouncing across the screen. There is also an analogue clock in the background. In Scroll mode the bouncing text is replaced by a different one scrolling from right to left.
Chapter 11. Plugins from the System section of the Rockbox main menu. Exit at any time by pressing Left or Off. 11.2.3 Cube Figure 11.25: Cube This is a rotating cube screen saver in 3D. Key Action On Play F3 Right / Left Up / Down Display at maximum frame rate Pause Cycle draw mode Select axis to adjust Change speed/angle (speed can not be changed while paused) Quit Off 11.2.4 Demystify Figure 11.26: Demystify Demystify is a screen saver like demo.
Chapter 11. Plugins Key Action Up / Down Right / Left Off Increase / decrease speed Add / remove polygon Quit 11.2.5 Fire Figure 11.27: Fire Fire is a demo displaying a fire effect. Key Action Up / Down On Play Off Increase / decrease number of flames Toggle flame type Toggle moving flames Quit 11.2.6 Logo Demo showing the Rockbox logo bouncing around the screen.
Chapter 11. Plugins 11.2.7 Mandelbrot Figure 11.28: Mandelbrot This demonstration draws fractal images from the Mandelbrot set using the greyscale engine. Key Action Direction keys Play On F1 F2 F3 Off Move about the image Zoom in Zoom out Decrease iteration depth (less detail) Increase iteration depth (more detail) Reset and return to the default image Quit 11.2.8 Mosaique Figure 11.29: Mosaique This simple graphics demo draws a mosaic picture on the screen of the player. Press Off to quit.
Chapter 11. Plugins 11.2.9 Oscilloscope Figure 11.30: Oscilloscope This demo shows the shape of the sound samples that make up the music being played. Keys Key Action F1 F2 F3 Play Up / Down Right / Left Off Toggle filled / curve / plot Toggle whether to scroll or not Toggle drawing orientation Pause the demo Increase / decrease volume Increase / decrease speed Exit demo 11.2.10 PictureFlow Figure 11.
Chapter 11. Plugins working correctly before attempting to use PictureFlow. In addition, there are some other points of which to be aware: • PictureFlow will accept album art larger than the dimensions of the screen, but the larger the dimensions, the longer they will take to scale. • The main playback buffer is used which means that unless the size of the playing tracks is small you will have to stop playback to use PictureFlow. Note: PictureFlow is a visualisation only.
Chapter 11. Plugins Show album title. Allows setting the album title to be shown above or below the cover art, or not at all. Resize Covers. Set whether to automatically resize the covers or to leave them at their original size. Rebuild cache. Rebuild the PictureFlow cache. This is needed in order for PictureFlow to pick up new albums, and may occasionally be needed if albums are removed. 11.2.11 Plasma Figure 11.32: Plasma Plasma is a demo displaying a 80’s style retro plasma effect.
Chapter 11. Plugins 11.2.13 Starfield Figure 11.34: Starfield Starfield simulation (like the classic screensaver). Key Action Right / Left Up / Down Off Increase / decrease number of stars Increase / decrease speed Quit 11.2.14 VU meter Figure 11.35: VU-Meter This is a VU meter, which displays the volume of the left and right audio channels. There are 3 types of meter selectable. The analogue meter is a classic needle style.
Chapter 11. Plugins Key Action Off On F1 Up Down Save settings and quit Help Settings Raise Volume Lower Volume 11.3 Viewers Viewers are plugins which are associated with specific file extensions. They cannot be run directly but are started by “playing” the associated file. Viewers are stored in the /.rockbox/rocks/viewers/ directory. 11.3.1 Shortcuts The Shortcuts Plugin allows you to jump to places within the file browser without having to navigate there manually. The plugin works with .
Chapter 11. Plugins Advanced Usage Placing the line “#Display last path segments=n” (where n is a number) in the beginning of a .link file will leave just the last n segments of the entries when they are shown. For example, if n is chosen to be 1, then the entry /MyMusic/collection/song.mp3 will be shown as song.mp3. This allows you to hide common path prefixes. You can also provide a custom display name for each entry individually.
Chapter 11. Plugins • The PluginChip8 page on www.rockbox.org has several attached: ZPluginChip8 • Check out the HP48 chip games section: http://www.hpcalc.org/hp48/games/chip/ • PC emulator by the guy who wrote the HP48 emulator: http://www.pdc.kth.se/ ∼lfo/chip8/CHIP8.htm • Links to other chip8 emulators: http://www.zophar.net/chip8.html 11.3.3 JPEG viewer Open a JPEG file in the File Browser to view it using Rockbox’s greyscale library. Note: This plugin will cause playback to stop.
Chapter 11. Plugins 11.3.5 Rockbox flash For “playing” .UCL files on a flashed player. Reprograms the flash memory of the player unit (see section 12.5 (page 126) for details). 11.3.6 Rockboy Figure 11.36: Rockboy Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on the gnuboy emulator. To start a game, open a ROM file saved as .gb or .gbc in the file browser.
Chapter 11. Plugins Set Keys (BUGGY) Select this option to set a new keymapping. Quit RockBoy. Quits the Rockboy plugin. 11.3.7 Search This plugin can be used on playlists. It searches through the playlist that it opened on looking for any occurrences of the string entered by the user. The results of this search are saved to a new playlist, search results.m3u, within the same directory as the original playlist. 11.3.8 Sort This plugin takes a file and sorts it in ascending alphabetical order.
Chapter 11. Plugins 101 Viewer Options Encoding sets the codepage in the text viewer. Available settings: UTF-8 (Unicode), BIG5 (Traditional Chinese), KSX-1001 (Korean), GB2312 (Simple Chinese), SJIS (Japanese), CP1250 (Central European), ISO8859-2 (Latin Extended), ISO-8859-9 (Turkish), ISO-8859-6 (Arabic), ISO8859-11 (Thai), CP1251 (Cyrillic), ISO-8859-8 (Hebrew), ISO-8859-7 (Greek), ISO-8859-1 (Latin 1).
Chapter 11. Plugins Compatibility • Currently messages are in English • Does not currently support right-to-left languages. 11.3.10 VBRfix This function scans a VBR (Variable Bitrate) MP3 file and updates/creates the Xing VBR header. The Xing header contains information about the VBR stream used to calculate average bit rate, time information and to more accurately fwd/rew in the stream.
Chapter 11. Plugins 11.3.12 ZXBox Figure 11.38: ZXBox ZXBox is a port of the “Spectemu” ZX Spectrum 48k emulator for Rockbox (Zproject’s homepage). To start a game open a tape file or snapshot saved as .tap, .tzx, .z80 or .sna in the file browser. Note: As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible. Default keys The emulator is set up for 5 different buttons: Up, Down, Left, Right and Jump/Fire.
Chapter 11. Plugins 104 format will be chosen after the extension you specified, per default .z80 will be taken in case you leave it open. Toggle Fast Mode. Toggles fastest possible emulation speed (no sound, maximum frameskip etc.). This is Useful when loading tapes with some specific loaders. Options. Map Keys To Kempston. Controls whether the player’s buttons should simulate a “Kempston” joystick or some assigned keys of the Spectrum keyboard. Display Speed.
Chapter 11. Plugins have a DIN-style circular jack with 8 pins (7 in a ∼ 270 degree circle, one in the center). A standard 5-pin DIN plug is OK for this, since we do not use the other (power) pins. As OEM, they shuffled the pins around a bit, better check first if it is not genuine Alpine. The bus pin is pulled high to 12 volts with a ∼ 2kOhm resistor, pulses driven low. Because it is open collector, this is not harmful to the Archos.
Chapter 11. Plugins Information explained At the top of the battery bench.txt file is various information on how to use the plugin, followed by the data themselves. Time This column reports the total time of operation of the player. It is not the time that you started the plug-in. If you have your player on for 5 minutes and then start the plugin, it will start measuring from 5 minutes. Seconds The same as Time, except measured in seconds.
Chapter 11. Plugins 11.4.3 Calculator Figure 11.39: Calculator This is a simple scientific calculator for use on the player. It works like a standard calculator. Pressing the “1st” and “2nd” buttons will toggle between other available math functions. Key Action Left / Right / Up / Down Play F1 Move around the keypad F2 F3 Off Select a button Delete last entered digit or clear after calculation Cycle through the 4 basic operators Calculate Quit 11.4.4 Calendar Figure 11.
Chapter 11. Plugins Key Action Left / Right / Up / Down Play On + Up / Down Off Move the selector Show memos for the selected day Previous / Next month Quit 11.4.5 Chess Clock Figure 11.41: Chess Clock The chess clock plugin is designed to simulate a chess clock, but it can be used in any kind of game with up to ten players.
Chapter 11. Plugins While playing The number of the current player is displayed on the top line. The time below is the time remaining for that round (and possibly also the total time left if different). Keys are as follows: Key Action Off Left Play Up Down F1 Exit plugin Restart round for the current player Pause the time (press again to continue) Switch to next player Switch to previous player Open menu (Play to select.
Chapter 11. Plugins Key configuration Key Action Left / Right Up / Down F1 Play Long Off Cycle through modes Cycle through skins Main Menu Start / Stop Counter Reset Counter Save Settings (if enabled) and Exit Clock Menu View Clock Exits the menu and returns to the current clock mode display. Mode Selector Opens a menu from which you can select a clock mode to view. Counter Settings Opens a menu from which you can adjust settings pertaining to the counter.
Chapter 11. Plugins Digital mode An imitation of an LCD, this mode shows a Clock comprised of digital “segments”. The 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 “Invert” mode, will invert the LCD left-to-right as the seconds pass (a fully-inverted LCD means the entire minute has passed).
Chapter 11. Plugins Linux selects Linux files. Default files are .dolphinview, .d3lphinview, and .Trash-*/. Windows selects Windows files. Default files are Thumbs.db, RECYCLE.BIN, Desktop.ini, /Recycled and /System Volume Information. Mac selects OS X files. Default files are . *, .DS Store and /.Trashes. Other selects additional files added in by the user. Key Action Left or Off Exit / Abort 11.4.
Chapter 11. Plugins Key Action Off Quit 11.4.11 md5sum Open a file, a directory or just launch it from the plugin menu to create an md5sum of the file, the directory’s contents or the whole filesystem. If the file’s extension is .md5 or .md5sum, it will check the md5 sums in the file instead. If the file’s extension is .md5list it will compute md5 sums for all the files listed. 11.4.12 Metronome This plugin can be used as a metronome to keep time during music practice.
Chapter 11. Plugins Import List From Textfile Imports the list from /.rockbox/folder advance list.txt Quit Folder List Editor Keys Key Action Right or On Long Play Delete selected folder Bring up the context menu which allows you to remove the selected folder or it’s entire folder tree Exit Left or Off 11.4.14 Split Editor When recording an mp3 file, it is common practice to start the recording a little bit early and stop it a little bit late to ensure all the desired sound is recorded.
Chapter 11. Plugins 115 Figure 11.43: The Split Editor’s Main Screen The Split Editor’s Main Screen The waveform displays the volume of the song over time. It will appear as the song plays and help to visually identify the point in time where the split is desired The split point indicator is a vertical line with a small triangle at the top end. It is the most important control element of the split editor. It can be moved with the Left and Right buttons.
Chapter 11. Plugins Playback loops from the beginning of the visible area to the split point. This mode is best used when fine tuning the split indicator position at the end of a recording. Playback does not loop, the borders of the visible area as well as the split point indicator are ignored. This mode is best used when playing the song outside of the borders of the displayed region. Perform the split (8) The icon above the F1 button indicates its function to execute the split.
Chapter 11. Plugins Key Action Up / Down Play Off Select item Toggle / edit item Cancel Table 11.2: Controls in the save dialogue Scale The values in the waveform are scaled according to the settings of the peak meter. These can be altered in the peak meter settings, see section 8.4 (page 53). If extreme minimum or maximum values are set the waveform might be cut off. A minimum setting of -60 dB and a maximum setting of 0 dB are recommended.
Chapter 11. Plugins 11.4.16 Stopwatch Figure 11.46: Stopwatch A simple stopwatch program with support for saving times. Key Action Off Play Left On Up / Down Quit Plugin Start / stop Reset timer (only when timer is stopped) Take lap time Scroll through lap times 11.4.17 Text Editor This plugin allows you to view and edit simple text documents on your DAP. You can view files by using Open with from the Context Menu (see section 4.1.2 (page 21)).
Chapter 11.
Chapter 12. Advanced Topics 120 12 Advanced Topics 12.1 Customising the User Interface 12.1.1 Getting Extras Rockbox supports custom fonts. A collection of fonts is available for download in the font package at http://www.rockbox.org/daily.shtml. 12.1.2 Loading Fonts Rockbox can load fonts dynamically. Simply copy the .fnt file to the player and “play” it in the File Browser. If you want a font to be loaded automatically every time you start up, it must be located in the /.
Chapter 12. Advanced Topics number of WPS files included in Rockbox, and you can load one of these at any time by selecting it in Settings → Theme Settings → Browse .wps files. Note: “Playing” a .wps from the File Browser has the same effect. b File Location: Custom WPS files may be located anywhere on the drive. The only restriction is that they must end in .wps. When you “play” a .wps file, it will be used for future WPS screens, and if the “played” .wps file is located in the /.
Chapter 12. Advanced Topics The last else part is optional, and will be displayed if 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 song – the song that is about to play after the one currently playing (unless you change the plan).
Chapter 12. Advanced Topics Example %?it<%t8%s%it|%s%fn>;%?ia<%t3%s%ia|%t0> The format above will do two different things depending if ID3 tags are present. If the ID3 artist and title are present: • Display id3 title for 8 seconds, • Display id3 artist for 3 seconds, • repeat. . . If the ID3 artist and title are not present: • Display the filename continuously.
Chapter 12. Advanced Topics 12.3 Managing Rockbox Settings 12.3.1 Introduction to .cfg Files. Rockbox allows users to store and load multiple 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 are permitted. So, for example, you could have a car.cfg file for the settings that you use while playing your jukebox in your car, and a headphones.
Chapter 12. Advanced Topics 125 you are in the car, and a regular LCD setting when you are using headphones. You could create configuration 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 use the Browse .cfg files option to quickly change settings.
Chapter 12. Advanced Topics 126 rename your old firmware files with names like ajbrec.ajz.old and so on, because it is possible that the player will load a file other than the one you intended. 12.4.1 Using ROLO (Rockbox Loader) Rockbox is able to load and start another firmware file without rebooting. You just “play” a file with the extension .ajz. This can be used to test new firmware versions without deleting your current version. 12.5 Rockbox in Flash 12.5.
Chapter 12. Advanced Topics 127 contain a copy of Rockbox 3.2 in the main image. It can easily be updated/replaced later. The bootloader allows to select which image to run. Pressing F1 at boot selects the first image. F2 selects the second image, which will also be booted if you don’t press any button. The button mapping is only there for completeness. F3 selects the built-in serial monitor called Minimon. You should know this in case you invoke it by accident.
Chapter 12. Advanced Topics we still didn’t manage to scare you off, you need to press F3 to actually program and verify. The programming takes just a few seconds. 5. In the unlikely event that the programming or verify steps should give you any error, do not switch off the box! Otherwise you’ll have seen it working for the last time. While Rockbox is still in RAM and operational, we could upgrade the plugin via USB and try again. If you switch it off, it’s gone.
Appendix A.
Appendix A. File formats A File formats A.1 Supported file formats Icon File Type Extension Action when selected Directory none Audio file .mp2, .mp3 Cuesheet Wave Audio File Playlist .cue .wav .m3u, .m3u8 Rockbox firmware .ajz While Playing Screen .wps Language File Text File .lng .txt Configuration File .cfg Font .
Appendix B. WPS Tags 131 B WPS Tags B.1 Status Bar Tag Description %we %wd Status Bar Enabled Status Bar Disabled These tags override the player setting for the display of the status bar. They must be noted on their own line. B.2 ID3 Info Tag Description %ia %ic %id %ig %in %it %iv %iy ID3 ID3 ID3 ID3 ID3 ID3 ID3 ID3 Artist Composer Album Name Genre Name Track Number Track Title Version (1.0, 1.1, 2.2, 2.3, 2.
Appendix B. WPS Tags 132 B.3 Power Related Information Tag Description %bl Show numeric battery level in percent. Can also be used in a conditional: %?bl<-1|0|1|2|...|N> Where the -1 value is used when the battery level isn’t known (it usually is).
Appendix B. WPS Tags 133 B.5 Playlist/Song Info Tag Description %pb Progress Bar This will replace the entire line with a progress bar. You can set the height, position and width of the progressbar (in pixels): %pb|height|leftpos|rightpos|toppos| Percentage Played In Song Current Time In Song Total Number of Playlist Entries Peak Meter. The entire line is used as volume peak meter. Playlist Name (Without path or extension) Playlist Position Remaining Time In Song Shuffle.
Appendix B. WPS Tags B.8 Repeat Mode Tag Description %mm Repeat mode, 0-4, in the order: Off, All, One, Shuffle , A-B Example: %?mm B.9 Playback Mode Tags Tag Description %mp Play status, 0-4, in the order: Stop, Play, Pause, Fast forward, Rewind Example: %?mp B.
Appendix B. WPS Tags B.11 Settings Tag Description %St|| Display the value of any Rockbox setting Example: Can be used as a simple tag %St|skip length| or with conditionals %?St|eq enabled|. B.12 Images Tag Description %P|filename.bmp| Load a Progress bar image for the WPS. Use %pb tag to show the progress bar Load and display an image n: image ID (a-z and A-Z) for later referencing in %xd filename: filename relative to /.
Appendix B. WPS Tags Examples: 1. Load and display the image /.rockbox/bg.bmp with ID “a” at 37, 109: %x|a|bg.bmp|37|109| 2. Load a bitmap strip containing 5 volume icon images (all the same size) with image ID “M”, and then reference the individual sub-images in a conditional: %xl|M|volume.
Appendix B. WPS Tags B.15 Real Time Clock Tag Description %cd %ce %cH %ck %cI %cl %cm %cM %cS %cy %cY %cP %cp %ca %cb %cu %cw Day of month Zero padded day of month Zero padded hour from 00 to Hour from 0 to 24 Zero padded hour from 12 to Hour from 12 to 12 Month Minutes Seconds 2-digit year 4-digit year Capital AM/PM Lowercase am/pm Weekday name Month name Day of week from 1 to 7, 1 is Day of week from 0 to 6, 0 is 24 12 Monday Sunday B.
Appendix C. Album Art 138 C Album Art C.1 Introduction Rockbox allows you to put the album art, or another image related to the music on your playerto display it in the PictureFlow plugin. For this feature to work, you must observe a few rules. C.2 Limitations Rockbox does not support album art embedded in your files’ tags, and will instead look for a picture located in the filesystem. In addition to this, the pictures must be in the BMP format. C.
Appendix D.
Appendix D.
Appendix D.
Appendix D.
Appendix E. User feedback E User feedback E.1 Bug reports If you experience inappropriate performance from any supported feature, please file a bug report on our web page. Do not report missing features as bugs, instead file them as feature ideas (see below). For open bug reports refer to http://www.rockbox.org/tracker/index.php?type=2 E.1.1 Rules for submitting new bug reports 1. Check that the bug has not already been reported 2.
Appendix E. User feedback E.2.2 Features we will not implement This is a list of Feature Requests we get repeatedly that we simply cannot do. View it as the opposite of a TODO! • Record to WAV (uncompressed) or MP3pro format! The recording hardware (the MAS) does not allow us to do this • Crossfade between tracks! Crossfading would require two mp3 decoders, and we only have one. This is not possible. • Support MP3pro, WMA or other sound format playback! The mp3-decoding hardware can only play MP3.
Appendix E. User feedback 145 • Interfacing with other USB devices (like cameras) or 2 player games over USB The USB system demands that there is a master that talks to a slave. The player can only serve as a slave, as most other USB devices such as cameras can. Thus, without a master no communication between the slaves can take place.
Appendix F. Changelog F Changelog F.1 What is new since v3.1? F.1.1 New features ? 2009-03-06: PictureFlow supports all targets except Archos Player, and can function during playback on all non-Archos targets. ? 2009-03-01: New alternative sorting algorithm, which is number-aware ? 2009-02-11: New game, Goban plugin. ? 2009-01-11: Battery charging on Sansa e200v1/c200v1.
Appendix F. Changelog 147 F.3 What is new since v2.5? F.3.
Appendix F. Changelog ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 2006-10-19: 2006-10-05: 2006-09-15: 2006-08-28: support 2006-08-07: 2006-07-19: 2006-07-18: 2006-04-19: 2006-03-30: 2006-03-28: 2006-03-28: 2006-03-26: 2006-03-26: 2006-03-20: 2006-03-19: 2006-03-12: 2006-03-11: 2006-02-22: 2006-02-13: 2006-01-28: 2006-01-23: 2005-12-06: 2005-11-05: last.
Appendix F. Changelog ? 2006-02-07: Equalizer configuration for software codec platforms ? 2006-02-06: The Rockbox manual is available in LATEXformat ? 2005-12-05: New wps’ added. Engineeer2, marquee, and DancePuffDuo F.3.
Appendix G. Credits G Credits People that have contributed to the project, one way or another.
Appendix G. Credits Hand · Nick Lanham · Sebastian Henriksen · Martin Scarratt · Karl Kurbjun · Tomasz Malesinski · Andrew Pilley · Matt v.d. Westhuizen · Tim Crist · Jvo Studer · Dan Everton · Imre Herceg · Seven Le Mesle · Craig Bachelor · Nikolaj Christensen · Mikael Magnusson · Dominik Wenger · Henrico Witvliet · Andrew Scott · Miguel A. Arévalo · Aaron F.
Appendix G. Credits · Stepan Moskovchenko · John S. Gwynne · Brian J. Morey · Stijn Hisken · Bertrik Sikken · Karim Boucher · James Espinoza · Franz Rühmland · Jordan Anderson · Maurus Cuelenaere · Chris Allegretta · Alastair S · Martin Crkovský · Ariya Hidayat · Jonas Hurrelmann · Lee Kang Hyuk · Clemens Werther · Robert Menes · Henri Valta · Melba Sitjar · Mehmet Ş.
Appendix H. Licenses H Licenses H.1 GNU Free Documentation License Version 1.2, November 2002 Copyright c 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Appendix H. Licenses 154 A ”Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
Appendix H. Licenses 155 A section ”Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as ”Acknowledgements”, ”Dedications”, ”Endorsements”, or ”History”.) To ”Preserve the Title” of such a section when you modify the Document means that it remains a section ”Entitled XYZ” according to this definition.
Appendix H. Licenses 156 you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
Appendix H. Licenses 157 create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the ”History” section.
Appendix H. Licenses 158 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
Appendix H. Licenses 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections.
Appendix H. Licenses Copyright c YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no BackCover Texts. A copy of the license is included in the section entitled ”GNU Free Documentation License”. If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the ”with.
Appendix H. Licenses H.2 The GNU General Public License Version 2, June 1991 Copyright c 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it.
Appendix H. Licenses 162 Terms and Conditions For Copying, Distribution and Modification 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License.
Appendix H. Licenses 163 such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works.
Appendix H. Licenses 164 the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License.
Appendix H. Licenses decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8.
Appendix H. Licenses you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if such holder or other party has been advised of the possibility of such damages.
Appendix H. Licenses The hypothetical commands show w and show c should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than show w and show c; they could even be mouse-clicks or menu items— whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc.
