koffice/chalk/core/kis_paint_layer.cpp

/*
 *  Copyright (c) 2005 Casper Boemann <cbr@boemann.dk>
 *  Copyright (c) 2006 Bart Coppens <kde@bartcoppens.be>
 *
 *  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 2 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, write to the free software
 *  foundation, inc., 675 mass ave, cambridge, ma 02139, usa.
 */

#include <kdebug.h>
#include <tqimage.h>

#include "kis_debug_areas.h"
#include "kis_image.h"
#include "kis_paint_layer.h"
#include "kis_selection.h"
#include "kis_painter.h"
#include "kis_undo_adapter.h"
#include "kis_iterators_pixel.h"
#include "kis_paint_device.h"
#include "kis_meta_registry.h"
#include "kis_colorspace_factory_registry.h"
#include "kis_datamanager.h"
#include "kis_undo_adapter.h"

KisPaintLayer::KisPaintLayer(KisImage *img, const TQString& name, TQ_UINT8 opacity, KisPaintDeviceSP dev)
    : super(img, name, opacity)
{
    Q_ASSERT(img);
    Q_ASSERT(dev);
    m_paintdev = dev;
    m_mask = 0;
    m_maskAsSelection = 0;
    m_paintdev->setParentLayer(this);
    m_renderMask = false;
    m_editMask = true;
}


KisPaintLayer::KisPaintLayer(KisImage *img, const TQString& name, TQ_UINT8 opacity)
    : super(img, name, opacity)
{
    Q_ASSERT(img);
    m_paintdev = new KisPaintDevice(this, img->colorSpace(), name.latin1());
    m_mask = 0;
    m_maskAsSelection = 0;
    m_renderMask = false;
    m_editMask = true;
}

KisPaintLayer::KisPaintLayer(KisImage *img, const TQString& name, TQ_UINT8 opacity, KisColorSpace * colorSpace)
    : super(img, name, opacity)
{
    Q_ASSERT(img);
    Q_ASSERT(colorSpace);
    m_paintdev = new KisPaintDevice(this, colorSpace,  name.latin1());
    m_mask = 0;
    m_maskAsSelection = 0;
    m_renderMask = false;
    m_editMask = true;
}

KisPaintLayer::KisPaintLayer(const KisPaintLayer& rhs) :
        KisLayer(rhs), KisLayerSupportsIndirectPainting(rhs)
{
    m_paintdev = new KisPaintDevice( *rhs.m_paintdev.data() );
    m_paintdev->setParentLayer(this);
    if (rhs.hasMask()) {
        m_mask = new KisPaintDevice(*rhs.m_mask.data());
        m_mask->setParentLayer(this);
    }
    m_renderMask = rhs.m_renderMask;
    m_editMask = rhs.m_editMask;
}

KisLayerSP KisPaintLayer::clone() const
{
    return new KisPaintLayer(*this);
}

KisPaintLayer::~KisPaintLayer()
{
    if (m_paintdev != 0) {
        m_paintdev->setParentLayer(0);
    }
    if (m_mask != 0) {
        m_mask->setParentLayer(0);
    }
}

void KisPaintLayer::paintSelection(TQImage &img, TQ_INT32 x, TQ_INT32 y, TQ_INT32 w, TQ_INT32 h)
{
    if (m_paintdev && m_paintdev->hasSelection()) {
        m_paintdev->selection()->paintSelection(img, x, y, w, h);
    } else if (m_mask && m_editMask && m_mask->hasSelection()) {
        m_mask->selection()->paintSelection(img, x, y, w, h);
    }
}

void KisPaintLayer::paintSelection(TQImage &img, const TQRect& scaledImageRect, const TQSize& scaledImageSize, const TQSize& imageSize)
{
    if (m_paintdev && m_paintdev->hasSelection()) {
        m_paintdev->selection()->paintSelection(img, scaledImageRect, scaledImageSize, imageSize);
    } else if (m_mask && m_editMask && m_mask->hasSelection()) {
        m_mask->selection()->paintSelection(img, scaledImageRect, scaledImageSize, imageSize);
    }
}

