tdegraphics/kolourpaint/pixmapfx/kpeffectblursharpen.cpp

/*
   Copyright (c) 2003,2004,2005 Clarence Dang <dang@kde.org>
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#define DEBUG_KP_EFFECT_BLUR_SHARPEN 0


#include <kpeffectblursharpen.h>

#include <tqimage.h>
#include <tqlabel.h>
#include <tqlayout.h>
#include <tqpixmap.h>
#include <tqpushbutton.h>

#include <kdebug.h>
#include <kimageeffect.h>
#include <tdelocale.h>
#include <knuminput.h>

#include <kpmainwindow.h>
#include <kppixmapfx.h>


static TQString nameForType (kpEffectBlurSharpenCommand::Type type)
{
    if (type == kpEffectBlurSharpenCommand::Blur)
        return i18n ("Soften");
    else if (type == kpEffectBlurSharpenCommand::Sharpen)
        return i18n ("Sharpen");
    else
        return TQString();
}


kpEffectBlurSharpenCommand::kpEffectBlurSharpenCommand (Type type,
                                                        double radius, double sigma,
                                                        int repeat,
                                                        bool actOnSelection,
                                                        kpMainWindow *mainWindow)
    : kpColorEffectCommand (::nameForType (type), actOnSelection, mainWindow),
      m_type (type),
      m_radius (radius), m_sigma (sigma),
      m_repeat (repeat)
{
}

kpEffectBlurSharpenCommand::~kpEffectBlurSharpenCommand ()
{
}


// public static
TQPixmap kpEffectBlurSharpenCommand::apply (const TQPixmap &pixmap,
                                           Type type, double radius, double sigma,
                                           int repeat)
{
#if DEBUG_KP_EFFECT_BLUR_SHARPEN
    kdDebug () << "kpEffectBlurSharpenCommand::apply(type="
               << int (type)
               << " radius=" << radius
               << " sigma=" << sigma
               << " repeat=" << repeat
               << ")"
               << endl;
#endif

    // (KImageEffect::(blur|sharpen)() ignores mask)
    TQPixmap usePixmap = kpPixmapFX::pixmapWithDefinedTransparentPixels (
        pixmap,
        TQt::white/*arbitrarily chosen*/);


    TQImage image = kpPixmapFX::convertToImage (usePixmap);

    for (int i = 0; i < repeat; i++)
    {
        if (type == Blur)
            image = KImageEffect::blur (image, radius, sigma);
        else if (type == Sharpen)
            image = KImageEffect::sharpen (image, radius, sigma);
    }

    TQPixmap retPixmap = kpPixmapFX::convertToPixmap (image);


    // KImageEffect::(blur|sharpen)() nukes mask - restore it
    if (usePixmap.mask ())
        retPixmap.setMask (*usePixmap.mask ());


    return retPixmap;
}

// protected virtual [base kpColorEffectCommand]
TQPixmap kpEffectBlurSharpenCommand::applyColorEffect (const TQPixmap &pixmap)
{
    return apply (pixmap, m_type, m_radius, m_sigma, m_repeat);
}



kpEffectBlurSharpenWidget::kpEffectBlurSharpenWidget (bool actOnSelection,
                                                      kpMainWindow *mainWindow,
                                                      TQWidget *parent, const char *name)
    : kpColorEffectWidget (actOnSelection, mainWindow, parent, name)
{
    TQGridLayout *lay = new TQGridLayout (this, 4, 2, marginHint (), spacingHint ());


    TQLabel *amountLabel = new TQLabel (i18n ("&Amount:"), this);
    m_amountInput = new KIntNumInput (this);
    m_amountInput->setRange (-10, 10, 1/*step*/, true/*slider*/);

    m_typeLabel = new TQLabel (this);


    amountLabel->setBuddy (m_amountInput);


    lay->addWidget (amountLabel, 0, 0);
    lay->addWidget (m_amountInput, 0, 1);

    lay->addMultiCellWidget (m_typeLabel, 1, 1, 0, 1, TQt::AlignCenter);

    lay->setColStretch (1, 1);


    connect (m_amountInput, TQ_SIGNAL (valueChanged (int)),
             this, TQ_SIGNAL (settingsChangedDelayed ()));

    connect (m_amountInput, TQ_SIGNAL (valueChanged (int)),
             this, TQ_SLOT (slotUpdateTypeLabel ()));
}

