mapbox profile specific voice instructions (graphhopper#3165)

* navigation profile specific voiceinstruction placement

* fix: hiking should have been walking

* fix: try to find a mapbox profile for the graphhopper profile

* Revert "fix: try to find a mapbox profile for the graphhopper profile"

This reverts commit 3db1c5b.

* feat: configure DistanceConfig from Profile hints too

* chore: add myself (Karol Olszacki) to the contributors list

* fix: create NavigationTransportMode enum and use that

* fix: make sure we accept all kinds of values for wider compatibility with OSRM/Mapbox/etc

* fix: DistanceConfig enhancement (#6)

* fix: fold more cases into DistanceConfig, remove the new enum and allow usage of existing one

* chore: update the example with gh-centric terms

---------

Co-authored-by: Karol Olszacki <karol.olszacki@pl.bosch.com>

Author: OlafFlebbeBosch

CONTRIBUTORS.md

@@ -49,6 +49,7 @@ Here is an overview:
  * jessLryan, max elevation can now be negative
  * joe-akeem, improvements like #2158
  * JohannesPelzer, improved GPX information and various other things
+ * karololszacki, introduce `navigation_transport_mode` option for Profiles to easily set which Voice Guidance distances to use
  * karussell, one of the core developers
  * khuebner, initial turn costs support
  * kodonnell, adding support for CH and other algorithms (#60) and penalizing inner-link U-turns (#88)

config-example.yml

@@ -30,6 +30,7 @@ graphhopper:
 
   profiles:
    - name: car
+#      navigation_transport_mode: "car"
 #     turn_costs:
 #       vehicle_types: [motorcar, motor_vehicle]
 #       u_turn_costs: 60
@@ -39,15 +40,19 @@ graphhopper:
 #   You can use the following in-built profiles. After you start GraphHopper it will print which encoded values you'll have to add to graph.encoded_values in this config file.
 #
 #    - name: foot
+#      navigation_transport_mode: "foot"
 #      custom_model_files: [foot.json, foot_elevation.json]
 #
 #    - name: bike
+#      navigation_transport_mode: "bike"
 #      custom_model_files: [bike.json, bike_elevation.json]
 #
 #    - name: racingbike
+#      navigation_transport_mode: "bike"
 #      custom_model_files: [racingbike.json, bike_elevation.json]
 #
 #    - name: mtb
+#      navigation_transport_mode: "bike"
 #      custom_model_files: [mtb.json, bike_elevation.json]
 #
 #    # See the bus.json for more details.

navigation/src/main/java/com/graphhopper/navigation/DistanceConfig.java

@@ -17,6 +17,9 @@
  */
 package com.graphhopper.navigation;
 
+import com.graphhopper.config.Profile;
+import com.graphhopper.routing.util.TransportationMode;
+import com.graphhopper.util.Helper;
 import com.graphhopper.util.TranslationMap;
 
 import java.util.ArrayList;
@@ -30,22 +33,65 @@ public class DistanceConfig {
     final List<VoiceInstructionConfig> voiceInstructions;
     final DistanceUtils.Unit unit;
 
-    public DistanceConfig(DistanceUtils.Unit unit, TranslationMap translationMap, Locale locale) {
+    public DistanceConfig(DistanceUtils.Unit unit, TranslationMap translationMap, Locale locale, Profile profile) {
+        this(unit, translationMap, locale, profile.getHints().getString("navigation_transport_mode", ""));
+    }
+
+    public DistanceConfig(DistanceUtils.Unit unit, TranslationMap translationMap, Locale locale, TransportationMode mode) {
+        this(unit, translationMap, locale, mode.name());
+    }
+
+    public DistanceConfig(DistanceUtils.Unit unit, TranslationMap translationMap, Locale locale, String mode) {
         this.unit = unit;
-        if (unit == DistanceUtils.Unit.METRIC) {
-            voiceInstructions = Arrays.asList(
-                    new InitialVoiceInstructionConfig(FOR_HIGHER_DISTANCE_PLURAL.metric, translationMap, locale, 4250, 250, unit),
-                    new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_PLURAL.metric, translationMap, locale, 2000, 2),
-                    new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_SINGULAR.metric, translationMap, locale, 1000, 1),
-                    new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.metric, translationMap, locale, new int[]{400, 200}, new int[]{400, 200})
-            );
-        } else {
-            voiceInstructions = Arrays.asList(
-                    new InitialVoiceInstructionConfig(FOR_HIGHER_DISTANCE_PLURAL.metric, translationMap, locale, 4250, 250, unit),
-                    new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_PLURAL.imperial, translationMap, locale, 3220, 2),
-                    new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_SINGULAR.imperial, translationMap, locale, 1610, 1),
-                    new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.imperial, translationMap, locale, new int[]{400, 200}, new int[]{1300, 600})
-            );
+        switch (Helper.toLowerCase(mode)) {
+            case "biking":
+            case "cycling":
+            case "cyclist":
+            case "mtb":
+            case "racingbike":
+            case "bike":
+            if (unit == DistanceUtils.Unit.METRIC) {
+                voiceInstructions =  Arrays.asList(
+                    new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.metric, translationMap, locale, new int[]{150},
+                        new int[]{150}));
+            } else {
+                voiceInstructions =  Arrays.asList(
+                    new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.imperial, translationMap, locale, new int[]{150},
+                        new int[]{500}));
+            }
+            break;
+            case "walking":
+            case "walk":
+            case "hiking":
+            case "hike":
+            case "foot":
+            case "pedestrian":
+            if (unit == DistanceUtils.Unit.METRIC) {
+                voiceInstructions =  Arrays.asList(
+                    new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.metric, translationMap, locale, new int[]{50},
+                        new int[]{50}));
+            } else {
+                voiceInstructions =  Arrays.asList(
+                    new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.imperial, translationMap, locale, new int[]{50},
+                        new int[]{150}));
+            }
+            break;
+            default:
+            if (unit == DistanceUtils.Unit.METRIC) {
+                voiceInstructions = Arrays.asList(
+                        new InitialVoiceInstructionConfig(FOR_HIGHER_DISTANCE_PLURAL.metric, translationMap, locale, 4250, 250, unit),
+                        new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_PLURAL.metric, translationMap, locale, 2000, 2),
+                        new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_SINGULAR.metric, translationMap, locale, 1000, 1),
+                        new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.metric, translationMap, locale, new int[]{400, 200}, new int[]{400, 200})
+                );
+            } else {
+                voiceInstructions = Arrays.asList(
+                        new InitialVoiceInstructionConfig(FOR_HIGHER_DISTANCE_PLURAL.metric, translationMap, locale, 4250, 250, unit),
+                        new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_PLURAL.imperial, translationMap, locale, 3220, 2),
+                        new FixedDistanceVoiceInstructionConfig(IN_HIGHER_DISTANCE_SINGULAR.imperial, translationMap, locale, 1610, 1),
+                        new ConditionalDistanceVoiceInstructionConfig(IN_LOWER_DISTANCE_PLURAL.imperial, translationMap, locale, new int[]{400, 200}, new int[]{1300, 600})
+                );
+            }
         }
 
     }