void KisPaintLayer::paintMaskInactiveLayers(TQImage &img, TQ_INT32 x, TQ_INT32 y, TQ_INT32 w, TQ_INT32 h)
{
    uchar *j = img.bits();

    KisColorSpace *cs = m_paintdev->colorSpace();

    for (TQ_INT32 y2 = y; y2 < h + y; ++y2) {
        KisHLineIteratorPixel it = m_paintdev->createHLineIterator(x, y2, w, false);
        while ( ! it.isDone()) {
            TQ_UINT8 s = cs->getAlpha(it.rawData());
            if(s==0)
            {
                TQ_UINT8 g = (*(j + 0)  + *(j + 1 ) + *(j + 2 )) / 9;

                *(j+0) = 128+g ;
                *(j+1) = 165+g;
                *(j+2) = 128+g;
            }
            j+=4;
            ++it;
        }
    }
}

TQImage KisPaintLayer::createThumbnail(TQ_INT32 w, TQ_INT32 h)
{
    if (m_paintdev)
        return m_paintdev->createThumbnail(w, h);
    else
        return TQImage();
}


TQ_INT32 KisPaintLayer::x() const {
    if (m_paintdev)
        return m_paintdev->getX();
    else return 0;
}

void KisPaintLayer::setX(TQ_INT32 x)
{
    if (m_paintdev)
        m_paintdev->setX(x);
}

TQ_INT32 KisPaintLayer::y() const {
    if (m_paintdev)
        return m_paintdev->getY();
    else
        return 0;
}

void KisPaintLayer::setY(TQ_INT32 y) {
    if (m_paintdev)
        m_paintdev->setY(y);
}

TQRect KisPaintLayer::extent() const {
    if (m_paintdev)
        return m_paintdev->extent();
    else
        return TQRect();
}

TQRect KisPaintLayer::exactBounds() const {
    if (m_paintdev)
        return m_paintdev->exactBounds();
    else
        return TQRect();
}

void KisPaintLayer::removeMask() {
    if (!hasMask())
        return;

    m_mask->setParentLayer(0);
    m_mask = 0;
    m_maskAsSelection = 0;
    setDirty();

    emit sigMaskInfoChanged();
}

// ### XXX Do we apply the mask outside the image boundaries too? I'd say no, but I'm not sure
void KisPaintLayer::applyMask() {
    if (!hasMask())
        return;

    int x, y, w, h;
    m_paintdev->extent(x, y, w, h);

    // A bit slow; but it works
    KisPaintDeviceSP temp = new KisPaintDevice(m_paintdev->colorSpace());
    KisPainter gc(temp);
    gc.bltSelection(x, y, COMPOSITE_OVER, m_paintdev, m_maskAsSelection, OPACITY_OPAQUE, x, y, w, h);
    gc.end();
    gc.begin(m_paintdev);
    gc.bitBlt(x, y, COMPOSITE_COPY, temp, OPACITY_OPAQUE, x, y, w, h);
    gc.end();

    removeMask();
}

KisPaintDeviceSP KisPaintLayer::createMask() {
    if (hasMask())
        return m_mask;

    kdDebug() << k_funcinfo << endl;
    // Grey8 nicely fits our needs of being intuitively comparable to other apps'
    // mask layer interfaces. It does have an alpha component though, which is a bit
    // less appropriate in this context.
    m_mask = new KisPaintDevice(KisMetaRegistry::instance()->csRegistry()
            ->getColorSpace(KisID("GRAYA"), 0));

    genericMaskCreationHelper();

    return m_mask;
}

// FIXME If from is a paint device is not grey8!!
void KisPaintLayer::createMaskFromPaintDevice(KisPaintDeviceSP from) {
    if (hasMask())
        return; // Or overwrite? XXX

    kdDebug() << k_funcinfo << endl;
    m_mask = from; // KisPaintDevice(*from); XXX

    genericMaskCreationHelper();
}

