kis_raw_import.cpp

Go to the documentation of this file.

/*
 *  SPDX-FileCopyrightText: 2008 Cyrille Berger <cberger@cberger.net>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#include "kis_raw_import.h"
 
#include <cmath>
#include <cstddef>
#include <exiv2/exiv2.hpp>
#include <utility>
#include <kpluginfactory.h>
#include <libkdcraw_version.h>
 
#include <kdcraw.h>
 
#include <KisCursorOverrideLock.h>
#include <KisDocument.h>
#include <KisExiv2IODevice.h>
#include <KisImportExportErrorCode.h>
#include <KoColorSpace.h>
#include <KoColorSpaceRegistry.h>
#include <KoColorSpaceTraits.h>
#include <KoDialog.h>
#include <KoUpdater.h>
#include <kis_debug.h>
#include <kis_group_layer.h>
#include <kis_image.h>
#include <kis_meta_data_backend_registry.h>
#include <kis_meta_data_io_backend.h>
#include <kis_meta_data_tags.h>
#include <kis_paint_device.h>
#include <kis_paint_layer.h>
#include <kis_random_accessor_ng.h>
#include <kis_transaction.h>
 
using namespace KDcrawIface;
 
class Q_DECL_HIDDEN MyKDcraw : public KDcraw
{
public:
    MyKDcraw(QPointer<KoUpdater> updater)
        : updater(std::move(updater))
    {
    }
 
    void setWaitingDataProgress(double value) override
    {
        if (updater)
            updater->setProgress(static_cast<int>(value * 100.0));
    }
 
private:
    QPointer<KoUpdater> updater;
};
 
K_PLUGIN_FACTORY_WITH_JSON(KisRawImportFactory, "krita_raw_import.json", registerPlugin<KisRawImport>();)
 
KisRawImport::KisRawImport(QObject *parent, const QVariantList &)
    : KisImportExportFilter(parent)
    , m_dialog(new KoDialog())
    , m_rawWidget(new WdgRawImport())
{
    m_dialog->setButtons(KoDialog::Ok | KoDialog::Cancel | KoDialog::Apply);
    m_dialog->setDefaultButton(KoDialog::Ok);
 
    m_dialog->setMainWidget(m_rawWidget);
    connect(m_dialog, &KoDialog::applyClicked, this, &KisRawImport::slotUpdatePreview);
    connect(m_rawWidget, &WdgRawImport::paint, this, &KisRawImport::slotUpdatePreview);
    connect(m_rawWidget->rawSettings, &DcrawSettingsWidget::signalSettingsChanged, [&]() {
        m_dialog->enableButtonApply(true);
    });
}
 
KisRawImport::~KisRawImport()
{
    delete m_dialog;
}
 
inline quint16 correctIndian(quint16 v)
{
#if KDCRAW_VERSION < 0x000400
    return ((v & 0x00FF) << 8) | ((v & 0xFF00 >> 8));
#else
    return v;
#endif
}
 
KisImportExportErrorCode
KisRawImport::convert(KisDocument *document, QIODevice * /*io*/, KisPropertiesConfigurationSP /*configuration*/)
{
#if KDCRAW_VERSION < 0x010200
    m_rawWidget->rawSettings->setDefaultSettings();
#else
    m_rawWidget->rawSettings->resetToDefault();
#endif
 
    int r = QDialog::Accepted;
    if (!batchMode()) {
        r = m_dialog->exec();
    }
 
    if (r == QDialog::Accepted) {
        KisCursorOverrideLock cursorLock(Qt::WaitCursor);
 
        // Do the decoding
        QByteArray imageData;
        RawDecodingSettings settings = rawDecodingSettings();
        settings.sixteenBitsImage = true;
        int width = 0;
        int height = 0;
        int rgbmax = 0;
        MyKDcraw dcraw(updater());
        if (!dcraw.decodeRAWImage(filename(), settings, imageData, width, height, rgbmax))
            return ImportExportCodes::FileFormatIncorrect;
 
        const KoColorProfile *profile = nullptr;
 
        switch (settings.outputColorSpace) {
        case RawDecodingSettings::RAWCOLOR:
        case RawDecodingSettings::SRGB:
            profile = KoColorSpaceRegistry::instance()->p709SRGBProfile();
            break;
        case RawDecodingSettings::ADOBERGB:
            profile = KoColorSpaceRegistry::instance()->profileByName("ClayRGB-elle-V2-g22.icc");
            break;
        case RawDecodingSettings::WIDEGAMMUT:
            profile = KoColorSpaceRegistry::instance()->profileByName("WideRGB-elle-V2-g22.icc");
            break;
        case RawDecodingSettings::PROPHOTO:
            profile = KoColorSpaceRegistry::instance()->profileByName("LargeRGB-elle-V2-g22.icc");
            break;
        case RawDecodingSettings::CUSTOMOUTPUTCS:
            QFileInfo info(settings.outputProfile);
 
            if (!info.exists()) {
                qWarning() << "WARNING: couldn't find custom profile" << settings.outputProfile;
                profile = KoColorSpaceRegistry::instance()->p709SRGBProfile();
            } else {
                QFile profileFile(settings.outputProfile);
 
                if (profileFile.open(QFile::ReadOnly)) {
                    profile = KoColorSpaceRegistry::instance()->createColorProfile(RGBAColorModelID.id(),
                                                                                   Integer16BitsColorDepthID.id(),
                                                                                   profileFile.readAll());
                } else {
                    qWarning() << "WARNING: couldn't open custom profile file" << settings.outputProfile;
                }
            }
 
            if (!profile) {
                qWarning() << "WARNING: reset profile to sRGB";
                profile = KoColorSpaceRegistry::instance()->p709SRGBProfile();
            }
 
            break;
        }
 
        // Init the image
        const KoColorSpace *cs = KoColorSpaceRegistry::instance()->rgb16(profile);
        KisImageSP image = new KisImage(document->createUndoStore(), width, height, cs, filename());
        KIS_ASSERT_RECOVER_RETURN_VALUE(!image.isNull(), ImportExportCodes::InternalError);
 
        KisPaintLayerSP layer = new KisPaintLayer(image, image->nextLayerName(), quint8_MAX);
 
        image->addNode(layer, image->rootLayer());
        KIS_ASSERT_RECOVER_RETURN_VALUE(!layer.isNull(), ImportExportCodes::InternalError);
 
        KisPaintDeviceSP device = layer->paintDevice();
        KIS_ASSERT_RECOVER_RETURN_VALUE(!device.isNull(), ImportExportCodes::InternalError);
 
        const auto readLayer = [](KisLayerSP layer,
                                  const QByteArray &imageData,
                                  int width,
                                  int height,
                                  const QPointer<KoUpdater> &updater) -> void {
            const float original = static_cast<float>(updater->progress());
            // Leave 10% for the metadata
            const float step = (static_cast<float>(updater->maximum() * 0.9) - original) / (float)height;
            // Copy the data
            KisRandomAccessorSP it = layer->paintDevice()->createRandomAccessorNG();
 
            for (int y = 0; y < height;) {
                const int numContiguousRows = qMin(it->numContiguousRows(y), height - y);
                for (int x = 0; x < width;) {
                    const int numContiguousColumns = qMin(it->numContiguousColumns(x), width - x);
 
                    it->moveTo(x, y);
 
                    const int rowStride = it->rowStride(x, y);
 
                    quint8 *d = it->rawData();
 
                    for (int i = 0; i < numContiguousRows; i++) {
                        const auto *ptr =
                            reinterpret_cast<const typename KoBgrU16Traits::channels_type *>(imageData.data())
                            + static_cast<ptrdiff_t>(((y + i) * width + x) * 3);
 
                        for (int j = 0; j < numContiguousColumns; j++) {
                            auto *pixel = reinterpret_cast<typename KoBgrU16Traits::Pixel *>(d) + j;
#if KDCRAW_VERSION < 0x000400
                            pixel->red = correctIndian(ptr[2]);
                            pixel->green = correctIndian(ptr[1]);
                            pixel->blue = correctIndian(ptr[0]);
                            pixel->alpha = 0xFFFF;
#else
                            *pixel = {correctIndian(ptr[2]), correctIndian(ptr[1]), correctIndian(ptr[0]), 0xFFFF};
#endif
                            ptr += 3;
                        }
 
                        d += rowStride;
                    }
 
                    x += numContiguousColumns;
                }
 
                y += numContiguousRows;
                updater->setProgress(static_cast<int>(original + step * float(y)));
            }
        };
 
        readLayer(layer, imageData, width, height, updater());
 
        {
            // HACK!! Externally parse the Exif metadata
            // libtiff has no way to access the fields wholesale
            try {
                KisExiv2IODevice::ptr_type basicIoDevice(new KisExiv2IODevice(filename()));
 
#if EXIV2_TEST_VERSION(0,28,0)
                const std::unique_ptr<Exiv2::Image> readImg = Exiv2::ImageFactory::open(std::move(basicIoDevice));
#else
                const std::unique_ptr<Exiv2::Image> readImg(Exiv2::ImageFactory::open(basicIoDevice).release());
#endif
 
                readImg->readMetadata();
 
                const KisMetaData::IOBackend *io = KisMetadataBackendRegistry::instance()->value("exif");
 
                // All IFDs are paint layer children of root
                KisNodeSP node = image->rootLayer()->firstChild();
 
                QBuffer ioDevice;
 
                {
                    // Synthesize the Exif blob
                    Exiv2::ExifData tempData;
                    Exiv2::Blob tempBlob;
 
                    // NOTE: do not use std::copy_if, auto_ptrs beware
                    for (const Exiv2::Exifdatum &i : readImg->exifData()) {
                        const uint16_t tag = i.tag();
 
                        if (tag == Exif::Image::ImageWidth || tag == Exif::Image::ImageLength
                            || tag == Exif::Image::BitsPerSample || tag == Exif::Image::Compression
                            || tag == Exif::Image::PhotometricInterpretation || tag == Exif::Image::Orientation
                            || tag == Exif::Image::SamplesPerPixel || tag == Exif::Image::PlanarConfiguration
                            || tag == Exif::Image::YCbCrSubSampling || tag == Exif::Image::YCbCrPositioning
                            || tag == Exif::Image::XResolution || tag == Exif::Image::YResolution
                            || tag == Exif::Image::ResolutionUnit || tag == Exif::Image::TransferFunction
                            || tag == Exif::Image::WhitePoint || tag == Exif::Image::PrimaryChromaticities
                            || tag == Exif::Image::YCbCrCoefficients || tag == Exif::Image::ReferenceBlackWhite
                            || tag == Exif::Image::InterColorProfile) {
                            dbgMetaData << "Ignoring TIFF-specific" << i.key().c_str();
                            continue;
                        }
 
                        tempData.add(i);
                    }
 
                    // Encode into temporary blob
                    Exiv2::ExifParser::encode(tempBlob, Exiv2::littleEndian, tempData);
 
                    // Reencode into Qt land
                    ioDevice.setData(reinterpret_cast<char *>(tempBlob.data()), static_cast<int>(tempBlob.size()));
                }
 
                // Get layer
                KisLayer *layer = qobject_cast<KisLayer *>(node.data());
                KIS_ASSERT_RECOVER(layer)
                {
                    errFile << "Attempted to import metadata on an empty document";
                    return ImportExportCodes::InternalError;
                }
 
                // Inject the data as any other IOBackend
                io->loadFrom(layer->metaData(), &ioDevice);
#if EXIV2_TEST_VERSION(0,28,0)
            } catch (Exiv2::Error &e) {
                errFile << "Failed injecting TIFF metadata:" << Exiv2::Error(e.code()).what();
#else
            } catch (Exiv2::AnyError &e) {
                errFile << "Failed metadata import:" << e.code() << e.what();
#endif
            }
        }
 
        document->setCurrentImage(image);
        updater()->setProgress(updater()->maximum());
        return ImportExportCodes::OK;
    }
 
    return ImportExportCodes::Cancelled;
}
 
