exr_converter.cc File Reference

#include "exr_converter.h"
#include <half.h>
#include <ImfAttribute.h>
#include <ImfChannelList.h>
#include <ImfFrameBuffer.h>
#include <ImfHeader.h>
#include <ImfInputFile.h>
#include <ImfOutputFile.h>
#include <ImfStringAttribute.h>
#include "exr_extra_tags.h"
#include <QApplication>
#include <QMessageBox>
#include <QDomDocument>
#include <QThread>
#include <KoColorSpaceRegistry.h>
#include <KoCompositeOpRegistry.h>
#include <KoColorSpaceTraits.h>
#include <KoColorModelStandardIds.h>
#include <KoColor.h>
#include <KoColorProfile.h>
#include <KisDocument.h>
#include <kis_group_layer.h>
#include <kis_image.h>
#include <kis_paint_device.h>
#include <kis_paint_layer.h>
#include <kis_transaction.h>
#include "kis_iterator_ng.h"
#include <kis_exr_layers_sorter.h>
#include <kis_meta_data_entry.h>
#include <kis_meta_data_schema.h>
#include <kis_meta_data_schema_registry.h>
#include <kis_meta_data_store.h>
#include <kis_meta_data_value.h>
#include "kis_kra_savexml_visitor.h"
#include <KisImportExportAdditionalChecks.h>
#include <KisPortingUtils.h>

Go to the source code of this file.

Classes
class	Encoder
class	EncoderImpl< _T_, size, alphaPos >
struct	ExrGroupLayerInfo
struct	ExrLayerInfoBase
struct	ExrPaintLayerInfo
struct	ExrPaintLayerSaveInfo
struct	ExrPixel_< _T_, size >
struct	GrayPixelWrapper< T >
struct	EXRConverter::Private
struct	ExrPaintLayerInfo::Remap
struct	Rgba< _T_ >
struct	RgbPixelWrapper< T >

Macros
#define	HDR_LAYER   "HDR Layer"

Enumerations
enum	ImageType { IT_UNKNOWN , IT_FLOAT16 , IT_FLOAT32 , IT_UNSUPPORTED }

Functions
template<typename T >
static T	alphaEpsilon ()
template<typename T >
static T	alphaNoiseThreshold ()
void	encodeData (Imf::OutputFile &file, const QList< ExrPaintLayerSaveInfo > &informationObjects, int width, int height)
Encoder *	encoder (Imf::OutputFile &file, const ExrPaintLayerSaveInfo &info, int width)
ImageType	imfTypeToKisType (Imf::PixelType type)
const KoColorSpace *	kisTypeToColorSpace (QString colorModelID, ImageType imageType)
template<typename T , typename Pixel , int size, int alphaPos>
void	multiplyAlpha (Pixel *pixel)
static bool	qFuzzyCompare (half p1, half p2)
static bool	qFuzzyIsNull (half h)
bool	recCheckGroup (const ExrGroupLayerInfo &group, QStringList list, int idx1, int idx2)
QString	remap (const QMap< QString, QString > &current2original, const QString &current)
ExrGroupLayerInfo *	searchGroup (QList< ExrGroupLayerInfo > *groups, QStringList list, int idx1, int idx2)
KisPaintDeviceSP	wrapLayerDevice (KisPaintDeviceSP device)

Macro Definition Documentation

HDR_LAYER

#define HDR_LAYER   "HDR Layer"

Definition at line 56 of file exr_converter.cc.

Enumeration Type Documentation

ImageType

enum ImageType

Enumerator
IT_UNKNOWN
IT_FLOAT16
IT_FLOAT32
IT_UNSUPPORTED

Definition at line 81 of file exr_converter.cc.

               {
    IT_UNKNOWN,
    IT_FLOAT16,
    IT_FLOAT32,
    IT_UNSUPPORTED
};

Function Documentation

alphaEpsilon()

template<typename T >

static T alphaEpsilon ( )

inlinestatic

Definition at line 222 of file exr_converter.cc.

{
    return static_cast<T>(HALF_EPSILON);
}

alphaNoiseThreshold()

template<typename T >

static T alphaNoiseThreshold ( )

inlinestatic

Definition at line 228 of file exr_converter.cc.

{
    return static_cast<T>(0.01); // 1%
}

encodeData()

void encodeData	(	Imf::OutputFile &	file,
		const QList< ExrPaintLayerSaveInfo > &	informationObjects,
		int	width,
		int	height )

Definition at line 1075 of file exr_converter.cc.

{
    QList<Encoder*> encoders;
    Q_FOREACH (const ExrPaintLayerSaveInfo& info, informationObjects) {
        encoders.push_back(encoder(file, info, width));
    }
 
    for (int y = 0; y < height; ++y) {
        Imf::FrameBuffer frameBuffer;
        Q_FOREACH (Encoder* encoder, encoders) {
            encoder->prepareFrameBuffer(&frameBuffer, y);
        }
        file.setFrameBuffer(frameBuffer);
        Q_FOREACH (Encoder* encoder, encoders) {
            encoder->encodeData(y);
        }
        file.writePixels(1);
    }
    qDeleteAll(encoders);
}

