Merge pull request OSGeo#13030 from rouault/fix_13025

WEBP: add read and creation support for .wld worldfiles

Author: rouault

autotest/gdrivers/webp.py

@@ -202,3 +202,23 @@ def my_callback(pct, msg, user_data):
 
     with gdal.Open(out_filename) as ds:
         ds.GetRasterBand(1).Checksum()
+
+
+###############################################################################
+
+
+def test_webp_world_file(tmp_vsimem):
+
+    src_ds = gdal.Open("data/rgbsmall.tif")
+
+    drv = gdal.GetDriverByName("WEBP")
+    drv.CreateCopy(tmp_vsimem / "out.webp", src_ds, options={"WORLDFILE": "YES"})
+    assert gdal.VSIStatL(tmp_vsimem / "out.wld") is not None
+    gdal.Unlink(tmp_vsimem / "out.webp.aux.xml")
+    with gdal.Open(tmp_vsimem / "out.webp") as ds:
+        assert ds.GetGeoTransform() == pytest.approx(src_ds.GetGeoTransform())
+    with gdal.Open(tmp_vsimem / "out.webp") as ds:
+        assert ds.GetFileList() == [
+            str(tmp_vsimem / "out.webp"),
+            str(tmp_vsimem / "out.wld"),
+        ]

doc/source/drivers/raster/jpeg.rst

@@ -166,7 +166,8 @@ to the JPEG file.
 The following creation options are supported:
 
 -  .. co:: WORLDFILE
-      :choices: YES
+      :choices: YES,NO
+      :default: NO
 
       Force the generation of an associated ESRI world
       file (with the extension .wld). See :ref:`World Files <raster.wld>`

doc/source/drivers/raster/webp.rst

@@ -25,6 +25,10 @@ The WEBP driver supports 3 bands (RGB) images. It also supports 4 bands (RGBA)
 XMP metadata can be extracted from the file,
 and will be stored as XML raw content in the xml:XMP metadata domain.
 
+Since 3.12, if an ESRI :ref:`world file <raster.wld>` exists with the
+``.webpw`` or ``.wld`` suffixes, it will be read and used to establish the
+geotransform for the image.
+
 Driver capabilities
 -------------------
 
@@ -65,6 +69,15 @@ Various creation options exists, among them :
       compression, the regular conversion code path is taken, resulting in a
       lossless or lossy copy depending on the LOSSLESS setting.
 
+-  .. co:: WORLDFILE
+      :choices: YES,NO
+      :default: NO
+      :since: 3.12
+
+      Force the generation of an associated ESRI world
+      file (with the extension ``.wld``). See :ref:`World Files <raster.wld>`
+      section for details.
+
 See Also
 --------
 

frmts/webp/webpdataset.cpp

@@ -42,10 +42,16 @@ class WEBPDataset final : public GDALPamDataset
 
     CPL_DISALLOW_COPY_ASSIGN(WEBPDataset)
 
+    CPLErr GetGeoTransform(GDALGeoTransform &gt,
+                           std::string &osWorldFilename) const;
+
   public:
     WEBPDataset();
     ~WEBPDataset() override;
 
+    char **GetFileList() override;
+
+    CPLErr GetGeoTransform(GDALGeoTransform &gt) const override;
     CPLErr IRasterIO(GDALRWFlag, int, int, int, int, void *, int, int,
                      GDALDataType, int, BANDMAP_TYPE, GSpacing nPixelSpace,
                      GSpacing nLineSpace, GSpacing nBandSpace,
@@ -173,6 +179,54 @@ WEBPDataset::~WEBPDataset()
     VSIFree(pabyUncompressed);
 }
 
+/************************************************************************/
+/*                               GetFileList()                          */
+/************************************************************************/
+
+char **WEBPDataset::GetFileList()
+{
+    char **papszFileList = GDALPamDataset::GetFileList();
+    GDALGeoTransform gt;
+    std::string osWorldFilename;
+    CPL_IGNORE_RET_VAL(GetGeoTransform(gt, osWorldFilename));
+    if (!osWorldFilename.empty())
+    {
+        papszFileList = CSLAddString(papszFileList, osWorldFilename.c_str());
+    }
+    return papszFileList;
+}
+
+/************************************************************************/
+/*                            GetGeoTransform()                         */
+/************************************************************************/
+
+CPLErr WEBPDataset::GetGeoTransform(GDALGeoTransform &gt) const
+{
+    std::string osWorldFilename;
+    return GetGeoTransform(gt, osWorldFilename);
+}
+
+CPLErr WEBPDataset::GetGeoTransform(GDALGeoTransform &gt,
+                                    std::string &osWorldFilename) const
+{
+    bool bGeoTransformValid = GDALPamDataset::GetGeoTransform(gt) == CE_None;
+    if (!bGeoTransformValid)
+    {
+        char *pszWldFilename = nullptr;
+        bGeoTransformValid =
+            GDALReadWorldFile2(GetDescription(), ".wld", gt,
+                               oOvManager.GetSiblingFiles(), &pszWldFilename) ||
+            GDALReadWorldFile2(GetDescription(), ".wpw", gt,
+                               oOvManager.GetSiblingFiles(), &pszWldFilename) ||
+            GDALReadWorldFile2(GetDescription(), ".webpw", gt,
+                               oOvManager.GetSiblingFiles(), &pszWldFilename);
+        if (bGeoTransformValid)
+            osWorldFilename = pszWldFilename;
+        CPLFree(pszWldFilename);
+    }
+    return bGeoTransformValid ? CE_None : CE_Failure;
+}
+
 /************************************************************************/
 /*                      GetMetadataDomainList()                         */
 /************************************************************************/
