/******************************************************************************
* Copyright (c) 2012, Howard Butler, hobu.inc@gmail.com
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following
* conditions are met:
*
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in
*       the documentation and/or other materials provided
*       with the distribution.
*     * Neither the name of Hobu, Inc. or Flaxen Geo Consulting nor the
*       names of its contributors may be used to endorse or promote
*       products derived from this software without specific prior
*       written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
****************************************************************************/

#pragma once

#include <pdal/Filter.hpp>

#include <map>
#include <boost/shared_ptr.hpp>
#include <boost/array.hpp>

#pragma GCC diagnostic ignored "-Wfloat-equal"
#include <gdal.h>
#include <ogr_spatialref.h>
#include <pdal/GDALUtils.hpp>


namespace pdal
{

class PointBuffer;

namespace gdal
{ class GlobalDebug; }

// Provides GDAL-based raster overlay that places output data in
// specified dimensions. It also supports scaling the data by a multiplier
// on a per-dimension basis.
class PDAL_DLL ColorizationFilter : public Filter
{

struct BandInfo
{
    BandInfo(const std::string& name, Dimension::Id::Enum dim, uint32_t band,
        double scale) : m_name(name), m_dim(dim), m_band(band), m_scale(scale)
    {}

    std::string m_name;
    Dimension::Id::Enum m_dim;
    uint32_t m_band;
    double m_scale;
};

public:
    SET_STAGE_NAME("filters.colorization", "Fetch color information from a GDAL datasource")
    SET_STAGE_LINK("http://pdal.io/stages/filters.colorization.html")
    SET_STAGE_ENABLED(true)

    ColorizationFilter() : Filter()
        {}

    static Options getDefaultOptions();

private:
    virtual void initialize();
    virtual void processOptions(const Options&);
    virtual void ready(PointContext ctx);
    virtual void filter(PointBuffer& buffer);
    virtual void done(PointContext ctx);

    bool getPixelAndLinePosition(double x, double y,
        boost::array<double, 6> const& inverse, int32_t& pixel,
        int32_t& line, void *ds);

    std::string m_rasterFilename;
    std::vector<BandInfo> m_bands;

    boost::array<double, 6> m_forward_transform;
    boost::array<double, 6> m_inverse_transform;

    GDALDatasetH m_ds;

    ColorizationFilter& operator=(const ColorizationFilter&); // not implemented
    ColorizationFilter(const ColorizationFilter&); // not implemented
};

} // namespace pdal
