gdal_mdreader.h

/******************************************************************************
 * $Id: gdal_mdreader.h e37e476c4cf8f4b0df8995e0d95d5d672fca1a9b 2018-05-05 16:54:18 +0200 Even Rouault $
 *
 * Project:  GDAL Core
 * Purpose:  Read metadata (mainly the remote sensing imagery) from files of
 *           different providers like DigitalGlobe, GeoEye etc.
 * Author:   Dmitry Baryshnikov, polimax@mail.ru
 *
 ******************************************************************************
 * Copyright (c) 2014-2015, NextGIS info@nextgis.ru
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/

#ifndef GDAL_MDREADER_H_INCLUDED
#define GDAL_MDREADER_H_INCLUDED

#include "cpl_port.h"
#include "gdal_priv.h"

#define MD_DOMAIN_IMD "IMD"              
#define MD_DOMAIN_RPC "RPC"              
#define MD_DOMAIN_IMAGERY "IMAGERY"      
#define MD_DOMAIN_DEFAULT ""             
#define MD_NAME_ACQDATETIME "ACQUISITIONDATETIME"  
#define MD_NAME_SATELLITE   "SATELLITEID"          
#define MD_NAME_CLOUDCOVER  "CLOUDCOVER"           
#define MD_NAME_MDTYPE      "METADATATYPE"         
#define MD_DATETIMEFORMAT "%Y-%m-%d %H:%M:%S"      
#define MD_CLOUDCOVER_NA "999"           
#define RPC_LINE_OFF        "LINE_OFF"
#define RPC_SAMP_OFF        "SAMP_OFF"
#define RPC_LAT_OFF         "LAT_OFF"
#define RPC_LONG_OFF        "LONG_OFF"
#define RPC_HEIGHT_OFF      "HEIGHT_OFF"
#define RPC_LINE_SCALE      "LINE_SCALE"
#define RPC_SAMP_SCALE      "SAMP_SCALE"
#define RPC_LAT_SCALE       "LAT_SCALE"
#define RPC_LONG_SCALE      "LONG_SCALE"
#define RPC_HEIGHT_SCALE    "HEIGHT_SCALE"
#define RPC_LINE_NUM_COEFF  "LINE_NUM_COEFF"
#define RPC_LINE_DEN_COEFF  "LINE_DEN_COEFF"
#define RPC_SAMP_NUM_COEFF  "SAMP_NUM_COEFF"
#define RPC_SAMP_DEN_COEFF  "SAMP_DEN_COEFF"

/* Optional */
#define RPC_MIN_LONG        "MIN_LONG"
#define RPC_MIN_LAT         "MIN_LAT"
#define RPC_MAX_LONG        "MAX_LONG"
#define RPC_MAX_LAT         "MAX_LAT"

typedef enum {
    MDR_None     = 0x00000000,    
    MDR_DG       = 0x00000001,    
    MDR_GE       = 0x00000002,    
    MDR_OV       = 0x00000004,    
    MDR_PLEIADES = 0x00000008,    
    MDR_SPOT     = 0x00000010,    
    MDR_RDK1     = 0x00000020,    
    MDR_LS       = 0x00000040,    
    MDR_RE       = 0x00000080,    
    MDR_KOMPSAT  = 0x00000100,    
    MDR_EROS     = 0x00000200,    
    MDR_ALOS     = 0x00000400,    
    MDR_ANY  = MDR_DG | MDR_GE | MDR_OV | MDR_PLEIADES | MDR_SPOT | MDR_RDK1 |
               MDR_LS | MDR_RE | MDR_KOMPSAT | MDR_EROS | MDR_ALOS 
} MDReaders;

class GDALMDReaderBase{

    CPL_DISALLOW_COPY_ASSIGN(GDALMDReaderBase)

public:
    GDALMDReaderBase(const char *pszPath, char **papszSiblingFiles);
    virtual ~GDALMDReaderBase();

    virtual char ** GetMetadataDomain(const char *pszDomain);
    virtual bool FillMetadata(GDALMultiDomainMetadata* poMDMD);
    virtual bool HasRequiredFiles() const = 0;
    virtual char** GetMetadataFiles() const = 0;
protected:
    virtual void LoadMetadata();
    virtual time_t GetAcquisitionTimeFromString(const char* pszDateTime);
    virtual char** ReadXMLToList(CPLXMLNode* psNode, char** papszList,
                         const char* pszName = "");
    virtual char** AddXMLNameValueToList(char** papszList, const char *pszName,
                                         const char *pszValue);
protected:
    char **m_papszIMDMD = nullptr;
    char **m_papszRPCMD = nullptr;
    char **m_papszIMAGERYMD = nullptr;
    char **m_papszDEFAULTMD = nullptr;
    bool m_bIsMetadataLoad = false;
};

class CPL_DLL GDALMDReaderManager{

    CPL_DISALLOW_COPY_ASSIGN(GDALMDReaderManager)

public:
    GDALMDReaderManager();
    virtual ~GDALMDReaderManager();

    virtual GDALMDReaderBase* GetReader(const char *pszPath,
                                        char **papszSiblingFiles,
                                        GUInt32 nType = MDR_ANY);
protected:
    GDALMDReaderBase *m_pReader = nullptr;
};

// misc
CPLString CPLStrip(const CPLString& osString, const char cChar);
CPLString CPLStripQuotes(const CPLString& osString);
char** GDALLoadRPBFile( const CPLString& osFilePath );
char** GDALLoadRPCFile( const CPLString& osFilePath );
char** GDALLoadIMDFile( const CPLString& osFilePath );
bool GDALCheckFileHeader(const CPLString& soFilePath,
                               const char * pszTestString,
                               int nBufferSize = 256);

CPLErr GDALWriteRPBFile( const char *pszFilename, char **papszMD );
CPLErr GDALWriteRPCTXTFile( const char *pszFilename, char **papszMD );
CPLErr GDALWriteIMDFile( const char *pszFilename, char **papszMD );

#endif //GDAL_MDREADER_H_INCLUDED