Line data Source code
1 : /******************************************************************************
2 : *
3 : * Project: Virtual GDAL Datasets
4 : * Purpose: Implementation of VRTDataset
5 : * Author: Frank Warmerdam <warmerdam@pobox.com>
6 : *
7 : ******************************************************************************
8 : * Copyright (c) 2001, Frank Warmerdam <warmerdam@pobox.com>
9 : * Copyright (c) 2007-2014, Even Rouault <even dot rouault at spatialys.com>
10 : *
11 : * SPDX-License-Identifier: MIT
12 : ****************************************************************************/
13 :
14 : #include "vrtdataset.h"
15 :
16 : #include "cpl_minixml.h"
17 : #include "cpl_string.h"
18 : #include "gdal_frmts.h"
19 : #include "ogr_spatialref.h"
20 : #include "gdal_thread_pool.h"
21 : #include "gdal_utils.h"
22 :
23 : #include <algorithm>
24 : #include <cassert>
25 : #include <cmath>
26 : #include <set>
27 : #include <typeinfo>
28 : #include "gdal_proxy.h"
29 :
30 : /*! @cond Doxygen_Suppress */
31 :
32 : #define VRT_PROTOCOL_PREFIX "vrt://"
33 :
34 : /************************************************************************/
35 : /* VRTDataset() */
36 : /************************************************************************/
37 :
38 4097 : VRTDataset::VRTDataset(int nXSize, int nYSize, int nBlockXSize, int nBlockYSize)
39 : {
40 4097 : nRasterXSize = nXSize;
41 4097 : nRasterYSize = nYSize;
42 :
43 4097 : m_adfGeoTransform[0] = 0.0;
44 4097 : m_adfGeoTransform[1] = 1.0;
45 4097 : m_adfGeoTransform[2] = 0.0;
46 4097 : m_adfGeoTransform[3] = 0.0;
47 4097 : m_adfGeoTransform[4] = 0.0;
48 4097 : m_adfGeoTransform[5] = 1.0;
49 4097 : m_bBlockSizeSpecified = nBlockXSize > 0 && nBlockYSize > 0;
50 4097 : m_nBlockXSize = nBlockXSize > 0 ? nBlockXSize : std::min(128, nXSize);
51 4097 : m_nBlockYSize = nBlockYSize > 0 ? nBlockYSize : std::min(128, nYSize);
52 :
53 4097 : GDALRegister_VRT();
54 :
55 4097 : poDriver = static_cast<GDALDriver *>(GDALGetDriverByName("VRT"));
56 4097 : }
57 :
58 : /*! @endcond */
59 :
60 : /************************************************************************/
61 : /* VRTCreate() */
62 : /************************************************************************/
63 :
64 : /**
65 : * @see VRTDataset::VRTDataset()
66 : */
67 :
68 1828 : VRTDatasetH CPL_STDCALL VRTCreate(int nXSize, int nYSize)
69 :
70 : {
71 1828 : auto poDS = new VRTDataset(nXSize, nYSize);
72 1828 : poDS->eAccess = GA_Update;
73 1828 : return poDS;
74 : }
75 :
76 : /*! @cond Doxygen_Suppress */
77 :
78 : /************************************************************************/
79 : /* ~VRTDataset() */
80 : /************************************************************************/
81 :
82 7610 : VRTDataset::~VRTDataset()
83 :
84 : {
85 4097 : VRTDataset::FlushCache(true);
86 4097 : CPLFree(m_pszVRTPath);
87 :
88 4097 : delete m_poMaskBand;
89 :
90 4150 : for (size_t i = 0; i < m_apoOverviews.size(); i++)
91 53 : delete m_apoOverviews[i];
92 4104 : for (size_t i = 0; i < m_apoOverviewsBak.size(); i++)
93 7 : delete m_apoOverviewsBak[i];
94 4097 : CSLDestroy(m_papszXMLVRTMetadata);
95 7610 : }
96 :
97 : /************************************************************************/
98 : /* FlushCache() */
99 : /************************************************************************/
100 :
101 4436 : CPLErr VRTDataset::FlushCache(bool bAtClosing)
102 :
103 : {
104 4436 : if (m_poRootGroup)
105 311 : return m_poRootGroup->Serialize() ? CE_None : CE_Failure;
106 : else
107 4125 : return VRTFlushCacheStruct<VRTDataset>::FlushCache(*this, bAtClosing);
108 : }
109 :
110 : /************************************************************************/
111 : /* FlushCache() */
112 : /************************************************************************/
113 :
114 725 : CPLErr VRTWarpedDataset::FlushCache(bool bAtClosing)
115 :
116 : {
117 725 : return VRTFlushCacheStruct<VRTWarpedDataset>::FlushCache(*this, bAtClosing);
118 : }
119 :
120 : /************************************************************************/
121 : /* FlushCache() */
122 : /************************************************************************/
123 :
124 154 : CPLErr VRTPansharpenedDataset::FlushCache(bool bAtClosing)
125 :
126 : {
127 154 : return VRTFlushCacheStruct<VRTPansharpenedDataset>::FlushCache(*this,
128 154 : bAtClosing);
129 : }
130 :
131 : /************************************************************************/
132 : /* FlushCache() */
133 : /************************************************************************/
134 :
135 100 : CPLErr VRTProcessedDataset::FlushCache(bool bAtClosing)
136 :
137 : {
138 100 : return VRTFlushCacheStruct<VRTProcessedDataset>::FlushCache(*this,
139 100 : bAtClosing);
140 : }
141 :
142 : /************************************************************************/
143 : /* FlushCache() */
144 : /************************************************************************/
145 :
146 : template <class T>
147 5104 : CPLErr VRTFlushCacheStruct<T>::FlushCache(T &obj, bool bAtClosing)
148 : {
149 5104 : CPLErr eErr = obj.GDALDataset::FlushCache(bAtClosing);
150 :
151 5104 : if (!obj.m_bNeedsFlush || !obj.m_bWritable)
152 2203 : return eErr;
153 :
154 : // We don't write to disk if there is no filename. This is a
155 : // memory only dataset.
156 3309 : if (strlen(obj.GetDescription()) == 0 ||
157 408 : STARTS_WITH_CI(obj.GetDescription(), "<VRTDataset"))
158 2505 : return eErr;
159 :
160 396 : obj.m_bNeedsFlush = false;
161 :
162 : // Serialize XML representation to disk
163 396 : const std::string osVRTPath(CPLGetPath(obj.GetDescription()));
164 396 : CPLXMLNode *psDSTree = obj.T::SerializeToXML(osVRTPath.c_str());
165 396 : if (!CPLSerializeXMLTreeToFile(psDSTree, obj.GetDescription()))
166 13 : eErr = CE_Failure;
167 396 : CPLDestroyXMLNode(psDSTree);
168 396 : return eErr;
169 : }
170 :
171 : /************************************************************************/
172 : /* GetMetadata() */
173 : /************************************************************************/
174 :
175 15052 : char **VRTDataset::GetMetadata(const char *pszDomain)
176 : {
177 15052 : if (pszDomain != nullptr && EQUAL(pszDomain, "xml:VRT"))
178 : {
179 : /* ------------------------------------------------------------------ */
180 : /* Convert tree to a single block of XML text. */
181 : /* ------------------------------------------------------------------ */
182 47 : const char *pszDescription = GetDescription();
183 47 : char *l_pszVRTPath = CPLStrdup(
184 47 : pszDescription[0] && !STARTS_WITH(pszDescription, "<VRTDataset")
185 20 : ? CPLGetPath(pszDescription)
186 : : "");
187 47 : CPLXMLNode *psDSTree = SerializeToXML(l_pszVRTPath);
188 47 : char *pszXML = CPLSerializeXMLTree(psDSTree);
189 :
190 47 : CPLDestroyXMLNode(psDSTree);
191 :
192 47 : CPLFree(l_pszVRTPath);
193 :
194 47 : CSLDestroy(m_papszXMLVRTMetadata);
195 47 : m_papszXMLVRTMetadata =
196 47 : static_cast<char **>(CPLMalloc(2 * sizeof(char *)));
197 47 : m_papszXMLVRTMetadata[0] = pszXML;
198 47 : m_papszXMLVRTMetadata[1] = nullptr;
199 47 : return m_papszXMLVRTMetadata;
200 : }
201 :
202 15005 : return GDALDataset::GetMetadata(pszDomain);
203 : }
204 :
205 : /************************************************************************/
206 : /* GetMetadataItem() */
207 : /************************************************************************/
208 :
209 23542 : const char *VRTDataset::GetMetadataItem(const char *pszName,
210 : const char *pszDomain)
211 :
212 : {
213 23542 : if (pszName && pszDomain && EQUAL(pszDomain, "__DEBUG__"))
214 : {
215 9 : if (EQUAL(pszName, "MULTI_THREADED_RASTERIO_LAST_USED"))
216 9 : return m_bMultiThreadedRasterIOLastUsed ? "1" : "0";
217 : }
218 23533 : return GDALDataset::GetMetadataItem(pszName, pszDomain);
219 : }
220 :
221 : /*! @endcond */
222 :
223 : /************************************************************************/
224 : /* VRTFlushCache(bool bAtClosing) */
225 : /************************************************************************/
226 :
227 : /**
228 : * @see VRTDataset::FlushCache(bool bAtClosing)
229 : */
230 :
231 0 : void CPL_STDCALL VRTFlushCache(VRTDatasetH hDataset)
232 : {
233 0 : VALIDATE_POINTER0(hDataset, "VRTFlushCache");
234 :
235 0 : static_cast<VRTDataset *>(GDALDataset::FromHandle(hDataset))
236 0 : ->FlushCache(false);
237 : }
238 :
239 : /*! @cond Doxygen_Suppress */
240 :
241 : /************************************************************************/
242 : /* SerializeToXML() */
243 : /************************************************************************/
244 :
245 545 : CPLXMLNode *VRTDataset::SerializeToXML(const char *pszVRTPathIn)
246 :
247 : {
248 545 : if (m_poRootGroup)
249 71 : return m_poRootGroup->SerializeToXML(pszVRTPathIn);
250 :
251 : /* -------------------------------------------------------------------- */
252 : /* Setup root node and attributes. */
253 : /* -------------------------------------------------------------------- */
254 474 : CPLXMLNode *psDSTree = CPLCreateXMLNode(nullptr, CXT_Element, "VRTDataset");
255 :
256 474 : char szNumber[128] = {'\0'};
257 474 : snprintf(szNumber, sizeof(szNumber), "%d", GetRasterXSize());
258 474 : CPLSetXMLValue(psDSTree, "#rasterXSize", szNumber);
259 :
260 474 : snprintf(szNumber, sizeof(szNumber), "%d", GetRasterYSize());
261 474 : CPLSetXMLValue(psDSTree, "#rasterYSize", szNumber);
262 :
263 : /* -------------------------------------------------------------------- */
264 : /* SRS */
265 : /* -------------------------------------------------------------------- */
266 474 : if (m_poSRS && !m_poSRS->IsEmpty())
267 : {
268 364 : char *pszWKT = nullptr;
269 364 : m_poSRS->exportToWkt(&pszWKT);
270 : CPLXMLNode *psSRSNode =
271 364 : CPLCreateXMLElementAndValue(psDSTree, "SRS", pszWKT);
272 364 : CPLFree(pszWKT);
273 364 : const auto &mapping = m_poSRS->GetDataAxisToSRSAxisMapping();
274 728 : CPLString osMapping;
275 1094 : for (size_t i = 0; i < mapping.size(); ++i)
276 : {
277 730 : if (!osMapping.empty())
278 366 : osMapping += ",";
279 730 : osMapping += CPLSPrintf("%d", mapping[i]);
280 : }
281 364 : CPLAddXMLAttributeAndValue(psSRSNode, "dataAxisToSRSAxisMapping",
282 : osMapping.c_str());
283 364 : const double dfCoordinateEpoch = m_poSRS->GetCoordinateEpoch();
284 364 : if (dfCoordinateEpoch > 0)
285 : {
286 2 : std::string osCoordinateEpoch = CPLSPrintf("%f", dfCoordinateEpoch);
287 1 : if (osCoordinateEpoch.find('.') != std::string::npos)
288 : {
289 6 : while (osCoordinateEpoch.back() == '0')
290 5 : osCoordinateEpoch.pop_back();
291 : }
292 1 : CPLAddXMLAttributeAndValue(psSRSNode, "coordinateEpoch",
293 : osCoordinateEpoch.c_str());
294 : }
295 : }
296 :
297 : /* -------------------------------------------------------------------- */
298 : /* Geotransform. */
299 : /* -------------------------------------------------------------------- */
300 474 : if (m_bGeoTransformSet)
301 : {
302 409 : CPLSetXMLValue(
303 : psDSTree, "GeoTransform",
304 : CPLSPrintf("%24.16e,%24.16e,%24.16e,%24.16e,%24.16e,%24.16e",
305 : m_adfGeoTransform[0], m_adfGeoTransform[1],
306 : m_adfGeoTransform[2], m_adfGeoTransform[3],
307 : m_adfGeoTransform[4], m_adfGeoTransform[5]));
308 : }
309 :
310 : /* -------------------------------------------------------------------- */
311 : /* Metadata */
312 : /* -------------------------------------------------------------------- */
313 474 : CPLXMLNode *psMD = oMDMD.Serialize();
314 474 : if (psMD != nullptr)
315 : {
316 301 : CPLAddXMLChild(psDSTree, psMD);
317 : }
318 :
319 : /* -------------------------------------------------------------------- */
320 : /* GCPs */
321 : /* -------------------------------------------------------------------- */
322 474 : if (!m_asGCPs.empty())
323 : {
324 4 : GDALSerializeGCPListToXML(psDSTree, m_asGCPs, m_poGCP_SRS.get());
325 : }
326 :
327 : /* -------------------------------------------------------------------- */
328 : /* Serialize bands. */
329 : /* -------------------------------------------------------------------- */
330 474 : CPLXMLNode *psLastChild = psDSTree->psChild;
331 2177 : for (; psLastChild != nullptr && psLastChild->psNext;
332 1703 : psLastChild = psLastChild->psNext)
333 : {
334 : }
335 474 : CPLAssert(psLastChild); // we have at least rasterXSize
336 474 : bool bHasWarnedAboutRAMUsage = false;
337 474 : size_t nAccRAMUsage = 0;
338 1241 : for (int iBand = 0; iBand < nBands; iBand++)
339 : {
340 : CPLXMLNode *psBandTree =
341 767 : static_cast<VRTRasterBand *>(papoBands[iBand])
342 1534 : ->SerializeToXML(pszVRTPathIn, bHasWarnedAboutRAMUsage,
343 767 : nAccRAMUsage);
344 :
345 767 : if (psBandTree != nullptr)
346 : {
347 767 : psLastChild->psNext = psBandTree;
348 767 : psLastChild = psBandTree;
349 : }
350 : }
351 :
352 : /* -------------------------------------------------------------------- */
353 : /* Serialize dataset mask band. */
354 : /* -------------------------------------------------------------------- */
355 474 : if (m_poMaskBand)
356 : {
357 32 : CPLXMLNode *psBandTree = m_poMaskBand->SerializeToXML(
358 16 : pszVRTPathIn, bHasWarnedAboutRAMUsage, nAccRAMUsage);
359 :
360 16 : if (psBandTree != nullptr)
361 : {
362 : CPLXMLNode *psMaskBandElement =
363 16 : CPLCreateXMLNode(psDSTree, CXT_Element, "MaskBand");
364 16 : CPLAddXMLChild(psMaskBandElement, psBandTree);
365 : }
366 : }
367 :
368 : /* -------------------------------------------------------------------- */
369 : /* Overview factors. */
370 : /* -------------------------------------------------------------------- */
371 474 : if (!m_anOverviewFactors.empty())
372 : {
373 8 : CPLString osOverviewList;
374 14 : for (int nOvFactor : m_anOverviewFactors)
375 : {
376 10 : if (!osOverviewList.empty())
377 6 : osOverviewList += " ";
378 10 : osOverviewList += CPLSPrintf("%d", nOvFactor);
379 : }
380 4 : CPLXMLNode *psOverviewList = CPLCreateXMLElementAndValue(
381 : psDSTree, "OverviewList", osOverviewList);
382 4 : if (!m_osOverviewResampling.empty())
383 : {
384 4 : CPLAddXMLAttributeAndValue(psOverviewList, "resampling",
385 : m_osOverviewResampling);
386 : }
387 : }
388 :
389 474 : return psDSTree;
390 : }
391 :
392 : /*! @endcond */
393 : /************************************************************************/
394 : /* VRTSerializeToXML() */
395 : /************************************************************************/
396 :
397 : /**
398 : * @see VRTDataset::SerializeToXML()
399 : */
400 :
401 0 : CPLXMLNode *CPL_STDCALL VRTSerializeToXML(VRTDatasetH hDataset,
402 : const char *pszVRTPath)
403 : {
404 0 : VALIDATE_POINTER1(hDataset, "VRTSerializeToXML", nullptr);
405 :
406 0 : return static_cast<VRTDataset *>(GDALDataset::FromHandle(hDataset))
407 0 : ->SerializeToXML(pszVRTPath);
408 : }
409 :
410 : /*! @cond Doxygen_Suppress */
411 :
412 : /************************************************************************/
413 : /* InitBand() */
414 : /************************************************************************/
415 :
416 1702 : VRTRasterBand *VRTDataset::InitBand(const char *pszSubclass, int nBand,
417 : bool bAllowPansharpenedOrProcessed)
418 : {
419 1702 : VRTRasterBand *poBand = nullptr;
420 1702 : if (auto poProcessedDS = dynamic_cast<VRTProcessedDataset *>(this))
421 : {
422 2 : if (bAllowPansharpenedOrProcessed &&
423 2 : EQUAL(pszSubclass, "VRTProcessedRasterBand"))
424 : {
425 2 : poBand = new VRTProcessedRasterBand(poProcessedDS, nBand);
426 : }
427 : }
428 1700 : else if (EQUAL(pszSubclass, "VRTSourcedRasterBand"))
429 1026 : poBand = new VRTSourcedRasterBand(this, nBand);
430 674 : else if (EQUAL(pszSubclass, "VRTDerivedRasterBand"))
431 163 : poBand = new VRTDerivedRasterBand(this, nBand);
432 511 : else if (EQUAL(pszSubclass, "VRTRawRasterBand"))
433 22 : poBand = new VRTRawRasterBand(this, nBand);
434 939 : else if (EQUAL(pszSubclass, "VRTWarpedRasterBand") &&
435 450 : dynamic_cast<VRTWarpedDataset *>(this) != nullptr)
436 450 : poBand = new VRTWarpedRasterBand(this, nBand);
437 39 : else if (bAllowPansharpenedOrProcessed &&
438 77 : EQUAL(pszSubclass, "VRTPansharpenedRasterBand") &&
439 38 : dynamic_cast<VRTPansharpenedDataset *>(this) != nullptr)
440 38 : poBand = new VRTPansharpenedRasterBand(this, nBand);
441 :
442 1702 : if (!poBand)
443 : {
444 1 : CPLError(CE_Failure, CPLE_AppDefined,
445 : "VRTRasterBand of unrecognized subclass '%s'.", pszSubclass);
446 : }
447 :
448 1702 : return poBand;
449 : }
450 :
451 : /************************************************************************/
452 : /* XMLInit() */
453 : /************************************************************************/
454 :
455 1385 : CPLErr VRTDataset::XMLInit(const CPLXMLNode *psTree, const char *pszVRTPathIn)
456 :
457 : {
458 1385 : if (pszVRTPathIn != nullptr)
459 995 : m_pszVRTPath = CPLStrdup(pszVRTPathIn);
460 :
461 : /* -------------------------------------------------------------------- */
462 : /* Check for an SRS node. */
463 : /* -------------------------------------------------------------------- */
464 1385 : const CPLXMLNode *psSRSNode = CPLGetXMLNode(psTree, "SRS");
465 1385 : if (psSRSNode)
466 : {
467 571 : m_poSRS.reset(new OGRSpatialReference());
468 571 : m_poSRS->SetFromUserInput(
469 : CPLGetXMLValue(psSRSNode, nullptr, ""),
470 : OGRSpatialReference::SET_FROM_USER_INPUT_LIMITATIONS_get());
471 : const char *pszMapping =
472 571 : CPLGetXMLValue(psSRSNode, "dataAxisToSRSAxisMapping", nullptr);
473 571 : if (pszMapping)
474 : {
475 : char **papszTokens =
476 340 : CSLTokenizeStringComplex(pszMapping, ",", FALSE, FALSE);
477 680 : std::vector<int> anMapping;
478 1023 : for (int i = 0; papszTokens && papszTokens[i]; i++)
479 : {
480 683 : anMapping.push_back(atoi(papszTokens[i]));
481 : }
482 340 : CSLDestroy(papszTokens);
483 340 : m_poSRS->SetDataAxisToSRSAxisMapping(anMapping);
484 : }
485 : else
486 : {
487 231 : m_poSRS->SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
488 : }
489 :
490 : const char *pszCoordinateEpoch =
491 571 : CPLGetXMLValue(psSRSNode, "coordinateEpoch", nullptr);
492 571 : if (pszCoordinateEpoch)
493 1 : m_poSRS->SetCoordinateEpoch(CPLAtof(pszCoordinateEpoch));
494 : }
495 :
496 : /* -------------------------------------------------------------------- */
497 : /* Check for a GeoTransform node. */
498 : /* -------------------------------------------------------------------- */
499 1385 : const char *pszGT = CPLGetXMLValue(psTree, "GeoTransform", "");
500 1385 : if (strlen(pszGT) > 0)
501 : {
502 : const CPLStringList aosTokens(
503 1268 : CSLTokenizeStringComplex(pszGT, ",", FALSE, FALSE));
504 634 : if (aosTokens.size() != 6)
505 : {
506 0 : CPLError(CE_Warning, CPLE_AppDefined,
507 : "GeoTransform node does not have expected six values.");
508 : }
509 : else
510 : {
511 4438 : for (int iTA = 0; iTA < 6; iTA++)
512 3804 : m_adfGeoTransform[iTA] = CPLAtof(aosTokens[iTA]);
513 634 : m_bGeoTransformSet = TRUE;
514 : }
515 : }
516 :
517 : /* -------------------------------------------------------------------- */
518 : /* Check for GCPs. */
519 : /* -------------------------------------------------------------------- */
520 1385 : if (const CPLXMLNode *psGCPList = CPLGetXMLNode(psTree, "GCPList"))
521 : {
522 51 : OGRSpatialReference *poSRS = nullptr;
523 51 : GDALDeserializeGCPListFromXML(psGCPList, m_asGCPs, &poSRS);
524 51 : m_poGCP_SRS.reset(poSRS);
525 : }
526 :
527 : /* -------------------------------------------------------------------- */
528 : /* Apply any dataset level metadata. */
529 : /* -------------------------------------------------------------------- */
530 1385 : oMDMD.XMLInit(psTree, TRUE);
531 :
532 : /* -------------------------------------------------------------------- */
533 : /* Create dataset mask band. */
534 : /* -------------------------------------------------------------------- */
535 :
536 : /* Parse dataset mask band first */
537 1385 : const CPLXMLNode *psMaskBandNode = CPLGetXMLNode(psTree, "MaskBand");
538 :
539 1385 : const CPLXMLNode *psChild = nullptr;
540 1385 : if (psMaskBandNode)
541 20 : psChild = psMaskBandNode->psChild;
542 : else
543 1365 : psChild = nullptr;
544 :
545 1385 : for (; psChild != nullptr; psChild = psChild->psNext)
546 : {
547 20 : if (psChild->eType == CXT_Element &&
548 20 : EQUAL(psChild->pszValue, "VRTRasterBand"))
549 : {
550 : const char *pszSubclass =
551 20 : CPLGetXMLValue(psChild, "subclass", "VRTSourcedRasterBand");
552 :
553 20 : VRTRasterBand *poBand = InitBand(pszSubclass, 0, false);
554 40 : if (poBand != nullptr &&
555 20 : poBand->XMLInit(psChild, pszVRTPathIn, m_oMapSharedSources) ==
556 : CE_None)
557 : {
558 20 : SetMaskBand(poBand);
559 20 : break;
560 : }
561 : else
562 : {
563 0 : delete poBand;
564 0 : return CE_Failure;
565 : }
566 : }
567 : }
568 :
569 : /* -------------------------------------------------------------------- */
570 : /* Create band information objects. */
571 : /* -------------------------------------------------------------------- */
572 1385 : int l_nBands = 0;
573 8272 : for (psChild = psTree->psChild; psChild != nullptr;
574 6887 : psChild = psChild->psNext)
575 : {
576 6918 : if (psChild->eType == CXT_Element &&
577 4442 : EQUAL(psChild->pszValue, "VRTRasterBand"))
578 : {
579 : const char *pszSubclass =
580 1682 : CPLGetXMLValue(psChild, "subclass", "VRTSourcedRasterBand");
581 1682 : if (dynamic_cast<VRTProcessedDataset *>(this) &&
582 2 : !EQUAL(pszSubclass, "VRTProcessedRasterBand"))
583 : {
584 0 : CPLError(CE_Failure, CPLE_NotSupported,
585 : "Only subClass=VRTProcessedRasterBand supported");
586 0 : return CE_Failure;
587 : }
588 :
589 1682 : VRTRasterBand *poBand = InitBand(pszSubclass, l_nBands + 1, true);
590 3363 : if (poBand != nullptr &&
591 1681 : poBand->XMLInit(psChild, pszVRTPathIn, m_oMapSharedSources) ==
592 : CE_None)
593 : {
594 1651 : l_nBands++;
595 1651 : SetBand(l_nBands, poBand);
596 : }
597 : else
598 : {
599 31 : delete poBand;
600 31 : return CE_Failure;
601 : }
602 : }
603 : }
604 :
605 1354 : if (const CPLXMLNode *psGroup = CPLGetXMLNode(psTree, "Group"))
606 : {
607 212 : const char *pszName = CPLGetXMLValue(psGroup, "name", nullptr);
608 212 : if (pszName == nullptr || !EQUAL(pszName, "/"))
609 : {
610 2 : CPLError(CE_Failure, CPLE_AppDefined,
611 : "Missing name or not equal to '/'");
612 2 : return CE_Failure;
613 : }
614 :
615 210 : m_poRootGroup = VRTGroup::Create(std::string(), "/");
616 210 : m_poRootGroup->SetIsRootGroup();
617 210 : if (!m_poRootGroup->XMLInit(m_poRootGroup, m_poRootGroup, psGroup,
618 : pszVRTPathIn))
619 : {
620 21 : return CE_Failure;
621 : }
622 : }
623 :
624 : /* -------------------------------------------------------------------- */
625 : /* Create virtual overviews. */
626 : /* -------------------------------------------------------------------- */
627 1331 : const char *pszSubClass = CPLGetXMLValue(psTree, "subClass", "");
628 1331 : if (EQUAL(pszSubClass, ""))
629 : {
630 : m_aosOverviewList =
631 1026 : CSLTokenizeString(CPLGetXMLValue(psTree, "OverviewList", ""));
632 : m_osOverviewResampling =
633 1026 : CPLGetXMLValue(psTree, "OverviewList.resampling", "");
634 : }
635 :
636 1331 : return CE_None;
637 : }
638 :
639 : /************************************************************************/
640 : /* GetGCPCount() */
641 : /************************************************************************/
642 :
643 1933 : int VRTDataset::GetGCPCount()
644 :
645 : {
646 1933 : return static_cast<int>(m_asGCPs.size());
647 : }
648 :
649 : /************************************************************************/
650 : /* GetGCPs() */
651 : /************************************************************************/
652 :
653 79 : const GDAL_GCP *VRTDataset::GetGCPs()
654 :
655 : {
656 79 : return gdal::GCP::c_ptr(m_asGCPs);
657 : }
658 :
659 : /************************************************************************/
660 : /* SetGCPs() */
661 : /************************************************************************/
662 :
663 33 : CPLErr VRTDataset::SetGCPs(int nGCPCountIn, const GDAL_GCP *pasGCPListIn,
664 : const OGRSpatialReference *poGCP_SRS)
665 :
666 : {
667 33 : m_poGCP_SRS.reset(poGCP_SRS ? poGCP_SRS->Clone() : nullptr);
668 33 : m_asGCPs = gdal::GCP::fromC(pasGCPListIn, nGCPCountIn);
669 :
670 33 : SetNeedsFlush();
671 :
672 33 : return CE_None;
673 : }
674 :
675 : /************************************************************************/
676 : /* SetSpatialRef() */
677 : /************************************************************************/
678 :
679 1981 : CPLErr VRTDataset::SetSpatialRef(const OGRSpatialReference *poSRS)
680 :
681 : {
682 1981 : m_poSRS.reset(poSRS ? poSRS->Clone() : nullptr);
683 :
684 1981 : SetNeedsFlush();
685 :
686 1981 : return CE_None;
687 : }
688 :
689 : /************************************************************************/
690 : /* SetGeoTransform() */
691 : /************************************************************************/
692 :
693 2108 : CPLErr VRTDataset::SetGeoTransform(double *padfGeoTransformIn)
694 :
695 : {
696 2108 : memcpy(m_adfGeoTransform, padfGeoTransformIn, sizeof(double) * 6);
697 2108 : m_bGeoTransformSet = TRUE;
698 :
699 2108 : SetNeedsFlush();
700 :
701 2108 : return CE_None;
702 : }
703 :
704 : /************************************************************************/
705 : /* GetGeoTransform() */
706 : /************************************************************************/
707 :
708 6954 : CPLErr VRTDataset::GetGeoTransform(double *padfGeoTransform)
709 :
710 : {
711 6954 : memcpy(padfGeoTransform, m_adfGeoTransform, sizeof(double) * 6);
712 :
713 6954 : return m_bGeoTransformSet ? CE_None : CE_Failure;
714 : }
715 :
716 : /************************************************************************/
717 : /* SetMetadata() */
718 : /************************************************************************/
719 :
720 1900 : CPLErr VRTDataset::SetMetadata(char **papszMetadata, const char *pszDomain)
721 :
722 : {
723 1900 : SetNeedsFlush();
724 :
725 1900 : return GDALDataset::SetMetadata(papszMetadata, pszDomain);
726 : }
727 :
728 : /************************************************************************/
729 : /* SetMetadataItem() */
730 : /************************************************************************/
731 :
732 901 : CPLErr VRTDataset::SetMetadataItem(const char *pszName, const char *pszValue,
733 : const char *pszDomain)
734 :
735 : {
736 901 : SetNeedsFlush();
737 :
738 901 : return GDALDataset::SetMetadataItem(pszName, pszValue, pszDomain);
739 : }
740 :
741 : /************************************************************************/
742 : /* Identify() */
743 : /************************************************************************/
744 :
745 80528 : int VRTDataset::Identify(GDALOpenInfo *poOpenInfo)
746 :
747 : {
748 80528 : if (poOpenInfo->nHeaderBytes > 20 &&
749 28834 : strstr(reinterpret_cast<const char *>(poOpenInfo->pabyHeader),
750 : "<VRTDataset") != nullptr)
751 2004 : return TRUE;
752 :
753 78524 : if (strstr(poOpenInfo->pszFilename, "<VRTDataset") != nullptr)
754 811 : return TRUE;
755 :
756 77713 : if (STARTS_WITH_CI(poOpenInfo->pszFilename, VRT_PROTOCOL_PREFIX))
757 138 : return TRUE;
758 :
759 77575 : return FALSE;
760 : }
761 :
762 : /************************************************************************/
763 : /* Open() */
764 : /************************************************************************/
765 :
766 1465 : GDALDataset *VRTDataset::Open(GDALOpenInfo *poOpenInfo)
767 :
768 : {
769 : /* -------------------------------------------------------------------- */
770 : /* Does this appear to be a virtual dataset definition XML */
771 : /* file? */
772 : /* -------------------------------------------------------------------- */
773 1465 : if (!Identify(poOpenInfo))
774 0 : return nullptr;
775 :
776 1465 : if (STARTS_WITH_CI(poOpenInfo->pszFilename, VRT_PROTOCOL_PREFIX))
777 69 : return OpenVRTProtocol(poOpenInfo->pszFilename);
778 :
779 : /* -------------------------------------------------------------------- */
780 : /* Try to read the whole file into memory. */
781 : /* -------------------------------------------------------------------- */
782 1396 : char *pszXML = nullptr;
783 1396 : VSILFILE *fp = poOpenInfo->fpL;
784 :
785 1396 : char *pszVRTPath = nullptr;
786 1396 : if (fp != nullptr)
787 : {
788 991 : poOpenInfo->fpL = nullptr;
789 :
790 991 : GByte *pabyOut = nullptr;
791 991 : if (!VSIIngestFile(fp, poOpenInfo->pszFilename, &pabyOut, nullptr,
792 : INT_MAX - 1))
793 : {
794 0 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
795 0 : return nullptr;
796 : }
797 991 : pszXML = reinterpret_cast<char *>(pabyOut);
798 :
799 991 : char *pszCurDir = CPLGetCurrentDir();
800 : const char *currentVrtFilename =
801 991 : CPLProjectRelativeFilename(pszCurDir, poOpenInfo->pszFilename);
802 991 : CPLString osInitialCurrentVrtFilename(currentVrtFilename);
803 991 : CPLFree(pszCurDir);
804 :
805 : #if defined(HAVE_READLINK) && defined(HAVE_LSTAT)
806 : char filenameBuffer[2048];
807 :
808 : while (true)
809 : {
810 : VSIStatBuf statBuffer;
811 995 : int lstatCode = lstat(currentVrtFilename, &statBuffer);
812 995 : if (lstatCode == -1)
813 : {
814 222 : if (errno == ENOENT)
815 : {
816 : // File could be a virtual file, let later checks handle it.
817 222 : break;
818 : }
819 : else
820 : {
821 0 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
822 0 : CPLFree(pszXML);
823 0 : CPLError(CE_Failure, CPLE_FileIO, "Failed to lstat %s: %s",
824 0 : currentVrtFilename, VSIStrerror(errno));
825 0 : return nullptr;
826 : }
827 : }
828 :
829 773 : if (!VSI_ISLNK(statBuffer.st_mode))
830 : {
831 769 : break;
832 : }
833 :
834 4 : const int bufferSize = static_cast<int>(readlink(
835 4 : currentVrtFilename, filenameBuffer, sizeof(filenameBuffer)));
836 4 : if (bufferSize != -1)
837 : {
838 4 : filenameBuffer[std::min(
839 4 : bufferSize, static_cast<int>(sizeof(filenameBuffer)) - 1)] =
840 : 0;
841 : // The filename in filenameBuffer might be a relative path
842 : // from the linkfile resolve it before looping
843 4 : currentVrtFilename = CPLProjectRelativeFilename(
844 : CPLGetDirname(currentVrtFilename), filenameBuffer);
845 : }
846 : else
847 : {
848 0 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
849 0 : CPLFree(pszXML);
850 0 : CPLError(CE_Failure, CPLE_FileIO,
851 : "Failed to read filename from symlink %s: %s",
852 0 : currentVrtFilename, VSIStrerror(errno));
853 0 : return nullptr;
854 : }
855 4 : }
856 : #endif // HAVE_READLINK && HAVE_LSTAT
857 :
858 991 : if (osInitialCurrentVrtFilename == currentVrtFilename)
859 988 : pszVRTPath = CPLStrdup(CPLGetPath(poOpenInfo->pszFilename));
860 : else
861 3 : pszVRTPath = CPLStrdup(CPLGetPath(currentVrtFilename));
862 :
863 991 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
864 : }
865 : /* -------------------------------------------------------------------- */
866 : /* Or use the filename as the XML input. */
867 : /* -------------------------------------------------------------------- */
868 : else
869 : {
870 405 : pszXML = CPLStrdup(poOpenInfo->pszFilename);
871 : }
872 :
873 1396 : if (CSLFetchNameValue(poOpenInfo->papszOpenOptions, "ROOT_PATH") != nullptr)
874 : {
875 5 : CPLFree(pszVRTPath);
876 5 : pszVRTPath = CPLStrdup(
877 5 : CSLFetchNameValue(poOpenInfo->papszOpenOptions, "ROOT_PATH"));
878 : }
879 :
880 : /* -------------------------------------------------------------------- */
881 : /* Turn the XML representation into a VRTDataset. */
882 : /* -------------------------------------------------------------------- */
883 1396 : VRTDataset *poDS = OpenXML(pszXML, pszVRTPath, poOpenInfo->eAccess);
884 :
885 1396 : if (poDS != nullptr)
886 1285 : poDS->m_bNeedsFlush = false;
887 :
888 1396 : if (poDS != nullptr)
889 : {
890 1285 : if (poDS->GetRasterCount() == 0 &&
891 1286 : (poOpenInfo->nOpenFlags & GDAL_OF_MULTIDIM_RASTER) == 0 &&
892 1 : strstr(pszXML, "VRTPansharpenedDataset") == nullptr)
893 : {
894 0 : delete poDS;
895 0 : poDS = nullptr;
896 : }
897 1285 : else if (poDS->GetRootGroup() == nullptr &&
898 1285 : (poOpenInfo->nOpenFlags & GDAL_OF_RASTER) == 0 &&
899 0 : (poOpenInfo->nOpenFlags & GDAL_OF_MULTIDIM_RASTER) != 0)
900 : {
901 0 : delete poDS;
902 0 : poDS = nullptr;
903 : }
904 : }
905 :
906 1396 : CPLFree(pszXML);
907 1396 : CPLFree(pszVRTPath);
908 :
909 : /* -------------------------------------------------------------------- */
910 : /* Initialize info for later overview discovery. */
911 : /* -------------------------------------------------------------------- */
912 :
913 1396 : if (poDS != nullptr)
914 : {
915 1285 : if (fp != nullptr)
916 : {
917 988 : poDS->oOvManager.Initialize(poDS, poOpenInfo->pszFilename);
918 988 : if (poOpenInfo->AreSiblingFilesLoaded())
919 2 : poDS->oOvManager.TransferSiblingFiles(
920 : poOpenInfo->StealSiblingFiles());
921 : }
922 :
923 : // Creating virtual overviews, but only if there is no higher priority
924 : // overview source, ie. a Overview element at VRT band level,
925 : // or external .vrt.ovr
926 1285 : if (!poDS->m_aosOverviewList.empty())
927 : {
928 6 : if (poDS->nBands > 0)
929 : {
930 6 : auto poBand = dynamic_cast<VRTRasterBand *>(poDS->papoBands[0]);
931 6 : if (poBand && !poBand->m_aoOverviewInfos.empty())
932 : {
933 0 : poDS->m_aosOverviewList.Clear();
934 0 : CPLDebug("VRT",
935 : "Ignoring virtual overviews of OverviewList "
936 : "because Overview element is present on VRT band");
937 : }
938 12 : else if (poBand &&
939 6 : poBand->GDALRasterBand::GetOverviewCount() > 0)
940 : {
941 1 : poDS->m_aosOverviewList.Clear();
942 1 : CPLDebug("VRT",
943 : "Ignoring virtual overviews of OverviewList "
944 : "because external .vrt.ovr is available");
945 : }
946 : }
947 17 : for (int iOverview = 0; iOverview < poDS->m_aosOverviewList.size();
948 : iOverview++)
949 : {
950 11 : const int nOvFactor = atoi(poDS->m_aosOverviewList[iOverview]);
951 11 : if (nOvFactor <= 1)
952 : {
953 0 : CPLError(CE_Failure, CPLE_AppDefined,
954 : "Invalid overview factor");
955 0 : delete poDS;
956 0 : return nullptr;
957 : }
958 :
959 22 : poDS->AddVirtualOverview(
960 11 : nOvFactor, poDS->m_osOverviewResampling.empty()
961 : ? "nearest"
962 11 : : poDS->m_osOverviewResampling.c_str());
963 : }
964 6 : poDS->m_aosOverviewList.Clear();
965 : }
966 :
967 1357 : if (poDS->eAccess == GA_Update && poDS->m_poRootGroup &&
968 72 : !STARTS_WITH_CI(poOpenInfo->pszFilename, "<VRT"))
969 : {
970 72 : poDS->m_poRootGroup->SetFilename(poOpenInfo->pszFilename);
971 : }
972 : }
973 :
974 1396 : return poDS;
975 : }
976 :
977 : /************************************************************************/
978 : /* OpenVRTProtocol() */
979 : /* */
980 : /* Create an open VRTDataset from a vrt:// string. */
981 : /************************************************************************/
982 :
983 69 : GDALDataset *VRTDataset::OpenVRTProtocol(const char *pszSpec)
984 :
985 : {
986 69 : CPLAssert(STARTS_WITH_CI(pszSpec, VRT_PROTOCOL_PREFIX));
987 138 : CPLString osFilename(pszSpec + strlen(VRT_PROTOCOL_PREFIX));
988 69 : const auto nPosQuotationMark = osFilename.find('?');
989 138 : CPLString osQueryString;
990 69 : if (nPosQuotationMark != std::string::npos)
991 : {
992 61 : osQueryString = osFilename.substr(nPosQuotationMark + 1);
993 61 : osFilename.resize(nPosQuotationMark);
994 : }
995 :
996 : // Parse query string, get args required for initial Open()
997 138 : const CPLStringList aosTokens(CSLTokenizeString2(osQueryString, "&", 0));
998 138 : CPLStringList aosAllowedDrivers;
999 138 : CPLStringList aosOpenOptions;
1000 :
1001 154 : for (const auto &[pszKey, pszValue] : cpl::IterateNameValue(
1002 219 : aosTokens, /* bReturnNullKeyIfNotNameValue = */ true))
1003 : {
1004 79 : if (!pszKey)
1005 : {
1006 2 : CPLError(CE_Failure, CPLE_NotSupported,
1007 : "Invalid option specification: %s\n"
1008 : "must be in the form 'key=value'",
1009 : pszValue);
1010 4 : return nullptr;
1011 : }
1012 77 : else if (EQUAL(pszKey, "if"))
1013 : {
1014 4 : if (!aosAllowedDrivers.empty())
1015 : {
1016 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1017 : "'if' option should be specified once, use commas "
1018 : "to input multiple values.");
1019 1 : return nullptr;
1020 : }
1021 3 : aosAllowedDrivers = CSLTokenizeString2(pszValue, ",", 0);
1022 : }
1023 73 : else if (EQUAL(pszKey, "oo"))
1024 : {
1025 3 : if (!aosOpenOptions.empty())
1026 : {
1027 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1028 : "'oo' option should be specified once, use commas "
1029 : "to input multiple values.");
1030 1 : return nullptr;
1031 : }
1032 2 : aosOpenOptions = CSLTokenizeString2(pszValue, ",", 0);
1033 : }
1034 : }
1035 :
1036 : // We don't open in GDAL_OF_SHARED mode to avoid issues when we open a
1037 : // http://.jp2 file with the JP2OpenJPEG driver through the HTTP driver,
1038 : // which returns a /vsimem/ file
1039 : auto poSrcDS = std::unique_ptr<GDALDataset, GDALDatasetUniquePtrReleaser>(
1040 : GDALDataset::Open(osFilename, GDAL_OF_RASTER | GDAL_OF_VERBOSE_ERROR,
1041 65 : aosAllowedDrivers.List(), aosOpenOptions.List(),
1042 130 : nullptr));
1043 65 : if (poSrcDS == nullptr)
1044 : {
1045 4 : return nullptr;
1046 : }
1047 :
1048 : // scan for sd_name/sd in tokens, close the source dataset and reopen if found/valid
1049 61 : bool bFound_subdataset = false;
1050 129 : for (const auto &[pszKey, pszValue] : cpl::IterateNameValue(aosTokens))
1051 : {
1052 71 : if (EQUAL(pszKey, "sd_name"))
1053 : {
1054 4 : if (bFound_subdataset)
1055 : {
1056 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1057 : "'sd_name' is mutually exclusive with option "
1058 : "'sd'");
1059 3 : return nullptr;
1060 : }
1061 3 : char **papszSubdatasets = poSrcDS->GetMetadata("SUBDATASETS");
1062 3 : int nSubdatasets = CSLCount(papszSubdatasets);
1063 :
1064 3 : if (nSubdatasets > 0)
1065 : {
1066 3 : bool bFound = false;
1067 25 : for (int j = 0; j < nSubdatasets; j += 2)
1068 : {
1069 : const std::string osSubdatasetSource(
1070 24 : strstr(papszSubdatasets[j], "=") + 1);
1071 24 : if (osSubdatasetSource.empty())
1072 : {
1073 0 : CPLError(CE_Failure, CPLE_IllegalArg,
1074 : "'sd_name:' failed to obtain "
1075 : "subdataset string ");
1076 0 : return nullptr;
1077 : }
1078 : GDALSubdatasetInfoH info =
1079 24 : GDALGetSubdatasetInfo(osSubdatasetSource.c_str());
1080 : char *component =
1081 24 : info ? GDALSubdatasetInfoGetSubdatasetComponent(info)
1082 24 : : nullptr;
1083 :
1084 24 : bFound = component && EQUAL(pszValue, component);
1085 24 : bFound_subdataset = true;
1086 24 : CPLFree(component);
1087 24 : GDALDestroySubdatasetInfo(info);
1088 24 : if (bFound)
1089 : {
1090 2 : poSrcDS.reset(GDALDataset::Open(
1091 : osSubdatasetSource.c_str(),
1092 : GDAL_OF_RASTER | GDAL_OF_VERBOSE_ERROR,
1093 2 : aosAllowedDrivers.List(), aosOpenOptions.List(),
1094 : nullptr));
1095 2 : if (poSrcDS == nullptr)
1096 : {
1097 0 : return nullptr;
1098 : }
1099 :
1100 2 : break;
1101 : }
1102 : }
1103 :
1104 3 : if (!bFound)
1105 : {
1106 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1107 : "'sd_name' option should be be a valid "
1108 : "subdataset component name");
1109 1 : return nullptr;
1110 : }
1111 : }
1112 : }
1113 :
1114 69 : if (EQUAL(pszKey, "sd"))
1115 : {
1116 3 : if (bFound_subdataset)
1117 : {
1118 0 : CPLError(CE_Failure, CPLE_IllegalArg,
1119 : "'sd' is mutually exclusive with option "
1120 : "'sd_name'");
1121 0 : return nullptr;
1122 : }
1123 3 : CSLConstList papszSubdatasets = poSrcDS->GetMetadata("SUBDATASETS");
1124 3 : int nSubdatasets = CSLCount(papszSubdatasets);
1125 :
1126 3 : if (nSubdatasets > 0)
1127 : {
1128 3 : int iSubdataset = atoi(pszValue);
1129 3 : if (iSubdataset < 1 || iSubdataset > (nSubdatasets) / 2)
1130 : {
1131 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1132 : "'sd' option should indicate a valid "
1133 : "subdataset component number (starting with 1)");
1134 1 : return nullptr;
1135 : }
1136 : const std::string osSubdatasetSource(
1137 2 : strstr(papszSubdatasets[(iSubdataset - 1) * 2], "=") + 1);
1138 2 : if (osSubdatasetSource.empty())
1139 : {
1140 0 : CPLError(CE_Failure, CPLE_IllegalArg,
1141 : "'sd:' failed to obtain subdataset "
1142 : "string ");
1143 0 : return nullptr;
1144 : }
1145 :
1146 2 : poSrcDS.reset(GDALDataset::Open(
1147 : osSubdatasetSource.c_str(),
1148 : GDAL_OF_RASTER | GDAL_OF_VERBOSE_ERROR,
1149 2 : aosAllowedDrivers.List(), aosOpenOptions.List(), nullptr));
1150 2 : if (poSrcDS == nullptr)
1151 : {
1152 0 : return nullptr;
1153 : }
1154 2 : bFound_subdataset = true;
1155 : }
1156 : }
1157 : }
1158 :
1159 116 : std::vector<int> anBands;
1160 :
1161 116 : CPLStringList argv;
1162 58 : argv.AddString("-of");
1163 58 : argv.AddString("VRT");
1164 :
1165 115 : for (const auto &[pszKey, pszValue] : cpl::IterateNameValue(aosTokens))
1166 : {
1167 67 : if (EQUAL(pszKey, "bands"))
1168 : {
1169 6 : const CPLStringList aosBands(CSLTokenizeString2(pszValue, ",", 0));
1170 12 : for (int j = 0; j < aosBands.size(); j++)
1171 : {
1172 9 : if (EQUAL(aosBands[j], "mask"))
1173 : {
1174 1 : anBands.push_back(0);
1175 : }
1176 : else
1177 : {
1178 8 : const int nBand = atoi(aosBands[j]);
1179 8 : if (nBand <= 0 || nBand > poSrcDS->GetRasterCount())
1180 : {
1181 3 : CPLError(CE_Failure, CPLE_IllegalArg,
1182 : "Invalid band number: %s", aosBands[j]);
1183 3 : return nullptr;
1184 : }
1185 5 : anBands.push_back(nBand);
1186 : }
1187 : }
1188 :
1189 9 : for (const int nBand : anBands)
1190 : {
1191 6 : argv.AddString("-b");
1192 6 : argv.AddString(nBand == 0 ? "mask" : CPLSPrintf("%d", nBand));
1193 : }
1194 : }
1195 :
1196 61 : else if (EQUAL(pszKey, "a_nodata"))
1197 : {
1198 1 : argv.AddString("-a_nodata");
1199 1 : argv.AddString(pszValue);
1200 : }
1201 :
1202 60 : else if (EQUAL(pszKey, "a_srs"))
1203 : {
1204 1 : argv.AddString("-a_srs");
1205 1 : argv.AddString(pszValue);
1206 : }
1207 :
1208 59 : else if (EQUAL(pszKey, "a_ullr"))
1209 : {
1210 : // Parse the limits
1211 1 : const CPLStringList aosUllr(CSLTokenizeString2(pszValue, ",", 0));
1212 : // fail if not four values
1213 1 : if (aosUllr.size() != 4)
1214 : {
1215 0 : CPLError(CE_Failure, CPLE_IllegalArg,
1216 : "Invalid a_ullr option: %s", pszValue);
1217 0 : return nullptr;
1218 : }
1219 :
1220 1 : argv.AddString("-a_ullr");
1221 1 : argv.AddString(aosUllr[0]);
1222 1 : argv.AddString(aosUllr[1]);
1223 1 : argv.AddString(aosUllr[2]);
1224 1 : argv.AddString(aosUllr[3]);
1225 : }
1226 :
1227 58 : else if (EQUAL(pszKey, "ovr"))
1228 : {
1229 1 : argv.AddString("-ovr");
1230 1 : argv.AddString(pszValue);
1231 : }
1232 57 : else if (EQUAL(pszKey, "expand"))
1233 : {
1234 1 : argv.AddString("-expand");
1235 1 : argv.AddString(pszValue);
1236 : }
1237 56 : else if (EQUAL(pszKey, "a_scale"))
1238 : {
1239 2 : argv.AddString("-a_scale");
1240 2 : argv.AddString(pszValue);
1241 : }
1242 54 : else if (EQUAL(pszKey, "a_offset"))
1243 : {
1244 1 : argv.AddString("-a_offset");
1245 1 : argv.AddString(pszValue);
1246 : }
1247 53 : else if (EQUAL(pszKey, "ot"))
1248 : {
1249 2 : argv.AddString("-ot");
1250 2 : argv.AddString(pszValue);
1251 : }
1252 51 : else if (EQUAL(pszKey, "gcp"))
1253 : {
1254 6 : const CPLStringList aosGCP(CSLTokenizeString2(pszValue, ",", 0));
1255 :
1256 6 : if (aosGCP.size() < 4 || aosGCP.size() > 5)
1257 : {
1258 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1259 : "Invalid value for GCP: %s\n need 4, or 5 "
1260 : "numbers, comma separated: "
1261 : "'gcp=<pixel>,<line>,<easting>,<northing>[,<"
1262 : "elevation>]'",
1263 : pszValue);
1264 1 : return nullptr;
1265 : }
1266 5 : argv.AddString("-gcp");
1267 28 : for (int j = 0; j < aosGCP.size(); j++)
1268 : {
1269 23 : argv.AddString(aosGCP[j]);
1270 : }
1271 : }
1272 45 : else if (EQUAL(pszKey, "scale") || STARTS_WITH_CI(pszKey, "scale_"))
1273 : {
1274 : const CPLStringList aosScaleParams(
1275 7 : CSLTokenizeString2(pszValue, ",", 0));
1276 :
1277 7 : if (!(aosScaleParams.size() == 2) &&
1278 7 : !(aosScaleParams.size() == 4) && !(aosScaleParams.size() == 1))
1279 : {
1280 0 : CPLError(CE_Failure, CPLE_IllegalArg,
1281 : "Invalid value for scale, (or scale_bn): "
1282 : "%s\n need 'scale=true', or 2 or 4 "
1283 : "numbers, comma separated: "
1284 : "'scale=src_min,src_max[,dst_min,dst_max]' or "
1285 : "'scale_bn=src_min,src_max[,dst_min,dst_max]'",
1286 : pszValue);
1287 0 : return nullptr;
1288 : }
1289 :
1290 : // -scale because scale=true or scale=min,max or scale=min,max,dstmin,dstmax
1291 7 : if (aosScaleParams.size() == 1 && CPLTestBool(aosScaleParams[0]))
1292 : {
1293 2 : argv.AddString(CPLSPrintf("-%s", pszKey));
1294 : }
1295 : // add remaining params (length 2 or 4)
1296 7 : if (aosScaleParams.size() > 1)
1297 : {
1298 5 : argv.AddString(CPLSPrintf("-%s", pszKey));
1299 21 : for (int j = 0; j < aosScaleParams.size(); j++)
1300 : {
1301 16 : argv.AddString(aosScaleParams[j]);
1302 : }
1303 7 : }
1304 : }
1305 38 : else if (EQUAL(pszKey, "exponent") ||
1306 36 : STARTS_WITH_CI(pszKey, "exponent_"))
1307 : {
1308 3 : argv.AddString(CPLSPrintf("-%s", pszKey));
1309 3 : argv.AddString(pszValue);
1310 : }
1311 35 : else if (EQUAL(pszKey, "outsize"))
1312 : {
1313 : const CPLStringList aosOutSize(
1314 4 : CSLTokenizeString2(pszValue, ",", 0));
1315 4 : if (aosOutSize.size() != 2)
1316 : {
1317 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1318 : "Invalid outsize option: %s, must be two"
1319 : "values separated by comma pixel,line or two "
1320 : "fraction values with percent symbol",
1321 : pszValue);
1322 1 : return nullptr;
1323 : }
1324 3 : argv.AddString("-outsize");
1325 3 : argv.AddString(aosOutSize[0]);
1326 3 : argv.AddString(aosOutSize[1]);
1327 : }
1328 31 : else if (EQUAL(pszKey, "projwin"))
1329 : {
1330 : // Parse the limits
1331 : const CPLStringList aosProjWin(
1332 3 : CSLTokenizeString2(pszValue, ",", 0));
1333 : // fail if not four values
1334 3 : if (aosProjWin.size() != 4)
1335 : {
1336 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1337 : "Invalid projwin option: %s", pszValue);
1338 1 : return nullptr;
1339 : }
1340 :
1341 2 : argv.AddString("-projwin");
1342 2 : argv.AddString(aosProjWin[0]);
1343 2 : argv.AddString(aosProjWin[1]);
1344 2 : argv.AddString(aosProjWin[2]);
1345 2 : argv.AddString(aosProjWin[3]);
1346 : }
1347 28 : else if (EQUAL(pszKey, "projwin_srs"))
1348 : {
1349 2 : argv.AddString("-projwin_srs");
1350 2 : argv.AddString(pszValue);
1351 : }
1352 26 : else if (EQUAL(pszKey, "tr"))
1353 : {
1354 : const CPLStringList aosTargetResolution(
1355 3 : CSLTokenizeString2(pszValue, ",", 0));
1356 3 : if (aosTargetResolution.size() != 2)
1357 : {
1358 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1359 : "Invalid tr option: %s, must be two "
1360 : "values separated by comma xres,yres",
1361 : pszValue);
1362 1 : return nullptr;
1363 : }
1364 2 : argv.AddString("-tr");
1365 2 : argv.AddString(aosTargetResolution[0]);
1366 2 : argv.AddString(aosTargetResolution[1]);
1367 : }
1368 23 : else if (EQUAL(pszKey, "r"))
1369 : {
1370 1 : argv.AddString("-r");
1371 1 : argv.AddString(pszValue);
1372 : }
1373 :
1374 22 : else if (EQUAL(pszKey, "srcwin"))
1375 : {
1376 : // Parse the limits
1377 6 : const CPLStringList aosSrcWin(CSLTokenizeString2(pszValue, ",", 0));
1378 : // fail if not four values
1379 6 : if (aosSrcWin.size() != 4)
1380 : {
1381 1 : CPLError(CE_Failure, CPLE_IllegalArg,
1382 : "Invalid srcwin option: %s, must be four "
1383 : "values separated by comma xoff,yoff,xsize,ysize",
1384 : pszValue);
1385 1 : return nullptr;
1386 : }
1387 :
1388 5 : argv.AddString("-srcwin");
1389 5 : argv.AddString(aosSrcWin[0]);
1390 5 : argv.AddString(aosSrcWin[1]);
1391 5 : argv.AddString(aosSrcWin[2]);
1392 5 : argv.AddString(aosSrcWin[3]);
1393 : }
1394 :
1395 16 : else if (EQUAL(pszKey, "a_gt"))
1396 : {
1397 : // Parse the limits
1398 : const CPLStringList aosAGeoTransform(
1399 2 : CSLTokenizeString2(pszValue, ",", 0));
1400 : // fail if not six values
1401 2 : if (aosAGeoTransform.size() != 6)
1402 : {
1403 1 : CPLError(CE_Failure, CPLE_IllegalArg, "Invalid a_gt option: %s",
1404 : pszValue);
1405 1 : return nullptr;
1406 : }
1407 :
1408 1 : argv.AddString("-a_gt");
1409 1 : argv.AddString(aosAGeoTransform[0]);
1410 1 : argv.AddString(aosAGeoTransform[1]);
1411 1 : argv.AddString(aosAGeoTransform[2]);
1412 1 : argv.AddString(aosAGeoTransform[3]);
1413 1 : argv.AddString(aosAGeoTransform[4]);
1414 1 : argv.AddString(aosAGeoTransform[5]);
1415 : }
1416 14 : else if (EQUAL(pszKey, "oo"))
1417 : {
1418 : // do nothing, we passed this in earlier
1419 : }
1420 13 : else if (EQUAL(pszKey, "if"))
1421 : {
1422 : // do nothing, we passed this in earlier
1423 : }
1424 12 : else if (EQUAL(pszKey, "sd_name"))
1425 : {
1426 : // do nothing, we passed this in earlier
1427 : }
1428 10 : else if (EQUAL(pszKey, "sd"))
1429 : {
1430 : // do nothing, we passed this in earlier
1431 : }
1432 9 : else if (EQUAL(pszKey, "unscale"))
1433 : {
1434 1 : if (CPLTestBool(pszValue))
1435 : {
1436 1 : argv.AddString("-unscale");
1437 : }
1438 : }
1439 8 : else if (EQUAL(pszKey, "a_coord_epoch"))
1440 : {
1441 0 : argv.AddString("-a_coord_epoch");
1442 0 : argv.AddString(pszValue);
1443 : }
1444 8 : else if (EQUAL(pszKey, "nogcp"))
1445 : {
1446 1 : if (CPLTestBool(pszValue))
1447 : {
1448 1 : argv.AddString("-nogcp");
1449 : }
1450 : }
1451 7 : else if (EQUAL(pszKey, "epo"))
1452 : {
1453 3 : if (CPLTestBool(pszValue))
1454 : {
1455 2 : argv.AddString("-epo");
1456 : }
1457 : }
1458 4 : else if (EQUAL(pszKey, "eco"))
1459 : {
1460 3 : if (CPLTestBool(pszValue))
1461 : {
1462 3 : argv.AddString("-eco");
1463 : }
1464 : }
1465 : else
1466 : {
1467 1 : CPLError(CE_Failure, CPLE_NotSupported, "Unknown option: %s",
1468 : pszKey);
1469 1 : return nullptr;
1470 : }
1471 : }
1472 :
1473 : GDALTranslateOptions *psOptions =
1474 48 : GDALTranslateOptionsNew(argv.List(), nullptr);
1475 :
1476 48 : auto hRet = GDALTranslate("", GDALDataset::ToHandle(poSrcDS.get()),
1477 : psOptions, nullptr);
1478 :
1479 48 : GDALTranslateOptionsFree(psOptions);
1480 :
1481 : // Situation where we open a http://.jp2 file with the JP2OpenJPEG driver
1482 : // through the HTTP driver, which returns a /vsimem/ file
1483 : const bool bPatchSourceFilename =
1484 48 : (STARTS_WITH(osFilename.c_str(), "http://") ||
1485 49 : STARTS_WITH(osFilename.c_str(), "https://")) &&
1486 1 : osFilename != poSrcDS->GetDescription();
1487 :
1488 48 : poSrcDS.reset();
1489 :
1490 48 : auto poDS = dynamic_cast<VRTDataset *>(GDALDataset::FromHandle(hRet));
1491 48 : if (poDS)
1492 : {
1493 45 : if (bPatchSourceFilename)
1494 : {
1495 2 : for (int i = 0; i < poDS->nBands; ++i)
1496 : {
1497 : auto poBand =
1498 1 : dynamic_cast<VRTSourcedRasterBand *>(poDS->papoBands[i]);
1499 2 : if (poBand && poBand->nSources == 1 &&
1500 1 : poBand->papoSources[0]->IsSimpleSource())
1501 : {
1502 2 : auto poSource = cpl::down_cast<VRTSimpleSource *>(
1503 1 : poBand->papoSources[0]);
1504 1 : poSource->m_bRelativeToVRTOri = 0;
1505 1 : poSource->m_osSourceFileNameOri = osFilename;
1506 : }
1507 : }
1508 : }
1509 45 : poDS->SetDescription(pszSpec);
1510 45 : poDS->SetWritable(false);
1511 : }
1512 48 : return poDS;
1513 : }
1514 :
1515 : /************************************************************************/
1516 : /* OpenXML() */
1517 : /* */
1518 : /* Create an open VRTDataset from a supplied XML representation */
1519 : /* of the dataset. */
1520 : /************************************************************************/
1521 :
1522 1397 : VRTDataset *VRTDataset::OpenXML(const char *pszXML, const char *pszVRTPath,
1523 : GDALAccess eAccessIn)
1524 :
1525 : {
1526 : /* -------------------------------------------------------------------- */
1527 : /* Parse the XML. */
1528 : /* -------------------------------------------------------------------- */
1529 2794 : CPLXMLTreeCloser psTree(CPLParseXMLString(pszXML));
1530 1397 : if (psTree == nullptr)
1531 0 : return nullptr;
1532 :
1533 1397 : CPLXMLNode *psRoot = CPLGetXMLNode(psTree.get(), "=VRTDataset");
1534 1397 : if (psRoot == nullptr)
1535 : {
1536 0 : CPLError(CE_Failure, CPLE_AppDefined, "Missing VRTDataset element.");
1537 0 : return nullptr;
1538 : }
1539 :
1540 1397 : const char *pszSubClass = CPLGetXMLValue(psRoot, "subClass", "");
1541 :
1542 1397 : const bool bIsPansharpened =
1543 1397 : strcmp(pszSubClass, "VRTPansharpenedDataset") == 0;
1544 1397 : const bool bIsProcessed = strcmp(pszSubClass, "VRTProcessedDataset") == 0;
1545 :
1546 1330 : if (!bIsPansharpened && !bIsProcessed &&
1547 3796 : CPLGetXMLNode(psRoot, "Group") == nullptr &&
1548 1069 : (CPLGetXMLNode(psRoot, "rasterXSize") == nullptr ||
1549 1068 : CPLGetXMLNode(psRoot, "rasterYSize") == nullptr ||
1550 1068 : CPLGetXMLNode(psRoot, "VRTRasterBand") == nullptr))
1551 : {
1552 2 : CPLError(CE_Failure, CPLE_AppDefined,
1553 : "Missing one of rasterXSize, rasterYSize or bands on"
1554 : " VRTDataset.");
1555 2 : return nullptr;
1556 : }
1557 :
1558 : /* -------------------------------------------------------------------- */
1559 : /* Create the new virtual dataset object. */
1560 : /* -------------------------------------------------------------------- */
1561 1395 : const int nXSize = atoi(CPLGetXMLValue(psRoot, "rasterXSize", "0"));
1562 1395 : const int nYSize = atoi(CPLGetXMLValue(psRoot, "rasterYSize", "0"));
1563 :
1564 1328 : if (!bIsPansharpened && !bIsProcessed &&
1565 3790 : CPLGetXMLNode(psRoot, "VRTRasterBand") != nullptr &&
1566 1067 : !GDALCheckDatasetDimensions(nXSize, nYSize))
1567 : {
1568 0 : return nullptr;
1569 : }
1570 :
1571 1395 : VRTDataset *poDS = nullptr;
1572 1395 : if (strcmp(pszSubClass, "VRTWarpedDataset") == 0)
1573 200 : poDS = new VRTWarpedDataset(nXSize, nYSize);
1574 1195 : else if (bIsPansharpened)
1575 67 : poDS = new VRTPansharpenedDataset(nXSize, nYSize);
1576 1128 : else if (bIsProcessed)
1577 49 : poDS = new VRTProcessedDataset(nXSize, nYSize);
1578 : else
1579 : {
1580 1079 : poDS = new VRTDataset(nXSize, nYSize);
1581 1079 : poDS->eAccess = eAccessIn;
1582 : }
1583 :
1584 1395 : if (poDS->XMLInit(psRoot, pszVRTPath) != CE_None)
1585 : {
1586 110 : delete poDS;
1587 110 : poDS = nullptr;
1588 : }
1589 :
1590 : /* -------------------------------------------------------------------- */
1591 : /* Try to return a regular handle on the file. */
1592 : /* -------------------------------------------------------------------- */
1593 :
1594 1395 : return poDS;
1595 : }
1596 :
1597 : /************************************************************************/
1598 : /* AddBand() */
1599 : /************************************************************************/
1600 :
1601 6015 : CPLErr VRTDataset::AddBand(GDALDataType eType, char **papszOptions)
1602 :
1603 : {
1604 6015 : if (eType == GDT_Unknown || eType == GDT_TypeCount)
1605 : {
1606 1 : ReportError(CE_Failure, CPLE_IllegalArg,
1607 : "Illegal GDT_Unknown/GDT_TypeCount argument");
1608 1 : return CE_Failure;
1609 : }
1610 :
1611 6014 : SetNeedsFlush();
1612 :
1613 : /* ==================================================================== */
1614 : /* Handle a new raw band. */
1615 : /* ==================================================================== */
1616 6014 : const char *pszSubClass = CSLFetchNameValue(papszOptions, "subclass");
1617 :
1618 6014 : if (pszSubClass != nullptr && EQUAL(pszSubClass, "VRTRawRasterBand"))
1619 : {
1620 6 : const int nWordDataSize = GDALGetDataTypeSizeBytes(eType);
1621 :
1622 : /* --------------------------------------------------------------------
1623 : */
1624 : /* Collect required information. */
1625 : /* --------------------------------------------------------------------
1626 : */
1627 : const char *pszImageOffset =
1628 6 : CSLFetchNameValueDef(papszOptions, "ImageOffset", "0");
1629 12 : vsi_l_offset nImageOffset = CPLScanUIntBig(
1630 6 : pszImageOffset, static_cast<int>(strlen(pszImageOffset)));
1631 :
1632 6 : int nPixelOffset = nWordDataSize;
1633 : const char *pszPixelOffset =
1634 6 : CSLFetchNameValue(papszOptions, "PixelOffset");
1635 6 : if (pszPixelOffset != nullptr)
1636 4 : nPixelOffset = atoi(pszPixelOffset);
1637 :
1638 : int nLineOffset;
1639 : const char *pszLineOffset =
1640 6 : CSLFetchNameValue(papszOptions, "LineOffset");
1641 6 : if (pszLineOffset != nullptr)
1642 4 : nLineOffset = atoi(pszLineOffset);
1643 : else
1644 : {
1645 4 : if (nPixelOffset > INT_MAX / GetRasterXSize() ||
1646 2 : nPixelOffset < INT_MIN / GetRasterXSize())
1647 : {
1648 0 : CPLError(CE_Failure, CPLE_AppDefined, "Int overflow");
1649 0 : return CE_Failure;
1650 : }
1651 2 : nLineOffset = nPixelOffset * GetRasterXSize();
1652 : }
1653 :
1654 6 : const char *pszByteOrder = CSLFetchNameValue(papszOptions, "ByteOrder");
1655 :
1656 : const char *pszFilename =
1657 6 : CSLFetchNameValue(papszOptions, "SourceFilename");
1658 6 : if (pszFilename == nullptr)
1659 : {
1660 0 : CPLError(CE_Failure, CPLE_AppDefined,
1661 : "AddBand() requires a SourceFilename option for "
1662 : "VRTRawRasterBands.");
1663 0 : return CE_Failure;
1664 : }
1665 :
1666 : const bool bRelativeToVRT =
1667 6 : CPLFetchBool(papszOptions, "relativeToVRT", false);
1668 :
1669 : /* --------------------------------------------------------------------
1670 : */
1671 : /* Create and initialize the band. */
1672 : /* --------------------------------------------------------------------
1673 : */
1674 :
1675 : VRTRawRasterBand *poBand =
1676 6 : new VRTRawRasterBand(this, GetRasterCount() + 1, eType);
1677 :
1678 6 : char *l_pszVRTPath = CPLStrdup(CPLGetPath(GetDescription()));
1679 6 : if (EQUAL(l_pszVRTPath, ""))
1680 : {
1681 0 : CPLFree(l_pszVRTPath);
1682 0 : l_pszVRTPath = nullptr;
1683 : }
1684 :
1685 6 : const CPLErr eErr = poBand->SetRawLink(
1686 : pszFilename, l_pszVRTPath, bRelativeToVRT, nImageOffset,
1687 : nPixelOffset, nLineOffset, pszByteOrder);
1688 6 : CPLFree(l_pszVRTPath);
1689 6 : if (eErr != CE_None)
1690 : {
1691 0 : delete poBand;
1692 0 : return eErr;
1693 : }
1694 :
1695 6 : SetBand(GetRasterCount() + 1, poBand);
1696 :
1697 6 : return CE_None;
1698 : }
1699 :
1700 : /* ==================================================================== */
1701 : /* Handle a new "sourced" band. */
1702 : /* ==================================================================== */
1703 : else
1704 : {
1705 6008 : VRTSourcedRasterBand *poBand = nullptr;
1706 :
1707 : /* ---- Check for our sourced band 'derived' subclass ---- */
1708 6008 : if (pszSubClass != nullptr &&
1709 5 : EQUAL(pszSubClass, "VRTDerivedRasterBand"))
1710 : {
1711 :
1712 : /* We'll need a pointer to the subclass in case we need */
1713 : /* to set the new band's pixel function below. */
1714 : VRTDerivedRasterBand *poDerivedBand =
1715 4 : new VRTDerivedRasterBand(this, GetRasterCount() + 1, eType,
1716 4 : GetRasterXSize(), GetRasterYSize());
1717 :
1718 : /* Set the pixel function options it provided. */
1719 : const char *pszFuncName =
1720 4 : CSLFetchNameValue(papszOptions, "PixelFunctionType");
1721 4 : if (pszFuncName != nullptr)
1722 3 : poDerivedBand->SetPixelFunctionName(pszFuncName);
1723 :
1724 : const char *pszLanguage =
1725 4 : CSLFetchNameValue(papszOptions, "PixelFunctionLanguage");
1726 4 : if (pszLanguage != nullptr)
1727 1 : poDerivedBand->SetPixelFunctionLanguage(pszLanguage);
1728 :
1729 : const char *pszTransferTypeName =
1730 4 : CSLFetchNameValue(papszOptions, "SourceTransferType");
1731 4 : if (pszTransferTypeName != nullptr)
1732 : {
1733 : const GDALDataType eTransferType =
1734 2 : GDALGetDataTypeByName(pszTransferTypeName);
1735 2 : if (eTransferType == GDT_Unknown)
1736 : {
1737 1 : CPLError(CE_Failure, CPLE_AppDefined,
1738 : "invalid SourceTransferType: \"%s\".",
1739 : pszTransferTypeName);
1740 1 : delete poDerivedBand;
1741 1 : return CE_Failure;
1742 : }
1743 1 : poDerivedBand->SetSourceTransferType(eTransferType);
1744 : }
1745 :
1746 : /* We're done with the derived band specific stuff, so */
1747 : /* we can assigned the base class pointer now. */
1748 3 : poBand = poDerivedBand;
1749 : }
1750 : else
1751 : {
1752 : int nBlockXSizeIn =
1753 6004 : atoi(CSLFetchNameValueDef(papszOptions, "BLOCKXSIZE", "0"));
1754 : int nBlockYSizeIn =
1755 6004 : atoi(CSLFetchNameValueDef(papszOptions, "BLOCKYSIZE", "0"));
1756 6004 : if (nBlockXSizeIn == 0 && nBlockYSizeIn == 0)
1757 : {
1758 4676 : nBlockXSizeIn = m_nBlockXSize;
1759 4676 : nBlockYSizeIn = m_nBlockYSize;
1760 : }
1761 : /* ---- Standard sourced band ---- */
1762 6004 : poBand = new VRTSourcedRasterBand(
1763 6004 : this, GetRasterCount() + 1, eType, GetRasterXSize(),
1764 6004 : GetRasterYSize(), nBlockXSizeIn, nBlockYSizeIn);
1765 : }
1766 :
1767 6007 : SetBand(GetRasterCount() + 1, poBand);
1768 :
1769 8668 : for (int i = 0; papszOptions != nullptr && papszOptions[i] != nullptr;
1770 : i++)
1771 : {
1772 2661 : if (STARTS_WITH_CI(papszOptions[i], "AddFuncSource="))
1773 : {
1774 0 : char **papszTokens = CSLTokenizeStringComplex(
1775 0 : papszOptions[i] + 14, ",", TRUE, FALSE);
1776 0 : if (CSLCount(papszTokens) < 1)
1777 : {
1778 0 : CPLError(CE_Failure, CPLE_AppDefined,
1779 : "AddFuncSource(): required argument missing.");
1780 : // TODO: How should this error be handled? Return
1781 : // CE_Failure?
1782 : }
1783 :
1784 0 : VRTImageReadFunc pfnReadFunc = nullptr;
1785 0 : sscanf(papszTokens[0], "%p", &pfnReadFunc);
1786 :
1787 0 : void *pCBData = nullptr;
1788 0 : if (CSLCount(papszTokens) > 1)
1789 0 : sscanf(papszTokens[1], "%p", &pCBData);
1790 :
1791 0 : const double dfNoDataValue = (CSLCount(papszTokens) > 2)
1792 0 : ? CPLAtof(papszTokens[2])
1793 0 : : VRT_NODATA_UNSET;
1794 :
1795 0 : poBand->AddFuncSource(pfnReadFunc, pCBData, dfNoDataValue);
1796 :
1797 0 : CSLDestroy(papszTokens);
1798 : }
1799 : }
1800 :
1801 6007 : return CE_None;
1802 : }
1803 : }
1804 :
1805 : /*! @endcond */
1806 : /************************************************************************/
1807 : /* VRTAddBand() */
1808 : /************************************************************************/
1809 :
1810 : /**
1811 : * @see VRTDataset::VRTAddBand().
1812 : *
1813 : * @note The return type of this function is int, but the actual values
1814 : * returned are of type CPLErr.
1815 : */
1816 :
1817 952 : int CPL_STDCALL VRTAddBand(VRTDatasetH hDataset, GDALDataType eType,
1818 : char **papszOptions)
1819 :
1820 : {
1821 952 : VALIDATE_POINTER1(hDataset, "VRTAddBand", 0);
1822 :
1823 952 : return static_cast<VRTDataset *>(GDALDataset::FromHandle(hDataset))
1824 952 : ->AddBand(eType, papszOptions);
1825 : }
1826 :
1827 : /*! @cond Doxygen_Suppress */
1828 : /************************************************************************/
1829 : /* Create() */
1830 : /************************************************************************/
1831 :
1832 505 : GDALDataset *VRTDataset::Create(const char *pszName, int nXSize, int nYSize,
1833 : int nBandsIn, GDALDataType eType,
1834 : char **papszOptions)
1835 :
1836 : {
1837 505 : if (STARTS_WITH_CI(pszName, "<VRTDataset"))
1838 : {
1839 0 : GDALDataset *poDS = OpenXML(pszName, nullptr, GA_Update);
1840 0 : if (poDS != nullptr)
1841 0 : poDS->SetDescription("<FromXML>");
1842 0 : return poDS;
1843 : }
1844 :
1845 505 : const char *pszSubclass = CSLFetchNameValue(papszOptions, "SUBCLASS");
1846 :
1847 505 : VRTDataset *poDS = nullptr;
1848 :
1849 : const int nBlockXSize =
1850 505 : atoi(CSLFetchNameValueDef(papszOptions, "BLOCKXSIZE", "0"));
1851 : const int nBlockYSize =
1852 505 : atoi(CSLFetchNameValueDef(papszOptions, "BLOCKYSIZE", "0"));
1853 505 : if (pszSubclass == nullptr || EQUAL(pszSubclass, "VRTDataset"))
1854 423 : poDS = new VRTDataset(nXSize, nYSize, nBlockXSize, nBlockYSize);
1855 82 : else if (EQUAL(pszSubclass, "VRTWarpedDataset"))
1856 : {
1857 82 : poDS = new VRTWarpedDataset(nXSize, nYSize, nBlockXSize, nBlockYSize);
1858 : }
1859 : else
1860 : {
1861 0 : CPLError(CE_Failure, CPLE_AppDefined, "SUBCLASS=%s not recognised.",
1862 : pszSubclass);
1863 0 : return nullptr;
1864 : }
1865 505 : poDS->eAccess = GA_Update;
1866 :
1867 505 : poDS->SetDescription(pszName);
1868 :
1869 714 : for (int iBand = 0; iBand < nBandsIn; iBand++)
1870 209 : poDS->AddBand(eType, nullptr);
1871 :
1872 505 : poDS->SetNeedsFlush();
1873 :
1874 505 : poDS->oOvManager.Initialize(poDS, pszName);
1875 :
1876 505 : return poDS;
1877 : }
1878 :
1879 : /************************************************************************/
1880 : /* CreateMultiDimensional() */
1881 : /************************************************************************/
1882 :
1883 : GDALDataset *
1884 100 : VRTDataset::CreateMultiDimensional(const char *pszFilename,
1885 : CSLConstList /*papszRootGroupOptions*/,
1886 : CSLConstList /*papszOptions*/)
1887 : {
1888 100 : VRTDataset *poDS = new VRTDataset(0, 0);
1889 100 : poDS->eAccess = GA_Update;
1890 100 : poDS->SetDescription(pszFilename);
1891 100 : poDS->m_poRootGroup = VRTGroup::Create(std::string(), "/");
1892 100 : poDS->m_poRootGroup->SetIsRootGroup();
1893 100 : poDS->m_poRootGroup->SetFilename(pszFilename);
1894 100 : poDS->m_poRootGroup->SetDirty();
1895 :
1896 100 : return poDS;
1897 : }
1898 :
1899 : /************************************************************************/
1900 : /* GetFileList() */
1901 : /************************************************************************/
1902 :
1903 59 : char **VRTDataset::GetFileList()
1904 : {
1905 59 : char **papszFileList = GDALDataset::GetFileList();
1906 :
1907 59 : int nSize = CSLCount(papszFileList);
1908 59 : int nMaxSize = nSize;
1909 :
1910 : // Do not need an element deallocator as each string points to an
1911 : // element of the papszFileList.
1912 : CPLHashSet *hSetFiles =
1913 59 : CPLHashSetNew(CPLHashSetHashStr, CPLHashSetEqualStr, nullptr);
1914 :
1915 129 : for (int iBand = 0; iBand < nBands; iBand++)
1916 : {
1917 70 : static_cast<VRTRasterBand *>(papoBands[iBand])
1918 70 : ->GetFileList(&papszFileList, &nSize, &nMaxSize, hSetFiles);
1919 : }
1920 :
1921 59 : CPLHashSetDestroy(hSetFiles);
1922 :
1923 59 : return papszFileList;
1924 : }
1925 :
1926 : /************************************************************************/
1927 : /* Delete() */
1928 : /************************************************************************/
1929 :
1930 : /* We implement Delete() to avoid that the default implementation */
1931 : /* in GDALDriver::Delete() destroys the source files listed by GetFileList(),*/
1932 : /* which would be an undesired effect... */
1933 12 : CPLErr VRTDataset::Delete(const char *pszFilename)
1934 : {
1935 12 : GDALDriverH hDriver = GDALIdentifyDriver(pszFilename, nullptr);
1936 :
1937 12 : if (!hDriver || !EQUAL(GDALGetDriverShortName(hDriver), "VRT"))
1938 0 : return CE_Failure;
1939 :
1940 23 : if (strstr(pszFilename, "<VRTDataset") == nullptr &&
1941 11 : VSIUnlink(pszFilename) != 0)
1942 : {
1943 0 : CPLError(CE_Failure, CPLE_AppDefined, "Deleting %s failed:\n%s",
1944 0 : pszFilename, VSIStrerror(errno));
1945 0 : return CE_Failure;
1946 : }
1947 :
1948 12 : return CE_None;
1949 : }
1950 :
1951 : /************************************************************************/
1952 : /* CreateMaskBand() */
1953 : /************************************************************************/
1954 :
1955 33 : CPLErr VRTDataset::CreateMaskBand(int)
1956 : {
1957 33 : if (m_poMaskBand != nullptr)
1958 : {
1959 1 : CPLError(CE_Failure, CPLE_AppDefined,
1960 : "This VRT dataset has already a mask band");
1961 1 : return CE_Failure;
1962 : }
1963 :
1964 32 : SetMaskBand(new VRTSourcedRasterBand(this, 0));
1965 :
1966 32 : return CE_None;
1967 : }
1968 :
1969 : /************************************************************************/
1970 : /* SetMaskBand() */
1971 : /************************************************************************/
1972 :
1973 58 : void VRTDataset::SetMaskBand(VRTRasterBand *poMaskBandIn)
1974 : {
1975 58 : delete m_poMaskBand;
1976 58 : m_poMaskBand = poMaskBandIn;
1977 58 : m_poMaskBand->SetIsMaskBand();
1978 58 : }
1979 :
1980 : /************************************************************************/
1981 : /* CloseDependentDatasets() */
1982 : /************************************************************************/
1983 :
1984 546 : int VRTDataset::CloseDependentDatasets()
1985 : {
1986 : /* We need to call it before removing the sources, otherwise */
1987 : /* we would remove them from the serizalized VRT */
1988 546 : FlushCache(true);
1989 :
1990 546 : int bHasDroppedRef = GDALDataset::CloseDependentDatasets();
1991 :
1992 1535 : for (int iBand = 0; iBand < nBands; iBand++)
1993 : {
1994 1978 : bHasDroppedRef |= static_cast<VRTRasterBand *>(papoBands[iBand])
1995 989 : ->CloseDependentDatasets();
1996 : }
1997 :
1998 546 : return bHasDroppedRef;
1999 : }
2000 :
2001 : /************************************************************************/
2002 : /* CheckCompatibleForDatasetIO() */
2003 : /************************************************************************/
2004 :
2005 : /* We will return TRUE only if all the bands are VRTSourcedRasterBands */
2006 : /* made of identical sources, that are strictly VRTSimpleSource, and that */
2007 : /* the band number of each source is the band number of the */
2008 : /* VRTSourcedRasterBand. */
2009 :
2010 6042 : bool VRTDataset::CheckCompatibleForDatasetIO() const
2011 : {
2012 6042 : int nSources = 0;
2013 6042 : VRTSource **papoSources = nullptr;
2014 12084 : CPLString osResampling;
2015 :
2016 6042 : if (m_nCompatibleForDatasetIO >= 0)
2017 : {
2018 4265 : return CPL_TO_BOOL(m_nCompatibleForDatasetIO);
2019 : }
2020 :
2021 1777 : m_nCompatibleForDatasetIO = false;
2022 :
2023 2797 : for (int iBand = 0; iBand < nBands; iBand++)
2024 : {
2025 2128 : auto poVRTBand = static_cast<VRTRasterBand *>(papoBands[iBand]);
2026 2128 : assert(poVRTBand);
2027 2128 : if (!poVRTBand->IsSourcedRasterBand())
2028 34 : return false;
2029 :
2030 2094 : const VRTSourcedRasterBand *poBand =
2031 : static_cast<const VRTSourcedRasterBand *>(poVRTBand);
2032 :
2033 : // Do not allow VRTDerivedRasterBand for example
2034 2094 : if (typeid(*poBand) != typeid(VRTSourcedRasterBand))
2035 3 : return false;
2036 :
2037 2091 : if (iBand == 0)
2038 : {
2039 1663 : nSources = poBand->nSources;
2040 1663 : papoSources = poBand->papoSources;
2041 2610 : for (int iSource = 0; iSource < nSources; iSource++)
2042 : {
2043 1953 : if (!papoSources[iSource]->IsSimpleSource())
2044 4 : return false;
2045 :
2046 1949 : const VRTSimpleSource *poSource =
2047 1949 : static_cast<const VRTSimpleSource *>(papoSources[iSource]);
2048 1949 : if (poSource->GetType() != VRTSimpleSource::GetTypeStatic())
2049 62 : return false;
2050 :
2051 5655 : if (poSource->m_nBand != iBand + 1 ||
2052 1887 : poSource->m_bGetMaskBand || poSource->m_osSrcDSName.empty())
2053 940 : return false;
2054 947 : osResampling = poSource->GetResampling();
2055 : }
2056 : }
2057 428 : else if (nSources != poBand->nSources)
2058 : {
2059 0 : return false;
2060 : }
2061 : else
2062 : {
2063 1399 : for (int iSource = 0; iSource < nSources; iSource++)
2064 : {
2065 1036 : if (!poBand->papoSources[iSource]->IsSimpleSource())
2066 0 : return false;
2067 1036 : const VRTSimpleSource *poRefSource =
2068 1036 : static_cast<const VRTSimpleSource *>(papoSources[iSource]);
2069 :
2070 1036 : const VRTSimpleSource *poSource =
2071 : static_cast<const VRTSimpleSource *>(
2072 1036 : poBand->papoSources[iSource]);
2073 1036 : if (poSource->GetType() != VRTSimpleSource::GetTypeStatic())
2074 10 : return false;
2075 3023 : if (poSource->m_nBand != iBand + 1 ||
2076 1026 : poSource->m_bGetMaskBand || poSource->m_osSrcDSName.empty())
2077 55 : return false;
2078 971 : if (!poSource->IsSameExceptBandNumber(poRefSource))
2079 0 : return false;
2080 971 : if (osResampling.compare(poSource->GetResampling()) != 0)
2081 0 : return false;
2082 : }
2083 : }
2084 : }
2085 :
2086 669 : m_nCompatibleForDatasetIO = nSources != 0;
2087 669 : return CPL_TO_BOOL(m_nCompatibleForDatasetIO);
2088 : }
2089 :
2090 : /************************************************************************/
2091 : /* GetSingleSimpleSource() */
2092 : /* */
2093 : /* Returns a non-NULL dataset if the VRT is made of a single source */
2094 : /* that is a simple source, in its full extent, and with all of its */
2095 : /* bands. Basically something produced by : */
2096 : /* gdal_translate src dst.vrt -of VRT (-a_srs / -a_ullr) */
2097 : /************************************************************************/
2098 :
2099 1161 : GDALDataset *VRTDataset::GetSingleSimpleSource()
2100 : {
2101 1161 : if (!CheckCompatibleForDatasetIO())
2102 911 : return nullptr;
2103 :
2104 250 : VRTSourcedRasterBand *poVRTBand =
2105 250 : static_cast<VRTSourcedRasterBand *>(papoBands[0]);
2106 250 : if (poVRTBand->nSources != 1)
2107 1 : return nullptr;
2108 :
2109 249 : VRTSimpleSource *poSource =
2110 249 : static_cast<VRTSimpleSource *>(poVRTBand->papoSources[0]);
2111 :
2112 249 : GDALRasterBand *poBand = poSource->GetRasterBand();
2113 249 : if (poBand == nullptr || poSource->GetMaskBandMainBand() != nullptr)
2114 3 : return nullptr;
2115 :
2116 246 : GDALDataset *poSrcDS = poBand->GetDataset();
2117 246 : if (poSrcDS == nullptr)
2118 0 : return nullptr;
2119 :
2120 : /* Check that it uses the full source dataset */
2121 246 : double dfReqXOff = 0.0;
2122 246 : double dfReqYOff = 0.0;
2123 246 : double dfReqXSize = 0.0;
2124 246 : double dfReqYSize = 0.0;
2125 246 : int nReqXOff = 0;
2126 246 : int nReqYOff = 0;
2127 246 : int nReqXSize = 0;
2128 246 : int nReqYSize = 0;
2129 246 : int nOutXOff = 0;
2130 246 : int nOutYOff = 0;
2131 246 : int nOutXSize = 0;
2132 246 : int nOutYSize = 0;
2133 246 : bool bError = false;
2134 492 : if (!poSource->GetSrcDstWindow(
2135 246 : 0, 0, poSrcDS->GetRasterXSize(), poSrcDS->GetRasterYSize(),
2136 : poSrcDS->GetRasterXSize(), poSrcDS->GetRasterYSize(), &dfReqXOff,
2137 : &dfReqYOff, &dfReqXSize, &dfReqYSize, &nReqXOff, &nReqYOff,
2138 : &nReqXSize, &nReqYSize, &nOutXOff, &nOutYOff, &nOutXSize,
2139 : &nOutYSize, bError))
2140 0 : return nullptr;
2141 :
2142 206 : if (nReqXOff != 0 || nReqYOff != 0 ||
2143 577 : nReqXSize != poSrcDS->GetRasterXSize() ||
2144 125 : nReqYSize != poSrcDS->GetRasterYSize())
2145 123 : return nullptr;
2146 :
2147 123 : if (nOutXOff != 0 || nOutYOff != 0 ||
2148 358 : nOutXSize != poSrcDS->GetRasterXSize() ||
2149 112 : nOutYSize != poSrcDS->GetRasterYSize())
2150 11 : return nullptr;
2151 :
2152 112 : return poSrcDS;
2153 : }
2154 :
2155 : /************************************************************************/
2156 : /* AdviseRead() */
2157 : /************************************************************************/
2158 :
2159 3152 : CPLErr VRTDataset::AdviseRead(int nXOff, int nYOff, int nXSize, int nYSize,
2160 : int nBufXSize, int nBufYSize, GDALDataType eDT,
2161 : int nBandCount, int *panBandList,
2162 : char **papszOptions)
2163 : {
2164 3152 : if (!CheckCompatibleForDatasetIO())
2165 2212 : return CE_None;
2166 :
2167 940 : VRTSourcedRasterBand *poVRTBand =
2168 940 : static_cast<VRTSourcedRasterBand *>(papoBands[0]);
2169 940 : if (poVRTBand->nSources != 1)
2170 9 : return CE_None;
2171 :
2172 931 : VRTSimpleSource *poSource =
2173 931 : static_cast<VRTSimpleSource *>(poVRTBand->papoSources[0]);
2174 :
2175 : /* Find source window and buffer size */
2176 931 : double dfReqXOff = 0.0;
2177 931 : double dfReqYOff = 0.0;
2178 931 : double dfReqXSize = 0.0;
2179 931 : double dfReqYSize = 0.0;
2180 931 : int nReqXOff = 0;
2181 931 : int nReqYOff = 0;
2182 931 : int nReqXSize = 0;
2183 931 : int nReqYSize = 0;
2184 931 : int nOutXOff = 0;
2185 931 : int nOutYOff = 0;
2186 931 : int nOutXSize = 0;
2187 931 : int nOutYSize = 0;
2188 931 : bool bError = false;
2189 931 : if (!poSource->GetSrcDstWindow(nXOff, nYOff, nXSize, nYSize, nBufXSize,
2190 : nBufYSize, &dfReqXOff, &dfReqYOff,
2191 : &dfReqXSize, &dfReqYSize, &nReqXOff,
2192 : &nReqYOff, &nReqXSize, &nReqYSize, &nOutXOff,
2193 : &nOutYOff, &nOutXSize, &nOutYSize, bError))
2194 : {
2195 92 : return bError ? CE_Failure : CE_None;
2196 : }
2197 :
2198 839 : GDALRasterBand *poBand = poSource->GetRasterBand();
2199 839 : if (poBand == nullptr || poSource->GetMaskBandMainBand() != nullptr)
2200 0 : return CE_None;
2201 :
2202 839 : GDALDataset *poSrcDS = poBand->GetDataset();
2203 839 : if (poSrcDS == nullptr)
2204 0 : return CE_None;
2205 :
2206 839 : return poSrcDS->AdviseRead(nReqXOff, nReqYOff, nReqXSize, nReqYSize,
2207 : nOutXSize, nOutYSize, eDT, nBandCount,
2208 839 : panBandList, papszOptions);
2209 : }
2210 :
2211 : /************************************************************************/
2212 : /* GetNumThreads() */
2213 : /************************************************************************/
2214 :
2215 37 : /* static */ int VRTDataset::GetNumThreads(GDALDataset *poDS)
2216 : {
2217 37 : const char *pszNumThreads = nullptr;
2218 37 : if (poDS)
2219 37 : pszNumThreads = CSLFetchNameValueDef(poDS->GetOpenOptions(),
2220 : "NUM_THREADS", nullptr);
2221 37 : if (!pszNumThreads)
2222 37 : pszNumThreads = CPLGetConfigOption("VRT_NUM_THREADS", nullptr);
2223 37 : if (!pszNumThreads)
2224 31 : pszNumThreads = CPLGetConfigOption("GDAL_NUM_THREADS", "ALL_CPUS");
2225 37 : if (EQUAL(pszNumThreads, "0") || EQUAL(pszNumThreads, "1"))
2226 5 : return atoi(pszNumThreads);
2227 32 : const int nMaxPoolSize = GDALGetMaxDatasetPoolSize();
2228 32 : const int nLimit = std::min(CPLGetNumCPUs(), nMaxPoolSize);
2229 32 : if (EQUAL(pszNumThreads, "ALL_CPUS"))
2230 31 : return nLimit;
2231 1 : return std::min(atoi(pszNumThreads), nLimit);
2232 : }
2233 :
2234 : /************************************************************************/
2235 : /* IRasterIO() */
2236 : /************************************************************************/
2237 :
2238 2319 : CPLErr VRTDataset::IRasterIO(GDALRWFlag eRWFlag, int nXOff, int nYOff,
2239 : int nXSize, int nYSize, void *pData, int nBufXSize,
2240 : int nBufYSize, GDALDataType eBufType,
2241 : int nBandCount, BANDMAP_TYPE panBandMap,
2242 : GSpacing nPixelSpace, GSpacing nLineSpace,
2243 : GSpacing nBandSpace,
2244 : GDALRasterIOExtraArg *psExtraArg)
2245 : {
2246 2319 : m_bMultiThreadedRasterIOLastUsed = false;
2247 :
2248 2319 : if (nBands == 1 && nBandCount == 1)
2249 : {
2250 : VRTSourcedRasterBand *poBand =
2251 642 : dynamic_cast<VRTSourcedRasterBand *>(papoBands[0]);
2252 642 : if (poBand)
2253 : {
2254 640 : return poBand->IRasterIO(eRWFlag, nXOff, nYOff, nXSize, nYSize,
2255 : pData, nBufXSize, nBufYSize, eBufType,
2256 640 : nPixelSpace, nLineSpace, psExtraArg);
2257 : }
2258 : }
2259 :
2260 : bool bLocalCompatibleForDatasetIO =
2261 1679 : CPL_TO_BOOL(CheckCompatibleForDatasetIO());
2262 367 : if (bLocalCompatibleForDatasetIO && eRWFlag == GF_Read &&
2263 2046 : (nBufXSize < nXSize || nBufYSize < nYSize) && m_apoOverviews.empty())
2264 : {
2265 2 : int bTried = FALSE;
2266 2 : const CPLErr eErr = TryOverviewRasterIO(
2267 : eRWFlag, nXOff, nYOff, nXSize, nYSize, pData, nBufXSize, nBufYSize,
2268 : eBufType, nBandCount, panBandMap, nPixelSpace, nLineSpace,
2269 : nBandSpace, psExtraArg, &bTried);
2270 :
2271 2 : if (bTried)
2272 : {
2273 1 : return eErr;
2274 : }
2275 :
2276 5 : for (int iBand = 0; iBand < nBands; iBand++)
2277 : {
2278 4 : VRTSourcedRasterBand *poBand =
2279 4 : static_cast<VRTSourcedRasterBand *>(papoBands[iBand]);
2280 :
2281 : // If there are overviews, let VRTSourcedRasterBand::IRasterIO()
2282 : // do the job.
2283 4 : if (poBand->GetOverviewCount() != 0)
2284 : {
2285 0 : bLocalCompatibleForDatasetIO = false;
2286 0 : break;
2287 : }
2288 : }
2289 : }
2290 :
2291 : // If resampling with non-nearest neighbour, we need to be careful
2292 : // if the VRT band exposes a nodata value, but the sources do not have it.
2293 : // To also avoid edge effects on sources when downsampling, use the
2294 : // base implementation of IRasterIO() (that is acquiring sources at their
2295 : // nominal resolution, and then downsampling), but only if none of the
2296 : // contributing sources have overviews.
2297 1678 : if (bLocalCompatibleForDatasetIO && eRWFlag == GF_Read &&
2298 344 : (nXSize != nBufXSize || nYSize != nBufYSize) &&
2299 22 : psExtraArg->eResampleAlg != GRIORA_NearestNeighbour)
2300 : {
2301 0 : for (int iBandIndex = 0; iBandIndex < nBandCount; iBandIndex++)
2302 : {
2303 : VRTSourcedRasterBand *poBand = static_cast<VRTSourcedRasterBand *>(
2304 0 : GetRasterBand(panBandMap[iBandIndex]));
2305 0 : if (!poBand->CanIRasterIOBeForwardedToEachSource(
2306 : eRWFlag, nXOff, nYOff, nXSize, nYSize, nBufXSize, nBufYSize,
2307 : psExtraArg))
2308 : {
2309 0 : bLocalCompatibleForDatasetIO = false;
2310 0 : break;
2311 : }
2312 : }
2313 : }
2314 :
2315 1678 : if (bLocalCompatibleForDatasetIO && eRWFlag == GF_Read)
2316 : {
2317 1153 : for (int iBandIndex = 0; iBandIndex < nBandCount; iBandIndex++)
2318 : {
2319 : VRTSourcedRasterBand *poBand = static_cast<VRTSourcedRasterBand *>(
2320 787 : GetRasterBand(panBandMap[iBandIndex]));
2321 :
2322 : /* Dirty little trick to initialize the buffer without doing */
2323 : /* any real I/O */
2324 787 : const int nSavedSources = poBand->nSources;
2325 787 : poBand->nSources = 0;
2326 :
2327 787 : GDALProgressFunc pfnProgressGlobal = psExtraArg->pfnProgress;
2328 787 : psExtraArg->pfnProgress = nullptr;
2329 :
2330 787 : GByte *pabyBandData =
2331 787 : static_cast<GByte *>(pData) + iBandIndex * nBandSpace;
2332 :
2333 787 : poBand->IRasterIO(GF_Read, nXOff, nYOff, nXSize, nYSize,
2334 : pabyBandData, nBufXSize, nBufYSize, eBufType,
2335 787 : nPixelSpace, nLineSpace, psExtraArg);
2336 :
2337 787 : psExtraArg->pfnProgress = pfnProgressGlobal;
2338 :
2339 787 : poBand->nSources = nSavedSources;
2340 : }
2341 :
2342 366 : CPLErr eErr = CE_None;
2343 :
2344 : // Use the last band, because when sources reference a GDALProxyDataset,
2345 : // they don't necessary instantiate all underlying rasterbands.
2346 366 : VRTSourcedRasterBand *poBand =
2347 366 : static_cast<VRTSourcedRasterBand *>(papoBands[nBands - 1]);
2348 :
2349 366 : double dfXOff = nXOff;
2350 366 : double dfYOff = nYOff;
2351 366 : double dfXSize = nXSize;
2352 366 : double dfYSize = nYSize;
2353 366 : if (psExtraArg->bFloatingPointWindowValidity)
2354 : {
2355 11 : dfXOff = psExtraArg->dfXOff;
2356 11 : dfYOff = psExtraArg->dfYOff;
2357 11 : dfXSize = psExtraArg->dfXSize;
2358 11 : dfYSize = psExtraArg->dfYSize;
2359 : }
2360 :
2361 366 : int nContributingSources = 0;
2362 366 : int nMaxThreads = 0;
2363 366 : constexpr int MINIMUM_PIXEL_COUNT_FOR_THREADED_IO = 1000 * 1000;
2364 732 : if ((static_cast<int64_t>(nBufXSize) * nBufYSize >=
2365 264 : MINIMUM_PIXEL_COUNT_FOR_THREADED_IO ||
2366 264 : static_cast<int64_t>(nXSize) * nYSize >=
2367 102 : MINIMUM_PIXEL_COUNT_FOR_THREADED_IO) &&
2368 102 : poBand->CanMultiThreadRasterIO(dfXOff, dfYOff, dfXSize, dfYSize,
2369 101 : nContributingSources) &&
2370 736 : nContributingSources > 1 &&
2371 4 : (nMaxThreads = VRTDataset::GetNumThreads(this)) > 1)
2372 : {
2373 2 : m_bMultiThreadedRasterIOLastUsed = true;
2374 2 : m_oMapSharedSources.InitMutex();
2375 :
2376 2 : std::atomic<bool> bSuccess = true;
2377 2 : CPLWorkerThreadPool *psThreadPool = GDALGetGlobalThreadPool(
2378 2 : std::min(nContributingSources, nMaxThreads));
2379 :
2380 2 : CPLDebugOnly(
2381 : "VRT",
2382 : "IRasterIO(): use optimized "
2383 : "multi-threaded code path for mosaic. "
2384 : "Using %d threads",
2385 : std::min(nContributingSources, psThreadPool->GetThreadCount()));
2386 :
2387 2 : auto oQueue = psThreadPool->CreateJobQueue();
2388 2 : std::atomic<int> nCompletedJobs = 0;
2389 132 : for (int iSource = 0; iSource < poBand->nSources; iSource++)
2390 : {
2391 130 : auto poSource = poBand->papoSources[iSource];
2392 130 : if (!poSource->IsSimpleSource())
2393 0 : continue;
2394 : auto poSimpleSource =
2395 130 : cpl::down_cast<VRTSimpleSource *>(poSource);
2396 130 : if (poSimpleSource->DstWindowIntersects(dfXOff, dfYOff, dfXSize,
2397 : dfYSize))
2398 : {
2399 67 : auto psJob = new RasterIOJob();
2400 67 : psJob->pbSuccess = &bSuccess;
2401 67 : psJob->pnCompletedJobs = &nCompletedJobs;
2402 67 : psJob->eVRTBandDataType = poBand->GetRasterDataType();
2403 67 : psJob->nXOff = nXOff;
2404 67 : psJob->nYOff = nYOff;
2405 67 : psJob->nXSize = nXSize;
2406 67 : psJob->nYSize = nYSize;
2407 67 : psJob->pData = pData;
2408 67 : psJob->nBufXSize = nBufXSize;
2409 67 : psJob->nBufYSize = nBufYSize;
2410 67 : psJob->eBufType = eBufType;
2411 67 : psJob->nBandCount = nBandCount;
2412 67 : psJob->panBandMap = panBandMap;
2413 67 : psJob->nPixelSpace = nPixelSpace;
2414 67 : psJob->nLineSpace = nLineSpace;
2415 67 : psJob->nBandSpace = nBandSpace;
2416 67 : psJob->psExtraArg = psExtraArg;
2417 67 : psJob->poSource = poSimpleSource;
2418 :
2419 67 : if (!oQueue->SubmitJob(RasterIOJob::Func, psJob))
2420 : {
2421 0 : delete psJob;
2422 0 : bSuccess = false;
2423 0 : break;
2424 : }
2425 : }
2426 : }
2427 :
2428 40 : while (oQueue->WaitEvent())
2429 : {
2430 : // Quite rough progress callback. We could do better by counting
2431 : // the number of contributing pixels.
2432 38 : if (psExtraArg->pfnProgress)
2433 : {
2434 76 : psExtraArg->pfnProgress(double(nCompletedJobs.load()) /
2435 : nContributingSources,
2436 : "", psExtraArg->pProgressData);
2437 : }
2438 : }
2439 :
2440 2 : eErr = bSuccess ? CE_None : CE_Failure;
2441 : }
2442 : else
2443 : {
2444 364 : GDALProgressFunc pfnProgressGlobal = psExtraArg->pfnProgress;
2445 364 : void *pProgressDataGlobal = psExtraArg->pProgressData;
2446 :
2447 895 : for (int iSource = 0; eErr == CE_None && iSource < poBand->nSources;
2448 : iSource++)
2449 : {
2450 531 : psExtraArg->pfnProgress = GDALScaledProgress;
2451 1062 : psExtraArg->pProgressData = GDALCreateScaledProgress(
2452 531 : 1.0 * iSource / poBand->nSources,
2453 531 : 1.0 * (iSource + 1) / poBand->nSources, pfnProgressGlobal,
2454 : pProgressDataGlobal);
2455 :
2456 531 : VRTSimpleSource *poSource = static_cast<VRTSimpleSource *>(
2457 531 : poBand->papoSources[iSource]);
2458 :
2459 531 : eErr = poSource->DatasetRasterIO(
2460 : poBand->GetRasterDataType(), nXOff, nYOff, nXSize, nYSize,
2461 : pData, nBufXSize, nBufYSize, eBufType, nBandCount,
2462 : panBandMap, nPixelSpace, nLineSpace, nBandSpace,
2463 : psExtraArg);
2464 :
2465 531 : GDALDestroyScaledProgress(psExtraArg->pProgressData);
2466 : }
2467 :
2468 364 : psExtraArg->pfnProgress = pfnProgressGlobal;
2469 364 : psExtraArg->pProgressData = pProgressDataGlobal;
2470 : }
2471 :
2472 366 : if (eErr == CE_None && psExtraArg->pfnProgress)
2473 : {
2474 121 : psExtraArg->pfnProgress(1.0, "", psExtraArg->pProgressData);
2475 : }
2476 :
2477 366 : return eErr;
2478 : }
2479 :
2480 : CPLErr eErr;
2481 1312 : if (eRWFlag == GF_Read &&
2482 1312 : psExtraArg->eResampleAlg != GRIORA_NearestNeighbour &&
2483 2 : nBufXSize < nXSize && nBufYSize < nYSize && nBandCount > 1)
2484 : {
2485 : // Force going through VRTSourcedRasterBand::IRasterIO(), otherwise
2486 : // GDALDataset::IRasterIOResampled() would be used without source
2487 : // overviews being potentially used.
2488 2 : eErr = GDALDataset::BandBasedRasterIO(
2489 : eRWFlag, nXOff, nYOff, nXSize, nYSize, pData, nBufXSize, nBufYSize,
2490 : eBufType, nBandCount, panBandMap, nPixelSpace, nLineSpace,
2491 : nBandSpace, psExtraArg);
2492 : }
2493 : else
2494 : {
2495 1310 : eErr = GDALDataset::IRasterIO(eRWFlag, nXOff, nYOff, nXSize, nYSize,
2496 : pData, nBufXSize, nBufYSize, eBufType,
2497 : nBandCount, panBandMap, nPixelSpace,
2498 : nLineSpace, nBandSpace, psExtraArg);
2499 : }
2500 1312 : return eErr;
2501 : }
2502 :
2503 : /************************************************************************/
2504 : /* VRTDataset::RasterIOJob::Func() */
2505 : /************************************************************************/
2506 :
2507 67 : void VRTDataset::RasterIOJob::Func(void *pData)
2508 : {
2509 : auto psJob =
2510 134 : std::unique_ptr<RasterIOJob>(static_cast<RasterIOJob *>(pData));
2511 67 : if (*psJob->pbSuccess)
2512 : {
2513 67 : GDALRasterIOExtraArg sArg = *(psJob->psExtraArg);
2514 67 : sArg.pfnProgress = nullptr;
2515 67 : sArg.pProgressData = nullptr;
2516 :
2517 134 : if (psJob->poSource->DatasetRasterIO(
2518 67 : psJob->eVRTBandDataType, psJob->nXOff, psJob->nYOff,
2519 67 : psJob->nXSize, psJob->nYSize, psJob->pData, psJob->nBufXSize,
2520 67 : psJob->nBufYSize, psJob->eBufType, psJob->nBandCount,
2521 67 : psJob->panBandMap, psJob->nPixelSpace, psJob->nLineSpace,
2522 134 : psJob->nBandSpace, &sArg) != CE_None)
2523 : {
2524 0 : *psJob->pbSuccess = false;
2525 : }
2526 : }
2527 :
2528 67 : ++(*psJob->pnCompletedJobs);
2529 67 : }
2530 :
2531 : /************************************************************************/
2532 : /* UnsetPreservedRelativeFilenames() */
2533 : /************************************************************************/
2534 :
2535 103 : void VRTDataset::UnsetPreservedRelativeFilenames()
2536 : {
2537 205 : for (int iBand = 0; iBand < nBands; iBand++)
2538 : {
2539 288 : if (!static_cast<VRTRasterBand *>(papoBands[iBand])
2540 102 : ->IsSourcedRasterBand())
2541 84 : continue;
2542 :
2543 18 : VRTSourcedRasterBand *poBand =
2544 18 : static_cast<VRTSourcedRasterBand *>(papoBands[iBand]);
2545 18 : const int nSources = poBand->nSources;
2546 18 : VRTSource **papoSources = poBand->papoSources;
2547 23 : for (int iSource = 0; iSource < nSources; iSource++)
2548 : {
2549 5 : if (!papoSources[iSource]->IsSimpleSource())
2550 0 : continue;
2551 :
2552 5 : VRTSimpleSource *poSource =
2553 5 : static_cast<VRTSimpleSource *>(papoSources[iSource]);
2554 5 : poSource->UnsetPreservedRelativeFilenames();
2555 : }
2556 : }
2557 103 : }
2558 :
2559 : /************************************************************************/
2560 : /* BuildVirtualOverviews() */
2561 : /************************************************************************/
2562 :
2563 5464 : static bool CheckBandForOverview(GDALRasterBand *poBand,
2564 : GDALRasterBand *&poFirstBand, int &nOverviews,
2565 : std::set<std::pair<int, int>> &oSetOvrSizes,
2566 : std::vector<GDALDataset *> &apoOverviewsBak)
2567 : {
2568 5464 : if (!cpl::down_cast<VRTRasterBand *>(poBand)->IsSourcedRasterBand())
2569 0 : return false;
2570 :
2571 : VRTSourcedRasterBand *poVRTBand =
2572 5464 : cpl::down_cast<VRTSourcedRasterBand *>(poBand);
2573 5464 : if (poVRTBand->nSources != 1)
2574 4233 : return false;
2575 1231 : if (!poVRTBand->papoSources[0]->IsSimpleSource())
2576 0 : return false;
2577 :
2578 : VRTSimpleSource *poSource =
2579 1231 : cpl::down_cast<VRTSimpleSource *>(poVRTBand->papoSources[0]);
2580 1231 : const char *pszType = poSource->GetType();
2581 1249 : if (pszType != VRTSimpleSource::GetTypeStatic() &&
2582 18 : pszType != VRTComplexSource::GetTypeStatic())
2583 : {
2584 2 : return false;
2585 : }
2586 1229 : GDALRasterBand *poSrcBand = poBand->GetBand() == 0
2587 1229 : ? poSource->GetMaskBandMainBand()
2588 1219 : : poSource->GetRasterBand();
2589 1229 : if (poSrcBand == nullptr)
2590 98 : return false;
2591 :
2592 : // To prevent recursion
2593 1131 : apoOverviewsBak.push_back(nullptr);
2594 1131 : const int nOvrCount = poSrcBand->GetOverviewCount();
2595 : oSetOvrSizes.insert(
2596 1131 : std::pair<int, int>(poSrcBand->GetXSize(), poSrcBand->GetYSize()));
2597 1286 : for (int i = 0; i < nOvrCount; ++i)
2598 : {
2599 155 : auto poSrcOvrBand = poSrcBand->GetOverview(i);
2600 155 : if (poSrcOvrBand)
2601 : {
2602 155 : oSetOvrSizes.insert(std::pair<int, int>(poSrcOvrBand->GetXSize(),
2603 310 : poSrcOvrBand->GetYSize()));
2604 : }
2605 : }
2606 1131 : apoOverviewsBak.resize(0);
2607 :
2608 1131 : if (nOvrCount == 0)
2609 1039 : return false;
2610 92 : if (poFirstBand == nullptr)
2611 : {
2612 33 : if (poSrcBand->GetXSize() == 0 || poSrcBand->GetYSize() == 0)
2613 0 : return false;
2614 33 : poFirstBand = poSrcBand;
2615 33 : nOverviews = nOvrCount;
2616 : }
2617 59 : else if (nOvrCount < nOverviews)
2618 0 : nOverviews = nOvrCount;
2619 92 : return true;
2620 : }
2621 :
2622 5429 : void VRTDataset::BuildVirtualOverviews()
2623 : {
2624 : // Currently we expose virtual overviews only if the dataset is made of
2625 : // a single SimpleSource/ComplexSource, in each band.
2626 : // And if the underlying sources have overviews of course
2627 5429 : if (!m_apoOverviews.empty() || !m_apoOverviewsBak.empty())
2628 5407 : return;
2629 :
2630 5394 : int nOverviews = 0;
2631 5394 : GDALRasterBand *poFirstBand = nullptr;
2632 5394 : std::set<std::pair<int, int>> oSetOvrSizes;
2633 :
2634 5484 : for (int iBand = 0; iBand < nBands; iBand++)
2635 : {
2636 5454 : if (!CheckBandForOverview(papoBands[iBand], poFirstBand, nOverviews,
2637 5454 : oSetOvrSizes, m_apoOverviewsBak))
2638 5364 : return;
2639 : }
2640 :
2641 30 : if (m_poMaskBand)
2642 : {
2643 10 : if (!CheckBandForOverview(m_poMaskBand, poFirstBand, nOverviews,
2644 10 : oSetOvrSizes, m_apoOverviewsBak))
2645 8 : return;
2646 : }
2647 22 : if (poFirstBand == nullptr)
2648 : {
2649 : // to make cppcheck happy
2650 0 : CPLAssert(false);
2651 : return;
2652 : }
2653 :
2654 : VRTSourcedRasterBand *l_poVRTBand =
2655 22 : cpl::down_cast<VRTSourcedRasterBand *>(papoBands[0]);
2656 : VRTSimpleSource *poSource =
2657 22 : cpl::down_cast<VRTSimpleSource *>(l_poVRTBand->papoSources[0]);
2658 22 : const double dfDstToSrcXRatio =
2659 22 : poSource->m_dfDstXSize / poSource->m_dfSrcXSize;
2660 22 : const double dfDstToSrcYRatio =
2661 22 : poSource->m_dfDstYSize / poSource->m_dfSrcYSize;
2662 :
2663 54 : for (int j = 0; j < nOverviews; j++)
2664 : {
2665 36 : auto poOvrBand = poFirstBand->GetOverview(j);
2666 36 : if (!poOvrBand)
2667 0 : return;
2668 36 : const double dfXRatio = static_cast<double>(poOvrBand->GetXSize()) /
2669 36 : poFirstBand->GetXSize();
2670 36 : const double dfYRatio = static_cast<double>(poOvrBand->GetYSize()) /
2671 36 : poFirstBand->GetYSize();
2672 36 : if (dfXRatio >= dfDstToSrcXRatio || dfYRatio >= dfDstToSrcYRatio)
2673 : {
2674 5 : continue;
2675 : }
2676 31 : int nOvrXSize = static_cast<int>(0.5 + nRasterXSize * dfXRatio);
2677 31 : int nOvrYSize = static_cast<int>(0.5 + nRasterYSize * dfYRatio);
2678 31 : if (nOvrXSize < 128 || nOvrYSize < 128)
2679 : break;
2680 :
2681 : // Look for a source overview whose size is very close to the
2682 : // theoretical computed one.
2683 97 : for (const auto &ovrSize : oSetOvrSizes)
2684 : {
2685 86 : if (std::abs(ovrSize.first - nOvrXSize) <= 1 &&
2686 16 : std::abs(ovrSize.second - nOvrYSize) <= 1)
2687 : {
2688 16 : nOvrXSize = ovrSize.first;
2689 16 : nOvrYSize = ovrSize.second;
2690 16 : break;
2691 : }
2692 : }
2693 :
2694 27 : VRTDataset *poOvrVDS = new VRTDataset(nOvrXSize, nOvrYSize);
2695 27 : m_apoOverviews.push_back(poOvrVDS);
2696 :
2697 : const auto CreateOverviewBand =
2698 75 : [&poOvrVDS, nOvrXSize, nOvrYSize, dfXRatio,
2699 150 : dfYRatio](VRTSourcedRasterBand *poVRTBand)
2700 : {
2701 : VRTSourcedRasterBand *poOvrVRTBand = new VRTSourcedRasterBand(
2702 75 : poOvrVDS, poVRTBand->GetBand(), poVRTBand->GetRasterDataType(),
2703 75 : nOvrXSize, nOvrYSize);
2704 75 : poOvrVRTBand->CopyCommonInfoFrom(poVRTBand);
2705 75 : poOvrVRTBand->m_bNoDataValueSet = poVRTBand->m_bNoDataValueSet;
2706 75 : poOvrVRTBand->m_dfNoDataValue = poVRTBand->m_dfNoDataValue;
2707 75 : poOvrVRTBand->m_bHideNoDataValue = poVRTBand->m_bHideNoDataValue;
2708 :
2709 : VRTSimpleSource *poSrcSource =
2710 75 : cpl::down_cast<VRTSimpleSource *>(poVRTBand->papoSources[0]);
2711 75 : VRTSimpleSource *poNewSource = nullptr;
2712 75 : const char *pszType = poSrcSource->GetType();
2713 75 : if (pszType == VRTSimpleSource::GetTypeStatic())
2714 : {
2715 70 : poNewSource =
2716 70 : new VRTSimpleSource(poSrcSource, dfXRatio, dfYRatio);
2717 : }
2718 5 : else if (pszType == VRTComplexSource::GetTypeStatic())
2719 : {
2720 5 : poNewSource = new VRTComplexSource(
2721 5 : cpl::down_cast<VRTComplexSource *>(poSrcSource), dfXRatio,
2722 5 : dfYRatio);
2723 : }
2724 : else
2725 : {
2726 0 : CPLAssert(false);
2727 : }
2728 75 : if (poNewSource)
2729 : {
2730 75 : auto poNewSourceBand = poVRTBand->GetBand() == 0
2731 75 : ? poNewSource->GetMaskBandMainBand()
2732 71 : : poNewSource->GetRasterBand();
2733 75 : CPLAssert(poNewSourceBand);
2734 75 : auto poNewSourceBandDS = poNewSourceBand->GetDataset();
2735 75 : if (poNewSourceBandDS)
2736 75 : poNewSourceBandDS->Reference();
2737 75 : poOvrVRTBand->AddSource(poNewSource);
2738 : }
2739 :
2740 75 : return poOvrVRTBand;
2741 27 : };
2742 :
2743 98 : for (int i = 0; i < nBands; i++)
2744 : {
2745 : VRTSourcedRasterBand *poSrcBand =
2746 71 : cpl::down_cast<VRTSourcedRasterBand *>(GetRasterBand(i + 1));
2747 71 : auto poOvrVRTBand = CreateOverviewBand(poSrcBand);
2748 71 : poOvrVDS->SetBand(poOvrVDS->GetRasterCount() + 1, poOvrVRTBand);
2749 : }
2750 :
2751 27 : if (m_poMaskBand)
2752 : {
2753 : VRTSourcedRasterBand *poSrcBand =
2754 4 : cpl::down_cast<VRTSourcedRasterBand *>(m_poMaskBand);
2755 4 : auto poOvrVRTBand = CreateOverviewBand(poSrcBand);
2756 4 : poOvrVDS->SetMaskBand(poOvrVRTBand);
2757 : }
2758 : }
2759 : }
2760 :
2761 : /************************************************************************/
2762 : /* AddVirtualOverview() */
2763 : /************************************************************************/
2764 :
2765 34 : bool VRTDataset::AddVirtualOverview(int nOvFactor, const char *pszResampling)
2766 : {
2767 34 : if (nRasterXSize / nOvFactor == 0 || nRasterYSize / nOvFactor == 0)
2768 : {
2769 1 : return false;
2770 : }
2771 :
2772 66 : CPLStringList argv;
2773 33 : argv.AddString("-of");
2774 33 : argv.AddString("VRT");
2775 33 : argv.AddString("-outsize");
2776 33 : argv.AddString(CPLSPrintf("%d", nRasterXSize / nOvFactor));
2777 33 : argv.AddString(CPLSPrintf("%d", nRasterYSize / nOvFactor));
2778 33 : argv.AddString("-r");
2779 33 : argv.AddString(pszResampling);
2780 :
2781 : GDALTranslateOptions *psOptions =
2782 33 : GDALTranslateOptionsNew(argv.List(), nullptr);
2783 :
2784 : // Add a dummy overview so that BuildVirtualOverviews() doesn't trigger
2785 33 : m_apoOverviews.push_back(nullptr);
2786 33 : CPLAssert(m_bCanTakeRef);
2787 33 : m_bCanTakeRef =
2788 : false; // we don't want hOverviewDS to take a reference on ourselves.
2789 : GDALDatasetH hOverviewDS =
2790 33 : GDALTranslate("", GDALDataset::ToHandle(this), psOptions, nullptr);
2791 33 : m_bCanTakeRef = true;
2792 33 : m_apoOverviews.pop_back();
2793 :
2794 33 : GDALTranslateOptionsFree(psOptions);
2795 33 : if (hOverviewDS == nullptr)
2796 0 : return false;
2797 :
2798 33 : m_anOverviewFactors.push_back(nOvFactor);
2799 33 : m_apoOverviews.push_back(GDALDataset::FromHandle(hOverviewDS));
2800 33 : return true;
2801 : }
2802 :
2803 : /************************************************************************/
2804 : /* IBuildOverviews() */
2805 : /************************************************************************/
2806 :
2807 28 : CPLErr VRTDataset::IBuildOverviews(const char *pszResampling, int nOverviews,
2808 : const int *panOverviewList, int nListBands,
2809 : const int *panBandList,
2810 : GDALProgressFunc pfnProgress,
2811 : void *pProgressData,
2812 : CSLConstList papszOptions)
2813 : {
2814 28 : if (CPLTestBool(CPLGetConfigOption("VRT_VIRTUAL_OVERVIEWS", "NO")))
2815 : {
2816 13 : SetNeedsFlush();
2817 25 : if (nOverviews == 0 ||
2818 12 : (!m_apoOverviews.empty() && m_anOverviewFactors.empty()))
2819 : {
2820 2 : m_anOverviewFactors.clear();
2821 2 : m_apoOverviewsBak.insert(m_apoOverviewsBak.end(),
2822 : m_apoOverviews.begin(),
2823 4 : m_apoOverviews.end());
2824 2 : m_apoOverviews.clear();
2825 : }
2826 13 : m_osOverviewResampling = pszResampling;
2827 36 : for (int i = 0; i < nOverviews; i++)
2828 : {
2829 23 : if (std::find(m_anOverviewFactors.begin(),
2830 : m_anOverviewFactors.end(),
2831 23 : panOverviewList[i]) == m_anOverviewFactors.end())
2832 : {
2833 23 : AddVirtualOverview(panOverviewList[i], pszResampling);
2834 : }
2835 : }
2836 13 : return CE_None;
2837 : }
2838 :
2839 15 : if (!oOvManager.IsInitialized())
2840 : {
2841 0 : const char *pszDesc = GetDescription();
2842 0 : if (pszDesc[0])
2843 : {
2844 0 : oOvManager.Initialize(this, pszDesc);
2845 : }
2846 : }
2847 :
2848 : // Make implicit overviews invisible, but do not destroy them in case they
2849 : // are already used. Should the client do that? Behavior might undefined
2850 : // in GDAL API?
2851 15 : if (!m_apoOverviews.empty())
2852 : {
2853 2 : m_apoOverviewsBak.insert(m_apoOverviewsBak.end(),
2854 4 : m_apoOverviews.begin(), m_apoOverviews.end());
2855 2 : m_apoOverviews.clear();
2856 : }
2857 : else
2858 : {
2859 : // Add a dummy overview so that GDALDataset::IBuildOverviews()
2860 : // doesn't manage to get a virtual implicit overview.
2861 13 : m_apoOverviews.push_back(nullptr);
2862 : }
2863 :
2864 15 : CPLErr eErr = GDALDataset::IBuildOverviews(
2865 : pszResampling, nOverviews, panOverviewList, nListBands, panBandList,
2866 : pfnProgress, pProgressData, papszOptions);
2867 :
2868 15 : m_apoOverviews.clear();
2869 15 : return eErr;
2870 : }
2871 :
2872 : /************************************************************************/
2873 : /* GetShiftedDataset() */
2874 : /* */
2875 : /* Returns true if the VRT is made of a single source that is a simple */
2876 : /* in its full resolution. */
2877 : /************************************************************************/
2878 :
2879 50 : bool VRTDataset::GetShiftedDataset(int nXOff, int nYOff, int nXSize, int nYSize,
2880 : GDALDataset *&poSrcDataset, int &nSrcXOff,
2881 : int &nSrcYOff)
2882 : {
2883 50 : if (!CheckCompatibleForDatasetIO())
2884 40 : return false;
2885 :
2886 10 : VRTSourcedRasterBand *poVRTBand =
2887 10 : static_cast<VRTSourcedRasterBand *>(papoBands[0]);
2888 10 : if (poVRTBand->nSources != 1)
2889 0 : return false;
2890 :
2891 10 : VRTSimpleSource *poSource =
2892 10 : static_cast<VRTSimpleSource *>(poVRTBand->papoSources[0]);
2893 :
2894 10 : GDALRasterBand *poBand = poSource->GetRasterBand();
2895 10 : if (!poBand || poSource->GetMaskBandMainBand())
2896 4 : return false;
2897 :
2898 6 : poSrcDataset = poBand->GetDataset();
2899 6 : if (!poSrcDataset)
2900 0 : return false;
2901 :
2902 6 : double dfReqXOff = 0.0;
2903 6 : double dfReqYOff = 0.0;
2904 6 : double dfReqXSize = 0.0;
2905 6 : double dfReqYSize = 0.0;
2906 6 : int nReqXOff = 0;
2907 6 : int nReqYOff = 0;
2908 6 : int nReqXSize = 0;
2909 6 : int nReqYSize = 0;
2910 6 : int nOutXOff = 0;
2911 6 : int nOutYOff = 0;
2912 6 : int nOutXSize = 0;
2913 6 : int nOutYSize = 0;
2914 6 : bool bError = false;
2915 6 : if (!poSource->GetSrcDstWindow(nXOff, nYOff, nXSize, nYSize, nXSize, nYSize,
2916 : &dfReqXOff, &dfReqYOff, &dfReqXSize,
2917 : &dfReqYSize, &nReqXOff, &nReqYOff,
2918 : &nReqXSize, &nReqYSize, &nOutXOff, &nOutYOff,
2919 : &nOutXSize, &nOutYSize, bError))
2920 0 : return false;
2921 :
2922 6 : if (nReqXSize != nXSize || nReqYSize != nYSize || nReqXSize != nOutXSize ||
2923 6 : nReqYSize != nOutYSize)
2924 0 : return false;
2925 :
2926 6 : nSrcXOff = nReqXOff;
2927 6 : nSrcYOff = nReqYOff;
2928 6 : return true;
2929 : }
2930 :
2931 : /************************************************************************/
2932 : /* GetCompressionFormats() */
2933 : /************************************************************************/
2934 :
2935 0 : CPLStringList VRTDataset::GetCompressionFormats(int nXOff, int nYOff,
2936 : int nXSize, int nYSize,
2937 : int nBandCount,
2938 : const int *panBandList)
2939 : {
2940 : GDALDataset *poSrcDataset;
2941 : int nSrcXOff;
2942 : int nSrcYOff;
2943 0 : if (!GetShiftedDataset(nXOff, nYOff, nXSize, nYSize, poSrcDataset, nSrcXOff,
2944 : nSrcYOff))
2945 0 : return CPLStringList();
2946 : return poSrcDataset->GetCompressionFormats(nSrcXOff, nSrcYOff, nXSize,
2947 0 : nYSize, nBandCount, panBandList);
2948 : }
2949 :
2950 : /************************************************************************/
2951 : /* ReadCompressedData() */
2952 : /************************************************************************/
2953 :
2954 50 : CPLErr VRTDataset::ReadCompressedData(const char *pszFormat, int nXOff,
2955 : int nYOff, int nXSize, int nYSize,
2956 : int nBandCount, const int *panBandList,
2957 : void **ppBuffer, size_t *pnBufferSize,
2958 : char **ppszDetailedFormat)
2959 : {
2960 : GDALDataset *poSrcDataset;
2961 : int nSrcXOff;
2962 : int nSrcYOff;
2963 50 : if (!GetShiftedDataset(nXOff, nYOff, nXSize, nYSize, poSrcDataset, nSrcXOff,
2964 : nSrcYOff))
2965 44 : return CE_Failure;
2966 6 : return poSrcDataset->ReadCompressedData(
2967 : pszFormat, nSrcXOff, nSrcYOff, nXSize, nYSize, nBandCount, panBandList,
2968 6 : ppBuffer, pnBufferSize, ppszDetailedFormat);
2969 : }
2970 :
2971 : /************************************************************************/
2972 : /* ClearStatistics() */
2973 : /************************************************************************/
2974 :
2975 2 : void VRTDataset::ClearStatistics()
2976 : {
2977 6 : for (int i = 1; i <= nBands; ++i)
2978 : {
2979 4 : bool bChanged = false;
2980 4 : GDALRasterBand *poBand = GetRasterBand(i);
2981 4 : CSLConstList papszOldMD = poBand->GetMetadata();
2982 8 : CPLStringList aosNewMD;
2983 14 : for (const char *pszMDItem : cpl::Iterate(papszOldMD))
2984 : {
2985 10 : if (STARTS_WITH_CI(pszMDItem, "STATISTICS_"))
2986 : {
2987 10 : bChanged = true;
2988 : }
2989 : else
2990 : {
2991 0 : aosNewMD.AddString(pszMDItem);
2992 : }
2993 : }
2994 4 : if (bChanged)
2995 : {
2996 2 : poBand->SetMetadata(aosNewMD.List());
2997 : }
2998 : }
2999 :
3000 2 : GDALDataset::ClearStatistics();
3001 2 : }
3002 :
3003 : /************************************************************************/
3004 : /* BuildSourceFilename() */
3005 : /************************************************************************/
3006 :
3007 : /* static */
3008 3115 : std::string VRTDataset::BuildSourceFilename(const char *pszFilename,
3009 : const char *pszVRTPath,
3010 : bool bRelativeToVRT)
3011 : {
3012 3115 : std::string osSrcDSName;
3013 3115 : if (pszVRTPath != nullptr && bRelativeToVRT)
3014 : {
3015 : // Try subdatasetinfo API first
3016 : // Note: this will become the only branch when subdatasetinfo will become
3017 : // available for NITF_IM, RASTERLITE and TILEDB
3018 2517 : const auto oSubDSInfo{GDALGetSubdatasetInfo(pszFilename)};
3019 2517 : if (oSubDSInfo && !oSubDSInfo->GetPathComponent().empty())
3020 : {
3021 8 : auto path{oSubDSInfo->GetPathComponent()};
3022 8 : osSrcDSName = oSubDSInfo->ModifyPathComponent(
3023 4 : CPLProjectRelativeFilename(pszVRTPath, path.c_str()));
3024 4 : GDALDestroySubdatasetInfo(oSubDSInfo);
3025 : }
3026 : else
3027 : {
3028 2513 : bool bDone = false;
3029 15068 : for (const char *pszSyntax : VRTDataset::apszSpecialSyntax)
3030 : {
3031 12557 : CPLString osPrefix(pszSyntax);
3032 12557 : osPrefix.resize(strchr(pszSyntax, ':') - pszSyntax + 1);
3033 12557 : if (pszSyntax[osPrefix.size()] == '"')
3034 2511 : osPrefix += '"';
3035 12557 : if (EQUALN(pszFilename, osPrefix, osPrefix.size()))
3036 : {
3037 2 : if (STARTS_WITH_CI(pszSyntax + osPrefix.size(), "{ANY}"))
3038 : {
3039 2 : const char *pszLastPart = strrchr(pszFilename, ':') + 1;
3040 : // CSV:z:/foo.xyz
3041 2 : if ((pszLastPart[0] == '/' || pszLastPart[0] == '\\') &&
3042 0 : pszLastPart - pszFilename >= 3 &&
3043 0 : pszLastPart[-3] == ':')
3044 : {
3045 0 : pszLastPart -= 2;
3046 : }
3047 2 : CPLString osPrefixFilename = pszFilename;
3048 2 : osPrefixFilename.resize(pszLastPart - pszFilename);
3049 : osSrcDSName =
3050 4 : osPrefixFilename +
3051 2 : CPLProjectRelativeFilename(pszVRTPath, pszLastPart);
3052 2 : bDone = true;
3053 : }
3054 0 : else if (STARTS_WITH_CI(pszSyntax + osPrefix.size(),
3055 : "{FILENAME}"))
3056 : {
3057 0 : CPLString osFilename(pszFilename + osPrefix.size());
3058 0 : size_t nPos = 0;
3059 0 : if (osFilename.size() >= 3 && osFilename[1] == ':' &&
3060 0 : (osFilename[2] == '\\' || osFilename[2] == '/'))
3061 0 : nPos = 2;
3062 0 : nPos = osFilename.find(
3063 0 : pszSyntax[osPrefix.size() + strlen("{FILENAME}")],
3064 : nPos);
3065 0 : if (nPos != std::string::npos)
3066 : {
3067 0 : const CPLString osSuffix = osFilename.substr(nPos);
3068 0 : osFilename.resize(nPos);
3069 0 : osSrcDSName = osPrefix +
3070 : CPLProjectRelativeFilename(
3071 0 : pszVRTPath, osFilename) +
3072 0 : osSuffix;
3073 0 : bDone = true;
3074 : }
3075 : }
3076 2 : break;
3077 : }
3078 : }
3079 2513 : if (!bDone)
3080 : {
3081 5022 : std::string osVRTPath = pszVRTPath;
3082 2511 : if (!CPLIsFilenameRelative(pszVRTPath))
3083 : {
3084 : // Simplify path by replacing "foo/a/../b" with "foo/b"
3085 2214 : while (STARTS_WITH(pszFilename, "../"))
3086 : {
3087 5 : osVRTPath = CPLGetPath(osVRTPath.c_str());
3088 5 : pszFilename += strlen("../");
3089 : }
3090 : }
3091 :
3092 : osSrcDSName =
3093 2511 : CPLProjectRelativeFilename(osVRTPath.c_str(), pszFilename);
3094 : }
3095 2517 : }
3096 : }
3097 : else
3098 : {
3099 598 : osSrcDSName = pszFilename;
3100 : }
3101 3115 : return osSrcDSName;
3102 : }
3103 :
3104 : /************************************************************************/
3105 : /* VRTMapSharedResources::Get() */
3106 : /************************************************************************/
3107 :
3108 1138 : GDALDataset *VRTMapSharedResources::Get(const std::string &osKey) const
3109 : {
3110 1138 : if (poMutex)
3111 132 : poMutex->lock();
3112 1140 : auto oIter = oMap.find(osKey);
3113 1140 : GDALDataset *poRet = nullptr;
3114 1140 : if (oIter != oMap.end())
3115 163 : poRet = oIter->second;
3116 1140 : if (poMutex)
3117 134 : poMutex->unlock();
3118 1140 : return poRet;
3119 : }
3120 :
3121 : /************************************************************************/
3122 : /* VRTMapSharedResources::Get() */
3123 : /************************************************************************/
3124 :
3125 924 : void VRTMapSharedResources::Insert(const std::string &osKey, GDALDataset *poDS)
3126 : {
3127 924 : if (poMutex)
3128 134 : poMutex->lock();
3129 924 : oMap[osKey] = poDS;
3130 925 : if (poMutex)
3131 134 : poMutex->unlock();
3132 925 : }
3133 :
3134 : /************************************************************************/
3135 : /* VRTMapSharedResources::InitMutex() */
3136 : /************************************************************************/
3137 :
3138 20 : void VRTMapSharedResources::InitMutex()
3139 : {
3140 20 : poMutex = &oMutex;
3141 20 : }
3142 :
3143 : /*! @endcond */
|
