exiftoolparser.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2020-11-28
 * Description : ExifTool process stream parser.
 *
 * Copyright (C) 2020-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * 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_EXIFTOOL_PARSER_H
#define DIGIKAM_EXIFTOOL_PARSER_H
 
// Qt Core
 
#include <QFileInfo>
#include <QVariant>
#include <QHash>
#include <QObject>
#include <QString>
#include <QByteArray>
#include <QProcess>
 
// Local includes
 
#include "digikam_export.h"
#include "exiftoolprocess.h"
#include "metaengine.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT ExifToolParser : public QObject
{
    Q_OBJECT
 
public:
 
    typedef QHash<QString, QVariantList> ExifToolData;
 
public:
 
    //---------------------------------------------------------------------------------------------
 
 
    explicit ExifToolParser(QObject* const parent);
    ~ExifToolParser();
 
    void setExifToolProgram(const QString& path);
 
    QString      currentPath()        const;
    ExifToolData currentData()        const;
    QString      currentErrorString() const;
 
    bool exifToolAvailable()          const;
 
 
public:
 
    //---------------------------------------------------------------------------------------------
 
 
    bool load(const QString& path, bool async = false);
 
    bool loadChunk(const QString& path);
 
    bool applyChanges(const QString& path, const ExifToolData& newTags);
 
    bool applyChanges(const QString& path, const QString& exvTempFile);
 
    bool readableFormats();
 
    bool writableFormats();
 
    bool translationsList();
 
    bool tagsDatabase();
 
    bool version();
 
    bool copyTags(const QString& src,
                  const QString& dst,
                  unsigned char copyOps,
                  unsigned char writeModes = ExifToolProcess::ALL_MODES);
 
    bool translateTags(const QString& path, unsigned char transOps);
 
 
Q_SIGNALS:
 
    void signalExifToolDataAvailable();
 
private Q_SLOTS:
 
    //---------------------------------------------------------------------------------------------
 
 
    void slotCmdCompleted(int cmdAction,
                          int execTime,
                          const QByteArray& cmdOutputChannel,
                          const QByteArray& cmdErrorChannel);
 
    void slotErrorOccurred(int cmdAction, QProcess::ProcessError error);
 
    void slotFinished(int cmdAction, int exitCode, QProcess::ExitStatus exitStatus);
 
public:
 
    void setOutputStream(int cmdAction,
                         const QByteArray& cmdOutputChannel,
                         const QByteArray& cmdErrorChannel);
 
    static MetaEngine::TagsMap tagsDbToOrderedMap(const ExifToolData& tagsDb);
 
private:
 
    void printExifToolOutput(const QByteArray& stdOut);
 
 
private Q_SLOTS:
 
    void slotMetaEngineSettingsChanged();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_EXIFTOOL_PARSER_H