]> git.sesse.net Git - kdenlive/blobdiff - src/effectslist.cpp
const'ref. Fix coding style. Minor optimization
[kdenlive] / src / effectslist.cpp
index 1c8be746bb2c84d27ce977cd1272e0f129f24faa..0588f0ae8de483b85edae350930a8ed345967e1a 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
-                          docclipbaseiterator.cpp  -  description
+                          effectslist.cpp  -  description
                              -------------------
     begin                : Sat Aug 10 2002
     copyright            : (C) 2002 by Jason Wood
 #include <KLocale>
 
 
-EffectsList::EffectsList():
-        QList < QDomElement > () {
+EffectsList::EffectsList(bool indexRequired) : m_useIndex(indexRequired)
+{
+    m_baseElement = createElement("list");
+    appendChild(m_baseElement);
 }
 
-EffectsList::~EffectsList() {
+EffectsList::~EffectsList()
+{
 }
 
-QDomElement EffectsList::getEffectByName(const QString & name) const {
+QDomElement EffectsList::getEffectByName(const QString & name) const
+{
     QString effectName;
-    for (int i = 0; i < size(); ++i) {
-        QDomElement effect =  at(i);
-        QDomNode namenode = effect.elementsByTagName("name").item(0);
-        if (!namenode.isNull()) effectName = i18n(namenode.toElement().text().toUtf8().data());
+    QDomNodeList effects = m_baseElement.childNodes();
+    for (int i = 0; i < effects.count(); ++i) {
+        QDomElement effect =  effects.at(i).toElement();
+        QDomElement namenode = effect.firstChildElement("name");
+        if (!namenode.isNull()) effectName = i18n(namenode.text().toUtf8().data());
         if (name == effectName) {
             QDomNodeList params = effect.elementsByTagName("parameter");
-            for (int i = 0; i < params.count(); i++) {
+            for (int i = 0; i < params.count(); ++i) {
                 QDomElement e = params.item(i).toElement();
                 if (!e.hasAttribute("value"))
                     e.setAttribute("value", e.attribute("default"));
@@ -49,119 +54,191 @@ QDomElement EffectsList::getEffectByName(const QString & name) const {
     return QDomElement();
 }
 
-QDomElement EffectsList::getEffectByTag(const QString & tag, const QString & id) const {
 
-    if (!id.isEmpty()) for (int i = 0; i < size(); ++i) {
-            QDomElement effect =  at(i);
-            //kDebug() << "// SRCH EFFECT; " << id << ", LKING: " << effect.attribute("id");
+void EffectsList::initEffect(const QDomElement &effect) const
+{
+    QDomNodeList params = effect.elementsByTagName("parameter");
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement e = params.item(i).toElement();
+        if (!e.hasAttribute("value"))
+            e.setAttribute("value", e.attribute("default"));
+    }
+}
+
+QDomElement EffectsList::getEffectByTag(const QString & tag, const QString & id) const
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    for (int i = 0; i < effects.count(); ++i) {
+        QDomElement effect =  effects.at(i).toElement();
+        if (!id.isEmpty()) {
             if (effect.attribute("id") == id) {
-                QDomNodeList params = effect.elementsByTagName("parameter");
-                for (int i = 0; i < params.count(); i++) {
-                    QDomElement e = params.item(i).toElement();
-                    if (!e.hasAttribute("value"))
-                        e.setAttribute("value", e.attribute("default"));
+                if (effect.tagName() == "effectgroup") {
+                    // Effect group
+                    QDomNodeList subeffects = effect.elementsByTagName("effect");
+                    for (int j = 0; j < subeffects.count(); j++) {
+                        QDomElement sub = subeffects.at(j).toElement();
+                        initEffect(sub);
+                    }
                 }
+                else initEffect(effect);
                 return effect;
             }
-        }
-
-    if (!tag.isEmpty()) for (int i = 0; i < size(); ++i) {
-            QDomElement effect =  at(i);
+        } else if (!tag.isEmpty()) {
             if (effect.attribute("tag") == tag) {
-                QDomNodeList params = effect.elementsByTagName("parameter");
-                for (int i = 0; i < params.count(); i++) {
-                    QDomElement e = params.item(i).toElement();
-                    if (!e.hasAttribute("value"))
-                        e.setAttribute("value", e.attribute("default"));
-                }
+                initEffect(effect);
                 return effect;
             }
         }
-
+    }
     return QDomElement();
 }
 
-int EffectsList::hasEffect(const QString & tag, const QString & id) const {
-    for (int i = 0; i < size(); ++i) {
-        QDomElement effect =  at(i);
+int EffectsList::hasEffect(const QString & tag, const QString & id) const
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    for (int i = 0; i < effects.count(); ++i) {
+        QDomElement effect =  effects.at(i).toElement();
         if (!id.isEmpty()) {
-            if (effect.attribute("id") == id) return i;
-        } else if (!tag.isEmpty() && effect.attribute("tag") == tag) return i;
+            if (effect.attribute("id") == id) return effect.attribute("kdenlive_ix").toInt();
+        } else if (!tag.isEmpty() && effect.attribute("tag") == tag) {
+            return effect.attribute("kdenlive_ix").toInt();
+        }
     }
     return -1;
 }
 
-QStringList EffectsList::effectIdInfo(const int ix) const {
+QStringList EffectsList::effectIdInfo(const int ix) const
+{
     QStringList info;
-    QDomElement effect =  at(ix);
-    QDomNode namenode = effect.elementsByTagName("name").item(0);
-    info << i18n(namenode.toElement().text().toUtf8().data()) << effect.attribute("tag") << effect.attribute("id");
+    QDomElement effect = m_baseElement.childNodes().at(ix).toElement();
+    if (effect.tagName() == "effectgroup") {
+        QString groupName = effect.attribute("name");
+        info << groupName << groupName << effect.attribute("id") << QString::number(Kdenlive::groupEffect);
+    }
+    else {
+        QDomElement namenode = effect.firstChildElement("name");
+        info << i18n(namenode.text().toUtf8().data()) << effect.attribute("tag") << effect.attribute("id");
+    }
     return info;
 }
 
-QStringList EffectsList::effectNames() {
+QStringList EffectsList::effectNames()
+{
     QStringList list;
-    for (int i = 0; i < size(); ++i) {
-        QDomElement effect =  at(i);
-        QDomNode namenode = effect.elementsByTagName("name").item(0);
-        if (!namenode.isNull()) list.append(i18n(namenode.toElement().text().toUtf8().data()));
+    QDomNodeList effects = m_baseElement.childNodes();
+    for (int i = 0; i < effects.count(); ++i) {
+        QDomElement effect =  effects.at(i).toElement();
+        QDomElement namenode = effect.firstChildElement("name");
+        if (!namenode.isNull()) list.append(i18n(namenode.text().toUtf8().data()));
     }
     return list;
 }
 
-QString EffectsList::getInfo(const QString & tag, const QString & id) const {
+QString EffectsList::getInfo(const QString & tag, const QString & id) const
+{
     QString info;
-    QDomElement effect = getEffectByTag(tag, id);
-    QDomNode namenode = effect.elementsByTagName("description").item(0);
-    if (!namenode.isNull()) info = i18n(namenode.toElement().text().toUtf8().data());
-    namenode = effect.elementsByTagName("author").item(0);
-    if (!namenode.isNull()) info.append("<br /><strong>" + i18n("Author:") + " </strong>" + i18n(namenode.toElement().text().toUtf8().data()));
-    return info;
+    return getEffectInfo(getEffectByTag(tag, id));
 }
 
-QString EffectsList::getInfoFromIndex(const int ix) const {
+QString EffectsList::getInfoFromIndex(const int ix) const
+{
     QString info;
-    QDomElement effect = at(ix);
-    QDomNode namenode = effect.elementsByTagName("description").item(0);
-    if (!namenode.isNull()) info = i18n(namenode.toElement().text().toUtf8().data());
-    namenode = effect.elementsByTagName("author").item(0);
-    if (!namenode.isNull()) info.append("<br /><strong>" + i18n("Author:") + " </strong>" + i18n(namenode.toElement().text().toUtf8().data()));
+    return getEffectInfo(m_baseElement.childNodes().at(ix).toElement());
+}
+
+QString EffectsList::getEffectInfo(const QDomElement effect) const
+{
+    QString info;
+    QDomElement namenode = effect.firstChildElement("description");
+    if (!namenode.isNull())
+        info = i18n(namenode.firstChild().nodeValue().simplified().toUtf8().data());
+
+    namenode = effect.firstChildElement("author");
+    if (!namenode.isNull())
+        info.append("<br /><strong>" + i18n("Author:") + " </strong>" + i18n(namenode.text().toUtf8().data()));
+
+    namenode = effect.firstChildElement("version");
+    if (!namenode.isNull())
+        info.append(QString(" (%1)").arg(namenode.text()));
+
     return info;
 }
 
-bool EffectsList::hasKeyFrames(QDomElement effect) {
+// static
+bool EffectsList::hasKeyFrames(const QDomElement &effect)
+{
     QDomNodeList params = effect.elementsByTagName("parameter");
-    for (int i = 0; i < params.count(); i++) {
+    for (int i = 0; i < params.count(); ++i) {
         QDomElement e = params.item(i).toElement();
         if (e.attribute("type") == "keyframe") return true;
     }
     return false;
 }
 
-EffectsList EffectsList::clone() const {
-    EffectsList list;
-    for (int i = 0; i < size(); ++i) {
-        list.append(at(i).cloneNode().toElement());
+// static
+bool EffectsList::hasSimpleKeyFrames(const QDomElement &effect)
+{
+    QDomNodeList params = effect.elementsByTagName("parameter");
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement e = params.item(i).toElement();
+        if (e.attribute("type") == "simplekeyframe") return true;
     }
-    return list;
+    return false;
 }
 
 // static
-void EffectsList::setParameter(QDomElement effect, const QString &name, const QString &value) {
+bool EffectsList::hasGeometryKeyFrames(const QDomElement &effect)
+{
     QDomNodeList params = effect.elementsByTagName("parameter");
-    for (int i = 0; i < params.count(); i++) {
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement param = params.item(i).toElement();
+        if (param.attribute("type") == "geometry" && !param.hasAttribute("fixed"))
+            return true;
+    }
+    return false;
+}
+
+void EffectsList::clone(const EffectsList &original)
+{
+    setContent(original.toString());
+    m_baseElement = documentElement();
+}
+
+void EffectsList::clearList()
+{
+    while (!m_baseElement.firstChild().isNull())
+        m_baseElement.removeChild(m_baseElement.firstChild());
+}
+
+// static
+void EffectsList::setParameter(QDomElement effect, const QString &name, const QString &value)
+{
+    QDomNodeList params = effect.elementsByTagName("parameter");
+    bool found = false;
+    for (int i = 0; i < params.count(); ++i) {
         QDomElement e = params.item(i).toElement();
         if (e.attribute("name") == name) {
             e.setAttribute("value", value);
+            found = true;
             break;
         }
     }
+    if (!found) {
+        // create property
+        QDomDocument doc = effect.ownerDocument();
+        QDomElement e = doc.createElement("parameter");
+        e.setAttribute("name", name);
+        QDomText val = doc.createTextNode(value);
+        e.appendChild(val);
+        effect.appendChild(e);
+    }
 }
 
 // static
-QString EffectsList::parameter(QDomElement effect, const QString &name) {
+QString EffectsList::parameter(const QDomElement &effect, const QString &name)
+{
     QDomNodeList params = effect.elementsByTagName("parameter");
-    for (int i = 0; i < params.count(); i++) {
+    for (int i = 0; i < params.count(); ++i) {
         QDomElement e = params.item(i).toElement();
         if (e.attribute("name") == name) {
             return e.attribute("value");
@@ -170,3 +247,178 @@ QString EffectsList::parameter(QDomElement effect, const QString &name) {
     return QString();
 }
 
+// static
+void EffectsList::setProperty(QDomElement effect, const QString &name, const QString &value)
+{
+    QDomNodeList params = effect.elementsByTagName("property");
+    // Update property if it already exists
+    bool found = false;
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement e = params.item(i).toElement();
+        if (e.attribute("name") == name) {
+            e.firstChild().setNodeValue(value);
+            found = true;
+            break;
+        }
+    }
+    if (!found) {
+        // create property
+        QDomDocument doc = effect.ownerDocument();
+        QDomElement e = doc.createElement("property");
+        e.setAttribute("name", name);
+        QDomText val = doc.createTextNode(value);
+        e.appendChild(val);
+        effect.appendChild(e);
+    }
+}
+
+// static
+void EffectsList::renameProperty(QDomElement effect, const QString &oldName, const QString &newName)
+{
+    QDomNodeList params = effect.elementsByTagName("property");
+    // Update property if it already exists
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement e = params.item(i).toElement();
+        if (e.attribute("name") == oldName) {
+            e.setAttribute("name", newName);
+            break;
+        }
+    }
+}
+
+// static
+QString EffectsList::property(QDomElement effect, const QString &name)
+{
+    QDomNodeList params = effect.elementsByTagName("property");
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement e = params.item(i).toElement();
+        if (e.attribute("name") == name) {
+            return e.firstChild().nodeValue();
+        }
+    }
+    return QString();
+}
+
+// static
+void EffectsList::removeProperty(QDomElement effect, const QString &name)
+{
+    QDomNodeList params = effect.elementsByTagName("property");
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement e = params.item(i).toElement();
+        if (e.attribute("name") == name) {
+            effect.removeChild(params.item(i));
+            break;
+        }
+    }
+}
+
+// static
+void EffectsList::removeMetaProperties(QDomElement producer)
+{
+    QDomNodeList params = producer.elementsByTagName("property");
+    for (int i = 0; i < params.count(); ++i) {
+        QDomElement e = params.item(i).toElement();
+        if (e.attribute("name").startsWith("meta")) {
+            producer.removeChild(params.item(i));
+            --i;
+        }
+    }
+}
+
+QDomElement EffectsList::append(QDomElement e)
+{
+    QDomElement result;
+    if (!e.isNull()) {
+        result = m_baseElement.appendChild(importNode(e, true)).toElement();
+        if (m_useIndex) {
+            updateIndexes(m_baseElement.childNodes(), m_baseElement.childNodes().count() - 1);
+        }
+    }
+    return result;
+}
+
+int EffectsList::count() const
+{
+    return m_baseElement.childNodes().count();
+}
+
+bool EffectsList::isEmpty() const
+{
+    return !m_baseElement.hasChildNodes();
+}
+
+const QDomElement EffectsList::at(int ix) const
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    if (ix < 0 || ix >= effects.count()) return QDomElement();
+    return effects.at(ix).toElement();
+}
+
+void EffectsList::removeAt(int ix)
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    if (ix <= 0 || ix > effects.count()) return;
+    m_baseElement.removeChild(effects.at(ix - 1));
+    if (m_useIndex) updateIndexes(effects, ix - 1);
+}
+
+QDomElement EffectsList::itemFromIndex(int ix) const
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    if (ix <= 0 || ix > effects.count()) return QDomElement();
+    return effects.at(ix - 1).toElement();
+}
+
+QDomElement EffectsList::insert(QDomElement effect)
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    int ix = effect.attribute("kdenlive_ix").toInt();
+    QDomElement result;
+    if (ix <= 0 || ix > effects.count()) {
+        ix = effects.count();
+        result = m_baseElement.appendChild(importNode(effect, true)).toElement();
+    }
+    else {
+        QDomElement listeffect =  effects.at(ix - 1).toElement();
+        result = m_baseElement.insertBefore(importNode(effect, true), listeffect).toElement();
+    }
+    if (m_useIndex && ix > 0)
+        updateIndexes(effects, ix - 1);
+    return result;
+}
+
+void EffectsList::updateIndexes(QDomNodeList effects, int startIndex)
+{
+    for (int i = startIndex; i < effects.count(); ++i) {
+        QDomElement listeffect =  effects.at(i).toElement();
+        listeffect.setAttribute(QLatin1String("kdenlive_ix"), i + 1);
+    }
+}
+
+void EffectsList::enableEffects(const QList <int>& indexes, bool disable)
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    QDomElement effect;
+    for (int i = 0; i < indexes.count(); ++i) {
+        effect =  effectFromIndex(effects, indexes.at(i));
+        effect.setAttribute("disable", (int) disable);
+    }
+}
+
+QDomElement EffectsList::effectFromIndex(const QDomNodeList &effects, int ix)
+{
+    if (ix <= 0 || ix > effects.count()) return QDomElement();
+    return effects.at(ix - 1).toElement();
+}
+
+void EffectsList::updateEffect(const QDomElement &effect)
+{
+    QDomNodeList effects = m_baseElement.childNodes();
+    int ix = effect.attribute("kdenlive_ix").toInt();
+    QDomElement current = effectFromIndex(effects, ix);
+    if (!current.isNull()) {
+        m_baseElement.insertBefore(importNode(effect, true), current);
+        m_baseElement.removeChild(current);
+    }
+    else m_baseElement.appendChild(importNode(effect, true));
+}