Line data Source code
1 : /******************************************************************************
2 : *
3 : * Project: GDAL
4 : * Purpose: Planetary drivers
5 : * Author: Even Rouault
6 : *
7 : ******************************************************************************
8 : * Copyright (c) 2023, Even Rouault
9 : *
10 : * SPDX-License-Identifier: MIT
11 : ****************************************************************************/
12 :
13 : #include "pdsdrivercore.h"
14 :
15 : #include "nasakeywordhandler.h"
16 :
17 : /************************************************************************/
18 : /* GetVICARLabelOffsetFromPDS3() */
19 : /************************************************************************/
20 :
21 5 : vsi_l_offset GetVICARLabelOffsetFromPDS3(const char *pszHdr, VSILFILE *fp,
22 : std::string &osVICARHeader)
23 : {
24 5 : const char *pszPDSVersionID = strstr(pszHdr, "PDS_VERSION_ID");
25 5 : int nOffset = 0;
26 5 : if (pszPDSVersionID)
27 5 : nOffset = static_cast<int>(pszPDSVersionID - pszHdr);
28 :
29 10 : NASAKeywordHandler oKeywords;
30 5 : if (oKeywords.Ingest(fp, nOffset))
31 : {
32 : const int nRecordBytes =
33 5 : atoi(oKeywords.GetKeyword("RECORD_BYTES", "0"));
34 : const int nImageHeader =
35 5 : atoi(oKeywords.GetKeyword("^IMAGE_HEADER", "0"));
36 5 : if (nRecordBytes > 0 && nImageHeader > 0)
37 : {
38 5 : const auto nImgHeaderOffset =
39 5 : static_cast<vsi_l_offset>(nImageHeader - 1) * nRecordBytes;
40 5 : osVICARHeader.resize(1024);
41 : size_t nMemb;
42 5 : if (VSIFSeekL(fp, nImgHeaderOffset, SEEK_SET) == 0 &&
43 5 : (nMemb = VSIFReadL(&osVICARHeader[0], 1, osVICARHeader.size(),
44 10 : fp)) != 0 &&
45 5 : osVICARHeader.find("LBLSIZE") != std::string::npos)
46 : {
47 5 : osVICARHeader.resize(nMemb);
48 5 : return nImgHeaderOffset;
49 : }
50 : }
51 : }
52 0 : return 0;
53 : }
54 :
55 : /************************************************************************/
56 : /* PDSDriverIdentify() */
57 : /************************************************************************/
58 :
59 60100 : int PDSDriverIdentify(GDALOpenInfo *poOpenInfo)
60 :
61 : {
62 60100 : if (poOpenInfo->pabyHeader == nullptr || poOpenInfo->fpL == nullptr)
63 54558 : return FALSE;
64 :
65 5542 : const char *pszHdr = reinterpret_cast<char *>(poOpenInfo->pabyHeader);
66 5542 : if (strstr(pszHdr, "PDS_VERSION_ID") == nullptr &&
67 5465 : strstr(pszHdr, "ODL_VERSION_ID") == nullptr)
68 : {
69 5465 : return FALSE;
70 : }
71 :
72 : // Some PDS3 images include a VICAR header pointed by ^IMAGE_HEADER.
73 : // If the user sets GDAL_TRY_PDS3_WITH_VICAR=YES, then we will gracefully
74 : // hand over the file to the VICAR dataset.
75 154 : std::string unused;
76 77 : if (CPLTestBool(CPLGetConfigOption("GDAL_TRY_PDS3_WITH_VICAR", "NO")) &&
77 78 : !STARTS_WITH(poOpenInfo->pszFilename, "/vsisubfile/") &&
78 1 : GetVICARLabelOffsetFromPDS3(pszHdr, poOpenInfo->fpL, unused) > 0)
79 : {
80 1 : CPLDebug("PDS3", "File is detected to have a VICAR header. "
81 : "Handing it over to the VICAR driver");
82 1 : return FALSE;
83 : }
84 :
85 76 : return TRUE;
86 : }
87 :
88 : /************************************************************************/
89 : /* PDSDriverSetCommonMetadata() */
90 : /************************************************************************/
91 :
92 1653 : void PDSDriverSetCommonMetadata(GDALDriver *poDriver)
93 : {
94 1653 : poDriver->SetDescription(PDS_DRIVER_NAME);
95 1653 : poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
96 1653 : poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, "NASA Planetary Data System");
97 1653 : poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/pds.html");
98 1653 : poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
99 :
100 1653 : poDriver->pfnIdentify = PDSDriverIdentify;
101 1653 : poDriver->SetMetadataItem(GDAL_DCAP_OPEN, "YES");
102 1653 : }
103 :
104 : /************************************************************************/
105 : /* PDS4DriverIdentify() */
106 : /************************************************************************/
107 :
108 70748 : int PDS4DriverIdentify(GDALOpenInfo *poOpenInfo)
109 : {
110 70748 : if (STARTS_WITH_CI(poOpenInfo->pszFilename, "PDS4:"))
111 30 : return TRUE;
112 70718 : if (poOpenInfo->nHeaderBytes == 0)
113 57144 : return FALSE;
114 :
115 13574 : const auto HasProductSomethingRootElement = [](const char *pszStr)
116 : {
117 26700 : return strstr(pszStr, "Product_Observational") != nullptr ||
118 26700 : strstr(pszStr, "Product_Ancillary") != nullptr ||
119 26700 : strstr(pszStr, "Product_Collection") != nullptr;
120 : };
121 13574 : const auto HasPDS4Schema = [](const char *pszStr)
122 13574 : { return strstr(pszStr, "://pds.nasa.gov/pds4/pds/v1") != nullptr; };
123 :
124 13574 : for (int i = 0; i < 2; ++i)
125 : {
126 13574 : const char *pszHeader =
127 : reinterpret_cast<const char *>(poOpenInfo->pabyHeader);
128 13574 : int nMatches = 0;
129 13574 : if (HasProductSomethingRootElement(pszHeader))
130 450 : nMatches++;
131 13574 : if (HasPDS4Schema(pszHeader))
132 450 : nMatches++;
133 13574 : if (nMatches == 2)
134 : {
135 450 : return TRUE;
136 : }
137 13124 : if (i == 0)
138 : {
139 13124 : if (nMatches == 0 || poOpenInfo->nHeaderBytes >= 8192)
140 : break;
141 : // If we have found one of the 2 matching elements to identify
142 : // PDS4 products, but have only ingested the default 1024 bytes,
143 : // then try to ingest more.
144 0 : poOpenInfo->TryToIngest(8192);
145 : }
146 : }
147 13124 : return FALSE;
148 : }
149 :
150 : /************************************************************************/
151 : /* PDS4DriverSetCommonMetadata() */
152 : /************************************************************************/
153 :
154 1653 : void PDS4DriverSetCommonMetadata(GDALDriver *poDriver)
155 : {
156 1653 : poDriver->SetDescription(PDS4_DRIVER_NAME);
157 1653 : poDriver->SetMetadataItem(GDAL_DCAP_VECTOR, "YES");
158 1653 : poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
159 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATE_LAYER, "YES");
160 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATE_FIELD, "YES");
161 1653 : poDriver->SetMetadataItem(GDAL_DCAP_DELETE_FIELD, "YES");
162 1653 : poDriver->SetMetadataItem(GDAL_DCAP_REORDER_FIELDS, "YES");
163 1653 : poDriver->SetMetadataItem(GDAL_DMD_ALTER_FIELD_DEFN_FLAGS,
164 1653 : "Name Type WidthPrecision");
165 1653 : poDriver->SetMetadataItem(GDAL_DCAP_Z_GEOMETRIES, "YES");
166 :
167 1653 : poDriver->SetMetadataItem(GDAL_DMD_LONGNAME,
168 1653 : "NASA Planetary Data System 4");
169 1653 : poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/pds4.html");
170 1653 : poDriver->SetMetadataItem(GDAL_DMD_EXTENSION, "xml");
171 1653 : poDriver->SetMetadataItem(GDAL_DMD_CREATIONDATATYPES,
172 : "Byte Int8 UInt16 Int16 UInt32 Int32 Float32 "
173 1653 : "Float64 CFloat32 CFloat64");
174 1653 : poDriver->SetMetadataItem(GDAL_DMD_OPENOPTIONLIST, "<OpenOptionList/>");
175 1653 : poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
176 1653 : poDriver->SetMetadataItem(GDAL_DMD_SUBDATASETS, "YES");
177 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATE_SUBDATASETS, "YES");
178 1653 : poDriver->SetMetadataItem(GDAL_DMD_SUPPORTED_SQL_DIALECTS, "OGRSQL SQLITE");
179 :
180 1653 : poDriver->SetMetadataItem(
181 : GDAL_DMD_OPENOPTIONLIST,
182 : "<OpenOptionList>"
183 : " <Option name='LAT' type='string' scope='vector' description="
184 : "'Name of a field containing a Latitude value' default='Latitude'/>"
185 : " <Option name='LONG' type='string' scope='vector' description="
186 : "'Name of a field containing a Longitude value' default='Longitude'/>"
187 : " <Option name='ALT' type='string' scope='vector' description="
188 : "'Name of a field containing a Altitude value' default='Altitude'/>"
189 : " <Option name='WKT' type='string' scope='vector' description="
190 : "'Name of a field containing a geometry encoded in the WKT format' "
191 : "default='WKT'/>"
192 : " <Option name='KEEP_GEOM_COLUMNS' scope='vector' type='boolean' "
193 : "description="
194 : "'whether to add original x/y/geometry columns as regular fields.' "
195 : "default='NO' />"
196 1653 : "</OpenOptionList>");
197 :
198 1653 : poDriver->SetMetadataItem(
199 : GDAL_DMD_CREATIONOPTIONLIST,
200 : "<CreationOptionList>"
201 : " <Option name='IMAGE_FILENAME' type='string' scope='raster' "
202 : "description="
203 : "'Image filename'/>"
204 : " <Option name='IMAGE_EXTENSION' type='string' scope='raster' "
205 : "description="
206 : "'Extension of the binary raw/geotiff file'/>"
207 : " <Option name='CREATE_LABEL_ONLY' scope='raster' type='boolean' "
208 : "description="
209 : "'whether to create only the XML label when converting from an "
210 : "existing raw format.' default='NO' />"
211 : " <Option name='IMAGE_FORMAT' type='string-select' scope='raster' "
212 : "description='Format of the image file' default='RAW'>"
213 : " <Value>RAW</Value>"
214 : " <Value>GEOTIFF</Value>"
215 : " </Option>"
216 : #ifdef notdef
217 : " <Option name='GEOTIFF_OPTIONS' type='string' scope='raster' "
218 : "description='Comma separated list of KEY=VALUE tuples to forward "
219 : "to the GeoTIFF driver'/>"
220 : #endif
221 : " <Option name='INTERLEAVE' type='string-select' scope='raster' "
222 : "description="
223 : "'Pixel organization' default='BSQ'>"
224 : " <Value>BSQ</Value>"
225 : " <Value>BIP</Value>"
226 : " <Value>BIL</Value>"
227 : " </Option>"
228 : " <Option name='VAR_*' type='string' scope='raster,vector' "
229 : "description="
230 : "'Value to substitute to a variable in the template'/>"
231 : " <Option name='TEMPLATE' type='string' scope='raster,vector' "
232 : "description="
233 : "'.xml template to use'/>"
234 : " <Option name='USE_SRC_LABEL' type='boolean' scope='raster' "
235 : "description='Whether to use source label in PDS4 to PDS4 conversions' "
236 : "default='YES'/>"
237 : " <Option name='LATITUDE_TYPE' type='string-select' "
238 : "scope='raster,vector' "
239 : "description='Value of latitude_type' default='Planetocentric'>"
240 : " <Value>Planetocentric</Value>"
241 : " <Value>Planetographic</Value>"
242 : " </Option>"
243 : " <Option name='LONGITUDE_DIRECTION' type='string-select' "
244 : "scope='raster,vector' "
245 : "description='Value of longitude_direction' "
246 : "default='Positive East'>"
247 : " <Value>Positive East</Value>"
248 : " <Value>Positive West</Value>"
249 : " </Option>"
250 : " <Option name='RADII' type='string' scope='raster,vector' "
251 : "description='Value of form "
252 : "semi_major_radius,semi_minor_radius to override the ones of the SRS'/>"
253 : " <Option name='ARRAY_TYPE' type='string-select' scope='raster' "
254 : "description='Name of the "
255 : "Array XML element' default='Array_3D_Image'>"
256 : " <Value>Array</Value>"
257 : " <Value>Array_2D</Value>"
258 : " <Value>Array_2D_Image</Value>"
259 : " <Value>Array_2D_Map</Value>"
260 : " <Value>Array_2D_Spectrum</Value>"
261 : " <Value>Array_3D</Value>"
262 : " <Value>Array_3D_Image</Value>"
263 : " <Value>Array_3D_Movie</Value>"
264 : " <Value>Array_3D_Spectrum</Value>"
265 : " </Option>"
266 : " <Option name='ARRAY_IDENTIFIER' type='string' scope='raster' "
267 : "description='Identifier to put in the Array element'/>"
268 : " <Option name='UNIT' type='string' scope='raster' "
269 : "description='Name of the unit of the array elements'/>"
270 : " <Option name='BOUNDING_DEGREES' type='string' scope='raster,vector' "
271 : "description='Manually set bounding box with the syntax "
272 : "west_lon,south_lat,east_lon,north_lat'/>"
273 1653 : "</CreationOptionList>");
274 :
275 1653 : poDriver->SetMetadataItem(
276 : GDAL_DS_LAYER_CREATIONOPTIONLIST,
277 : "<LayerCreationOptionList>"
278 : " <Option name='TABLE_TYPE' type='string-select' description='Type of "
279 : "table' default='DELIMITED'>"
280 : " <Value>DELIMITED</Value>"
281 : " <Value>CHARACTER</Value>"
282 : " <Value>BINARY</Value>"
283 : " </Option>"
284 : " <Option name='LINE_ENDING' type='string-select' description="
285 : "'end-of-line sequence. Only applies for "
286 : "TABLE_TYPE=DELIMITED/CHARACTER' "
287 : "default='CRLF'>"
288 : " <Value>CRLF</Value>"
289 : " <Value>LF</Value>"
290 : " </Option>"
291 : " <Option name='GEOM_COLUMNS' type='string-select' description='How "
292 : "geometry is encoded' default='AUTO'>"
293 : " <Value>AUTO</Value>"
294 : " <Value>WKT</Value>"
295 : " <Value>LONG_LAT</Value>"
296 : " </Option>"
297 : " <Option name='CREATE_VRT' type='boolean' description='Whether to "
298 : "generate "
299 : "a OGR VRT file. Only applies for TABLE_TYPE=DELIMITED' default='YES'/>"
300 : " <Option name='LAT' type='string' description="
301 : "'Name of a field containing a Latitude value' default='Latitude'/>"
302 : " <Option name='LONG' type='string' description="
303 : "'Name of a field containing a Longitude value' default='Longitude'/>"
304 : " <Option name='ALT' type='string' description="
305 : "'Name of a field containing a Altitude value' default='Altitude'/>"
306 : " <Option name='WKT' type='string' description="
307 : "'Name of a field containing a WKT value' default='WKT'/>"
308 : " <Option name='SAME_DIRECTORY' type='boolean' description="
309 : "'Whether table files should be created in the same "
310 : "directory, or in a subdirectory' default='NO'/>"
311 1653 : "</LayerCreationOptionList>");
312 :
313 1653 : poDriver->SetMetadataItem(
314 : GDAL_DMD_CREATIONFIELDDATATYPES,
315 1653 : "Integer Integer64 Real String Date DateTime Time");
316 1653 : poDriver->SetMetadataItem(GDAL_DMD_CREATIONFIELDDATASUBTYPES, "Boolean");
317 :
318 1653 : poDriver->pfnIdentify = PDS4DriverIdentify;
319 1653 : poDriver->SetMetadataItem(GDAL_DCAP_OPEN, "YES");
320 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATE, "YES");
321 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATECOPY, "YES");
322 :
323 1653 : poDriver->SetMetadataItem(GDAL_DCAP_UPDATE, "YES");
324 1653 : poDriver->SetMetadataItem(GDAL_DMD_UPDATE_ITEMS, "Features");
325 1653 : }
326 :
327 : /************************************************************************/
328 : /* ISIS2DriverIdentify() */
329 : /************************************************************************/
330 :
331 60076 : int ISIS2DriverIdentify(GDALOpenInfo *poOpenInfo)
332 : {
333 60076 : if (poOpenInfo->pabyHeader == nullptr)
334 54515 : return FALSE;
335 :
336 5561 : if (strstr(reinterpret_cast<const char *>(poOpenInfo->pabyHeader),
337 : "^QUBE") == nullptr)
338 5557 : return FALSE;
339 :
340 4 : return TRUE;
341 : }
342 :
343 : /************************************************************************/
344 : /* ISIS2DriverSetCommonMetadata() */
345 : /************************************************************************/
346 :
347 1653 : void ISIS2DriverSetCommonMetadata(GDALDriver *poDriver)
348 : {
349 1653 : poDriver->SetDescription(ISIS2_DRIVER_NAME);
350 1653 : poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
351 1653 : poDriver->SetMetadataItem(GDAL_DMD_LONGNAME,
352 1653 : "USGS Astrogeology ISIS cube (Version 2)");
353 1653 : poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/isis2.html");
354 1653 : poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
355 :
356 1653 : poDriver->pfnIdentify = ISIS2DriverIdentify;
357 1653 : poDriver->SetMetadataItem(GDAL_DCAP_OPEN, "YES");
358 1653 : }
359 :
360 : /************************************************************************/
361 : /* ISIS3DriverIdentify() */
362 : /************************************************************************/
363 :
364 60676 : int ISIS3DriverIdentify(GDALOpenInfo *poOpenInfo)
365 : {
366 60676 : if (poOpenInfo->fpL != nullptr && poOpenInfo->pabyHeader != nullptr &&
367 6045 : strstr(reinterpret_cast<const char *>(poOpenInfo->pabyHeader),
368 : "IsisCube") != nullptr)
369 531 : return TRUE;
370 :
371 60145 : return FALSE;
372 : }
373 :
374 : /************************************************************************/
375 : /* ISIS3DriverSetCommonMetadata() */
376 : /************************************************************************/
377 :
378 1653 : void ISIS3DriverSetCommonMetadata(GDALDriver *poDriver)
379 : {
380 1653 : poDriver->SetDescription(ISIS3_DRIVER_NAME);
381 1653 : poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
382 1653 : poDriver->SetMetadataItem(GDAL_DMD_LONGNAME,
383 1653 : "USGS Astrogeology ISIS cube (Version 3)");
384 1653 : poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/isis3.html");
385 1653 : poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
386 1653 : poDriver->SetMetadataItem(GDAL_DMD_EXTENSIONS, "lbl cub");
387 1653 : poDriver->SetMetadataItem(GDAL_DMD_CREATIONDATATYPES,
388 1653 : "Byte UInt16 Int16 Float32");
389 1653 : poDriver->SetMetadataItem(GDAL_DMD_OPENOPTIONLIST, "<OpenOptionList/>");
390 1653 : poDriver->SetMetadataItem(
391 : GDAL_DMD_CREATIONOPTIONLIST,
392 : "<CreationOptionList>"
393 : " <Option name='DATA_LOCATION' type='string-select' "
394 : "description='Location of pixel data' default='LABEL'>"
395 : " <Value>LABEL</Value>"
396 : " <Value>EXTERNAL</Value>"
397 : " <Value>GEOTIFF</Value>"
398 : " </Option>"
399 : " <Option name='GEOTIFF_AS_REGULAR_EXTERNAL' type='boolean' "
400 : "description='Whether the GeoTIFF file, if uncompressed, should be "
401 : "registered as a regular raw file' default='YES'/>"
402 : " <Option name='GEOTIFF_OPTIONS' type='string' "
403 : "description='Comma separated list of KEY=VALUE tuples to forward "
404 : "to the GeoTIFF driver'/>"
405 : " <Option name='EXTERNAL_FILENAME' type='string' "
406 : "description='Override default external filename. "
407 : "Only for DATA_LOCATION=EXTERNAL or GEOTIFF'/>"
408 : " <Option name='TILED' type='boolean' "
409 : "description='Whether the pixel data should be tiled' default='NO'/>"
410 : " <Option name='BLOCKXSIZE' type='int' "
411 : "description='Tile width' default='256'/>"
412 : " <Option name='BLOCKYSIZE' type='int' "
413 : "description='Tile height' default='256'/>"
414 : " <Option name='COMMENT' type='string' "
415 : "description='Comment to add into the label'/>"
416 : " <Option name='LATITUDE_TYPE' type='string-select' "
417 : "description='Value of Mapping.LatitudeType' default='Planetocentric'>"
418 : " <Value>Planetocentric</Value>"
419 : " <Value>Planetographic</Value>"
420 : " </Option>"
421 : " <Option name='LONGITUDE_DIRECTION' type='string-select' "
422 : "description='Value of Mapping.LongitudeDirection' "
423 : "default='PositiveEast'>"
424 : " <Value>PositiveEast</Value>"
425 : " <Value>PositiveWest</Value>"
426 : " </Option>"
427 : " <Option name='TARGET_NAME' type='string' description='Value of "
428 : "Mapping.TargetName'/>"
429 : " <Option name='FORCE_360' type='boolean' "
430 : "description='Whether to force longitudes in [0,360] range' "
431 : "default='NO'/>"
432 : " <Option name='WRITE_BOUNDING_DEGREES' type='boolean' "
433 : "description='Whether to write Min/MaximumLong/Latitude values' "
434 : "default='YES'/>"
435 : " <Option name='BOUNDING_DEGREES' type='string' "
436 : "description='Manually set bounding box with the syntax "
437 : "min_long,min_lat,max_long,max_lat'/>"
438 : " <Option name='USE_SRC_LABEL' type='boolean' "
439 : "description='Whether to use source label in ISIS3 to ISIS3 "
440 : "conversions' "
441 : "default='YES'/>"
442 : " <Option name='USE_SRC_MAPPING' type='boolean' "
443 : "description='Whether to use Mapping group from source label in "
444 : "ISIS3 to ISIS3 conversions' "
445 : "default='NO'/>"
446 : " <Option name='USE_SRC_HISTORY' type='boolean' "
447 : "description='Whether to use content pointed by the History object in "
448 : "ISIS3 to ISIS3 conversions' "
449 : "default='YES'/>"
450 : " <Option name='ADD_GDAL_HISTORY' type='boolean' "
451 : "description='Whether to add GDAL specific history in the content "
452 : "pointed "
453 : "by the History object in "
454 : "ISIS3 to ISIS3 conversions' "
455 : "default='YES'/>"
456 : " <Option name='GDAL_HISTORY' type='string' "
457 : "description='Manually defined GDAL history. Must be formatted as "
458 : "ISIS3 "
459 : "PDL. If not specified, it is automatically composed.'/>"
460 1653 : "</CreationOptionList>");
461 :
462 1653 : poDriver->pfnIdentify = ISIS3DriverIdentify;
463 1653 : poDriver->SetMetadataItem(GDAL_DCAP_OPEN, "YES");
464 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATE, "YES");
465 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATECOPY, "YES");
466 1653 : }
467 :
468 : /************************************************************************/
469 : /* VICARGetLabelOffset() */
470 : /************************************************************************/
471 :
472 70380 : vsi_l_offset VICARGetLabelOffset(GDALOpenInfo *poOpenInfo)
473 :
474 : {
475 70380 : if (poOpenInfo->pabyHeader == nullptr || poOpenInfo->fpL == nullptr)
476 57109 : return static_cast<vsi_l_offset>(-1);
477 :
478 5462 : const auto HasFoundVICARKeywords = [](const char *pszHeader)
479 : {
480 5692 : return strstr(pszHeader, "LBLSIZE") != nullptr &&
481 230 : strstr(pszHeader, "FORMAT") != nullptr &&
482 230 : strstr(pszHeader, "NL") != nullptr &&
483 5922 : strstr(pszHeader, "NS") != nullptr &&
484 5692 : strstr(pszHeader, "NB") != nullptr;
485 : };
486 :
487 26542 : std::string osHeader;
488 13271 : const char *pszHeader =
489 : reinterpret_cast<const char *>(poOpenInfo->pabyHeader);
490 : // Some PDS3 images include a VICAR header pointed by ^IMAGE_HEADER.
491 : // If the user sets GDAL_TRY_PDS3_WITH_VICAR=YES, then we will gracefully
492 : // hand over the file to the VICAR dataset.
493 13271 : vsi_l_offset nOffset = 0;
494 : const bool bTryPDS3WithVicar =
495 13274 : CPLTestBool(CPLGetConfigOption("GDAL_TRY_PDS3_WITH_VICAR", "NO")) &&
496 3 : !STARTS_WITH(poOpenInfo->pszFilename, "/vsisubfile/");
497 13271 : if (bTryPDS3WithVicar && (nOffset = GetVICARLabelOffsetFromPDS3(
498 : pszHeader, poOpenInfo->fpL, osHeader)) > 0)
499 : {
500 2 : pszHeader = osHeader.c_str();
501 : }
502 :
503 13271 : if ((poOpenInfo->nOpenFlags & GDAL_OF_RASTER) == 0 &&
504 7815 : (poOpenInfo->nOpenFlags & GDAL_OF_VECTOR) != 0)
505 : {
506 : // If opening in vector-only mode, then check when have NBB != 0
507 7813 : const char *pszNBB = strstr(pszHeader, "NBB");
508 7813 : if (pszNBB == nullptr)
509 7810 : return static_cast<vsi_l_offset>(-1);
510 3 : const char *pszEqualSign = strchr(pszNBB, '=');
511 3 : if (pszEqualSign == nullptr)
512 0 : return static_cast<vsi_l_offset>(-1);
513 3 : if (atoi(pszEqualSign + 1) == 0)
514 1 : return static_cast<vsi_l_offset>(-1);
515 : }
516 :
517 5460 : if (HasFoundVICARKeywords(pszHeader))
518 : {
519 : // If we find VICAR keywords, but the file starts with PDS_VERSION_ID,
520 : // it might be a PDS3 image that includes a VICAR header. Check if
521 : // this is the case.
522 228 : if (nOffset == 0 && STARTS_WITH(pszHeader, "PDS_VERSION_ID"))
523 : {
524 4 : if (!bTryPDS3WithVicar &&
525 2 : (!GDALGetDriverByName("PDS") ||
526 2 : poOpenInfo->IsSingleAllowedDriver("VICAR")))
527 : {
528 2 : const auto nOffset2 = GetVICARLabelOffsetFromPDS3(
529 : pszHeader, poOpenInfo->fpL, osHeader);
530 2 : if (nOffset2 > 0 && HasFoundVICARKeywords(osHeader.c_str()))
531 : {
532 2 : return nOffset2;
533 : }
534 : }
535 : }
536 226 : return nOffset;
537 : }
538 5232 : return static_cast<vsi_l_offset>(-1);
539 : }
540 :
541 : /************************************************************************/
542 : /* VICARDriverIdentify() */
543 : /************************************************************************/
544 :
545 70265 : static int VICARDriverIdentify(GDALOpenInfo *poOpenInfo)
546 : {
547 70265 : return VICARGetLabelOffset(poOpenInfo) != static_cast<vsi_l_offset>(-1);
548 : }
549 :
550 : /************************************************************************/
551 : /* VICARDriverSetCommonMetadata() */
552 : /************************************************************************/
553 :
554 1653 : void VICARDriverSetCommonMetadata(GDALDriver *poDriver)
555 : {
556 1653 : poDriver->SetDescription(VICAR_DRIVER_NAME);
557 1653 : poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
558 1653 : poDriver->SetMetadataItem(GDAL_DCAP_VECTOR, "YES");
559 1653 : poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, "MIPL VICAR file");
560 1653 : poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/vicar.html");
561 1653 : poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
562 1653 : poDriver->SetMetadataItem(GDAL_DMD_CREATIONDATATYPES,
563 1653 : "Byte Int16 Int32 Float32 Float64 CFloat32");
564 1653 : poDriver->SetMetadataItem(
565 : GDAL_DMD_CREATIONOPTIONLIST,
566 : "<CreationOptionList>"
567 : " <Option name='GEOREF_FORMAT' type='string-select' "
568 : "description='How to encode georeferencing information' "
569 : "default='MIPL'>"
570 : " <Value>MIPL</Value>"
571 : " <Value>GEOTIFF</Value>"
572 : " </Option>"
573 : " <Option name='COORDINATE_SYSTEM_NAME' type='string-select' "
574 : "description='Value of MAP.COORDINATE_SYSTEM_NAME' "
575 : "default='PLANETOCENTRIC'>"
576 : " <Value>PLANETOCENTRIC</Value>"
577 : " <Value>PLANETOGRAPHIC</Value>"
578 : " </Option>"
579 : " <Option name='POSITIVE_LONGITUDE_DIRECTION' type='string-select' "
580 : "description='Value of MAP.POSITIVE_LONGITUDE_DIRECTION' "
581 : "default='EAST'>"
582 : " <Value>EAST</Value>"
583 : " <Value>WEST</Value>"
584 : " </Option>"
585 : " <Option name='TARGET_NAME' type='string' description='Value of "
586 : "MAP.TARGET_NAME'/>"
587 : " <Option name='USE_SRC_LABEL' type='boolean' "
588 : "description='Whether to use source label in VICAR to VICAR "
589 : "conversions' "
590 : "default='YES'/>"
591 : " <Option name='USE_SRC_MAP' type='boolean' "
592 : "description='Whether to use MAP property from source label in "
593 : "VICAR to VICAR conversions' "
594 : "default='NO'/>"
595 : " <Option name='LABEL' type='string' "
596 : "description='Label to use, either as a JSON string or a filename "
597 : "containing one'/>"
598 : " <Option name='COMPRESS' type='string-select' "
599 : "description='Compression method' default='NONE'>"
600 : " <Value>NONE</Value>"
601 : " <Value>BASIC</Value>"
602 : " <Value>BASIC2</Value>"
603 : " </Option>"
604 1653 : "</CreationOptionList>");
605 :
606 1653 : poDriver->pfnIdentify = VICARDriverIdentify;
607 1653 : poDriver->SetMetadataItem(GDAL_DCAP_OPEN, "YES");
608 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATE, "YES");
609 1653 : poDriver->SetMetadataItem(GDAL_DCAP_CREATECOPY, "YES");
610 1653 : }
611 :
612 : /************************************************************************/
613 : /* DeclareDeferredPDSPlugin() */
614 : /************************************************************************/
615 :
616 : #ifdef PLUGIN_FILENAME
617 : void DeclareDeferredPDSPlugin()
618 : {
619 : if (GDALGetDriverByName(PDS_DRIVER_NAME) != nullptr)
620 : {
621 : return;
622 : }
623 : {
624 : auto poDriver = new GDALPluginDriverProxy(PLUGIN_FILENAME);
625 : #ifdef PLUGIN_INSTALLATION_MESSAGE
626 : poDriver->SetMetadataItem(GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE,
627 : PLUGIN_INSTALLATION_MESSAGE);
628 : #endif
629 : PDSDriverSetCommonMetadata(poDriver);
630 : GetGDALDriverManager()->DeclareDeferredPluginDriver(poDriver);
631 : }
632 : {
633 : auto poDriver = new GDALPluginDriverProxy(PLUGIN_FILENAME);
634 : #ifdef PLUGIN_INSTALLATION_MESSAGE
635 : poDriver->SetMetadataItem(GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE,
636 : PLUGIN_INSTALLATION_MESSAGE);
637 : #endif
638 : PDS4DriverSetCommonMetadata(poDriver);
639 : GetGDALDriverManager()->DeclareDeferredPluginDriver(poDriver);
640 : }
641 : {
642 : auto poDriver = new GDALPluginDriverProxy(PLUGIN_FILENAME);
643 : #ifdef PLUGIN_INSTALLATION_MESSAGE
644 : poDriver->SetMetadataItem(GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE,
645 : PLUGIN_INSTALLATION_MESSAGE);
646 : #endif
647 : ISIS2DriverSetCommonMetadata(poDriver);
648 : GetGDALDriverManager()->DeclareDeferredPluginDriver(poDriver);
649 : }
650 : {
651 : auto poDriver = new GDALPluginDriverProxy(PLUGIN_FILENAME);
652 : #ifdef PLUGIN_INSTALLATION_MESSAGE
653 : poDriver->SetMetadataItem(GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE,
654 : PLUGIN_INSTALLATION_MESSAGE);
655 : #endif
656 : ISIS3DriverSetCommonMetadata(poDriver);
657 : GetGDALDriverManager()->DeclareDeferredPluginDriver(poDriver);
658 : }
659 : {
660 : auto poDriver = new GDALPluginDriverProxy(PLUGIN_FILENAME);
661 : #ifdef PLUGIN_INSTALLATION_MESSAGE
662 : poDriver->SetMetadataItem(GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE,
663 : PLUGIN_INSTALLATION_MESSAGE);
664 : #endif
665 : VICARDriverSetCommonMetadata(poDriver);
666 : GetGDALDriverManager()->DeclareDeferredPluginDriver(poDriver);
667 : }
668 : }
669 : #endif
|
