Add auto_webmercator to COG

Cargo.toml

@@ -49,6 +49,8 @@ env_logger = "0.11"
 flate2 = "1"
 flume = "0.11"
 futures = "0.3"
+image = "0.25.6"
+imageproc = "0.25.0"
 indoc = "2"
 insta = "1"
 itertools = "0.14"

docs/src/SUMMARY.md

@@ -23,6 +23,7 @@
     - [PostgreSQL Connections](pg-connections.md)
       - [PostgreSQL Table Sources](sources-pg-tables.md)
       - [PostgreSQL Function Sources](sources-pg-functions.md)
+  - [Cloud-Optimized-GeoTIFF Sources](sources-cog-files.md)
     - [Composite Sources](sources-composite.md)
   - [Supporting Resources](sources-resources.md)
     - [Sprites](sources-sprites.md)

docs/src/sources-cog-files.md

@@ -17,44 +17,34 @@ Martin can also serve raster sources like local [COG(Cloud Optimized GeoTIFF)](h
 * Deflate
 * PackBits
 
-## Run Martin with CLI to serve cog files
+## Supported Projection
 
-```bash
-# Configured with a directory containing `*.tif` or `*.tiff` TIFF files.
-martin /with/tiff/dir1 /with/tiff/dir2
-# Configured with dedicated TIFF file
-martin /path/to/target1.tif /path/to/target2.tiff
-# Configured with a combination of directories and dedicated TIFF files.
-martin /with/tiff/files /path/to/target1.tif /path/to/target2.tiff
-```
-
-## Run Martin with configuration file
+Currently we only support COGS with [EPSG:3857](https://epsg.io/3857) by enable the `auto-web` option.
 
-```yml
-keep_alive: 75
-
-# The socket address to bind [default: 0.0.0.0:3000]
-listen_addresses: '0.0.0.0:3000'
+It's beacause the [Tile Matrix Set](https://docs.ogc.org/is/17-083r2/17-083r2.html#72) inside each COG file is highly customized for its extent and tilesize. It's not aligned
+with any well knowed TIle Matrix Set.
 
-# Number of web server workers
-worker_processes: 8
+To load COG file, there are two approaches generally:
 
-# Amount of memory (in MB) to use for caching tiles [default: 512, 0 to disable]
-cache_size_mb: 8
+1. The client(`Maplibre`, `OpenLayers`,etc) load COG file with the specific customized [Tile Matrix Set](https://docs.ogc.org/is/17-083r2/17-083r2.html#72). As martin support various data sources we need to find one general way to support `not-3857` projections and to tell clients the TMS. [Join our disscussion there](https://github.com/maplibre/martin/issues/343).
+2. Martin serve COG files with well known [Tile Matrix Set](https://docs.ogc.org/is/17-083r2/17-083r2.html#72) and do the clipping internally. Currently we support the [WebMercatorQuad](https://docs.ogc.org/is/17-083r2/17-083r2.html#72) with `auto-web` configuration.
 
-# Database configuration. This can also be a list of PG configs.
+## configuration file
 
+```yml
 cog:
-  paths:
-    # scan this whole dir, matching all *.tif and *.tiff files
-    - /dir-path
-    # specific TIFF file will be published as a cog source
-    - /path/to/target1.tif
-    - /path/to/target2.tiff
+  # Default false
+  # If enabled, martin will automatically serve COG as a [WebMercatorQuad](https://docs.ogc.org/is/17-083r2/17-083r2.html#72) service, the tiles will be cliped and merged internally to be aligned with the Web Mercator grid.
+  # Note: Just work for COG files with a Web Mercator CRS (EPSG:3857).
+  auto_web: false
   sources:
-    # named source matching source name to a single file
-     cog-src1: /path/to/cog1.tif
-     cog-src2: /path/to/cog2.tif
+    cog-src2: tests/fixtures/cog/rgb_u8.tif
+    cog-src1: tests/fixtures/cog/rgba_u8.tif
+    # Test COG with auto_webmercator enabled
+    cog-auto-web:
+      path: tests/fixtures/cog/rgba_u8_nodata.tiff
+      # inline option. Would override the global dauto_web.
+      auto_web: true
 ```
 
 ## About COG

martin-tile-utils/src/lib.rs

@@ -272,6 +272,30 @@ pub fn tile_index(lng: f64, lat: f64, zoom: u8) -> (u32, u32) {
     (col, row)
 }
 
+/// Convert min/max XYZ tile coordinates to a bounding box values in Web Mercator.
+#[must_use]
+pub fn xyz_to_bbox_webmercator(
+    zoom: u8,
+    min_x: u32,
+    min_y: u32,
+    max_x: u32,
+    max_y: u32,
+) -> [f64; 4] {
+    assert!(zoom <= MAX_ZOOM, "zoom {zoom} must be <= {MAX_ZOOM}");
+
+    let tile_length = EARTH_CIRCUMFERENCE / f64::from(1_u32 << zoom);
+
+    let left_down_bbox = tile_bbox(min_x, max_y, tile_length);
+    let right_top_bbox = tile_bbox(max_x, min_y, tile_length);
+
+    [
+        left_down_bbox[0],
+        left_down_bbox[1],
+        right_top_bbox[2],
+        right_top_bbox[3],
+    ]
+}
+
 /// Convert min/max XYZ tile coordinates to a bounding box values.
 ///
 /// The result is `[min_lng, min_lat, max_lng, max_lat]`

martin/Cargo.toml

@@ -68,7 +68,7 @@ default = [
     "styles",
     "webui",
 ]
-cog = ["dep:png", "dep:tiff"]
+cog = ["dep:tiff", "dep:png", "dep:image", "dep:imageproc"]
 fonts = ["dep:bit-set", "dep:pbf_font_tools", "dep:regex"]
 lambda = ["dep:lambda-web"]
 mbtiles = ["dep:mbtiles"]
@@ -108,6 +108,8 @@ deadpool-postgres = { workspace = true, optional = true }
 enum-display = { workspace = true, optional = true }
 env_logger.workspace = true
 futures.workspace = true
+image = { workspace = true, optional = true }
+imageproc = { workspace = true, optional = true }
 itertools.workspace = true
 json-patch = { workspace = true, optional = true }
 lambda-web = { workspace = true, optional = true }

martin/src/cog/config.rs

@@ -13,6 +13,11 @@ use crate::{MartinResult, TileInfoSource};
 pub struct CogConfig {
     #[serde(flatten)]
     pub unrecognized: UnrecognizedValues,
+
+    /// Default false
+    /// If enabled, martin will automatically serve COG as a [WebMercatorQuad](https://docs.ogc.org/is/17-083r2/17-083r2.html#72) service, the tiles will be cliped and merged internally to be aligned with the Web Mercator grid.
+    /// Note: Just work for COG files with a Web Mercator CRS (EPSG:3857).
+    pub auto_web: Option<bool>,
 }
 
 impl ConfigExtras for CogConfig {
@@ -27,7 +32,32 @@ impl SourceConfigExtras for CogConfig {
     }
 
     async fn new_sources(&self, id: String, path: PathBuf) -> MartinResult<TileInfoSource> {
-        let cog = CogSource::new(id, path)?;
+        let cog = CogSource::new(id, path, self.auto_web.unwrap_or(false))?;
+        Ok(Box::new(cog))
+    }
+
+    async fn new_sources_with_config(
+        &self,
+        id: String,
+        path: PathBuf,
+        config: serde_yaml::Value,
+    ) -> MartinResult<TileInfoSource> {
+        let source_auto_web = if let serde_yaml::Value::Mapping(map) = &config {
+            if let Some(auto_web_value) = map.get(serde_yaml::Value::String("auto_web".to_string()))
+            {
+                match auto_web_value {
+                    serde_yaml::Value::Bool(b) => Some(*b),
+                    _ => None,
+                }
+            } else {
+                None
+            }
+        } else {
+            None
+        };
+
+        let auto_web = source_auto_web.unwrap_or_else(|| self.auto_web.unwrap_or(false));
+        let cog = CogSource::new(id, path, auto_web)?;
         Ok(Box::new(cog))
     }
 

martin/src/cog/errors.rs

@@ -63,4 +63,7 @@ pub enum CogError {
         "Get full resolution failed for {0}: either a valid ModelPixelScaleTag or ModelPixelScaleTag is required"
     )]
     GetFullResolutionFailed(PathBuf),
+
+    #[error("Failed to create image buffer for {0}: {1}")]
+    ImageBufferCreationFailed(PathBuf, String),
 }