Line data    Source code

       1             : /******************************************************************************
       2             :  *
       3             :  * Project:  OpenGIS Simple Features Reference Implementation
       4             :  * Purpose:  Implements Basis Universal / KTX2 driver.
       5             :  * Author:   Even Rouault, <even dot rouault at spatialys.com>
       6             :  *
       7             :  ******************************************************************************
       8             :  * Copyright (c) 2022, Even Rouault <even dot rouault at spatialys.com>
       9             :  *
      10             :  * Permission is hereby granted, free of charge, to any person obtaining a
      11             :  * copy of this software and associated documentation files (the "Software"),
      12             :  * to deal in the Software without restriction, including without limitation
      13             :  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
      14             :  * and/or sell copies of the Software, and to permit persons to whom the
      15             :  * Software is furnished to do so, subject to the following conditions:
      16             :  *
      17             :  * The above copyright notice and this permission notice shall be included
      18             :  * in all copies or substantial portions of the Software.
      19             :  *
      20             :  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
      21             :  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      22             :  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
      23             :  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      24             :  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
      25             :  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
      26             :  * DEALINGS IN THE SOFTWARE.
      27             :  ****************************************************************************/
      28             : 
      29             : #include "ktx2drivercore.h"
      30             : #include "commoncore.h"
      31             : 
      32             : /************************************************************************/
      33             : /*                     KTX2DriverIdentify()                             */
      34             : /************************************************************************/
      35             : 
      36       47770 : int KTX2DriverIdentify(GDALOpenInfo *poOpenInfo)
      37             : 
      38             : {
      39       47770 :     constexpr GByte KTX2Signature[] = {0xAB, 0x4B, 0x54, 0x58, 0x20, 0x32,
      40             :                                        0x30, 0xBB, 0x0D, 0x0A, 0x1A, 0x0A};
      41       47770 :     if (STARTS_WITH(poOpenInfo->pszFilename, "KTX2:"))
      42          16 :         return true;
      43       50327 :     return poOpenInfo->fpL != nullptr &&
      44        2573 :            poOpenInfo->nHeaderBytes >=
      45       50327 :                static_cast<int>(sizeof(KTX2Signature)) &&
      46        2389 :            memcmp(poOpenInfo->pabyHeader, KTX2Signature,
      47       47754 :                   sizeof(KTX2Signature)) == 0;
      48             : }
      49             : 
      50             : /************************************************************************/
      51             : /*                      KTX2DriverSetCommonMetadata()                   */
      52             : /************************************************************************/
      53             : 
      54        1230 : void KTX2DriverSetCommonMetadata(GDALDriver *poDriver)
      55             : {
      56        1230 :     poDriver->SetDescription(KTX2_DRIVER_NAME);
      57        1230 :     poDriver->SetMetadataItem(GDAL_DCAP_RASTER, "YES");
      58        1230 :     poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, "KTX2 texture format");
      59        1230 :     poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/raster/ktx2.html");
      60        1230 :     poDriver->SetMetadataItem(GDAL_DMD_EXTENSION, "ktx2");
      61        1230 :     poDriver->SetMetadataItem(GDAL_DMD_CREATIONDATATYPES, "Byte");
      62             : 
      63        1230 :     poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");
      64             : 
      65        1230 :     poDriver->SetMetadataItem(
      66             :         GDAL_DMD_CREATIONOPTIONLIST,
      67        2460 :         GDAL_KTX2_BASISU_GetCreationOptions(/* bIsKTX2 = */ true).c_str());
      68             : 
      69        1230 :     poDriver->pfnIdentify = KTX2DriverIdentify;
      70        1230 :     poDriver->SetMetadataItem(GDAL_DCAP_OPEN, "YES");
      71        1230 :     poDriver->SetMetadataItem(GDAL_DCAP_CREATECOPY, "YES");
      72        1230 : }
      73             : 
      74             : /************************************************************************/
      75             : /*                     DeclareDeferredKTX2Plugin()                      */
      76             : /************************************************************************/
      77             : 
      78             : #ifdef PLUGIN_FILENAME
      79        1523 : void DeclareDeferredKTX2Plugin()
      80             : {
      81        1523 :     if (GDALGetDriverByName(KTX2_DRIVER_NAME) != nullptr)
      82             :     {
      83         301 :         return;
      84             :     }
      85        1222 :     auto poDriver = new GDALPluginDriverProxy(PLUGIN_FILENAME);
      86             : #ifdef PLUGIN_INSTALLATION_MESSAGE
      87             :     poDriver->SetMetadataItem(GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE,
      88             :                               PLUGIN_INSTALLATION_MESSAGE);
      89             : #endif
      90        1222 :     KTX2DriverSetCommonMetadata(poDriver);
      91        1222 :     GetGDALDriverManager()->DeclareDeferredPluginDriver(poDriver);
      92             : }
      93             : #endif