File indexing completed on 2024-04-28 04:20:14

 
 /*
    Copyright (c) 2003-2007 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_DOCUMENT_SAVE_OPTIONS 0
 
 
 #include "kpDocumentSaveOptions.h"
 
 #include "kpDefs.h"
 #include "pixmapfx/kpPixmapFX.h"
 
 #include <KConfigGroup>
 #include "kpLogCategories.h"
 #include <KSharedConfig>
 
 #include <QImage>
 #include <QString>
 
 //---------------------------------------------------------------------
 
 class kpDocumentSaveOptionsPrivate
 {
 public:
     QString m_mimeType;
     int m_colorDepth{};
     bool m_dither{};
     int m_quality{};
 };
 
 //---------------------------------------------------------------------
 
 kpDocumentSaveOptions::kpDocumentSaveOptions ()
     : d (new kpDocumentSaveOptionsPrivate ())
 {
     d->m_mimeType = invalidMimeType ();
     d->m_colorDepth = invalidColorDepth ();
     d->m_dither = initialDither ();
     d->m_quality = invalidQuality ();
 }
 
 //---------------------------------------------------------------------
 
 kpDocumentSaveOptions::kpDocumentSaveOptions (const kpDocumentSaveOptions &rhs)
     : d (new kpDocumentSaveOptionsPrivate ())
 {
     d->m_mimeType = rhs.mimeType ();
     d->m_colorDepth = rhs.colorDepth ();
     d->m_dither = rhs.dither ();
     d->m_quality = rhs.quality ();
 }
 
 //---------------------------------------------------------------------
 
 kpDocumentSaveOptions::kpDocumentSaveOptions (const QString &mimeType, int colorDepth, bool dither, int quality)
     : d (new kpDocumentSaveOptionsPrivate ())
 {
     d->m_mimeType = mimeType;
     d->m_colorDepth = colorDepth;
     d->m_dither = dither;
     d->m_quality = quality;
 }
 
 //---------------------------------------------------------------------
 
 kpDocumentSaveOptions::~kpDocumentSaveOptions ()
 {
     delete d;
 }
 
 //---------------------------------------------------------------------
 
 
 // public
 bool kpDocumentSaveOptions::operator== (const kpDocumentSaveOptions &rhs) const
 {
     return (mimeType () == rhs.mimeType () &&
             colorDepth () == rhs.colorDepth () &&
             dither () == rhs.dither () &&
             quality () == rhs.quality ());
 }
 
 //---------------------------------------------------------------------
 
 // public
 bool kpDocumentSaveOptions::operator!= (const kpDocumentSaveOptions &rhs) const
 {
     return !(*this == rhs);
 }
 
 //---------------------------------------------------------------------
 
 
 // public
 kpDocumentSaveOptions &kpDocumentSaveOptions::operator= (const kpDocumentSaveOptions &rhs)
 {
     setMimeType (rhs.mimeType ());
     setColorDepth (rhs.colorDepth ());
     setDither (rhs.dither ());
     setQuality (rhs.quality ());
 
     return *this;
 }
 
 //---------------------------------------------------------------------
 
 
 // public
 void kpDocumentSaveOptions::printDebug (const QString &prefix) const
 {
     const QString usedPrefix = !prefix.isEmpty () ?
                                    prefix + QLatin1String (": ") :
                                    QString();
 
     qCDebug(kpLogDocument) << usedPrefix
                << "mimeType=" << mimeType ()
                << " colorDepth=" << colorDepth ()
                << " dither=" << dither ()
                << " quality=" << quality ();
 }
 
 //---------------------------------------------------------------------
 
 
 // public
 QString kpDocumentSaveOptions::mimeType () const
 {
     return d->m_mimeType;
 }
 
 //---------------------------------------------------------------------
 
 // public
 void kpDocumentSaveOptions::setMimeType (const QString &mimeType)
 {
     Q_ASSERT(mimeType.isEmpty () || mimeType.contains (QLatin1Char('/')));
     d->m_mimeType = mimeType;
 }
 
 //---------------------------------------------------------------------
 
 
 // public static
 QString kpDocumentSaveOptions::invalidMimeType ()
 {
     return {};
 }
 
 //---------------------------------------------------------------------
 
 // public static
 bool kpDocumentSaveOptions::mimeTypeIsInvalid (const QString &mimeType)
 {
     return (mimeType == invalidMimeType ());
 }
 
 //---------------------------------------------------------------------
 
 // public
 bool kpDocumentSaveOptions::mimeTypeIsInvalid () const
 {
     return mimeTypeIsInvalid (mimeType ());
 }
 
 //---------------------------------------------------------------------
 
 
 // public
 int kpDocumentSaveOptions::colorDepth () const
 {
     return d->m_colorDepth;
 }
 
 // public
 void kpDocumentSaveOptions::setColorDepth (int depth)
 {
     d->m_colorDepth = depth;
 }
 
 
 // public static
 int kpDocumentSaveOptions::invalidColorDepth ()
 {
     return -1;
 }
 
 // public static
 bool kpDocumentSaveOptions::colorDepthIsInvalid (int colorDepth)
 {
     return (colorDepth != 1 && colorDepth != 8 && colorDepth != 32);
 }
 
 // public
 bool kpDocumentSaveOptions::colorDepthIsInvalid () const
 {
     return colorDepthIsInvalid (colorDepth ());
 }
 
 
 // public
 bool kpDocumentSaveOptions::dither () const
 {
     return d->m_dither;
 }
 
 // public
 void kpDocumentSaveOptions::setDither (bool dither)
 {
     d->m_dither = dither;
 }
 
 
 // public static
 int kpDocumentSaveOptions::initialDither ()
 {
     return false;  // to avoid accidental double dithering
 }
 
 
 // public
 int kpDocumentSaveOptions::quality () const
 {
     return d->m_quality;
 }
 
 // public
 void kpDocumentSaveOptions::setQuality (int quality)
 {
     d->m_quality = quality;
 }
 
 
 // public static
 int kpDocumentSaveOptions::invalidQuality ()
 {
     return -2;
 }
 
 // public static
 bool kpDocumentSaveOptions::qualityIsInvalid (int quality)
 {
     return (quality < -1 || quality > 100);
 }
 
 // public
 bool kpDocumentSaveOptions::qualityIsInvalid () const
 {
     return qualityIsInvalid (quality ());
 }
 
 
 // public static
 QString kpDocumentSaveOptions::defaultMimeType (const KConfigGroup &config)
 {
     return config.readEntry (kpSettingForcedMimeType,
                               QStringLiteral ("image/png"));
 }
 
 // public static
 void kpDocumentSaveOptions::saveDefaultMimeType (KConfigGroup &config,
                                                  const QString &mimeType)
 {
     config.writeEntry (kpSettingForcedMimeType, mimeType);
 }
 
 
 // public static
 int kpDocumentSaveOptions::defaultColorDepth (const KConfigGroup &config)
 {
     int colorDepth =
         config.readEntry (kpSettingForcedColorDepth, -1);
 
     if (colorDepthIsInvalid (colorDepth))
     {
         // (not screen depth, in case of transparency)
         colorDepth = 32;
     }
 
     return colorDepth;
 }
 
 //---------------------------------------------------------------------
 
 // public static
 void kpDocumentSaveOptions::saveDefaultColorDepth (KConfigGroup &config, int colorDepth)
 {
     config.writeEntry (kpSettingForcedColorDepth, colorDepth);
 }
 
 //---------------------------------------------------------------------
 
 
 // public static
 int kpDocumentSaveOptions::defaultDither (const KConfigGroup &config)
 {
     return config.readEntry (kpSettingForcedDither, initialDither ());
 }
 
 //---------------------------------------------------------------------
 
 // public static
 void kpDocumentSaveOptions::saveDefaultDither (KConfigGroup &config, bool dither)
 {
     config.writeEntry (kpSettingForcedDither, dither);
 }
 
 //---------------------------------------------------------------------
 
 
 // public static
 int kpDocumentSaveOptions::defaultQuality (const KConfigGroup &config)
 {
     int val = config.readEntry (kpSettingForcedQuality, -1);
 
     return qualityIsInvalid (val) ? -1 : val;
 }
 
 //---------------------------------------------------------------------
 
 // public static
 void kpDocumentSaveOptions::saveDefaultQuality (KConfigGroup &config, int quality)
 {
     config.writeEntry (kpSettingForcedQuality, quality);
 }
 
 //---------------------------------------------------------------------
 
 
 // public static
 kpDocumentSaveOptions kpDocumentSaveOptions::defaultDocumentSaveOptions (const KConfigGroup &config)
 {
     kpDocumentSaveOptions saveOptions;
     saveOptions.setMimeType (defaultMimeType (config));
     saveOptions.setColorDepth (defaultColorDepth (config));
     saveOptions.setDither (defaultDither (config));
     saveOptions.setQuality (defaultQuality (config));
 
 #if DEBUG_KP_DOCUMENT_SAVE_OPTIONS
     saveOptions.printDebug ("kpDocumentSaveOptions::defaultDocumentSaveOptions()");
 #endif
 
     return saveOptions;
 }
 
 //---------------------------------------------------------------------
 
 // public static
 bool kpDocumentSaveOptions::saveDefaultDifferences (KConfigGroup &config,
                                                     const kpDocumentSaveOptions &oldDocInfo,
                                                     const kpDocumentSaveOptions &newDocInfo)
 {
     bool savedSomething = false;
 
 #if DEBUG_KP_DOCUMENT_SAVE_OPTIONS
     qCDebug(kpLogDocument) << "kpDocumentSaveOptions::saveDefaultDifferences()";
     oldDocInfo.printDebug ("\told");
     newDocInfo.printDebug ("\tnew");
 #endif
 
     if (newDocInfo.mimeType () != oldDocInfo.mimeType ())
     {
         saveDefaultMimeType (config, newDocInfo.mimeType ());
         savedSomething = true;
     }
 
     if (newDocInfo.colorDepth () != oldDocInfo.colorDepth ())
     {
         saveDefaultColorDepth (config, newDocInfo.colorDepth ());
         savedSomething = true;
     }
 
     if (newDocInfo.dither () != oldDocInfo.dither ())
     {
         saveDefaultDither (config, newDocInfo.dither ());
         savedSomething = true;
     }
 
     if (newDocInfo.quality () != oldDocInfo.quality ())
     {
         saveDefaultQuality (config, newDocInfo.quality ());
         savedSomething = true;
     }
 
     return savedSomething;
 }
 
 //---------------------------------------------------------------------
 // Currently, Depth and Quality settings are mutually exclusive with
 // Depth overriding Quality.  I've currently favoured Quality with the
 // below mimetypes (i.e. all lossy mimetypes are only given Quality settings,
 // no Depth settings).
 //
 // To test whether depth is configurable, write an image in the new
 // mimetype with all depths and read each one back.  See what
 // kpDocument thinks the depth is when it gets QImage to read it.
 
 
 // public static
 int kpDocumentSaveOptions::mimeTypeMaximumColorDepth(const QString &mimeType)
 {
     // SYNC: update mime info here
 
     if ( mimeType == QStringLiteral("image/x-eps") )
       return 32;  // Grayscale actually (unenforced since depth not set to configurable)
 
     if ( mimeType == QStringLiteral("image/x-portable-bitmap") )
       return 1;
 
     if ( mimeType == QStringLiteral("image/x-portable-graymap") )
       return 8; // Grayscale actually (unenforced since depth not set to configurable)
 
     if ( mimeType == QStringLiteral("image/x-xbitmap") )
       return 1;
 
     return 32;
 }
 
 //---------------------------------------------------------------------
 
 // public
 int kpDocumentSaveOptions::mimeTypeMaximumColorDepth () const
 {
     return mimeTypeMaximumColorDepth (mimeType ());
 }
 
 //---------------------------------------------------------------------
 
 // public static
 bool kpDocumentSaveOptions::mimeTypeHasConfigurableColorDepth (const QString &mimeType)
 {
     QStringList defaultMimeTypes;
 
     // SYNC: update mime info here
     defaultMimeTypes << QStringLiteral ("image/png");
     defaultMimeTypes << QStringLiteral ("image/bmp");
     defaultMimeTypes << QStringLiteral ("image/x-pcx");
 
     // TODO: Only 1, 24 not 8; Qt only sees 32 but "file" cmd realizes
     //       it's either 1 or 24.
     defaultMimeTypes << QStringLiteral ("image/x-rgb");
 
     // TODO: Only 8 and 24 - no 1.
     defaultMimeTypes << QStringLiteral ("image/x-xpixmap");
 
     return defaultMimeTypes.contains(mimeType);
 }
 
 //---------------------------------------------------------------------
 
 // public
 bool kpDocumentSaveOptions::mimeTypeHasConfigurableColorDepth () const
 {
     return mimeTypeHasConfigurableColorDepth (mimeType ());
 }
 
 //---------------------------------------------------------------------
 
 // public static
 bool kpDocumentSaveOptions::mimeTypeHasConfigurableQuality (const QString &mimeType)
 {
     QStringList defaultMimeTypes;
 
     // SYNC: update mime info here
     defaultMimeTypes << QStringLiteral ("image/jp2");
     defaultMimeTypes << QStringLiteral ("image/jpeg");
     defaultMimeTypes << QStringLiteral ("image/webp");
     defaultMimeTypes << QStringLiteral ("image/avif");
     defaultMimeTypes << QStringLiteral ("image/heif");
     defaultMimeTypes << QStringLiteral ("image/heic");
 
     return defaultMimeTypes.contains(mimeType);
 }
 
 //---------------------------------------------------------------------
 
 // public
 bool kpDocumentSaveOptions::mimeTypeHasConfigurableQuality () const
 {
     return mimeTypeHasConfigurableQuality (mimeType ());
 }
 
 //---------------------------------------------------------------------
 
 // public
 int kpDocumentSaveOptions::isLossyForSaving (const QImage &image) const
 {
     int ret = 0;
 
     if (mimeTypeMaximumColorDepth () < image.depth ())
     {
         ret |= MimeTypeMaximumColorDepthLow;
     }
 
     if (mimeTypeHasConfigurableColorDepth () &&
         !colorDepthIsInvalid () /*REFACTOR: guarantee it is valid*/ &&
         ((colorDepth () < image.depth ()) ||
          (colorDepth () < 32 && image.hasAlphaChannel())))
     {
         ret |= ColorDepthLow;
     }
 
     if (mimeTypeHasConfigurableQuality () &&
         !qualityIsInvalid ())
     {
         ret |= Quality;
     }
 
     return ret;
 }
 
 //---------------------------------------------------------------------