References Encoder::encodeData(), encoder(), and Encoder::prepareFrameBuffer().

encoder()

Encoder * encoder	(	Imf::OutputFile &	file,
		const ExrPaintLayerSaveInfo &	info,
		int	width )

Definition at line 1035 of file exr_converter.cc.

{
    dbgFile << "Create encoder for" << info.name << info.channels << info.layerDevice->colorSpace()->channelCount();
    switch (info.layerDevice->colorSpace()->channelCount()) {
    case 1: {
        if (info.layerDevice->colorSpace()->colorDepthId() == Float16BitsColorDepthID) {
            Q_ASSERT(info.pixelType == Imf::HALF);
            return new EncoderImpl < half, 1, -1 > (&file, &info, width);
        } else if (info.layerDevice->colorSpace()->colorDepthId() == Float32BitsColorDepthID) {
            Q_ASSERT(info.pixelType == Imf::FLOAT);
            return new EncoderImpl < float, 1, -1 > (&file, &info, width);
        }
        break;
    }
    case 2: {
        if (info.layerDevice->colorSpace()->colorDepthId() == Float16BitsColorDepthID) {
            Q_ASSERT(info.pixelType == Imf::HALF);
            return new EncoderImpl<half, 2, 1>(&file, &info, width);
        } else if (info.layerDevice->colorSpace()->colorDepthId() == Float32BitsColorDepthID) {
            Q_ASSERT(info.pixelType == Imf::FLOAT);
            return new EncoderImpl<float, 2, 1>(&file, &info, width);
        }
        break;
    }
    case 4: {
        if (info.layerDevice->colorSpace()->colorDepthId() == Float16BitsColorDepthID) {
            Q_ASSERT(info.pixelType == Imf::HALF);
            return new EncoderImpl<half, 4, 3>(&file, &info, width);
        } else if (info.layerDevice->colorSpace()->colorDepthId() == Float32BitsColorDepthID) {
            Q_ASSERT(info.pixelType == Imf::FLOAT);
            return new EncoderImpl<float, 4, 3>(&file, &info, width);
        }
        break;
    }
    default:
        qFatal("Impossible error");
    }
    return 0;
}

References KoColorSpace::channelCount(), ExrPaintLayerSaveInfo::channels, KoColorSpace::colorDepthId(), KisPaintDevice::colorSpace(), dbgFile, Float16BitsColorDepthID, Float32BitsColorDepthID, ExrPaintLayerSaveInfo::layerDevice, ExrPaintLayerSaveInfo::name, and ExrPaintLayerSaveInfo::pixelType.

imfTypeToKisType()

ImageType imfTypeToKisType

(

Imf::PixelType

type

)

Definition at line 174 of file exr_converter.cc.

{
    switch (type) {
    case Imf::UINT:
    case Imf::NUM_PIXELTYPES:
        return IT_UNSUPPORTED;
    case Imf::HALF:
        return IT_FLOAT16;
    case Imf::FLOAT:
        return IT_FLOAT32;
    default:
        qFatal("Out of bound enum");
        return IT_UNKNOWN;
    }
}

References IT_FLOAT16, IT_FLOAT32, IT_UNKNOWN, and IT_UNSUPPORTED.

kisTypeToColorSpace()

const KoColorSpace * kisTypeToColorSpace	(	QString	colorModelID,
		ImageType	imageType )

Our user settings are only for the RGB color model, for other models just use the default one provided by the color space.

Definition at line 190 of file exr_converter.cc.

{
 
    QString colorDepthID = "UNKNOWN";
    switch(imageType) {
    case IT_FLOAT16:
        colorDepthID = Float16BitsColorDepthID.id();
        break;
    case IT_FLOAT32:
        colorDepthID = Float32BitsColorDepthID.id();
        break;
    default:
        return 0;
    };
 
    const QString colorSpaceId = KoColorSpaceRegistry::instance()->colorSpaceId(colorModelID, colorDepthID);
    const QString defaultProfileForColorSpace = KoColorSpaceRegistry::instance()->defaultProfileForColorSpace(colorSpaceId);
 
    const QString profileName =
        colorModelID == RGBAColorModelID.id() ?
        KisConfig(false).readEntry("ExrDefaultColorProfile", defaultProfileForColorSpace) :
        defaultProfileForColorSpace;
 
    return KoColorSpaceRegistry::instance()->colorSpace(colorModelID, colorDepthID, profileName);
 
}

