[routing] Add the street name to verbal turn instructions #3118

zyphlar · 2022-08-08T03:54:29Z

zyphlar commented

2022-08-08 03:54:29 +00:00

Inserts the "nextStreet" variable into the Notifications struct
and then speaks that value with a new "onto" localized word joining
things for TTS output like "in 500 meters, turn left onto Main St."

I omitted the immediate "turn left / then turn right" notifications
since by then it's usually too late to read a street sign and it
can sound repetitious. A TODO is to check highway entrances/exits for
sane language (ideally "Take exit 123 for Main Street, City Center.)

I've added the "onto" localized string and poorly translated it into
all language files. A few languages didn't seem to have equivalents.
I also removed the period from the locale strings so announcements
flow naturally as one sentence.

The best localization would probably be to use formatter strings,
like "in 5000 feet" "turn left onto %s" so that languages with other
orderings or dynamic prepositional syntaxes can sound more natural.

Signed DCO.

I'm not natively a CPP programmer and I don't know how to run the test suite, I'm sure the TTS changes may cause those tests to fail.
Also I'm unsure what the localization/translation process is like, marking the "onto" string as desiring of feedback would be ideal.
I've tested this on my Android 12 phone but have no way to test iPhone.

Inserts the "nextStreet" variable into the Notifications struct and then speaks that value with a new "onto" localized word joining things for TTS output like "in 500 meters, turn left onto Main St." I omitted the immediate "turn left / then turn right" notifications since by then it's usually too late to read a street sign and it can sound repetitious. A TODO is to check highway entrances/exits for sane language (ideally "Take exit 123 for Main Street, City Center.) I've added the "onto" localized string and poorly translated it into all language files. A few languages didn't seem to have equivalents. I also removed the period from the locale strings so announcements flow naturally as one sentence. The best localization would probably be to use formatter strings, like "in 5000 feet" "turn left onto %s" so that languages with other orderings or dynamic prepositional syntaxes can sound more natural. --- Signed DCO. --- I'm not natively a CPP programmer and I don't know how to run the test suite, I'm sure the TTS changes may cause those tests to fail. Also I'm unsure what the localization/translation process is like, marking the `"onto"` string as desiring of feedback would be ideal. I've tested this on my Android 12 phone but have no way to test iPhone.

👍 3

vng commented

2022-08-08 05:05:17 +00:00

(Migrated from github.com)

Great, thanks!

Please, fix ./data/strings/sounds.txt. Files like ./data/sound-strings/ar.json are generated by ./tools/unix/generate_localizations.sh script.
Better to take out string manipulations into separate commit.

Will take a look at the code :)

Great, thanks! - Please, fix ./data/strings/sounds.txt. Files like ./data/sound-strings/ar.json are generated by ./tools/unix/generate_localizations.sh script. - Better to take out string manipulations into separate commit. Will take a look at the code :)

vng (Migrated from github.com) reviewed 2022-08-08 05:13:29 +00:00

routing/turns_notification_manager.cpp

					
				@ -76,2 +76,3 @@

				                                             measurement_utils::Units lengthUnits) const

				                                             measurement_utils::Units lengthUnits,

				                                             std::string nextStreet) const

				{

vng (Migrated from github.com) commented

2022-08-08 05:11:58 +00:00

Better to use std::string const & nextStreet here and below.

routing/turns_tts_text.cpp

vng (Migrated from github.com) commented

2022-08-08 05:08:38 +00:00

We should add "onto" to the sound.txt with all the localizations. And I suspect that it's not an easy task according to languages grammar (not sure that we even can rely on a fixed word's order).

zyphlar commented

2022-08-08 06:10:24 +00:00

@vng thanks for the review, all this seems fine. I mentioned the possibility of using formatter strings like

sprintf("Turn left onto %s", streetName);

However this would duplicate half the sounds.txt and as far as I could tell from automated translation suggestions only benefit a few languages, with Japanese and Turkish coming to mind, maybe a couple others. (Most languages seem happy to have the same ordering and I suspect users of these languages may be able to understand even if it sounds artificial... it is a robot after all.) I also worry about missing strings or misaligned formatters/types, maybe a sprintf wrapper to sanity check the inputs is advised.

Your choice, I am happy to do either way. Did you want me to edit strings.txt in this PR while reverting the individual locale files?

@vng thanks for the review, all this seems fine. I mentioned the possibility of using formatter strings like ``` sprintf("Turn left onto %s", streetName); ``` However this would duplicate half the sounds.txt and as far as I could tell from automated translation suggestions only benefit a few languages, with Japanese and Turkish coming to mind, maybe a couple others. (Most languages seem happy to have the same ordering and I suspect users of these languages may be able to understand even if it sounds artificial... it is a robot after all.) I also worry about missing strings or misaligned formatters/types, maybe a sprintf wrapper to sanity check the inputs is advised. Your choice, I am happy to do either way. Did you want me to edit strings.txt in this PR while reverting the individual locale files?

vng commented

2022-08-08 06:19:21 +00:00

(Migrated from github.com)

Agree, so:
1st commit: remove useless dots, add "onto" stub into sound.txt
2nd commit: Regenerated strings by generate_localizations.sh
3rd commit: Code modifications

Agree, so: 1st commit: remove useless dots, add "onto" stub into sound.txt 2nd commit: Regenerated strings by generate_localizations.sh 3rd commit: Code modifications

zyphlar commented

2022-08-08 06:31:14 +00:00

@vng which do you prefer, copying half of sound.txt like

[turn_right]
en: Turn right

[turn_right_onto]
en: Turn right onto %s

Or simply adding a single new string and forcing a few languages to have Western-style ordering:

[onto]
en: on to

@vng which do you prefer, copying half of sound.txt like ``` [turn_right] en: Turn right [turn_right_onto] en: Turn right onto %s ``` Or simply adding a single new string and forcing a few languages to have Western-style ordering: ``` [onto] en: on to ```

vng commented

2022-08-08 06:35:43 +00:00

(Migrated from github.com)

Single one new string [onto]