1 files changed, 153 insertions, 0 deletions
diff --git a/digikam/libs/dimg/filters/dimgthreadedfilter.h b/digikam/libs/dimg/filters/dimgthreadedfilter.h
new file mode 100644
index 0000000..20eede3
--- /dev/null
+++ b/digikam/libs/dimg/filters/dimgthreadedfilter.h
@@ -0,0 +1,153 @@
+/* ============================================================
+ *
+ * This file is a part of digiKam project
+ * http://www.digikam.org
+ *
+ * Date        : 2005-05-25
+ * Description : threaded image filter class.
+ * 
+ * Copyright (C) 2005-2007 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 DIMGTHREADEDFILTER_H
+#define DIMGTHREADEDFILTER_H
+
+// Qt includes.
+
+#include <qthread.h>
+#include <qstring.h>
+
+// KDE includes.
+
+#include <kapplication.h>
+
+// Local includes.
+
+#include "dimg.h"
+#include "digikam_export.h"
+
+class QObject;
+
+namespace Digikam
+{
+
+class DIGIKAM_EXPORT DImgThreadedFilter : public QThread
+{
+
+public:
+
+/** Class used to post status of computation to parent. */
+class EventData
+{
+    public:
+    
+    EventData() 
+    {
+       starting = false;
+       success  = false; 
+    }
+    
+    bool starting;    
+    bool success;
+    int  progress;
+};
+
+public:
+    
+    DImgThreadedFilter(DImg *orgImage, QObject *parent=0, 
+                       const QString& name=QString());
+    
+    ~DImgThreadedFilter();
+    
+    DImg getTargetImage(void) { return m_destImage; };
+    
+    virtual void startComputation(void);
+    virtual void stopComputation(void);
+    
+    const QString &filterName() { return m_name; };
+    
+protected:
+
+    /** Start filter operation before threaded method. Must be calls by your constructor. */
+    virtual void initFilter(void);
+        
+    /** List of threaded operations by filter. */
+    virtual void run(){ startComputation(); };
+    
+    /** Main image filter method. */
+    virtual void filterImage(void){};
+    
+    /** Clean up filter data if necessary. Call by stopComputation() method. */
+    virtual void cleanupFilter(void){};
+    
+    /** Post Event to parent about progress. Warning: you need to delete 
+        'EventData' instance to 'customEvent' parent implementation. */
+    void postProgress(int progress=0, bool starting=true, bool success=false);
+
+protected:
+
+    /**
+      Support for chaining two filters as master and thread.
+
+      Constructor for slave mode:
+      Constructs a new slave filter with the specified master.
+      The filter will be executed in the current thread.
+      orgImage and destImage will not be copied.
+      progressBegin and progressEnd can indicate the progress span
+      that the slave filter uses in the parent filter's progress.
+      Any derived filter class that is publicly available to other filters
+      should implement an additional constructor using this constructor.
+      */
+    DImgThreadedFilter(DImgThreadedFilter *master, const DImg &orgImage, const DImg &destImage,
+                       int progressBegin=0, int progressEnd=100, const QString& name=QString());
+
+    /** Inform the master that there is currently a slave. At destruction of the slave, call with slave=0. */
+    void setSlave(DImgThreadedFilter *slave);
+
+    /** This method modulates the progress value from the 0..100 span to the span of this slave.
+        Called by postProgress if master is not null. */
+    virtual int modulateProgress(int progress);
+
+protected:
+
+    /** Used to stop compution loop. */
+    bool                m_cancel;
+
+    /** The progress span that a slave filter uses in the parent filter's progress. */
+    int                 m_progressBegin;
+    int                 m_progressSpan;
+
+    /** To post event from thread to parent. */
+    QObject            *m_parent;
+
+    /** Filter name.*/
+    QString             m_name;
+
+    /** Copy of original Image data. */
+    DImg                m_orgImage;
+
+    /** Output image data. */
+    DImg                m_destImage;
+
+    /** The current slave. Any filter might want to use another filter while processing. */
+    DImgThreadedFilter *m_slave;
+
+    /** The master of this slave filter. Progress info will be routed to this one. */
+    DImgThreadedFilter *m_master;
+};
+
+}  // NameSpace Digikam
+
+#endif /* DIMGTHREADEDFILTER_H */