/*
    Scan Tailor - Interactive post-processing tool for scanned pages.
    Copyright (C) 2007-2008  Joseph Artsimovich <joseph_a@mail.ru>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "CommandLine.h"
#include "TiffWriter.h"
#include "imageproc/Grayscale.h"
#include "Dpm.h"
#include "imageproc/Constants.h"
#include "settings/globalstaticsettings.h"
#include <QtGlobal>
#include <QFile>
#include <QIODevice>
#include <QImage>
#include <QColor>
#include <QVector>
#include <QSize>
#include <QDebug>
#include <vector>
#include <tiff.h>
#include <tiffio.h>
#include <string.h>
#include <math.h>
#include <assert.h>

#include "version.h"

/**
 * m_reverseBitsLUT[byte] gives the same byte, but with bit order reversed.
 */
uint8_t const
TiffWriter::m_reverseBitsLUT[256] = {
    0x00, 0x80, 0x40, 0xc0, 0x20, 0xa0, 0x60, 0xe0,
    0x10, 0x90, 0x50, 0xd0, 0x30, 0xb0, 0x70, 0xf0,
    0x08, 0x88, 0x48, 0xc8, 0x28, 0xa8, 0x68, 0xe8,
    0x18, 0x98, 0x58, 0xd8, 0x38, 0xb8, 0x78, 0xf8,
    0x04, 0x84, 0x44, 0xc4, 0x24, 0xa4, 0x64, 0xe4,
    0x14, 0x94, 0x54, 0xd4, 0x34, 0xb4, 0x74, 0xf4,
    0x0c, 0x8c, 0x4c, 0xcc, 0x2c, 0xac, 0x6c, 0xec,
    0x1c, 0x9c, 0x5c, 0xdc, 0x3c, 0xbc, 0x7c, 0xfc,
    0x02, 0x82, 0x42, 0xc2, 0x22, 0xa2, 0x62, 0xe2,
    0x12, 0x92, 0x52, 0xd2, 0x32, 0xb2, 0x72, 0xf2,
    0x0a, 0x8a, 0x4a, 0xca, 0x2a, 0xaa, 0x6a, 0xea,
    0x1a, 0x9a, 0x5a, 0xda, 0x3a, 0xba, 0x7a, 0xfa,
    0x06, 0x86, 0x46, 0xc6, 0x26, 0xa6, 0x66, 0xe6,
    0x16, 0x96, 0x56, 0xd6, 0x36, 0xb6, 0x76, 0xf6,
    0x0e, 0x8e, 0x4e, 0xce, 0x2e, 0xae, 0x6e, 0xee,
    0x1e, 0x9e, 0x5e, 0xde, 0x3e, 0xbe, 0x7e, 0xfe,
    0x01, 0x81, 0x41, 0xc1, 0x21, 0xa1, 0x61, 0xe1,
    0x11, 0x91, 0x51, 0xd1, 0x31, 0xb1, 0x71, 0xf1,
    0x09, 0x89, 0x49, 0xc9, 0x29, 0xa9, 0x69, 0xe9,
    0x19, 0x99, 0x59, 0xd9, 0x39, 0xb9, 0x79, 0xf9,
    0x05, 0x85, 0x45, 0xc5, 0x25, 0xa5, 0x65, 0xe5,
    0x15, 0x95, 0x55, 0xd5, 0x35, 0xb5, 0x75, 0xf5,
    0x0d, 0x8d, 0x4d, 0xcd, 0x2d, 0xad, 0x6d, 0xed,
    0x1d, 0x9d, 0x5d, 0xdd, 0x3d, 0xbd, 0x7d, 0xfd,
    0x03, 0x83, 0x43, 0xc3, 0x23, 0xa3, 0x63, 0xe3,
    0x13, 0x93, 0x53, 0xd3, 0x33, 0xb3, 0x73, 0xf3,
    0x0b, 0x8b, 0x4b, 0xcb, 0x2b, 0xab, 0x6b, 0xeb,
    0x1b, 0x9b, 0x5b, 0xdb, 0x3b, 0xbb, 0x7b, 0xfb,
    0x07, 0x87, 0x47, 0xc7, 0x27, 0xa7, 0x67, 0xe7,
    0x17, 0x97, 0x57, 0xd7, 0x37, 0xb7, 0x77, 0xf7,
    0x0f, 0x8f, 0x4f, 0xcf, 0x2f, 0xaf, 0x6f, 0xef,
    0x1f, 0x9f, 0x5f, 0xdf, 0x3f, 0xbf, 0x7f, 0xff
};