kpEffectBlurSharpenWidget::~kpEffectBlurSharpenWidget ()
{
}


// public virtual [base kpColorEffectWidget]
TQString kpEffectBlurSharpenWidget::caption () const
{
    return TQString();
}


// public virtual [base kpColorEffectWidget]
bool kpEffectBlurSharpenWidget::isNoOp () const
{
    return (type () == kpEffectBlurSharpenCommand::None);
}

// public virtual [base kpColorEffectWidget]
TQPixmap kpEffectBlurSharpenWidget::applyColorEffect (const TQPixmap &pixmap)
{
    return kpEffectBlurSharpenCommand::apply (pixmap,
                                              type (), radius (), sigma (), repeat ());
}

// public virtual [base kpColorEffectWidget]
kpColorEffectCommand *kpEffectBlurSharpenWidget::createCommand () const
{
    return new kpEffectBlurSharpenCommand (type (), radius (), sigma (), repeat (),
                                           m_actOnSelection,
                                           m_mainWindow);
}


// protected slot
void kpEffectBlurSharpenWidget::slotUpdateTypeLabel ()
{
    TQString text = ::nameForType (type ());

#if DEBUG_KP_EFFECT_BLUR_SHARPEN
    kdDebug () << "kpEffectBlurSharpenWidget::slotUpdateTypeLabel() text="
               << text << endl;
#endif
    m_typeLabel->setText (text);
}


// protected
kpEffectBlurSharpenCommand::Type kpEffectBlurSharpenWidget::type () const
{
    if (m_amountInput->value () == 0)
        return kpEffectBlurSharpenCommand::None;
    else if (m_amountInput->value () < 0)
        return kpEffectBlurSharpenCommand::Blur;
    else
        return kpEffectBlurSharpenCommand::Sharpen;
}

// The numbers that follow were picked by experimentation.
// I still have no idea what "radius" and "sigma" mean
// (even after reading the API).

// protected
double kpEffectBlurSharpenWidget::radius () const
{
    if (m_amountInput->value () == 0)
        return 0;

    if (m_amountInput->value () < 0)
    {
        return 8;
    }
    else
    {
        const double SharpenMin = .1;
        const double SharpenMax = 2.5;

        return SharpenMin +
                  (m_amountInput->value () - 1) *
                      (SharpenMax - SharpenMin) /
                          (m_amountInput->maxValue () - 1);
    }
}

// protected
double kpEffectBlurSharpenWidget::sigma () const
{
    if (m_amountInput->value () == 0)
        return 0;

    if (m_amountInput->value () < 0)
    {
        const double BlurMin = .5;
        const double BlurMax = 4;

        return BlurMin +
                   (-m_amountInput->value () - 1) *
                        (BlurMax - BlurMin) /
                            (-m_amountInput->minValue () - 1);
    }
    else
    {
        const double SharpenMin = .5;
        const double SharpenMax = 3.0;

        return SharpenMin +
                   (m_amountInput->value () - 1) *
                       (SharpenMax - SharpenMin) /
                           (m_amountInput->maxValue () - 1);
    }
}

// protected
int kpEffectBlurSharpenWidget::repeat () const
{
    if (m_amountInput->value () == 0)
        return 0;

    if (m_amountInput->value () < 0)
        return 1;
    else
    {
        const double SharpenMin = 1;
        const double SharpenMax = 2;

        return tqRound (SharpenMin +
                          (m_amountInput->value () - 1) *
                              (SharpenMax - SharpenMin) /
                                  (m_amountInput->maxValue () - 1));
    }
}

#include <kpeffectblursharpen.moc>