|Device detection||sansapatcher detection untested|
|Bootloader installation||done, needs testing|
|Doom files installation||done|
|Talk file generation||done (only basic functionality)|
|Voice file installation||done|
|Manual view||done: downloading to the device (no destination selection)|
|Complete Installation||done, code could be improved|
|Small Installation||done, code could be improved|
|Portable installation||done (only working if built as static binary)|
|Proxy setup||system proxy only working on linux (http_proxy environment variable)|
|Download cache||needs testing|
|I18N||support added, translations missing|
|uninstallation / install info||done|
|1st installation detection||if no / no valid user configuration is found, display a warning and open the configuration dialog|
|Device detection||use USB PIDs for detection linux (using libusb), windows (setupapi based)|
|Proxy||support "system proxy" setting on windows (registry values used)|
|L10N support||we have I18N already, extend it to do real L10N|
|Mountpoint resolving on mac||done|
|backup of installation prior to installing||rbutil now asks if you want to backup before installing a new Build|
|improving screenreader support||maybe add a drop downmenü with all install/uninstall options from the main tabs. / findout why jaws and other screenreaders have problems reading titles of QTabwidget: Qt bug, fixed with Qt 4.4.0.|
|builtin rbspeex and sapi.vbs||The rbspeex encoder should be built in, and the Sapi.vbs should be in the resource file (windows)|
|Talk file generation||support festival and the sapi scripts from svn; autodetect binaries; find a way to not make the progress window flicker; add option to generate talk files for directories only; incorporate sapi vbs scripts; add option to only voice certain file types; add options to correct voicestrings|
|voice file creation||needs the servers to provide the features file for every player|
|Unsupported iPod||Display exactly which unsupported iPod was found so as to help avoid user confusion when they are e.g. sure they have a Video not Classic and think it is RBUtil that is wrong|
|General||Code clean up - being worked on.|
|Better Progress Window||console version needs implementation, Logging to a file|
|Console commandos for rbutil||needs implementation - in Work (FS#8571)|
|clean orphan files||could be done by automatically performing an uninstallation before updating|
|install info cleanup||possibility to wipe all files that are marked as outdated in the info window / all files that don't match a specific (read: the current) version)|
|1st time installation||Operate in wizard mode instead of the "invalid configuration" splash. First thing should be UI language selection, without needing to restart.|
|Device detection||Auto detection should probably display directly what was found; at least the highlighting should be more prominent (currently very faint on laptop LCD)|
|Accessibility||Accessibility in rbutil needs improvement. Most of those isses are Qt issues. - (FS#10205)|
Some of the following could be implemented with plugins. -- Qt supports plugins, but it hasn't figured out how to make use of that. Its also unclear which functionality should go into plugins.
|Scrobbler submission||basically a frontend for libscrobbler|
|default configuration||provide some reasonable defaults for config.cfg|
|video conversion||do it like WinFF|
|local repository||do we really want such a function? Offline mode does something similar|
|Configfile editor||A Editor for Rockbox config files|
|Optional components||Rbutil could install the midi patchset, if the license allows it (otherwise the patchset needs to be removed from the wiki as well)|
|Install/ uninstall||Support for multiple devices would be nice (perhaps use some sort of (quasi-)unique device ID?)|
There's an online tool available at http://themes.rockbox.org so having support for this in Rockbox Utility would only duplicate work
|UI Rework||see below|
|Talkfile generation for database|
As rbutil gets more and more functions, the UI needs a rework. Lets collect ideas for a Rework here:
Combine the first three Tabs (Quickstart, Installation, Extras) into one. Make a more global selection of release or current Build. Screenshots of mockups by bluebrother:
Show more info about the currently selected Device. Ie currently installed version and maybe a player picture.
If you want to work on RockboxUtility get the module "rockbox" from svn (you need parts of the Rockbox source tree, so it's easiest to grab the whole tree. If you don't want to do this: you'll need
rbutil, and parts of
apps. You might want to use the script
deploy-release.py in this case). Source code is in the
rbutil/rbutilqt folder (plus other parts of the Rockbox source tree) in the Rockbox SVN (browse). You can download it with the command:
svn co svn://svn.rockbox.org/rockbox/trunk rockbox
You have to have Qt Version 4.5.0 or higher installed. Since r22624 out-of-tree building is possible. You can still build in-tree.
makein the build folder.
Depending on your installation the qmake binary of Qt4 might be called
qmake-qt4. On linux and mac you'll also need libusb (including the development headers).
qmake -config dbg
-config silentto the qmake call (you can add multiple
-configswitches, in case you also want to enable debugging output), or add the line
CONFIG += silentto the project file.
-config silentfrom working. You can simply fix this by adjusting the path delimiter in
mkspecs/features/resources.prfbelow the Qt installation directory -- the delimiter in the line naming
rcc.exeneeds to be a slash, not a backslash.
QMAKE_RCCin the project file to the correct binary using slashes.
qmakewill produce a warning. You can either safely ignore this warning (the translations are generated during the build process) or run
lrelease-qt4 rbutilqt.probefore calling
binfolder of the MinGW installation in your PATH variable.
binfolder to your PATH. Make sure the MinGW path comes first or use
makewon't accepts backslashes in paths, but this is unfortunately needed by Qt).
-no-exceptionswhen building Qt. Otherwise you'll get a dependency on
mingwm10.dll. Also, having support for exceptions enabled increases the binary size noticably.
configure -no-exceptions -static -release -no-webkit -no-dbus -no-phonon -no-phonon-backend -no-qt3support -no-opengl -no-direct3d -no-style-motif -no-style-cde
make. Important note: on OS X 10.6 the default compiler is gcc-4.2 which doesn't support the 10.4 SDK anymore. To make it use the older gcc-4.0 (part of Xcode 3.2) set
QMAKESPECexplicitly, i.e. invoke qmake as
QMAKESPEC=macx-g++40 qmake. Official support for OS X 10.6 also requires at least Qt 4.6.
For building Qt itself, do the following
./configure -universal -sdk /Developer/SDKs/MacOSX10.4u.sdk
makefollowed by (as root)
You can then build rbutilqt by typing (in the rbutilqt source directory)
/usr/local/Trolltech/Qt-4.3.0/bin/qmake followed by
If you want to statically link rbutil with Qt (i.e. to build versions for distribution), add
-static to the configure options.
An alternative to static linking is to use the instructions on http://doc.trolltech.com/4.3/deployment-mac.htm to include the frameworks in the application bundle. This method has the benefit of allowing plugins to be included too and also means that a static build of Qt is not required.
For deployment on mac, there is a "osx_deploy.sh script. It expects Qt as framework. So dont built Qt statically. You have to make sure that you have a universal libusb.a. Also make sure that rbutil links to the static version of libusb. (easiest way is to rename the libusb.dynlib in your search path) You can get a universal binary of libusb at: http://www.ellert.se/twain-sane/
Notes: I had an error regarding when compiling Qt related to missing pq_* functions. I fixed this by disabling PostgreSQL support - adding "-no-sql-psql" to the ./configure line.
More advice for compiling on the Mac is available here - http://doc.trolltech.com/qtjambi/com/trolltech/qt/platform-notes-mac.html
For building the static binary the following configuration was used:
./configure -prefix /usr/local/qt4.4.3-static/ -release -static -no-exceptions -no-qt3support -no-phonon -no-phonon-backend -no-xinerama -no-openssl -no-xcursor -no-cups
You can have two differently configured versions of Qt alongside without any problems, just remember to call the correct qmake. There is no need to make the Qt bin-folder part of the PATH variable. If you want to omit demos and examples during Qt compilation, omit the
-fast option in the configure line and run
make sub-src sub-tools instead of
Qt supports I18N and Rockbox Utility uses this. To translate Rockbox Utility do the following:
*.tsfile using "linguist"
lreleaseto convert the
*.tsfile to the
*.qmformat that is used for I18N.
*.qmfile in the same folder as the executable. Rockbox Utility will then detect the new translation and allow you to use it.
*.qmfile in rbutil-lang.qrc and the language file will be built into the binary.
*.tsfile to the tracker so we can include it
Note: this table is generated using the script
langstats.py and updated in the wiki manually. Do not edit the table manually, such changes will get lost on the next update with the script.
|Translation status as of revision 29000|
|Czech||cs||572||523||49||71||28117 (2010-09-19)||88% ########+|
|German||de||639||542||97||4||28117 (2010-09-19)||99% #########+|
|Finnish||fi||338||295||43||305||28117 (2010-09-19)||52% #####|
|French||fr||640||640||0||3||28692 (2010-11-28)||99% #########+|
|Greek||gr||475||423||52||168||28117 (2010-09-19)||73% #######|
|Hebrew||he||617||606||11||26||28117 (2010-09-19)||95% #########+|
|Italian||it||512||467||45||131||28117 (2010-09-19)||79% #######+|
|Japanese||ja||620||609||11||23||28117 (2010-09-19)||96% #########+|
|Dutch||nl||563||516||47||80||28117 (2010-09-19)||87% ########+|
|Polish||pl||584||521||63||59||28117 (2010-09-19)||90% #########|
|Portuguese||pt||474||423||51||169||28117 (2010-09-19)||73% #######|
|Portuguese (Brasileiro)||pt_BR||640||640||0||4||28117 (2010-09-19)||99% #########+|
|Russian||ru||639||639||0||4||28997 (2011-01-07)||99% #########+|
|Turkish||tr||262||222||40||381||28117 (2010-09-19)||40% ####|
|Chinese||zh_CN||234||199||35||409||28117 (2010-09-19)||36% ###+|
|Chinese (trad)||zh_TW||234||199||35||409||28117 (2010-09-19)||36% ###+|
To add a new target you have to edit the following files:
If your Target has a new Bootloader installation method:
If there are ways for your target to detect the mountpoint or, in case of duplicate USB-IDs, detect the correct Target:
The TTS Engines are in base/tts.cpp / .h. Add your new Engine to the list in initTTSList() and the switch in getTTS().
If your new engine is a simple external executable, you can add a template line to constructor of TTSExes and you are done.
If you have to interface your TTS Engine via another way, or want to give more options to the user, you have to create a new TTS Class which inherits from TTSBase. You will have to implement at least the following functions:
To display settings, the TTS Classes implements the EncTtsSettingInterface which you can find in base/encttssettings.h/cpp. In the generateSetting() function you should create EncTtsSetting objects for all your settings. Each Setting contains the following Information:
You can connect to the following signals:
Add your newly generated objects with insertSetting() to the internal list. insertSetting() also takes a ID, which you can use to retrieve the object again in the saveSettings object.
Currently there are no distribution packages planned. Packages might be requested from distributions. Requests we are aware of:
Please note that we do not support any versions of Rockbox Utility packaged by distributions!
All supported devices can be detected automatically. Rockbox Utility will display a warning when autodetection wasn't successful; you can always select your device manually. If you installed Rockbox once it can get detected via the file /.rockbox/rockbox-info.txt. This will work on all devices. See DeviceDetection for further details.
This relies on detecting the player first (see paragraph above). The following table list when / how we can resolve the mountpoint afterwards. This table only holds supported players; all supported player can now (as of 2008-04-03) be detected reliably. denotes a possible way of resolving that hasn't been implemented yet. Once Rockbox is installed mountpoint resolving using rockbox-info.txt will always work.
|Apple||all Ipods||resolving from drive UNC path figured by ipodpatcher (fallback: check for iPod_Control folder)||device node known by ipodpatcher, resolving using mtab||same as linux|
|Archos||all||detect some specific files (firmware image on disk, magic in firmware file)||same||same|
|Cowon||X5, M5||unknown (no specific file to check for)||same||same|
|Iriver||H100, H300||only detection based on USB possible, currently there is no way known to resolve USB PID -> mountpoint||same||same|
|Iriver||H10||possible recognizing the bootloader file location||same||same|
|Packard Bell||Vibe 500||possible recognizing the bootloader file location||same||same|
|Sandisk||e200, c200||resolving from drive UNC path figured by sansapatcher||device node known by sansapatcher, resolving using mtab||same as linux|
|Olympus||m:robe 100||possible looking for bootloader file||same||same|
|Toshiba||Gigabeat||possible searching for bootloader file||same||same|
deploy-release.py is intended to automate releasing by building the current checkout state and packaging it to a
zip file. Use the command line option
--qmake to pass the path to the qmake binary of the Qt installation you want to use (if there are multiple), otherwise the system is searched for a Qt4 installation and the first found gets used.
Brief release checklist
Info.plistand commit them.
svn copy svn://svn.rockbox.org/rockbox/trunk svn://svn.rockbox.org/rockbox/tags/rbutil_1.0.5
deploy-release.pyto do the following steps. Don't forget to
-a libusb.aon the platforms that require it.
qmake -config release -config static
deploy-release.py is intended for simplifying the release process but can also get used for building. This is especially useful if you just want to build RockboxUtility and don't want to get the full Rockbox svn.
deploy-release.py -hto get an overview of the supported command line options. All created archives will get placed in the current directory while building itself takes place in the systems temporary path.
This is the Qt version of Rockbox Utility. It supersedes the older wxwidgets based version which isn't maintained anymore and has therefore been removed from svn.