class TiffWriter::TiffHandle
{
public:
    TiffHandle(TIFF* handle) : m_pHandle(handle) {}

    ~TiffHandle()
    {
        if (m_pHandle) {
            TIFFClose(m_pHandle);
        }
    }

    TIFF* handle() const
    {
        return m_pHandle;
    }
private:
    TIFF* m_pHandle;
};

static tsize_t deviceRead(thandle_t context, tdata_t data, tsize_t size)
{
    QIODevice* dev = (QIODevice*)context;
    return (tsize_t)dev->read(static_cast<char*>(data), size);
}

static tsize_t deviceWrite(thandle_t context, tdata_t data, tsize_t size)
{
    QIODevice* dev = (QIODevice*)context;
    return (tsize_t)dev->write(static_cast<char*>(data), size);
}

static toff_t deviceSeek(thandle_t context, toff_t offset, int whence)
{
    QIODevice* dev = (QIODevice*)context;

    switch (whence) {
    case SEEK_SET:
        dev->seek(offset);
        break;
    case SEEK_CUR:
        dev->seek(dev->pos() + offset);
        break;
    case SEEK_END:
        dev->seek(dev->size() + offset);
        break;
    }

    return dev->pos();
}

static int deviceClose(thandle_t context)
{
    QIODevice* dev = (QIODevice*)context;
    dev->close();
    return 0;
}

static toff_t deviceSize(thandle_t context)
{
    QIODevice* dev = (QIODevice*)context;
    return dev->size();
}

static int deviceMap(thandle_t, tdata_t*, toff_t*)
{
    // Not implemented.
    return 0;
}

static void deviceUnmap(thandle_t, tdata_t, toff_t)
{
    // Not implemented.
}

bool
TiffWriter::writeImage(QString const& file_path, QImage const& image, bool multipage, int page_no, QString* compression_used)
{
    if (image.isNull()) {
        return false;
    }

    QFile file(file_path);
    QIODevice::OpenMode open_mode = QFile::ReadWrite;
    if (!multipage || page_no == 0) {
        // libtiff don't truncate existing file even in "wBm" mode
        open_mode.setFlag(QFile::Truncate);
    }
    if (!file.open(open_mode)) {
        return false;
    }

    if (!writeImage(file, image, multipage, page_no, compression_used)) {
        file.remove();
        return false;
    }

    return true;
}

