thumbnailcreator.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-07-20
 * Description : Loader for thumbnails
 *
 * Copyright (C) 2003-2005 by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2003-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2006-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * 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, 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_THUMB_NAIL_CREATOR_H
#define DIGIKAM_THUMB_NAIL_CREATOR_H
 
// Qt includes
 
#include <QString>
#include <QPixmap>
#include <QImage>
 
// Local includes
 
#include "drawdecoding.h"
#include "digikam_export.h"
#include "thumbnailinfo.h"
 
namespace Digikam
{
 
class IccProfile;
class DImgLoaderObserver;
class DMetadata;
class ThumbnailImage;
class ThumbsDbInfo;
 
class DIGIKAM_EXPORT ThumbnailCreator
{
public:
 
    enum StorageMethod
    {
        FreeDesktopStandard,
        ThumbnailDatabase
    };
 
public:
 
    explicit ThumbnailCreator(StorageMethod method);
 
    ThumbnailCreator(int thumbnailSize, StorageMethod method);
    ~ThumbnailCreator();
 
    QImage load(const ThumbnailIdentifier& identifier)                              const;
 
    QImage loadDetail(const ThumbnailIdentifier& identifier,
                      const QRect& detailRect)                                      const;
 
    void pregenerate(const ThumbnailIdentifier& identifier)                         const;
    void pregenerateDetail(const ThumbnailIdentifier& identifier,
                           const QRect& detailRect)                                 const;
 
    void setThumbnailSize(int thumbnailSize);
 
    void setLoadingProperties(DImgLoaderObserver* const observer,
                              const DRawDecoding& settings);
 
    void setExifRotate(bool rotate);
 
    void setOnlyLargeThumbnails(bool onlyLarge);
 
    void setRemoveAlphaChannel(bool removeAlpha);
 
    void setThumbnailInfoProvider(ThumbnailInfoProvider* const provider);
 
    int thumbnailSize()                                                             const;
 
    int storedSize()                                                                const;
 
    void store(const QString& path, const QImage& image)                            const;
 
    void storeDetailThumbnail(const QString& path,
                              const QRect& detailRect,
                              const QImage& image)                                  const;
 
    QString errorString()                                                           const;
 
    void deleteThumbnailsFromDisk(const QString& filePath)                          const;
 
    static ThumbnailInfo fileThumbnailInfo(const QString& path);
 
    static QString identifierForDetail(const ThumbnailInfo& info,
                                       const QRect& rect);
 
private:
 
    void initialize();
 
    ThumbnailImage createThumbnail(const ThumbnailInfo& info,
                                   const QRect& detailRect = QRect())               const;
 
    QImage load(const ThumbnailIdentifier& id,
                const QRect& rect,
                bool pregenerate)                                                   const;
    QImage loadWithDImgScaled(const QString& path,
                              IccProfile* const profile)                            const;
    QImage loadImageDetail(const ThumbnailInfo& info,
                           const DMetadata& metadata,
                           const QRect& detailRect,
                           IccProfile* const profile)                               const;
    QImage loadImagePreview(const DMetadata& metadata)                              const;
    QImage loadPNG(const QString& path)                                             const;
 
    QImage handleAlphaChannel(const QImage& thumb)                                  const;
    int    exifOrientation(const ThumbnailInfo& info,
                           const DMetadata& metadata,
                           bool fromEmbeddedPreview,
                           bool fromDetail)                                         const;
    QImage exifRotate(const QImage& thumb, int orientation)                         const;
 
    void store(const QString& path,
               const QImage& i,
               const QRect& rect)                                                   const;
 
    ThumbnailInfo makeThumbnailInfo(const ThumbnailIdentifier& identifier,
                                    const QRect& rect)                              const;
    QImage scaleForStorage(const QImage& qimage)                                    const;
 
    void storeInDatabase(const ThumbnailInfo& info,
                         const ThumbnailImage& image)                               const;
    ThumbsDbInfo loadThumbsDbInfo(const ThumbnailInfo& info)                        const;
    ThumbnailImage loadFromDatabase(const ThumbnailInfo& info)                      const;
    bool isInDatabase(const ThumbnailInfo& info)                                    const;
    void deleteFromDatabase(const ThumbnailInfo& info)                              const;
 
    void storeFreedesktop(const ThumbnailInfo& info, const ThumbnailImage& image)   const;
    ThumbnailImage loadFreedesktop(const ThumbnailInfo& info)                       const;
    void deleteFromDiskFreedesktop(const QString& filePath)                         const;
 
    void initThumbnailDirs();
    QString thumbnailPath(const QString& uri)                                       const;
 
    // implementations in thumbnailbasic.cpp
 
    static QString normalThumbnailDir();
    static QString largeThumbnailDir();
    static QString thumbnailPath(const QString& filePath, const QString& basePath);
    static QString thumbnailUri(const QString& filePath);
    static QString thumbnailPathFromUri(const QString& uri, const QString& basePath);
 
private:
 
    // Disable
    ThumbnailCreator(const ThumbnailCreator&)            = delete;
    ThumbnailCreator& operator=(const ThumbnailCreator&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_THUMB_NAIL_CREATOR_H