Improve reloading of externally modified clips (wait for 1.5 second before reloading...

[kdenlive] / src / clipmanager.h

diff --git a/src/clipmanager.h b/src/clipmanager.h
index 2d5f510795fb4dc8a0440a8e8fa74c511090277f..fe214673835f2a56af23782e9c800e56cb8d279e 100644 (file)
--- a/src/clipmanager.h
+++ b/src/clipmanager.h
@@ -17,19 +17,23 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  ***************************************************************************/
 
+/**
+ * @class ClipManager
+ * @brief Manages the list of clips in a document.
+ * @author Jean-Baptiste Mardelle
+ */
+
 #ifndef CLIPMANAGER_H
 #define CLIPMANAGER_H
 
-/**ClipManager manages the list of clips in a document
-  *@author Jean-Baptiste Mardelle
-  */
-
 #include <qdom.h>
 #include <QPixmap>
 #include <QObject>
+#include <QTimer>
 
 #include <KUrl>
 #include <KUndoStack>
+#include <KDirWatch>
 #include <klocale.h>
 
 #include "gentime.h"
@@ -38,28 +42,43 @@
 
 class KdenliveDoc;
 class DocClipBase;
+class AbstractGroupItem;
 
-namespace Mlt {
+namespace Mlt
+{
 class Producer;
 };
 
-class ClipManager: public QObject {
+class ClipManager: public QObject
+{
 Q_OBJECT public:
 
-
     ClipManager(KdenliveDoc *doc);
     virtual ~ ClipManager();
     void addClip(DocClipBase *clip);
     DocClipBase *getClipAt(int pos);
     void deleteClip(const QString &clipId);
+
+    /** @brief Add a file to the project.
+     * @ref slotAddClipList
+     * @param url file to add
+     * @param group name of the group to insert the file in (can be empty)
+     * @param groupId id of the group (if any) */
     void slotAddClipFile(const KUrl url, const QString group, const QString &groupId);
+
+    /** @brief Adds a list of files to the project.
+     * @param urls files to add
+     * @param group name of the group to insert the files in (can be empty)
+     * @param groupId id of the group (if any)
+     * It checks for duplicated items and asks to the user for instructions. */
     void slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId);
-    void slotAddTextClipFile(const QString titleName, const QString imagePath, const QString xml, const QString group, const QString &groupId);
+    void slotAddTextClipFile(const QString titleName, int out, const QString xml, const QString group, const QString &groupId);
+    void slotAddTextTemplateClip(QString titleName, const KUrl path, const QString group, const QString &groupId);
     void slotAddColorClipFile(const QString name, const QString color, QString duration, const QString group, const QString &groupId);
     void slotAddSlideshowClipFile(const QString name, const QString path, int count, const QString duration, const bool loop, const bool fade, const QString &luma_duration, const QString &luma_file, const int softness, const QString group, const QString &groupId);
     DocClipBase *getClipById(QString clipId);
-    DocClipBase *getClipByResource(QString resource);
-    void slotDeleteClip(const QString & clipId);
+    const QList <DocClipBase *> getClipByResource(QString resource);
+    void slotDeleteClips(QStringList ids);
     void setThumbsProgress(const QString &message, int progress);
     void checkAudioThumbs();
     QList <DocClipBase*> documentClipList() const;
@@ -71,26 +90,51 @@ Q_OBJECT public:
     void endAudioThumbsGeneration(const QString &requestedId);
     void askForAudioThumb(const QString &id);
     QString projectFolder() const;
-    void resetProducersList(QList <Mlt::Producer *> prods);
+    void clearUnusedProducers();
+    void resetProducersList(const QList <Mlt::Producer *> prods);
     void addFolder(const QString&, const QString&);
     void deleteFolder(const QString&);
     void clear();
+    AbstractGroupItem *createGroup();
+    void removeGroup(AbstractGroupItem *group);
+    QDomElement groupsXml() const;
+    int clipsCount() const;
 
 public slots:
     void updatePreviewSettings();
 
+private slots:
+    /** A clip was externally modified, monitor for more changes and prepare for reload */
+    void slotClipModified(const QString &path);
+    void slotClipMissing(const QString &path);
+    void slotClipAvailable(const QString &path);
+    /** Check the list of externally modified clips, and process them if they were not modified in the last 1500 milliseconds */
+    void slotProcessModifiedClips();
+
 private:   // Private attributes
     /** the list of clips in the document */
     QList <DocClipBase*> m_clipList;
+    /** the list of groups in the document */
+    QList <AbstractGroupItem *> m_groupsList;
     QMap <QString, QString> m_folderList;
     QList <QString> m_audioThumbsQueue;
     /** the document undo stack*/
     KdenliveDoc *m_doc;
     int m_clipIdCounter;
     int m_folderIdCounter;
-    bool m_audioThumbsEnabled;
     QString m_generatingAudioId;
+    KDirWatch m_fileWatcher;
+    /** Timer used to reload clips when they have been externally modified */
+    QTimer m_modifiedTimer;
+    /** List of the clip IDs that need to be reloaded after being externally modified */
+    QMap <QString, QTime> m_modifiedClips;
 
+signals:
+    void reloadClip(const QString &);
+    void modifiedClip(const QString &);
+    void missingClip(const QString &);
+    void availableClip(const QString &);
+    void checkAllClips();
 };
 
 #endif