///////////////////////////////////////////////////////////////////////////////
// $Id: test_gdal_gtiff.cpp,v 1.3 2006/12/06 15:39:13 mloskot Exp $
//
// Project:  C++ Test Suite for GDAL/OGR
// Purpose:  Test read/write functionality for GeoTIFF format.
//           Ported from gcore/tiff_read.py, gcore/tiff_write.py.
// Author:   Mateusz Loskot <mateusz@loskot.net>
// 
///////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2006, Mateusz Loskot <mateusz@loskot.net>
//  
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
// 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Library General Public License for more details.
// 
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the
// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.
///////////////////////////////////////////////////////////////////////////////
//
//  $Log: test_gdal_gtiff.cpp,v $
//  Revision 1.3  2006/12/06 15:39:13  mloskot
//  Added file header comment and copyright note.
//
//
///////////////////////////////////////////////////////////////////////////////
#include <tut.h> // TUT
#include <tut_gdal.h>
#include <gdal_common.h>
#include <gdal.h> // GDAL
#include <gdal_alg.h>
#include <gdal_priv.h>
#include <cpl_string.h>
#include <sstream> // C++
#include <string>
#include <vector>

namespace tut
{

    // Common fixture with test data
    struct test_gtiff_data
    {
        struct raster_t
        {
            std::string file_;
            int band_;
            int checksum_;
            raster_t(std::string const& f, int b, int c)
                : file_(f), band_(b), checksum_(c)
            {}
        };
        typedef std::vector<raster_t> rasters_t;

        GDALDriverH drv_;
        std::string drv_name_;
        std::string data_;
        std::string data_tmp_;
        rasters_t rasters_;

        test_gtiff_data()
            : drv_(NULL), drv_name_("GTiff")
        {
            drv_ = GDALGetDriverByName(drv_name_.c_str());

            // Compose data path for test group
            data_ = tut::common::data_basedir;
            data_tmp_ = tut::common::tmp_basedir;

            // Collection of test GeoTIFF rasters
            rasters_.push_back(raster_t("byte.tif", 1, 4672));
            rasters_.push_back(raster_t("int16.tif", 1, 4672));
            rasters_.push_back(raster_t("uint16.tif", 1, 4672));
            rasters_.push_back(raster_t("int32.tif", 1, 4672));
            rasters_.push_back(raster_t("uint32.tif", 1, 4672));
            rasters_.push_back(raster_t("float32.tif", 1, 4672));
            rasters_.push_back(raster_t("float64.tif", 1, 4672));
            rasters_.push_back(raster_t("cint16.tif", 1, 5028));
            rasters_.push_back(raster_t("cint32.tif", 1, 5028));
            rasters_.push_back(raster_t("cfloat32.tif", 1, 5028));
            rasters_.push_back(raster_t("cfloat64.tif", 1, 5028));
            rasters_.push_back(raster_t("utmsmall.tif", 1, 50054));
        }
    };

    // Register test group
    typedef test_group<test_gtiff_data> group;
    typedef group::object object;
    group test_gtiff_group("GDAL::GTiff");

    // Test driver availability
    template<>
    template<>
    void object::test<1>()
    {
        ensure("GDAL::GTiff driver not available", NULL != drv_);
    }

    // Test open dataset
    template<>
    template<>
    void object::test<2>()
    {
        rasters_t::const_iterator it;
        for (it = rasters_.begin(); it != rasters_.end(); ++it)
        {
            std::string file(data_ + SEP);
            file += it->file_;
            GDALDatasetH ds = GDALOpen(file.c_str(), GA_ReadOnly);
            ensure("Can't open dataset: " + file, NULL != ds);
            GDALClose(ds);
        }
    }

    // Test dataset checksums
    template<>
    template<>
    void object::test<3>()
    {
        rasters_t::const_iterator it;
        for (it = rasters_.begin(); it != rasters_.end(); ++it)
        {
            std::string file(data_ + SEP);
            file += it->file_;

            GDALDatasetH ds = GDALOpen(file.c_str(), GA_ReadOnly);
            ensure("Can't open dataset: " + file, NULL != ds);

            GDALRasterBandH band = GDALGetRasterBand(ds, it->band_);
            ensure("Can't get raster band", NULL != band);

            const int xsize = GDALGetRasterXSize(ds);
            const int ysize = GDALGetRasterYSize(ds);
            const int checksum = GDALChecksumImage(band, 0, 0, xsize, ysize);

            std::stringstream os;
            os << "Checksums for '" << file << "' not equal";
            ensure_equals(os.str().c_str(), it->checksum_, checksum);

            GDALClose(ds);
        }
    }