void KisRawImport::slotUpdatePreview()
{
    QByteArray imageData;
    RawDecodingSettings settings = rawDecodingSettings();
    settings.sixteenBitsImage = false;
    int width = 0;
    int height = 0;
    int rgbmax = 0;
    KDcraw dcraw;
    if (dcraw.decodeHalfRAWImage(filename(), settings, imageData, width, height, rgbmax)) {
        QImage image(width, height, QImage::Format_RGB32);
        quint8 *ptr = reinterpret_cast<quint8 *>(imageData.data());
        for (int y = 0; y < height; ++y) {
            QRgb *pixel = reinterpret_cast<QRgb *>(image.scanLine(y));
            for (int x = 0; x < width; ++x) {
                pixel[x] = qRgb(ptr[0], ptr[1], ptr[2]);
                ptr += 3;
            }
        }
        const QSize previewSize = m_rawWidget->preview->size() * m_rawWidget->preview->devicePixelRatioF();
        QPixmap img = QPixmap::fromImage(image).scaled(previewSize, Qt::KeepAspectRatio, Qt::SmoothTransformation);
        img.setDevicePixelRatio(m_rawWidget->preview->devicePixelRatioF());
        m_rawWidget->preview->setPixmap(img);
    }
 
    m_dialog->enableButtonApply(false);
}
 
