Use a positioned glyph font encoding for Devanagari (#265)

* Add pmap:script

* Add pgf

* FontRegistry as Singleton

* Keep original Unicode in , store encoded strings in

* Download zip ball

* Store pgf names and versions in tilejson metadata

* Bump minor version, add changelog

Author: wipfli

CHANGELOG.md

@@ -1,3 +1,7 @@
+Tiles v3.7.0
+------
+- Use a positioned glyph font encoding for Devanagari via @wipfli [#265]
+
 Tiles v3.6.0
 ------
 - More places kinds (port from Tilezen), refine zoom levels via @nvkelso [#259]

SEMANTIC-VERSIONING.md

@@ -66,6 +66,7 @@ Upon our version `1.0.0` release Protomaps Basemap makes the following promises
 1. **Simplification** within `kind` **values** at zooms 16 (or max zoom) by removing `common`, `common-optional`, and `optional` **properties** by merging or other method
 1. **Change** of <= -3 (earlier) to default `min_zoom` or `max_zoom` **values** to determine when `kind` is included
 1. **Change** of >= +2 (later) to default `min_zoom` or `max_zoom` **values** to determine when `kind` is included
+1. **Change** of version of a positioned glyph font for an already included script
 
 #### MINOR version increments:
 
@@ -81,6 +82,7 @@ Upon our version `1.0.0` release Protomaps Basemap makes the following promises
 1. **Change** of <= -2 (earlier) to `min_zoom` or `max_zoom` **values** to determine when `kind` is included
 1. **Change** of >= +1 (later) to default `min_zoom` or `max_zoom` **values** to determine when `kind` is included
 1. **Change** the maximum Tilezen zoom (currently zoom 16).
+1. **Add** new positioned glyph font script
 
 #### PATCH version increments
 

tiles/pom.xml

@@ -104,7 +104,7 @@
             <eclipse>
               <version>4.21.0</version>
               <!--suppress UnresolvedMavenProperty -->
-              <file>${maven.multiModuleProjectDirectory}/eclipse-formatter.xml</file>
+              <file>${project.basedir}/eclipse-formatter.xml</file>
             </eclipse>
           </java>
           <markdown>

tiles/src/main/java/com/protomaps/basemap/Basemap.java

@@ -19,7 +19,11 @@
 import com.protomaps.basemap.layers.Roads;
 import com.protomaps.basemap.layers.Transit;
 import com.protomaps.basemap.layers.Water;
+import com.protomaps.basemap.text.FontRegistry;
 import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 
 public class Basemap extends ForwardingProfile {
@@ -97,7 +101,7 @@ public String description() {
 
   @Override
   public String version() {
-    return "3.6.0";
+    return "3.7.0";
   }
 
   @Override
@@ -112,6 +116,21 @@ public String attribution() {
       """.trim();
   }
 
+  @Override
+  public Map<String, String> extraArchiveMetadata() {
+    Map<String, String> result = new HashMap<>();
+
+    FontRegistry fontRegistry = FontRegistry.getInstance();
+    List<String> scripts = fontRegistry.getScripts();
+
+    for (String script : scripts) {
+      result.put("pgf:" + script.toLowerCase() + ":name", fontRegistry.getName(script));
+      result.put("pgf:" + script.toLowerCase() + ":version", fontRegistry.getVersion(script));
+    }
+
+    return result;
+  }
+
   public static void main(String[] args) {
     run(Arguments.fromArgsOrConfigFile(args));
   }
@@ -137,14 +156,22 @@ static void run(Arguments args) {
       .addGeoPackageSource("landcover", sourcesDir.resolve("daylight-landcover.gpkg"),
         "https://r2-public.protomaps.com/datasets/daylight-landcover.gpkg");
 
-    Downloader.create(planetiler.config()).add("ne", neUrl, nePath).run();
+    Path pgfEncodingZip = sourcesDir.resolve("pgf-encoding.zip");
+    Downloader.create(planetiler.config()).add("ne", neUrl, nePath)
+      .add("pgf-encoding", "https://wipfli.github.io/pgf-encoding/pgf-encoding.zip", pgfEncodingZip)
+      .run();
     //      .add("qrank", "https://qrank.wmcloud.org/download/qrank.csv.gz", sourcesDir.resolve("qrank.csv.gz")).run();
 
     var tmpDir = nePath.resolveSibling(nePath.getFileName() + "-unzipped");
     var naturalEarthDb = NaturalEarthDb.fromSqlite(nePath, tmpDir);
     //    var qrankDb = QrankDb.fromCsv(sourcesDir.resolve("qrank.csv.gz"));
     var qrankDb = QrankDb.empty();
 
+    FontRegistry fontRegistry = FontRegistry.getInstance();
+    fontRegistry.setZipFilePath(pgfEncodingZip.toString());
+
+    fontRegistry.loadFontBundle("NotoSansDevanagari-Regular", "1", "Devanagari");
+
     planetiler.setProfile(new Basemap(naturalEarthDb, qrankDb)).setOutput(Path.of(area + ".pmtiles"))
       .run();
   }

tiles/src/main/java/com/protomaps/basemap/layers/Places.java

@@ -13,6 +13,8 @@
 import com.protomaps.basemap.names.NeNames;
 import com.protomaps.basemap.names.OsmNames;
 import com.protomaps.basemap.names.Script;
+import com.protomaps.basemap.text.FontRegistry;
+import com.protomaps.basemap.text.TextEngine;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -138,11 +140,19 @@ public void processNe(SourceFeature sf, FeatureCollector features) {
         // since all these are locality, we hard code kindRank to 2 (needs to match OSM section below)
         .setSortKey(getSortKey(minZoom, 2, populationRank, population, sf.getString("name")));
 
-      var script = Script.getScript(sf.getTag("name").toString());
+      String name = sf.getTag("name").toString();
+      var script = Script.getScript(name);
+
       if (!script.equals("Latin") && !script.equals("Generic")) {
         feat.setAttr("pmap:script", script);
+        FontRegistry fontRegistry = FontRegistry.getInstance();
+        if (fontRegistry.getScripts().contains(script)) {
+          String encodedName = TextEngine.encodeRegisteredScripts(name);
+          feat.setAttr("pmap:pgf:name", encodedName);
+        }
       }
 
+
       // NOTE: The buffer needs to be consistent with the innteral grid pixel sizes
       feat.setPointLabelGridPixelSize(LOCALITY_GRID_SIZE_ZOOM_FUNCTION)
         .setPointLabelGridLimit(LOCALITY_GRID_LIMIT_ZOOM_FUNCTION)

tiles/src/main/java/com/protomaps/basemap/names/NeNames.java

@@ -2,6 +2,8 @@
 
 import com.onthegomap.planetiler.FeatureCollector;
 import com.onthegomap.planetiler.reader.SourceFeature;
+import com.protomaps.basemap.text.FontRegistry;
+import com.protomaps.basemap.text.TextEngine;
 import java.util.Map;
 
 public class NeNames {
@@ -10,17 +12,38 @@ private NeNames() {}
 
   public static FeatureCollector.Feature setNeNames(FeatureCollector.Feature feature, SourceFeature sf,
     int minZoom) {
+    FontRegistry fontRegistry = FontRegistry.getInstance();
+
     for (Map.Entry<String, Object> tag : sf.tags().entrySet()) {
-      var key = tag.getKey();
+      String key = tag.getKey().toString();
+      if (sf.getTag(key) == null) {
+        continue;
+      }
+      String value = sf.getTag(key).toString();
+      var script = Script.getScript(value);
+
+      if (key.startsWith("name_")) {
+        key = key.replace("_", ":");
+      }
+
       if (key.equals("name")) {
-        feature.setAttrWithMinzoom(key, sf.getTag(key), minZoom);
+        feature.setAttrWithMinzoom("name", value, minZoom);
 
-        var script = Script.getScript(sf.getTag(key).toString());
         if (!script.equals("Latin") && !script.equals("Generic")) {
           feature.setAttrWithMinzoom("pmap:script", script, minZoom);
         }
-      } else if (key.startsWith("name_")) {
-        feature.setAttrWithMinzoom(key.replace("_", ":"), sf.getTag(key), minZoom);
+
+        String encodedValue = TextEngine.encodeRegisteredScripts(value);
+        feature.setAttrWithMinzoom("pmap:pgf:name", encodedValue, minZoom);
+      }
+
+      if (key.startsWith("name:")) {
+        feature.setAttrWithMinzoom(key, value, minZoom);
+
+        if (fontRegistry.getScripts().contains(script)) {
+          String encodedValue = TextEngine.encodeRegisteredScripts(value);
+          feature.setAttrWithMinzoom("pmap:pgf:" + key, encodedValue, minZoom);
+        }
       }
     }
 

tiles/src/main/java/com/protomaps/basemap/names/OsmNames.java

@@ -2,6 +2,8 @@
 
 import com.onthegomap.planetiler.FeatureCollector;
 import com.onthegomap.planetiler.reader.SourceFeature;
+import com.protomaps.basemap.text.FontRegistry;
+import com.protomaps.basemap.text.TextEngine;
 import java.text.NumberFormat;
 import java.text.ParsePosition;
 import java.util.Map;
@@ -12,19 +14,32 @@ private OsmNames() {}
 
   public static FeatureCollector.Feature setOsmNames(FeatureCollector.Feature feature, SourceFeature sf,
     int minZoom) {
+    FontRegistry fontRegistry = FontRegistry.getInstance();
     for (Map.Entry<String, Object> tag : sf.tags().entrySet()) {
       var key = tag.getKey();
-      // Full names of places (default and translations)
-      if (key.equals("name") || key.startsWith("name:")) {
-        feature.setAttrWithMinzoom(key, sf.getTag(key), minZoom);
-      }
+      String value = sf.getTag(key).toString();
+      var script = Script.getScript(value);
 
       if (key.equals("name")) {
-        var script = Script.getScript(sf.getTag(key).toString());
+        feature.setAttrWithMinzoom("name", value, minZoom);
+
         if (!script.equals("Latin") && !script.equals("Generic")) {
           feature.setAttrWithMinzoom("pmap:script", script, minZoom);
         }
+
+        String encodedValue = TextEngine.encodeRegisteredScripts(value);
+        feature.setAttrWithMinzoom("pmap:pgf:name", encodedValue, minZoom);
+      }
+
+      if (key.startsWith("name:")) {
+        feature.setAttrWithMinzoom(key, value, minZoom);
+
+        if (fontRegistry.getScripts().contains(script)) {
+          String encodedValue = TextEngine.encodeRegisteredScripts(value);
+          feature.setAttrWithMinzoom("pmap:pgf:" + key, encodedValue, minZoom);
+        }
       }
+
     }
     return feature;
   }

tiles/src/main/java/com/protomaps/basemap/names/Script.java

@@ -1,5 +1,6 @@
 package com.protomaps.basemap.names;
 
+
 public class Script {
 
   private Script() {}