jpegutils.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2004-09-29
 * Description : helper methods for JPEG image format.
 *
 * Copyright (C) 2004-2005 by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2006-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2006-2012 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_JPEG_UTILS_H
#define DIGIKAM_JPEG_UTILS_H
 
// Qt includes
 
#include <QString>
#include <QImage>
 
// Local includes
 
#include "digikam_config.h"
#include "digikam_export.h"
#include "dmetadata.h"
#include "metaengine_rotation.h"
 
namespace Digikam
{
 
namespace JPEGUtils
{
 
typedef MetaEngineRotation::TransformationAction TransformAction;
 
class DIGIKAM_EXPORT JpegRotator
{
public:
 
    explicit JpegRotator(const QString& file);
 
    ~JpegRotator();
 
    void setCurrentOrientation(MetaEngine::ImageOrientation orientation);
 
    void setDocumentName(const QString& documentName);
 
    void setDestinationFile(const QString& dest);
 
    bool autoExifTransform();
 
    bool exifTransform(TransformAction action);
 
    bool exifTransform(const MetaEngineRotation& matrix);
 
protected:
 
    QString                      m_file;
    QString                      m_destFile;
    QString                      m_documentName;
    QSize                        m_originalSize;
    DMetadata*                   m_metadata;
    MetaEngine::ImageOrientation m_orientation;
 
protected:
 
    void updateMetadata(const QString& fileName, const MetaEngineRotation& matrix);
    bool performJpegTransform(TransformAction action, const QString& src, const QString& dest);
 
private:
 
    // Disable
    JpegRotator(const JpegRotator&)            = delete;
    JpegRotator& operator=(const JpegRotator&) = delete;
};
 
DIGIKAM_EXPORT bool loadJPEGScaled(QImage& image, const QString& path, int maximumSize);
DIGIKAM_EXPORT bool jpegConvert(const QString& src,
                                const QString& dest,
                                const QString& documentName,
                                const QString& format=QLatin1String("PNG"));
DIGIKAM_EXPORT bool isJpegImage(const QString& file);
DIGIKAM_EXPORT int  getJpegQuality(const QString& file);
 
} // namespace JPEGUtils
 
} // namespace Digikam
 
#endif // DIGIKAM_JPEG_UTILS_H