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