navigation/src/main/java/com/graphhopper/navigation/NavigateResource.java

@@ -144,7 +144,7 @@ public Response doGet(
         } else {
             DistanceUtils.Unit unit = voiceUnits.equals("metric") ? DistanceUtils.Unit.METRIC : DistanceUtils.Unit.IMPERIAL;
             Locale locale = Helper.getLocale(localeStr);
-            DistanceConfig config = new DistanceConfig(unit, translationMap, locale);
+            DistanceConfig config = new DistanceConfig(unit, translationMap, locale, graphHopper.getProfile(ghProfile));
             logger.info(logStr);
             return Response.ok(NavigateResponseConverter.convertFromGHResponse(ghResponse, translationMap, locale, config)).
                     header("X-GH-Took", "" + Math.round(took * 1000)).
@@ -214,7 +214,7 @@ public Response doPost(@NotNull GHRequest request, @Context HttpServletRequest h
                 unit = DistanceUtils.Unit.IMPERIAL;
             }
 
-            DistanceConfig config = new DistanceConfig(unit, translationMap, request.getLocale());
+            DistanceConfig config = new DistanceConfig(unit, translationMap, request.getLocale(), graphHopper.getProfile(request.getProfile()));
             logger.info(logStr);
             return Response.ok(NavigateResponseConverter.convertFromGHResponse(ghResponse, translationMap, request.getLocale(), config)).
                     header("X-GH-Took", "" + Math.round(took * 1000)).

navigation/src/test/java/com/graphhopper/navigation/DistanceConfigTest.java

@@ -0,0 +1,53 @@
+package com.graphhopper.navigation;
+
+import com.graphhopper.config.Profile;
+import com.graphhopper.routing.util.TransportationMode;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class DistanceConfigTest {
+
+    @Test
+    public void distanceConfigTest() {
+        // from TransportationMode
+        DistanceConfig car = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, TransportationMode.CAR);
+        assertEquals(4, car.voiceInstructions.size());
+        DistanceConfig foot = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, TransportationMode.FOOT);
+        assertEquals(1, foot.voiceInstructions.size());
+        DistanceConfig bike = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, TransportationMode.BIKE);
+        assertEquals(1, bike.voiceInstructions.size());
+        DistanceConfig bus = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, TransportationMode.BUS);
+        assertEquals(4, bus.voiceInstructions.size());
+
+
+        // from Profile
+        Profile awesomeProfile = new Profile("my_awesome_profile").putHint("navigation_transport_mode", "car");
+        DistanceConfig carFromProfile = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, awesomeProfile);
+        assertEquals(4, carFromProfile.voiceInstructions.size());
+
+        Profile fastWalkProfile = new Profile("my_fast_walk_profile").putHint("navigation_transport_mode", "foot");
+        DistanceConfig footFromProfile = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, fastWalkProfile);
+        assertEquals(1, footFromProfile.voiceInstructions.size());
+
+        Profile crazyMtbProfile = new Profile("my_crazy_mtb").putHint("navigation_transport_mode", "bike");
+        DistanceConfig bikeFromProfile = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, crazyMtbProfile);
+        assertEquals(1, bikeFromProfile.voiceInstructions.size());
+
+        Profile truckProfile = new Profile("my_truck"); // no hint set, so defaults to car
+        DistanceConfig truckCfg = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, truckProfile);
+        assertEquals(4, truckCfg.voiceInstructions.size());
+
+
+        // from String
+        DistanceConfig driving = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, "driving");
+        assertEquals(4, driving.voiceInstructions.size());
+        DistanceConfig anything = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, "anything");
+        assertEquals(4, anything.voiceInstructions.size());
+        DistanceConfig none = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, "");
+        assertEquals(4, none.voiceInstructions.size());
+        DistanceConfig biking = new DistanceConfig(DistanceUtils.Unit.METRIC, null, null, "biking");
+        assertEquals(1, biking.voiceInstructions.size());
+    }
+
+}

