RGBEImport Class Reference

#include <RGBEImport.h>

Inheritance diagram for RGBEImport:

Public Member Functions
KisImportExportErrorCode	convert (KisDocument *document, QIODevice *io, KisPropertiesConfigurationSP configuration=nullptr) override
	RGBEImport (QObject *parent, const QVariantList &)
bool	supportsIO () const override
	Override and return false for the filters that use a library that cannot handle file handles, only file names.
	~RGBEImport () override=default
Public Member Functions inherited from KisImportExportFilter
virtual KisConfigWidget *	createConfigurationWidget (QWidget *parent, const QByteArray &from="", const QByteArray &to="") const
	createConfigurationWidget creates a widget that can be used to define the settings for a given import/export filter
virtual KisPropertiesConfigurationSP	defaultConfiguration (const QByteArray &from="", const QByteArray &to="") const
	defaultConfiguration defines the default settings for the given import export filter
virtual QMap< QString, KisExportCheckBase * >	exportChecks ()
	generate and return the list of capabilities of this export filter. The list
virtual bool	exportSupportsGuides () const
	exportSupportsGuides Because guides are in the document and not the image, checking for guides cannot be made an exportCheck.
KisPropertiesConfigurationSP	lastSavedConfiguration (const QByteArray &from="", const QByteArray &to="") const
	lastSavedConfiguration return the last saved configuration for this filter
	Private ()
void	setBatchMode (bool batchmode)
void	setFilename (const QString &filename)
void	setImportUserFeedBackInterface (KisImportUserFeedbackInterface *interface)
void	setMimeType (const QString &mime)
void	setRealFilename (const QString &filename)
void	setUpdater (QPointer< KoUpdater > updater)
QPointer< KoUpdater >	updater ()
virtual QString	verify (const QString &fileName) const
	Verify whether the given file is correct and readable.
	~KisImportExportFilter () override
	~Private ()

Additional Inherited Members
Public Attributes inherited from KisImportExportFilter
bool	batchmode
QMap< QString, KisExportCheckBase * >	capabilities
QString	filename
KisImportUserFeedbackInterface *	importUserFeedBackInterface {nullptr}
QByteArray	mime
QString	realFilename
QPointer< KoUpdater >	updater
Static Public Attributes inherited from KisImportExportFilter
static const QString	CICPPrimariesTag = "CICPCompatiblePrimaries"
static const QString	CICPTransferCharacteristicsTag = "CICPCompatibleTransferFunction"
static const QString	ColorDepthIDTag = "ColorDepthID"
static const QString	ColorModelIDTag = "ColorModelID"
static const QString	HDRTag = "HDRSupported"
static const QString	ImageContainsTransparencyTag = "ImageContainsTransparency"
static const QString	sRGBTag = "sRGB"
Protected Member Functions inherited from KisImportExportFilter
void	addCapability (KisExportCheckBase *capability)
void	addSupportedColorModels (QList< QPair< KoID, KoID > > supportedColorModels, const QString &name, KisExportCheckBase::Level level=KisExportCheckBase::PARTIALLY)
bool	batchMode () const
QString	filename () const
KisImportUserFeedbackInterface *	importUserFeedBackInterface () const
virtual void	initializeCapabilities ()
	KisImportExportFilter (QObject *parent=0)
QByteArray	mimeType () const
QString	realFilename () const
void	setProgress (int value)
QString	verifyZiPBasedFiles (const QString &fileName, const QStringList &filesToCheck) const

Detailed Description

Definition at line 12 of file RGBEImport.h.

Constructor & Destructor Documentation

RGBEImport()

RGBEImport::RGBEImport	(	QObject *	parent,
		const QVariantList &	)

Definition at line 51 of file RGBEImport.cpp.

    : KisImportExportFilter(parent)
{
}

~RGBEImport()

RGBEImport::~RGBEImport ( )

overridedefault

Member Function Documentation

convert()

KisImportExportErrorCode RGBEImport::convert ( KisDocument * document, QIODevice * io, KisPropertiesConfigurationSP configuration = nullptr )

overridevirtual

The filter chain calls this method to perform the actual conversion. The passed mimetypes should be a pair of those you specified in your .desktop file. You have to implement this method to make the filter work.

Returns

The error status, see the #ConversionStatus enum. KisImportExportFilter::OK means that everything is alright.

Implements KisImportExportFilter.

Definition at line 57 of file RGBEImport.cpp.