    // Test GeoTIFF driver metadata
    template<>
    template<>
    void object::test<4>()
    {
        const char* mdItem = GDALGetMetadataItem(drv_, "DMD_MIMETYPE", NULL);
        ensure("Can't fetch metadata", NULL != mdItem);

        ensure_equals("Invalid MIME type",
            std::string(mdItem), std::string("image/tiff"));
    }

    // Create a simple file by copying from an existing one
    template<>
    template<>
    void object::test<5>()
    {
        // Index of test file being copied
        const std::size_t fileIdx = 10;

        std::string src(data_ + SEP);
        src += rasters_.at(fileIdx).file_;
        GDALDatasetH dsSrc = GDALOpen(src.c_str(), GA_ReadOnly);
        ensure("Can't open source dataset: " + src, NULL != dsSrc);

        std::string dst(data_tmp_ + "\\test_2.tif");
        GDALDatasetH dsDst = NULL;
        dsDst = GDALCreateCopy(drv_, dst.c_str(), dsSrc, FALSE, NULL, NULL, NULL);
        ensure("Can't copy dataset", NULL != dsDst);

        GDALClose(dsDst);
        GDALClose(dsSrc);
      
        // Re-open copied dataset and test it
        dsDst = GDALOpen(dst.c_str(), GA_ReadOnly);
        GDALRasterBandH band = GDALGetRasterBand(dsDst, rasters_.at(fileIdx).band_);
        ensure("Can't get raster band", NULL != band);

        const int xsize = GDALGetRasterXSize(dsDst);
        const int ysize = GDALGetRasterYSize(dsDst);
        const int checksum = GDALChecksumImage(band, 0, 0, xsize, ysize);

        std::stringstream os;
        os << "Checksums for '" << dst << "' not equal";
        ensure_equals(os.str().c_str(), rasters_.at(fileIdx).checksum_, checksum);

        GDALClose(dsDst);
        GDALDeleteDataset(drv_, dst.c_str());
    }

    // Create a simple file by copying from an existing one using creation options
    template<>
    template<>
    void object::test<6>()
    {
        // Index of test file being copied
        const std::size_t fileIdx = 11;
        std::string src(data_ + SEP);
        src += rasters_.at(fileIdx).file_;
        GDALDatasetH dsSrc = GDALOpen(src.c_str(), GA_ReadOnly);
        ensure("Can't open source dataset: " + src, NULL != dsSrc);

        std::string dst(data_tmp_ + "\\test_3.tif");

        char** options = NULL;
        options = CSLSetNameValue(options, "TILED", "YES");
        options = CSLSetNameValue(options, "BLOCKXSIZE", "32");
        options = CSLSetNameValue(options, "BLOCKYSIZE", "32");

        GDALDatasetH dsDst = NULL;
        dsDst = GDALCreateCopy(drv_, dst.c_str(), dsSrc, FALSE, options, NULL, NULL);
        ensure("Can't copy dataset", NULL != dsDst);

        GDALClose(dsDst);
        CSLDestroy(options);
        GDALClose(dsSrc);

        // Re-open copied dataset and test it
        dsDst = GDALOpen(dst.c_str(), GA_ReadOnly);
        GDALRasterBandH band = GDALGetRasterBand(dsDst, rasters_.at(fileIdx).band_);
        ensure("Can't get raster band", NULL != band);

        const int xsize = GDALGetRasterXSize(dsDst);
        const int ysize = GDALGetRasterYSize(dsDst);
        const int checksum = GDALChecksumImage(band, 0, 0, xsize, ysize);

        std::stringstream os;
        os << "Checksums for '" << dst << "' not equal";
        ensure_equals(os.str().c_str(), rasters_.at(fileIdx).checksum_, checksum);

        GDALClose(dsDst);
        GDALDeleteDataset(drv_, dst.c_str());
    }

    // Test raster min/max calculation
    template<>
    template<>
    void object::test<7>()
    {
                // Index of test file being copied
        const std::size_t fileIdx = 10;

        std::string src(data_ + SEP);
        src += rasters_.at(fileIdx).file_;
        GDALDatasetH ds = GDALOpen(src.c_str(), GA_ReadOnly);
        ensure("Can't open dataset: " + src, NULL != ds);
        
        GDALRasterBandH band = GDALGetRasterBand(ds, rasters_.at(fileIdx).band_);
        ensure("Can't get raster band", NULL != band);

        double expect[2] = { 74.0, 255.0 };
        double minmax[2] = { 0 };
        GDALComputeRasterMinMax(band, TRUE, minmax);

        ensure_equals("Computed wrong min", expect[0], minmax[0]);
        ensure_equals("Computed wrong max", expect[1], minmax[1]);

        GDALClose(ds);
    }

 } // namespace tut
