1 /***************************************************************************
2 effectslist.cpp - description
4 begin : Sat Aug 10 2002
5 copyright : (C) 2002 by Jason Wood
6 email : jasonwood@blueyonder.co.uk
7 ***************************************************************************/
9 /***************************************************************************
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 ***************************************************************************/
19 #include "effectslist.h"
25 EffectsList::EffectsList(bool indexRequired) : m_useIndex(indexRequired)
27 m_baseElement = createElement("list");
28 appendChild(m_baseElement);
31 EffectsList::~EffectsList()
35 QDomElement EffectsList::getEffectByName(const QString & name) const
38 QDomNodeList effects = m_baseElement.childNodes();
39 for (int i = 0; i < effects.count(); ++i) {
40 QDomElement effect = effects.at(i).toElement();
41 QDomElement namenode = effect.firstChildElement("name");
42 if (!namenode.isNull()) effectName = i18n(namenode.text().toUtf8().data());
43 if (name == effectName) {
44 QDomNodeList params = effect.elementsByTagName("parameter");
45 for (int i = 0; i < params.count(); ++i) {
46 QDomElement e = params.item(i).toElement();
47 if (!e.hasAttribute("value"))
48 e.setAttribute("value", e.attribute("default"));
58 void EffectsList::initEffect(const QDomElement &effect) const
60 QDomNodeList params = effect.elementsByTagName("parameter");
61 for (int i = 0; i < params.count(); ++i) {
62 QDomElement e = params.item(i).toElement();
63 if (!e.hasAttribute("value"))
64 e.setAttribute("value", e.attribute("default"));
68 QDomElement EffectsList::getEffectByTag(const QString & tag, const QString & id) const
70 QDomNodeList effects = m_baseElement.childNodes();
71 for (int i = 0; i < effects.count(); ++i) {
72 QDomElement effect = effects.at(i).toElement();
74 if (effect.attribute("id") == id) {
75 if (effect.tagName() == "effectgroup") {
77 QDomNodeList subeffects = effect.elementsByTagName("effect");
78 for (int j = 0; j < subeffects.count(); j++) {
79 QDomElement sub = subeffects.at(j).toElement();
83 else initEffect(effect);
86 } else if (!tag.isEmpty()) {
87 if (effect.attribute("tag") == tag) {
96 int EffectsList::hasEffect(const QString & tag, const QString & id) const
98 QDomNodeList effects = m_baseElement.childNodes();
99 for (int i = 0; i < effects.count(); ++i) {
100 QDomElement effect = effects.at(i).toElement();
102 if (effect.attribute("id") == id) return effect.attribute("kdenlive_ix").toInt();
103 } else if (!tag.isEmpty() && effect.attribute("tag") == tag) {
104 return effect.attribute("kdenlive_ix").toInt();
110 QStringList EffectsList::effectIdInfo(const int ix) const
113 QDomElement effect = m_baseElement.childNodes().at(ix).toElement();
114 if (effect.tagName() == "effectgroup") {
115 QString groupName = effect.attribute("name");
116 info << groupName << groupName << effect.attribute("id") << QString::number(Kdenlive::groupEffect);
119 QDomElement namenode = effect.firstChildElement("name");
120 info << i18n(namenode.text().toUtf8().data()) << effect.attribute("tag") << effect.attribute("id");
125 QStringList EffectsList::effectNames()
128 QDomNodeList effects = m_baseElement.childNodes();
129 for (int i = 0; i < effects.count(); ++i) {
130 QDomElement effect = effects.at(i).toElement();
131 QDomElement namenode = effect.firstChildElement("name");
132 if (!namenode.isNull()) list.append(i18n(namenode.text().toUtf8().data()));
137 QString EffectsList::getInfo(const QString & tag, const QString & id) const
140 return getEffectInfo(getEffectByTag(tag, id));
143 QString EffectsList::getInfoFromIndex(const int ix) const
146 return getEffectInfo(m_baseElement.childNodes().at(ix).toElement());
149 QString EffectsList::getEffectInfo(const QDomElement effect) const
152 QDomElement namenode = effect.firstChildElement("description");
153 if (!namenode.isNull())
154 info = i18n(namenode.firstChild().nodeValue().simplified().toUtf8().data());
156 namenode = effect.firstChildElement("author");
157 if (!namenode.isNull())
158 info.append("<br /><strong>" + i18n("Author:") + " </strong>" + i18n(namenode.text().toUtf8().data()));
160 namenode = effect.firstChildElement("version");
161 if (!namenode.isNull())
162 info.append(QString(" (%1)").arg(namenode.text()));
168 bool EffectsList::hasKeyFrames(const QDomElement &effect)
170 QDomNodeList params = effect.elementsByTagName("parameter");
171 for (int i = 0; i < params.count(); ++i) {
172 QDomElement e = params.item(i).toElement();
173 if (e.attribute("type") == "keyframe") return true;
179 bool EffectsList::hasSimpleKeyFrames(const QDomElement &effect)
181 QDomNodeList params = effect.elementsByTagName("parameter");
182 for (int i = 0; i < params.count(); ++i) {
183 QDomElement e = params.item(i).toElement();
184 if (e.attribute("type") == "simplekeyframe") return true;
190 bool EffectsList::hasGeometryKeyFrames(const QDomElement &effect)
192 QDomNodeList params = effect.elementsByTagName("parameter");
193 for (int i = 0; i < params.count(); ++i) {
194 QDomElement param = params.item(i).toElement();
195 if (param.attribute("type") == "geometry" && !param.hasAttribute("fixed"))
201 void EffectsList::clone(const EffectsList &original)
203 setContent(original.toString());
204 m_baseElement = documentElement();
207 void EffectsList::clearList()
209 while (!m_baseElement.firstChild().isNull())
210 m_baseElement.removeChild(m_baseElement.firstChild());
214 void EffectsList::setParameter(QDomElement effect, const QString &name, const QString &value)
216 QDomNodeList params = effect.elementsByTagName("parameter");
218 for (int i = 0; i < params.count(); ++i) {
219 QDomElement e = params.item(i).toElement();
220 if (e.attribute("name") == name) {
221 e.setAttribute("value", value);
228 QDomDocument doc = effect.ownerDocument();
229 QDomElement e = doc.createElement("parameter");
230 e.setAttribute("name", name);
231 QDomText val = doc.createTextNode(value);
233 effect.appendChild(e);
238 QString EffectsList::parameter(const QDomElement &effect, const QString &name)
240 QDomNodeList params = effect.elementsByTagName("parameter");
241 for (int i = 0; i < params.count(); ++i) {
242 QDomElement e = params.item(i).toElement();
243 if (e.attribute("name") == name) {
244 return e.attribute("value");
251 void EffectsList::setProperty(QDomElement effect, const QString &name, const QString &value)
253 QDomNodeList params = effect.elementsByTagName("property");
254 // Update property if it already exists
256 for (int i = 0; i < params.count(); ++i) {
257 QDomElement e = params.item(i).toElement();
258 if (e.attribute("name") == name) {
259 e.firstChild().setNodeValue(value);
266 QDomDocument doc = effect.ownerDocument();
267 QDomElement e = doc.createElement("property");
268 e.setAttribute("name", name);
269 QDomText val = doc.createTextNode(value);
271 effect.appendChild(e);
276 void EffectsList::renameProperty(QDomElement effect, const QString &oldName, const QString &newName)
278 QDomNodeList params = effect.elementsByTagName("property");
279 // Update property if it already exists
280 for (int i = 0; i < params.count(); ++i) {
281 QDomElement e = params.item(i).toElement();
282 if (e.attribute("name") == oldName) {
283 e.setAttribute("name", newName);
290 QString EffectsList::property(QDomElement effect, const QString &name)
292 QDomNodeList params = effect.elementsByTagName("property");
293 for (int i = 0; i < params.count(); ++i) {
294 QDomElement e = params.item(i).toElement();
295 if (e.attribute("name") == name) {
296 return e.firstChild().nodeValue();
303 void EffectsList::removeProperty(QDomElement effect, const QString &name)
305 QDomNodeList params = effect.elementsByTagName("property");
306 for (int i = 0; i < params.count(); ++i) {
307 QDomElement e = params.item(i).toElement();
308 if (e.attribute("name") == name) {
309 effect.removeChild(params.item(i));
316 void EffectsList::removeMetaProperties(QDomElement producer)
318 QDomNodeList params = producer.elementsByTagName("property");
319 for (int i = 0; i < params.count(); ++i) {
320 QDomElement e = params.item(i).toElement();
321 if (e.attribute("name").startsWith("meta")) {
322 producer.removeChild(params.item(i));
328 QDomElement EffectsList::append(QDomElement e)
332 result = m_baseElement.appendChild(importNode(e, true)).toElement();
334 updateIndexes(m_baseElement.childNodes(), m_baseElement.childNodes().count() - 1);
340 int EffectsList::count() const
342 return m_baseElement.childNodes().count();
345 bool EffectsList::isEmpty() const
347 return !m_baseElement.hasChildNodes();
350 const QDomElement EffectsList::at(int ix) const
352 QDomNodeList effects = m_baseElement.childNodes();
353 if (ix < 0 || ix >= effects.count()) return QDomElement();
354 return effects.at(ix).toElement();
357 void EffectsList::removeAt(int ix)
359 QDomNodeList effects = m_baseElement.childNodes();
360 if (ix <= 0 || ix > effects.count()) return;
361 m_baseElement.removeChild(effects.at(ix - 1));
362 if (m_useIndex) updateIndexes(effects, ix - 1);
365 QDomElement EffectsList::itemFromIndex(int ix) const
367 QDomNodeList effects = m_baseElement.childNodes();
368 if (ix <= 0 || ix > effects.count()) return QDomElement();
369 return effects.at(ix - 1).toElement();
372 QDomElement EffectsList::insert(QDomElement effect)
374 QDomNodeList effects = m_baseElement.childNodes();
375 int ix = effect.attribute("kdenlive_ix").toInt();
377 if (ix <= 0 || ix > effects.count()) {
378 ix = effects.count();
379 result = m_baseElement.appendChild(importNode(effect, true)).toElement();
382 QDomElement listeffect = effects.at(ix - 1).toElement();
383 result = m_baseElement.insertBefore(importNode(effect, true), listeffect).toElement();
385 if (m_useIndex && ix > 0)
386 updateIndexes(effects, ix - 1);
390 void EffectsList::updateIndexes(QDomNodeList effects, int startIndex)
392 for (int i = startIndex; i < effects.count(); ++i) {
393 QDomElement listeffect = effects.at(i).toElement();
394 listeffect.setAttribute(QLatin1String("kdenlive_ix"), i + 1);
398 void EffectsList::enableEffects(const QList <int>& indexes, bool disable)
400 QDomNodeList effects = m_baseElement.childNodes();
402 for (int i = 0; i < indexes.count(); ++i) {
403 effect = effectFromIndex(effects, indexes.at(i));
404 effect.setAttribute("disable", (int) disable);
408 QDomElement EffectsList::effectFromIndex(const QDomNodeList &effects, int ix)
410 if (ix <= 0 || ix > effects.count()) return QDomElement();
411 return effects.at(ix - 1).toElement();
414 void EffectsList::updateEffect(const QDomElement &effect)
416 QDomNodeList effects = m_baseElement.childNodes();
417 int ix = effect.attribute("kdenlive_ix").toInt();
418 QDomElement current = effectFromIndex(effects, ix);
419 if (!current.isNull()) {
420 m_baseElement.insertBefore(importNode(effect, true), current);
421 m_baseElement.removeChild(current);
423 else m_baseElement.appendChild(importNode(effect, true));