void KisPaintLayer::createMaskFromSelection(KisSelectionSP from) {
    kdDebug() << k_funcinfo << endl;
    m_mask = new KisPaintDevice(KisMetaRegistry::instance()->csRegistry()
            ->getColorSpace(KisID("GRAYA"), 0));
    m_mask->setParentLayer(this);

    m_maskAsSelection = new KisSelection(); // Anonymous selection is good enough

    // Default pixel is opaque white == don't mask?
    TQ_UINT8 const defPixel[] = { 255, 255 };
    m_mask->dataManager()->setDefaultPixel(defPixel);

    if (from) {
        TQRect r(extent());

        int w = r.width();
        int h = r.height();
        for (int y = r.y(); y < h; y++) {
            KisHLineIteratorPixel srcIt = from->createHLineIterator(r.x(), y, w, false);
            KisHLineIteratorPixel dstIt = m_mask->createHLineIterator(r.x(), y, w, true);

            while(!dstIt.isDone()) {
                // XXX same remark as in convertMaskToSelection
                *dstIt.rawData() = *srcIt.rawData();
                ++srcIt;
                ++dstIt;
            }
        }
    }

    convertMaskToSelection(extent());
    m_paintdev->deselect();

    setDirty();
    emit sigMaskInfoChanged();
}

KisPaintDeviceSP KisPaintLayer::getMask() {
    createMask();
    kdDebug() << k_funcinfo << endl;
    return m_mask;
}

KisSelectionSP KisPaintLayer::getMaskAsSelection() {
    createMask();
    kdDebug() << k_funcinfo << endl;
    return m_maskAsSelection;
}

void KisPaintLayer::setEditMask(bool b) {
    m_editMask = b;
    emit sigMaskInfoChanged();
}

void KisPaintLayer::setRenderMask(bool b) {
    m_renderMask = b;

    if (hasMask())
        setDirty();

    emit sigMaskInfoChanged();
}

void KisPaintLayer::convertMaskToSelection(const TQRect& r) {
    KisRectIteratorPixel srcIt = m_mask->createRectIterator(r.x(), r.y(),
            r.width(), r.height(), false);
    KisRectIteratorPixel dstIt = m_maskAsSelection->createRectIterator(r.x(), r.y(),
            r.width(), r.height(), true);

    while(!dstIt.isDone()) {
        // src is grey8 (grey + alpha), dst is alpha8. We convert the grey value to
        // alpha8 manually and ignore the alpha (that's why we don't convert using default
        // functions, and interpret the data raw!) [ XXX ]
        *dstIt.rawData() = *srcIt.rawData();
        ++srcIt;
        ++dstIt;
    }
}

void KisPaintLayer::genericMaskCreationHelper() {
    m_mask->setParentLayer(this);

    m_maskAsSelection = new KisSelection(); // Anonymous selection is good enough

    // Default pixel is opaque white == don't mask?
    TQ_UINT8 const defPixel[] = { 255, 255 };
    m_mask->dataManager()->setDefaultPixel(defPixel);

    setDirty();
    emit sigMaskInfoChanged();
}

void KisPaintLayer::setDirty(bool propagate) {
    if (hasMask())
        convertMaskToSelection(extent());
    super::setDirty(propagate);
}

void KisPaintLayer::setDirty(const TQRect & rect, bool propagate) {
    if (hasMask())
        convertMaskToSelection(rect);
    super::setDirty(rect, propagate);
}

// Undoable versions code
namespace {
    class KisCreateMaskCommand : public KNamedCommand {
        typedef KNamedCommand super;
        KisPaintLayerSP m_layer;
        KisPaintDeviceSP m_mask;
    public:
        KisCreateMaskCommand(const TQString& name, KisPaintLayer* layer)
            : super(name), m_layer(layer) {}
        virtual void execute() {
            kdDebug() << k_funcinfo << endl;
            if (!m_mask)
                m_mask = m_layer->createMask();
            else
                m_layer->createMaskFromPaintDevice(m_mask);
        }
        virtual void unexecute() {
            m_layer->removeMask();
        }
    };

