Rockbox

This is the bug/patch tracker for Rockbox. Click here for more information.

Quick links: Bugs · Patches · Rockbox frontpage

Tasklist

FS#9067 - [GSoC] Accessibility and localization improvements

Attached to Project: Rockbox
Opened by Tom Ross (midgey34) - Tuesday, 03 June 2008, 08:41 GMT+2
Last edited by Tom Ross (midgey34) - Thursday, 23 July 2009, 05:05 GMT+2
Task Type Patches
Category Language
Status New
Assigned To No-one
Player Type All players
Severity Low
Priority Normal
Reported Version Daily build (which?)
Due in Version Undecided
Due Date Undecided
Percent Complete 0%
Private No

Details

This tracker task will be used to house my Summer of Code work. For information about the goals of the project please see http://www.rockbox.org/twiki/bin/view/Main/PluginLocalization . Please read the comments and the descriptions of each patch.

Latest patch: plugin_loc.072209.diff
Posted: July 22
This task depends upon

Comment by Tom Ross (midgey34) - Tuesday, 03 June 2008, 08:46 GMT+2
This patch is my latest attempt to allow for localized plugins. It uses the plugin buffer to store the plugin strings. As a demo, Blackjack has been translated into "Spanish" but not fully. The introduction screen is always in English and there are some formatting issues when entering a bet on certain targets. Please see the wiki page for more details on the implementation.

This patch was tested on Gigabeat F, iriver H300, and Sansa e200. For mentors following the project, this is the same as v9.5 .
   plugin_lang_work.diff (56.5 KiB) 
 tools/genlang                     |   48 ++++
 tools/configure                   |    9 
 tools/make.inc                    |    4 
 tools/buildzip.pl                 |    4 
 apps/language.c                   |   47 ++--
 apps/language.h                   |    4 
 apps/Makefile                     |    2 
 apps/plugins/lang/espanol.lang    |  437 ++++++++++++++++++++++++++++++++++++++
 apps/plugins/lang/SOURCES         |    2 
 apps/plugins/lang/english.lang    |  437 ++++++++++++++++++++++++++++++++++++++
 apps/plugins/lang/Makefile        |   40 +++
 apps/plugins/lib/pluginlib_lang.c |   54 ++++
 apps/plugins/lib/pluginlib_lang.h |   32 ++
 apps/plugins/lib/Makefile         |    6 
 apps/plugins/lib/SOURCES          |    1 
 apps/plugins/blackjack.c          |  216 +++++++++---------
 apps/settings.h                   |    1 
 apps/plugin.c                     |   45 +--
 apps/plugin.h                     |   12 +
 19 files changed, 1236 insertions(+), 165 deletions(-)

Comment by Tom Ross (midgey34) - Wednesday, 09 July 2008, 18:42 GMT+2
This patch contains further improvements on localized plugins. Chopper and Chessbox have been mostly adapted and translated into "Spanish." This patch also uses the user keyword from lang files to restrict access to strings. If a plugin tries to access a string that has a different user, the returned string will be blank. Originally this was an attempt at loadable strings but this version saves no new ram. I mentioned a proposal about loadable strings in my emails to Daniel and Stephane and I'd like to discuss the ideas on IRC.

Additionally in this patch plugins can now talk. Run 'make voice' to create a voice build as normal. Then go into Blackjack and listen to how it talks to you. So far only parts of Blackjack are voiced. It would be nice for someone to attach a voice file (created by Festival) to allow other people to quickly test out the patch.
   plugin_talk.diff (84.6 KiB) 
 tools/voice.pl                    |    4 
 tools/genlang                     |  159 +++++++-
 tools/configure                   |   13 
 tools/make.inc                    |    4 
 tools/buildzip.pl                 |    4 
 apps/language.c                   |   71 ++-
 apps/language.h                   |    8 
 apps/Makefile                     |    2 
 apps/plugins/chessbox/chessbox.c  |   14 
 apps/plugins/chessbox/Makefile    |    6 
 apps/plugins/lang/espanol.lang    |  580 ++++++++++++++++++++++++++++++
 apps/plugins/lang/SOURCES         |    2 
 apps/plugins/lang/english.lang    |  720 ++++++++++++++++++++++++++++++++++++++
 apps/plugins/lang/Makefile        |   40 ++
 apps/plugins/lib/pluginlib_lang.c |   61 +++
 apps/plugins/lib/pluginlib_lang.h |   33 +
 apps/plugins/lib/Makefile         |    6 
 apps/plugins/lib/SOURCES          |    1 
 apps/plugins/chopper.c            |   44 +-
 apps/plugins/blackjack.c          |  217 +++++------
 apps/settings.h                   |    1 
 apps/talk.c                       |    3 
 apps/plugin.c                     |   65 +--
 apps/plugin.h                     |   18 
 24 files changed, 1851 insertions(+), 225 deletions(-)