RawDecodingSettings KisRawImport::rawDecodingSettings()
{
#if KDCRAW_VERSION < 0x010200
    RawDecodingSettings settings;
    settings.sixteenBitsImage = true;
    settings.brightness = m_rawWidget->rawSettings->brightness();
    settings.RAWQuality = m_rawWidget->rawSettings->quality();
    settings.outputColorSpace = m_rawWidget->rawSettings->outputColorSpace();
    settings.RGBInterpolate4Colors = m_rawWidget->rawSettings->useFourColor();
    settings.DontStretchPixels = m_rawWidget->rawSettings->useDontStretchPixels();
    settings.unclipColors = m_rawWidget->rawSettings->unclipColor();
    settings.whiteBalance = m_rawWidget->rawSettings->whiteBalance();
    settings.customWhiteBalance = m_rawWidget->rawSettings->customWhiteBalance();
    settings.customWhiteBalanceGreen = m_rawWidget->rawSettings->customWhiteBalanceGreen();
 
    settings.enableBlackPoint = m_rawWidget->rawSettings->useBlackPoint();
    settings.blackPoint = m_rawWidget->rawSettings->blackPoint();
 
    settings.enableNoiseReduction = m_rawWidget->rawSettings->useNoiseReduction();
    settings.NRThreshold = m_rawWidget->rawSettings->NRThreshold();
 
    settings.enableCACorrection = m_rawWidget->rawSettings->useCACorrection();
    settings.caMultiplier[0] = m_rawWidget->rawSettings->caRedMultiplier();
    settings.caMultiplier[1] = m_rawWidget->rawSettings->caBlueMultiplier();
 
    return settings;
#else
    return m_rawWidget->rawSettings->settings();
#endif
}
 
#include "kis_raw_import.moc"