Line data Source code
1 : /******************************************************************************
2 : *
3 : * Project: ESRI .hdr Driver
4 : * Purpose: Implementation of EHdrDataset
5 : * Author: Frank Warmerdam, warmerdam@pobox.com
6 : *
7 : ******************************************************************************
8 : * Copyright (c) 1999, Frank Warmerdam <warmerdam@pobox.com>
9 : * Copyright (c) 2007-2013, Even Rouault <even dot rouault at spatialys.com>
10 : *
11 : * SPDX-License-Identifier: MIT
12 : ****************************************************************************/
13 :
14 : #include "cpl_port.h"
15 : #include "ehdrdataset.h"
16 : #include "rawdataset.h"
17 :
18 : #include <algorithm>
19 : #include <cctype>
20 : #include <cerrno>
21 : #include <climits>
22 : #include <cmath>
23 : #include <cstddef>
24 : #include <cstdio>
25 : #include <cstdlib>
26 : #include <cstring>
27 : #if HAVE_FCNTL_H
28 : #include <fcntl.h>
29 : #endif
30 :
31 : #include <limits>
32 :
33 : #include "cpl_conv.h"
34 : #include "cpl_error.h"
35 : #include "cpl_progress.h"
36 : #include "cpl_string.h"
37 : #include "cpl_vsi.h"
38 : #include "gdal.h"
39 : #include "gdal_frmts.h"
40 : #include "gdal_pam.h"
41 : #include "gdal_priv.h"
42 : #include "ogr_core.h"
43 : #include "ogr_spatialref.h"
44 :
45 : constexpr int HAS_MIN_FLAG = 0x1;
46 : constexpr int HAS_MAX_FLAG = 0x2;
47 : constexpr int HAS_MEAN_FLAG = 0x4;
48 : constexpr int HAS_STDDEV_FLAG = 0x8;
49 : constexpr int HAS_ALL_FLAGS =
50 : HAS_MIN_FLAG | HAS_MAX_FLAG | HAS_MEAN_FLAG | HAS_STDDEV_FLAG;
51 :
52 : /************************************************************************/
53 : /* EHdrRasterBand() */
54 : /************************************************************************/
55 :
56 186 : EHdrRasterBand::EHdrRasterBand(GDALDataset *poDSIn, int nBandIn,
57 : VSILFILE *fpRawIn, vsi_l_offset nImgOffsetIn,
58 : int nPixelOffsetIn, int nLineOffsetIn,
59 : GDALDataType eDataTypeIn,
60 : RawRasterBand::ByteOrder eByteOrderIn,
61 186 : int nBitsIn)
62 : : RawRasterBand(poDSIn, nBandIn, fpRawIn, nImgOffsetIn, nPixelOffsetIn,
63 : nLineOffsetIn, eDataTypeIn, eByteOrderIn,
64 : RawRasterBand::OwnFP::NO),
65 : nBits(nBitsIn), nStartBit(0), nPixelOffsetBits(0), nLineOffsetBits(0),
66 : bNoDataSet(FALSE), dfNoData(0.0), dfMin(0.0), dfMax(0.0), dfMean(0.0),
67 186 : dfStdDev(0.0), minmaxmeanstddev(0)
68 : {
69 186 : m_bValid = RawRasterBand::IsValid();
70 :
71 186 : EHdrDataset *poEDS = reinterpret_cast<EHdrDataset *>(poDS);
72 :
73 186 : if (nBits < 8)
74 : {
75 0 : const int nSkipBytes = atoi(poEDS->GetKeyValue("SKIPBYTES"));
76 0 : if (nSkipBytes < 0 || nSkipBytes > std::numeric_limits<int>::max() / 8)
77 : {
78 0 : m_bValid = false;
79 0 : CPLError(CE_Failure, CPLE_AppDefined, "Invalid SKIPBYTES: %d",
80 : nSkipBytes);
81 0 : nStartBit = 0;
82 : }
83 : else
84 : {
85 0 : nStartBit = static_cast<vsi_l_offset>(nSkipBytes) * 8;
86 : }
87 0 : if (nBand >= 2)
88 : {
89 : GIntBig nBandRowBytes =
90 0 : CPLAtoGIntBig(poEDS->GetKeyValue("BANDROWBYTES"));
91 0 : if (nBandRowBytes < 0)
92 : {
93 0 : m_bValid = false;
94 0 : CPLError(CE_Failure, CPLE_AppDefined,
95 : "Invalid BANDROWBYTES: " CPL_FRMT_GIB, nBandRowBytes);
96 0 : nBandRowBytes = 0;
97 : }
98 0 : vsi_l_offset nRowBytes = 0;
99 0 : if (nBandRowBytes == 0)
100 0 : nRowBytes =
101 0 : (static_cast<vsi_l_offset>(nBits) * poDS->GetRasterXSize() +
102 : 7) /
103 : 8;
104 : else
105 0 : nRowBytes = static_cast<vsi_l_offset>(nBandRowBytes);
106 :
107 0 : nStartBit += nRowBytes * (nBand - 1) * 8;
108 : }
109 :
110 0 : nPixelOffsetBits = nBits;
111 : GIntBig nTotalRowBytes =
112 0 : CPLAtoGIntBig(poEDS->GetKeyValue("TOTALROWBYTES"));
113 0 : if (nTotalRowBytes < 0 ||
114 0 : nTotalRowBytes > GINTBIG_MAX / 8 / poDS->GetRasterYSize())
115 : {
116 0 : m_bValid = false;
117 0 : CPLError(CE_Failure, CPLE_AppDefined,
118 : "Invalid TOTALROWBYTES: " CPL_FRMT_GIB, nTotalRowBytes);
119 0 : nTotalRowBytes = 0;
120 : }
121 0 : if (nTotalRowBytes > 0)
122 0 : nLineOffsetBits = static_cast<vsi_l_offset>(nTotalRowBytes * 8);
123 : else
124 0 : nLineOffsetBits = static_cast<vsi_l_offset>(nPixelOffsetBits) *
125 0 : poDS->GetRasterXSize();
126 :
127 0 : nBlockXSize = poDS->GetRasterXSize();
128 0 : nBlockYSize = 1;
129 :
130 0 : SetMetadataItem("NBITS", CPLString().Printf("%d", nBits),
131 : "IMAGE_STRUCTURE");
132 : }
133 186 : }
134 :
135 : /************************************************************************/
136 : /* IReadBlock() */
137 : /************************************************************************/
138 :
139 5350 : CPLErr EHdrRasterBand::IReadBlock(int nBlockXOff, int nBlockYOff, void *pImage)
140 :
141 : {
142 5350 : if (nBits >= 8)
143 5350 : return RawRasterBand::IReadBlock(nBlockXOff, nBlockYOff, pImage);
144 :
145 : // Establish desired position.
146 0 : const vsi_l_offset nLineStart =
147 0 : (nStartBit + nLineOffsetBits * nBlockYOff) / 8;
148 0 : int iBitOffset =
149 0 : static_cast<int>((nStartBit + nLineOffsetBits * nBlockYOff) % 8);
150 0 : const vsi_l_offset nLineEnd =
151 0 : (nStartBit + nLineOffsetBits * nBlockYOff +
152 0 : static_cast<vsi_l_offset>(nPixelOffsetBits) * nBlockXSize - 1) /
153 : 8;
154 0 : const vsi_l_offset nLineBytesBig = nLineEnd - nLineStart + 1;
155 0 : if (nLineBytesBig >
156 0 : static_cast<vsi_l_offset>(std::numeric_limits<int>::max()))
157 0 : return CE_Failure;
158 0 : const unsigned int nLineBytes = static_cast<unsigned int>(nLineBytesBig);
159 :
160 : // Read data into buffer.
161 0 : GByte *pabyBuffer = static_cast<GByte *>(VSI_MALLOC_VERBOSE(nLineBytes));
162 0 : if (pabyBuffer == nullptr)
163 0 : return CE_Failure;
164 :
165 0 : if (VSIFSeekL(GetFPL(), nLineStart, SEEK_SET) != 0 ||
166 0 : VSIFReadL(pabyBuffer, 1, nLineBytes, GetFPL()) != nLineBytes)
167 : {
168 0 : CPLError(CE_Failure, CPLE_FileIO,
169 : "Failed to read %u bytes at offset %lu.\n%s", nLineBytes,
170 0 : static_cast<unsigned long>(nLineStart), VSIStrerror(errno));
171 0 : CPLFree(pabyBuffer);
172 0 : return CE_Failure;
173 : }
174 :
175 : // Copy data, promoting to 8bit.
176 0 : for (int iX = 0, iPixel = 0; iX < nBlockXSize; iX++)
177 : {
178 0 : int nOutWord = 0;
179 :
180 0 : for (int iBit = 0; iBit < nBits; iBit++)
181 : {
182 0 : if (pabyBuffer[iBitOffset >> 3] & (0x80 >> (iBitOffset & 7)))
183 0 : nOutWord |= (1 << (nBits - 1 - iBit));
184 0 : iBitOffset++;
185 : }
186 :
187 0 : iBitOffset = iBitOffset + nPixelOffsetBits - nBits;
188 :
189 0 : reinterpret_cast<GByte *>(pImage)[iPixel++] =
190 : static_cast<GByte>(nOutWord);
191 : }
192 :
193 0 : CPLFree(pabyBuffer);
194 :
195 0 : return CE_None;
196 : }
197 :
198 : /************************************************************************/
199 : /* IWriteBlock() */
200 : /************************************************************************/
201 :
202 3300 : CPLErr EHdrRasterBand::IWriteBlock(int nBlockXOff, int nBlockYOff, void *pImage)
203 :
204 : {
205 3300 : if (nBits >= 8)
206 3300 : return RawRasterBand::IWriteBlock(nBlockXOff, nBlockYOff, pImage);
207 :
208 : // Establish desired position.
209 0 : const vsi_l_offset nLineStart =
210 0 : (nStartBit + nLineOffsetBits * nBlockYOff) / 8;
211 0 : int iBitOffset =
212 0 : static_cast<int>((nStartBit + nLineOffsetBits * nBlockYOff) % 8);
213 0 : const vsi_l_offset nLineEnd =
214 0 : (nStartBit + nLineOffsetBits * nBlockYOff +
215 0 : static_cast<vsi_l_offset>(nPixelOffsetBits) * nBlockXSize - 1) /
216 : 8;
217 0 : const vsi_l_offset nLineBytesBig = nLineEnd - nLineStart + 1;
218 0 : if (nLineBytesBig >
219 0 : static_cast<vsi_l_offset>(std::numeric_limits<int>::max()))
220 0 : return CE_Failure;
221 0 : const unsigned int nLineBytes = static_cast<unsigned int>(nLineBytesBig);
222 :
223 : // Read data into buffer.
224 0 : GByte *pabyBuffer = static_cast<GByte *>(VSI_CALLOC_VERBOSE(nLineBytes, 1));
225 0 : if (pabyBuffer == nullptr)
226 0 : return CE_Failure;
227 :
228 0 : if (VSIFSeekL(GetFPL(), nLineStart, SEEK_SET) != 0)
229 : {
230 0 : CPLError(CE_Failure, CPLE_FileIO,
231 : "Failed to read %u bytes at offset %lu.\n%s", nLineBytes,
232 0 : static_cast<unsigned long>(nLineStart), VSIStrerror(errno));
233 0 : CPLFree(pabyBuffer);
234 0 : return CE_Failure;
235 : }
236 :
237 0 : CPL_IGNORE_RET_VAL(VSIFReadL(pabyBuffer, nLineBytes, 1, GetFPL()));
238 :
239 : // Copy data, promoting to 8bit.
240 0 : for (int iX = 0, iPixel = 0; iX < nBlockXSize; iX++)
241 : {
242 0 : const int nOutWord = reinterpret_cast<GByte *>(pImage)[iPixel++];
243 :
244 0 : for (int iBit = 0; iBit < nBits; iBit++)
245 : {
246 0 : if (nOutWord & (1 << (nBits - 1 - iBit)))
247 0 : pabyBuffer[iBitOffset >> 3] |= (0x80 >> (iBitOffset & 7));
248 : else
249 0 : pabyBuffer[iBitOffset >> 3] &= ~((0x80 >> (iBitOffset & 7)));
250 :
251 0 : iBitOffset++;
252 : }
253 :
254 0 : iBitOffset = iBitOffset + nPixelOffsetBits - nBits;
255 : }
256 :
257 : // Write the data back out.
258 0 : if (VSIFSeekL(GetFPL(), nLineStart, SEEK_SET) != 0 ||
259 0 : VSIFWriteL(pabyBuffer, 1, nLineBytes, GetFPL()) != nLineBytes)
260 : {
261 0 : CPLError(CE_Failure, CPLE_FileIO,
262 : "Failed to write %u bytes at offset %lu.\n%s", nLineBytes,
263 0 : static_cast<unsigned long>(nLineStart), VSIStrerror(errno));
264 0 : return CE_Failure;
265 : }
266 :
267 0 : CPLFree(pabyBuffer);
268 :
269 0 : return CE_None;
270 : }
271 :
272 : /************************************************************************/
273 : /* IRasterIO() */
274 : /************************************************************************/
275 :
276 1742 : CPLErr EHdrRasterBand::IRasterIO(GDALRWFlag eRWFlag, int nXOff, int nYOff,
277 : int nXSize, int nYSize, void *pData,
278 : int nBufXSize, int nBufYSize,
279 : GDALDataType eBufType, GSpacing nPixelSpace,
280 : GSpacing nLineSpace,
281 : GDALRasterIOExtraArg *psExtraArg)
282 :
283 : {
284 : // Defer to RawRasterBand
285 1742 : if (nBits >= 8)
286 1742 : return RawRasterBand::IRasterIO(eRWFlag, nXOff, nYOff, nXSize, nYSize,
287 : pData, nBufXSize, nBufYSize, eBufType,
288 1742 : nPixelSpace, nLineSpace, psExtraArg);
289 :
290 : // Force use of IReadBlock() and IWriteBlock()
291 0 : return GDALRasterBand::IRasterIO(eRWFlag, nXOff, nYOff, nXSize, nYSize,
292 : pData, nBufXSize, nBufYSize, eBufType,
293 0 : nPixelSpace, nLineSpace, psExtraArg);
294 : }
295 :
296 : /************************************************************************/
297 : /* OSR_GDS() */
298 : /************************************************************************/
299 :
300 18 : static const char *OSR_GDS(char *pszResult, int nResultLen, char **papszNV,
301 : const char *pszField, const char *pszDefaultValue)
302 :
303 : {
304 18 : if (papszNV == nullptr || papszNV[0] == nullptr)
305 0 : return pszDefaultValue;
306 :
307 18 : int iLine = 0; // Used after for.
308 66 : for (; papszNV[iLine] != nullptr &&
309 49 : !EQUALN(papszNV[iLine], pszField, strlen(pszField));
310 : iLine++)
311 : {
312 : }
313 :
314 18 : if (papszNV[iLine] == nullptr)
315 17 : return pszDefaultValue;
316 :
317 1 : char **papszTokens = CSLTokenizeString(papszNV[iLine]);
318 :
319 1 : if (CSLCount(papszTokens) > 1)
320 1 : strncpy(pszResult, papszTokens[1], nResultLen - 1);
321 : else
322 0 : strncpy(pszResult, pszDefaultValue, nResultLen - 1);
323 1 : pszResult[nResultLen - 1] = '\0';
324 :
325 1 : CSLDestroy(papszTokens);
326 1 : return pszResult;
327 : }
328 :
329 : /************************************************************************/
330 : /* ==================================================================== */
331 : /* EHdrDataset */
332 : /* ==================================================================== */
333 : /************************************************************************/
334 :
335 : /************************************************************************/
336 : /* EHdrDataset() */
337 : /************************************************************************/
338 :
339 118 : EHdrDataset::EHdrDataset()
340 : : fpImage(nullptr), osHeaderExt("hdr"), bGotTransform(false),
341 118 : bHDRDirty(false), papszHDR(nullptr), bCLRDirty(false)
342 : {
343 118 : m_oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
344 118 : adfGeoTransform[0] = 0.0;
345 118 : adfGeoTransform[1] = 1.0;
346 118 : adfGeoTransform[2] = 0.0;
347 118 : adfGeoTransform[3] = 0.0;
348 118 : adfGeoTransform[4] = 0.0;
349 118 : adfGeoTransform[5] = 1.0;
350 118 : }
351 :
352 : /************************************************************************/
353 : /* ~EHdrDataset() */
354 : /************************************************************************/
355 :
356 236 : EHdrDataset::~EHdrDataset()
357 :
358 : {
359 118 : EHdrDataset::Close();
360 236 : }
361 :
362 : /************************************************************************/
363 : /* Close() */
364 : /************************************************************************/
365 :
366 231 : CPLErr EHdrDataset::Close()
367 : {
368 231 : CPLErr eErr = CE_None;
369 231 : if (nOpenFlags != OPEN_FLAGS_CLOSED)
370 : {
371 118 : if (EHdrDataset::FlushCache(true) != CE_None)
372 0 : eErr = CE_Failure;
373 :
374 118 : if (nBands > 0 && GetAccess() == GA_Update)
375 : {
376 : int bNoDataSet;
377 : RawRasterBand *poBand =
378 51 : reinterpret_cast<RawRasterBand *>(GetRasterBand(1));
379 :
380 51 : const double dfNoData = poBand->GetNoDataValue(&bNoDataSet);
381 51 : if (bNoDataSet)
382 : {
383 1 : ResetKeyValue("NODATA", CPLString().Printf("%.8g", dfNoData));
384 : }
385 :
386 51 : if (bCLRDirty)
387 4 : RewriteCLR(poBand);
388 :
389 51 : if (bHDRDirty)
390 : {
391 38 : if (RewriteHDR() != CE_None)
392 2 : eErr = CE_Failure;
393 : }
394 : }
395 :
396 118 : if (fpImage)
397 : {
398 118 : if (VSIFCloseL(fpImage) != 0)
399 : {
400 0 : CPLError(CE_Failure, CPLE_FileIO, "I/O error");
401 0 : eErr = CE_Failure;
402 : }
403 : }
404 :
405 118 : CSLDestroy(papszHDR);
406 118 : if (GDALPamDataset::Close() != CE_None)
407 0 : eErr = CE_Failure;
408 : }
409 231 : return eErr;
410 : }
411 :
412 : /************************************************************************/
413 : /* GetKeyValue() */
414 : /************************************************************************/
415 :
416 0 : const char *EHdrDataset::GetKeyValue(const char *pszKey, const char *pszDefault)
417 :
418 : {
419 0 : for (int i = 0; papszHDR[i] != nullptr; i++)
420 : {
421 0 : if (EQUALN(pszKey, papszHDR[i], strlen(pszKey)) &&
422 0 : isspace(static_cast<unsigned char>(papszHDR[i][strlen(pszKey)])))
423 : {
424 0 : const char *pszValue = papszHDR[i] + strlen(pszKey);
425 0 : while (isspace(static_cast<unsigned char>(*pszValue)))
426 0 : pszValue++;
427 :
428 0 : return pszValue;
429 : }
430 : }
431 :
432 0 : return pszDefault;
433 : }
434 :
435 : /************************************************************************/
436 : /* ResetKeyValue() */
437 : /* */
438 : /* Replace or add the keyword with the indicated value in the */
439 : /* papszHDR list. */
440 : /************************************************************************/
441 :
442 149 : void EHdrDataset::ResetKeyValue(const char *pszKey, const char *pszValue)
443 :
444 : {
445 149 : if (strlen(pszValue) > 65)
446 : {
447 0 : CPLAssert(strlen(pszValue) <= 65);
448 0 : return;
449 : }
450 :
451 149 : char szNewLine[82] = {'\0'};
452 149 : snprintf(szNewLine, sizeof(szNewLine), "%-15s%s", pszKey, pszValue);
453 :
454 1676 : for (int i = CSLCount(papszHDR) - 1; i >= 0; i--)
455 : {
456 1527 : if (EQUALN(papszHDR[i], szNewLine, strlen(pszKey) + 1))
457 : {
458 0 : if (strcmp(papszHDR[i], szNewLine) != 0)
459 : {
460 0 : CPLFree(papszHDR[i]);
461 0 : papszHDR[i] = CPLStrdup(szNewLine);
462 0 : bHDRDirty = true;
463 : }
464 0 : return;
465 : }
466 : }
467 :
468 149 : bHDRDirty = true;
469 149 : papszHDR = CSLAddString(papszHDR, szNewLine);
470 : }
471 :
472 : /************************************************************************/
473 : /* RewriteCLR() */
474 : /************************************************************************/
475 :
476 4 : void EHdrDataset::RewriteCLR(GDALRasterBand *poBand) const
477 :
478 : {
479 4 : CPLString osCLRFilename = CPLResetExtension(GetDescription(), "clr");
480 4 : GDALColorTable *poTable = poBand->GetColorTable();
481 4 : GDALRasterAttributeTable *poRAT = poBand->GetDefaultRAT();
482 4 : if (poTable || poRAT)
483 : {
484 3 : VSILFILE *fp = VSIFOpenL(osCLRFilename, "wt");
485 3 : if (fp != nullptr)
486 : {
487 : // Write RAT in priority if both are defined
488 3 : if (poRAT)
489 : {
490 26 : for (int iEntry = 0; iEntry < poRAT->GetRowCount(); iEntry++)
491 : {
492 25 : CPLString oLine;
493 : oLine.Printf("%3d %3d %3d %3d\n",
494 25 : poRAT->GetValueAsInt(iEntry, 0),
495 25 : poRAT->GetValueAsInt(iEntry, 1),
496 25 : poRAT->GetValueAsInt(iEntry, 2),
497 25 : poRAT->GetValueAsInt(iEntry, 3));
498 50 : if (VSIFWriteL(reinterpret_cast<void *>(
499 25 : const_cast<char *>(oLine.c_str())),
500 25 : strlen(oLine), 1, fp) != 1)
501 : {
502 0 : CPLError(CE_Failure, CPLE_FileIO,
503 : "Error while write color table");
504 0 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
505 0 : return;
506 : }
507 : }
508 : }
509 : else
510 : {
511 8 : for (int iColor = 0; iColor < poTable->GetColorEntryCount();
512 : iColor++)
513 : {
514 : GDALColorEntry sEntry;
515 6 : poTable->GetColorEntryAsRGB(iColor, &sEntry);
516 :
517 : // I wish we had a way to mark transparency.
518 6 : CPLString oLine;
519 6 : oLine.Printf("%3d %3d %3d %3d\n", iColor, sEntry.c1,
520 6 : sEntry.c2, sEntry.c3);
521 12 : if (VSIFWriteL(reinterpret_cast<void *>(
522 6 : const_cast<char *>(oLine.c_str())),
523 6 : strlen(oLine), 1, fp) != 1)
524 : {
525 0 : CPLError(CE_Failure, CPLE_FileIO,
526 : "Error while write color table");
527 0 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
528 0 : return;
529 : }
530 : }
531 : }
532 3 : if (VSIFCloseL(fp) != 0)
533 : {
534 0 : CPLError(CE_Failure, CPLE_FileIO,
535 : "Error while write color table");
536 : }
537 : }
538 : else
539 : {
540 0 : CPLError(CE_Failure, CPLE_OpenFailed,
541 : "Unable to create color file %s.", osCLRFilename.c_str());
542 3 : }
543 : }
544 : else
545 : {
546 1 : VSIUnlink(osCLRFilename);
547 : }
548 : }
549 :
550 : /************************************************************************/
551 : /* SetSpatialRef() */
552 : /************************************************************************/
553 :
554 35 : CPLErr EHdrDataset::SetSpatialRef(const OGRSpatialReference *poSRS)
555 :
556 : {
557 : // Reset coordinate system on the dataset.
558 35 : m_oSRS.Clear();
559 35 : if (poSRS == nullptr)
560 0 : return CE_None;
561 :
562 35 : m_oSRS = *poSRS;
563 : // Convert to ESRI WKT.
564 35 : char *pszESRI_SRS = nullptr;
565 35 : const char *const apszOptions[] = {"FORMAT=WKT1_ESRI", nullptr};
566 35 : m_oSRS.exportToWkt(&pszESRI_SRS, apszOptions);
567 :
568 35 : if (pszESRI_SRS)
569 : {
570 : // Write to .prj file.
571 35 : CPLString osPrjFilename = CPLResetExtension(GetDescription(), "prj");
572 35 : VSILFILE *fp = VSIFOpenL(osPrjFilename.c_str(), "wt");
573 35 : if (fp != nullptr)
574 : {
575 35 : size_t nCount = VSIFWriteL(pszESRI_SRS, strlen(pszESRI_SRS), 1, fp);
576 35 : nCount += VSIFWriteL("\n", 1, 1, fp);
577 35 : if (VSIFCloseL(fp) != 0 || nCount != 2)
578 : {
579 2 : CPLFree(pszESRI_SRS);
580 2 : return CE_Failure;
581 : }
582 : }
583 :
584 33 : CPLFree(pszESRI_SRS);
585 : }
586 :
587 33 : return CE_None;
588 : }
589 :
590 : /************************************************************************/
591 : /* GetGeoTransform() */
592 : /************************************************************************/
593 :
594 29 : CPLErr EHdrDataset::GetGeoTransform(double *padfTransform)
595 :
596 : {
597 29 : if (bGotTransform)
598 : {
599 29 : memcpy(padfTransform, adfGeoTransform, sizeof(double) * 6);
600 29 : return CE_None;
601 : }
602 :
603 0 : return GDALPamDataset::GetGeoTransform(padfTransform);
604 : }
605 :
606 : /************************************************************************/
607 : /* SetGeoTransform() */
608 : /************************************************************************/
609 :
610 37 : CPLErr EHdrDataset::SetGeoTransform(double *padfGeoTransform)
611 :
612 : {
613 : // We only support non-rotated images with info in the .HDR file.
614 37 : if (padfGeoTransform[2] != 0.0 || padfGeoTransform[4] != 0.0)
615 : {
616 0 : return GDALPamDataset::SetGeoTransform(padfGeoTransform);
617 : }
618 :
619 : // Record new geotransform.
620 37 : bGotTransform = true;
621 37 : memcpy(adfGeoTransform, padfGeoTransform, sizeof(double) * 6);
622 :
623 : // Strip out all old geotransform keywords from HDR records.
624 361 : for (int i = CSLCount(papszHDR) - 1; i >= 0; i--)
625 : {
626 324 : if (STARTS_WITH_CI(papszHDR[i], "ul") ||
627 324 : STARTS_WITH_CI(papszHDR[i] + 1, "ll") ||
628 324 : STARTS_WITH_CI(papszHDR[i], "cell") ||
629 324 : STARTS_WITH_CI(papszHDR[i] + 1, "dim"))
630 : {
631 0 : papszHDR = CSLRemoveStrings(papszHDR, i, 1, nullptr);
632 : }
633 : }
634 :
635 : // Set the transformation information.
636 37 : CPLString oValue;
637 :
638 37 : oValue.Printf("%.15g", adfGeoTransform[0] + adfGeoTransform[1] * 0.5);
639 37 : ResetKeyValue("ULXMAP", oValue);
640 :
641 37 : oValue.Printf("%.15g", adfGeoTransform[3] + adfGeoTransform[5] * 0.5);
642 37 : ResetKeyValue("ULYMAP", oValue);
643 :
644 37 : oValue.Printf("%.15g", adfGeoTransform[1]);
645 37 : ResetKeyValue("XDIM", oValue);
646 :
647 37 : oValue.Printf("%.15g", fabs(adfGeoTransform[5]));
648 37 : ResetKeyValue("YDIM", oValue);
649 :
650 37 : return CE_None;
651 : }
652 :
653 : /************************************************************************/
654 : /* RewriteHDR() */
655 : /************************************************************************/
656 :
657 38 : CPLErr EHdrDataset::RewriteHDR()
658 :
659 : {
660 76 : const CPLString osPath = CPLGetPath(GetDescription());
661 76 : const CPLString osName = CPLGetBasename(GetDescription());
662 : const CPLString osHDRFilename =
663 76 : CPLFormCIFilename(osPath, osName, osHeaderExt);
664 :
665 : // Write .hdr file.
666 38 : VSILFILE *fp = VSIFOpenL(osHDRFilename, "wt");
667 :
668 38 : if (fp == nullptr)
669 : {
670 0 : CPLError(CE_Failure, CPLE_OpenFailed, "Failed to rewrite .hdr file %s.",
671 : osHDRFilename.c_str());
672 0 : return CE_Failure;
673 : }
674 :
675 512 : for (int i = 0; papszHDR[i] != nullptr; i++)
676 : {
677 476 : size_t nCount = VSIFWriteL(papszHDR[i], strlen(papszHDR[i]), 1, fp);
678 476 : nCount += VSIFWriteL("\n", 1, 1, fp);
679 476 : if (nCount != 2)
680 : {
681 2 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
682 2 : return CE_Failure;
683 : }
684 : }
685 :
686 36 : bHDRDirty = false;
687 :
688 36 : if (VSIFCloseL(fp) != 0)
689 0 : return CE_Failure;
690 :
691 36 : return CE_None;
692 : }
693 :
694 : /************************************************************************/
695 : /* RewriteSTX() */
696 : /************************************************************************/
697 :
698 4 : CPLErr EHdrDataset::RewriteSTX() const
699 : {
700 8 : const CPLString osPath = CPLGetPath(GetDescription());
701 8 : const CPLString osName = CPLGetBasename(GetDescription());
702 8 : const CPLString osSTXFilename = CPLFormCIFilename(osPath, osName, "stx");
703 :
704 4 : VSILFILE *fp = VSIFOpenL(osSTXFilename, "wt");
705 4 : if (fp == nullptr)
706 : {
707 0 : CPLDebug("EHDR", "Failed to rewrite .stx file %s.",
708 : osSTXFilename.c_str());
709 0 : return CE_Failure;
710 : }
711 :
712 4 : bool bOK = true;
713 8 : for (int i = 0; bOK && i < nBands; ++i)
714 : {
715 4 : EHdrRasterBand *poBand =
716 4 : reinterpret_cast<EHdrRasterBand *>(papoBands[i]);
717 4 : bOK &= VSIFPrintfL(fp, "%d %.10f %.10f ", i + 1, poBand->dfMin,
718 4 : poBand->dfMax) >= 0;
719 4 : if (poBand->minmaxmeanstddev & HAS_MEAN_FLAG)
720 4 : bOK &= VSIFPrintfL(fp, "%.10f ", poBand->dfMean) >= 0;
721 : else
722 0 : bOK &= VSIFPrintfL(fp, "# ") >= 0;
723 :
724 4 : if (poBand->minmaxmeanstddev & HAS_STDDEV_FLAG)
725 4 : bOK &= VSIFPrintfL(fp, "%.10f\n", poBand->dfStdDev) >= 0;
726 : else
727 0 : bOK &= VSIFPrintfL(fp, "#\n") >= 0;
728 : }
729 :
730 4 : if (VSIFCloseL(fp) != 0)
731 0 : bOK = false;
732 :
733 4 : return bOK ? CE_None : CE_Failure;
734 : }
735 :
736 : /************************************************************************/
737 : /* ReadSTX() */
738 : /************************************************************************/
739 :
740 118 : CPLErr EHdrDataset::ReadSTX() const
741 : {
742 236 : const CPLString osPath = CPLGetPath(GetDescription());
743 236 : const CPLString osName = CPLGetBasename(GetDescription());
744 236 : const CPLString osSTXFilename = CPLFormCIFilename(osPath, osName, "stx");
745 :
746 118 : VSILFILE *fp = VSIFOpenL(osSTXFilename, "rt");
747 118 : if (fp == nullptr)
748 115 : return CE_None;
749 :
750 3 : const char *pszLine = nullptr;
751 6 : while ((pszLine = CPLReadLineL(fp)) != nullptr)
752 : {
753 : char **papszTokens =
754 3 : CSLTokenizeStringComplex(pszLine, " \t", TRUE, FALSE);
755 3 : const int nTokens = CSLCount(papszTokens);
756 3 : if (nTokens >= 5)
757 : {
758 3 : const int i = atoi(papszTokens[0]);
759 3 : if (i > 0 && i <= nBands)
760 : {
761 3 : EHdrRasterBand *poBand =
762 3 : reinterpret_cast<EHdrRasterBand *>(papoBands[i - 1]);
763 3 : poBand->dfMin = CPLAtof(papszTokens[1]);
764 3 : poBand->dfMax = CPLAtof(papszTokens[2]);
765 :
766 3 : int bNoDataSet = FALSE;
767 3 : const double dfNoData = poBand->GetNoDataValue(&bNoDataSet);
768 3 : if (bNoDataSet && dfNoData == poBand->dfMin)
769 : {
770 : // Triggered by
771 : // /vsicurl/http://eros.usgs.gov/archive/nslrsda/GeoTowns/HongKong/srtm/n22e113.zip/n22e113.bil
772 0 : CPLDebug(
773 : "EHDr",
774 : "Ignoring .stx file where min == nodata. "
775 : "The nodata value should not be taken into account "
776 : "in minimum value computation.");
777 0 : CSLDestroy(papszTokens);
778 0 : papszTokens = nullptr;
779 0 : break;
780 : }
781 :
782 3 : poBand->minmaxmeanstddev = HAS_MIN_FLAG | HAS_MAX_FLAG;
783 : // Reads optional mean and stddev.
784 3 : if (!EQUAL(papszTokens[3], "#"))
785 : {
786 3 : poBand->dfMean = CPLAtof(papszTokens[3]);
787 3 : poBand->minmaxmeanstddev |= HAS_MEAN_FLAG;
788 : }
789 3 : if (!EQUAL(papszTokens[4], "#"))
790 : {
791 3 : poBand->dfStdDev = CPLAtof(papszTokens[4]);
792 3 : poBand->minmaxmeanstddev |= HAS_STDDEV_FLAG;
793 : }
794 :
795 3 : if (nTokens >= 6 && !EQUAL(papszTokens[5], "#"))
796 0 : poBand->SetMetadataItem("STRETCHMIN", papszTokens[5],
797 0 : "RENDERING_HINTS");
798 :
799 3 : if (nTokens >= 7 && !EQUAL(papszTokens[6], "#"))
800 0 : poBand->SetMetadataItem("STRETCHMAX", papszTokens[6],
801 0 : "RENDERING_HINTS");
802 : }
803 : }
804 :
805 3 : CSLDestroy(papszTokens);
806 : }
807 :
808 3 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
809 :
810 3 : return CE_None;
811 : }
812 :
813 : /************************************************************************/
814 : /* GetImageRepFilename() */
815 : /************************************************************************/
816 :
817 : // Check for IMAGE.REP (Spatiocarte Defense 1.0) or name_of_image.rep
818 : // if it is a GIS-GeoSPOT image.
819 : // For the specification of SPDF (in French), see
820 : // http://eden.ign.fr/download/pub/doc/emabgi/spdf10.pdf/download
821 :
822 102 : CPLString EHdrDataset::GetImageRepFilename(const char *pszFilename)
823 : {
824 :
825 204 : const CPLString osPath = CPLGetPath(pszFilename);
826 204 : const CPLString osName = CPLGetBasename(pszFilename);
827 204 : const CPLString osREPFilename = CPLFormCIFilename(osPath, osName, "rep");
828 :
829 : VSIStatBufL sStatBuf;
830 102 : if (VSIStatExL(osREPFilename.c_str(), &sStatBuf, VSI_STAT_EXISTS_FLAG) == 0)
831 0 : return osREPFilename;
832 :
833 204 : if (EQUAL(CPLGetFilename(pszFilename), "imspatio.bil") ||
834 102 : EQUAL(CPLGetFilename(pszFilename), "haspatio.bil"))
835 : {
836 0 : CPLString osImageRepFilename(CPLFormCIFilename(osPath, "image", "rep"));
837 0 : if (VSIStatExL(osImageRepFilename, &sStatBuf, VSI_STAT_EXISTS_FLAG) ==
838 : 0)
839 0 : return osImageRepFilename;
840 :
841 : // Try in the upper directories if not found in the BIL image directory.
842 0 : CPLString dirName(CPLGetDirname(osPath));
843 0 : if (CPLIsFilenameRelative(osPath.c_str()))
844 : {
845 0 : char *cwd = CPLGetCurrentDir();
846 0 : if (cwd)
847 : {
848 0 : dirName = CPLFormFilename(cwd, dirName.c_str(), nullptr);
849 0 : CPLFree(cwd);
850 : }
851 : }
852 0 : while (dirName[0] != 0 && EQUAL(dirName, ".") == FALSE &&
853 0 : EQUAL(dirName, "/") == FALSE)
854 : {
855 : osImageRepFilename =
856 0 : CPLFormCIFilename(dirName.c_str(), "image", "rep");
857 0 : if (VSIStatExL(osImageRepFilename.c_str(), &sStatBuf,
858 0 : VSI_STAT_EXISTS_FLAG) == 0)
859 0 : return osImageRepFilename;
860 :
861 : // Don't try to recurse above the 'image' subdirectory.
862 0 : if (EQUAL(dirName, "image"))
863 : {
864 0 : break;
865 : }
866 0 : dirName = CPLString(CPLGetDirname(dirName));
867 : }
868 : }
869 102 : return CPLString();
870 : }
871 :
872 : /************************************************************************/
873 : /* GetFileList() */
874 : /************************************************************************/
875 :
876 22 : char **EHdrDataset::GetFileList()
877 :
878 : {
879 44 : const CPLString osPath = CPLGetPath(GetDescription());
880 44 : const CPLString osName = CPLGetBasename(GetDescription());
881 :
882 : // Main data file, etc.
883 22 : char **papszFileList = GDALPamDataset::GetFileList();
884 :
885 : // Header file.
886 44 : CPLString osFilename = CPLFormCIFilename(osPath, osName, osHeaderExt);
887 22 : papszFileList = CSLAddString(papszFileList, osFilename);
888 :
889 : // Statistics file
890 22 : osFilename = CPLFormCIFilename(osPath, osName, "stx");
891 : VSIStatBufL sStatBuf;
892 22 : if (VSIStatExL(osFilename, &sStatBuf, VSI_STAT_EXISTS_FLAG) == 0)
893 2 : papszFileList = CSLAddString(papszFileList, osFilename);
894 :
895 : // color table file.
896 22 : osFilename = CPLFormCIFilename(osPath, osName, "clr");
897 22 : if (VSIStatExL(osFilename, &sStatBuf, VSI_STAT_EXISTS_FLAG) == 0)
898 2 : papszFileList = CSLAddString(papszFileList, osFilename);
899 :
900 : // projections file.
901 22 : osFilename = CPLFormCIFilename(osPath, osName, "prj");
902 22 : if (VSIStatExL(osFilename, &sStatBuf, VSI_STAT_EXISTS_FLAG) == 0)
903 8 : papszFileList = CSLAddString(papszFileList, osFilename);
904 :
905 22 : const CPLString imageRepFilename = GetImageRepFilename(GetDescription());
906 22 : if (!imageRepFilename.empty())
907 0 : papszFileList = CSLAddString(papszFileList, imageRepFilename.c_str());
908 :
909 44 : return papszFileList;
910 : }
911 :
912 : /************************************************************************/
913 : /* Open() */
914 : /************************************************************************/
915 :
916 27876 : GDALDataset *EHdrDataset::Open(GDALOpenInfo *poOpenInfo)
917 :
918 : {
919 27876 : return Open(poOpenInfo, true);
920 : }
921 :
922 27928 : GDALDataset *EHdrDataset::Open(GDALOpenInfo *poOpenInfo, bool bFileSizeCheck)
923 :
924 : {
925 : // Assume the caller is pointing to the binary (i.e. .bil) file.
926 27928 : if (poOpenInfo->nHeaderBytes < 2 || poOpenInfo->fpL == nullptr)
927 26639 : return nullptr;
928 :
929 : // Tear apart the filename to form a .HDR filename.
930 2578 : const CPLString osPath = CPLGetPath(poOpenInfo->pszFilename);
931 2578 : const CPLString osName = CPLGetBasename(poOpenInfo->pszFilename);
932 :
933 1289 : const char *pszHeaderExt = "hdr";
934 1289 : if (EQUAL(CPLGetExtension(poOpenInfo->pszFilename), "SRC") &&
935 0 : osName.size() == 7 &&
936 0 : (osName[0] == 'e' || osName[0] == 'E' || osName[0] == 'w' ||
937 1289 : osName[0] == 'W') &&
938 0 : (osName[4] == 'n' || osName[4] == 'N' || osName[4] == 's' ||
939 0 : osName[4] == 'S'))
940 : {
941 : // It is a GTOPO30 or SRTM30 source file, whose header extension is .sch
942 : // see http://dds.cr.usgs.gov/srtm/version1/SRTM30/GTOPO30_Documentation
943 0 : pszHeaderExt = "sch";
944 : }
945 :
946 1289 : char **papszSiblingFiles = poOpenInfo->GetSiblingFiles();
947 2578 : CPLString osHDRFilename;
948 1289 : if (papszSiblingFiles)
949 : {
950 1284 : const int iFile = CSLFindString(
951 : papszSiblingFiles, CPLFormFilename(nullptr, osName, pszHeaderExt));
952 1284 : if (iFile < 0) // Return if there is no corresponding .hdr file.
953 1144 : return nullptr;
954 :
955 : osHDRFilename =
956 140 : CPLFormFilename(osPath, papszSiblingFiles[iFile], nullptr);
957 : }
958 : else
959 : {
960 5 : osHDRFilename = CPLFormCIFilename(osPath, osName, pszHeaderExt);
961 : }
962 :
963 145 : const bool bSelectedHDR = EQUAL(osHDRFilename, poOpenInfo->pszFilename);
964 :
965 : // Do we have a .hdr file?
966 145 : VSILFILE *fp = VSIFOpenL(osHDRFilename, "r");
967 145 : if (fp == nullptr)
968 : {
969 5 : return nullptr;
970 : }
971 :
972 : // Is this file an ESRI header file? Read a few lines of text
973 : // searching for something starting with nrows or ncols.
974 140 : int nRows = -1;
975 140 : int nCols = -1;
976 140 : int l_nBands = 1;
977 140 : int nSkipBytes = 0;
978 140 : double dfULXMap = 0.5;
979 140 : double dfULYMap = 0.5;
980 140 : double dfYLLCorner = -123.456;
981 140 : int bCenter = TRUE;
982 140 : double dfXDim = 1.0;
983 140 : double dfYDim = 1.0;
984 140 : double dfNoData = 0.0;
985 140 : int nLineCount = 0;
986 140 : int bNoDataSet = FALSE;
987 140 : GDALDataType eDataType = GDT_Byte;
988 140 : int nBits = -1;
989 140 : char chByteOrder = 'M';
990 140 : char chPixelType = 'N'; // Not defined.
991 140 : char szLayout[10] = "BIL";
992 140 : char **papszHDR = nullptr;
993 140 : int bHasInternalProjection = FALSE;
994 140 : int bHasMin = FALSE;
995 140 : int bHasMax = FALSE;
996 140 : double dfMin = 0;
997 140 : double dfMax = 0;
998 :
999 140 : const char *pszLine = nullptr;
1000 1619 : while ((pszLine = CPLReadLineL(fp)) != nullptr)
1001 : {
1002 1480 : nLineCount++;
1003 :
1004 1480 : if (nLineCount > 50 || strlen(pszLine) > 1000)
1005 : break;
1006 :
1007 1479 : papszHDR = CSLAddString(papszHDR, pszLine);
1008 :
1009 : char **papszTokens =
1010 1479 : CSLTokenizeStringComplex(pszLine, " \t", TRUE, FALSE);
1011 1479 : if (CSLCount(papszTokens) < 2)
1012 : {
1013 45 : CSLDestroy(papszTokens);
1014 45 : continue;
1015 : }
1016 :
1017 1434 : if (EQUAL(papszTokens[0], "ncols"))
1018 : {
1019 118 : nCols = atoi(papszTokens[1]);
1020 : }
1021 1316 : else if (EQUAL(papszTokens[0], "nrows"))
1022 : {
1023 120 : nRows = atoi(papszTokens[1]);
1024 : }
1025 1196 : else if (EQUAL(papszTokens[0], "skipbytes"))
1026 : {
1027 0 : nSkipBytes = atoi(papszTokens[1]);
1028 : }
1029 1196 : else if (EQUAL(papszTokens[0], "ulxmap") ||
1030 1153 : EQUAL(papszTokens[0], "xllcorner") ||
1031 1149 : EQUAL(papszTokens[0], "xllcenter"))
1032 : {
1033 47 : dfULXMap = CPLAtofM(papszTokens[1]);
1034 47 : if (EQUAL(papszTokens[0], "xllcorner"))
1035 4 : bCenter = FALSE;
1036 : }
1037 1149 : else if (EQUAL(papszTokens[0], "ulymap"))
1038 : {
1039 43 : dfULYMap = CPLAtofM(papszTokens[1]);
1040 : }
1041 1106 : else if (EQUAL(papszTokens[0], "yllcorner") ||
1042 1102 : EQUAL(papszTokens[0], "yllcenter"))
1043 : {
1044 4 : dfYLLCorner = CPLAtofM(papszTokens[1]);
1045 4 : if (EQUAL(papszTokens[0], "yllcorner"))
1046 4 : bCenter = FALSE;
1047 : }
1048 1102 : else if (EQUAL(papszTokens[0], "xdim"))
1049 : {
1050 43 : dfXDim = CPLAtofM(papszTokens[1]);
1051 : }
1052 1059 : else if (EQUAL(papszTokens[0], "ydim"))
1053 : {
1054 43 : dfYDim = CPLAtofM(papszTokens[1]);
1055 : }
1056 1016 : else if (EQUAL(papszTokens[0], "cellsize"))
1057 : {
1058 4 : dfXDim = CPLAtofM(papszTokens[1]);
1059 4 : dfYDim = dfXDim;
1060 : }
1061 1012 : else if (EQUAL(papszTokens[0], "nbands"))
1062 : {
1063 112 : l_nBands = atoi(papszTokens[1]);
1064 : }
1065 900 : else if (EQUAL(papszTokens[0], "layout"))
1066 : {
1067 118 : snprintf(szLayout, sizeof(szLayout), "%s", papszTokens[1]);
1068 : }
1069 782 : else if (EQUAL(papszTokens[0], "NODATA_value") ||
1070 782 : EQUAL(papszTokens[0], "NODATA"))
1071 : {
1072 4 : dfNoData = CPLAtofM(papszTokens[1]);
1073 4 : bNoDataSet = TRUE;
1074 : }
1075 778 : else if (EQUAL(papszTokens[0], "NBITS"))
1076 : {
1077 112 : nBits = atoi(papszTokens[1]);
1078 : }
1079 666 : else if (EQUAL(papszTokens[0], "PIXELTYPE"))
1080 : {
1081 108 : chPixelType = static_cast<char>(
1082 108 : toupper(static_cast<unsigned char>(papszTokens[1][0])));
1083 : }
1084 558 : else if (EQUAL(papszTokens[0], "byteorder"))
1085 : {
1086 124 : chByteOrder = static_cast<char>(
1087 124 : toupper(static_cast<unsigned char>(papszTokens[1][0])));
1088 : }
1089 :
1090 : // http://www.worldclim.org/futdown.htm have the projection extensions
1091 434 : else if (EQUAL(papszTokens[0], "Projection"))
1092 : {
1093 3 : bHasInternalProjection = TRUE;
1094 : }
1095 431 : else if (EQUAL(papszTokens[0], "MinValue") ||
1096 430 : EQUAL(papszTokens[0], "MIN_VALUE"))
1097 : {
1098 1 : dfMin = CPLAtofM(papszTokens[1]);
1099 1 : bHasMin = TRUE;
1100 : }
1101 430 : else if (EQUAL(papszTokens[0], "MaxValue") ||
1102 429 : EQUAL(papszTokens[0], "MAX_VALUE"))
1103 : {
1104 1 : dfMax = CPLAtofM(papszTokens[1]);
1105 1 : bHasMax = TRUE;
1106 : }
1107 :
1108 1434 : CSLDestroy(papszTokens);
1109 : }
1110 :
1111 140 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
1112 :
1113 : // Did we get the required keywords? If not, return with this never having
1114 : // been considered to be a match. This isn't an error!
1115 140 : if (nRows == -1 || nCols == -1)
1116 : {
1117 22 : CSLDestroy(papszHDR);
1118 22 : return nullptr;
1119 : }
1120 :
1121 236 : if (!GDALCheckDatasetDimensions(nCols, nRows) ||
1122 118 : !GDALCheckBandCount(l_nBands, FALSE))
1123 : {
1124 0 : CSLDestroy(papszHDR);
1125 0 : return nullptr;
1126 : }
1127 :
1128 : // Has the caller selected the .hdr file to open?
1129 118 : if (bSelectedHDR)
1130 : {
1131 0 : CPLError(CE_Failure, CPLE_AppDefined,
1132 : "The selected file is an ESRI BIL header file, but to "
1133 : "open ESRI BIL datasets, the data file should be selected "
1134 : "instead of the .hdr file. Please try again selecting "
1135 : "the data file (often with the extension .bil) corresponding "
1136 : "to the header file: %s",
1137 : poOpenInfo->pszFilename);
1138 0 : CSLDestroy(papszHDR);
1139 0 : return nullptr;
1140 : }
1141 :
1142 : // If we aren't sure of the file type, check the data file size. If it is 4
1143 : // bytes or more per pixel then we assume it is floating point data.
1144 118 : if (nBits == -1 && chPixelType == 'N')
1145 : {
1146 : VSIStatBufL sStatBuf;
1147 6 : if (VSIStatL(poOpenInfo->pszFilename, &sStatBuf) == 0)
1148 : {
1149 6 : const size_t nBytes = static_cast<size_t>(sStatBuf.st_size / nCols /
1150 6 : nRows / l_nBands);
1151 6 : if (nBytes > 0 && nBytes != 3)
1152 2 : nBits = static_cast<int>(nBytes * 8);
1153 :
1154 6 : if (nBytes == 4)
1155 2 : chPixelType = 'F';
1156 : }
1157 : }
1158 :
1159 : // If the extension is FLT it is likely a floating point file.
1160 118 : if (chPixelType == 'N')
1161 : {
1162 8 : if (EQUAL(CPLGetExtension(poOpenInfo->pszFilename), "FLT"))
1163 2 : chPixelType = 'F';
1164 : }
1165 :
1166 : // If we have a negative nodata value, assume that the
1167 : // pixel type is signed. This is necessary for datasets from
1168 : // http://www.worldclim.org/futdown.htm
1169 :
1170 118 : if (bNoDataSet && dfNoData < 0 && chPixelType == 'N')
1171 : {
1172 2 : chPixelType = 'S';
1173 : }
1174 :
1175 236 : auto poDS = std::make_unique<EHdrDataset>();
1176 :
1177 118 : poDS->osHeaderExt = pszHeaderExt;
1178 :
1179 118 : poDS->nRasterXSize = nCols;
1180 118 : poDS->nRasterYSize = nRows;
1181 118 : poDS->papszHDR = papszHDR;
1182 118 : std::swap(poDS->fpImage, poOpenInfo->fpL);
1183 118 : poDS->eAccess = poOpenInfo->eAccess;
1184 :
1185 : // Figure out the data type.
1186 118 : if (nBits == 16)
1187 : {
1188 21 : if (chPixelType == 'S')
1189 13 : eDataType = GDT_Int16;
1190 : else
1191 8 : eDataType = GDT_UInt16; // Default
1192 : }
1193 97 : else if (nBits == 32)
1194 : {
1195 34 : if (chPixelType == 'S')
1196 8 : eDataType = GDT_Int32;
1197 26 : else if (chPixelType == 'F')
1198 21 : eDataType = GDT_Float32;
1199 : else
1200 5 : eDataType = GDT_UInt32; // Default
1201 : }
1202 63 : else if (nBits >= 1 && nBits <= 8)
1203 : {
1204 59 : if (chPixelType == 'S')
1205 6 : eDataType = GDT_Int8;
1206 : else
1207 53 : eDataType = GDT_Byte;
1208 59 : nBits = 8;
1209 : }
1210 4 : else if (nBits == -1)
1211 : {
1212 4 : if (chPixelType == 'F')
1213 : {
1214 0 : eDataType = GDT_Float32;
1215 0 : nBits = 32;
1216 : }
1217 : else
1218 : {
1219 4 : eDataType = GDT_Byte;
1220 4 : nBits = 8;
1221 : }
1222 : }
1223 : else
1224 : {
1225 0 : CPLError(CE_Failure, CPLE_NotSupported,
1226 : "EHdr driver does not support %d NBITS value.", nBits);
1227 0 : return nullptr;
1228 : }
1229 :
1230 : // Compute the line offset.
1231 118 : const int nItemSize = GDALGetDataTypeSizeBytes(eDataType);
1232 118 : CPLAssert(nItemSize != 0);
1233 118 : CPLAssert(l_nBands != 0);
1234 :
1235 118 : int nPixelOffset = 0;
1236 118 : int nLineOffset = 0;
1237 118 : vsi_l_offset nBandOffset = 0;
1238 :
1239 118 : if (EQUAL(szLayout, "BIP"))
1240 : {
1241 0 : if (nCols > std::numeric_limits<int>::max() / (nItemSize * l_nBands))
1242 : {
1243 0 : CPLError(CE_Failure, CPLE_AppDefined, "Int overflow occurred.");
1244 0 : return nullptr;
1245 : }
1246 0 : nPixelOffset = nItemSize * l_nBands;
1247 0 : nLineOffset = nPixelOffset * nCols;
1248 0 : nBandOffset = static_cast<vsi_l_offset>(nItemSize);
1249 : }
1250 118 : else if (EQUAL(szLayout, "BSQ"))
1251 : {
1252 0 : if (nCols > std::numeric_limits<int>::max() / nItemSize)
1253 : {
1254 0 : CPLError(CE_Failure, CPLE_AppDefined, "Int overflow occurred.");
1255 0 : return nullptr;
1256 : }
1257 0 : nPixelOffset = nItemSize;
1258 0 : nLineOffset = nPixelOffset * nCols;
1259 0 : nBandOffset = static_cast<vsi_l_offset>(nLineOffset) * nRows;
1260 : }
1261 : else
1262 : {
1263 : // Assume BIL.
1264 118 : if (nCols > std::numeric_limits<int>::max() / (nItemSize * l_nBands))
1265 : {
1266 0 : CPLError(CE_Failure, CPLE_AppDefined, "Int overflow occurred.");
1267 0 : return nullptr;
1268 : }
1269 118 : nPixelOffset = nItemSize;
1270 118 : nLineOffset = nItemSize * l_nBands * nCols;
1271 118 : nBandOffset = static_cast<vsi_l_offset>(nItemSize) * nCols;
1272 : }
1273 :
1274 189 : if (nBits >= 8 && bFileSizeCheck &&
1275 71 : !RAWDatasetCheckMemoryUsage(
1276 71 : poDS->nRasterXSize, poDS->nRasterYSize, l_nBands, nItemSize,
1277 71 : nPixelOffset, nLineOffset, nSkipBytes, nBandOffset, poDS->fpImage))
1278 : {
1279 0 : return nullptr;
1280 : }
1281 :
1282 118 : poDS->SetDescription(poOpenInfo->pszFilename);
1283 118 : poDS->PamInitialize();
1284 :
1285 : // Create band information objects.
1286 304 : for (int i = 0; i < l_nBands; i++)
1287 : {
1288 : auto poBand = std::make_unique<EHdrRasterBand>(
1289 186 : poDS.get(), i + 1, poDS->fpImage, nSkipBytes + nBandOffset * i,
1290 : nPixelOffset, nLineOffset, eDataType,
1291 : chByteOrder == 'I' || chByteOrder == 'L'
1292 186 : ? RawRasterBand::ByteOrder::ORDER_LITTLE_ENDIAN
1293 : : RawRasterBand::ByteOrder::ORDER_BIG_ENDIAN,
1294 186 : nBits);
1295 186 : if (!poBand->IsValid())
1296 0 : return nullptr;
1297 :
1298 186 : poBand->bNoDataSet = bNoDataSet;
1299 186 : poBand->dfNoData = dfNoData;
1300 :
1301 186 : if (bHasMin && bHasMax)
1302 : {
1303 1 : poBand->dfMin = dfMin;
1304 1 : poBand->dfMax = dfMax;
1305 1 : poBand->minmaxmeanstddev = HAS_MIN_FLAG | HAS_MAX_FLAG;
1306 : }
1307 :
1308 186 : poDS->SetBand(i + 1, std::move(poBand));
1309 : }
1310 :
1311 : // If we didn't get bounds in the .hdr, look for a worldfile.
1312 118 : if (dfYLLCorner != -123.456)
1313 : {
1314 4 : if (bCenter)
1315 0 : dfULYMap = dfYLLCorner + (nRows - 1) * dfYDim;
1316 : else
1317 4 : dfULYMap = dfYLLCorner + nRows * dfYDim;
1318 : }
1319 :
1320 118 : if (dfULXMap != 0.5 || dfULYMap != 0.5 || dfXDim != 1.0 || dfYDim != 1.0)
1321 : {
1322 47 : poDS->bGotTransform = true;
1323 :
1324 47 : if (bCenter)
1325 : {
1326 43 : poDS->adfGeoTransform[0] = dfULXMap - dfXDim * 0.5;
1327 43 : poDS->adfGeoTransform[1] = dfXDim;
1328 43 : poDS->adfGeoTransform[2] = 0.0;
1329 43 : poDS->adfGeoTransform[3] = dfULYMap + dfYDim * 0.5;
1330 43 : poDS->adfGeoTransform[4] = 0.0;
1331 43 : poDS->adfGeoTransform[5] = -dfYDim;
1332 : }
1333 : else
1334 : {
1335 4 : poDS->adfGeoTransform[0] = dfULXMap;
1336 4 : poDS->adfGeoTransform[1] = dfXDim;
1337 4 : poDS->adfGeoTransform[2] = 0.0;
1338 4 : poDS->adfGeoTransform[3] = dfULYMap;
1339 4 : poDS->adfGeoTransform[4] = 0.0;
1340 4 : poDS->adfGeoTransform[5] = -dfYDim;
1341 : }
1342 : }
1343 :
1344 118 : if (!poDS->bGotTransform)
1345 71 : poDS->bGotTransform = CPL_TO_BOOL(GDALReadWorldFile(
1346 71 : poOpenInfo->pszFilename, nullptr, poDS->adfGeoTransform));
1347 :
1348 118 : if (!poDS->bGotTransform)
1349 71 : poDS->bGotTransform = CPL_TO_BOOL(GDALReadWorldFile(
1350 71 : poOpenInfo->pszFilename, "wld", poDS->adfGeoTransform));
1351 :
1352 : // Check for a .prj file.
1353 118 : const char *pszPrjFilename = CPLFormCIFilename(osPath, osName, "prj");
1354 :
1355 118 : fp = VSIFOpenL(pszPrjFilename, "r");
1356 :
1357 : // .hdr files from http://www.worldclim.org/futdown.htm have the projection
1358 : // info in the .hdr file itself.
1359 118 : if (fp == nullptr && bHasInternalProjection)
1360 : {
1361 1 : pszPrjFilename = osHDRFilename;
1362 1 : fp = VSIFOpenL(pszPrjFilename, "r");
1363 : }
1364 :
1365 118 : if (fp != nullptr)
1366 : {
1367 38 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
1368 38 : fp = nullptr;
1369 :
1370 38 : char **papszLines = CSLLoad(pszPrjFilename);
1371 :
1372 38 : if (poDS->m_oSRS.importFromESRI(papszLines) == OGRERR_NONE)
1373 : {
1374 : // If geographic values are in seconds, we must transform.
1375 : // Is there a code for minutes too?
1376 36 : char szResult[80] = {'\0'};
1377 54 : if (poDS->m_oSRS.IsGeographic() &&
1378 18 : EQUAL(OSR_GDS(szResult, sizeof(szResult), papszLines, "Units",
1379 : ""),
1380 : "DS"))
1381 : {
1382 0 : poDS->adfGeoTransform[0] /= 3600.0;
1383 0 : poDS->adfGeoTransform[1] /= 3600.0;
1384 0 : poDS->adfGeoTransform[2] /= 3600.0;
1385 0 : poDS->adfGeoTransform[3] /= 3600.0;
1386 0 : poDS->adfGeoTransform[4] /= 3600.0;
1387 0 : poDS->adfGeoTransform[5] /= 3600.0;
1388 : }
1389 : }
1390 : else
1391 : {
1392 2 : poDS->m_oSRS.Clear();
1393 : }
1394 :
1395 38 : CSLDestroy(papszLines);
1396 : }
1397 : else
1398 : {
1399 : // Check for IMAGE.REP (Spatiocarte Defense 1.0) or name_of_image.rep
1400 : // if it is a GIS-GeoSPOT image
1401 : // For the specification of SPDF (in French), see
1402 : // http://eden.ign.fr/download/pub/doc/emabgi/spdf10.pdf/download
1403 : const CPLString szImageRepFilename =
1404 160 : GetImageRepFilename(poOpenInfo->pszFilename);
1405 80 : if (!szImageRepFilename.empty())
1406 : {
1407 0 : fp = VSIFOpenL(szImageRepFilename.c_str(), "r");
1408 : }
1409 80 : if (fp != nullptr)
1410 : {
1411 0 : bool bUTM = false;
1412 0 : bool bWGS84 = false;
1413 0 : int bNorth = FALSE;
1414 0 : bool bSouth = false;
1415 0 : int utmZone = 0;
1416 :
1417 0 : while ((pszLine = CPLReadLineL(fp)) != nullptr)
1418 : {
1419 0 : if (STARTS_WITH(pszLine, "PROJ_ID") && strstr(pszLine, "UTM"))
1420 : {
1421 0 : bUTM = true;
1422 : }
1423 0 : else if (STARTS_WITH(pszLine, "PROJ_ZONE"))
1424 : {
1425 0 : const char *c = strchr(pszLine, '"');
1426 0 : if (c)
1427 : {
1428 0 : c++;
1429 0 : if (*c >= '0' && *c <= '9')
1430 : {
1431 0 : utmZone = atoi(c);
1432 0 : if (utmZone >= 1 && utmZone <= 60)
1433 : {
1434 0 : if (strstr(pszLine, "Nord") ||
1435 0 : strstr(pszLine, "NORD"))
1436 : {
1437 0 : bNorth = TRUE;
1438 : }
1439 0 : else if (strstr(pszLine, "Sud") ||
1440 0 : strstr(pszLine, "SUD"))
1441 : {
1442 0 : bSouth = true;
1443 : }
1444 : }
1445 : }
1446 : }
1447 : }
1448 0 : else if (STARTS_WITH(pszLine, "PROJ_CODE") &&
1449 0 : strstr(pszLine, "FR-MINDEF"))
1450 : {
1451 0 : const char *c = strchr(pszLine, 'A');
1452 0 : if (c)
1453 : {
1454 0 : c++;
1455 0 : if (*c >= '0' && *c <= '9')
1456 : {
1457 0 : utmZone = atoi(c);
1458 0 : if (utmZone >= 1 && utmZone <= 60)
1459 : {
1460 0 : if (c[1] == 'N' ||
1461 0 : (c[1] != '\0' && c[2] == 'N'))
1462 : {
1463 0 : bNorth = TRUE;
1464 : }
1465 0 : else if (c[1] == 'S' ||
1466 0 : (c[1] != '\0' && c[2] == 'S'))
1467 : {
1468 0 : bSouth = true;
1469 : }
1470 : }
1471 : }
1472 0 : }
1473 : }
1474 0 : else if (STARTS_WITH(pszLine, "HORIZ_DATUM") &&
1475 0 : (strstr(pszLine, "WGS 84") ||
1476 0 : strstr(pszLine, "WGS84")))
1477 : {
1478 0 : bWGS84 = true;
1479 : }
1480 0 : else if (STARTS_WITH(pszLine, "MAP_NUMBER"))
1481 : {
1482 0 : const char *c = strchr(pszLine, '"');
1483 0 : if (c)
1484 : {
1485 0 : char *pszMapNumber = CPLStrdup(c + 1);
1486 0 : char *c2 = strchr(pszMapNumber, '"');
1487 0 : if (c2)
1488 0 : *c2 = 0;
1489 0 : poDS->SetMetadataItem("SPDF_MAP_NUMBER", pszMapNumber);
1490 0 : CPLFree(pszMapNumber);
1491 : }
1492 : }
1493 0 : else if (STARTS_WITH(pszLine, "PRODUCTION_DATE"))
1494 : {
1495 0 : const char *c = pszLine + strlen("PRODUCTION_DATE");
1496 0 : while (*c == ' ')
1497 0 : c++;
1498 0 : if (*c)
1499 : {
1500 0 : poDS->SetMetadataItem("SPDF_PRODUCTION_DATE", c);
1501 : }
1502 : }
1503 : }
1504 :
1505 0 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
1506 :
1507 0 : if (utmZone >= 1 && utmZone <= 60 && bUTM && bWGS84 &&
1508 0 : (bNorth || bSouth))
1509 : {
1510 0 : char projCSStr[64] = {'\0'};
1511 0 : snprintf(projCSStr, sizeof(projCSStr), "WGS 84 / UTM zone %d%c",
1512 : utmZone, (bNorth) ? 'N' : 'S');
1513 :
1514 0 : poDS->m_oSRS.SetProjCS(projCSStr);
1515 0 : poDS->m_oSRS.SetWellKnownGeogCS("WGS84");
1516 0 : poDS->m_oSRS.SetUTM(utmZone, bNorth);
1517 0 : poDS->m_oSRS.SetAuthority("PROJCS", "EPSG",
1518 0 : (bNorth ? 32600 : 32700) + utmZone);
1519 0 : poDS->m_oSRS.AutoIdentifyEPSG();
1520 : }
1521 : else
1522 : {
1523 0 : CPLError(CE_Warning, CPLE_NotSupported,
1524 : "Cannot retrieve projection from IMAGE.REP");
1525 : }
1526 : }
1527 : }
1528 :
1529 : // Check for a color table.
1530 118 : const char *pszCLRFilename = CPLFormCIFilename(osPath, osName, "clr");
1531 :
1532 : // Only read the .clr for byte, int16 or uint16 bands.
1533 118 : if (nItemSize <= 2)
1534 84 : fp = VSIFOpenL(pszCLRFilename, "r");
1535 : else
1536 34 : fp = nullptr;
1537 :
1538 118 : if (fp != nullptr)
1539 : {
1540 : std::shared_ptr<GDALRasterAttributeTable> poRat(
1541 7 : new GDALDefaultRasterAttributeTable());
1542 7 : poRat->CreateColumn("Value", GFT_Integer, GFU_Generic);
1543 7 : poRat->CreateColumn("Red", GFT_Integer, GFU_Red);
1544 7 : poRat->CreateColumn("Green", GFT_Integer, GFU_Green);
1545 7 : poRat->CreateColumn("Blue", GFT_Integer, GFU_Blue);
1546 :
1547 7 : poDS->m_poColorTable.reset(new GDALColorTable());
1548 :
1549 7 : bool bHasFoundNonCTValues = false;
1550 7 : int nRatRow = 0;
1551 :
1552 : while (true)
1553 : {
1554 94 : pszLine = CPLReadLineL(fp);
1555 94 : if (!pszLine)
1556 7 : break;
1557 :
1558 87 : if (*pszLine == '#' || *pszLine == '!')
1559 0 : continue;
1560 :
1561 : char **papszValues =
1562 87 : CSLTokenizeString2(pszLine, "\t ", CSLT_HONOURSTRINGS);
1563 :
1564 87 : if (CSLCount(papszValues) >= 4)
1565 : {
1566 87 : const int nIndex = atoi(papszValues[0]);
1567 87 : poRat->SetValue(nRatRow, 0, nIndex);
1568 87 : poRat->SetValue(nRatRow, 1, atoi(papszValues[1]));
1569 87 : poRat->SetValue(nRatRow, 2, atoi(papszValues[2]));
1570 87 : poRat->SetValue(nRatRow, 3, atoi(papszValues[3]));
1571 87 : nRatRow++;
1572 :
1573 87 : if (nIndex >= 0 && nIndex < 65536)
1574 : {
1575 72 : const GDALColorEntry oEntry = {
1576 72 : static_cast<short>(atoi(papszValues[1])), // Red
1577 72 : static_cast<short>(atoi(papszValues[2])), // Green
1578 72 : static_cast<short>(atoi(papszValues[3])), // Blue
1579 72 : 255};
1580 :
1581 72 : poDS->m_poColorTable->SetColorEntry(nIndex, &oEntry);
1582 : }
1583 : else
1584 : {
1585 : // Negative values are valid. At least we can find use of
1586 : // them here:
1587 : // http://www.ngdc.noaa.gov/mgg/topo/elev/esri/clr/
1588 : // But, there's no way of representing them with GDAL color
1589 : // table model.
1590 15 : if (!bHasFoundNonCTValues)
1591 3 : CPLDebug("EHdr", "Ignoring color index : %d", nIndex);
1592 15 : bHasFoundNonCTValues = true;
1593 : }
1594 : }
1595 :
1596 87 : CSLDestroy(papszValues);
1597 87 : }
1598 :
1599 7 : CPL_IGNORE_RET_VAL(VSIFCloseL(fp));
1600 :
1601 7 : if (bHasFoundNonCTValues)
1602 : {
1603 3 : poDS->m_poRAT.swap(poRat);
1604 : }
1605 :
1606 14 : for (int i = 1; i <= poDS->nBands; i++)
1607 : {
1608 : EHdrRasterBand *poBand =
1609 7 : cpl::down_cast<EHdrRasterBand *>(poDS->GetRasterBand(i));
1610 7 : poBand->m_poColorTable = poDS->m_poColorTable;
1611 7 : poBand->m_poRAT = poDS->m_poRAT;
1612 7 : poBand->SetColorInterpretation(GCI_PaletteIndex);
1613 : }
1614 :
1615 7 : poDS->bCLRDirty = false;
1616 : }
1617 :
1618 : // Read statistics (.STX).
1619 118 : poDS->ReadSTX();
1620 :
1621 : // Initialize any PAM information.
1622 118 : poDS->TryLoadXML();
1623 :
1624 : // Check for overviews.
1625 118 : poDS->oOvManager.Initialize(poDS.get(), poOpenInfo->pszFilename);
1626 :
1627 118 : return poDS.release();
1628 : }
1629 :
1630 : /************************************************************************/
1631 : /* Create() */
1632 : /************************************************************************/
1633 :
1634 78 : GDALDataset *EHdrDataset::Create(const char *pszFilename, int nXSize,
1635 : int nYSize, int nBandsIn, GDALDataType eType,
1636 : char **papszParamList)
1637 :
1638 : {
1639 : // Verify input options.
1640 78 : if (nBandsIn <= 0)
1641 : {
1642 1 : CPLError(CE_Failure, CPLE_NotSupported,
1643 : "EHdr driver does not support %d bands.", nBandsIn);
1644 1 : return nullptr;
1645 : }
1646 :
1647 77 : if (eType != GDT_Byte && eType != GDT_Int8 && eType != GDT_Float32 &&
1648 30 : eType != GDT_UInt16 && eType != GDT_Int16 && eType != GDT_Int32 &&
1649 : eType != GDT_UInt32)
1650 : {
1651 19 : CPLError(CE_Failure, CPLE_AppDefined,
1652 : "Attempt to create ESRI .hdr labelled dataset with an illegal"
1653 : "data type (%s).",
1654 : GDALGetDataTypeName(eType));
1655 :
1656 19 : return nullptr;
1657 : }
1658 :
1659 : // Try to create the file.
1660 58 : VSILFILE *fp = VSIFOpenL(pszFilename, "wb");
1661 :
1662 58 : if (fp == nullptr)
1663 : {
1664 3 : CPLError(CE_Failure, CPLE_OpenFailed,
1665 : "Attempt to create file `%s' failed.", pszFilename);
1666 3 : return nullptr;
1667 : }
1668 :
1669 : // Just write out a couple of bytes to establish the binary
1670 : // file, and then close it.
1671 55 : bool bOK = VSIFWriteL(reinterpret_cast<void *>(const_cast<char *>("\0\0")),
1672 55 : 2, 1, fp) == 1;
1673 55 : if (VSIFCloseL(fp) != 0)
1674 0 : bOK = false;
1675 55 : fp = nullptr;
1676 55 : if (!bOK)
1677 1 : return nullptr;
1678 :
1679 : // Create the hdr filename.
1680 : char *const pszHdrFilename =
1681 54 : CPLStrdup(CPLResetExtension(pszFilename, "hdr"));
1682 :
1683 : // Open the file.
1684 54 : fp = VSIFOpenL(pszHdrFilename, "wt");
1685 54 : if (fp == nullptr)
1686 : {
1687 0 : CPLError(CE_Failure, CPLE_OpenFailed,
1688 : "Attempt to create file `%s' failed.", pszHdrFilename);
1689 0 : CPLFree(pszHdrFilename);
1690 0 : return nullptr;
1691 : }
1692 :
1693 : // Decide how many bits the file should have.
1694 54 : int nBits = GDALGetDataTypeSize(eType);
1695 :
1696 54 : if (CSLFetchNameValue(papszParamList, "NBITS") != nullptr)
1697 1 : nBits = atoi(CSLFetchNameValue(papszParamList, "NBITS"));
1698 :
1699 54 : const int nRowBytes = (nBits * nXSize + 7) / 8;
1700 :
1701 : // Check for signed byte.
1702 54 : const char *pszPixelType = CSLFetchNameValue(papszParamList, "PIXELTYPE");
1703 54 : if (pszPixelType == nullptr)
1704 53 : pszPixelType = "";
1705 :
1706 : // Write out the raw definition for the dataset as a whole.
1707 54 : bOK &= VSIFPrintfL(fp, "BYTEORDER I\n") >= 0;
1708 54 : bOK &= VSIFPrintfL(fp, "LAYOUT BIL\n") >= 0;
1709 54 : bOK &= VSIFPrintfL(fp, "NROWS %d\n", nYSize) >= 0;
1710 54 : bOK &= VSIFPrintfL(fp, "NCOLS %d\n", nXSize) >= 0;
1711 54 : bOK &= VSIFPrintfL(fp, "NBANDS %d\n", nBandsIn) >= 0;
1712 54 : bOK &= VSIFPrintfL(fp, "NBITS %d\n", nBits) >= 0;
1713 54 : bOK &= VSIFPrintfL(fp, "BANDROWBYTES %d\n", nRowBytes) >= 0;
1714 54 : bOK &= VSIFPrintfL(fp, "TOTALROWBYTES %d\n", nRowBytes * nBandsIn) >= 0;
1715 :
1716 54 : if (eType == GDT_Float32)
1717 5 : bOK &= VSIFPrintfL(fp, "PIXELTYPE FLOAT\n") >= 0;
1718 49 : else if (eType == GDT_Int8 || eType == GDT_Int16 || eType == GDT_Int32)
1719 10 : bOK &= VSIFPrintfL(fp, "PIXELTYPE SIGNEDINT\n") >= 0;
1720 39 : else if (eType == GDT_Byte && EQUAL(pszPixelType, "SIGNEDBYTE"))
1721 1 : bOK &= VSIFPrintfL(fp, "PIXELTYPE SIGNEDINT\n") >= 0;
1722 : else
1723 38 : bOK &= VSIFPrintfL(fp, "PIXELTYPE UNSIGNEDINT\n") >= 0;
1724 :
1725 54 : if (VSIFCloseL(fp) != 0)
1726 0 : bOK = false;
1727 :
1728 54 : CPLFree(pszHdrFilename);
1729 :
1730 54 : if (!bOK)
1731 0 : return nullptr;
1732 :
1733 108 : GDALOpenInfo oOpenInfo(pszFilename, GA_Update);
1734 54 : return Open(&oOpenInfo, false);
1735 : }
1736 :
1737 : /************************************************************************/
1738 : /* CreateCopy() */
1739 : /************************************************************************/
1740 :
1741 39 : GDALDataset *EHdrDataset::CreateCopy(const char *pszFilename,
1742 : GDALDataset *poSrcDS, int bStrict,
1743 : char **papszOptions,
1744 : GDALProgressFunc pfnProgress,
1745 : void *pProgressData)
1746 :
1747 : {
1748 39 : const int nBands = poSrcDS->GetRasterCount();
1749 39 : if (nBands == 0)
1750 : {
1751 1 : CPLError(CE_Failure, CPLE_NotSupported,
1752 : "EHdr driver does not support source dataset without any "
1753 : "bands.");
1754 1 : return nullptr;
1755 : }
1756 :
1757 38 : char **papszAdjustedOptions = CSLDuplicate(papszOptions);
1758 :
1759 : // Ensure we pass on NBITS and PIXELTYPE structure information.
1760 38 : auto poSrcBand = poSrcDS->GetRasterBand(1);
1761 38 : if (poSrcBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE") != nullptr &&
1762 0 : CSLFetchNameValue(papszOptions, "NBITS") == nullptr)
1763 : {
1764 0 : papszAdjustedOptions = CSLSetNameValue(
1765 : papszAdjustedOptions, "NBITS",
1766 0 : poSrcBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE"));
1767 : }
1768 :
1769 62 : if (poSrcBand->GetRasterDataType() == GDT_Byte &&
1770 24 : CSLFetchNameValue(papszOptions, "PIXELTYPE") == nullptr)
1771 : {
1772 24 : poSrcBand->EnablePixelTypeSignedByteWarning(false);
1773 : const char *pszPixelType =
1774 24 : poSrcBand->GetMetadataItem("PIXELTYPE", "IMAGE_STRUCTURE");
1775 24 : poSrcBand->EnablePixelTypeSignedByteWarning(true);
1776 24 : if (pszPixelType != nullptr)
1777 : {
1778 1 : papszAdjustedOptions = CSLSetNameValue(papszAdjustedOptions,
1779 : "PIXELTYPE", pszPixelType);
1780 : }
1781 : }
1782 :
1783 : // Proceed with normal copying using the default createcopy operators.
1784 : GDALDriver *poDriver =
1785 38 : reinterpret_cast<GDALDriver *>(GDALGetDriverByName("EHdr"));
1786 :
1787 38 : GDALDataset *poOutDS = poDriver->DefaultCreateCopy(
1788 : pszFilename, poSrcDS, bStrict, papszAdjustedOptions, pfnProgress,
1789 : pProgressData);
1790 38 : CSLDestroy(papszAdjustedOptions);
1791 :
1792 38 : if (poOutDS != nullptr)
1793 20 : poOutDS->FlushCache(false);
1794 :
1795 38 : return poOutDS;
1796 : }
1797 :
1798 : /************************************************************************/
1799 : /* GetNoDataValue() */
1800 : /************************************************************************/
1801 :
1802 100 : double EHdrRasterBand::GetNoDataValue(int *pbSuccess)
1803 : {
1804 100 : if (pbSuccess)
1805 100 : *pbSuccess = bNoDataSet;
1806 :
1807 100 : if (bNoDataSet)
1808 1 : return dfNoData;
1809 :
1810 99 : return RawRasterBand::GetNoDataValue(pbSuccess);
1811 : }
1812 :
1813 : /************************************************************************/
1814 : /* GetMinimum() */
1815 : /************************************************************************/
1816 :
1817 3 : double EHdrRasterBand::GetMinimum(int *pbSuccess)
1818 : {
1819 3 : if (pbSuccess != nullptr)
1820 3 : *pbSuccess = (minmaxmeanstddev & HAS_MIN_FLAG) != 0;
1821 :
1822 3 : if (minmaxmeanstddev & HAS_MIN_FLAG)
1823 2 : return dfMin;
1824 :
1825 1 : return RawRasterBand::GetMinimum(pbSuccess);
1826 : }
1827 :
1828 : /************************************************************************/
1829 : /* GetMaximum() */
1830 : /************************************************************************/
1831 :
1832 2 : double EHdrRasterBand::GetMaximum(int *pbSuccess)
1833 : {
1834 2 : if (pbSuccess != nullptr)
1835 2 : *pbSuccess = (minmaxmeanstddev & HAS_MAX_FLAG) != 0;
1836 :
1837 2 : if (minmaxmeanstddev & HAS_MAX_FLAG)
1838 1 : return dfMax;
1839 :
1840 1 : return RawRasterBand::GetMaximum(pbSuccess);
1841 : }
1842 :
1843 : /************************************************************************/
1844 : /* GetStatistics() */
1845 : /************************************************************************/
1846 :
1847 6 : CPLErr EHdrRasterBand::GetStatistics(int bApproxOK, int bForce, double *pdfMin,
1848 : double *pdfMax, double *pdfMean,
1849 : double *pdfStdDev)
1850 : {
1851 6 : if (!(GetMetadataItem("STATISTICS_APPROXIMATE") && !bApproxOK))
1852 : {
1853 5 : if ((minmaxmeanstddev & HAS_ALL_FLAGS) == HAS_ALL_FLAGS)
1854 : {
1855 1 : if (pdfMin)
1856 1 : *pdfMin = dfMin;
1857 1 : if (pdfMax)
1858 1 : *pdfMax = dfMax;
1859 1 : if (pdfMean)
1860 1 : *pdfMean = dfMean;
1861 1 : if (pdfStdDev)
1862 1 : *pdfStdDev = dfStdDev;
1863 1 : return CE_None;
1864 : }
1865 : }
1866 :
1867 5 : const CPLErr eErr = RawRasterBand::GetStatistics(
1868 : bApproxOK, bForce, &dfMin, &dfMax, &dfMean, &dfStdDev);
1869 5 : if (eErr != CE_None)
1870 2 : return eErr;
1871 :
1872 3 : EHdrDataset *poEDS = reinterpret_cast<EHdrDataset *>(poDS);
1873 :
1874 3 : minmaxmeanstddev = HAS_ALL_FLAGS;
1875 :
1876 3 : if (!bApproxOK && poEDS->RewriteSTX() != CE_None)
1877 0 : RawRasterBand::SetStatistics(dfMin, dfMax, dfMean, dfStdDev);
1878 :
1879 3 : if (pdfMin)
1880 3 : *pdfMin = dfMin;
1881 3 : if (pdfMax)
1882 3 : *pdfMax = dfMax;
1883 3 : if (pdfMean)
1884 3 : *pdfMean = dfMean;
1885 3 : if (pdfStdDev)
1886 3 : *pdfStdDev = dfStdDev;
1887 :
1888 3 : return CE_None;
1889 : }
1890 :
1891 : /************************************************************************/
1892 : /* SetStatistics() */
1893 : /************************************************************************/
1894 :
1895 3 : CPLErr EHdrRasterBand::SetStatistics(double dfMinIn, double dfMaxIn,
1896 : double dfMeanIn, double dfStdDevIn)
1897 : {
1898 : // Avoid churn if nothing is changing.
1899 3 : if (dfMin == dfMinIn && dfMax == dfMaxIn && dfMean == dfMeanIn &&
1900 1 : dfStdDev == dfStdDevIn)
1901 1 : return CE_None;
1902 :
1903 2 : dfMin = dfMinIn;
1904 2 : dfMax = dfMaxIn;
1905 2 : dfMean = dfMeanIn;
1906 2 : dfStdDev = dfStdDevIn;
1907 :
1908 : // marks stats valid
1909 2 : minmaxmeanstddev = HAS_ALL_FLAGS;
1910 :
1911 2 : EHdrDataset *poEDS = reinterpret_cast<EHdrDataset *>(poDS);
1912 :
1913 2 : if (GetMetadataItem("STATISTICS_APPROXIMATE") == nullptr)
1914 : {
1915 2 : if (GetMetadataItem("STATISTICS_MINIMUM"))
1916 : {
1917 0 : SetMetadataItem("STATISTICS_MINIMUM", nullptr);
1918 0 : SetMetadataItem("STATISTICS_MAXIMUM", nullptr);
1919 0 : SetMetadataItem("STATISTICS_MEAN", nullptr);
1920 0 : SetMetadataItem("STATISTICS_STDDEV", nullptr);
1921 : }
1922 2 : return poEDS->RewriteSTX();
1923 : }
1924 :
1925 0 : return RawRasterBand::SetStatistics(dfMinIn, dfMaxIn, dfMeanIn, dfStdDevIn);
1926 : }
1927 :
1928 : /************************************************************************/
1929 : /* GetColorTable() */
1930 : /************************************************************************/
1931 :
1932 13 : GDALColorTable *EHdrRasterBand::GetColorTable()
1933 : {
1934 13 : return m_poColorTable.get();
1935 : }
1936 :
1937 : /************************************************************************/
1938 : /* SetColorTable() */
1939 : /************************************************************************/
1940 :
1941 6 : CPLErr EHdrRasterBand::SetColorTable(GDALColorTable *poNewCT)
1942 : {
1943 6 : if (poNewCT == nullptr)
1944 2 : m_poColorTable.reset();
1945 : else
1946 4 : m_poColorTable.reset(poNewCT->Clone());
1947 :
1948 6 : reinterpret_cast<EHdrDataset *>(poDS)->bCLRDirty = true;
1949 :
1950 6 : return CE_None;
1951 : }
1952 :
1953 : /************************************************************************/
1954 : /* GetDefaultRAT() */
1955 : /************************************************************************/
1956 :
1957 13 : GDALRasterAttributeTable *EHdrRasterBand::GetDefaultRAT()
1958 : {
1959 13 : return m_poRAT.get();
1960 : }
1961 :
1962 : /************************************************************************/
1963 : /* SetDefaultRAT() */
1964 : /************************************************************************/
1965 :
1966 3 : CPLErr EHdrRasterBand::SetDefaultRAT(const GDALRasterAttributeTable *poRAT)
1967 : {
1968 3 : if (poRAT)
1969 : {
1970 3 : if (!(poRAT->GetColumnCount() == 4 &&
1971 1 : poRAT->GetTypeOfCol(0) == GFT_Integer &&
1972 1 : poRAT->GetTypeOfCol(1) == GFT_Integer &&
1973 1 : poRAT->GetTypeOfCol(2) == GFT_Integer &&
1974 1 : poRAT->GetTypeOfCol(3) == GFT_Integer &&
1975 1 : poRAT->GetUsageOfCol(0) == GFU_Generic &&
1976 1 : poRAT->GetUsageOfCol(1) == GFU_Red &&
1977 1 : poRAT->GetUsageOfCol(2) == GFU_Green &&
1978 1 : poRAT->GetUsageOfCol(3) == GFU_Blue))
1979 : {
1980 1 : CPLError(CE_Warning, CPLE_NotSupported,
1981 : "Unsupported type of RAT: "
1982 : "only value,R,G,B ones are supported");
1983 1 : return CE_Failure;
1984 : }
1985 : }
1986 :
1987 2 : if (poRAT == nullptr)
1988 1 : m_poRAT.reset();
1989 : else
1990 1 : m_poRAT.reset(poRAT->Clone());
1991 :
1992 2 : reinterpret_cast<EHdrDataset *>(poDS)->bCLRDirty = true;
1993 :
1994 2 : return CE_None;
1995 : }
1996 :
1997 : /************************************************************************/
1998 : /* GDALRegister_EHdr() */
1999 : /************************************************************************/
2000 :
2001 1595 : void GDALRegister_EHdr()
2002 :
2003 : {
2004 1595 : if (GDALGetDriverByName("EHdr") != nullptr)
2005 302 : return;
2006 :
2007 1293 : GDALDriver *poDriver = new GDALDriver();
2008 :
2009 1293 : poDriver->SetDescription("EHdr");
2010 1293 : poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
2011 1293 : poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, "ESRI .hdr Labelled");
2012 1293 : poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/ehdr.html");
2013 1293 : poDriver->SetMetadataItem(GDAL_DMD_EXTENSION, "bil");
2014 1293 : poDriver->SetMetadataItem(GDAL_DMD_CREATIONDATATYPES,
2015 1293 : "Byte Int8 Int16 UInt16 Int32 UInt32 Float32");
2016 :
2017 1293 : poDriver->SetMetadataItem(
2018 : GDAL_DMD_CREATIONOPTIONLIST,
2019 : "<CreationOptionList>"
2020 : " <Option name='NBITS' type='int' description='Special pixel bits "
2021 : "(1-7)'/>"
2022 : " <Option name='PIXELTYPE' type='string' description='By setting "
2023 : "this to SIGNEDBYTE, a new Byte file can be forced to be written as "
2024 : "signed byte'/>"
2025 1293 : "</CreationOptionList>");
2026 :
2027 1293 : poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
2028 1293 : poDriver->pfnOpen = EHdrDataset::Open;
2029 1293 : poDriver->pfnCreate = EHdrDataset::Create;
2030 1293 : poDriver->pfnCreateCopy = EHdrDataset::CreateCopy;
2031 :
2032 1293 : GetGDALDriverManager()->RegisterDriver(poDriver);
2033 : }
|