Comment by Tom Ross (midgey34) - Monday, 21 July 2008, 05:38 GMT+2
This patch implements the beginning of loading lang strings from file offsets as I discussed with amiconn. I sent this out to Bagder and sdoyon but I think they're both on break. Some of these changes are for my own purposes to make building take less time or get around mac specific quirks.
   plugin_lang_offsets.diff (91.5 KiB) 
 tools/voice.pl                    |   14 
 tools/genlang                     |  135 ++++++-
 tools/configure                   |   13 
 tools/make.inc                    |    4 
 tools/buildzip.pl                 |    4 
 apps/language.c                   |  117 +++---
 apps/language.h                   |    9 
 apps/Makefile                     |    2 
 apps/plugins/chessbox/chessbox.c  |   14 
 apps/plugins/chessbox/Makefile    |    6 
 apps/plugins/lang/espanol.lang    |  580 ++++++++++++++++++++++++++++++
 apps/plugins/lang/SOURCES         |    2 
 apps/plugins/lang/english.lang    |  720 ++++++++++++++++++++++++++++++++++++++
 apps/plugins/lang/Makefile        |   40 ++
 apps/plugins/lib/pluginlib_lang.c |   80 ++++
 apps/plugins/lib/pluginlib_lang.h |   39 ++
 apps/plugins/lib/Makefile         |    6 
 apps/plugins/lib/SOURCES          |    1 
 apps/plugins/chopper.c            |   44 +-
 apps/plugins/blackjack.c          |  259 +++++++------
 apps/settings.h                   |    1 
 apps/plugin.c                     |   65 +--
 apps/plugin.h                     |   20 -
 23 files changed, 1920 insertions(+), 255 deletions(-)

Comment by Tom Ross (midgey34) - Wednesday, 13 August 2008, 08:41 GMT+2
Here's my latest work. This version changes to using a single lang file per language. It's still rough around the edges but works fairly well. Like previous version, plugins can be translated into multiple languages and strings can be voiced. A fairly significant change is the ability to now use the ID2P() macro in conjunction with splashes within plugins.

I've split the code changes from the language changes to make the code more easily reviewable. If you want to compile a build to test out my work, both patches are required.
lang_changes.zip contains lang_changes.diff which are the required changes to the lang files
single_lang_file.diff are all the code changes

Note: I don't think this will compile and work on target. I've broken that with this patch and I need to make a few changes to makefiles to fix it.
   single_lang_file.diff (68.8 KiB) 
 tools/voice.pl                    |   12 -
 tools/genlang                     |  238 ++++++++++++++++++++++++++---------
 tools/configure                   |   14 +-
 tools/make.inc                    |    2 
 apps/language.c                   |  102 +++++++++------
 apps/language.h                   |    7 -
 apps/Makefile                     |   11 +
 apps/plugins/Makefile             |    2 
 apps/plugins/chessbox/chessbox.c  |   14 +-
 apps/plugins/chessbox/Makefile    |    8 -
 apps/plugins/lib/pluginlib_lang.c |   53 +++++++
 apps/plugins/lib/pluginlib_lang.h |   32 ++++
 apps/plugins/lib/SOURCES          |    1 
 apps/plugins/chopper.c            |   44 +++---
 apps/plugins/blackjack.c          |  253 ++++++++++++++++++++------------------
 apps/talk.c                       |    3 
 apps/plugin.c                     |   67 +++++-----
 apps/plugin.h                     |   20 ++-
 18 files changed, 585 insertions(+), 298 deletions(-)

   lang_changes.zip (707.7 KiB)
Comment by Tom Ross (midgey34) - Tuesday, 03 March 2009, 06:22 GMT+2
For anyone who has been following SVN, you may have noticed I've committed a few things related to this task. They are all in preparation and make syncing this significantly easier. Here's an attempt at updating the patch to work with the new build system. So far I've only tested this on the Gigabeat F sim and target. Both seem to "work" for the most part. The build magic is not perfect and so it might quit with an error. Just make a second time and it should continue. You will probably want to test this by building a new build from scratch - not using an existing folder. Currently all lang objects are linked explicitly and some magic is needed to only link the proper lang file per plugin and only link if the plugin uses the pluginlib_lang files.

This should be considered a work in progress and is nowhere ready to commit. I'm aiming for inclusion in 3.3 so if there are no problems, this will hopefully be committed in early April.

