File indexing completed on 2024-05-12 15:58:45

 /*
  *  SPDX-FileCopyrightText: 2007 Boudewijn Rempt <boud@valdyas.org>
  *
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #include <KoIcon.h>
 #include <kis_icon.h>
 #include <KoCompositeOpRegistry.h>
 
 #include "kis_layer.h"
 #include "kis_transform_mask.h"
 #include "filter/kis_filter.h"
 #include "filter/kis_filter_configuration.h"
 #include "filter/kis_filter_registry.h"
 #include "kis_selection.h"
 #include "kis_processing_information.h"
 #include "kis_node.h"
 #include "kis_node_visitor.h"
 #include "kis_processing_visitor.h"
 #include "kis_node_progress_proxy.h"
 #include "kis_transaction.h"
 #include "kis_painter.h"
 
 #include "kis_busy_progress_indicator.h"
 #include "kis_perspectivetransform_worker.h"
 #include "kis_transform_mask_params_interface.h"
 #include "kis_transform_mask_params_factory_registry.h"
 #include "kis_recalculate_transform_mask_job.h"
 #include "kis_thread_safe_signal_compressor.h"
 #include "kis_algebra_2d.h"
 #include "kis_safe_transform.h"
 #include "kis_keyframe_channel.h"
 #include "kis_raster_keyframe_channel.h"
 #include "kis_scalar_keyframe_channel.h"
 
 #include "kis_image_config.h"
 #include "kis_lod_capable_layer_offset.h"
 
 //#include "kis_paint_device_debug_utils.h"
 //#define DEBUG_RENDERING
 //#define DUMP_RECT QRect(0,0,512,512)
 
 #define UPDATE_DELAY 3000 /*ms */
 
 struct Q_DECL_HIDDEN KisTransformMask::Private
 {
     Private(KisImageSP image)
         : worker(0, QTransform(), true, 0),
           staticCacheValid(false),
           recalculatingStaticImage(false),
           offset(new KisDefaultBounds(image)),
           updateSignalCompressor(UPDATE_DELAY, KisSignalCompressor::POSTPONE),
           offBoundsReadArea(0.5)
     {
     }
 
     Private(const Private &rhs)
         : worker(rhs.worker),
           params(rhs.params->clone()),
           staticCacheValid(rhs.staticCacheValid),
           recalculatingStaticImage(rhs.recalculatingStaticImage),
           staticCacheDevice(nullptr),
           offset(rhs.offset),
           updateSignalCompressor(UPDATE_DELAY, KisSignalCompressor::POSTPONE),
           offBoundsReadArea(rhs.offBoundsReadArea)
     {
     }
 
     void reloadParameters()
     {
         QTransform affineTransform;
         if (params->isAffine()) {
             affineTransform = params->finalAffineTransform();
         }
         worker.setForwardTransform(affineTransform);
 
         params->clearChangedFlag();
         staticCacheValid = false;
     }
 
     KisPerspectiveTransformWorker worker;
     KisTransformMaskParamsInterfaceSP params;
 
     bool staticCacheValid;
     bool recalculatingStaticImage;
     KisPaintDeviceSP staticCacheDevice;
     bool staticCacheIsOverridden = false;
 
     KisLodCapableLayerOffset offset;
 
     KisThreadSafeSignalCompressor updateSignalCompressor;
     qreal offBoundsReadArea;
 };
 
 
 KisTransformMask::KisTransformMask(KisImageWSP image, const QString &name)
     : KisEffectMask(image, name),
       m_d(new Private(image))
 {
     setTransformParams(
         KisTransformMaskParamsInterfaceSP(
             new KisDumbTransformMaskParams()));
 
     connect(&m_d->updateSignalCompressor, SIGNAL(timeout()), SLOT(slotDelayedStaticUpdate()));
     connect(this, SIGNAL(sigInternalForceStaticImageUpdate()), SLOT(slotInternalForceStaticImageUpdate()));
     m_d->offBoundsReadArea = KisImageConfig(true).transformMaskOffBoundsReadArea();
     setSupportsLodMoves(false);
 }
 
 KisTransformMask::~KisTransformMask()
 {
 }
 
 KisTransformMask::KisTransformMask(const KisTransformMask& rhs)
     : KisEffectMask(rhs),
       m_d(new Private(*rhs.m_d))
 {
     connect(&m_d->updateSignalCompressor, SIGNAL(timeout()), SLOT(slotDelayedStaticUpdate()));
 
     KisAnimatedTransformParamsInterface* rhsAniTransform = dynamic_cast<KisAnimatedTransformParamsInterface*>(rhs.m_d->params.data());
     KisAnimatedTransformParamsInterface* aniTransform = dynamic_cast<KisAnimatedTransformParamsInterface*>(m_d->params.data());
     if(rhsAniTransform && aniTransform) {
         QList<KisKeyframeChannel*> chans;
         chans = aniTransform->copyChannelsFrom(rhsAniTransform);
         foreach( KisKeyframeChannel* chan, chans) {
             addKeyframeChannel(chan);
         }
     }
 }
 
 KisPaintDeviceSP KisTransformMask::paintDevice() const
 {
     return 0;
 }
 
 QIcon KisTransformMask::icon() const
 {
     return KisIconUtils::loadIcon("transformMask");
 }
 
 void KisTransformMask::setTransformParams(KisTransformMaskParamsInterfaceSP params)
 {
     KIS_ASSERT_RECOVER(params) {
         params = KisTransformMaskParamsInterfaceSP(
             new KisDumbTransformMaskParams());
     }
 
     m_d->params = params;
 
     m_d->reloadParameters();
 
     m_d->updateSignalCompressor.stop();
 }
 
 KisTransformMaskParamsInterfaceSP KisTransformMask::transformParams() const
 {
     return m_d->params;
 }
 
 void KisTransformMask::slotDelayedStaticUpdate()
 {
     /**
      * The mask might have been deleted from the layers stack in the
      * meanwhile. Just ignore the updates in the case.
      */
 
     KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
     if (!parentLayer) return;
 
     KisImageSP image = parentLayer->image();
     if (image) {
         image->addSpontaneousJob(new KisRecalculateTransformMaskJob(this));
     }
 }
 
 KisPaintDeviceSP KisTransformMask::buildPreviewDevice()
 {
     /**
      * Note: this function must be called from within the scheduler's
      * context. We are accessing parent's updateProjection(), which
      * is not entirely safe. The calling job must ensure it is the
      * only job running.
      */
 
     KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
     KIS_ASSERT_RECOVER(parentLayer) { return new KisPaintDevice(colorSpace()); }
 
     KisPaintDeviceSP device =
         new KisPaintDevice(parentLayer->original()->colorSpace());
     device->setDefaultBounds(parentLayer->original()->defaultBounds());
 
     QRect requestedRect = parentLayer->original()->exactBounds();
     parentLayer->buildProjectionUpToNode(device, this, requestedRect);
 
     return device;
 }
 
 KisPaintDeviceSP KisTransformMask::buildSourcePreviewDevice()
 {
     /**
      * Note: this function must be called from within the scheduler's
      * context. We are accessing parent's updateProjection(), which
      * is not entirely safe. The calling job must ensure it is the
      * only job running.
      */
 
     KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
     KIS_ASSERT_RECOVER(parentLayer) { return new KisPaintDevice(colorSpace()); }
 
     KisPaintDeviceSP device =
         new KisPaintDevice(parentLayer->original()->colorSpace());
     device->setDefaultBounds(parentLayer->original()->defaultBounds());
 
     QRect requestedRect = parentLayer->original()->exactBounds();
 
     KisNodeSP prevSibling = this->prevSibling();
     if (prevSibling) {
         parentLayer->buildProjectionUpToNode(device, prevSibling, requestedRect);
     } else {
         requestedRect = parentLayer->outgoingChangeRect(requestedRect);
         parentLayer->copyOriginalToProjection(parentLayer->original(), device, requestedRect);
     }
 
     return device;
 }
 
 void KisTransformMask::overrideStaticCacheDevice(KisPaintDeviceSP device)
 {
     m_d->staticCacheDevice->clear();
 
     if (device) {
         const QRect rc = device->extent();
         KisPainter::copyAreaOptimized(rc.topLeft(), device, m_d->staticCacheDevice, rc);
     }
 
     m_d->staticCacheValid = bool(device);
     m_d->staticCacheIsOverridden = bool(device);
 }
 
 void KisTransformMask::recaclulateStaticImage()
 {
     /**
      * Note: this function must be called from within the scheduler's
      * context. We are accessing parent's updateProjection(), which
      * is not entirely safe.
      */
 
     KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
     KIS_SAFE_ASSERT_RECOVER_RETURN(parentLayer);
 
     // It might happen that the mask became invisible in the meantime
     // and the projection has become disabled. That mush be "impossible"
     // situation, hence assert.
     KIS_SAFE_ASSERT_RECOVER_RETURN(parentLayer->projection() != parentLayer->paintDevice());
 
     if (!m_d->staticCacheDevice ||
         *m_d->staticCacheDevice->colorSpace() != *parentLayer->original()->colorSpace()) {
 
         m_d->staticCacheDevice =
             new KisPaintDevice(parentLayer->original()->colorSpace());
         m_d->staticCacheDevice->setDefaultBounds(parentLayer->original()->defaultBounds());
     }
 
     m_d->recalculatingStaticImage = true;
     /**
      * updateProjection() is assuming that the requestedRect takes
      * into account all the change rects of all the masks. Usually,
      * this work is done by the walkers.
      */
     QRect requestedRect =
         parentLayer->changeRect(parentLayer->original()->exactBounds());
 
     // force reset parent layer's projection, because we might have changed
     // our mask parameters and going to write to some other area
     parentLayer->projection()->clear();
 
     /**
      * Here we use updateProjection() to regenerate the projection of
      * the layer and after that a special update call (no-filthy) will
      * be issued to pass the changed further through the stack.
      */
     parentLayer->updateProjection(requestedRect, this);
     m_d->recalculatingStaticImage = false;
 
     m_d->staticCacheValid = true;
 }
 
 QRect KisTransformMask::decorateRect(KisPaintDeviceSP &src,
                                      KisPaintDeviceSP &dst,
                                      const QRect & rc,
                                      PositionToFilthy maskPos) const
 {
     Q_ASSERT_X(src != dst, "KisTransformMask::decorateRect",
                "src must be != dst, because we can't create transactions "
                "during merge, as it breaks reentrancy");
 
     KIS_ASSERT_RECOVER(m_d->params) { return rc; }
 
     if (m_d->params->isHidden()) return rc;
     KIS_ASSERT_RECOVER_NOOP(maskPos == N_FILTHY ||
                             maskPos == N_ABOVE_FILTHY ||
                             maskPos == N_BELOW_FILTHY);
 
     if (m_d->params->hasChanged()) m_d->reloadParameters();
 
     if (!m_d->staticCacheIsOverridden &&
         !m_d->recalculatingStaticImage &&
         (maskPos == N_FILTHY || maskPos == N_ABOVE_FILTHY)) {
 
         m_d->staticCacheValid = false;
         m_d->updateSignalCompressor.start();
     }
 
     if (m_d->recalculatingStaticImage) {
         m_d->staticCacheDevice->clear();
         m_d->params->transformDevice(const_cast<KisTransformMask*>(this), src, m_d->staticCacheDevice);
         QRect updatedRect = m_d->staticCacheDevice->extent();
         KisPainter::copyAreaOptimized(updatedRect.topLeft(), m_d->staticCacheDevice, dst, updatedRect);
 
 #ifdef DEBUG_RENDERING
         qDebug() << "Recalculate" << name() << ppVar(src->exactBounds()) << ppVar(dst->exactBounds()) << ppVar(rc);
         KIS_DUMP_DEVICE_2(src, DUMP_RECT, "recalc_src", "dd");
         KIS_DUMP_DEVICE_2(dst, DUMP_RECT, "recalc_dst", "dd");
 #endif /* DEBUG_RENDERING */
 
     } else if (!m_d->staticCacheValid && !m_d->staticCacheIsOverridden && m_d->params->isAffine()) {
         m_d->worker.runPartialDst(src, dst, rc);
 
 #ifdef DEBUG_RENDERING
         qDebug() << "Partial" << name() << ppVar(src->exactBounds()) << ppVar(src->extent()) << ppVar(dst->exactBounds()) << ppVar(dst->extent()) << ppVar(rc);
         KIS_DUMP_DEVICE_2(src, DUMP_RECT, "partial_src", "dd");
         KIS_DUMP_DEVICE_2(dst, DUMP_RECT, "partial_dst", "dd");
 #endif /* DEBUG_RENDERING */
 
     } else if ((m_d->staticCacheValid || m_d->staticCacheIsOverridden) && m_d->staticCacheDevice) {
         KisPainter::copyAreaOptimized(rc.topLeft(), m_d->staticCacheDevice, dst, rc);
 
 #ifdef DEBUG_RENDERING
         qDebug() << "Fetch" << name() << ppVar(src->exactBounds()) << ppVar(dst->exactBounds()) << ppVar(rc);
         KIS_DUMP_DEVICE_2(src, DUMP_RECT, "fetch_src", "dd");
         KIS_DUMP_DEVICE_2(dst, DUMP_RECT, "fetch_dst", "dd");
 #endif /* DEBUG_RENDERING */
 
     }
 
     KIS_ASSERT_RECOVER_NOOP(this->busyProgressIndicator());
     this->busyProgressIndicator()->update();
 
     return rc;
 }
 
 bool KisTransformMask::accept(KisNodeVisitor &v)
 {
     return v.visit(this);
 }
 
 void KisTransformMask::accept(KisProcessingVisitor &visitor, KisUndoAdapter *undoAdapter)
 {
     return visitor.visit(this, undoAdapter);
 }
 
 QRect KisTransformMask::changeRect(const QRect &rect, PositionToFilthy pos) const
 {
     Q_UNUSED(pos);
 
     /**
      * FIXME: This check of the emptiness should be done
      * on the higher/lower level
      */
     if (rect.isEmpty()) return rect;
 
     QRect changeRect = rect;
 
     if (m_d->params->isAffine()) {
         QRect bounds;
         QRect interestRect;
         KisNodeSP parentNode = parent();
 
         if (parentNode) {
             bounds = parentNode->original()->defaultBounds()->bounds();
             interestRect = parentNode->original()->extent();
         } else {
             bounds = QRect(0,0,777,777);
             interestRect = QRect(0,0,888,888);
             warnKrita << "WARNING: transform mask has no parent (change rect)."
                       << "Cannot run safe transformations."
                       << "Will limit bounds to" << ppVar(bounds);
         }
 
         const QRect limitingRect = KisAlgebra2D::blowRect(bounds, m_d->offBoundsReadArea);
 
         if (m_d->params->hasChanged()) m_d->reloadParameters();
         KisSafeTransform transform(m_d->worker.forwardTransform(), limitingRect, interestRect);
         changeRect = transform.mapRectForward(rect);
     } else {
         QRect interestRect;
         interestRect = parent() ? parent()->original()->extent() : QRect();
 
         changeRect = m_d->params->nonAffineChangeRect(rect);
     }
 
     return changeRect;
 }
 
 QRect KisTransformMask::needRect(const QRect& rect, PositionToFilthy pos) const
 {
     Q_UNUSED(pos);
 
     /**
      * FIXME: This check of the emptiness should be done
      * on the higher/lower level
      */
     if (rect.isEmpty()) return rect;
     if (!m_d->params->isAffine()) return rect;
 
     QRect bounds;
     QRect interestRect;
     KisNodeSP parentNode = parent();
 
     if (parentNode) {
         bounds = parentNode->original()->defaultBounds()->bounds();
         interestRect = parentNode->original()->extent();
     } else {
         bounds = QRect(0,0,777,777);
         interestRect = QRect(0,0,888,888);
         warnKrita << "WARNING: transform mask has no parent (need rect)."
                    << "Cannot run safe transformations."
                    << "Will limit bounds to" << ppVar(bounds);
     }
 
     QRect needRect = rect;
 
     if (m_d->params->isAffine()) {
         const QRect limitingRect = KisAlgebra2D::blowRect(bounds, m_d->offBoundsReadArea);
 
         if (m_d->params->hasChanged()) m_d->reloadParameters();
         KisSafeTransform transform(m_d->worker.forwardTransform(), limitingRect, interestRect);
         needRect = transform.mapRectBackward(rect);
 
         /**
          * When sampling affine transformations we use KisRandomSubAccessor,
          * which uses bilinear interpolation for calculating pixels. Therefore,
          * we need to extend the sides of the need rect by one pixel.
          */
         needRect = kisGrowRect(needRect, 1);
 
     } else {
         needRect = m_d->params->nonAffineNeedRect(rect, interestRect);
     }
 
     return needRect;
 }
 
 QRect KisTransformMask::extent() const
 {
     QRect rc = KisMask::extent();
 
     QRect partialChangeRect;
     QRect existentProjection;
     KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
     if (parentLayer) {
         partialChangeRect = parentLayer->partialChangeRect(const_cast<KisTransformMask*>(this), rc);
         existentProjection = parentLayer->projection()->extent();
     }
 
     return changeRect(partialChangeRect) | existentProjection;
 }
 
 QRect KisTransformMask::exactBounds() const
 {
     QRect existentProjection;
     KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
     if (parentLayer) {
         existentProjection = parentLayer->projection()->exactBounds();
 
         /* Take into account multiple keyframes... */
         if (parentLayer->original() && parentLayer->original()->defaultBounds() && parentLayer->original()->keyframeChannel()) {
             Q_FOREACH( const int& time, parentLayer->original()->keyframeChannel()->allKeyframeTimes() ) {
                 KisRasterKeyframeSP keyframe = parentLayer->original()->keyframeChannel()->keyframeAt<KisRasterKeyframe>(time);
                 existentProjection |= keyframe->contentBounds();
             }
         }
     }
 
     if (isAnimated()) {
         existentProjection |= changeRect(image()->bounds());
     }
 
     return changeRect(sourceDataBounds()) | existentProjection;
 }
 
 QRect KisTransformMask::sourceDataBounds() const
 {
     /// NOTE: we should avoid including parent layer's projection's
     ///       extent into the source of changeRect calculation, because
     ///       that is exactly what partialChangeRect() calculates.
 
     QRect partialChangeRect;
     KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
     if (parentLayer) {
         const QRect rc = parentLayer->original()->exactBounds();
         partialChangeRect = parentLayer->partialChangeRect(const_cast<KisTransformMask*>(this), rc);
     }
 
     return partialChangeRect;
 }
 
 qint32 KisTransformMask::x() const
 {
     return m_d->offset.x();
 }
 
 qint32 KisTransformMask::y() const
 {
     return m_d->offset.y();
 }
 
 void KisTransformMask::setX(qint32 x)
 {
     m_d->params->translateSrcAndDst(QPointF(x - this->x(), 0));
     setTransformParams(m_d->params);
     m_d->offset.setX(x);
 }
 
 void KisTransformMask::setY(qint32 y)
 {
     m_d->params->translateSrcAndDst(QPointF(0, y - this->y()));
     setTransformParams(m_d->params);
     m_d->offset.setY(y);
 }
 
 void KisTransformMask::forceUpdateTimedNode()
 {
     if (hasPendingTimedUpdates()) {
         KIS_SAFE_ASSERT_RECOVER_NOOP(!m_d->staticCacheValid);
 
         m_d->updateSignalCompressor.stop();
         slotDelayedStaticUpdate();
     }
 }
 
 bool KisTransformMask::hasPendingTimedUpdates() const
 {
     return m_d->updateSignalCompressor.isActive();
 }
 
 void KisTransformMask::threadSafeForceStaticImageUpdate()
 {
     emit sigInternalForceStaticImageUpdate();
 }
 
 void KisTransformMask::syncLodCache()
 {
     m_d->offset.syncLodOffset();
     KisEffectMask::syncLodCache();
 }
 
 KisPaintDeviceList KisTransformMask::getLodCapableDevices() const
 {
     KisPaintDeviceList devices;
     devices += KisEffectMask::getLodCapableDevices();
     if (m_d->staticCacheDevice) {
         devices << m_d->staticCacheDevice;
     }
     return devices;
 }
 
 void KisTransformMask::slotInternalForceStaticImageUpdate()
 {
     m_d->updateSignalCompressor.stop();
     slotDelayedStaticUpdate();
 }
 
 KisKeyframeChannel *KisTransformMask::requestKeyframeChannel(const QString &id)
 {
     if (id == KisKeyframeChannel::PositionX.id() ||
         id == KisKeyframeChannel::PositionY.id() ||
         id == KisKeyframeChannel::ScaleX.id() ||
         id == KisKeyframeChannel::ScaleY.id() ||
         id == KisKeyframeChannel::ShearX.id() ||
         id == KisKeyframeChannel::ShearY.id() ||
         id == KisKeyframeChannel::RotationX.id() ||
         id == KisKeyframeChannel::RotationY.id() ||
         id == KisKeyframeChannel::RotationZ.id()) {
 
         KisAnimatedTransformParamsInterface *animatedParams = dynamic_cast<KisAnimatedTransformParamsInterface*>(m_d->params.data());
 
         if (!animatedParams) {
             auto converted = KisTransformMaskParamsFactoryRegistry::instance()->animateParams(m_d->params, this);
             if (converted.isNull()) return KisEffectMask::requestKeyframeChannel(id);
             m_d->params = converted;
             animatedParams = dynamic_cast<KisAnimatedTransformParamsInterface*>(converted.data());
         }
 
         KisKeyframeChannel *channel = animatedParams->requestKeyframeChannel(id, this);
         if (channel) {
             channel->setNode(this);
             channel->setDefaultBounds(new KisDefaultBounds(this->image()));
             return channel;
         }
     }
 
     return KisEffectMask::requestKeyframeChannel(id);
 }
 
 bool KisTransformMask::supportsKeyframeChannel(const QString &id)
 {
     if (id == KisKeyframeChannel::PositionX.id() ||
         id == KisKeyframeChannel::PositionY.id() ||
         id == KisKeyframeChannel::ScaleX.id() ||
         id == KisKeyframeChannel::ScaleY.id() ||
         id == KisKeyframeChannel::ShearX.id() ||
         id == KisKeyframeChannel::ShearY.id() ||
         id == KisKeyframeChannel::RotationX.id() ||
         id == KisKeyframeChannel::RotationY.id() ||
             id == KisKeyframeChannel::RotationZ.id()) {
         return true;
     }
     else if (id == KisKeyframeChannel::Opacity.id()) {
         return false;
     }
 
     return KisEffectMask::supportsKeyframeChannel(id);
 }