Embed custom effects in project file:

http://www.kdenlive.org/mantis/view.php?id=1774

svn path=/trunk/kdenlive/; revision=4922

diff --git a/src/initeffects.cpp b/src/initeffects.cpp
index 91bbd8b305ee9afe04ab6ec25ee17eeb4cdd096c..42cf9148195a79ead1bcbbc1fc298158938728cb 100644 (file)
--- a/src/initeffects.cpp
+++ b/src/initeffects.cpp
@@ -33,7 +33,7 @@
 #include <QIcon>
 
 initEffectsThumbnailer::initEffectsThumbnailer() :
-        QThread()
+    QThread()
 {
 }
 
@@ -46,7 +46,7 @@ void initEffectsThumbnailer::prepareThumbnailsCall(const QStringList& list)
 
 void initEffectsThumbnailer::run()
 {
-    foreach(const QString &entry, m_list) {
+    foreach(const QString & entry, m_list) {
         kDebug() << entry;
         if (!entry.isEmpty() && (entry.endsWith(".png") || entry.endsWith(".pgm"))) {
             if (!EffectStackEdit::iconCache.contains(entry)) {
@@ -71,9 +71,9 @@ void initEffects::refreshLumas()
     filters << "*.pgm" << "*.png";
 
     QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
-    foreach(const QString &folder, customLumas) {
+    foreach(const QString & folder, customLumas) {
         QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
-        foreach(const QString &fname, filesnames) {
+        foreach(const QString & fname, filesnames) {
             imagenamelist.append(fname);
             imagefiles.append(KUrl(folder).path(KUrl::AddTrailingSlash) + fname);
         }
@@ -85,7 +85,7 @@ void initEffects::refreshLumas()
     folder.addPath(mlt_environment("MLT_NORMALISATION"));
     QDir lumafolder(folder.path());
     QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
-    foreach(const QString &fname, filesnames) {
+    foreach(const QString & fname, filesnames) {
         imagenamelist.append(fname);
         KUrl path(folder);
         path.addPath(fname);
@@ -114,6 +114,25 @@ void initEffects::refreshLumas()
     }
 }
 
+// static
+QDomDocument initEffects::getUsedCustomEffects(QMap <QString, QString> effectids)
+{
+    QMapIterator<QString, QString> i(effectids);
+    int ix;
+    QDomDocument doc;
+    QDomElement list = doc.createElement("customeffects");
+    doc.appendChild(list);
+    while (i.hasNext()) {
+        i.next();
+        ix = MainWindow::customEffects.hasEffect(i.value(), i.key());
+        if (ix > -1) {
+            QDomElement e = MainWindow::customEffects.at(ix);
+            list.appendChild(doc.importNode(e, true));
+        }
+    }
+    return doc;
+}
+
 //static
 Mlt::Repository *initEffects::parseEffectFiles()
 {
@@ -222,7 +241,7 @@ Mlt::Repository *initEffects::parseEffectFiles()
         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
     }
     MainWindow::transitions.clearList();
-    foreach(const QDomElement &effect, effectsMap)
+    foreach(const QDomElement & effect, effectsMap)
     MainWindow::transitions.append(effect);
     effectsMap.clear();
     for (int i = 0; i < MainWindow::customEffects.count(); ++i) {
@@ -230,7 +249,7 @@ Mlt::Repository *initEffects::parseEffectFiles()
         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
     }
     MainWindow::customEffects.clearList();
-    foreach(const QDomElement &effect, effectsMap)
+    foreach(const QDomElement & effect, effectsMap)
     MainWindow::customEffects.append(effect);
     effectsMap.clear();
     for (int i = 0; i < MainWindow::audioEffects.count(); ++i) {
@@ -238,7 +257,7 @@ Mlt::Repository *initEffects::parseEffectFiles()
         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
     }
     MainWindow::audioEffects.clearList();
-    foreach(const QDomElement &effect, effectsMap)
+    foreach(const QDomElement & effect, effectsMap)
     MainWindow::audioEffects.append(effect);
     effectsMap.clear();
     for (int i = 0; i < MainWindow::videoEffects.count(); ++i) {
@@ -246,13 +265,13 @@ Mlt::Repository *initEffects::parseEffectFiles()
         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
     }
     // Add remaining filters to the list of video effects.
-    foreach(const QString &filtername, filtersList) {
+    foreach(const QString & filtername, filtersList) {
         QDomDocument doc = createDescriptionFromMlt(repository, "filters", filtername);
         if (!doc.isNull())
             effectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
     }
     MainWindow::videoEffects.clearList();
-    foreach(const QDomElement &effect, effectsMap)
+    foreach(const QDomElement & effect, effectsMap)
     MainWindow::videoEffects.append(effect);
 
     return repository;
@@ -280,7 +299,7 @@ void initEffects::parseCustomEffectsFile()
     QDomDocument doc;
     QDomNodeList effects;
     QDomElement e;
-    foreach(const QString &filename, fileList) {
+    foreach(const QString & filename, fileList) {
         QString itemName = KUrl(path + filename).path();
         QFile file(itemName);
         doc.setContent(&file, false);
@@ -293,8 +312,8 @@ void initEffects::parseCustomEffectsFile()
             effectsMap.insert(e.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), e);
         }
     }
-    foreach(const QDomElement &effect, effectsMap)
-        MainWindow::customEffects.append(effect);
+    foreach(const QDomElement & effect, effectsMap)
+    MainWindow::customEffects.append(effect);
 }
 
 // static
@@ -575,8 +594,8 @@ QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository,
                 if (QString(paramdesc.get("type")) == "float") {
                     params.setAttribute("type", "constant");
                     params.setAttribute("factor", "1000");
-                    if (paramdesc.get("maximum")) params.setAttribute("max", QString(paramdesc.get("maximum")).toFloat()*1000.0);
-                    if (paramdesc.get("minimum")) params.setAttribute("min", QString(paramdesc.get("minimum")).toFloat()*1000.0);
+                    if (paramdesc.get("maximum")) params.setAttribute("max", QString(paramdesc.get("maximum")).toFloat() * 1000.0);
+                    if (paramdesc.get("minimum")) params.setAttribute("min", QString(paramdesc.get("minimum")).toFloat() * 1000.0);
                 }
                 if (QString(paramdesc.get("type")) == "boolean")
                     params.setAttribute("type", "bool");
@@ -630,7 +649,7 @@ void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *
         if (!folder.endsWith('/'))
             folder.append('/');
         QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
-        foreach(const QString &fname, filesnames) {
+        foreach(const QString & fname, filesnames) {
             imagenamelist.append(fname);
             imagefiles.append(folder + fname);
         }
@@ -642,14 +661,14 @@ void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *
     folder.addPath(mlt_environment("MLT_NORMALISATION"));
     QDir lumafolder(folder.path());
     QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
-    foreach(const QString &fname, filesnames) {
+    foreach(const QString & fname, filesnames) {
         imagenamelist.append(fname);
         KUrl path(folder);
         path.addPath(fname);
         imagefiles.append(path.toLocalFile());
     }
 
-    foreach(const QString &name, names) {
+    foreach(const QString & name, names) {
         QDomDocument ret;
         QDomElement ktrans = ret.createElement("ktransition");
         ret.appendChild(ktrans);
@@ -767,7 +786,7 @@ void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *
                 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "composite.progressive", "bool", "1", "0", "1"));
                 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "composite.deinterlace", "bool", "0", "0", "1"));
             }
-            foreach(const QDomElement &e, paramList)
+            foreach(const QDomElement & e, paramList)
             ktrans.appendChild(e);
         }
 

diff --git a/src/initeffects.h b/src/initeffects.h
index ac5dceac3cbf7d5588390f6b8b4cccb40c4697b9..acc70c96217273e930caa5b02d9777dd80d8cb9f 100644 (file)
--- a/src/initeffects.h
+++ b/src/initeffects.h
@@ -57,6 +57,7 @@ public:
     static Mlt::Repository *parseEffectFiles();
     static void refreshLumas();
     static QDomDocument createDescriptionFromMlt(Mlt::Repository* repository, const QString& type, const QString& name);
+    static QDomDocument getUsedCustomEffects(QMap <QString, QString> effectids);
 
     /** @brief Fills the transitions list.
      * @param repository MLT repository

diff --git a/src/kdenlivedoc.cpp b/src/kdenlivedoc.cpp
index ab638515612c5ff41f84c86f8a67d371bb59e20e..025d028a7e557098f359278ee9c942078d60300b 100644 (file)
--- a/src/kdenlivedoc.cpp
+++ b/src/kdenlivedoc.cpp
@@ -29,6 +29,7 @@
 #include "documentchecker.h"
 #include "documentvalidator.h"
 #include "kdenlive-config.h"
+#include "initeffects.h"
 
 #include <KDebug>
 #include <KStandardDirs>
@@ -107,8 +108,15 @@ KdenliveDoc::KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup
                             parent->slotGotProgressInfo(i18n("Loading"), 0);
                             QDomElement mlt = m_document.firstChildElement("mlt");
                             QDomElement infoXml = mlt.firstChildElement("kdenlivedoc");
-                            QDomElement e;
 
+                            // Check embedded effects
+                            QDomElement customeffects = infoXml.firstChildElement("customeffects");
+                            if (!customeffects.isNull() && customeffects.hasChildNodes()) {
+                                parent->slotGotProgressInfo(i18n("Importing project effects"), 0);
+                                if (saveCustomEffects(customeffects.childNodes())) parent->slotReloadEffects();
+                            }
+
+                            QDomElement e;
                             // Read notes
                             QDomElement notesxml = infoXml.firstChildElement("documentnotes");
                             if (!notesxml.isNull()) m_notesWidget->setText(notesxml.firstChild().nodeValue());
@@ -502,9 +510,34 @@ bool KdenliveDoc::saveSceneList(const QString &path, const QString &scene)
         KMessageBox::error(kapp->activeWindow(), i18n("Cannot write to file %1, scene list is corrupted.", path));
         return false;
     }
+
     QDomElement addedXml = sceneList.createElement("kdenlivedoc");
     mlt.appendChild(addedXml);
 
+    // check if project contains custom effects to embed them in project file
+    QDomNodeList effects = mlt.elementsByTagName("filter");
+    int maxEffects = effects.count();
+    kDebug() << "// FOUD " << maxEffects << " EFFECTS+++++++++++++++++++++";
+    QMap <QString, QString> effectIds;
+    for (int i = 0; i < maxEffects; i++) {
+        QDomNode m = effects.at(i);
+        QDomNodeList params = m.childNodes();
+        QString id;
+        QString tag;
+        for (int j = 0; j < params.count(); j++) {
+            QDomElement e = params.item(j).toElement();
+            if (e.attribute("name") == "kdenlive_id") {
+                id = e.firstChild().nodeValue();
+            }
+            if (e.attribute("name") == "tag") {
+                tag = e.firstChild().nodeValue();
+            }
+            if (!id.isEmpty() && !tag.isEmpty()) effectIds.insert(id, tag);
+        }
+    }
+    QDomDocument customeffects = initEffects::getUsedCustomEffects(effectIds);
+    addedXml.appendChild(sceneList.importNode(customeffects.documentElement(), true));
+
     QDomElement markers = sceneList.createElement("markers");
     addedXml.setAttribute("version", DOCUMENTVERSION);
     addedXml.setAttribute("kdenliveversion", VERSION);
@@ -1385,5 +1418,36 @@ QDomElement KdenliveDoc::getTrackEffect(int trackIndex, int effectIndex) const
     return list.at(effectIndex).cloneNode().toElement();
 }
 
+bool KdenliveDoc::saveCustomEffects(QDomNodeList customeffects)
+{
+    QDomElement e;
+    QStringList importedEffects;
+    int maxchild = customeffects.count();
+    for (int i = 0; i < maxchild; i++) {
+        e = customeffects.at(i).toElement();
+        QString id = e.attribute("id");
+        QString tag = e.attribute("tag");
+        if (!id.isEmpty()) {
+            // Check if effect exists or save it
+            if (MainWindow::customEffects.hasEffect(tag, id) == -1) {
+                QDomDocument doc;
+                doc.appendChild(doc.importNode(e, true));
+                QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
+                path += id + ".xml";
+                if (!QFile::exists(path)) {
+                    importedEffects << id;
+                    QFile file(path);
+                    if (file.open(QFile::WriteOnly | QFile::Truncate)) {
+                        QTextStream out(&file);
+                        out << doc.toString();
+                    }
+                }
+            }
+        }
+    }
+    if (!importedEffects.isEmpty()) KMessageBox::informationList(kapp->activeWindow(), i18n("The following effects were imported from the project:"), importedEffects);
+    return (!importedEffects.isEmpty());
+}
+
 #include "kdenlivedoc.moc"
 

diff --git a/src/kdenlivedoc.h b/src/kdenlivedoc.h
index e8953f1de63866a280c44fb304ed60ae9d3feea4..08dea8333e94e71b587cfb7a2338355041525023 100644 (file)
--- a/src/kdenlivedoc.h
+++ b/src/kdenlivedoc.h
@@ -172,6 +172,9 @@ private:
     /** @brief Creates a new project. */
     QDomDocument createEmptyDocument(int videotracks, int audiotracks);
     QDomDocument createEmptyDocument(QList <TrackInfo> tracks);
+    /** @brief Saves effects embedded in project file.
+    *   @return True if effects were imported.  */
+    bool saveCustomEffects(QDomNodeList customeffects);
 
 public slots:
     void slotCreateXmlClip(const QString &name, const QDomElement xml, QString group, const QString &groupId);

diff --git a/src/mainwindow.h b/src/mainwindow.h
index 62f5c68122e72e8fe32fdf51de7bbc628362d791..5d723fa5429db1f4e088f3ad60feb69adc2e1a6a 100644 (file)
--- a/src/mainwindow.h
+++ b/src/mainwindow.h
@@ -283,6 +283,7 @@ public slots:
     * Checks if already open and whether backup exists */
     void openFile(const KUrl &url);
     void slotGotProgressInfo(const QString &message, int progress);
+    void slotReloadEffects();
     Q_SCRIPTABLE void setRenderingProgress(const QString &url, int progress);
     Q_SCRIPTABLE void setRenderingFinished(const QString &url, int status, const QString &error);
 
@@ -410,7 +411,6 @@ private slots:
     void slotCopy();
     void slotPaste();
     void slotPasteEffects();
-    void slotReloadEffects();
 
     void slotAdjustClipMonitor();
     void slotAdjustProjectMonitor();