NOTE: lang_changes.diff (or zip) is no longer needed. This patch is all that's important.
Patch created against r20189.
   sorted_genlang.diff (95.6 KiB) 
 tools/genlang                     |  339 ++++++++++-----
 tools/make.inc                    |    2 
 apps/language.c                   |  111 +++--
 apps/language.h                   |   18 
 apps/plugins/chessbox/chessbox.c  |   43 +
 apps/plugins/plugins.make         |    9 
 apps/plugins/lib/pluginlib_lang.c |   60 ++
 apps/plugins/lib/pluginlib_lang.h |   32 +
 apps/plugins/lib/SOURCES          |    1 
 apps/plugins/chopper.c            |   53 --
 apps/plugins/blackjack.c          |  246 ++++++-----
 apps/lang/english.lang            |  836 ++++++++++++++++++++++++++++++++++++++
 apps/lang/espanol.lang            |  570 +++++++++++++++++++++++++
 apps/lang/lang.make               |    9 
 apps/talk.c                       |    5 
 apps/plugin.c                     |   10 
 apps/plugin.h                     |   13 
 17 files changed, 2040 insertions(+), 317 deletions(-)

Comment by Tom Ross (midgey34) - Wednesday, 04 March 2009, 05:26 GMT+2
Cleanup some small changes that are no longer needed. Add some Spanish strings for Chopper that got lost in the sync. Slightly new build magic for producing language objects. Seems to work on my machine and make complete successfully on the first attempt. Once again I suggest you build from a completely fresh directory.

Patch created against r20196.
   sorted_genlang.2.diff (96.4 KiB) 
 tools/genlang                     |  337 ++++++++++-----
 tools/make.inc                    |    4 
 apps/language.c                   |  111 +++-
 apps/language.h                   |   18 
 apps/plugins/chessbox/chessbox.c  |   43 +
 apps/plugins/plugins.make         |    9 
 apps/plugins/lib/pluginlib_lang.c |   59 ++
 apps/plugins/lib/pluginlib_lang.h |   30 +
 apps/plugins/lib/SOURCES          |    1 
 apps/plugins/chopper.c            |   53 --
 apps/plugins/blackjack.c          |  246 ++++++----
 apps/lang/english.lang            |  851 ++++++++++++++++++++++++++++++++++++++
 apps/lang/espanol.lang            |  612 +++++++++++++++++++++++++++
 apps/lang/lang.make               |    8 
 apps/talk.c                       |    5 
 apps/plugin.c                     |   10 
 apps/plugin.h                     |   13 
 17 files changed, 2092 insertions(+), 318 deletions(-)

Comment by alex wallis (alexwallis646) - Thursday, 25 June 2009, 16:45 GMT+2
I was wondering any updates for this task? or any idea when it might be committed?

Even if not, is there any possibility the patch could please be resynced?
As I was only able to get the patch to apply with a fuzz factor of 3, and I guess it didn't work properly as I got the following error while making a build including it.
"LD blackjack.rock
/home/Administrator/rockbox/build/apps/plugins/blackjack.o: In function `plugin_
start':
blackjack.c:(.text+0x1324): undefined reference to `plugin_use_lang'
collect2: ld returned 1 exit status
make: *** [/home/Administrator/rockbox/build/apps/plugins/blackjack.rock] Error
1"
I would be very interested in trying it if any improvements have been made, or just if it is resynced, as I haven't got around to trying it yet in any form.
Thanks.
Comment by Tom Ross (midgey34) - Thursday, 23 July 2009, 05:05 GMT+2
Resync of the patch as requested by Alex. I'll have some time (for real this time) in August to work on this.
   plugin_loc.072209.diff (96 KiB) 
 tools/genlang                     |  337 ++++++++++-----
 tools/make.inc                    |    4 
 apps/language.c                   |  111 +++-
 apps/language.h                   |   18 
 apps/lang/english.lang            |  851 ++++++++++++++++++++++++++++++++++++++
 apps/lang/espanol.lang            |  612 +++++++++++++++++++++++++++
 apps/lang/lang.make               |    8 
 apps/plugins/chessbox/chessbox.c  |   43 +
 apps/plugins/plugins.make         |    9 
 apps/plugins/lib/pluginlib_lang.c |   59 ++
 apps/plugins/lib/pluginlib_lang.h |   30 +
 apps/plugins/lib/SOURCES          |    1 
 apps/plugins/blackjack.c          |  244 +++++-----
 apps/plugins/chopper.c            |   52 --
 apps/talk.c                       |    5 
 apps/plugin.c                     |   11 
 apps/plugin.h                     |   14 
 17 files changed, 2092 insertions(+), 317 deletions(-)

Comment by harry tu (bookshare) - Tuesday, 27 October 2009, 00:57 GMT+2
I don't understand, would that make "(corelanguagefile).lang" bigger, or would we have "language.lang" and "language-plugins.lang"? Same for the voice files. I'd like to know the status of the patch?

Loading...