PSDSaver Class Reference

#include <psd_saver.h>

Inheritance diagram for PSDSaver:

Public Slots
virtual void	cancel ()

Public Member Functions
KisImportExportErrorCode	buildFile (QIODevice &io)
KisImageSP	image ()
	PSDSaver (KisDocument *doc)
	~PSDSaver () override

Private Attributes
KisDocument *	m_doc
KisImageSP	m_image
bool	m_stop

Detailed Description

Definition at line 24 of file psd_saver.h.

Constructor & Destructor Documentation

PSDSaver()

PSDSaver::PSDSaver

(

KisDocument *

doc

)

Definition at line 76 of file psd_saver.cpp.

    : m_image(doc->savingImage())
    , m_doc(doc)
    , m_stop(false)
{
}

~PSDSaver()

PSDSaver::~PSDSaver ( )

override

Definition at line 83 of file psd_saver.cpp.

{
}

Member Function Documentation

buildFile()

KisImportExportErrorCode PSDSaver::buildFile

(

QIODevice &

io

)

Definition at line 92 of file psd_saver.cpp.

{
    KIS_ASSERT_RECOVER_RETURN_VALUE(m_image, ImportExportCodes::InternalError);
 
    if (m_image->width() > MAX_PSD_SIZE || m_image->height() > MAX_PSD_SIZE) {
        return ImportExportCodes::Failure;
    }
 
    const bool haveLayers = m_image->rootLayer()->childCount() > 1 ||
        m_image->rootLayer()->firstChild()->childCount() > 0 ||
        // check if "oblige child" mechanism is in action, then forbid collapsing
        m_image->rootLayer()->projection() != m_image->rootLayer()->firstChild()->projection() ||
        KisPainter::checkDeviceHasTransparency(
                m_image->rootLayer()->firstChild()->projection());
 
    // HEADER
    PSDHeader header;
    header.signature = "8BPS";
    header.version = 1;
    header.nChannels = haveLayers ?
        m_image->colorSpace()->channelCount() :
        m_image->colorSpace()->colorChannelCount();
 
    header.width = m_image->width();
    header.height = m_image->height();
 
    QPair<psd_color_mode, quint16> colordef = colormodelid_to_psd_colormode(m_image->colorSpace()->colorModelId().id(),
                                                                          m_image->colorSpace()->colorDepthId().id());
 
    if (colordef.first == COLORMODE_UNKNOWN || colordef.second == 0 || colordef.second == 32) {
        m_image->convertImageColorSpace(KoColorSpaceRegistry::instance()->rgb16(), KoColorConversionTransformation::internalRenderingIntent(), KoColorConversionTransformation::internalConversionFlags());
        m_image->waitForDone();
        colordef = colormodelid_to_psd_colormode(m_image->colorSpace()->colorModelId().id(), m_image->colorSpace()->colorDepthId().id());
    }
    header.colormode = colordef.first;
    header.channelDepth = colordef.second;
 
    dbgFile << "header" << header << io.pos();
 
    if (!header.write(io)) {
        dbgFile << "Failed to write header. Error:" << header.error << io.pos();
        return ImportExportCodes::ErrorWhileWriting;
    }
 
    // COLORMODE BlOCK
    PSDColorModeBlock colorModeBlock(header.colormode);
    // XXX: check for annotations that contain the duotone spec
 
    KisAnnotationSP annotation = m_image->annotation("DuotoneColormodeBlock");
    if (annotation) {
        colorModeBlock.duotoneSpecification = annotation->annotation();
    }
 
    dbgFile << "colormode block" << io.pos();
    if (!colorModeBlock.write(io)) {
        dbgFile << "Failed to write colormode block. Error:" << colorModeBlock.error << io.pos();
        return ImportExportCodes::ErrorWhileWriting;
    }
 
    // IMAGE RESOURCES SECTION
    PSDImageResourceSection resourceSection;
 
    vKisAnnotationSP_it it = m_image->beginAnnotations();
    vKisAnnotationSP_it endIt = m_image->endAnnotations();
    while (it != endIt) {
        KisAnnotationSP annotation = (*it);
        if (!annotation || annotation->type().isEmpty()) {
            dbgFile << "Warning: empty annotation";
            it++;
            continue;
        }
 
        dbgFile << "Annotation:" << annotation->type() << annotation->description();
 
        if (annotation->type().startsWith(QString("PSD Resource Block:"))) { //
            PSDResourceBlock *resourceBlock = dynamic_cast<PSDResourceBlock*>(annotation.data());
            if (resourceBlock) {
                dbgFile << "Adding PSD Resource Block" << resourceBlock->identifier;
                resourceSection.resources[(PSDImageResourceSection::PSDResourceID)resourceBlock->identifier] = resourceBlock;
            }
        }
 
        it++;
    }
 
    // Add resolution block
    {
        RESN_INFO_1005 *resInfo = new RESN_INFO_1005;
        resInfo->hRes = INCH_TO_POINT(m_image->xRes());
        resInfo->vRes = INCH_TO_POINT(m_image->yRes());
        PSDResourceBlock *block = new PSDResourceBlock;
        block->identifier = PSDImageResourceSection::RESN_INFO;
        block->resource = resInfo;
        resourceSection.resources[PSDImageResourceSection::RESN_INFO] = block;
    }
 
    // Add grid/guides block
    {
        GRID_GUIDE_1032 *gridGuidesInfo = new GRID_GUIDE_1032;
        QList<quint32> verticalGuides;
        Q_FOREACH(qreal guide, m_doc->guidesConfig().verticalGuideLines()) {
            verticalGuides.append(guide * m_image->xRes());
        }
        QList<quint32> horizontalGuides;
        Q_FOREACH(qreal guide, m_doc->guidesConfig().horizontalGuideLines()) {
            horizontalGuides.append(guide * m_image->xRes());
        }
        gridGuidesInfo->verticalGuides = verticalGuides;
        gridGuidesInfo->horizontalGuides = horizontalGuides;
        PSDResourceBlock *block = new PSDResourceBlock;
        block->identifier = PSDImageResourceSection::GRID_GUIDE;
        block->resource = gridGuidesInfo;
        resourceSection.resources[PSDImageResourceSection::GRID_GUIDE] = block;
    }
 
    // Add icc block
    {
        ICC_PROFILE_1039 *profileInfo = new ICC_PROFILE_1039;
        profileInfo->icc = m_image->profile()->rawData();
        PSDResourceBlock *block = new PSDResourceBlock;
        block->identifier = PSDImageResourceSection::ICC_PROFILE;
        block->resource = profileInfo;
        resourceSection.resources[PSDImageResourceSection::ICC_PROFILE] = block;
 
    }
 
    dbgFile << "resource section" << io.pos();
    if (!resourceSection.write(io)) {
        dbgFile << "Failed to write resource section. Error:" << resourceSection.error << io.pos();
        return ImportExportCodes::ErrorWhileWriting;
    }
 
    // LAYER AND MASK DATA
    // Only save layers and masks if there is more than one layer
    dbgFile << "m_image->rootLayer->childCount" << m_image->rootLayer()->childCount() << io.pos();
 
    if (haveLayers) {
 
        PSDLayerMaskSection layerSection(header);
        layerSection.hasTransparency = true;
 
        if (!layerSection.write(io, m_image->rootLayer(), psd_compression_type::RLE)) {
            dbgFile << "failed to write layer section. Error:" << layerSection.error << io.pos();
            return ImportExportCodes::ErrorWhileWriting;
        }
    }
    else {
        // else write a zero length block
        dbgFile << "No layers, saving empty layers/mask block" << io.pos();
        psdwrite(io, (quint32)0);
    }
 
    // IMAGE DATA
    dbgFile << "Saving composited image" << io.pos();
    PSDImageData imagedata(&header);
    // Photoshop compresses layer data by default with RLE.
    if (!imagedata.write(io, m_image->projection(), haveLayers, psd_compression_type::RLE)) {
        dbgFile << "Failed to write image data. Error:"  << imagedata.error;
        return ImportExportCodes::ErrorWhileWriting;
    }
 
    return ImportExportCodes::OK;
}