References KoColorSpaceRegistry::colorSpace(), KoColorSpaceRegistry::colorSpaceId(), KoColorSpaceRegistry::defaultProfileForColorSpace(), Float16BitsColorDepthID, Float32BitsColorDepthID, KoID::id(), KoColorSpaceRegistry::instance(), IT_FLOAT16, IT_FLOAT32, KisConfig::readEntry(), and RGBAColorModelID.

multiplyAlpha()

template<typename T , typename Pixel , int size, int alphaPos>

void multiplyAlpha

(

Pixel *

pixel

)

Definition at line 356 of file exr_converter.cc.

{
    if (alphaPos >= 0) {
        T alpha = pixel->data[alphaPos];
 
        if (alpha > alphaEpsilon<T>()) {
            for (int i = 0; i < size; ++i) {
                if (i != alphaPos) {
                    pixel->data[i] *= alpha;
                }
            }
 
            pixel->data[alphaPos] = alpha;
        } else {
            for (int i = 0; i < size; ++i) {
                pixel->data[i] = 0;
            }
        }
    }
}

qFuzzyCompare()

static bool qFuzzyCompare ( half p1, half p2 )

inlinestatic

Definition at line 233 of file exr_converter.cc.

{
    return std::abs(p1 - p2) < float(HALF_EPSILON);
}

References p1, and p2.

qFuzzyIsNull()

static bool qFuzzyIsNull ( half h )

inlinestatic

Definition at line 238 of file exr_converter.cc.

{
    return std::abs(h) < float(HALF_EPSILON);
}

recCheckGroup()

bool recCheckGroup	(	const ExrGroupLayerInfo &	group,
		QStringList	list,
		int	idx1,
		int	idx2 )

Definition at line 485 of file exr_converter.cc.

{
    if (idx1 > idx2) return true;
    if (group.name == list[idx2]) {
        return recCheckGroup(*group.parent, list, idx1, idx2 - 1);
    }
    return false;
}

References ExrLayerInfoBase::name, ExrLayerInfoBase::parent, and recCheckGroup().

remap()

QString remap	(	const QMap< QString, QString > &	current2original,
		const QString &	current )

Definition at line 1204 of file exr_converter.cc.

{
    if (current2original.contains(current)) {
        return current2original[current];
    }
    return current;
}

searchGroup()

ExrGroupLayerInfo * searchGroup	(	QList< ExrGroupLayerInfo > *	groups,
		QStringList	list,
		int	idx1,
		int	idx2 )

Definition at line 494 of file exr_converter.cc.

{
    if (idx1 > idx2) {
        return 0;
    }
    // Look for the group
    for (int i = 0; i < groups->size(); ++i) {
        if (recCheckGroup(groups->at(i), list, idx1, idx2)) {
            return &(*groups)[i];
        }
    }
    // Create the group
    ExrGroupLayerInfo info;
    info.name = list.at(idx2);
    info.parent = searchGroup(groups, list, idx1, idx2 - 1);
    groups->append(info);
    return &groups->last();
}

References ExrLayerInfoBase::name, ExrLayerInfoBase::parent, recCheckGroup(), and searchGroup().

wrapLayerDevice()

KisPaintDeviceSP wrapLayerDevice

(

KisPaintDeviceSP

device

)

We should try to keep the same profile of the space when possible (i.e. when the color model is kept the same)

Definition at line 1096 of file exr_converter.cc.

{
    const KoColorSpace *cs = device->colorSpace();
 
    if (cs->colorDepthId() != Float16BitsColorDepthID && cs->colorDepthId() != Float32BitsColorDepthID) {
        const KoColorProfile *targetBestEffortProfile = nullptr;
        if (cs->colorModelId() == GrayAColorModelID ||
            cs->colorModelId() == RGBAColorModelID) {
            targetBestEffortProfile = cs->profile();
        }
 
        cs = KoColorSpaceRegistry::instance()->colorSpace(
            cs->colorModelId() == GrayAColorModelID ?
                GrayAColorModelID.id() : RGBAColorModelID.id(),
            Float16BitsColorDepthID.id(),
            targetBestEffortProfile);
    } else if (cs->colorModelId() != GrayAColorModelID &&
               cs->colorModelId() != RGBAColorModelID) {
        cs = KoColorSpaceRegistry::instance()->colorSpace(
            RGBAColorModelID.id(),
            cs->colorDepthId().id());
    }
 
    if (*cs != *device->colorSpace()) {
        device = new KisPaintDevice(*device);
        device->convertTo(cs);
    }
 
    return device;
}

References KoColorSpace::colorDepthId(), KoColorSpace::colorModelId(), KisPaintDevice::colorSpace(), KoColorSpaceRegistry::colorSpace(), KisPaintDevice::convertTo(), Float16BitsColorDepthID, Float32BitsColorDepthID, GrayAColorModelID, KoID::id(), KoColorSpaceRegistry::instance(), KoColorSpace::profile(), and RGBAColorModelID.