git.sesse.net Git - kdenlive/blob - src/effectslist.cpp

   1 /***************************************************************************
   2                           effectslist.cpp  -  description
   3                              -------------------
   4     begin                : Sat Aug 10 2002
   5     copyright            : (C) 2002 by Jason Wood
   6     email                : jasonwood@blueyonder.co.uk
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  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.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18
  19 #include "effectslist.h"
  20
  21 #include <KDebug>
  22 #include <KLocale>
  23
  24
  25 EffectsList::EffectsList(bool indexRequired) : m_useIndex(indexRequired)
  26 {
  27     m_baseElement = createElement("list");
  28     appendChild(m_baseElement);
  29 }
  30
  31 EffectsList::~EffectsList()
  32 {
  33 }
  34
  35 QDomElement EffectsList::getEffectByName(const QString & name) const
  36 {
  37     QString effectName;
  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"));
  49             }
  50             return effect;
  51         }
  52     }
  53
  54     return QDomElement();
  55 }
  56
  57 QDomElement EffectsList::getEffectByTag(const QString & tag, const QString & id) const
  58 {
  59     QDomNodeList effects = m_baseElement.childNodes();
  60     for (int i = 0; i < effects.count(); i++) {
  61         QDomElement effect =  effects.at(i).toElement();
  62         if (!id.isEmpty()) {
  63             if (effect.attribute("id") == id) {
  64                 QDomNodeList params = effect.elementsByTagName("parameter");
  65                 for (int i = 0; i < params.count(); i++) {
  66                     QDomElement e = params.item(i).toElement();
  67                     if (!e.hasAttribute("value"))
  68                         e.setAttribute("value", e.attribute("default"));
  69                 }
  70                 return effect;
  71             }
  72         } else if (!tag.isEmpty()) {
  73             if (effect.attribute("tag") == tag) {
  74                 QDomNodeList params = effect.elementsByTagName("parameter");
  75                 for (int i = 0; i < params.count(); i++) {
  76                     QDomElement e = params.item(i).toElement();
  77                     if (!e.hasAttribute("value"))
  78                         e.setAttribute("value", e.attribute("default"));
  79                 }
  80                 return effect;
  81             }
  82         }
  83     }
  84     return QDomElement();
  85 }
  86
  87 int EffectsList::hasEffect(const QString & tag, const QString & id) const
  88 {
  89     QDomNodeList effects = m_baseElement.childNodes();
  90     for (int i = 0; i < effects.count(); i++) {
  91         QDomElement effect =  effects.at(i).toElement();
  92         if (!id.isEmpty()) {
  93             if (effect.attribute("id") == id) return effect.attribute("kdenlive_ix").toInt();
  94         } else if (!tag.isEmpty() && effect.attribute("tag") == tag) return effect.attribute("kdenlive_ix").toInt();
  95     }
  96     return -1;
  97 }
  98
  99 QStringList EffectsList::effectIdInfo(const int ix) const
 100 {
 101     QStringList info;
 102     QDomElement effect = m_baseElement.childNodes().at(ix).toElement();
 103     if (effect.tagName() == "effectgroup") {
 104         QString groupName = effect.attribute("name");
 105         info << groupName << groupName << groupName << QString::number(Kdenlive::groupEffect);
 106     }
 107     else {
 108         QDomElement namenode = effect.firstChildElement("name");
 109         info << i18n(namenode.text().toUtf8().data()) << effect.attribute("tag") << effect.attribute("id");
 110     }
 111     return info;
 112 }
 113
 114 QStringList EffectsList::effectNames()
 115 {
 116     QStringList list;
 117     QDomNodeList effects = m_baseElement.childNodes();
 118     for (int i = 0; i < effects.count(); i++) {
 119         QDomElement effect =  effects.at(i).toElement();
 120         QDomElement namenode = effect.firstChildElement("name");
 121         if (!namenode.isNull()) list.append(i18n(namenode.text().toUtf8().data()));
 122     }
 123     return list;
 124 }
 125
 126 QString EffectsList::getInfo(const QString & tag, const QString & id) const
 127 {
 128     QString info;
 129     return getEffectInfo(getEffectByTag(tag, id));
 130 }
 131
 132 QString EffectsList::getInfoFromIndex(const int ix) const
 133 {
 134     QString info;
 135     return getEffectInfo(m_baseElement.childNodes().at(ix).toElement());
 136 }
 137
 138 QString EffectsList::getEffectInfo(const QDomElement effect) const
 139 {
 140     QString info;
 141     QDomElement namenode = effect.firstChildElement("description");
 142     if (!namenode.isNull())
 143         info = i18n(namenode.firstChild().nodeValue().simplified().toUtf8().data());
 144
 145     namenode = effect.firstChildElement("author");
 146     if (!namenode.isNull())
 147         info.append("<br /><strong>" + i18n("Author:") + " </strong>" + i18n(namenode.text().toUtf8().data()));
 148
 149     namenode = effect.firstChildElement("version");
 150     if (!namenode.isNull())
 151         info.append(QString(" (%1)").arg(namenode.text()));
 152
 153     return info;
 154 }
 155
 156 // static
 157 bool EffectsList::hasKeyFrames(QDomElement effect)
 158 {
 159     QDomNodeList params = effect.elementsByTagName("parameter");
 160     for (int i = 0; i < params.count(); i++) {
 161         QDomElement e = params.item(i).toElement();
 162         if (e.attribute("type") == "keyframe") return true;
 163     }
 164     return false;
 165 }
 166
 167 // static
 168 bool EffectsList::hasSimpleKeyFrames(QDomElement effect)
 169 {
 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") == "simplekeyframe") return true;
 174     }
 175     return false;
 176 }
 177
 178 // static
 179 bool EffectsList::hasGeometryKeyFrames(QDomElement effect)
 180 {
 181     QDomNodeList params = effect.elementsByTagName("parameter");
 182     for (int i = 0; i < params.count(); ++i) {
 183         QDomElement param = params.item(i).toElement();
 184         if (param.attribute("type") == "geometry" && !param.hasAttribute("fixed"))
 185             return true;
 186     }
 187     return false;
 188 }
 189
 190 void EffectsList::clone(const EffectsList &original)
 191 {
 192     setContent(original.toString());
 193     m_baseElement = documentElement();
 194 }
 195
 196 void EffectsList::clearList()
 197 {
 198     while (!m_baseElement.firstChild().isNull())
 199         m_baseElement.removeChild(m_baseElement.firstChild());
 200 }
 201
 202 // static
 203 void EffectsList::setParameter(QDomElement effect, const QString &name, const QString &value)
 204 {
 205     QDomNodeList params = effect.elementsByTagName("parameter");
 206     for (int i = 0; i < params.count(); i++) {
 207         QDomElement e = params.item(i).toElement();
 208         if (e.attribute("name") == name) {
 209             e.setAttribute("value", value);
 210             break;
 211         }
 212     }
 213 }
 214
 215 // static
 216 QString EffectsList::parameter(QDomElement effect, const QString &name)
 217 {
 218     QDomNodeList params = effect.elementsByTagName("parameter");
 219     for (int i = 0; i < params.count(); i++) {
 220         QDomElement e = params.item(i).toElement();
 221         if (e.attribute("name") == name) {
 222             return e.attribute("value");
 223         }
 224     }
 225     return QString();
 226 }
 227
 228 // static
 229 void EffectsList::setProperty(QDomElement effect, const QString &name, const QString &value)
 230 {
 231     QDomNodeList params = effect.elementsByTagName("property");
 232     // Update property if it already exists
 233     bool found = false;
 234     for (int i = 0; i < params.count(); i++) {
 235         QDomElement e = params.item(i).toElement();
 236         if (e.attribute("name") == name) {
 237             e.firstChild().setNodeValue(value);
 238             found = true;
 239             break;
 240         }
 241     }
 242     if (!found) {
 243         // create property
 244         QDomDocument doc = effect.ownerDocument();
 245         QDomElement e = doc.createElement("property");
 246         e.setAttribute("name", name);
 247         QDomText val = doc.createTextNode(value);
 248         e.appendChild(val);
 249         effect.appendChild(e);
 250     }
 251 }
 252
 253 // static
 254 void EffectsList::renameProperty(QDomElement effect, const QString &oldName, const QString &newName)
 255 {
 256     QDomNodeList params = effect.elementsByTagName("property");
 257     // Update property if it already exists
 258     for (int i = 0; i < params.count(); i++) {
 259         QDomElement e = params.item(i).toElement();
 260         if (e.attribute("name") == oldName) {
 261             e.setAttribute("name", newName);
 262             break;
 263         }
 264     }
 265 }
 266
 267 // static
 268 QString EffectsList::property(QDomElement effect, const QString &name)
 269 {
 270     QDomNodeList params = effect.elementsByTagName("property");
 271     for (int i = 0; i < params.count(); i++) {
 272         QDomElement e = params.item(i).toElement();
 273         if (e.attribute("name") == name) {
 274             return e.firstChild().nodeValue();
 275         }
 276     }
 277     return QString();
 278 }
 279
 280 // static
 281 void EffectsList::removeProperty(QDomElement effect, const QString &name)
 282 {
 283     QDomNodeList params = effect.elementsByTagName("property");
 284     for (int i = 0; i < params.count(); i++) {
 285         QDomElement e = params.item(i).toElement();
 286         if (e.attribute("name") == name) {
 287             effect.removeChild(params.item(i));
 288             break;
 289         }
 290     }
 291 }
 292
 293 // static
 294 void EffectsList::removeMetaProperties(QDomElement producer)
 295 {
 296     QDomNodeList params = producer.elementsByTagName("property");
 297     for (int i = 0; i < params.count(); i++) {
 298         QDomElement e = params.item(i).toElement();
 299         if (e.attribute("name").startsWith("meta")) {
 300             producer.removeChild(params.item(i));
 301             i--;
 302         }
 303     }
 304 }
 305
 306 QDomElement EffectsList::append(QDomElement e)
 307 {
 308     QDomElement result;
 309     if (!e.isNull()) {
 310         result = m_baseElement.appendChild(importNode(e, true)).toElement();
 311         if (m_useIndex) {
 312             updateIndexes(m_baseElement.childNodes(), m_baseElement.childNodes().count() - 1);
 313         }
 314     }
 315     return result;
 316 }
 317
 318 int EffectsList::count() const
 319 {
 320     return m_baseElement.childNodes().count();
 321 }
 322
 323 bool EffectsList::isEmpty() const
 324 {
 325     return !m_baseElement.hasChildNodes();
 326 }
 327
 328 const QDomElement EffectsList::at(int ix) const
 329 {
 330     QDomNodeList effects = m_baseElement.childNodes();
 331     if (ix < 0 || ix >= effects.count()) return QDomElement();
 332     return effects.at(ix).toElement();
 333 }
 334
 335 void EffectsList::removeAt(int ix)
 336 {
 337     QDomNodeList effects = m_baseElement.childNodes();
 338     if (ix <= 0 || ix > effects.count()) return;
 339     m_baseElement.removeChild(effects.at(ix - 1));
 340     if (m_useIndex) updateIndexes(effects, ix - 1);
 341 }
 342
 343 QDomElement EffectsList::itemFromIndex(int ix) const
 344 {
 345     QDomNodeList effects = m_baseElement.childNodes();
 346     if (ix <= 0 || ix > effects.count()) return QDomElement();
 347     return effects.at(ix - 1).toElement();
 348 }
 349
 350 QDomElement EffectsList::insert(QDomElement effect)
 351 {
 352     QDomNodeList effects = m_baseElement.childNodes();
 353     int ix = effect.attribute("kdenlive_ix").toInt();
 354     QDomElement result;
 355     if (ix <= 0 || ix > effects.count()) {
 356         ix = effects.count();
 357         result = m_baseElement.appendChild(importNode(effect, true)).toElement();
 358     }
 359     else {
 360         QDomElement listeffect =  effects.at(ix - 1).toElement();
 361         result = m_baseElement.insertBefore(importNode(effect, true), listeffect).toElement();
 362     }
 363     if (m_useIndex && ix > 0)
 364         updateIndexes(effects, ix - 1);
 365     return result;
 366 }
 367
 368 void EffectsList::updateIndexes(QDomNodeList effects, int startIndex)
 369 {
 370     for (int i = startIndex; i < effects.count(); i++) {
 371         QDomElement listeffect =  effects.at(i).toElement();
 372         listeffect.setAttribute("kdenlive_ix", i + 1);
 373     }
 374 }
 375
 376 QDomElement EffectsList::effectFromIndex(QDomNodeList effects, int ix)
 377 {
 378     if (ix <= 0 || ix > effects.count()) return QDomElement();
 379     return effects.at(ix - 1).toElement();
 380 }
 381
 382 void EffectsList::updateEffect(QDomElement effect)
 383 {
 384     QDomNodeList effects = m_baseElement.childNodes();
 385     int ix = effect.attribute("kdenlive_ix").toInt();
 386     QDomElement current = effectFromIndex(effects, ix);
 387     if (!current.isNull()) {
 388         m_baseElement.insertBefore(importNode(effect, true), current);
 389         m_baseElement.removeChild(current);
 390     }
 391     else m_baseElement.appendChild(importNode(effect, true));
 392 }