File indexing completed on 2024-06-16 04:16:43

 /*
  * This file is part of the KDE project
  *
  * SPDX-FileCopyrightText: 2004 Michael Thaler <michael.thaler@physik.tu-muenchen.de>
  *
  * ported from digikam, copyrighted 2004 by Gilles Caulier,
  * Original RainDrops algorithm copyrighted 2004 by
  * Pieter Z. Voloshyn <pieter_voloshyn at ame.com.br>.
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #include "kis_raindrops_filter.h"
 
 #include <stdlib.h>
 #include <vector>
 #include <math.h>
 
 #include <QDateTime>
 #include <QPoint>
 #include <QSpinBox>
 
 #include <klocalizedstring.h>
 #include <kis_debug.h>
 #include <kpluginfactory.h>
 
 #include "KoIntegerMaths.h"
 #include <KoUpdater.h>
 
 #include <filter/kis_filter_category_ids.h>
 #include <filter/kis_filter_registry.h>
 #include <filter/kis_filter.h>
 #include <kis_global.h>
 #include <kis_selection.h>
 #include <kis_types.h>
 #include <kis_paint_device.h>
 #include <filter/kis_filter_configuration.h>
 #include <kis_processing_information.h>
 #include <kis_random_accessor_ng.h>
 #include <KisGlobalResourcesInterface.h>
 
 #include "widgets/kis_multi_integer_filter_widget.h"
 
 
 KisRainDropsFilter::KisRainDropsFilter()
     : KisFilter(id(), FiltersCategoryArtisticId, i18n("&Raindrops..."))
 {
     setSupportsPainting(false);
     setSupportsThreading(false);
     setSupportsAdjustmentLayers(false);
 }
 
 // This method have been ported from Pieter Z. Voloshyn algorithm code.
 
 /* Function to apply the RainDrops effect (inspired from Jason Waltman code)
  *
  * data             => The image data in RGBA mode.
  * Width            => Width of image.
  * Height           => Height of image.
  * DropSize         => Raindrop size
  * number           => Maximum number of raindrops
  * fishEyes            => FishEye coefficient
  *
  * Theory           => This functions does several math's functions and the engine
  *                     is simple to understand, but a little hard to implement. A
  *                     control will indicate if there is or not a raindrop in that
  *                     area, if not, a fisheye effect with a random size (max=DropSize)
  *                     will be applied, after this, a shadow will be applied too.
  *                     and after this, a blur function will finish the effect.
  */
 
 
 void KisRainDropsFilter::processImpl(KisPaintDeviceSP device,
                                      const QRect& applyRect,
                                      const KisFilterConfigurationSP config,
                                      KoUpdater* progressUpdater ) const
 {
     /**
      * This case should be filtered out at the higher level, in
      * KisFilter::process() or in KisFilterStrokeStrategy
      */
     KIS_SAFE_ASSERT_RECOVER_RETURN(!applyRect.isEmpty());
 
     QPoint srcTopLeft = applyRect.topLeft();
     Q_ASSERT(device);
 
     //read the filter configuration values from the KisFilterConfiguration object
     quint32 DropSize = config->getInt("dropSize", 80);
     quint32 number = config->getInt("number", 80);
     quint32 fishEyes = config->getInt("fishEyes", 30);
     qsrand(config->getInt("seed"));
 
     if (fishEyes <= 0) fishEyes = 1;
 
     if (fishEyes > 100) fishEyes = 100;
 
     int Width = applyRect.width();
     int Height = applyRect.height();
 
     bool** BoolMatrix = CreateBoolArray(Width, Height);
 
     int       i, j, k, l, m, n;                 // loop variables
     int       Bright;                           // Bright value for shadows and highlights
     int       x, y;                             // center coordinates
     int       Counter = 0;                      // Counter (duh !)
     int       NewSize;                          // Size of current raindrop
     int       halfSize;                         // Half of the current raindrop
     int       Radius;                           // Maximum radius for raindrop
     int       BlurRadius;                       // Blur Radius
     int       BlurPixels;
 
     double    r, a;                             // polar coordinates
     double    OldRadius;                        // Radius before processing
     double    NewfishEyes = (double)fishEyes * 0.01;  // FishEye Coefficients
     double    s;
     double    R, G, B;
 
     bool      FindAnother = false;              // To search for good coordinates
 
     const KoColorSpace * cs = device->colorSpace();
 
     // Init boolean Matrix.
 
     for (i = 0 ; i < Width; ++i) {
         for (j = 0 ; j < Height; ++j) {
             BoolMatrix[i][j] = false;
         }
     }
 
     progressUpdater->setRange(0, number);
     KisRandomAccessorSP dstAccessor = device->createRandomAccessorNG();
     
     for (uint NumBlurs = 0; NumBlurs <= number; ++NumBlurs) {
         NewSize = (int)(qrand() * ((double)(DropSize - 5) / RAND_MAX) + 5);
         halfSize = NewSize / 2;
         Radius = halfSize;
         s = Radius / log(NewfishEyes * Radius + 1);
 
         Counter = 0;
 
         do {
             FindAnother = false;
             y = (int)(qrand() * ((double)(Width - 1) / RAND_MAX));
             x = (int)(qrand() * ((double)(Height - 1) / RAND_MAX));
 
             if (BoolMatrix[y][x])
                 FindAnother = true;
             else
                 for (i = x - halfSize ; i <= x + halfSize; i++)
                     for (j = y - halfSize ; j <= y + halfSize; j++)
                         if ((i >= 0) && (i < Height) && (j >= 0) && (j < Width))
                             if (BoolMatrix[j][i])
                                 FindAnother = true;
 
             Counter++;
         } while (FindAnother && Counter < 10000);
 
         if (Counter >= 10000) {
             NumBlurs = number;
             break;
         }
 
         for (i = -1 * halfSize ; i < NewSize - halfSize; i++) {
             for (j = -1 * halfSize ; j < NewSize - halfSize; j++) {
                 r = sqrt((double)i * i + j * j);
                 a = atan2(static_cast<double>(i), static_cast<double>(j));
 
                 if (r <= Radius) {
                     OldRadius = r;
                     r = (exp(r / s) - 1) / NewfishEyes;
 
                     k = x + (int)(r * sin(a));
                     l = y + (int)(r * cos(a));
 
                     m = x + i;
                     n = y + j;
 
                     if ((k >= 0) && (k < Height) && (l >= 0) && (l < Width)) {
                         if ((m >= 0) && (m < Height) && (n >= 0) && (n < Width)) {
                             Bright = 0;
 
                             if (OldRadius >= 0.9 * Radius) {
                                 if ((a <= 0) && (a > -2.25))
                                     Bright = -80;
                                 else if ((a <= -2.25) && (a > -2.5))
                                     Bright = -40;
                                 else if ((a <= 0.25) && (a > 0))
                                     Bright = -40;
                             }
 
                             else if (OldRadius >= 0.8 * Radius) {
                                 if ((a <= -0.75) && (a > -1.50))
                                     Bright = -40;
                                 else if ((a <= 0.10) && (a > -0.75))
                                     Bright = -30;
                                 else if ((a <= -1.50) && (a > -2.35))
                                     Bright = -30;
                             }
 
                             else if (OldRadius >= 0.7 * Radius) {
                                 if ((a <= -0.10) && (a > -2.0))
                                     Bright = -20;
                                 else if ((a <= 2.50) && (a > 1.90))
                                     Bright = 60;
                             }
 
                             else if (OldRadius >= 0.6 * Radius) {
                                 if ((a <= -0.50) && (a > -1.75))
                                     Bright = -20;
                                 else if ((a <= 0) && (a > -0.25))
                                     Bright = 20;
                                 else if ((a <= -2.0) && (a > -2.25))
                                     Bright = 20;
                             }
 
                             else if (OldRadius >= 0.5 * Radius) {
                                 if ((a <= -0.25) && (a > -0.50))
                                     Bright = 30;
                                 else if ((a <= -1.75) && (a > -2.0))
                                     Bright = 30;
                             }
 
                             else if (OldRadius >= 0.4 * Radius) {
                                 if ((a <= -0.5) && (a > -1.75))
                                     Bright = 40;
                             }
 
                             else if (OldRadius >= 0.3 * Radius) {
                                 if ((a <= 0) && (a > -2.25))
                                     Bright = 30;
                             }
 
                             else if (OldRadius >= 0.2 * Radius) {
                                 if ((a <= -0.5) && (a > -1.75))
                                     Bright = 20;
                             }
 
                             BoolMatrix[n][m] = true;
 
                             QColor originalColor;
 
                             dstAccessor->moveTo(srcTopLeft.x() + l, srcTopLeft.y() + k);
                             cs->toQColor(dstAccessor->oldRawData(), &originalColor);
 
                             int newRed = CLAMP(originalColor.red() + Bright, 0, quint8_MAX);
                             int newGreen = CLAMP(originalColor.green() + Bright, 0, quint8_MAX);
                             int newBlue = CLAMP(originalColor.blue() + Bright, 0, quint8_MAX);
 
                             QColor newColor;
                             newColor.setRgb(newRed, newGreen, newBlue);
 
                             dstAccessor->moveTo(srcTopLeft.x() + n, srcTopLeft.y() + m);
                             cs->fromQColor(newColor, dstAccessor->rawData());
                         }
                     }
                 }
             }
         }
 
         BlurRadius = NewSize / 25 + 1;
 
         for (i = -1 * halfSize - BlurRadius ; i < NewSize - halfSize + BlurRadius; i++) {
             for (j = -1 * halfSize - BlurRadius; j < NewSize - halfSize + BlurRadius; ++j) {
                 r = sqrt((double)i * i + j * j);
 
                 if (r <= Radius * 1.1) {
                     R = G = B = 0;
                     BlurPixels = 0;
 
                     for (k = -1 * BlurRadius; k < BlurRadius + 1; k++)
                         for (l = -1 * BlurRadius; l < BlurRadius + 1; l++) {
                             m = x + i + k;
                             n = y + j + l;
 
                             if ((m >= 0) && (m < Height) && (n >= 0) && (n < Width)) {
                                 QColor color;
                                 dstAccessor->moveTo(srcTopLeft.x() + n, srcTopLeft.y() + m);
                                 cs->toQColor(dstAccessor->rawData(), &color);
 
                                 R += color.red();
                                 G += color.green();
                                 B += color.blue();
                                 BlurPixels++;
                             }
                         }
 
                     m = x + i;
                     n = y + j;
 
                     if ((m >= 0) && (m < Height) && (n >= 0) && (n < Width)) {
                         QColor color;
 
                         if (BlurPixels == 0) {
                             // Coverity complains that it *is* possible
                             // for BlurPixels to be 0, so let's make sure
                             // Krita doesn't crash here
                             BlurPixels = 1;
                         }
 
                         color.setRgb((int)(R / BlurPixels), (int)(G / BlurPixels), (int)(B / BlurPixels));
                         dstAccessor->moveTo(srcTopLeft.x() + n, srcTopLeft.y() + m);
                         cs->fromQColor(color, dstAccessor->rawData());
                     }
                 }
             }
         }
 
         progressUpdater->setValue(NumBlurs);
     }
 
     FreeBoolArray(BoolMatrix, Width);
 }
 
 // This method have been ported from Pieter Z. Voloshyn algorithm code.
 
 /* Function to free a dynamic boolean array
  *
  * lpbArray          => Dynamic boolean array
  * Columns           => The number of array columns
  *
  * Theory            => An easy to understand 'for' statement
  */
 void KisRainDropsFilter::FreeBoolArray(bool** lpbArray, uint Columns) const
 {
     for (uint i = 0; i < Columns; ++i)
         free(lpbArray[i]);
 
     free(lpbArray);
 }
 
 /* Function to create a bidimensional dynamic boolean array
  *
  * Columns           => Number of columns
  * Rows              => Number of rows
  *
  * Theory            => Using 'for' statement, we can alloc multiple dynamic arrays
  *                      To create more dimensions, just add some 'for's, ok?
  */
 bool** KisRainDropsFilter::CreateBoolArray(uint Columns, uint Rows) const
 {
     bool** lpbArray = 0;
     lpbArray = (bool**) malloc(Columns * sizeof(bool*));
 
     if (lpbArray == 0)
         return (0);
 
     for (uint i = 0; i < Columns; ++i) {
         lpbArray[i] = (bool*) malloc(Rows * sizeof(bool));
         if (lpbArray[i] == 0) {
             FreeBoolArray(lpbArray, Columns);
             return (0);
         }
     }
 
     return (lpbArray);
 }
 
 // This method have been ported from Pieter Z. Voloshyn algorithm code.
 
 /* This function limits the RGB values
  *
  * ColorValue        => Here, is an RGB value to be analyzed
  *
  * Theory            => A color is represented in RGB value (e.g. 0xFFFFFF is
  *                      white color). But R, G and B values have 256 values to be used
  *                      so, this function analyzes the value and limits to this range
  */
 
 uchar KisRainDropsFilter::LimitValues(int ColorValue) const
 {
     if (ColorValue > 255)        // MAX = 255
         ColorValue = 255;
     if (ColorValue < 0)          // MIN = 0
         ColorValue = 0;
     return ((uchar) ColorValue);
 }
 
 KisConfigWidget * KisRainDropsFilter::createConfigurationWidget(QWidget* parent, const KisPaintDeviceSP, bool) const
 {
     vKisIntegerWidgetParam param;
     param.push_back(KisIntegerWidgetParam(1, 200, 80, i18n("Drop size"), "dropsize"));
     param.push_back(KisIntegerWidgetParam(1, 500, 80, i18n("Number of drops"), "number"));
     param.push_back(KisIntegerWidgetParam(1, 100, 30, i18n("Fish eyes"), "fishEyes"));
     KisMultiIntegerFilterWidget * w = new KisMultiIntegerFilterWidget(id().id(), parent, id().id(), param);
     w->setConfiguration(defaultConfiguration(KisGlobalResourcesInterface::instance()));
     return w;
 }
 
 KisFilterConfigurationSP KisRainDropsFilter::defaultConfiguration(KisResourcesInterfaceSP resourcesInterface) const
 {
     KisFilterConfigurationSP config = factoryConfiguration(resourcesInterface);
     config->setProperty("dropsize", 80);
     config->setProperty("number", 80);
     config->setProperty("fishEyes", 30);
     config->setProperty("seed", QTime::currentTime().msec());
 
 
     return config;
 }