Line data Source code
1 : /*
2 : * Copyright (c) 2002-2012, California Institute of Technology.
3 : * All rights reserved. Based on Government Sponsored Research under contracts
4 : * NAS7-1407 and/or NAS7-03001.
5 : *
6 : * Redistribution and use in source and binary forms, with or without
7 : * modification, are permitted provided that the following conditions are met:
8 : * 1. Redistributions of source code must retain the above copyright notice,
9 : * this list of conditions and the following disclaimer.
10 : * 2. Redistributions in binary form must reproduce the above copyright
11 : * notice, this list of conditions and the following disclaimer in the
12 : * documentation and/or other materials provided with the distribution.
13 : * 3. Neither the name of the California Institute of Technology (Caltech),
14 : * its operating division the Jet Propulsion Laboratory (JPL), the National
15 : * Aeronautics and Space Administration (NASA), nor the names of its
16 : * contributors may be used to endorse or promote products derived from this
17 : * software without specific prior written permission.
18 : *
19 : * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 : * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 : * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 : * ARE DISCLAIMED. IN NO EVENT SHALL THE CALIFORNIA INSTITUTE OF TECHNOLOGY BE
23 : * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 : * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 : * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 : * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 : * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 : * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 : * POSSIBILITY OF SUCH DAMAGE.
30 : *
31 : * Portions copyright 2014-2021 Esri
32 : *
33 : * Licensed under the Apache License, Version 2.0 (the "License");
34 : * you may not use this file except in compliance with the License.
35 : * You may obtain a copy of the License at
36 : *
37 : * http://www.apache.org/licenses/LICENSE-2.0
38 : *
39 : * Unless required by applicable law or agreed to in writing, software
40 : * distributed under the License is distributed on an "AS IS" BASIS,
41 : * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
42 : * See the License for the specific language governing permissions and
43 : * limitations under the License.
44 : */
45 :
46 : /******************************************************************************
47 : *
48 : * Project: Meta Raster File Format Driver Implementation, Dataset
49 : * Purpose: Implementation of GDAL dataset
50 : *
51 : * Author: Lucian Plesea, Lucian.Plesea jpl.nasa.gov, lplesea esri.com
52 : *
53 : ******************************************************************************
54 : *
55 : * The MRF dataset and the band are closely tied together, they should be
56 : * considered a single class, or a class (dataset) with extensions (bands).
57 : *
58 : *
59 : ****************************************************************************/
60 :
61 : #include "marfa.h"
62 : #include "mrfdrivercore.h"
63 : #include "cpl_multiproc.h" /* for CPLSleep() */
64 : #include "gdal_priv.h"
65 : #include <assert.h>
66 :
67 : #include <algorithm>
68 : #include <limits>
69 : #include <vector>
70 : #if defined(ZSTD_SUPPORT)
71 : #include <zstd.h>
72 : #endif
73 : using std::string;
74 : using std::vector;
75 :
76 : NAMESPACE_MRF_START
77 :
78 : // Initialize as invalid
79 371 : MRFDataset::MRFDataset()
80 : : zslice(0), idxSize(0), clonedSource(FALSE), nocopy(FALSE),
81 : bypass_cache(
82 371 : CPLTestBool(CPLGetConfigOption("MRF_BYPASSCACHING", "FALSE"))),
83 : mp_safe(FALSE), hasVersions(FALSE), verCount(0),
84 : bCrystalized(TRUE), // Assume not in create mode
85 : spacing(0), no_errors(0), missing(0), poSrcDS(nullptr), level(-1),
86 : cds(nullptr), scale(0.0), pbuffer(nullptr), pbsize(0), tile(ILSize()),
87 : bdirty(0), bGeoTransformValid(TRUE), poColorTable(nullptr), Quality(0),
88 742 : pzscctx(nullptr), pzsdctx(nullptr), read_timer(), write_timer(0)
89 : {
90 371 : m_oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
91 371 : ifp.FP = dfp.FP = nullptr;
92 371 : dfp.acc = GF_Read;
93 371 : ifp.acc = GF_Read;
94 371 : }
95 :
96 181 : bool MRFDataset::SetPBuffer(unsigned int sz)
97 : {
98 181 : if (sz == 0)
99 : {
100 0 : CPLFree(pbuffer);
101 0 : pbuffer = nullptr;
102 : }
103 181 : void *pbufferNew = VSIRealloc(pbuffer, sz);
104 181 : if (pbufferNew == nullptr)
105 : {
106 0 : CPLError(CE_Failure, CPLE_OutOfMemory, "Cannot allocate %u bytes", sz);
107 0 : return false;
108 : }
109 181 : pbuffer = pbufferNew;
110 181 : pbsize = sz;
111 181 : return true;
112 : }
113 :
114 256 : static GDALColorEntry GetXMLColorEntry(CPLXMLNode *p)
115 : {
116 : GDALColorEntry ce;
117 256 : ce.c1 = static_cast<short>(getXMLNum(p, "c1", 0));
118 256 : ce.c2 = static_cast<short>(getXMLNum(p, "c2", 0));
119 256 : ce.c3 = static_cast<short>(getXMLNum(p, "c3", 0));
120 256 : ce.c4 = static_cast<short>(getXMLNum(p, "c4", 255));
121 256 : return ce;
122 : }
123 :
124 : //
125 : // Called by dataset destructor or at GDAL termination, to avoid
126 : // closing datasets whose drivers have already been unloaded
127 : //
128 371 : int MRFDataset::CloseDependentDatasets()
129 : {
130 371 : int bHasDroppedRef = GDALPamDataset::CloseDependentDatasets();
131 :
132 371 : if (poSrcDS)
133 : {
134 3 : bHasDroppedRef = TRUE;
135 3 : GDALClose(GDALDataset::ToHandle(poSrcDS));
136 3 : poSrcDS = nullptr;
137 : }
138 :
139 371 : if (cds)
140 : {
141 2 : bHasDroppedRef = TRUE;
142 2 : GDALClose(GDALDataset::ToHandle(cds));
143 2 : cds = nullptr;
144 : }
145 :
146 371 : return bHasDroppedRef;
147 : }
148 :
149 742 : MRFDataset::~MRFDataset()
150 : { // Make sure everything gets written
151 371 : if (eAccess != GA_ReadOnly && !bCrystalized)
152 50 : if (!MRFDataset::Crystalize())
153 : {
154 : // Can't return error code from a destructor, just emit the error
155 10 : CPLError(CE_Failure, CPLE_FileIO, "Error creating files");
156 : }
157 :
158 371 : MRFDataset::FlushCache(true);
159 371 : MRFDataset::CloseDependentDatasets();
160 :
161 371 : if (ifp.FP)
162 263 : VSIFCloseL(ifp.FP);
163 371 : if (dfp.FP)
164 266 : VSIFCloseL(dfp.FP);
165 :
166 371 : delete poColorTable;
167 :
168 : // CPLFree ignores being called with NULL
169 371 : CPLFree(pbuffer);
170 371 : pbsize = 0;
171 : #if defined(ZSTD_SUPPORT)
172 371 : ZSTD_freeCCtx(static_cast<ZSTD_CCtx *>(pzscctx));
173 371 : ZSTD_freeDCtx(static_cast<ZSTD_DCtx *>(pzsdctx));
174 : #endif
175 : // total time spend doing compression and decompression
176 371 : if (0 != write_timer.count())
177 112 : CPLDebug("MRF_Timing", "Compression took %fms",
178 112 : 1e-6 * write_timer.count());
179 :
180 371 : if (0 != read_timer.count())
181 142 : CPLDebug("MRF_Timing", "Decompression took %fms",
182 142 : 1e-6 * read_timer.count());
183 742 : }
184 :
185 : /*
186 : *\brief Format specific RasterIO, may be bypassed by BlockBasedRasterIO by
187 : *setting GDAL_FORCE_CACHING to Yes, in which case the band ReadBlock and
188 : *WriteBLock are called directly
189 : */
190 140 : CPLErr MRFDataset::IRasterIO(GDALRWFlag eRWFlag, int nXOff, int nYOff,
191 : int nXSize, int nYSize, void *pData, int nBufXSize,
192 : int nBufYSize, GDALDataType eBufType,
193 : int nBandCount, BANDMAP_TYPE panBandMap,
194 : GSpacing nPixelSpace, GSpacing nLineSpace,
195 : GSpacing nBandSpace,
196 : GDALRasterIOExtraArg *psExtraArgs)
197 : {
198 140 : CPLDebug("MRF_IO",
199 : "IRasterIO %s, %d, %d, %d, %d, bufsz %d,%d,%d strides P %d, L %d, "
200 : "B %d \n",
201 : eRWFlag == GF_Write ? "Write" : "Read", nXOff, nYOff, nXSize,
202 : nYSize, nBufXSize, nBufYSize, nBandCount,
203 : static_cast<int>(nPixelSpace), static_cast<int>(nLineSpace),
204 : static_cast<int>(nBandSpace));
205 :
206 140 : if (eRWFlag == GF_Write && !bCrystalized && !Crystalize())
207 : {
208 0 : CPLError(CE_Failure, CPLE_FileIO, "MRF: Error creating files");
209 0 : return CE_Failure;
210 : }
211 :
212 : //
213 : // Call the parent implementation, which splits it into bands and calls
214 : // their IRasterIO
215 : //
216 140 : return GDALPamDataset::IRasterIO(eRWFlag, nXOff, nYOff, nXSize, nYSize,
217 : pData, nBufXSize, nBufYSize, eBufType,
218 : nBandCount, panBandMap, nPixelSpace,
219 140 : nLineSpace, nBandSpace, psExtraArgs);
220 : }
221 :
222 : /**
223 : *\brief Build some overviews
224 : *
225 : * if nOverviews is 0, erase the overviews (reduce to base image only)
226 : */
227 :
228 31 : CPLErr MRFDataset::IBuildOverviews(const char *pszResampling, int nOverviews,
229 : const int *panOverviewList, int nBandsIn,
230 : const int *panBandList,
231 : GDALProgressFunc pfnProgress,
232 : void *pProgressData,
233 : CSLConstList papszOptions)
234 :
235 : {
236 31 : if (pfnProgress == nullptr)
237 0 : pfnProgress = GDALDummyProgress;
238 :
239 31 : CPLErr eErr = CE_None;
240 31 : CPLDebug("MRF_OVERLAY", "IBuildOverviews %d, bands %d\n", nOverviews,
241 : nBandsIn);
242 :
243 31 : if (nBands != nBandsIn)
244 : {
245 0 : CPLError(CE_Failure, CPLE_NotSupported, "nBands = %d not supported",
246 : nBandsIn);
247 0 : return CE_Failure;
248 : }
249 :
250 : // If we don't have write access, then create external overviews
251 31 : if (GetAccess() != GA_Update)
252 : {
253 1 : CPLDebug("MRF", "File open read-only, creating overviews externally.");
254 1 : return GDALDataset::IBuildOverviews(
255 : pszResampling, nOverviews, panOverviewList, nBands, panBandList,
256 1 : pfnProgress, pProgressData, papszOptions);
257 : }
258 :
259 30 : if (nOverviews == 0)
260 : {
261 : // If there are none, nothing to do
262 0 : if (GetRasterBand(1)->GetOverviewCount() == 0)
263 0 : return CE_None;
264 :
265 0 : auto *b = static_cast<MRFRasterBand *>(GetRasterBand(1));
266 : // If the first band internal overviews don't exist, they are external
267 0 : if (b->overviews.empty())
268 0 : return GDALDataset::IBuildOverviews(
269 : pszResampling, nOverviews, panOverviewList, nBands, panBandList,
270 0 : pfnProgress, pProgressData, papszOptions);
271 :
272 : // We should clean overviews, but this is not allowed in an MRF
273 0 : CPLError(CE_Warning, CPLE_NotSupported,
274 : "MRF: Internal overviews cannot be removed, "
275 : "but they can be rebuilt");
276 0 : return CE_None;
277 : }
278 :
279 30 : std::vector<int> panOverviewListNew(nOverviews);
280 61 : for (int i = 0; i < nOverviews; i++)
281 31 : panOverviewListNew[i] = panOverviewList[i];
282 : try
283 : { // Throw an error code, to make sure memory gets freed properly
284 : // Modify the metadata file if it doesn't already have the Rset model
285 : // set
286 30 : if (0.0 == scale)
287 : {
288 30 : CPLXMLNode *config = ReadConfig();
289 : try
290 : {
291 : const char *model =
292 30 : CPLGetXMLValue(config, "Rsets.model", "uniform");
293 30 : if (!EQUAL(model, "uniform"))
294 : {
295 0 : CPLError(CE_Failure, CPLE_AppDefined,
296 : "MRF:IBuildOverviews, Overviews not implemented "
297 : "for model %s",
298 : model);
299 0 : throw CE_Failure;
300 : }
301 :
302 : // The scale value is the same as first overview
303 30 : scale =
304 30 : strtod(CPLGetXMLValue(
305 : config, "Rsets.scale",
306 60 : CPLOPrintf("%d", panOverviewList[0]).c_str()),
307 : nullptr);
308 30 : if (scale == 0.0)
309 : {
310 0 : CPLError(CE_Failure, CPLE_IllegalArg,
311 : "Invalid Rsets.scale value");
312 0 : throw CE_Failure;
313 : }
314 :
315 30 : if (static_cast<int>(scale) != 2 &&
316 0 : (EQUALN("Avg", pszResampling, 3) ||
317 0 : EQUALN("Nnb", pszResampling, 3)))
318 : {
319 0 : CPLError(CE_Failure, CPLE_IllegalArg,
320 : "MRF internal resampling requires a scale factor "
321 : "of two");
322 0 : throw CE_Failure;
323 : }
324 :
325 : // Initialize the empty overlays, all of them for a given scale
326 : // They could already exist, in which case they are not erased
327 30 : idxSize = AddOverviews(int(scale));
328 :
329 : // If we don't have overviews, don't try to generate them
330 30 : if (GetRasterBand(1)->GetOverviewCount() == 0)
331 0 : throw CE_None;
332 :
333 30 : if (!CheckFileSize(current.idxfname, idxSize, GA_Update))
334 : {
335 0 : CPLError(CE_Failure, CPLE_AppDefined,
336 : "MRF: Can't extend index file");
337 0 : throw CE_Failure;
338 : }
339 :
340 : // Set the uniform node, in case it was not set before, and
341 : // save the new configuration
342 30 : CPLSetXMLValue(config, "Rsets.#model", "uniform");
343 30 : CPLSetXMLValue(config, "Rsets.#scale", PrintDouble(scale));
344 :
345 30 : if (!WriteConfig(config))
346 : {
347 0 : CPLError(CE_Failure, CPLE_AppDefined,
348 : "MRF: Can't rewrite the metadata file");
349 0 : throw CE_Failure;
350 : }
351 30 : CPLDestroyXMLNode(config);
352 30 : config = nullptr;
353 : }
354 0 : catch (const CPLErr &)
355 : {
356 0 : CPLDestroyXMLNode(config);
357 0 : throw; // Rethrow
358 : }
359 :
360 : // To avoid issues with blacks overviews, generate all of them
361 : // if the user asked for a couple of overviews in the correct
362 : // sequence and starting with the lowest one
363 90 : if (!EQUAL(pszResampling, "NONE") &&
364 32 : nOverviews != GetRasterBand(1)->GetOverviewCount() &&
365 2 : CPLTestBool(
366 : CPLGetConfigOption("MRF_ALL_OVERVIEW_LEVELS", "YES")))
367 : {
368 2 : bool bIncreasingPowers =
369 2 : (panOverviewList[0] == static_cast<int>(scale));
370 3 : for (int i = 1; i < nOverviews; i++)
371 1 : bIncreasingPowers =
372 2 : bIncreasingPowers &&
373 1 : (panOverviewList[i] ==
374 1 : static_cast<int>(scale * panOverviewList[i - 1]));
375 :
376 2 : int ovrcount = GetRasterBand(1)->GetOverviewCount();
377 2 : if (bIncreasingPowers && nOverviews != ovrcount)
378 : {
379 2 : CPLDebug("MRF",
380 : "Generating %d levels instead of the %d requested",
381 : ovrcount, nOverviews);
382 2 : nOverviews = ovrcount;
383 2 : panOverviewListNew.resize(ovrcount);
384 7 : for (int i = 0; i < ovrcount; i++)
385 5 : panOverviewListNew[i] = int(std::pow(scale, i + 1));
386 : }
387 : }
388 : }
389 :
390 30 : if (static_cast<int>(scale) != 2 && (EQUALN("Avg", pszResampling, 3) ||
391 0 : EQUALN("Nnb", pszResampling, 3)))
392 : {
393 0 : CPLError(CE_Failure, CPLE_IllegalArg,
394 : "MRF internal resampling requires a scale factor of two");
395 0 : throw CE_Failure;
396 : }
397 :
398 : // First pass, count the pixels to be processed, mark invalid levels
399 : // Smallest positive value to avoid Coverity Scan complaining about
400 : // division by zero
401 30 : double dfTotalPixels = std::numeric_limits<double>::min();
402 30 : double dfPixels = double(nRasterXSize) * nRasterYSize;
403 63 : for (int i = 0; i < nOverviews; i++)
404 : {
405 : // Verify that scales are reasonable, val/scale has to be an integer
406 33 : if (!IsPower(panOverviewListNew[i], scale))
407 : {
408 0 : CPLError(CE_Warning, CPLE_AppDefined,
409 : "MRF:IBuildOverviews, skipping overview factor %d,"
410 : " it is not a power of %f",
411 0 : panOverviewListNew[i], scale);
412 0 : panOverviewListNew[i] = -1;
413 0 : continue;
414 : };
415 :
416 33 : int srclevel = int(logbase(panOverviewListNew[i], scale) - 0.5);
417 33 : MRFRasterBand *b = static_cast<MRFRasterBand *>(GetRasterBand(1));
418 :
419 : // Warn for requests for invalid levels
420 33 : if (srclevel >= b->GetOverviewCount())
421 : {
422 0 : CPLError(CE_Warning, CPLE_AppDefined,
423 : "MRF:IBuildOverviews, overview factor %d is not valid "
424 : "for this dataset",
425 0 : panOverviewListNew[i]);
426 0 : panOverviewListNew[i] = -1;
427 0 : continue;
428 : }
429 33 : dfTotalPixels += dfPixels * std::pow(scale, -srclevel);
430 : }
431 :
432 30 : dfPixels = 0;
433 63 : for (int i = 0; i < nOverviews; i++)
434 : {
435 : // Skip the invalid levels
436 33 : if (panOverviewListNew[i] < 0)
437 0 : continue;
438 :
439 33 : int srclevel = int(logbase(panOverviewListNew[i], scale) - 0.5);
440 : auto dfLevelPixels =
441 33 : std::pow(scale, -srclevel) * nRasterXSize * nRasterYSize;
442 : // Use "avg" flag to trigger the internal average sampling
443 33 : if (EQUALN("Avg", pszResampling, 3) ||
444 19 : EQUALN("Nnb", pszResampling, 3))
445 : {
446 26 : int sampling = EQUALN("Avg", pszResampling, 3) ? SAMPLING_Avg
447 : : SAMPLING_Near;
448 26 : auto b = static_cast<MRFRasterBand *>(GetRasterBand(1));
449 : // Internal, using PatchOverview
450 26 : if (srclevel > 0)
451 : b = static_cast<MRFRasterBand *>(
452 3 : b->GetOverview(srclevel - 1));
453 :
454 : eErr =
455 26 : PatchOverview(0, 0, b->nBlocksPerRow, b->nBlocksPerColumn,
456 : srclevel, 0, sampling);
457 26 : if (eErr == CE_Failure)
458 26 : throw eErr;
459 : }
460 : else
461 : {
462 : // Use the GDAL method
463 14 : std::vector<GDALRasterBand *> apoSrcBandList(nBands);
464 : std::vector<std::vector<GDALRasterBand *>> aapoOverviewBandList(
465 14 : nBands);
466 14 : for (int iBand = 0; iBand < nBands; iBand++)
467 : {
468 : // This is the base level
469 7 : apoSrcBandList[iBand] = GetRasterBand(panBandList[iBand]);
470 : // Set up the destination
471 14 : aapoOverviewBandList[iBand] = std::vector<GDALRasterBand *>{
472 14 : apoSrcBandList[iBand]->GetOverview(srclevel)};
473 : // Use the previous level as the source
474 7 : if (srclevel > 0)
475 0 : apoSrcBandList[iBand] =
476 0 : apoSrcBandList[iBand]->GetOverview(srclevel - 1);
477 : }
478 :
479 14 : auto pScaledProgress = GDALCreateScaledProgress(
480 : dfPixels / dfTotalPixels,
481 7 : (dfPixels + dfLevelPixels) / dfTotalPixels, pfnProgress,
482 : pProgressData);
483 7 : eErr = GDALRegenerateOverviewsMultiBand(
484 : apoSrcBandList, aapoOverviewBandList, pszResampling,
485 : GDALScaledProgress, pScaledProgress, papszOptions);
486 7 : GDALDestroyScaledProgress(pScaledProgress);
487 : }
488 33 : dfPixels += dfLevelPixels;
489 33 : pfnProgress(dfPixels / dfTotalPixels, "", pProgressData);
490 33 : if (eErr == CE_Failure)
491 0 : throw eErr;
492 : }
493 :
494 30 : pfnProgress(1.0, "", pProgressData);
495 : }
496 0 : catch (const CPLErr &e)
497 : {
498 0 : eErr = e;
499 : }
500 :
501 30 : return eErr;
502 : }
503 :
504 : /*
505 : *\brief blank separated list to vector of doubles
506 : */
507 34 : static void list2vec(std::vector<double> &v, const char *pszList)
508 : {
509 34 : if ((pszList == nullptr) || (pszList[0] == 0))
510 0 : return;
511 34 : char **papszTokens = CSLTokenizeString2(
512 : pszList, " \t\n\r", CSLT_STRIPLEADSPACES | CSLT_STRIPENDSPACES);
513 34 : v.clear();
514 69 : for (int i = 0; i < CSLCount(papszTokens); i++)
515 35 : v.push_back(CPLStrtod(papszTokens[i], nullptr));
516 34 : CSLDestroy(papszTokens);
517 : }
518 :
519 20 : void MRFDataset::SetNoDataValue(const char *pszVal)
520 : {
521 20 : list2vec(vNoData, pszVal);
522 20 : }
523 :
524 7 : void MRFDataset::SetMinValue(const char *pszVal)
525 : {
526 7 : list2vec(vMin, pszVal);
527 7 : }
528 :
529 7 : void MRFDataset::SetMaxValue(const char *pszVal)
530 : {
531 7 : list2vec(vMax, pszVal);
532 7 : }
533 :
534 : /**
535 : *
536 : *\brief Read the XML config tree, from file
537 : * Caller is responsible for freeing the memory
538 : *
539 : * @return NULL on failure, or the document tree on success.
540 : *
541 : */
542 30 : CPLXMLNode *MRFDataset::ReadConfig() const
543 : {
544 30 : if (fname[0] == '<')
545 0 : return CPLParseXMLString(fname);
546 30 : return CPLParseXMLFile(fname);
547 : }
548 :
549 : /**
550 : *\brief Write the XML config tree
551 : * Caller is responsible for correctness of data
552 : * and for freeing the memory
553 : *
554 : * @param config The document tree to write
555 : * @return TRUE on success, FALSE otherwise
556 : */
557 202 : int MRFDataset::WriteConfig(CPLXMLNode *config)
558 : {
559 202 : if (fname[0] == '<')
560 0 : return FALSE;
561 202 : return CPLSerializeXMLTreeToFile(config, fname);
562 : }
563 :
564 : static void
565 5 : stringSplit(vector<string> &theStringVector, // Altered/returned value
566 : const string &theString, size_t start = 0,
567 : const char theDelimiter = ' ')
568 : {
569 : while (true)
570 : {
571 5 : size_t end = theString.find(theDelimiter, start);
572 5 : if (string::npos == end)
573 : {
574 5 : theStringVector.push_back(theString.substr(start));
575 5 : return;
576 : }
577 0 : theStringVector.push_back(theString.substr(start, end - start));
578 0 : start = end + 1;
579 0 : }
580 : }
581 :
582 : // Returns the number following the prefix if it exists in one of the vector
583 : // strings Otherwise it returns the default
584 15 : static int getnum(const vector<string> &theStringVector, const char prefix,
585 : int def)
586 : {
587 25 : for (unsigned int i = 0; i < theStringVector.size(); i++)
588 15 : if (theStringVector[i][0] == prefix)
589 5 : return atoi(theStringVector[i].c_str() + 1);
590 10 : return def;
591 : }
592 :
593 : /**
594 : *\brief Open a MRF file
595 : *
596 : */
597 204 : GDALDataset *MRFDataset::Open(GDALOpenInfo *poOpenInfo)
598 : {
599 204 : if (!MRFDriverIdentify(poOpenInfo))
600 0 : return nullptr;
601 :
602 204 : CPLXMLNode *config = nullptr;
603 204 : CPLErr ret = CE_None;
604 204 : const char *pszFileName = poOpenInfo->pszFilename;
605 :
606 204 : int level = -1; // All levels
607 204 : int version = 0; // Current
608 204 : int zslice = 0;
609 408 : string fn; // Used to parse and adjust the file name
610 408 : string insidefn; // inside tar file name
611 :
612 : // Different ways to open an MRF
613 204 : if (poOpenInfo->nHeaderBytes >= 10)
614 : {
615 199 : const char *pszHeader =
616 : reinterpret_cast<char *>(poOpenInfo->pabyHeader);
617 199 : fn.assign(pszHeader, poOpenInfo->nHeaderBytes);
618 199 : if (STARTS_WITH(pszHeader, "<MRF_META>")) // Regular file name
619 192 : config = CPLParseXMLFile(pszFileName);
620 7 : else if (poOpenInfo->eAccess == GA_ReadOnly && fn.size() > 600 &&
621 7 : (fn[262] == 0 || fn[262] == 32) &&
622 1 : STARTS_WITH(fn.c_str() + 257, "ustar") &&
623 15 : strlen(CPLGetPathSafe(fn.c_str()).c_str()) == 0 &&
624 1 : STARTS_WITH(fn.c_str() + 512, "<MRF_META>"))
625 : { // An MRF inside a tar
626 1 : insidefn = string("/vsitar/") + pszFileName + "/" + pszHeader;
627 1 : config = CPLParseXMLFile(insidefn.c_str());
628 : }
629 : #if defined(LERC)
630 : else
631 6 : config = LERC_Band::GetMRFConfig(poOpenInfo);
632 : #endif
633 : }
634 : else
635 : {
636 5 : if (EQUALN(pszFileName, "<MRF_META>", 10)) // Content as file name
637 0 : config = CPLParseXMLString(pszFileName);
638 : else
639 : { // Try Ornate file name
640 5 : fn = pszFileName;
641 5 : size_t pos = fn.find(":MRF:");
642 5 : if (string::npos != pos)
643 : { // Tokenize and pick known options
644 5 : vector<string> tokens;
645 5 : stringSplit(tokens, fn, pos + 5, ':');
646 5 : level = getnum(tokens, 'L', -1);
647 5 : version = getnum(tokens, 'V', 0);
648 5 : zslice = getnum(tokens, 'Z', 0);
649 5 : fn.resize(pos); // Cut the ornamentations
650 5 : pszFileName = fn.c_str();
651 5 : config = CPLParseXMLFile(pszFileName);
652 : }
653 : }
654 : }
655 :
656 204 : if (!config)
657 0 : return nullptr;
658 :
659 204 : MRFDataset *ds = new MRFDataset();
660 204 : ds->fname = pszFileName;
661 204 : if (!insidefn.empty())
662 : {
663 1 : ds->publicname = pszFileName;
664 1 : ds->fname = insidefn;
665 : }
666 204 : ds->eAccess = poOpenInfo->eAccess;
667 204 : ds->level = level;
668 204 : ds->zslice = zslice;
669 :
670 : // OpenOptions can override file name arguments
671 204 : ds->ProcessOpenOptions(poOpenInfo->papszOpenOptions);
672 :
673 204 : if (level == -1)
674 202 : ret = ds->Initialize(config);
675 : else
676 : {
677 : // Open the whole dataset, then pick one level
678 2 : ds->cds = new MRFDataset();
679 2 : ds->cds->fname = ds->fname;
680 2 : ds->cds->eAccess = ds->eAccess;
681 2 : ds->zslice = zslice;
682 2 : ret = ds->cds->Initialize(config);
683 2 : if (ret == CE_None)
684 2 : ret = ds->LevelInit(level);
685 : }
686 204 : CPLDestroyXMLNode(config);
687 :
688 204 : if (ret != CE_None)
689 : {
690 23 : delete ds;
691 23 : return nullptr;
692 : }
693 :
694 : // Open a single version
695 181 : if (version != 0)
696 2 : ret = ds->SetVersion(version);
697 :
698 181 : if (ret != CE_None)
699 : {
700 1 : delete ds;
701 1 : return nullptr;
702 : }
703 :
704 : // Tell PAM what our real file name is, to help it find the aux.xml
705 180 : ds->SetPhysicalFilename(ds->fname);
706 : // Don't mess with metadata after this, otherwise PAM will re-write the
707 : // aux.xml
708 180 : ds->TryLoadXML();
709 :
710 : /* -------------------------------------------------------------------- */
711 : /* Open external overviews. */
712 : /* -------------------------------------------------------------------- */
713 180 : ds->oOvManager.Initialize(ds, ds->fname);
714 :
715 180 : return ds;
716 : }
717 :
718 : // Adjust the band images with the right offset, then adjust the sizes
719 2 : CPLErr MRFDataset::SetVersion(int version)
720 : {
721 2 : if (!hasVersions || version > verCount)
722 : {
723 1 : CPLError(CE_Failure, CPLE_AppDefined,
724 : "GDAL MRF: Version number error!");
725 1 : return CE_Failure;
726 : }
727 : // Size of one version index
728 2 : for (int bcount = 1; bcount <= nBands; bcount++)
729 : {
730 : MRFRasterBand *srcband =
731 1 : reinterpret_cast<MRFRasterBand *>(GetRasterBand(bcount));
732 1 : srcband->img.idxoffset += idxSize * verCount;
733 1 : for (int l = 0; l < srcband->GetOverviewCount(); l++)
734 : {
735 : MRFRasterBand *band =
736 0 : reinterpret_cast<MRFRasterBand *>(srcband->GetOverview(l));
737 0 : if (band != nullptr)
738 0 : band->img.idxoffset += idxSize * verCount;
739 : }
740 : }
741 1 : hasVersions = 0;
742 1 : return CE_None;
743 : }
744 :
745 2 : CPLErr MRFDataset::LevelInit(const int l)
746 : {
747 : // Test that this level does exist
748 2 : if (l < 0 || l >= cds->GetRasterBand(1)->GetOverviewCount())
749 : {
750 1 : CPLError(CE_Failure, CPLE_AppDefined,
751 : "GDAL MRF: Overview not present!");
752 1 : return CE_Failure;
753 : }
754 :
755 : MRFRasterBand *srcband = reinterpret_cast<MRFRasterBand *>(
756 1 : cds->GetRasterBand(1)->GetOverview(l));
757 :
758 : // Copy the sizes from this level
759 1 : full = srcband->img;
760 1 : current = srcband->img;
761 1 : current.size.c = cds->current.size.c;
762 1 : scale = cds->scale;
763 1 : const auto poSRS = cds->GetSpatialRef();
764 1 : if (poSRS)
765 1 : m_oSRS = *poSRS;
766 :
767 1 : SetMetadataItem("INTERLEAVE", OrderName(current.order), "IMAGE_STRUCTURE");
768 1 : SetMetadataItem("COMPRESSION", CompName(current.comp), "IMAGE_STRUCTURE");
769 :
770 1 : bGeoTransformValid = (CE_None == cds->GetGeoTransform(m_gt));
771 4 : for (int i = 0; i < l + 1; i++)
772 : {
773 3 : m_gt[1] *= scale;
774 3 : m_gt[5] *= scale;
775 : }
776 :
777 1 : nRasterXSize = current.size.x;
778 1 : nRasterYSize = current.size.y;
779 1 : nBands = current.size.c;
780 :
781 : // Add the bands, copy constructor so they can be closed independently
782 2 : for (int i = 1; i <= nBands; i++)
783 1 : SetBand(i, new MRFLRasterBand(reinterpret_cast<MRFRasterBand *>(
784 1 : cds->GetRasterBand(i)->GetOverview(l))));
785 1 : return CE_None;
786 : }
787 :
788 : // Is the string positive or not
789 1279 : inline bool on(const char *pszValue)
790 : {
791 1279 : if (!pszValue || pszValue[0] == 0)
792 110 : return false;
793 2326 : return EQUAL(pszValue, "ON") || EQUAL(pszValue, "TRUE") ||
794 2326 : EQUAL(pszValue, "YES");
795 : }
796 :
797 : /**
798 : *\brief Initialize the image structure and the dataset from the XML Raster node
799 : *
800 : * @param image the structure to be initialized
801 : * @param ds the parent dataset, some things get inherited
802 : * @param defimage defimage
803 : *
804 : * The structure should be initialized with the default values as much as
805 : *possible
806 : *
807 : */
808 :
809 366 : static CPLErr Init_Raster(ILImage &image, MRFDataset *ds, CPLXMLNode *defimage)
810 : {
811 : CPLXMLNode *node; // temporary
812 366 : if (!defimage)
813 : {
814 0 : CPLError(CE_Failure, CPLE_AppDefined,
815 : "GDAL MRF: Can't find raster info");
816 0 : return CE_Failure;
817 : }
818 :
819 : // Size is mandatory
820 366 : node = CPLGetXMLNode(defimage, "Size");
821 :
822 366 : if (node)
823 : {
824 366 : image.size = ILSize(static_cast<int>(getXMLNum(node, "x", -1)),
825 366 : static_cast<int>(getXMLNum(node, "y", -1)),
826 366 : static_cast<int>(getXMLNum(node, "z", 1)),
827 366 : static_cast<int>(getXMLNum(node, "c", 1)), 0);
828 : }
829 :
830 : // Basic checks
831 366 : if (!node || image.size.x < 1 || image.size.y < 1 || image.size.z < 0 ||
832 732 : image.size.c < 0 || !GDALCheckBandCount(image.size.c, FALSE))
833 : {
834 0 : CPLError(CE_Failure, CPLE_AppDefined, "Raster size missing or invalid");
835 0 : return CE_Failure;
836 : }
837 :
838 : // Pagesize, defaults to 512,512,1,c
839 366 : image.pagesize = ILSize(std::min(512, image.size.x),
840 366 : std::min(512, image.size.y), 1, image.size.c);
841 :
842 366 : node = CPLGetXMLNode(defimage, "PageSize");
843 366 : if (node)
844 : {
845 366 : image.pagesize =
846 366 : ILSize(static_cast<int>(getXMLNum(node, "x", image.pagesize.x)),
847 366 : static_cast<int>(getXMLNum(node, "y", image.pagesize.y)),
848 : 1, // One slice at a time, forced
849 366 : static_cast<int>(getXMLNum(node, "c", image.pagesize.c)));
850 366 : if (image.pagesize.x < 1 || image.pagesize.y < 1 ||
851 366 : image.pagesize.c <= 0)
852 : {
853 0 : CPLError(CE_Failure, CPLE_IllegalArg, "Invalid PageSize");
854 0 : return CE_Failure;
855 : }
856 : }
857 :
858 : // Page Encoding, defaults to PNG
859 366 : const char *pszCompression = CPLGetXMLValue(defimage, "Compression", "PNG");
860 366 : image.comp = CompToken(pszCompression);
861 366 : if (image.comp == IL_ERR_COMP)
862 : {
863 0 : CPLError(CE_Failure, CPLE_IllegalArg,
864 : "GDAL MRF: Compression %s is unknown", pszCompression);
865 0 : return CE_Failure;
866 : }
867 :
868 : // Is there a palette?
869 : //
870 : // GDAL only supports RGB+A palette, the other modes don't work
871 : //
872 :
873 676 : if ((image.pagesize.c == 1) &&
874 310 : (nullptr != (node = CPLGetXMLNode(defimage, "Palette"))))
875 : {
876 1 : int entries = static_cast<int>(getXMLNum(node, "Size", 255));
877 1 : GDALPaletteInterp eInterp = GPI_RGB;
878 1 : if ((entries > 0) && (entries < 257))
879 : {
880 1 : GDALColorEntry ce_start = {0, 0, 0, 255}, ce_end = {0, 0, 0, 255};
881 :
882 : // Create it and initialize it to black opaque
883 1 : GDALColorTable *poColorTable = new GDALColorTable(eInterp);
884 1 : poColorTable->CreateColorRamp(0, &ce_start, entries - 1, &ce_end);
885 : // Read the values
886 1 : CPLXMLNode *p = CPLGetXMLNode(node, "Entry");
887 1 : if (p)
888 : {
889 : // Initialize the first entry
890 1 : ce_start = GetXMLColorEntry(p);
891 1 : int start_idx = static_cast<int>(getXMLNum(p, "idx", 0));
892 1 : if (start_idx < 0)
893 : {
894 0 : CPLError(CE_Failure, CPLE_IllegalArg,
895 : "GDAL MRF: Palette index %d not allowed",
896 : start_idx);
897 0 : delete poColorTable;
898 0 : return CE_Failure;
899 : }
900 1 : poColorTable->SetColorEntry(start_idx, &ce_start);
901 256 : while (nullptr != (p = SearchXMLSiblings(p, "Entry")))
902 : {
903 : // For every entry, create a ramp
904 255 : ce_end = GetXMLColorEntry(p);
905 : int end_idx =
906 255 : static_cast<int>(getXMLNum(p, "idx", start_idx + 1));
907 255 : if ((end_idx <= start_idx) || (start_idx >= entries))
908 : {
909 0 : CPLError(CE_Failure, CPLE_IllegalArg,
910 : "GDAL MRF: Index Error at index %d", end_idx);
911 0 : delete poColorTable;
912 0 : return CE_Failure;
913 : }
914 255 : poColorTable->CreateColorRamp(start_idx, &ce_start, end_idx,
915 : &ce_end);
916 255 : ce_start = ce_end;
917 255 : start_idx = end_idx;
918 : }
919 : }
920 :
921 1 : ds->SetColorTable(poColorTable);
922 : }
923 : else
924 : {
925 0 : CPLError(CE_Failure, CPLE_IllegalArg,
926 : "GDAL MRF: Palette definition error");
927 0 : return CE_Failure;
928 : }
929 : }
930 :
931 : // Order of increment
932 366 : if (image.pagesize.c != image.size.c && image.pagesize.c != 1)
933 : {
934 : // Fixes heap buffer overflow in
935 : // GDALMRFRasterBand::ReadInterleavedBlock() See
936 : // https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=2884
937 0 : CPLError(CE_Failure, CPLE_NotSupported,
938 : "GDAL MRF: image.pagesize.c = %d and image.size.c = %d",
939 : image.pagesize.c, image.size.c);
940 0 : return CE_Failure;
941 : }
942 :
943 366 : image.order = OrderToken(
944 : CPLGetXMLValue(defimage, "Order",
945 366 : (image.pagesize.c != image.size.c) ? "BAND" : "PIXEL"));
946 366 : if (image.order == IL_ERR_ORD)
947 : {
948 0 : CPLError(CE_Failure, CPLE_AppDefined, "GDAL MRF: Order %s is unknown",
949 : CPLGetXMLValue(defimage, "Order", nullptr));
950 0 : return CE_Failure;
951 : }
952 :
953 366 : const char *photo_val = CPLGetXMLValue(defimage, "Photometric", nullptr);
954 366 : if (photo_val)
955 5 : ds->SetPhotometricInterpretation(photo_val);
956 :
957 366 : image.quality = atoi(CPLGetXMLValue(defimage, "Quality", "85"));
958 366 : if (image.quality < 0 || image.quality > 99)
959 : {
960 0 : CPLError(CE_Warning, CPLE_AppDefined,
961 : "GDAL MRF: Quality setting error, using default of 85");
962 0 : image.quality = 85;
963 : }
964 :
965 : // Data Type, use GDAL Names
966 366 : image.dt = GDALGetDataTypeByName(
967 : CPLGetXMLValue(defimage, "DataType", GDALGetDataTypeName(image.dt)));
968 366 : if (image.dt == GDT_Unknown || GDALGetDataTypeSizeBytes(image.dt) == 0)
969 : {
970 0 : CPLError(CE_Failure, CPLE_AppDefined, "GDAL MRF: Unsupported type");
971 0 : return CE_Failure;
972 : }
973 :
974 : // Check the endianness if needed, assume host order
975 366 : if (is_Endianness_Dependent(image.dt, image.comp))
976 69 : image.nbo = on(CPLGetXMLValue(defimage, "NetByteOrder", "No"));
977 :
978 366 : CPLXMLNode *DataValues = CPLGetXMLNode(defimage, "DataValues");
979 366 : if (nullptr != DataValues)
980 : {
981 27 : const char *pszValue = CPLGetXMLValue(DataValues, "NoData", nullptr);
982 27 : if (pszValue)
983 20 : ds->SetNoDataValue(pszValue);
984 27 : pszValue = CPLGetXMLValue(DataValues, "min", nullptr);
985 27 : if (pszValue)
986 7 : ds->SetMinValue(pszValue);
987 27 : pszValue = CPLGetXMLValue(DataValues, "max", nullptr);
988 27 : if (pszValue)
989 7 : ds->SetMaxValue(pszValue);
990 : }
991 :
992 : // Calculate the page size in bytes
993 366 : const int nDTSize = GDALGetDataTypeSizeBytes(image.dt);
994 366 : if (nDTSize <= 0 || image.pagesize.z <= 0 ||
995 366 : image.pagesize.x > INT_MAX / image.pagesize.y ||
996 366 : image.pagesize.x * image.pagesize.y > INT_MAX / image.pagesize.z ||
997 366 : image.pagesize.x * image.pagesize.y * image.pagesize.z >
998 366 : INT_MAX / image.pagesize.c ||
999 366 : image.pagesize.x * image.pagesize.y * image.pagesize.z *
1000 366 : image.pagesize.c >
1001 366 : INT_MAX / nDTSize)
1002 : {
1003 0 : CPLError(CE_Failure, CPLE_AppDefined, "MRF page size too big");
1004 0 : return CE_Failure;
1005 : }
1006 366 : image.pageSizeBytes = nDTSize * image.pagesize.x * image.pagesize.y *
1007 366 : image.pagesize.z * image.pagesize.c;
1008 :
1009 : // Calculate the page count, including the total for the level
1010 366 : image.pagecount = pcount(image.size, image.pagesize);
1011 366 : if (image.pagecount.l < 0)
1012 : {
1013 0 : return CE_Failure;
1014 : }
1015 :
1016 : // Data File Name and base offset
1017 : image.datfname =
1018 366 : getFname(defimage, "DataFile", ds->GetFname(), ILComp_Ext[image.comp]);
1019 366 : image.dataoffset = static_cast<int>(
1020 366 : getXMLNum(CPLGetXMLNode(defimage, "DataFile"), "offset", 0.0));
1021 :
1022 : // Index File Name and base offset
1023 366 : image.idxfname = getFname(defimage, "IndexFile", ds->GetFname(), ".idx");
1024 366 : image.idxoffset = static_cast<int>(
1025 366 : getXMLNum(CPLGetXMLNode(defimage, "IndexFile"), "offset", 0.0));
1026 :
1027 366 : return CE_None;
1028 : }
1029 :
1030 162 : char **MRFDataset::GetFileList()
1031 : {
1032 162 : char **papszFileList = nullptr;
1033 :
1034 162 : string usename = fname;
1035 162 : if (!publicname.empty())
1036 0 : usename = publicname;
1037 : // Add the header file name if it is real
1038 : VSIStatBufL sStat;
1039 162 : if (VSIStatExL(usename.c_str(), &sStat, VSI_STAT_EXISTS_FLAG) == 0)
1040 162 : papszFileList = CSLAddString(papszFileList, usename.c_str());
1041 :
1042 : // These two should be real
1043 : // We don't really want to add these files, since they will be erased when
1044 : // an mrf is overwritten This collides with the concept that the data file
1045 : // never shrinks. Same goes with the index, in case we just want to add
1046 : // things to it.
1047 : // papszFileList = CSLAddString( papszFileList, full.datfname);
1048 : // papszFileList = CSLAddString( papszFileList, full.idxfname);
1049 : // if (!source.empty())
1050 : // papszFileList = CSLAddString( papszFileList, source);
1051 :
1052 324 : return papszFileList;
1053 : }
1054 :
1055 : // Try to create all the folders in the path in sequence, ignore errors
1056 4 : static void mkdir_r(string const &fname)
1057 : {
1058 4 : size_t loc = fname.find_first_of("\\/");
1059 4 : if (loc == string::npos)
1060 0 : return;
1061 : while (true)
1062 : {
1063 5 : ++loc;
1064 5 : loc = fname.find_first_of("\\/", loc);
1065 5 : if (loc == string::npos)
1066 4 : break;
1067 1 : VSIMkdir(fname.substr(0, loc).c_str(), 0);
1068 : }
1069 : }
1070 :
1071 : // Returns the dataset index file or null
1072 7268 : VSILFILE *MRFDataset::IdxFP()
1073 : {
1074 7268 : if (ifp.FP != nullptr)
1075 6999 : return ifp.FP;
1076 :
1077 : // If missing is set, we already checked, there is no index
1078 269 : if (missing)
1079 0 : return nullptr;
1080 :
1081 : // If name starts with '(' it is not a real file name
1082 269 : if (current.idxfname[0] == '(')
1083 0 : return nullptr;
1084 :
1085 269 : const char *mode = "rb";
1086 269 : ifp.acc = GF_Read;
1087 :
1088 269 : if (eAccess == GA_Update || !source.empty())
1089 : {
1090 159 : mode = "r+b";
1091 159 : ifp.acc = GF_Write;
1092 : }
1093 :
1094 269 : ifp.FP = VSIFOpenL(current.idxfname, mode);
1095 :
1096 : // If file didn't open for reading and no_errors is set, just return null
1097 : // and make a note
1098 269 : if (ifp.FP == nullptr && eAccess == GA_ReadOnly && no_errors)
1099 : {
1100 0 : missing = 1;
1101 0 : return nullptr;
1102 : }
1103 :
1104 : // need to create the index file
1105 369 : if (ifp.FP == nullptr && !bCrystalized &&
1106 100 : (eAccess == GA_Update || !source.empty()))
1107 : {
1108 100 : mode = "w+b";
1109 100 : ifp.FP = VSIFOpenL(current.idxfname, mode);
1110 : }
1111 :
1112 269 : if (nullptr == ifp.FP && !source.empty())
1113 : {
1114 : // caching and cloning, try making the folder and attempt again
1115 4 : mkdir_r(current.idxfname);
1116 4 : ifp.FP = VSIFOpenL(current.idxfname, mode);
1117 : }
1118 :
1119 269 : GIntBig expected_size = idxSize;
1120 269 : if (clonedSource)
1121 2 : expected_size *= 2;
1122 :
1123 269 : if (nullptr != ifp.FP)
1124 : {
1125 409 : if (!bCrystalized &&
1126 150 : !CheckFileSize(current.idxfname, expected_size, GA_Update))
1127 : {
1128 0 : CPLError(CE_Failure, CPLE_FileIO,
1129 : "MRF: Can't extend the cache index file %s",
1130 : current.idxfname.c_str());
1131 0 : return nullptr;
1132 : }
1133 :
1134 259 : if (source.empty())
1135 255 : return ifp.FP;
1136 :
1137 : // Make sure the index is large enough before proceeding
1138 : // Timeout in .1 seconds, can't really guarantee the accuracy
1139 : // So this is about half second, should be sufficient
1140 4 : int timeout = 5;
1141 0 : do
1142 : {
1143 4 : if (CheckFileSize(current.idxfname, expected_size, GA_ReadOnly))
1144 4 : return ifp.FP;
1145 0 : CPLSleep(0.100); /* 100 ms */
1146 0 : } while (--timeout);
1147 :
1148 : // If we get here it is a time-out
1149 0 : CPLError(CE_Failure, CPLE_AppDefined,
1150 : "GDAL MRF: Timeout on fetching cloned index file %s\n",
1151 : current.idxfname.c_str());
1152 0 : return nullptr;
1153 : }
1154 :
1155 : // If single tile, and no index file, let the caller figure it out
1156 10 : if (IsSingleTile())
1157 6 : return nullptr;
1158 :
1159 : // Error if this is not a caching MRF
1160 4 : if (source.empty())
1161 : {
1162 0 : CPLError(CE_Failure, CPLE_AppDefined,
1163 : "GDAL MRF: Can't open index file %s\n",
1164 : current.idxfname.c_str());
1165 0 : return nullptr;
1166 : }
1167 :
1168 : // Caching/Cloning MRF and index could be read only
1169 : // Is this actually works, we should try again, maybe somebody else just
1170 : // created the file?
1171 4 : mode = "rb";
1172 4 : ifp.acc = GF_Read;
1173 4 : ifp.FP = VSIFOpenL(current.idxfname, mode);
1174 4 : if (nullptr != ifp.FP)
1175 0 : return ifp.FP;
1176 :
1177 : // Caching and index file absent, create it
1178 : // Due to a race, multiple processes might do this at the same time, but
1179 : // that is fine
1180 4 : ifp.FP = VSIFOpenL(current.idxfname, "wb");
1181 4 : if (nullptr == ifp.FP)
1182 : {
1183 0 : CPLError(CE_Failure, CPLE_AppDefined,
1184 : "Can't create the MRF cache index file %s",
1185 : current.idxfname.c_str());
1186 0 : return nullptr;
1187 : }
1188 4 : VSIFCloseL(ifp.FP);
1189 4 : ifp.FP = nullptr;
1190 :
1191 : // Make it large enough for caching and for cloning
1192 4 : if (!CheckFileSize(current.idxfname, expected_size, GA_Update))
1193 : {
1194 0 : CPLError(CE_Failure, CPLE_AppDefined,
1195 : "Can't extend the cache index file %s",
1196 : current.idxfname.c_str());
1197 0 : return nullptr;
1198 : }
1199 :
1200 : // Try opening it again in rw mode so we can read and write
1201 4 : mode = "r+b";
1202 4 : ifp.acc = GF_Write;
1203 4 : ifp.FP = VSIFOpenL(current.idxfname.c_str(), mode);
1204 :
1205 4 : if (nullptr == ifp.FP)
1206 : {
1207 0 : CPLError(CE_Failure, CPLE_AppDefined,
1208 : "GDAL MRF: Can't reopen cache index file %s\n",
1209 : full.idxfname.c_str());
1210 0 : return nullptr;
1211 : }
1212 4 : return ifp.FP;
1213 : }
1214 :
1215 : //
1216 : // Returns the dataset data file or null
1217 : // Data file is opened either in Read or Append mode, never in straight write
1218 : //
1219 7143 : VSILFILE *MRFDataset::DataFP()
1220 : {
1221 7143 : if (dfp.FP != nullptr)
1222 6877 : return dfp.FP;
1223 266 : const char *mode = "rb";
1224 266 : dfp.acc = GF_Read;
1225 :
1226 : // Open it for writing if updating or if caching
1227 266 : if (eAccess == GA_Update || !source.empty())
1228 : {
1229 158 : mode = "a+b";
1230 158 : dfp.acc = GF_Write;
1231 : }
1232 :
1233 266 : dfp.FP = VSIFOpenL(current.datfname, mode);
1234 266 : if (dfp.FP)
1235 266 : return dfp.FP;
1236 :
1237 : // It could be a caching MRF
1238 0 : if (source.empty())
1239 0 : goto io_error;
1240 :
1241 : // May be there but read only, remember that it was open that way
1242 0 : mode = "rb";
1243 0 : dfp.acc = GF_Read;
1244 0 : dfp.FP = VSIFOpenL(current.datfname, mode);
1245 0 : if (nullptr != dfp.FP)
1246 : {
1247 0 : CPLDebug("MRF_IO", "Opened %s RO mode %s\n", current.datfname.c_str(),
1248 : mode);
1249 0 : return dfp.FP;
1250 : }
1251 :
1252 0 : if (source.empty())
1253 0 : goto io_error;
1254 :
1255 : // caching, maybe the folder didn't exist
1256 0 : mkdir_r(current.datfname);
1257 0 : mode = "a+b";
1258 0 : dfp.acc = GF_Write;
1259 0 : dfp.FP = VSIFOpenL(current.datfname, mode);
1260 0 : if (dfp.FP)
1261 0 : return dfp.FP;
1262 :
1263 0 : io_error:
1264 0 : dfp.FP = nullptr;
1265 0 : CPLError(CE_Failure, CPLE_FileIO, "GDAL MRF: %s : %s", strerror(errno),
1266 : current.datfname.c_str());
1267 0 : return nullptr;
1268 : }
1269 :
1270 : // Builds an XML tree from the current MRF. If written to a file it becomes an
1271 : // MRF
1272 334 : CPLXMLNode *MRFDataset::BuildConfig()
1273 : {
1274 334 : CPLXMLNode *config = CPLCreateXMLNode(nullptr, CXT_Element, "MRF_META");
1275 :
1276 334 : if (!source.empty())
1277 : {
1278 : CPLXMLNode *psCachedSource =
1279 4 : CPLCreateXMLNode(config, CXT_Element, "CachedSource");
1280 : // Should wrap the string in CDATA, in case it is XML
1281 : CPLXMLNode *psSource =
1282 4 : CPLCreateXMLElementAndValue(psCachedSource, "Source", source);
1283 4 : if (clonedSource)
1284 0 : CPLSetXMLValue(psSource, "#clone", "true");
1285 : }
1286 :
1287 : // Use the full size
1288 334 : CPLXMLNode *raster = CPLCreateXMLNode(config, CXT_Element, "Raster");
1289 :
1290 : // Preserve the file names if not the default ones
1291 334 : if (full.datfname != getFname(GetFname(), ILComp_Ext[full.comp]))
1292 0 : CPLCreateXMLElementAndValue(raster, "DataFile", full.datfname.c_str());
1293 334 : if (full.idxfname != getFname(GetFname(), ".idx"))
1294 0 : CPLCreateXMLElementAndValue(raster, "IndexFile", full.idxfname.c_str());
1295 334 : if (spacing != 0)
1296 0 : XMLSetAttributeVal(raster, "Spacing", static_cast<double>(spacing),
1297 : "%.0f");
1298 :
1299 334 : XMLSetAttributeVal(raster, "Size", full.size, "%.0f");
1300 334 : XMLSetAttributeVal(raster, "PageSize", full.pagesize, "%.0f");
1301 :
1302 : #ifdef HAVE_PNG
1303 334 : if (full.comp != IL_PNG)
1304 : #endif
1305 : {
1306 194 : CPLCreateXMLElementAndValue(raster, "Compression", CompName(full.comp));
1307 : }
1308 :
1309 334 : if (full.dt != GDT_Byte)
1310 202 : CPLCreateXMLElementAndValue(raster, "DataType",
1311 : GDALGetDataTypeName(full.dt));
1312 :
1313 : // special photometric interpretation
1314 334 : if (!photometric.empty())
1315 4 : CPLCreateXMLElementAndValue(raster, "Photometric", photometric);
1316 :
1317 334 : if (!vNoData.empty() || !vMin.empty() || !vMax.empty())
1318 : {
1319 : CPLXMLNode *values =
1320 43 : CPLCreateXMLNode(raster, CXT_Element, "DataValues");
1321 43 : XMLSetAttributeVal(values, "NoData", vNoData);
1322 43 : XMLSetAttributeVal(values, "min", vMin);
1323 43 : XMLSetAttributeVal(values, "max", vMax);
1324 : }
1325 :
1326 : // palette, if we have one
1327 334 : if (poColorTable != nullptr)
1328 : {
1329 1 : const char *pfrmt = "%.0f";
1330 1 : CPLXMLNode *pal = CPLCreateXMLNode(raster, CXT_Element, "Palette");
1331 1 : int sz = poColorTable->GetColorEntryCount();
1332 1 : if (sz != 256)
1333 0 : XMLSetAttributeVal(pal, "Size", poColorTable->GetColorEntryCount());
1334 : // RGB or RGBA for now
1335 257 : for (int i = 0; i < sz; i++)
1336 : {
1337 256 : CPLXMLNode *entry = CPLCreateXMLNode(pal, CXT_Element, "Entry");
1338 256 : const GDALColorEntry *ent = poColorTable->GetColorEntry(i);
1339 : // No need to set the index, it is always from 0 no size-1
1340 256 : XMLSetAttributeVal(entry, "c1", ent->c1, pfrmt);
1341 256 : XMLSetAttributeVal(entry, "c2", ent->c2, pfrmt);
1342 256 : XMLSetAttributeVal(entry, "c3", ent->c3, pfrmt);
1343 256 : if (ent->c4 != 255)
1344 0 : XMLSetAttributeVal(entry, "c4", ent->c4, pfrmt);
1345 : }
1346 : }
1347 :
1348 334 : if (is_Endianness_Dependent(full.dt, full.comp)) // Need to set the order
1349 62 : CPLCreateXMLElementAndValue(raster, "NetByteOrder",
1350 62 : (full.nbo || NET_ORDER) ? "TRUE" : "FALSE");
1351 :
1352 334 : if (full.quality > 0 && full.quality != 85)
1353 12 : CPLCreateXMLElementAndValue(raster, "Quality",
1354 24 : CPLOPrintf("%d", full.quality));
1355 :
1356 : // Done with the raster node
1357 :
1358 334 : if (scale != 0.0)
1359 : {
1360 0 : CPLCreateXMLNode(config, CXT_Element, "Rsets");
1361 0 : CPLSetXMLValue(config, "Rsets.#model", "uniform");
1362 0 : CPLSetXMLValue(config, "Rsets.#scale", PrintDouble(scale));
1363 : }
1364 334 : CPLXMLNode *gtags = CPLCreateXMLNode(config, CXT_Element, "GeoTags");
1365 :
1366 : // Do we have an affine transform different from identity?
1367 334 : GDALGeoTransform gt;
1368 668 : if ((MRFDataset::GetGeoTransform(gt) == CE_None) &&
1369 334 : (gt[0] != 0 || gt[1] != 1 || gt[2] != 0 || gt[3] != 0 || gt[4] != 0 ||
1370 197 : gt[5] != 1))
1371 : {
1372 137 : double minx = gt[0];
1373 137 : double maxx = gt[1] * full.size.x + minx;
1374 137 : double maxy = gt[3];
1375 137 : double miny = gt[5] * full.size.y + maxy;
1376 137 : CPLXMLNode *bbox = CPLCreateXMLNode(gtags, CXT_Element, "BoundingBox");
1377 137 : XMLSetAttributeVal(bbox, "minx", minx);
1378 137 : XMLSetAttributeVal(bbox, "miny", miny);
1379 137 : XMLSetAttributeVal(bbox, "maxx", maxx);
1380 137 : XMLSetAttributeVal(bbox, "maxy", maxy);
1381 : }
1382 :
1383 334 : const char *pszProj = GetProjectionRef();
1384 334 : if (pszProj && (!EQUAL(pszProj, "")))
1385 138 : CPLCreateXMLElementAndValue(gtags, "Projection", pszProj);
1386 :
1387 334 : if (optlist.Count() != 0)
1388 : {
1389 52 : CPLString options;
1390 54 : for (int i = 0; i < optlist.size(); i++)
1391 : {
1392 28 : options += optlist[i];
1393 28 : options += ' ';
1394 : }
1395 26 : options.pop_back();
1396 26 : CPLCreateXMLElementAndValue(config, "Options", options);
1397 : }
1398 :
1399 334 : return config;
1400 : }
1401 :
1402 : /**
1403 : * \brief Populates the dataset variables from the XML definition
1404 : *
1405 : *
1406 : */
1407 366 : CPLErr MRFDataset::Initialize(CPLXMLNode *config)
1408 : {
1409 : // We only need a basic initialization here, usually gets overwritten by the
1410 : // image params
1411 366 : full.dt = GDT_Byte;
1412 366 : full.hasNoData = false;
1413 366 : full.NoDataValue = 0;
1414 366 : Quality = 85;
1415 :
1416 366 : CPLErr ret = Init_Raster(full, this, CPLGetXMLNode(config, "Raster"));
1417 366 : if (CE_None != ret)
1418 0 : return ret;
1419 :
1420 366 : hasVersions = on(CPLGetXMLValue(config, "Raster.versioned", "no"));
1421 366 : mp_safe = on(CPLGetXMLValue(config, "Raster.mp_safe", "no"));
1422 366 : spacing = atoi(CPLGetXMLValue(config, "Raster.Spacing", "0"));
1423 :
1424 : // The zslice defined in the file wins over the oo or the file argument
1425 366 : if (CPLGetXMLNode(config, "Raster.zslice"))
1426 0 : zslice = atoi(CPLGetXMLValue(config, "Raster.zslice", "0"));
1427 :
1428 366 : Quality = full.quality;
1429 :
1430 : // Bounding box
1431 366 : CPLXMLNode *bbox = CPLGetXMLNode(config, "GeoTags.BoundingBox");
1432 366 : if (nullptr != bbox)
1433 : {
1434 : double x0, x1, y0, y1;
1435 :
1436 161 : x0 = atof(CPLGetXMLValue(bbox, "minx", "0"));
1437 161 : x1 = atof(CPLGetXMLValue(bbox, "maxx", "1"));
1438 161 : y1 = atof(CPLGetXMLValue(bbox, "maxy", "1"));
1439 161 : y0 = atof(CPLGetXMLValue(bbox, "miny", "0"));
1440 :
1441 161 : m_gt[0] = x0;
1442 161 : m_gt[1] = (x1 - x0) / full.size.x;
1443 161 : m_gt[2] = 0;
1444 161 : m_gt[3] = y1;
1445 161 : m_gt[4] = 0;
1446 161 : m_gt[5] = (y0 - y1) / full.size.y;
1447 161 : bGeoTransformValid = TRUE;
1448 : }
1449 :
1450 : const char *pszRawProjFromXML =
1451 366 : CPLGetXMLValue(config, "GeoTags.Projection", "");
1452 366 : if (strlen(pszRawProjFromXML) != 0)
1453 162 : m_oSRS.SetFromUserInput(
1454 : pszRawProjFromXML,
1455 : OGRSpatialReference::SET_FROM_USER_INPUT_LIMITATIONS_get());
1456 :
1457 : // Copy the full size to current, data and index are not yet open
1458 366 : current = full;
1459 366 : if (current.size.z != 1)
1460 : {
1461 0 : SetMetadataItem("ZSIZE", CPLOPrintf("%d", current.size.z),
1462 0 : "IMAGE_STRUCTURE");
1463 0 : SetMetadataItem("ZSLICE", CPLOPrintf("%d", zslice), "IMAGE_STRUCTURE");
1464 : // Capture the zslice in pagesize.l
1465 0 : current.pagesize.l = zslice;
1466 : // Adjust offset for base image
1467 0 : if (full.size.z <= 0)
1468 : {
1469 0 : CPLError(CE_Failure, CPLE_AppDefined,
1470 : "GDAL MRF: Invalid Raster.z value");
1471 0 : return CE_Failure;
1472 : }
1473 0 : if (zslice >= full.size.z)
1474 : {
1475 0 : CPLError(CE_Failure, CPLE_AppDefined, "GDAL MRF: Invalid slice");
1476 0 : return CE_Failure;
1477 : }
1478 :
1479 0 : current.idxoffset +=
1480 0 : (current.pagecount.l / full.size.z) * zslice * sizeof(ILIdx);
1481 : }
1482 :
1483 : // Dataset metadata setup
1484 366 : SetMetadataItem("INTERLEAVE", OrderName(current.order), "IMAGE_STRUCTURE");
1485 366 : SetMetadataItem("COMPRESSION", CompName(current.comp), "IMAGE_STRUCTURE");
1486 :
1487 366 : if (is_Endianness_Dependent(current.dt, current.comp))
1488 69 : SetMetadataItem("NETBYTEORDER", current.nbo ? "TRUE" : "FALSE",
1489 69 : "IMAGE_STRUCTURE");
1490 :
1491 : // Open the files for the current image, either RW or RO
1492 366 : nRasterXSize = current.size.x;
1493 366 : nRasterYSize = current.size.y;
1494 366 : nBands = current.size.c;
1495 :
1496 366 : if (!nBands || !nRasterXSize || !nRasterYSize)
1497 : {
1498 0 : CPLError(CE_Failure, CPLE_AppDefined, "GDAL MRF: Image size missing");
1499 0 : return CE_Failure;
1500 : }
1501 :
1502 : // Pick up the source data image, if there is one
1503 366 : source = CPLGetXMLValue(config, "CachedSource.Source", "");
1504 : // Is it a clone?
1505 366 : clonedSource =
1506 366 : on(CPLGetXMLValue(config, "CachedSource.Source.clone", "no"));
1507 : // Pick up the options, if any
1508 : optlist.Assign(CSLTokenizeString2(
1509 : CPLGetXMLValue(config, "Options", nullptr), " \t\n\r",
1510 366 : CSLT_STRIPLEADSPACES | CSLT_STRIPENDSPACES));
1511 :
1512 : // Load all the options in the IMAGE_STRUCTURE metadata
1513 397 : for (int i = 0; i < optlist.Count(); i++)
1514 : {
1515 62 : CPLString s(optlist[i]);
1516 31 : size_t nSepPos = s.find_first_of(":=");
1517 31 : if (std::string::npos != nSepPos)
1518 : {
1519 31 : s.resize(nSepPos);
1520 31 : SetMetadataItem(s, optlist.FetchNameValue(s), "IMAGE_STRUCTURE");
1521 : }
1522 : }
1523 :
1524 : // We have the options, so we can call rasterband
1525 798 : for (int i = 1; i <= nBands; i++)
1526 : {
1527 : // The overviews are low resolution copies of the current one.
1528 484 : MRFRasterBand *band = newMRFRasterBand(this, current, i);
1529 484 : if (!band)
1530 52 : return CE_Failure;
1531 :
1532 432 : GDALColorInterp ci = GCI_Undefined;
1533 :
1534 : // Default color interpretation
1535 432 : switch (nBands)
1536 : {
1537 264 : case 1:
1538 : case 2:
1539 264 : ci = (i == 1) ? GCI_GrayIndex : GCI_AlphaBand;
1540 264 : break;
1541 153 : case 3:
1542 : case 4:
1543 153 : if (i < 3)
1544 100 : ci = (i == 1) ? GCI_RedBand : GCI_GreenBand;
1545 : else
1546 53 : ci = (i == 3) ? GCI_BlueBand : GCI_AlphaBand;
1547 : }
1548 :
1549 432 : if (GetColorTable())
1550 1 : ci = GCI_PaletteIndex;
1551 :
1552 : // Legacy, deprecated
1553 432 : if (optlist.FetchBoolean("MULTISPECTRAL", FALSE))
1554 0 : ci = GCI_Undefined;
1555 :
1556 : // New style
1557 432 : if (!photometric.empty())
1558 : {
1559 15 : if ("MULTISPECTRAL" == photometric)
1560 0 : ci = GCI_Undefined;
1561 : }
1562 :
1563 432 : band->SetColorInterpretation(ci);
1564 432 : SetBand(i, band);
1565 : }
1566 :
1567 314 : CPLXMLNode *rsets = CPLGetXMLNode(config, "Rsets");
1568 314 : if (nullptr != rsets && nullptr != rsets->psChild)
1569 : {
1570 : // We have rsets
1571 :
1572 : // Regular spaced overlays, until everything fits in a single tile
1573 32 : if (EQUAL("uniform", CPLGetXMLValue(rsets, "model", "uniform")))
1574 : {
1575 32 : scale = getXMLNum(rsets, "scale", 2.0);
1576 32 : if (scale <= 1)
1577 : {
1578 0 : CPLError(CE_Failure, CPLE_AppDefined,
1579 : "MRF: zoom factor less than unit not allowed");
1580 0 : return CE_Failure;
1581 : }
1582 : // Looks like there are overlays
1583 32 : AddOverviews(int(scale));
1584 : }
1585 : else
1586 : {
1587 0 : CPLError(CE_Failure, CPLE_AppDefined, "Unknown Rset definition");
1588 0 : return CE_Failure;
1589 : }
1590 : }
1591 :
1592 314 : idxSize = IdxSize(full, int(scale));
1593 314 : if (idxSize == 0)
1594 0 : return CE_Failure;
1595 :
1596 : // If not set by the bands, get a pageSizeBytes buffer
1597 314 : if (GetPBufferSize() == 0 && !SetPBuffer(current.pageSizeBytes))
1598 0 : return CE_Failure;
1599 :
1600 314 : if (hasVersions)
1601 : { // It has versions, but how many?
1602 5 : verCount = 0; // Assume it only has one
1603 : VSIStatBufL statb;
1604 : // If the file exists, compute the last version number
1605 5 : if (0 == VSIStatL(full.idxfname, &statb))
1606 5 : verCount = int(statb.st_size / idxSize - 1);
1607 : }
1608 :
1609 314 : return CE_None;
1610 : }
1611 :
1612 0 : static inline bool has_path(const CPLString &name)
1613 : {
1614 0 : return name.find_first_of("/\\") != string::npos;
1615 : }
1616 :
1617 : // Does name look like an absolute gdal file name?
1618 4 : static inline bool is_absolute(const CPLString &name)
1619 : {
1620 4 : return (name.find_first_of("/\\") == 0) // Starts with root
1621 4 : || (name.size() > 1 && name[1] == ':' &&
1622 0 : isalpha(static_cast<unsigned char>(
1623 0 : name[0]))) // Starts with drive letter
1624 8 : || (name[0] == '<'); // Maybe it is XML
1625 : }
1626 :
1627 : // Add the dirname of path to the beginning of name, if it is relative
1628 : // returns true if name was modified
1629 4 : static inline bool make_absolute(CPLString &name, const CPLString &path)
1630 : {
1631 4 : if (!is_absolute(name) && (path.find_first_of("/\\") != string::npos))
1632 : {
1633 4 : name = path.substr(0, path.find_last_of("/\\") + 1) + name;
1634 4 : return true;
1635 : }
1636 0 : return false;
1637 : }
1638 :
1639 : /**
1640 : *\brief Get the source dataset, open it if necessary
1641 : */
1642 5 : GDALDataset *MRFDataset::GetSrcDS()
1643 : {
1644 5 : if (poSrcDS)
1645 1 : return poSrcDS;
1646 4 : if (source.empty())
1647 0 : return nullptr;
1648 :
1649 : // Stub out the error handler
1650 4 : CPLPushErrorHandler(CPLQuietErrorHandler);
1651 : // Try open the source dataset as is
1652 4 : poSrcDS =
1653 4 : GDALDataset::FromHandle(GDALOpenShared(source.c_str(), GA_ReadOnly));
1654 4 : CPLPopErrorHandler();
1655 :
1656 : // It the open fails, try again with the current dataset path prepended
1657 4 : if (!poSrcDS && make_absolute(source, fname))
1658 4 : poSrcDS = GDALDataset::FromHandle(
1659 : GDALOpenShared(source.c_str(), GA_ReadOnly));
1660 :
1661 4 : if (0 == source.find("<MRF_META>") && has_path(fname))
1662 : {
1663 : // MRF XML source, might need to patch the file names with the current
1664 : // one
1665 0 : MRFDataset *poMRFDS = dynamic_cast<MRFDataset *>(poSrcDS);
1666 0 : if (!poMRFDS)
1667 : {
1668 0 : delete poSrcDS;
1669 0 : poSrcDS = nullptr;
1670 0 : return nullptr;
1671 : }
1672 0 : make_absolute(poMRFDS->current.datfname, fname);
1673 0 : make_absolute(poMRFDS->current.idxfname, fname);
1674 : }
1675 4 : mp_safe = true; // Turn on MP safety
1676 4 : return poSrcDS;
1677 : }
1678 :
1679 : /**
1680 : *\brief Add or verify that all overlays exits
1681 : *
1682 : * @return size of the index file
1683 : */
1684 :
1685 62 : GIntBig MRFDataset::AddOverviews(int scaleIn)
1686 : {
1687 : // Fit the overlays
1688 62 : ILImage img = current;
1689 134 : while (1 != img.pagecount.x * img.pagecount.y)
1690 : {
1691 : // Adjust raster data for next level
1692 : // Adjust the offsets for indices left at this level
1693 72 : img.idxoffset += sizeof(ILIdx) * img.pagecount.l / img.size.z *
1694 72 : (img.size.z - zslice);
1695 :
1696 : // Next overview size
1697 72 : img.size.x = pcount(img.size.x, scaleIn);
1698 72 : img.size.y = pcount(img.size.y, scaleIn);
1699 72 : img.size.l++; // Increment the level
1700 72 : img.pagecount = pcount(img.size, img.pagesize);
1701 :
1702 : // And adjust the offset again, within next level
1703 72 : img.idxoffset += sizeof(ILIdx) * img.pagecount.l / img.size.z * zslice;
1704 72 : int l = static_cast<int>(img.size.l);
1705 : // Create and register the overviews for each band
1706 144 : for (int i = 1; i <= nBands; i++)
1707 : {
1708 : MRFRasterBand *b =
1709 72 : reinterpret_cast<MRFRasterBand *>(GetRasterBand(i));
1710 72 : if (!(b->GetOverview(l - 1)))
1711 72 : b->AddOverview(newMRFRasterBand(this, img, i, l));
1712 : }
1713 : }
1714 :
1715 : // Last adjustment, should be a single set of c and leftover z tiles
1716 62 : return img.idxoffset +
1717 124 : sizeof(ILIdx) * img.pagecount.l / img.size.z * (img.size.z - zslice);
1718 : }
1719 :
1720 : //
1721 : // set an entry if it doesn't already exist
1722 : //
1723 135 : static char **CSLAddIfMissing(char **papszList, const char *pszName,
1724 : const char *pszValue)
1725 : {
1726 135 : if (CSLFetchNameValue(papszList, pszName))
1727 14 : return papszList;
1728 121 : return CSLSetNameValue(papszList, pszName, pszValue);
1729 : }
1730 :
1731 : // CreateCopy implemented based on Create
1732 134 : GDALDataset *MRFDataset::CreateCopy(const char *pszFilename,
1733 : GDALDataset *poSrcDS, int /*bStrict*/,
1734 : char **papszOptions,
1735 : GDALProgressFunc pfnProgress,
1736 : void *pProgressData)
1737 : {
1738 268 : ILImage img;
1739 :
1740 134 : int x = poSrcDS->GetRasterXSize();
1741 134 : int y = poSrcDS->GetRasterYSize();
1742 134 : int nBands = poSrcDS->GetRasterCount();
1743 134 : if (nBands == 0)
1744 : {
1745 1 : CPLError(CE_Failure, CPLE_NotSupported, "nBands == 0 not supported");
1746 1 : return nullptr;
1747 : }
1748 133 : GDALRasterBand *poSrcBand1 = poSrcDS->GetRasterBand(1);
1749 :
1750 133 : GDALDataType dt = poSrcBand1->GetRasterDataType();
1751 : // Have our own options, to modify as we want
1752 133 : char **options = CSLDuplicate(papszOptions);
1753 :
1754 : const char *pszValue =
1755 133 : poSrcDS->GetMetadataItem("INTERLEAVE", "IMAGE_STRUCTURE");
1756 : options =
1757 133 : CSLAddIfMissing(options, "INTERLEAVE", pszValue ? pszValue : "PIXEL");
1758 : int xb, yb;
1759 133 : poSrcBand1->GetBlockSize(&xb, &yb);
1760 :
1761 : // Keep input block size if it exists and not explicitly set
1762 134 : if (CSLFetchNameValue(options, "BLOCKSIZE") == nullptr && xb != x &&
1763 1 : yb != y)
1764 : {
1765 1 : options = CSLAddIfMissing(options, "BLOCKXSIZE",
1766 2 : PrintDouble(xb, "%d").c_str());
1767 1 : options = CSLAddIfMissing(options, "BLOCKYSIZE",
1768 2 : PrintDouble(yb, "%d").c_str());
1769 : }
1770 :
1771 133 : MRFDataset *poDS = nullptr;
1772 : try
1773 : {
1774 : poDS = reinterpret_cast<MRFDataset *>(
1775 133 : Create(pszFilename, x, y, nBands, dt, options));
1776 :
1777 133 : if (poDS == nullptr || poDS->bCrystalized)
1778 11 : throw CPLOPrintf("MRF: Can't create %s", pszFilename);
1779 :
1780 122 : img = poDS->current; // Deal with the current one here
1781 :
1782 : // Copy data values from source
1783 284 : for (int i = 0; i < poDS->nBands; i++)
1784 : {
1785 : int bHas;
1786 : double dfData;
1787 162 : GDALRasterBand *srcBand = poSrcDS->GetRasterBand(i + 1);
1788 162 : GDALRasterBand *mBand = poDS->GetRasterBand(i + 1);
1789 162 : dfData = srcBand->GetNoDataValue(&bHas);
1790 162 : if (bHas)
1791 : {
1792 16 : poDS->vNoData.push_back(dfData);
1793 16 : mBand->SetNoDataValue(dfData);
1794 : }
1795 162 : dfData = srcBand->GetMinimum(&bHas);
1796 162 : if (bHas)
1797 17 : poDS->vMin.push_back(dfData);
1798 162 : dfData = srcBand->GetMaximum(&bHas);
1799 162 : if (bHas)
1800 17 : poDS->vMax.push_back(dfData);
1801 :
1802 : // Copy the band metadata, PAM will handle it
1803 162 : char **meta = srcBand->GetMetadata("IMAGE_STRUCTURE");
1804 162 : if (CSLCount(meta))
1805 7 : mBand->SetMetadata(meta, "IMAGE_STRUCTURE");
1806 :
1807 162 : meta = srcBand->GetMetadata();
1808 162 : if (CSLCount(meta))
1809 18 : mBand->SetMetadata(meta);
1810 : }
1811 :
1812 : // Geotags
1813 122 : GDALGeoTransform gt;
1814 122 : if (CE_None == poSrcDS->GetGeoTransform(gt))
1815 119 : poDS->SetGeoTransform(gt);
1816 :
1817 122 : const auto poSRS = poSrcDS->GetSpatialRef();
1818 122 : if (poSRS)
1819 118 : poDS->m_oSRS = *poSRS;
1820 :
1821 : // Color palette if we only have one band
1822 225 : if (1 == nBands &&
1823 103 : GCI_PaletteIndex == poSrcBand1->GetColorInterpretation())
1824 1 : poDS->SetColorTable(poSrcBand1->GetColorTable()->Clone());
1825 :
1826 : // Finally write the XML in the right file name
1827 122 : if (!poDS->Crystalize())
1828 10 : throw CPLString("MRF: Error creating files");
1829 : }
1830 21 : catch (const CPLString &e)
1831 : {
1832 21 : if (nullptr != poDS)
1833 10 : delete poDS;
1834 21 : CPLError(CE_Failure, CPLE_ObjectNull, "%s", e.c_str());
1835 21 : poDS = nullptr;
1836 : }
1837 :
1838 133 : CSLDestroy(options);
1839 133 : if (nullptr == poDS)
1840 21 : return nullptr;
1841 :
1842 112 : char **papszFileList = poDS->GetFileList();
1843 112 : poDS->oOvManager.Initialize(poDS, poDS->GetPhysicalFilename(),
1844 : papszFileList);
1845 112 : CSLDestroy(papszFileList);
1846 :
1847 112 : CPLErr err = CE_None;
1848 : // Have PAM copy all, but skip the mask
1849 112 : int nCloneFlags = GCIF_PAM_DEFAULT & ~GCIF_MASK;
1850 :
1851 : // If copy is disabled, we're done, we just created an empty MRF
1852 112 : if (!on(CSLFetchNameValue(papszOptions, "NOCOPY")))
1853 : {
1854 : // Use the GDAL copy call
1855 : // Need to flag the dataset as compressed (COMPRESSED=TRUE) to force
1856 : // block writes This might not be what we want, if the input and out
1857 : // order is truly separate
1858 110 : nCloneFlags |= GCIF_MASK; // We do copy the data, so copy the mask too
1859 : // if necessary
1860 110 : char **papszCWROptions = nullptr;
1861 : papszCWROptions =
1862 110 : CSLAddNameValue(papszCWROptions, "COMPRESSED", "TRUE");
1863 :
1864 : #ifdef HAVE_JPEG
1865 : // Use the Zen version of the CopyWholeRaster if input has a dataset
1866 : // mask and JPEGs are generated
1867 112 : if (GMF_PER_DATASET == poSrcDS->GetRasterBand(1)->GetMaskFlags() &&
1868 2 : (poDS->current.comp == IL_JPEG
1869 : #ifdef HAVE_PNG
1870 0 : || poDS->current.comp == IL_JPNG
1871 : #endif
1872 : ))
1873 : {
1874 2 : err = poDS->ZenCopy(poSrcDS, pfnProgress, pProgressData);
1875 2 : nCloneFlags ^= GCIF_MASK; // Turn the external mask off
1876 : }
1877 : else
1878 : #endif
1879 : {
1880 108 : err = GDALDatasetCopyWholeRaster(
1881 : (GDALDatasetH)poSrcDS, (GDALDatasetH)poDS, papszCWROptions,
1882 : pfnProgress, pProgressData);
1883 : }
1884 :
1885 110 : CSLDestroy(papszCWROptions);
1886 : }
1887 :
1888 112 : if (CE_None == err)
1889 112 : err = poDS->CloneInfo(poSrcDS, nCloneFlags);
1890 :
1891 112 : if (CE_Failure == err)
1892 : {
1893 0 : delete poDS;
1894 0 : return nullptr;
1895 : }
1896 :
1897 112 : return poDS;
1898 : }
1899 :
1900 : // Prepares the data so it is suitable for Zen JPEG encoding, based on input
1901 : // mask If bFBO is set, only the values of the first band are set non-zero when
1902 : // needed
1903 : template <typename T>
1904 2 : static void ZenFilter(T *buffer, GByte *mask, int nPixels, int nBands,
1905 : bool bFBO)
1906 : {
1907 524290 : for (int i = 0; i < nPixels; i++)
1908 : {
1909 524288 : if (mask[i] == 0)
1910 : { // enforce zero values
1911 516096 : for (int b = 0; b < nBands; b++)
1912 387072 : buffer[nBands * i + b] = 0;
1913 : }
1914 : else
1915 : { // enforce non-zero
1916 395264 : if (bFBO)
1917 : { // First band only
1918 197632 : bool f = true;
1919 790528 : for (int b = 0; b < nBands; b++)
1920 : {
1921 592896 : if (0 == buffer[nBands * i + b])
1922 : {
1923 0 : f = false;
1924 0 : break;
1925 : }
1926 : }
1927 197632 : if (f)
1928 197632 : buffer[nBands * i] = 1;
1929 : }
1930 : else
1931 : { // Every band
1932 790528 : for (int b = 0; b < nBands; b++)
1933 592896 : if (0 == buffer[nBands * i + b])
1934 0 : buffer[nBands * i + b] = 1;
1935 : }
1936 : }
1937 : }
1938 2 : }
1939 :
1940 : // Custom CopyWholeRaster for Zen JPEG, called when the input has a PER_DATASET
1941 : // mask Works like GDALDatasetCopyWholeRaster, but it does filter the input data
1942 : // based on the mask
1943 : //
1944 2 : CPLErr MRFDataset::ZenCopy(GDALDataset *poSrc, GDALProgressFunc pfnProgress,
1945 : void *pProgressData)
1946 : {
1947 2 : VALIDATE_POINTER1(poSrc, "MRF:ZenCopy", CE_Failure);
1948 :
1949 2 : if (!pfnProgress)
1950 0 : pfnProgress = GDALDummyProgress;
1951 :
1952 : /* -------------------------------------------------------------------- */
1953 : /* Confirm the datasets match in size and band counts. */
1954 : /* -------------------------------------------------------------------- */
1955 2 : const int nXSize = GetRasterXSize();
1956 2 : const int nYSize = GetRasterYSize();
1957 2 : const int nBandCount = GetRasterCount();
1958 :
1959 2 : if (poSrc->GetRasterXSize() != nXSize ||
1960 4 : poSrc->GetRasterYSize() != nYSize ||
1961 2 : poSrc->GetRasterCount() != nBandCount)
1962 : {
1963 0 : CPLError(CE_Failure, CPLE_AppDefined,
1964 : "Input and output dataset sizes or band counts do not\n"
1965 : "match in GDALDatasetCopyWholeRaster()");
1966 0 : return CE_Failure;
1967 : }
1968 :
1969 : /* -------------------------------------------------------------------- */
1970 : /* Get our prototype band, and assume the others are similarly */
1971 : /* configured. Also get the per_dataset mask */
1972 : /* -------------------------------------------------------------------- */
1973 2 : GDALRasterBand *poSrcPrototypeBand = poSrc->GetRasterBand(1);
1974 2 : GDALRasterBand *poDstPrototypeBand = GetRasterBand(1);
1975 2 : GDALRasterBand *poSrcMask = poSrcPrototypeBand->GetMaskBand();
1976 :
1977 2 : const int nPageXSize = current.pagesize.x;
1978 2 : const int nPageYSize = current.pagesize.y;
1979 2 : const double nTotalBlocks =
1980 2 : static_cast<double>(DIV_ROUND_UP(nYSize, nPageYSize)) *
1981 2 : static_cast<double>(DIV_ROUND_UP(nXSize, nPageXSize));
1982 2 : const GDALDataType eDT = poDstPrototypeBand->GetRasterDataType();
1983 :
1984 : // All the bands are done per block
1985 : // this flag tells us to apply the Zen filter to the first band only
1986 2 : const bool bFirstBandOnly = (current.order == IL_Interleaved);
1987 :
1988 2 : if (!pfnProgress(0.0, nullptr, pProgressData))
1989 : {
1990 0 : CPLError(CE_Failure, CPLE_UserInterrupt,
1991 : "User terminated CreateCopy()");
1992 0 : return CE_Failure;
1993 : }
1994 :
1995 2 : const int nPixelCount = nPageXSize * nPageYSize;
1996 2 : const int dts = GDALGetDataTypeSizeBytes(eDT);
1997 2 : void *buffer = VSI_MALLOC3_VERBOSE(nPixelCount, nBandCount, dts);
1998 2 : GByte *buffer_mask = nullptr;
1999 2 : if (buffer)
2000 : buffer_mask =
2001 2 : reinterpret_cast<GByte *>(VSI_MALLOC_VERBOSE(nPixelCount));
2002 :
2003 2 : if (!buffer || !buffer_mask)
2004 : {
2005 : // Just in case buffers did get allocated
2006 0 : CPLFree(buffer);
2007 0 : CPLFree(buffer_mask);
2008 0 : CPLError(CE_Failure, CPLE_OutOfMemory, "Can't allocate copy buffer");
2009 0 : return CE_Failure;
2010 : }
2011 :
2012 2 : int nBlocksDone = 0;
2013 2 : CPLErr eErr = CE_None;
2014 : // Advise the source that a complete read will be done
2015 2 : poSrc->AdviseRead(0, 0, nXSize, nYSize, nXSize, nYSize, eDT, nBandCount,
2016 2 : nullptr, nullptr);
2017 :
2018 : // For every block, break on error
2019 4 : for (int row = 0; row < nYSize && eErr == CE_None; row += nPageYSize)
2020 : {
2021 2 : int nRows = std::min(nPageYSize, nYSize - row);
2022 4 : for (int col = 0; col < nXSize && eErr == CE_None; col += nPageXSize)
2023 : {
2024 2 : int nCols = std::min(nPageXSize, nXSize - col);
2025 :
2026 : // Report
2027 2 : if (eErr == CE_None && !pfnProgress(nBlocksDone++ / nTotalBlocks,
2028 : nullptr, pProgressData))
2029 : {
2030 0 : eErr = CE_Failure;
2031 0 : CPLError(CE_Failure, CPLE_UserInterrupt,
2032 : "User terminated CreateCopy()");
2033 0 : break;
2034 : }
2035 :
2036 : // Get the data mask as byte
2037 2 : eErr = poSrcMask->RasterIO(GF_Read, col, row, nCols, nRows,
2038 : buffer_mask, nCols, nRows, GDT_Byte, 0,
2039 : 0, nullptr);
2040 :
2041 2 : if (eErr != CE_None)
2042 0 : break;
2043 :
2044 : // If there is no data at all, skip this block
2045 2 : if (MatchCount(buffer_mask, nPixelCount, static_cast<GByte>(0)) ==
2046 : nPixelCount)
2047 0 : continue;
2048 :
2049 : // get the data in the buffer, interleaved
2050 4 : eErr = poSrc->RasterIO(
2051 : GF_Read, col, row, nCols, nRows, buffer, nCols, nRows, eDT,
2052 2 : nBandCount, nullptr, static_cast<GSpacing>(nBands) * dts,
2053 2 : static_cast<GSpacing>(nBands) * dts * nCols, dts, nullptr);
2054 :
2055 2 : if (eErr != CE_None)
2056 0 : break;
2057 :
2058 : // This is JPEG, only 8 and 12(16) bits unsigned integer types are
2059 : // valid
2060 2 : switch (eDT)
2061 : {
2062 2 : case GDT_Byte:
2063 2 : ZenFilter(reinterpret_cast<GByte *>(buffer), buffer_mask,
2064 : nPixelCount, nBandCount, bFirstBandOnly);
2065 2 : break;
2066 0 : case GDT_UInt16:
2067 0 : ZenFilter(reinterpret_cast<GUInt16 *>(buffer), buffer_mask,
2068 : nPixelCount, nBandCount, bFirstBandOnly);
2069 0 : break;
2070 0 : default:
2071 0 : CPLError(CE_Failure, CPLE_AppDefined,
2072 : "Unsupported data type for Zen filter");
2073 0 : eErr = CE_Failure;
2074 0 : break;
2075 : }
2076 :
2077 : // Write
2078 2 : if (eErr == CE_None)
2079 2 : eErr = RasterIO(
2080 : GF_Write, col, row, nCols, nRows, buffer, nCols, nRows, eDT,
2081 2 : nBandCount, nullptr, static_cast<GSpacing>(nBands) * dts,
2082 2 : static_cast<GSpacing>(nBands) * dts * nCols, dts, nullptr);
2083 :
2084 : } // Columns
2085 2 : if (eErr != CE_None)
2086 0 : break;
2087 :
2088 : } // Rows
2089 :
2090 : // Cleanup
2091 2 : CPLFree(buffer);
2092 2 : CPLFree(buffer_mask);
2093 :
2094 : // Final report
2095 2 : if (eErr == CE_None && !pfnProgress(1.0, nullptr, pProgressData))
2096 : {
2097 0 : eErr = CE_Failure;
2098 0 : CPLError(CE_Failure, CPLE_UserInterrupt,
2099 : "User terminated CreateCopy()");
2100 : }
2101 :
2102 2 : return eErr;
2103 : }
2104 :
2105 : // Apply open options to the current dataset
2106 : // Called before the configuration is read
2107 204 : void MRFDataset::ProcessOpenOptions(char **papszOptions)
2108 : {
2109 408 : CPLStringList opt(papszOptions, FALSE);
2110 204 : no_errors = opt.FetchBoolean("NOERRORS", FALSE);
2111 204 : const char *val = opt.FetchNameValue("ZSLICE");
2112 204 : if (val)
2113 0 : zslice = atoi(val);
2114 204 : }
2115 :
2116 : // Apply create options to the current dataset, only valid during creation
2117 162 : void MRFDataset::ProcessCreateOptions(char **papszOptions)
2118 : {
2119 162 : assert(!bCrystalized);
2120 324 : CPLStringList opt(papszOptions, FALSE);
2121 162 : ILImage &img(full);
2122 :
2123 162 : const char *val = opt.FetchNameValue("COMPRESS");
2124 162 : if (val && IL_ERR_COMP == (img.comp = CompToken(val)))
2125 0 : throw CPLString("GDAL MRF: Error setting compression");
2126 :
2127 162 : val = opt.FetchNameValue("INTERLEAVE");
2128 162 : if (val && IL_ERR_ORD == (img.order = OrderToken(val)))
2129 0 : throw CPLString("GDAL MRF: Error setting interleave");
2130 :
2131 162 : val = opt.FetchNameValue("QUALITY");
2132 162 : if (val)
2133 6 : img.quality = atoi(val);
2134 :
2135 162 : val = opt.FetchNameValue("ZSIZE");
2136 162 : if (val)
2137 0 : img.size.z = atoi(val);
2138 :
2139 162 : val = opt.FetchNameValue("BLOCKXSIZE");
2140 162 : if (val)
2141 1 : img.pagesize.x = atoi(val);
2142 :
2143 162 : val = opt.FetchNameValue("BLOCKYSIZE");
2144 162 : if (val)
2145 1 : img.pagesize.y = atoi(val);
2146 :
2147 162 : val = opt.FetchNameValue("BLOCKSIZE");
2148 162 : if (val)
2149 30 : img.pagesize.x = img.pagesize.y = atoi(val);
2150 :
2151 162 : img.nbo = opt.FetchBoolean("NETBYTEORDER", FALSE) != FALSE;
2152 :
2153 162 : val = opt.FetchNameValue("CACHEDSOURCE");
2154 162 : if (val)
2155 : {
2156 2 : source = val;
2157 2 : nocopy = opt.FetchBoolean("NOCOPY", FALSE);
2158 : }
2159 :
2160 162 : val = opt.FetchNameValue("UNIFORM_SCALE");
2161 162 : if (val)
2162 0 : scale = atoi(val);
2163 :
2164 162 : val = opt.FetchNameValue("PHOTOMETRIC");
2165 162 : if (val)
2166 2 : photometric = val;
2167 :
2168 162 : val = opt.FetchNameValue("DATANAME");
2169 162 : if (val)
2170 0 : img.datfname = val;
2171 :
2172 162 : val = opt.FetchNameValue("INDEXNAME");
2173 162 : if (val)
2174 0 : img.idxfname = val;
2175 :
2176 162 : val = opt.FetchNameValue("SPACING");
2177 162 : if (val)
2178 0 : spacing = atoi(val);
2179 :
2180 : optlist.Assign(
2181 : CSLTokenizeString2(opt.FetchNameValue("OPTIONS"), " \t\n\r",
2182 162 : CSLT_STRIPLEADSPACES | CSLT_STRIPENDSPACES));
2183 :
2184 : // General Fixups
2185 162 : if (img.order == IL_Interleaved)
2186 41 : img.pagesize.c = img.size.c;
2187 :
2188 : // Compression dependent fixups
2189 162 : }
2190 :
2191 : /**
2192 : *\brief Create an MRF dataset, some settings can be changed later
2193 : * papszOptions might be anything that an MRF might take
2194 : * Still missing are the georeference ...
2195 : *
2196 : */
2197 :
2198 166 : GDALDataset *MRFDataset::Create(const char *pszName, int nXSize, int nYSize,
2199 : int nBandsIn, GDALDataType eType,
2200 : char **papszOptions)
2201 : {
2202 166 : if (nBandsIn == 0)
2203 : {
2204 1 : CPLError(CE_Failure, CPLE_NotSupported, "No bands defined");
2205 1 : return nullptr;
2206 : }
2207 :
2208 165 : MRFDataset *poDS = new MRFDataset();
2209 165 : CPLErr err = CE_None;
2210 165 : poDS->fname = pszName;
2211 165 : poDS->nBands = nBandsIn;
2212 :
2213 : // Don't know what to do with these in this call
2214 : // int level = -1;
2215 : // int version = 0;
2216 :
2217 165 : size_t pos = poDS->fname.find(":MRF:");
2218 165 : if (string::npos != pos)
2219 : { // Tokenize and pick known options
2220 0 : vector<string> tokens;
2221 0 : stringSplit(tokens, poDS->fname, pos + 5, ':');
2222 : // level = getnum(tokens, 'L', -1);
2223 : // version = getnum(tokens, 'V', 0);
2224 0 : poDS->zslice = getnum(tokens, 'Z', 0);
2225 0 : poDS->fname.resize(pos); // Cut the ornamentations
2226 : }
2227 :
2228 : // Try creating the mrf file early, to avoid failing on Crystalize later
2229 165 : if (!STARTS_WITH(poDS->fname.c_str(), "<MRF_META>"))
2230 : {
2231 : // Try opening it first, even though we still clobber it later
2232 165 : VSILFILE *mainfile = VSIFOpenL(poDS->fname.c_str(), "r+b");
2233 165 : if (!mainfile)
2234 : { // Then try creating it
2235 115 : mainfile = VSIFOpenL(poDS->fname.c_str(), "w+b");
2236 115 : if (!mainfile)
2237 : {
2238 3 : CPLError(CE_Failure, CPLE_OpenFailed,
2239 : "MRF: Can't open %s for writing", poDS->fname.c_str());
2240 3 : delete poDS;
2241 3 : return nullptr;
2242 : }
2243 : }
2244 162 : VSIFCloseL(mainfile);
2245 : }
2246 :
2247 : // Use the full, set some initial parameters
2248 162 : ILImage &img = poDS->full;
2249 162 : img.size = ILSize(nXSize, nYSize, 1, nBandsIn);
2250 : #ifdef HAVE_PNG
2251 162 : img.comp = IL_PNG;
2252 : #else
2253 : img.comp = IL_NONE;
2254 : #endif
2255 162 : img.order = (nBandsIn < 5) ? IL_Interleaved : IL_Separate;
2256 162 : img.pagesize = ILSize(512, 512, 1, 1);
2257 162 : img.quality = 85;
2258 162 : img.dt = eType;
2259 162 : img.dataoffset = 0;
2260 162 : img.idxoffset = 0;
2261 162 : img.hasNoData = false;
2262 162 : img.nbo = false;
2263 :
2264 : // Set the guard that tells us it needs saving before IO can take place
2265 162 : poDS->bCrystalized = FALSE;
2266 :
2267 : // Process the options, anything that an MRF might take
2268 :
2269 : try
2270 : {
2271 : // Adjust the dataset and the full image
2272 162 : poDS->ProcessCreateOptions(papszOptions);
2273 :
2274 : // Set default file names
2275 162 : if (img.datfname.empty())
2276 162 : img.datfname = getFname(poDS->GetFname(), ILComp_Ext[img.comp]);
2277 162 : if (img.idxfname.empty())
2278 162 : img.idxfname = getFname(poDS->GetFname(), ".idx");
2279 :
2280 162 : poDS->eAccess = GA_Update;
2281 : }
2282 :
2283 0 : catch (const CPLString &e)
2284 : {
2285 0 : CPLError(CE_Failure, CPLE_OpenFailed, "%s", e.c_str());
2286 0 : delete poDS;
2287 0 : return nullptr;
2288 : }
2289 :
2290 162 : poDS->current = poDS->full;
2291 162 : poDS->SetDescription(poDS->GetFname());
2292 :
2293 : // Build a MRF XML and initialize from it, this creates the bands
2294 162 : CPLXMLNode *config = poDS->BuildConfig();
2295 162 : err = poDS->Initialize(config);
2296 162 : CPLDestroyXMLNode(config);
2297 :
2298 162 : if (CPLE_None != err)
2299 : {
2300 30 : delete poDS;
2301 30 : return nullptr;
2302 : }
2303 :
2304 : // If not set by the band, get a pageSizeBytes buffer
2305 132 : if (poDS->GetPBufferSize() == 0 &&
2306 0 : !poDS->SetPBuffer(poDS->current.pageSizeBytes))
2307 : {
2308 0 : delete poDS;
2309 0 : return nullptr;
2310 : }
2311 :
2312 : // Tell PAM what our real file name is, to help it find the aux.xml
2313 132 : poDS->SetPhysicalFilename(poDS->GetFname());
2314 132 : return poDS;
2315 : }
2316 :
2317 172 : int MRFDataset::Crystalize()
2318 : {
2319 172 : if (bCrystalized || eAccess != GA_Update)
2320 : {
2321 0 : bCrystalized = TRUE;
2322 0 : return TRUE;
2323 : }
2324 :
2325 : // No need to write to disk if there is no filename. This is a
2326 : // memory only dataset.
2327 344 : if (strlen(GetDescription()) == 0 ||
2328 172 : EQUALN(GetDescription(), "<MRF_META>", 10))
2329 : {
2330 0 : bCrystalized = TRUE;
2331 0 : return TRUE;
2332 : }
2333 :
2334 172 : CPLXMLNode *config = BuildConfig();
2335 172 : if (!WriteConfig(config))
2336 20 : return FALSE;
2337 152 : CPLDestroyXMLNode(config);
2338 152 : if (!nocopy && (!IdxFP() || !DataFP()))
2339 0 : return FALSE;
2340 152 : bCrystalized = TRUE;
2341 152 : return TRUE;
2342 : }
2343 :
2344 : // Copy the first index at the end of the file and bump the version count
2345 1 : CPLErr MRFDataset::AddVersion()
2346 : {
2347 1 : VSILFILE *l_ifp = IdxFP();
2348 1 : void *tbuff = CPLMalloc(static_cast<size_t>(idxSize));
2349 1 : VSIFSeekL(l_ifp, 0, SEEK_SET);
2350 1 : VSIFReadL(tbuff, 1, static_cast<size_t>(idxSize), l_ifp);
2351 1 : verCount++; // The one we write
2352 1 : VSIFSeekL(l_ifp, idxSize * verCount,
2353 : SEEK_SET); // At the end, this can mess things up royally
2354 1 : VSIFWriteL(tbuff, 1, static_cast<size_t>(idxSize), l_ifp);
2355 1 : CPLFree(tbuff);
2356 1 : return CE_None;
2357 : }
2358 :
2359 : //
2360 : // Write a tile at the end of the data file
2361 : // If buff and size are zero, it is equivalent to erasing the tile
2362 : // If only size is zero, it is a special empty tile,
2363 : // when used for caching, offset should be 1
2364 : //
2365 : // To make it multi-processor safe, open the file in append mode
2366 : // and verify after write
2367 : //
2368 5096 : CPLErr MRFDataset::WriteTile(void *buff, GUIntBig infooffset, GUIntBig size)
2369 : {
2370 5096 : CPLErr ret = CE_None;
2371 5096 : ILIdx tinfo = {0, 0};
2372 :
2373 5096 : VSILFILE *l_dfp = DataFP();
2374 5096 : VSILFILE *l_ifp = IdxFP();
2375 :
2376 : // Verify buffer
2377 10192 : std::vector<GByte> tbuff;
2378 :
2379 5096 : if (l_ifp == nullptr || l_dfp == nullptr)
2380 0 : return CE_Failure;
2381 :
2382 : // Flag that versioned access requires a write even if empty
2383 5096 : int new_tile = false;
2384 : // If it has versions, might need to start a new one
2385 5096 : if (hasVersions)
2386 : {
2387 1 : int new_version = false; // Assume no need to build new version
2388 :
2389 : // Read the current tile info
2390 1 : VSIFSeekL(l_ifp, infooffset, SEEK_SET);
2391 1 : VSIFReadL(&tinfo, 1, sizeof(ILIdx), l_ifp);
2392 :
2393 1 : if (verCount == 0)
2394 1 : new_version = true; // No previous yet, might create a new version
2395 : else
2396 : { // We need at least two versions before we can test for changes
2397 0 : ILIdx prevtinfo = {0, 0};
2398 :
2399 : // Read the previous one
2400 0 : VSIFSeekL(l_ifp, infooffset + verCount * idxSize, SEEK_SET);
2401 0 : VSIFReadL(&prevtinfo, 1, sizeof(ILIdx), l_ifp);
2402 :
2403 : // current and previous tiles are different, might create version
2404 0 : if (tinfo.size != prevtinfo.size ||
2405 0 : tinfo.offset != prevtinfo.offset)
2406 0 : new_version = true;
2407 : }
2408 :
2409 : // tinfo contains the current info or 0,0
2410 1 : if (tinfo.size == GIntBig(net64(size)))
2411 : { // Might be identical
2412 0 : if (size != 0)
2413 : {
2414 : // Use the temporary buffer
2415 0 : tbuff.resize(static_cast<size_t>(size));
2416 0 : VSIFSeekL(l_dfp, infooffset, SEEK_SET);
2417 0 : VSIFReadL(tbuff.data(), 1, tbuff.size(), l_dfp);
2418 : // Need to write it if not the same
2419 0 : new_tile = !std::equal(tbuff.begin(), tbuff.end(),
2420 : static_cast<GByte *>(buff));
2421 0 : tbuff.clear();
2422 : }
2423 : else
2424 : {
2425 : // Writing a null tile on top of a null tile, does it count?
2426 0 : if (tinfo.offset != GIntBig(net64(GUIntBig(buff))))
2427 0 : new_tile = true;
2428 : }
2429 : }
2430 : else
2431 : {
2432 1 : new_tile = true; // Need to write it because it is different
2433 1 : if (verCount == 0 && tinfo.size == 0)
2434 0 : new_version = false; // Don't create a version if current is
2435 : // empty and there is no previous
2436 : }
2437 :
2438 1 : if (!new_tile)
2439 0 : return CE_None; // No reason to write
2440 :
2441 : // Do we need to start a new version before writing the tile?
2442 1 : if (new_version)
2443 1 : AddVersion();
2444 : }
2445 :
2446 5096 : bool same = true;
2447 5096 : if (size)
2448 0 : do
2449 : {
2450 : // start of critical MP section
2451 5085 : VSIFSeekL(l_dfp, 0, SEEK_END);
2452 5085 : GUIntBig offset = VSIFTellL(l_dfp) + spacing;
2453 :
2454 : // Spacing should be 0 in MP safe mode, this doesn't have much of
2455 : // effect Use the existing data, spacing content is not guaranteed
2456 5085 : for (GUIntBig pending = spacing; pending != 0;
2457 0 : pending -= std::min(pending, size))
2458 0 : VSIFWriteL(buff, 1,
2459 0 : static_cast<size_t>(std::min(pending, size)),
2460 : l_dfp); // Usually only once
2461 :
2462 5085 : if (static_cast<size_t>(size) !=
2463 5085 : VSIFWriteL(buff, 1, static_cast<size_t>(size), l_dfp))
2464 0 : ret = CE_Failure;
2465 : // End of critical section
2466 :
2467 5085 : tinfo.offset = net64(offset);
2468 : //
2469 : // For MP ops, check that we can read the same content, otherwise
2470 : // try again This makes the caching MRF MP safe on file systems that
2471 : // implement append mode fully, without using explicit locks
2472 : //
2473 5085 : if (CE_None == ret && mp_safe)
2474 : { // readback and check
2475 3 : if (tbuff.size() < size)
2476 3 : tbuff.resize(static_cast<size_t>(size));
2477 3 : VSIFSeekL(l_dfp, offset, SEEK_SET);
2478 3 : VSIFReadL(tbuff.data(), 1, tbuff.size(), l_dfp);
2479 3 : same = std::equal(tbuff.begin(), tbuff.end(),
2480 : static_cast<GByte *>(buff));
2481 : }
2482 5085 : } while (CE_None == ret && mp_safe && !same);
2483 :
2484 5096 : if (CE_None != ret)
2485 : {
2486 0 : CPLError(CE_Failure, CPLE_AppDefined, "MRF: Tile write failed");
2487 0 : return ret;
2488 : }
2489 :
2490 : // Convert index to net format, offset is set already
2491 5096 : tinfo.size = net64(size);
2492 : // Do nothing if the tile is empty and the file record is also empty
2493 5096 : if (!new_tile && 0 == size && nullptr == buff)
2494 : {
2495 10 : VSIFSeekL(l_ifp, infooffset, SEEK_SET);
2496 10 : VSIFReadL(&tinfo, 1, sizeof(ILIdx), l_ifp);
2497 10 : if (0 == tinfo.offset && 0 == tinfo.size)
2498 10 : return ret;
2499 : }
2500 :
2501 : // Special case, any non-zero offset will do
2502 5086 : if (nullptr != buff && 0 == size)
2503 0 : tinfo.offset = ~GUIntBig(0);
2504 :
2505 5086 : VSIFSeekL(l_ifp, infooffset, SEEK_SET);
2506 5086 : if (sizeof(tinfo) != VSIFWriteL(&tinfo, 1, sizeof(tinfo), l_ifp))
2507 : {
2508 0 : CPLError(CE_Failure, CPLE_AppDefined, "MRF: Index write failed");
2509 0 : ret = CE_Failure;
2510 : }
2511 :
2512 5086 : return ret;
2513 : }
2514 :
2515 128 : CPLErr MRFDataset::SetGeoTransform(const GDALGeoTransform >)
2516 : {
2517 128 : if (GetAccess() != GA_Update || bCrystalized)
2518 : {
2519 0 : CPLError(CE_Failure, CPLE_NotSupported,
2520 : "SetGeoTransform only works during Create call");
2521 0 : return CE_Failure;
2522 : }
2523 128 : m_gt = gt;
2524 128 : bGeoTransformValid = TRUE;
2525 128 : return CE_None;
2526 : }
2527 :
2528 16 : bool MRFDataset::IsSingleTile()
2529 : {
2530 16 : if (current.pagecount.l != 1 || !source.empty() || nullptr == DataFP())
2531 4 : return FALSE;
2532 12 : return 0 == reinterpret_cast<MRFRasterBand *>(GetRasterBand(1))
2533 12 : ->GetOverviewCount();
2534 : }
2535 :
2536 : /*
2537 : * Returns 0,1,0,0,0,1 even if it was not set
2538 : */
2539 455 : CPLErr MRFDataset::GetGeoTransform(GDALGeoTransform >) const
2540 : {
2541 455 : gt = m_gt;
2542 455 : MRFDataset *nonConstThis = const_cast<MRFDataset *>(this);
2543 455 : if (nonConstThis->GetMetadata("RPC") || nonConstThis->GetGCPCount())
2544 0 : bGeoTransformValid = FALSE;
2545 455 : if (!bGeoTransformValid)
2546 0 : return CE_Failure;
2547 455 : return CE_None;
2548 : }
2549 :
2550 : /**
2551 : *\brief Read a tile index
2552 : *
2553 : * It handles the non-existent index case, for no compression
2554 : * The bias is non-zero only when the cloned index is read
2555 : */
2556 :
2557 2020 : CPLErr MRFDataset::ReadTileIdx(ILIdx &tinfo, const ILSize &pos,
2558 : const ILImage &img, const GIntBig bias)
2559 : {
2560 2020 : VSILFILE *l_ifp = IdxFP();
2561 :
2562 : // Initialize the tinfo structure, in case the files are missing
2563 2020 : if (missing)
2564 0 : return CE_None;
2565 :
2566 2020 : GIntBig offset = bias + IdxOffset(pos, img);
2567 2020 : if (l_ifp == nullptr && img.comp == IL_NONE)
2568 : {
2569 0 : tinfo.size = current.pageSizeBytes;
2570 0 : tinfo.offset = offset * tinfo.size;
2571 0 : return CE_None;
2572 : }
2573 :
2574 2020 : if (l_ifp == nullptr && IsSingleTile())
2575 : {
2576 6 : tinfo.offset = 0;
2577 6 : VSILFILE *l_dfp = DataFP(); // IsSingleTile() checks that fp is valid
2578 6 : VSIFSeekL(l_dfp, 0, SEEK_END);
2579 6 : tinfo.size = VSIFTellL(l_dfp);
2580 :
2581 : // It should be less than the pagebuffer
2582 6 : tinfo.size = std::min(tinfo.size, static_cast<GIntBig>(pbsize));
2583 6 : return CE_None;
2584 : }
2585 :
2586 2014 : if (l_ifp == nullptr)
2587 : {
2588 0 : CPLError(CE_Failure, CPLE_FileIO, "Can't open index file");
2589 0 : return CE_Failure;
2590 : }
2591 :
2592 2014 : VSIFSeekL(l_ifp, offset, SEEK_SET);
2593 2014 : if (1 != VSIFReadL(&tinfo, sizeof(ILIdx), 1, l_ifp))
2594 0 : return CE_Failure;
2595 : // Convert them to native form
2596 2014 : tinfo.offset = net64(tinfo.offset);
2597 2014 : tinfo.size = net64(tinfo.size);
2598 :
2599 2014 : if (0 == bias || 0 != tinfo.size || 0 != tinfo.offset)
2600 2013 : return CE_None;
2601 :
2602 : // zero size and zero offset in sourced index means that this portion is
2603 : // un-initialized
2604 :
2605 : // Should be cloned and the offset within the cloned index
2606 1 : offset -= bias;
2607 1 : assert(offset < bias);
2608 1 : assert(clonedSource);
2609 :
2610 : // Read this block from the remote index, prepare it and store it in the
2611 : // right place The block size in bytes, should be a multiple of 16, to have
2612 : // full index entries
2613 1 : const int CPYSZ = 32768;
2614 : // Adjust offset to the start of the block
2615 1 : offset = (offset / CPYSZ) * CPYSZ;
2616 1 : GIntBig size = std::min(size_t(CPYSZ), size_t(bias - offset));
2617 1 : size /= sizeof(ILIdx); // In records
2618 2 : vector<ILIdx> buf(static_cast<size_t>(size));
2619 1 : ILIdx *buffer = &buf[0]; // Buffer to copy the source to the clone index
2620 :
2621 : // Fetch the data from the cloned index
2622 1 : MRFDataset *pSrc = static_cast<MRFDataset *>(GetSrcDS());
2623 1 : if (nullptr == pSrc)
2624 : {
2625 0 : CPLError(CE_Failure, CPLE_FileIO, "Can't open cloned source index");
2626 0 : return CE_Failure; // Source reported the error
2627 : }
2628 :
2629 1 : VSILFILE *srcidx = pSrc->IdxFP();
2630 1 : if (nullptr == srcidx)
2631 : {
2632 0 : CPLError(CE_Failure, CPLE_FileIO, "Can't open cloned source index");
2633 0 : return CE_Failure; // Source reported the error
2634 : }
2635 :
2636 1 : VSIFSeekL(srcidx, offset, SEEK_SET);
2637 1 : size = VSIFReadL(buffer, sizeof(ILIdx), static_cast<size_t>(size), srcidx);
2638 1 : if (size != GIntBig(buf.size()))
2639 : {
2640 0 : CPLError(CE_Failure, CPLE_FileIO, "Can't read cloned source index");
2641 0 : return CE_Failure; // Source reported the error
2642 : }
2643 :
2644 : // Mark the empty records as checked, by making the offset non-zero
2645 2 : for (vector<ILIdx>::iterator it = buf.begin(); it != buf.end(); ++it)
2646 : {
2647 1 : if (it->offset == 0 && it->size == 0)
2648 0 : it->offset = net64(1);
2649 : }
2650 :
2651 : // Write it in the right place in the local index file
2652 1 : VSIFSeekL(l_ifp, bias + offset, SEEK_SET);
2653 1 : size = VSIFWriteL(&buf[0], sizeof(ILIdx), static_cast<size_t>(size), l_ifp);
2654 1 : if (size != GIntBig(buf.size()))
2655 : {
2656 0 : CPLError(CE_Failure, CPLE_FileIO, "Can't write to cloning MRF index");
2657 0 : return CE_Failure; // Source reported the error
2658 : }
2659 :
2660 : // Cloned index updated, restart this function, it will work now
2661 1 : return ReadTileIdx(tinfo, pos, img, bias);
2662 : }
2663 :
2664 : NAMESPACE_MRF_END
|