    class KisMaskFromSelectionCommand : public KNamedCommand {
        typedef KNamedCommand super;
        KisPaintLayerSP m_layer;
        KisPaintDeviceSP m_maskBefore;
        KisPaintDeviceSP m_maskAfter;
        KisSelectionSP m_selection;
    public:
        KisMaskFromSelectionCommand(const TQString& name, KisPaintLayer* layer)
            : super(name), m_layer(layer) {
            if (m_layer->hasMask())
                m_maskBefore = m_layer->getMask();
            else
                m_maskBefore = 0;
            m_maskAfter = 0;
            if (m_layer->paintDevice()->hasSelection())
                m_selection = m_layer->paintDevice()->selection();
            else
                m_selection = 0;
        }
        virtual void execute() {
            if (!m_maskAfter) {
                m_layer->createMaskFromSelection(m_selection);
                m_maskAfter = m_layer->getMask();
            } else {
                m_layer->paintDevice()->deselect();
                m_layer->createMaskFromPaintDevice(m_maskAfter);
            }
        }
        virtual void unexecute() {
            m_layer->paintDevice()->setSelection(m_selection);
            if (m_maskBefore)
                m_layer->createMaskFromPaintDevice(m_maskBefore);
            else
                m_layer->removeMask();
        }
    };

    class KisMaskToSelectionCommand : public KNamedCommand {
        typedef KNamedCommand super;
        KisPaintLayerSP m_layer;
        KisPaintDeviceSP m_mask;
        KisSelectionSP m_selection;
    public:
        KisMaskToSelectionCommand(const TQString& name, KisPaintLayer* layer)
            : super(name), m_layer(layer) {
            m_mask = m_layer->getMask();
            if (m_layer->paintDevice()->hasSelection())
                m_selection = m_layer->paintDevice()->selection();
            else
                m_selection = 0;
        }
        virtual void execute() {
            m_layer->paintDevice()->setSelection(m_layer->getMaskAsSelection());
            m_layer->removeMask();
        }
        virtual void unexecute() {
            if (m_selection)
                m_layer->paintDevice()->setSelection(m_selection);
            else
                m_layer->paintDevice()->deselect();
            m_layer->createMaskFromPaintDevice(m_mask);
        }
    };

    class KisRemoveMaskCommand : public KNamedCommand {
        typedef KNamedCommand super;
        KisPaintLayerSP m_layer;
        KisPaintDeviceSP m_mask;
    public:
        KisRemoveMaskCommand(const TQString& name, KisPaintLayer* layer)
            : super(name), m_layer(layer) {
            m_mask = m_layer->getMask();
        }
        virtual void execute() {
            kdDebug() << k_funcinfo << endl;
            m_layer->removeMask();
        }
        virtual void unexecute() {
            // I hope that if the undo stack unwinds, it will end up here in the right
            // state again; taking a deep-copy sounds like wasteful to me
            m_layer->createMaskFromPaintDevice(m_mask);
        }
    };

    class KisApplyMaskCommand : public KNamedCommand {
        typedef KNamedCommand super;
        KisPaintLayerSP m_layer;
        KisPaintDeviceSP m_mask;
        KisPaintDeviceSP m_original;
    public:
        KisApplyMaskCommand(const TQString& name, KisPaintLayer* layer)
            : super(name), m_layer(layer) {
            m_mask = m_layer->getMask();
            m_original = new KisPaintDevice(*m_layer->paintDevice());
        }
        virtual void execute() {
            m_layer->applyMask();
        }
        virtual void unexecute() {
                // I hope that if the undo stack unwinds, it will end up here in the right
                // state again; taking a deep-copy sounds like wasteful to me
            KisPainter gc(m_layer->paintDevice());
            int x, y, w, h;
            m_layer->paintDevice()->extent(x, y, w, h);

            gc.bitBlt(x, y, COMPOSITE_COPY, m_original, OPACITY_OPAQUE, x, y, w, h);
            gc.end();

            m_layer->createMaskFromPaintDevice(m_mask);
        }
    };
}

KNamedCommand* KisPaintLayer::createMaskCommand() {
    return new KisCreateMaskCommand(i18n("Create Layer Mask"), this);
}

KNamedCommand* KisPaintLayer::maskFromSelectionCommand() {
    return new KisMaskFromSelectionCommand(i18n("Mask From Selection"), this);
}

KNamedCommand* KisPaintLayer::maskToSelectionCommand() {
    return new KisMaskToSelectionCommand(i18n("Mask to Selection"), this);
}


KNamedCommand* KisPaintLayer::removeMaskCommand() {
    return new KisRemoveMaskCommand(i18n("Remove Layer Mask"), this);
}

KNamedCommand* KisPaintLayer::applyMaskCommand() {
    return new KisApplyMaskCommand(i18n("Apply Layer Mask"), this);
}


#include "kis_paint_layer.moc"