References KisImage::annotation(), KisImage::beginAnnotations(), KoColorSpace::channelCount(), PSDHeader::channelDepth, KisPainter::checkDeviceHasTransparency(), KisNode::childCount(), KoColorSpace::colorChannelCount(), KoColorSpace::colorDepthId(), PSDHeader::colormode, COLORMODE_UNKNOWN, KoColorSpace::colorModelId(), colormodelid_to_psd_colormode(), KisImage::colorSpace(), KisImage::convertImageColorSpace(), KisSharedPtr< T >::data(), dbgFile, PSDColorModeBlock::duotoneSpecification, KisImage::endAnnotations(), PSDHeader::error, PSDLayerMaskSection::error, PSDImageResourceSection::error, PSDColorModeBlock::error, PSDImageData::error, ImportExportCodes::ErrorWhileWriting, ImportExportCodes::Failure, KisNode::firstChild(), PSDImageResourceSection::GRID_GUIDE, KisDocument::guidesConfig, PSDLayerMaskSection::hasTransparency, KisImage::height(), PSDHeader::height, KisGuidesConfig::horizontalGuideLines(), GRID_GUIDE_1032::horizontalGuides, RESN_INFO_1005::hRes, ICC_PROFILE_1039::icc, PSDImageResourceSection::ICC_PROFILE, KoID::id(), PSDResourceBlock::identifier, INCH_TO_POINT(), KoColorSpaceRegistry::instance(), KoColorConversionTransformation::internalConversionFlags(), ImportExportCodes::InternalError, KoColorConversionTransformation::internalRenderingIntent(), KIS_ASSERT_RECOVER_RETURN_VALUE, m_doc, m_image, MAX_PSD_SIZE, PSDHeader::nChannels, ImportExportCodes::OK, KisImage::profile(), KisImage::projection(), KisBaseNode::projection(), KisLayer::projection(), psdwrite(), KoColorProfile::rawData(), PSDImageResourceSection::RESN_INFO, PSDImageResourceSection::resources, RLE, KisImage::rootLayer(), PSDHeader::signature, PSDHeader::version, KisGuidesConfig::verticalGuideLines(), GRID_GUIDE_1032::verticalGuides, RESN_INFO_1005::vRes, KisImage::waitForDone(), KisImage::width(), PSDHeader::width, PSDHeader::write(), PSDImageResourceSection::write(), PSDColorModeBlock::write(), PSDLayerMaskSection::write(), PSDImageData::write(), KisImage::xRes(), and KisImage::yRes().

cancel

void PSDSaver::cancel ( )

virtualslot

Definition at line 257 of file psd_saver.cpp.

{
    m_stop = true;
}

References m_stop.

image()

KisImageSP PSDSaver::image

(

)

Definition at line 87 of file psd_saver.cpp.

{
    return m_image;
}

References m_image.

Member Data Documentation

m_doc

KisDocument* PSDSaver::m_doc

private

Definition at line 44 of file psd_saver.h.

m_image

KisImageSP PSDSaver::m_image

private

Definition at line 43 of file psd_saver.h.

m_stop

bool PSDSaver::m_stop

private

Definition at line 45 of file psd_saver.h.

---

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

• plugins/impex/psd/psd_saver.h
• plugins/impex/psd/psd_saver.cpp