@@ -1083,6 +1137,14 @@ GDALDataset *WEBPDataset::CreateCopy(const char *pszFilename,
         return nullptr;
     }
 
+    // Do we need a world file?
+    if (CPLFetchBool(papszOptions, "WORLDFILE", false))
+    {
+        GDALGeoTransform gt;
+        poSrcDS->GetGeoTransform(gt);
+        GDALWriteWorldFile(pszFilename, "wld", gt.data());
+    }
+
     /* -------------------------------------------------------------------- */
     /*      Re-open dataset, and copy any auxiliary pam information.        */
     /* -------------------------------------------------------------------- */

frmts/webp/webpdrivercore.cpp

@@ -104,6 +104,8 @@ void WEBPDriverSetCommonMetadata(GDALDriver *poDriver)
         "   <Option name='EXACT' type='int' description='preserve the exact "
         "RGB values under transparent area. off=0, on=1' default='0'/>\n"
 #endif
+        "<Option name='WORLDFILE' type='boolean' description='whether "
+        "to generate a worldfile' default='NO'/>\n"
         "</CreationOptionList>\n");
 
     poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");

gcore/gdal_mdreader.cpp

@@ -90,7 +90,7 @@ GDALMDReaderManager::~GDALMDReaderManager()
     delete pReaderBase
 
 GDALMDReaderBase *GDALMDReaderManager::GetReader(const char *pszPath,
-                                                 char **papszSiblingFiles,
+                                                 CSLConstList papszSiblingFiles,
                                                  GUInt32 nType)
 {
     if (!GDALCanFileAcceptSidecarFile(pszPath))
@@ -160,7 +160,7 @@ GDALMDReaderBase *GDALMDReaderManager::GetReader(const char *pszPath,
  * GDALMDReaderBase()
  */
 GDALMDReaderBase::GDALMDReaderBase(const char * /* pszPath */,
-                                   char ** /* papszSiblingFiles */)
+                                   CSLConstList /* papszSiblingFiles */)
 {
 }
 

gcore/gdal_mdreader.h

@@ -116,7 +116,7 @@ class CPL_DLL GDALMDReaderBase
                          const std::string &osPrefixFull);
 
   public:
-    GDALMDReaderBase(const char *pszPath, char **papszSiblingFiles);
+    GDALMDReaderBase(const char *pszPath, CSLConstList papszSiblingFiles);
     virtual ~GDALMDReaderBase();
 
     /**
@@ -214,7 +214,7 @@ class CPL_DLL GDALMDReaderManager
      * delete it.
      */
     virtual GDALMDReaderBase *GetReader(const char *pszPath,
-                                        char **papszSiblingFiles,
+                                        CSLConstList papszSiblingFiles,
                                         GUInt32 nType = MDR_ANY);
 
   protected:

gcore/gdal_priv.h

@@ -311,7 +311,7 @@ class CPL_DLL GDALDefaultOverviews
     int HaveMaskFile(char **papszSiblings = nullptr,
                      const char *pszBasename = nullptr);
 
-    char **GetSiblingFiles()
+    CSLConstList GetSiblingFiles() const
     {
         return papszInitSiblingFiles;
     }

gcore/mdreader/reader_alos.cpp

@@ -28,7 +28,7 @@
  * GDALMDReaderALOS()
  */
 GDALMDReaderALOS::GDALMDReaderALOS(const char *pszPath,
-                                   char **papszSiblingFiles)
+                                   CSLConstList papszSiblingFiles)
     : GDALMDReaderBase(pszPath, papszSiblingFiles)
 {
     const CPLString osDirName = CPLGetDirnameSafe(pszPath);

gcore/mdreader/reader_alos.h

@@ -34,7 +34,7 @@ Common metadata (from metadata filename):
 class GDALMDReaderALOS final : public GDALMDReaderBase
 {
   public:
-    GDALMDReaderALOS(const char *pszPath, char **papszSiblingFiles);
+    GDALMDReaderALOS(const char *pszPath, CSLConstList papszSiblingFiles);
     ~GDALMDReaderALOS() override;
     bool HasRequiredFiles() const override;
     char **GetMetadataFiles() const override;