{
    if (!io->isReadable()) {
        errFile << "Cannot read image contents";
        return ImportExportCodes::NoAccessToRead;
    }
 
    if (!(io->peek(11) == "#?RADIANCE\n" || io->peek(7) == "#?RGBE\n")) {
        errFile << "Invalid RGBE header!";
        return ImportExportCodes::ErrorWhileReading;
    }
 
    RGBEImportData d{};
 
    int len;
    QByteArray line(MAXLINE + 1, Qt::Uninitialized);
    QByteArray rawFormat;
    QByteArray rawGamma;
    QByteArray rawExposure;
    QByteArray rawHeaderInfo;
 
    // Parse header
    do {
        len = io->readLine(line.data(), MAXLINE);
        if (line.startsWith("# ")) {
            rawHeaderInfo = line.mid(2, len - 2 - 1 /*\n*/);
        } else if (line.startsWith("GAMMA=")) {
            rawGamma = line.mid(6, len - 6 - 1 /*\n*/);
        } else if (line.startsWith("EXPOSURE=")) {
            rawExposure = line.mid(9, len - 9 - 1 /*\n*/);
        } else if (line.startsWith("FORMAT=")) {
            rawFormat = line.mid(7, len - 7 - 1 /*\n*/);
        }
    } while ((len > 0) && (line[0] != '\n'));
 
    if (rawFormat != "32-bit_rle_rgbe") {
        errFile << "Invalid RGBE format!";
        return ImportExportCodes::ErrorWhileReading;
    }
 
    const QString headerInfo = [&]() {
        if (!rawHeaderInfo.isEmpty()) {
            return QString(rawHeaderInfo).trimmed();
        }
        return QString();
    }();
 
    // Unused fields, I don't know what to do with gamma and exposure fields yet.
    if (!rawGamma.isEmpty()) {
        bool gammaOk = false;
        const float gammaTemp = QString(rawGamma).toFloat(&gammaOk);
        if (gammaOk) {
            d.m_gamma = gammaTemp;
        }
    }
    if (!rawExposure.isEmpty()) {
        bool exposureOk = false;
        const float expTemp = QString(rawExposure).toFloat(&exposureOk);
        if (exposureOk) {
            d.m_exposure = expTemp;
        }
    }
 
    len = io->readLine(line.data(), MAXLINE);
    line.resize(len);
 
    /*
       TODO: handle flipping and rotation, as per the spec below
       The single resolution line consists of 4 values, a X and Y label each followed by a numerical
       integer value. The X and Y are immediately preceded by a sign which can be used to indicate
       flipping, the order of the X and Y indicate rotation. The standard coordinate system for
       Radiance images would have the following resolution string -Y N +X N. This indicates that the
       vertical axis runs down the file and the X axis is to the right (imagining the image as a
       rectangular block of data). A -X would indicate a horizontal flip of the image. A +Y would
       indicate a vertical flip. If the X value appears before the Y value then that indicates that
       the image is stored in column order rather than row order, that is, it is rotated by 90 degrees.
       The reader can convince themselves that the 8 combinations cover all the possible image orientations
       and rotations.
    */
    QRegularExpression resolutionRegExp(QStringLiteral("([+\\-][XY]) ([0-9]+) ([+\\-][XY]) ([0-9]+)\n"));
    QRegularExpressionMatch match = resolutionRegExp.match(QString::fromLatin1(line));
    if (!match.hasMatch()) {
        errFile << "Invalid HDR file, the first line after the header didn't have the expected format:" << line;
        return ImportExportCodes::InternalError;
    }
 
    if ((match.captured(1).at(1) != u'Y') || (match.captured(3).at(1) != u'X')) {
        errFile << "Unsupported image orientation in HDR file.";
        return ImportExportCodes::InternalError;
    }
 
    const int width = match.captured(4).toInt();
    const int height = match.captured(2).toInt();
 
    dbgFile << "RGBE image information:";
    dbgFile << "Program info:" << headerInfo;
    if (!rawGamma.isEmpty()) {
        dbgFile << "Gamma:" << d.m_gamma;
    } else {
        dbgFile << "No gamma metadata provided";
    }
    if (!rawExposure.isEmpty()) {
        dbgFile << "Exposure:" << d.m_exposure;
    } else {
        dbgFile << "No exposure metadata provided";
    }
    dbgFile << "Dimension:" << width << "x" << height;
 
    KisImageSP image;
    KisLayerSP layer;
 
    const KoColorProfile *profile = nullptr;
 
    d.m_colorID = RGBAColorModelID;
    d.m_depthID = Float32BitsColorDepthID;
 
    profile = KoColorSpaceRegistry::instance()->p709G10Profile();
    d.cs = KoColorSpaceRegistry::instance()->colorSpace(d.m_colorID.id(), d.m_depthID.id(), profile);
 
    image = new KisImage(document->createUndoStore(), width, height, d.cs, "RGBE image");
    layer = new KisPaintLayer(image, image->nextLayerName(), OPACITY_OPAQUE_U8);
    d.m_currentFrame = new KisPaintDevice(image->colorSpace());
 
    QDataStream stream(io);
    KisSequentialIterator it(d.m_currentFrame, {0, 0, width, height});
 
    if (!RGBEIMPORT::LoadHDR(stream, width, height, it)) {
        errFile << "Error loading HDR file.";
        return ImportExportCodes::InternalError;
    }
 
    layer->paintDevice()->makeCloneFrom(d.m_currentFrame, image->bounds());
    image->addNode(layer, image->rootLayer().data());
 
    document->setCurrentImage(image);
 
    return ImportExportCodes::OK;
}

References KisNodeFacade::addNode(), KisImage::bounds(), KisImage::colorSpace(), KoColorSpaceRegistry::colorSpace(), KisImportExportFilter::d, KisSharedPtr< T >::data(), dbgFile, errFile, ImportExportCodes::ErrorWhileReading, Float32BitsColorDepthID, KoColorSpaceRegistry::instance(), ImportExportCodes::InternalError, RGBEIMPORT::LoadHDR(), KisPaintDevice::makeCloneFrom(), MAXLINE, KisImage::nextLayerName(), ImportExportCodes::NoAccessToRead, ImportExportCodes::OK, OPACITY_OPAQUE_U8, KoColorSpaceRegistry::p709G10Profile(), KisBaseNode::paintDevice(), RGBAColorModelID, KisImage::rootLayer(), and u.

supportsIO()

bool RGBEImport::supportsIO ( ) const

inlineoverridevirtual

Override and return false for the filters that use a library that cannot handle file handles, only file names.

Reimplemented from KisImportExportFilter.

Definition at line 18 of file RGBEImport.h.

{ return true; }

---

The documentation for this class was generated from the following files:

• plugins/impex/rgbe/RGBEImport.h
• plugins/impex/rgbe/RGBEImport.cpp