bool
TiffWriter::writeImage(QIODevice& device, QImage const& image, bool multipage, int page_no, QString* compression_used)
{
    if (image.isNull()) {
        return false;
    }
    if (!device.isWritable()) {
        return false;
    }
    if (device.isSequential()) {
        // libtiff needs to be able to seek.
        return false;
    }

    const QString open_mode = (multipage && page_no > 0) ? "aBm" : "wBm";
    TiffHandle tif(
        TIFFClientOpen(
            // Libtiff seems to be buggy with L or H flags,
            // so we use B.
            "file", open_mode.toStdString().c_str(), &device, &deviceRead, &deviceWrite,
            &deviceSeek, &deviceClose, &deviceSize,
            &deviceMap, &deviceUnmap
        )
    );
    if (!tif.handle()) {
        return false;
    }

    if (multipage) {
        TIFFSetField(tif.handle(), TIFFTAG_PAGENUMBER, page_no, page_no);
        TIFFSetField(tif.handle(), TIFFTAG_SUBFILETYPE, FILETYPE_PAGE);
    }

    TIFFSetField(tif.handle(), TIFFTAG_IMAGEWIDTH, uint32(image.width()));
    TIFFSetField(tif.handle(), TIFFTAG_IMAGELENGTH, uint32(image.height()));
    TIFFSetField(tif.handle(), TIFFTAG_SAMPLEFORMAT, SAMPLEFORMAT_UINT);
    TIFFSetField(tif.handle(), TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
    TIFFSetField(tif.handle(), TIFFTAG_SOFTWARE, "Scan Tailor \"Universal\" " VERSION);
    setDpm(tif, Dpm(image));

    CommandLine const& cli = CommandLine::get();

    int compression = GlobalStaticSettings::m_tiff_compression_color_id;
    if (compression_used) {
        *compression_used = GlobalStaticSettings::m_tiff_compr_method_color;
    }

    if (! cli.hasTiffForceRGB()) {
        if (cli.hasTiffForceGrayscale()) {
            return writeBitonalOrIndexed8Image(tif, imageproc::toGrayscale(image), multipage, compression);
        }
        switch (image.format()) {
        case QImage::Format_Mono:
        case QImage::Format_MonoLSB: {
            compression = GlobalStaticSettings::m_tiff_compression_bw_id;
            if (compression_used) {
                *compression_used = GlobalStaticSettings::m_tiff_compr_method_bw;
            }
            return writeBitonalOrIndexed8Image(tif, image, multipage, compression);
        }
        case QImage::Format_Indexed8: {
            return writeBitonalOrIndexed8Image(tif, image, multipage, compression);
        }
        default:;
        }
    }

    if (image.hasAlphaChannel()) {
        return writeARGB32Image(
                   tif, image.convertToFormat(QImage::Format_ARGB32), multipage, compression
               );
    } else {
        return writeRGB32Image(
                   tif, image.convertToFormat(QImage::Format_RGB32), multipage, compression
               );
    }
}

/**
 * Set the physical resolution, if it's defined.
 */
void
TiffWriter::setDpm(TiffHandle const& tif, Dpm const& dpm)
{
    using namespace imageproc::constants;

    if (dpm.isNull()) {
        return;
    }

    float xres = 0.01 * dpm.horizontal(); // cm
    float yres = 0.01 * dpm.vertical(); // cm
    uint16 unit = RESUNIT_CENTIMETER;

    // If we have a round (or almost round) DPI, then
    // write it as DPI rather than dots per cm.
    double const xdpi = dpm.horizontal() * DPM2DPI;
    double const ydpi = dpm.vertical() * DPM2DPI;
    double const rounded_xdpi = floor(xdpi + 0.5);
    double const rounded_ydpi = floor(ydpi + 0.5);
    if (fabs(xdpi - rounded_xdpi) < 0.02 &&
            fabs(ydpi - rounded_ydpi) < 0.02) {
        xres = rounded_xdpi;
        yres = rounded_ydpi;
        unit = RESUNIT_INCH;
    }

    TIFFSetField(tif.handle(), TIFFTAG_XRESOLUTION, xres);
    TIFFSetField(tif.handle(), TIFFTAG_YRESOLUTION, yres);
    TIFFSetField(tif.handle(), TIFFTAG_RESOLUTIONUNIT, unit);
}

bool
TiffWriter::writeBitonalOrIndexed8Image(
    TiffHandle const& tif, QImage const& image, bool multipage, int compression)
{
    TIFFSetField(tif.handle(), TIFFTAG_SAMPLESPERPIXEL, uint16(1));

    uint16 bits_per_sample = 8;
    uint16 photometric = PHOTOMETRIC_PALETTE;
    if (image.isGrayscale()) {
        photometric = PHOTOMETRIC_MINISBLACK;
    }

    switch (image.format()) {
    case QImage::Format_Mono:
    case QImage::Format_MonoLSB:
        bits_per_sample = 1;
        if (image.colorCount() < 2) {
            photometric = PHOTOMETRIC_MINISWHITE;
        } else {
            // Some programs don't understand
            // palettized binary images, so don't
            // use a palette for black and white images.
            uint32_t const c0 = image.color(0);
            uint32_t const c1 = image.color(1);
            if (c0 == 0xffffffff && c1 == 0xff000000) {
                photometric = PHOTOMETRIC_MINISWHITE;
            } else if (c0 == 0xff000000 && c1 == 0xffffffff) {
                photometric = PHOTOMETRIC_MINISBLACK;
            }
        }
        break;
    default:;
    }

    TIFFSetField(tif.handle(), TIFFTAG_COMPRESSION, uint16(compression));
    TIFFSetField(tif.handle(), TIFFTAG_BITSPERSAMPLE, bits_per_sample);
    TIFFSetField(tif.handle(), TIFFTAG_PHOTOMETRIC, photometric);
    TIFFSetField(tif.handle(), TIFFTAG_FILLORDER, FILLORDER_MSB2LSB);

    if (GlobalStaticSettings::m_use_horizontal_predictor && bits_per_sample == 8) {
        TIFFSetField(tif.handle(), TIFFTAG_PREDICTOR, PREDICTOR_HORIZONTAL);
    }

    if (photometric == PHOTOMETRIC_PALETTE) {
        int const num_colors = 1 << bits_per_sample;
        QVector<QRgb> color_table(image.colorTable());
        if (color_table.size() > num_colors) {
            color_table.resize(num_colors);
        }
        std::vector<uint16> pr(num_colors, 0);
        std::vector<uint16> pg(num_colors, 0);
        std::vector<uint16> pb(num_colors, 0);
        for (int i = 0; i < color_table.size(); ++i) {
            QRgb const rgb = color_table[i];
            pr[i] = (0xFFFF * qRed(rgb) + 128) / 255;
            pg[i] = (0xFFFF * qGreen(rgb) + 128) / 255;
            pb[i] = (0xFFFF * qBlue(rgb) + 128) / 255;
        }
        TIFFSetField(tif.handle(), TIFFTAG_COLORMAP, &pr[0], &pg[0], &pb[0]);
    }

    if (image.format() == QImage::Format_Indexed8) {
        if (!write8bitLines(tif, image)) {
            return false;
        }
    } else {
        if (image.format() == QImage::Format_MonoLSB) {
            if (!writeBinaryLinesReversed(tif, image)) {
                return false;
            }
        } else {
            if (!writeBinaryLinesAsIs(tif, image)) {
                return false;
            }
        }
    }

    if (multipage && (TIFFWriteDirectory(tif.handle()) == -1)) {
        return false;
    }
    return true;
}

bool
TiffWriter::writeRGB32Image(
    TiffHandle const& tif, QImage const& image, bool multipage, int compression)
{
    assert(image.format() == QImage::Format_RGB32);

    TIFFSetField(tif.handle(), TIFFTAG_SAMPLESPERPIXEL, uint16(3));
    TIFFSetField(tif.handle(), TIFFTAG_COMPRESSION, uint16(compression));
    TIFFSetField(tif.handle(), TIFFTAG_BITSPERSAMPLE, uint16(8));
    TIFFSetField(tif.handle(), TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_RGB);
    if (GlobalStaticSettings::m_use_horizontal_predictor) {
        TIFFSetField(tif.handle(), TIFFTAG_PREDICTOR, PREDICTOR_HORIZONTAL);
    }

    int const width = image.width();
    int const height = image.height();

    std::vector<uint8_t> tmp_line(width * 3);

    // Libtiff expects "RR GG BB" sequences regardless of CPU byte order.

    for (int y = 0; y < height; ++y) {
        uint32_t const* p_src = (uint32_t const*)image.scanLine(y);
        uint8_t* p_dst = &tmp_line[0];
        for (int x = 0; x < width; ++x) {
            uint32_t const ARGB = *p_src;
            p_dst[0] = static_cast<uint8_t>(ARGB >> 16);
            p_dst[1] = static_cast<uint8_t>(ARGB >> 8);
            p_dst[2] = static_cast<uint8_t>(ARGB);
            ++p_src;
            p_dst += 3;
        }
        if (TIFFWriteScanline(tif.handle(), &tmp_line[0], y) == -1) {
            return false;
        }
    }

    if (multipage && (TIFFWriteDirectory(tif.handle()) == -1)) {
        return false;
    }

    return true;
}

bool
TiffWriter::writeARGB32Image(
    TiffHandle const& tif, QImage const& image, bool multipage, int compression)
{
    assert(image.format() == QImage::Format_ARGB32);

    TIFFSetField(tif.handle(), TIFFTAG_SAMPLESPERPIXEL, uint16(4));
    TIFFSetField(tif.handle(), TIFFTAG_COMPRESSION, uint16(compression));
    TIFFSetField(tif.handle(), TIFFTAG_BITSPERSAMPLE, uint16(8));
    TIFFSetField(tif.handle(), TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_RGB);
    if (GlobalStaticSettings::m_use_horizontal_predictor) {
        TIFFSetField(tif.handle(), TIFFTAG_PREDICTOR, PREDICTOR_HORIZONTAL);
    }

    int const width = image.width();
    int const height = image.height();

    std::vector<uint8_t> tmp_line(width * 4);

    // Libtiff expects "RR GG BB AA" sequences regardless of CPU byte order.

    for (int y = 0; y < height; ++y) {
        uint32_t const* p_src = (uint32_t const*)image.scanLine(y);
        uint8_t* p_dst = &tmp_line[0];
        for (int x = 0; x < width; ++x) {
            uint32_t const ARGB = *p_src;
            p_dst[0] = static_cast<uint8_t>(ARGB >> 16);
            p_dst[1] = static_cast<uint8_t>(ARGB >> 8);
            p_dst[2] = static_cast<uint8_t>(ARGB);
            p_dst[3] = static_cast<uint8_t>(ARGB >> 24);
            ++p_src;
            p_dst += 4;
        }
        if (TIFFWriteScanline(tif.handle(), &tmp_line[0], y) == -1) {
            return false;
        }
    }

    if (multipage && (TIFFWriteDirectory(tif.handle()) == -1)) {
        return false;
    }

    return true;
}

bool
TiffWriter::write8bitLines(
    TiffHandle const& tif, QImage const& image)
{
    int const width = image.width();
    int const height = image.height();

    // TIFFWriteScanline() can actually modify the data you pass it,
    // so we have to use a temporary buffer even when no coversion
    // is required.
    std::vector<uint8_t> tmp_line(width, 0);

    for (int y = 0; y < height; ++y) {
        uint8_t const* src_line = image.scanLine(y);
        memcpy(&tmp_line[0], src_line, tmp_line.size());
        if (TIFFWriteScanline(tif.handle(), &tmp_line[0], y) == -1) {
            return false;
        }
    }

    return true;
}

bool
TiffWriter::writeBinaryLinesAsIs(
    TiffHandle const& tif, QImage const& image)
{
    int const width = image.width();
    int const height = image.height();

    // TIFFWriteScanline() can actually modify the data you pass it,
    // so we have to use a temporary buffer even when no conversion
    // is required.
    int const bpl = (width + 7) / 8;
    std::vector<uint8_t> tmp_line(bpl, 0);

    for (int y = 0; y < height; ++y) {
        uint8_t const* src_line = image.scanLine(y);
        memcpy(&tmp_line[0], src_line, bpl);
        if (TIFFWriteScanline(tif.handle(), &tmp_line[0], y) == -1) {
            return false;
        }
    }

    return true;
}

bool
TiffWriter::writeBinaryLinesReversed(
    TiffHandle const& tif, QImage const& image)
{
    int const width = image.width();
    int const height = image.height();

    int const bpl = (width + 7) / 8;
    std::vector<uint8_t> tmp_line(bpl, 0);

    for (int y = 0; y < height; ++y) {
        uint8_t const* src_line = image.scanLine(y);
        for (int i = 0; i < bpl; ++i) {
            tmp_line[i] = m_reverseBitsLUT[src_line[i]];
        }
        if (TIFFWriteScanline(tif.handle(), &tmp_line[0], y) == -1) {
            return false;
        }
    }

    return true;
}
