exiftoolprocess.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2021-02-18
 * Description : Qt5 and Qt6 interface for exiftool.
 *               Based on ZExifTool Qt interface published at 18 Feb 2021
 *               https://github.com/philvl/ZExifTool
 *
 * Copyright (C) 2021-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (c) 2021 by Philippe Vianney Liaud <philvl dot dev 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_PROCESS_H
#define DIGIKAM_EXIFTOOL_PROCESS_H
 
// Qt Core
 
#include <QObject>
#include <QString>
#include <QProcess>
#include <QMutex>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT ExifToolProcess : public QObject
{
    Q_OBJECT
 
public:
 
    enum Action
    {
        LOAD_METADATA       = 0,                    
        LOAD_CHUNKS,                                
        APPLY_CHANGES,                              
        APPLY_CHANGES_EXV,                          
        READ_FORMATS,                               
        WRITE_FORMATS,                              
        TRANSLATIONS_LIST,                          
        TAGS_DATABASE,                              
        VERSION_STRING,                             
        COPY_TAGS,                                  
        TRANS_TAGS,                                 
        NO_ACTION                                   
    };
 
    enum CopyTagsSource
    {
        COPY_EXIF           = 0x01,                 
        COPY_MAKERNOTES     = 0x02,                 
        COPY_IPTC           = 0x04,                 
        COPY_XMP            = 0x08,                 
        COPY_ICC            = 0x10,                 
        COPY_ALL            = 0x20,                 
        COPY_NONE           = 0x40                  
    };
 
    enum WritingTagsMode
    {
        WRITE_EXISTING_TAGS = 0x01,                 
        CREATE_NEW_TAGS     = 0x02,                 
        CREATE_NEW_GROUPS   = 0x04,                 
        ALL_MODES           = WRITE_EXISTING_TAGS |
                              CREATE_NEW_TAGS     |
                              CREATE_NEW_GROUPS
    };
 
    enum TranslateTagsOps
    {
        TRANS_ALL_XMP       = 0x01,                 
        TRANS_ALL_IPTC      = 0x02,                 
        TRANS_ALL_EXIF      = 0x04                  
    };
 
public:
 
    explicit ExifToolProcess(QObject* const parent);
 
    ~ExifToolProcess();
 
public:
 
    void setProgram(const QString& etExePath,
                    const QString& perlExePath = QString());
 
    QString program() const;
 
    bool checkExifToolProgram();
 
    bool start();
 
    void terminate();
 
    void kill();
 
public:
 
    bool                   isRunning()                  const;
 
    bool                   isBusy()                     const;
 
    qint64                 processId()                  const;
 
    QProcess::ProcessState state()                      const;
 
    QProcess::ProcessError error()                      const;
 
    QString                errorString()                const;
 
    QProcess::ExitStatus   exitStatus()                 const;
 
    int                    exitCode()                   const;
 
    bool waitForStarted(int msecs = 30000)              const;
 
    bool waitForFinished(int msecs = 30000)             const;
 
    int command(const QByteArrayList& args, Action ac);
 
Q_SIGNALS:
 
    void signalStarted(int cmdAction);
 
    void signalStateChanged(int cmdAction,
                            QProcess::ProcessState newState);
 
    void signalErrorOccurred(int cmdAction,
                             QProcess::ProcessError error);
 
    void signalFinished(int cmdAction,
                        int exitCode,
                        QProcess::ExitStatus exitStatus);
 
    void signalCmdCompleted(int cmdAction,
                            int execTime,
                            const QByteArray& cmdOutputChannel,
                            const QByteArray& cmdErrorChannel);
 
private Q_SLOTS:
 
    void slotStarted();
    void slotStateChanged(QProcess::ProcessState newState);
    void slotErrorOccurred(QProcess::ProcessError error);
    void slotReadyReadStandardOutput();
    void slotReadyReadStandardError();
    void slotFinished(int exitCode,
                      QProcess::ExitStatus exitStatus);
 
private:
 
    QString exifToolBin()                               const;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_EXIFTOOL_PROCESS_H