navigation/src/test/java/com/graphhopper/navigation/NavigateResponseConverterTest.java

@@ -7,6 +7,7 @@
 import com.graphhopper.GraphHopper;
 import com.graphhopper.jackson.ResponsePathSerializer;
 import com.graphhopper.routing.TestProfiles;
+import com.graphhopper.routing.util.TransportationMode;
 import com.graphhopper.util.Helper;
 import com.graphhopper.util.Parameters;
 import com.graphhopper.util.PointList;
@@ -29,9 +30,8 @@ public class NavigateResponseConverterTest {
     private static final String osmFile = "../core/files/andorra.osm.gz";
     private static GraphHopper hopper;
     private static final String profile = "my_car";
-
     private final TranslationMap trMap = hopper.getTranslationMap();
-    private final DistanceConfig distanceConfig = new DistanceConfig(DistanceUtils.Unit.METRIC, trMap, Locale.ENGLISH);
+    private final DistanceConfig distanceConfig = new DistanceConfig(DistanceUtils.Unit.METRIC, trMap, Locale.ENGLISH, TransportationMode.CAR);
 
     @BeforeAll
     public static void beforeClass() {
@@ -183,7 +183,7 @@ public void voiceInstructionsImperialTest() {
         GHResponse rsp = hopper.route(new GHRequest(42.554851, 1.536198, 42.510071, 1.548128).setProfile(profile));
 
         ObjectNode json = NavigateResponseConverter.convertFromGHResponse(rsp, trMap, Locale.ENGLISH,
-                new DistanceConfig(DistanceUtils.Unit.IMPERIAL, trMap, Locale.ENGLISH));
+                new DistanceConfig(DistanceUtils.Unit.IMPERIAL, trMap, Locale.ENGLISH, TransportationMode.CAR));
 
         JsonNode steps = json.get("routes").get(0).get("legs").get(0).get("steps");
 
@@ -212,6 +212,146 @@ public void voiceInstructionsImperialTest() {
         assertEquals("keep right", voiceInstruction.get("announcement").asText());
     }
 
+    @Test
+    public void voiceInstructionsWalkingMetricTest() {
+
+        GHResponse rsp = hopper.route(new GHRequest(42.554851, 1.536198, 42.510071, 1.548128).setProfile(profile));
+
+        ObjectNode json = NavigateResponseConverter.convertFromGHResponse(rsp, trMap, Locale.ENGLISH,
+                new DistanceConfig(DistanceUtils.Unit.METRIC, trMap, Locale.ENGLISH, TransportationMode.FOOT));
+
+        JsonNode steps = json.get("routes").get(0).get("legs").get(0).get("steps");
+
+        // Step 4 is about 240m long
+        JsonNode step = steps.get(4);
+        JsonNode maneuver = step.get("maneuver");
+
+        JsonNode voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        JsonNode voiceInstruction = voiceInstructions.get(0);
+        assertEquals(50, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 50 meters At roundabout, take exit 2 onto CS-340, then At roundabout, take exit 2 onto CG-3",
+                voiceInstruction.get("announcement").asText());
+
+        // Step 14 is over 3km long
+        step = steps.get(14);
+        maneuver = step.get("maneuver");
+
+        voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        voiceInstruction = voiceInstructions.get(0);
+        assertEquals(50, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 50 meters keep right", voiceInstruction.get("announcement").asText());
+
+        voiceInstruction = voiceInstructions.get(1);
+        assertEquals("keep right", voiceInstruction.get("announcement").asText());
+    }
+
+    @Test
+    public void voiceInstructionsWalkingImperialTest() {
+
+        GHResponse rsp = hopper.route(new GHRequest(42.554851, 1.536198, 42.510071, 1.548128).setProfile(profile));
+
+        ObjectNode json = NavigateResponseConverter.convertFromGHResponse(rsp, trMap, Locale.ENGLISH,
+                new DistanceConfig(DistanceUtils.Unit.IMPERIAL, trMap, Locale.ENGLISH, TransportationMode.FOOT));
+
+        JsonNode steps = json.get("routes").get(0).get("legs").get(0).get("steps");
+
+        // Step 4 is about 240m long
+        JsonNode step = steps.get(4);
+        JsonNode maneuver = step.get("maneuver");
+
+        JsonNode voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        JsonNode voiceInstruction = voiceInstructions.get(0);
+        assertEquals(50, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 150 feet At roundabout, take exit 2 onto CS-340, then At roundabout, take exit 2 onto CG-3",
+                voiceInstruction.get("announcement").asText());
+
+        // Step 14 is over 3km long
+        step = steps.get(14);
+        maneuver = step.get("maneuver");
+
+        voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        voiceInstruction = voiceInstructions.get(0);
+        assertEquals(50, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 150 feet keep right", voiceInstruction.get("announcement").asText());
+
+        voiceInstruction = voiceInstructions.get(1);
+        assertEquals("keep right", voiceInstruction.get("announcement").asText());
+    }
+
+    @Test
+    public void voiceInstructionsCyclingMetricTest() {
+
+        GHResponse rsp = hopper.route(new GHRequest(42.554851, 1.536198, 42.510071, 1.548128).setProfile(profile));
+
+        ObjectNode json = NavigateResponseConverter.convertFromGHResponse(rsp, trMap, Locale.ENGLISH,
+                new DistanceConfig(DistanceUtils.Unit.METRIC, trMap, Locale.ENGLISH, TransportationMode.BIKE));
+
+        JsonNode steps = json.get("routes").get(0).get("legs").get(0).get("steps");
+
+        // Step 4 is about 240m long
+        JsonNode step = steps.get(4);
+        JsonNode maneuver = step.get("maneuver");
+
+        JsonNode voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        JsonNode voiceInstruction = voiceInstructions.get(0);
+        assertEquals(150, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 150 meters At roundabout, take exit 2 onto CS-340, then At roundabout, take exit 2 onto CG-3",
+                voiceInstruction.get("announcement").asText());
+
+        // Step 14 is over 3km long
+        step = steps.get(14);
+        maneuver = step.get("maneuver");
+
+        voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        voiceInstruction = voiceInstructions.get(0);
+        assertEquals(150, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 150 meters keep right", voiceInstruction.get("announcement").asText());
+
+        voiceInstruction = voiceInstructions.get(1);
+        assertEquals("keep right", voiceInstruction.get("announcement").asText());
+    }
+
+    @Test
+    public void voiceInstructionsCyclingImperialTest() {
+
+        GHResponse rsp = hopper.route(new GHRequest(42.554851, 1.536198, 42.510071, 1.548128).setProfile(profile));
+
+        ObjectNode json = NavigateResponseConverter.convertFromGHResponse(rsp, trMap, Locale.ENGLISH,
+                new DistanceConfig(DistanceUtils.Unit.IMPERIAL, trMap, Locale.ENGLISH, TransportationMode.BIKE));
+
+        JsonNode steps = json.get("routes").get(0).get("legs").get(0).get("steps");
+
+        // Step 4 is about 240m long
+        JsonNode step = steps.get(4);
+        JsonNode maneuver = step.get("maneuver");
+
+        JsonNode voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        JsonNode voiceInstruction = voiceInstructions.get(0);
+        assertEquals(150, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 500 feet At roundabout, take exit 2 onto CS-340, then At roundabout, take exit 2 onto CG-3",
+                voiceInstruction.get("announcement").asText());
+
+        // Step 14 is over 3km long
+        step = steps.get(14);
+        maneuver = step.get("maneuver");
+
+        voiceInstructions = step.get("voiceInstructions");
+        assertEquals(2, voiceInstructions.size());
+        voiceInstruction = voiceInstructions.get(0);
+        assertEquals(150, voiceInstruction.get("distanceAlongGeometry").asDouble(), 1);
+        assertEquals("In 500 feet keep right", voiceInstruction.get("announcement").asText());
+
+        voiceInstruction = voiceInstructions.get(1);
+        assertEquals("keep right", voiceInstruction.get("announcement").asText());
+    }
+
     @Test
     @Disabled
     public void alternativeRoutesTest() {
@@ -244,7 +384,7 @@ public void voiceInstructionTranslationTest() {
         rsp = hopper.route(
                 new GHRequest(42.554851, 1.536198, 42.510071, 1.548128).setProfile(profile).setLocale(Locale.GERMAN));
 
-        DistanceConfig distanceConfigGerman = new DistanceConfig(DistanceUtils.Unit.METRIC, trMap, Locale.GERMAN);
+        DistanceConfig distanceConfigGerman = new DistanceConfig(DistanceUtils.Unit.METRIC, trMap, Locale.GERMAN, TransportationMode.CAR);
 
         json = NavigateResponseConverter.convertFromGHResponse(rsp, trMap, Locale.GERMAN, distanceConfigGerman);