/******************************************************************************

 *

 * Project:  VICAR Driver; JPL/MIPL VICAR Format

 * Purpose:  Implementation of VICARDataset

 * Author:   Even Rouault, <even.rouault at spatialys.com>

 *

 ******************************************************************************

 * Copyright (c) 2014, Sebastian Walter <sebastian dot walter at fu-berlin dot

 *de> Copyright (c) 2019, Even Rouault, <even.rouault at spatialys.com>

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/

#ifndef VICARDATASET_H

#define VICARDATASET_H

#include "cpl_string.h"

#include "gdal_frmts.h"

#include "ogr_spatialref.h"

#include "ogrsf_frmts.h"

#include "rawdataset.h"

#include "vicarkeywordhandler.h"

#include <array>

/************************************************************************/

/* ==================================================================== */

/*                             VICARDataset                             */

/* ==================================================================== */

/************************************************************************/

class VICARDataset final : public RawDataset

{

    friend class VICARRawRasterBand;

    friend class VICARBASICRasterBand;

    VSILFILE *fpImage = nullptr;

    VICARKeywordHandler oKeywords{};

    enum CompressMethod

    {

        COMPRESS_NONE,

        COMPRESS_BASIC,

        COMPRESS_BASIC2,

    };

    CompressMethod m_eCompress = COMPRESS_NONE;

    int m_nRecordSize = 0;

    vsi_l_offset m_nImageOffsetWithoutNBB = 0;

    int m_nLastRecordOffset = 0;

    std::vector<vsi_l_offset> m_anRecordOffsets{};  // for BASIC/BASIC2

    std::vector<GByte> m_abyCodedBuffer{};

    vsi_l_offset m_nLabelSize = 0;

    CPLJSONObject m_oJSonLabel{};

    CPLStringList m_aosVICARMD{};

    bool m_bGotTransform = false;

    GDALGeoTransform m_gt{};

    OGRSpatialReference m_oSRS{};

    std::unique_ptr<OGRLayer> m_poLayer{};

    bool m_bGeoRefFormatIsMIPL = true;

    CPLString m_osLatitudeType{};        // creation only

    CPLString m_osLongitudeDirection{};  // creation only

    CPLString m_osTargetName{};          // creation only

    bool m_bIsLabelWritten = true;       // creation only

    bool m_bUseSrcLabel = true;          // creation only

    bool m_bUseSrcMap = false;           // creation only

    bool m_bInitToNodata = false;        // creation only

    CPLJSONObject m_oSrcJSonLabel{};     // creation only

    const char *GetKeyword(const char *pszPath, const char *pszDefault = "");

    void WriteLabel();

    void PatchLabel();

    void BuildLabel();

    void InvalidateLabel();

    static VICARDataset *CreateInternal(const char *pszFilename, int nXSize,

                                        int nYSize, int nBands,

                                        GDALDataType eType,

                                        char **papszOptions);

    void ReadProjectionFromMapGroup();

    void BuildLabelPropertyMap(CPLJSONObject &oLabel);

#if defined(HAVE_TIFF) && defined(HAVE_GEOTIFF)

    void ReadProjectionFromGeoTIFFGroup();

    void BuildLabelPropertyGeoTIFF(CPLJSONObject &oLabel);

#endif

    CPLErr Close(GDALProgressFunc = nullptr, void * = nullptr) override;

    CPL_DISALLOW_COPY_ASSIGN(VICARDataset)

  public:

    VICARDataset();

    ~VICARDataset() override;

    CPLErr GetGeoTransform(GDALGeoTransform &gt) const override;

    CPLErr SetGeoTransform(const GDALGeoTransform &gt) override;

    const OGRSpatialReference *GetSpatialRef() const override;

    CPLErr SetSpatialRef(const OGRSpatialReference *poSRS) override;

    bool GetRawBinaryLayout(GDALDataset::RawBinaryLayout &) override;

    char **GetMetadataDomainList() override;

    char **GetMetadata(const char *pszDomain = "") override;

    CPLErr SetMetadata(char **papszMD, const char *pszDomain = "") override;

    int GetLayerCount() const override

    {

        return m_poLayer ? 1 : 0;

    }

    const OGRLayer *GetLayer(int i) const override

    {

        return (m_poLayer && i == 0) ? m_poLayer.get() : nullptr;

    }

    static GDALDataset *Open(GDALOpenInfo *);

    static GDALDataset *Create(const char *pszFilename, int nXSize, int nYSize,

                               int nBands, GDALDataType eType,

                               char **papszOptions);

    static GDALDataset *CreateCopy(const char *pszFilename,

                                   GDALDataset *poSrcDS, int bStrict,

                                   char **papszOptions,

                                   GDALProgressFunc pfnProgress,

                                   void *pProgressData);

    static GDALDataType GetDataTypeFromFormat(const char *pszFormat);

    static bool GetSpacings(const VICARKeywordHandler &keywords,

                            uint64_t &nPixelOffset, uint64_t &nLineOffset,

                            uint64_t &nBandOffset,

                            uint64_t &nImageOffsetWithoutNBB, uint64_t &nNBB,

                            uint64_t &nImageSize);

};

#endif  // VICARDATASET_H