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

   1 /***************************************************************************
   2                           initeffects.cpp  -  description
   3                              -------------------
   4     begin                :  Jul 2006
   5     copyright            : (C) 2006 by Jean-Baptiste Mardelle
   6     email                : jb@ader.ch
   7     copyright            : (C) 2008 Marco Gittler
   8     email                : g.marco@freenet.de
   9  ***************************************************************************/
  10
  11 /***************************************************************************
  12  *                                                                         *
  13  *   This program is free software; you can redistribute it and/or modify  *
  14  *   it under the terms of the GNU General Public License as published by  *
  15  *   the Free Software Foundation; either version 2 of the License, or     *
  16  *   (at your option) any later version.                                   *
  17  *                                                                         *
  18  ***************************************************************************/
  19
  20 #include "initeffects.h"
  21 #include "kdenlivesettings.h"
  22 #include "effectslist.h"
  23 #include "mainwindow.h"
  24
  25 #include <KDebug>
  26 #include <kglobal.h>
  27 #include <KStandardDirs>
  28
  29 #include <QFile>
  30 #include <qregexp.h>
  31 #include <QDir>
  32 #include <QIcon>
  33
  34 #include "locale.h"
  35
  36 initEffectsThumbnailer::initEffectsThumbnailer() :
  37     QThread()
  38 {
  39 }
  40
  41 void initEffectsThumbnailer::prepareThumbnailsCall(const QStringList& list)
  42 {
  43     m_list = list;
  44     start();
  45     kDebug() << "done";
  46 }
  47
  48 void initEffectsThumbnailer::run()
  49 {
  50     foreach(const QString & entry, m_list) {
  51         kDebug() << entry;
  52         if (!entry.isEmpty() && (entry.endsWith(".png") || entry.endsWith(".pgm"))) {
  53             if (!MainWindow::m_lumacache.contains(entry)) {
  54                 QImage pix(entry);
  55                 //if (!pix.isNull())
  56                 MainWindow::m_lumacache.insert(entry, pix.scaled(30, 30, Qt::KeepAspectRatio, Qt::SmoothTransformation));
  57                 kDebug() << "stored";
  58             }
  59         }
  60     }
  61 }
  62
  63 initEffectsThumbnailer initEffects::thumbnailer;
  64
  65 // static
  66 void initEffects::refreshLumas()
  67 {
  68     // Check for Kdenlive installed luma files, add empty string at start for no luma
  69     QStringList imagenamelist = QStringList() << i18n("None");
  70     QStringList imagefiles = QStringList() << QString();
  71     QStringList filters;
  72     filters << "*.pgm" << "*.png";
  73
  74     QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
  75     foreach(const QString & folder, customLumas) {
  76         QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
  77         foreach(const QString & fname, filesnames) {
  78             imagenamelist.append(fname);
  79             imagefiles.append(KUrl(folder).path(KUrl::AddTrailingSlash) + fname);
  80         }
  81     }
  82
  83     // Check for MLT lumas
  84     KUrl folder(mlt_environment("MLT_DATA"));
  85     folder.addPath("lumas");
  86     folder.addPath(mlt_environment("MLT_NORMALISATION"));
  87     QDir lumafolder(folder.path());
  88     QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
  89     foreach(const QString & fname, filesnames) {
  90         imagenamelist.append(fname);
  91         KUrl path(folder);
  92         path.addPath(fname);
  93         imagefiles.append(path.toLocalFile());
  94     }
  95     QDomElement lumaTransition = MainWindow::transitions.getEffectByTag("luma", "luma");
  96     QDomNodeList params = lumaTransition.elementsByTagName("parameter");
  97     for (int i = 0; i < params.count(); i++) {
  98         QDomElement e = params.item(i).toElement();
  99         if (e.attribute("tag") == "resource") {
 100             e.setAttribute("paramlistdisplay", imagenamelist.join(","));
 101             e.setAttribute("paramlist", imagefiles.join(";"));
 102             break;
 103         }
 104     }
 105
 106     QDomElement compositeTransition = MainWindow::transitions.getEffectByTag("composite", "composite");
 107     params = compositeTransition.elementsByTagName("parameter");
 108     for (int i = 0; i < params.count(); i++) {
 109         QDomElement e = params.item(i).toElement();
 110         if (e.attribute("tag") == "luma") {
 111             e.setAttribute("paramlistdisplay", imagenamelist.join(","));
 112             e.setAttribute("paramlist", imagefiles.join(";"));
 113             break;
 114         }
 115     }
 116 }
 117
 118 // static
 119 QDomDocument initEffects::getUsedCustomEffects(QMap <QString, QString> effectids)
 120 {
 121     QMapIterator<QString, QString> i(effectids);
 122     int ix;
 123     QDomDocument doc;
 124     QDomElement list = doc.createElement("customeffects");
 125     doc.appendChild(list);
 126     while (i.hasNext()) {
 127         i.next();
 128         ix = MainWindow::customEffects.hasEffect(i.value(), i.key());
 129         if (ix > -1) {
 130             QDomElement e = MainWindow::customEffects.at(ix);
 131             list.appendChild(doc.importNode(e, true));
 132         }
 133     }
 134     return doc;
 135 }
 136
 137 //static
 138 void initEffects::parseEffectFiles(const QString &locale)
 139 {
 140     QStringList::Iterator more;
 141     QStringList::Iterator it;
 142     QStringList fileList;
 143     QString itemName;
 144
 145     Mlt::Repository *repository = Mlt::Factory::init();
 146     if (!repository) {
 147         kDebug() << "Repository didn't finish initialisation" ;
 148         return;
 149     }
 150
 151     // Warning: Mlt::Factory::init() resets the locale to the default system value, make sure we keep correct locale
 152     if (!locale.isEmpty()) setlocale(LC_NUMERIC, locale.toUtf8().constData());
 153
 154     // Retrieve the list of MLT's available effects.
 155     Mlt::Properties *filters = repository->filters();
 156     QStringList filtersList;
 157     int max = filters->count();
 158     for (int i = 0; i < max; ++i)
 159         filtersList << filters->get_name(i);
 160     delete filters;
 161
 162     // Retrieve the list of available producers.
 163     Mlt::Properties *producers = repository->producers();
 164     QStringList producersList;
 165     max = producers->count();
 166     for (int i = 0; i < max; ++i)
 167         producersList << producers->get_name(i);
 168     KdenliveSettings::setProducerslist(producersList);
 169     delete producers;
 170
 171     // Retrieve the list of available transitions.
 172     Mlt::Properties *transitions = repository->transitions();
 173     QStringList transitionsItemList;
 174     max = transitions->count();
 175     for (int i = 0; i < max; ++i)
 176         transitionsItemList << transitions->get_name(i);
 177     delete transitions;
 178
 179     // Remove blacklisted transitions from the list.
 180     QFile file(KStandardDirs::locate("appdata", "blacklisted_transitions.txt"));
 181     if (file.open(QIODevice::ReadOnly)) {
 182         QTextStream in(&file);
 183         while (!in.atEnd()) {
 184             QString black = in.readLine().simplified();
 185             if (!black.isEmpty() && !black.startsWith('#') &&
 186                     transitionsItemList.contains(black))
 187                 transitionsItemList.removeAll(black);
 188         }
 189         file.close();
 190     }
 191
 192     // Fill transitions list.
 193     fillTransitionsList(repository, &MainWindow::transitions, transitionsItemList);
 194
 195     // Remove blacklisted effects from the filters list.
 196     QStringList mltFiltersList = filtersList;
 197     QFile file2(KStandardDirs::locate("appdata", "blacklisted_effects.txt"));
 198     if (file2.open(QIODevice::ReadOnly)) {
 199         QTextStream in(&file2);
 200         while (!in.atEnd()) {
 201             QString black = in.readLine().simplified();
 202             if (!black.isEmpty() && !black.startsWith('#') &&
 203                     mltFiltersList.contains(black))
 204                 mltFiltersList.removeAll(black);
 205         }
 206         file2.close();
 207     }
 208
 209     /*
 210      * Cleanup the global lists. We use QMap because of its automatic sorting
 211      * (by key) and key uniqueness (using insert() instead of insertMulti()).
 212      * This introduces some more cycles (while removing them from other parts of
 213      * the code and centralising them), but due to the way this methods, QMap
 214      * and EffectsList are implemented, there's no easy way to make it
 215      * differently without reinplementing something (which should really be
 216      * done).
 217      */
 218     QDomElement effectInfo;
 219     QMap<QString, QDomElement> effectsMap;
 220     QMap<QString, QDomElement> videoEffectsMap;
 221     QMap<QString, QDomElement> audioEffectsMap;
 222
 223     // Create transitions
 224     max = MainWindow::transitions.count();
 225     for (int i = 0; i < max; ++i) {
 226         effectInfo = MainWindow::transitions.at(i);
 227         effectsMap.insert(effectInfo.firstChildElement("name").text().toLower().toUtf8().data(), effectInfo);
 228     }
 229     MainWindow::transitions.clearList();
 230     foreach(const QDomElement & effect, effectsMap)
 231         MainWindow::transitions.append(effect);
 232     effectsMap.clear();
 233
 234     // Create effects from MLT
 235     foreach(const QString & filtername, mltFiltersList) {
 236         QDomDocument doc = createDescriptionFromMlt(repository, "filters", filtername);
 237         //WARNING: TEMPORARY FIX for empty MLT effects descriptions - disable effects without parameters - jbm 09-06-2011
 238         if (!doc.isNull() && doc.elementsByTagName("parameter").count() > 0) {
 239             if (doc.documentElement().attribute("type") == "audio") {
 240                 if (doc.elementsByTagName("description").count() > 0) {
 241                     QString desc = doc.documentElement().firstChildElement("description").text();
 242                     //WARNING: TEMPORARY FIX for unusable MLT SOX parameters description
 243                     if (desc.startsWith("Process audio using a SoX")) {
 244                         // Remove MLT's SOX generated effects since the parameters properties are unusable for us
 245                     }
 246                     else audioEffectsMap.insert(doc.documentElement().firstChildElement("name").text().toLower().toUtf8().data(), doc.documentElement());
 247                 }
 248             }
 249             else
 250                 videoEffectsMap.insert(doc.documentElement().firstChildElement("name").text().toLower().toUtf8().data(), doc.documentElement());
 251         }
 252     }
 253
 254     // Set the directories to look into for effects.
 255     QStringList direc = KGlobal::dirs()->findDirs("appdata", "effects");
 256     // Iterate through effects directories to parse all XML files.
 257     for (more = direc.begin(); more != direc.end(); ++more) {
 258         QDir directory(*more);
 259         QStringList filter;
 260         filter << "*.xml";
 261         fileList = directory.entryList(filter, QDir::Files);
 262         for (it = fileList.begin(); it != fileList.end(); ++it) {
 263             itemName = KUrl(*more + *it).path();
 264             parseEffectFile(&MainWindow::customEffects,
 265                             &MainWindow::audioEffects,
 266                             &MainWindow::videoEffects,
 267                             itemName, filtersList, producersList, repository);
 268         }
 269     }
 270
 271     // Create custom effects
 272     max = MainWindow::customEffects.count();
 273     for (int i = 0; i < max; ++i) {
 274         effectInfo = MainWindow::customEffects.at(i);
 275         if (effectInfo.tagName() == "effectgroup") {
 276             effectsMap.insert(effectInfo.attribute("name").toUtf8().data(), effectInfo);
 277         }
 278         else effectsMap.insert(effectInfo.firstChildElement("name").text().toUtf8().data(), effectInfo);
 279     }
 280     MainWindow::customEffects.clearList();
 281     foreach(const QDomElement & effect, effectsMap)
 282         MainWindow::customEffects.append(effect);
 283     effectsMap.clear();
 284
 285     // Create audio effects
 286     max = MainWindow::audioEffects.count();
 287     for (int i = 0; i < max; ++i) {
 288         effectInfo = MainWindow::audioEffects.at(i);
 289         audioEffectsMap.insert(effectInfo.firstChildElement("name").text().toLower().toUtf8().data(), effectInfo);
 290     }
 291     MainWindow::audioEffects.clearList();
 292     foreach(const QDomElement & effect, audioEffectsMap)
 293         MainWindow::audioEffects.append(effect);
 294
 295     // Create video effects
 296     max = MainWindow::videoEffects.count();
 297     for (int i = 0; i < max; ++i) {
 298         effectInfo = MainWindow::videoEffects.at(i);
 299         videoEffectsMap.insert(effectInfo.firstChildElement("name").text().toLower().toUtf8().data(), effectInfo);
 300     }
 301     MainWindow::videoEffects.clearList();
 302     foreach(const QDomElement & effect, videoEffectsMap)
 303         MainWindow::videoEffects.append(effect);
 304 }
 305
 306 // static
 307 void initEffects::parseCustomEffectsFile()
 308 {
 309     MainWindow::customEffects.clearList();
 310     /*
 311      * Why a QMap? See parseEffectFiles(). It's probably useless here, but we
 312      * cannot be sure about it.
 313      */
 314     QMap<QString, QDomElement> effectsMap;
 315     QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
 316     QDir directory = QDir(path);
 317     QStringList filter;
 318     filter << "*.xml";
 319     const QStringList fileList = directory.entryList(filter, QDir::Files);
 320     /*
 321      * We need to declare these variables outside the foreach, or the QMap will
 322      * refer to non existing variables (QMap::insert() takes references as
 323      * parameters).
 324      */
 325     QDomDocument doc;
 326     QDomNodeList effects;
 327     QDomElement e;
 328     int unknownGroupCount = 0;
 329     foreach(const QString & filename, fileList) {
 330         QString itemName = KUrl(path + filename).path();
 331         QFile file(itemName);
 332         doc.setContent(&file, false);
 333         file.close();
 334         QDomElement base = doc.documentElement();
 335         if (base.tagName() == "effectgroup") {
 336             QString groupName = base.attribute("name");
 337             if (groupName.isEmpty()) {
 338                 groupName = i18n("Group %1", unknownGroupCount);
 339                 base.setAttribute("name", groupName);
 340                 unknownGroupCount++;
 341             }
 342             effectsMap.insert(groupName.toLower().toUtf8().data(), base);
 343         } else if (base.tagName() == "effect") {
 344             effectsMap.insert(base.firstChildElement("name").text().toLower().toUtf8().data(), base);
 345         }
 346         else kDebug() << "Unsupported effect file: " << itemName;
 347     }
 348     foreach(const QDomElement & effect, effectsMap)
 349         MainWindow::customEffects.append(effect);
 350 }
 351
 352 // static
 353 void initEffects::parseEffectFile(EffectsList *customEffectList, EffectsList *audioEffectList, EffectsList *videoEffectList, QString name, QStringList filtersList, QStringList producersList, Mlt::Repository *repository)
 354 {
 355     QDomDocument doc;
 356     QFile file(name);
 357     doc.setContent(&file, false);
 358     file.close();
 359     QDomElement documentElement;
 360     QDomNodeList effects;
 361     QDomElement base = doc.documentElement();
 362     effects = doc.elementsByTagName("effect");
 363
 364     if (effects.count() == 0) {
 365         kDebug() << "Effect broken: " << name;
 366         return;
 367     }
 368
 369     bool needsLocaleConversion = false;
 370     for (int i = 0; !effects.item(i).isNull(); ++i) {
 371         QLocale locale;
 372         documentElement = effects.item(i).toElement();
 373         QString tag = documentElement.attribute("tag", QString());
 374         if (documentElement.hasAttribute("LC_NUMERIC")) {
 375             // set a locale for that file
 376             locale = QLocale(documentElement.attribute("LC_NUMERIC"));
 377             if (locale.decimalPoint() != QLocale().decimalPoint()) {
 378                 needsLocaleConversion = true;
 379             }
 380         }
 381         locale.setNumberOptions(QLocale::OmitGroupSeparator);
 382
 383         if (needsLocaleConversion) {
 384             // we need to convert all numbers to the system's locale (for example 0.5 -> 0,5)
 385             QChar separator = QLocale().decimalPoint();
 386             QChar oldSeparator = locale.decimalPoint();
 387             QDomNodeList params = documentElement.elementsByTagName("parameter");
 388             for (int j = 0; j < params.count(); j++) {
 389                 QDomNamedNodeMap attrs = params.at(j).attributes();
 390                 for (int k = 0; k < attrs.count(); k++) {
 391                     QString name = attrs.item(k).nodeName();
 392                     if (name != "type" && name != "name") {
 393                             QString val = attrs.item(k).nodeValue();
 394                             if (val.contains(oldSeparator)) {
 395                                 QString newVal = val.replace(oldSeparator, separator);
 396                                 attrs.item(k).setNodeValue(newVal);
 397                             }
 398                     }
 399                 }
 400             }
 401         }
 402
 403         double version = -1;
 404         Mlt::Properties *metadata = repository->metadata(filter_type, tag.toUtf8().data());
 405         if (metadata && metadata->is_valid()) {
 406             version = metadata->get_double("version");
 407         }
 408         if (metadata) delete metadata;
 409         if (documentElement.hasAttribute("version")) {
 410             // a specific version of the filter is required
 411             if (locale.toDouble(documentElement.attribute("version")) > version) {
 412                 return;
 413             }
 414         }
 415         if (version > -1) {
 416             // Add version info to XML
 417             QDomNode versionNode = doc.createElement("version");
 418             versionNode.appendChild(doc.createTextNode(QLocale().toString(version)));
 419             documentElement.appendChild(versionNode);
 420         }
 421
 422         // Parse effect information.
 423         if (base.tagName() != "effectgroup" && (filtersList.contains(tag) || producersList.contains(tag))) {
 424             QString type = documentElement.attribute("type", QString());
 425             if (type == "audio")
 426                 audioEffectList->append(documentElement);
 427             else if (type == "custom")
 428                 customEffectList->append(documentElement);
 429             else
 430                 videoEffectList->append(documentElement);
 431         }
 432     }
 433     if (base.tagName() == "effectgroup") {
 434         QString type = base.attribute("type", QString());
 435         if (type == "audio")
 436             audioEffectList->append(base);
 437         else if (type == "custom")
 438             customEffectList->append(base);
 439         else
 440             videoEffectList->append(base);
 441     }
 442 }
 443
 444 QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository, const QString& /*type*/, const QString& filtername)
 445 {
 446
 447     QDomDocument ret;
 448     Mlt::Properties *metadata = repository->metadata(filter_type, filtername.toAscii().data());
 449     //kDebug() << filtername;
 450     if (metadata && metadata->is_valid()) {
 451         if (metadata->get("title") && metadata->get("identifier")) {
 452             QDomElement eff = ret.createElement("effect");
 453             QString id = metadata->get("identifier");
 454             eff.setAttribute("tag", id);
 455             eff.setAttribute("id", id);
 456             //kDebug()<<"Effect: "<<id;
 457
 458             QDomElement name = ret.createElement("name");
 459             name.appendChild(ret.createTextNode(metadata->get("title")));
 460
 461             QDomElement desc = ret.createElement("description");
 462             desc.appendChild(ret.createTextNode(metadata->get("description")));
 463
 464             QDomElement author = ret.createElement("author");
 465             author.appendChild(ret.createTextNode(metadata->get("creator")));
 466
 467             QDomElement version = ret.createElement("version");
 468             version.appendChild(ret.createTextNode(metadata->get("version")));
 469
 470             eff.appendChild(name);
 471             eff.appendChild(author);
 472             eff.appendChild(desc);
 473             eff.appendChild(version);
 474
 475             Mlt::Properties tags((mlt_properties) metadata->get_data("tags"));
 476             if (QString(tags.get(0)) == "Audio") eff.setAttribute("type", "audio");
 477             /*for (int i = 0; i < tags.count(); i++)
 478                 kDebug()<<tags.get_name(i)<<"="<<tags.get(i);*/
 479
 480             Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
 481             for (int j = 0; param_props.is_valid() && j < param_props.count(); j++) {
 482                 QDomElement params = ret.createElement("parameter");
 483
 484                 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(j)));
 485
 486                 params.setAttribute("name", paramdesc.get("identifier"));
 487
 488                 if (paramdesc.get("maximum")) params.setAttribute("max", paramdesc.get("maximum"));
 489                 if (paramdesc.get("minimum")) params.setAttribute("min", paramdesc.get("minimum"));
 490
 491                 QString paramType = paramdesc.get("type");
 492
 493                 if (paramType == "integer")
 494                     params.setAttribute("type", "constant");
 495                 else if (paramType == "float") {
 496                     params.setAttribute("type", "constant");
 497                     // param type is float, set default decimals to 3
 498                     params.setAttribute("decimals", "3");
 499                 }
 500                 else if (paramType == "boolean")
 501                     params.setAttribute("type", "bool");
 502                 else if (paramType == "geometry") {
 503                     params.setAttribute("type", "geometry");
 504                 }
 505                 else {
 506                     params.setAttribute("type", paramType);
 507                     if (!QString(paramdesc.get("format")).isEmpty()) params.setAttribute("format", paramdesc.get("format"));
 508                 }
 509                 if (paramdesc.get("default")) params.setAttribute("default", paramdesc.get("default"));
 510                 if (paramdesc.get("value")) {
 511                     params.setAttribute("value", paramdesc.get("value"));
 512                 } else {
 513                     params.setAttribute("value", paramdesc.get("default"));
 514                 }
 515
 516                 QDomElement pname = ret.createElement("name");
 517                 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
 518                 params.appendChild(pname);
 519
 520                 eff.appendChild(params);
 521             }
 522             ret.appendChild(eff);
 523         }
 524     }
 525     delete metadata;
 526     metadata = 0;
 527     /*QString outstr;
 528      QTextStream str(&outstr);
 529      ret.save(str, 2);
 530      kDebug() << outstr;*/
 531     return ret;
 532 }
 533
 534 void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *transitions, QStringList names)
 535 {
 536     // Remove transitions that are not implemented.
 537     int pos = names.indexOf("mix");
 538     if (pos != -1)
 539         names.takeAt(pos);
 540
 541     QStringList imagenamelist = QStringList() << i18n("None");
 542     QStringList imagefiles = QStringList() << QString();
 543     QStringList filters;
 544     filters << "*.pgm" << "*.png";
 545     QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
 546     foreach(QString folder, customLumas) {
 547         if (!folder.endsWith('/'))
 548             folder.append('/');
 549         QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
 550         foreach(const QString & fname, filesnames) {
 551             imagenamelist.append(fname);
 552             imagefiles.append(folder + fname);
 553         }
 554     }
 555
 556     // Check for MLT luma files.
 557     KUrl folder(mlt_environment("MLT_DATA"));
 558     folder.addPath("lumas");
 559     folder.addPath(mlt_environment("MLT_NORMALISATION"));
 560     QDir lumafolder(folder.path());
 561     QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
 562     foreach(const QString & fname, filesnames) {
 563         imagenamelist.append(fname);
 564         KUrl path(folder);
 565         path.addPath(fname);
 566         imagefiles.append(path.toLocalFile());
 567     }
 568
 569     //WARNING: this is a hack to get around temporary invalid metadata in MLT, 2nd of june 2011 JBM
 570     QStringList customTransitions;
 571     customTransitions << "composite" << "luma" << "affine" << "mix" << "region";
 572
 573     foreach(const QString & name, names) {
 574         QDomDocument ret;
 575         QDomElement ktrans = ret.createElement("ktransition");
 576         ret.appendChild(ktrans);
 577         ktrans.setAttribute("tag", name);
 578
 579         QDomElement tname = ret.createElement("name");
 580         QDomElement desc = ret.createElement("description");
 581         ktrans.appendChild(tname);
 582         ktrans.appendChild(desc);
 583         Mlt::Properties *metadata = NULL;
 584         if (!customTransitions.contains(name)) metadata = repository->metadata(transition_type, name.toUtf8().data());
 585         if (metadata && metadata->is_valid()) {
 586             // If possible, set name and description.
 587             if (metadata->get("title") && metadata->get("identifier"))
 588                 tname.appendChild(ret.createTextNode(metadata->get("title")));
 589             desc.appendChild(ret.createTextNode(metadata->get("description")));
 590
 591             Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
 592             for (int i = 0; param_props.is_valid() && i < param_props.count(); ++i) {
 593                 QDomElement params = ret.createElement("parameter");
 594
 595                 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(i)));
 596
 597                 params.setAttribute("name", paramdesc.get("identifier"));
 598
 599                 if (paramdesc.get("maximum"))
 600                     params.setAttribute("max", paramdesc.get("maximum"));
 601                 if (paramdesc.get("minimum"))
 602                     params.setAttribute("min", paramdesc.get("minimum"));
 603                 if (QString(paramdesc.get("type")) == "integer") {
 604                     params.setAttribute("type", "constant");
 605                     params.setAttribute("factor", "100");
 606                 }
 607                 if (QString(paramdesc.get("type")) == "boolean")
 608                     params.setAttribute("type", "bool");
 609                 if (!QString(paramdesc.get("format")).isEmpty()) {
 610                     params.setAttribute("type", "complex");
 611                     params.setAttribute("format", paramdesc.get("format"));
 612                 }
 613                 if (paramdesc.get("default"))
 614                     params.setAttribute("default", paramdesc.get("default"));
 615                 if (paramdesc.get("value"))
 616                     params.setAttribute("value", paramdesc.get("value"));
 617                 else
 618                     params.setAttribute("value", paramdesc.get("default"));
 619
 620                 QDomElement pname = ret.createElement("name");
 621                 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
 622                 params.appendChild(pname);
 623                 ktrans.appendChild(params);
 624             }
 625         } else {
 626             /*
 627              * Check for Kdenlive installed luma files, add empty string at
 628              * start for no luma file.
 629              */
 630
 631             // Implement default transitions.
 632             QList<QDomElement> paramList;
 633             if (name == "luma") {
 634                 ktrans.setAttribute("id", name);
 635                 tname.appendChild(ret.createTextNode(i18n("Wipe")));
 636                 desc.appendChild(ret.createTextNode(i18n("Applies a stationary transition between the current and next frames.")));
 637
 638                 paramList.append(quickParameterFill(ret, i18n("Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
 639                 paramList.append(quickParameterFill(ret, i18nc("@property: means that the image is inverted", "Invert"), "invert", "bool", "0", "0", "1"));
 640                 paramList.append(quickParameterFill(ret, i18n("Image File"), "resource", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
 641                 paramList.append(quickParameterFill(ret, i18n("Reverse Transition"), "reverse", "bool", "0", "0", "1"));
 642                 //thumbnailer.prepareThumbnailsCall(imagelist);
 643             } else if (name == "composite") {
 644                 ktrans.setAttribute("id", name);
 645                 tname.appendChild(ret.createTextNode(i18n("Composite")));
 646                 desc.appendChild(ret.createTextNode(i18n("A key-framable alpha-channel compositor for two frames.")));
 647                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0%/0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
 648                 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
 649                 paramList.append(quickParameterFill(ret, i18n("Align"), "aligned", "bool", "1", "0", "1"));
 650                 paramList.append(quickParameterFill(ret, i18n("Fill"), "fill", "bool", "1", "0", "1"));
 651                 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
 652                 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "luma", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
 653                 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
 654                 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "luma_invert", "bool", "0", "0", "1"));
 655                 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "progressive", "bool", "1", "0", "1"));
 656                 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "deinterlace", "bool", "0", "0", "1"));
 657             } else if (name == "affine") {
 658                 tname.appendChild(ret.createTextNode(i18n("Affine")));
 659                 ret.documentElement().setAttribute("showrotation", "1");
 660                 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "double", "0", "0", "360"));
 661                 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "double", "0", "0", "360"));
 662                 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "double", "0", "0", "360"));
 663                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Y"), "fix_rotate_y", "double", "0", "0", "360"));
 664                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate X"), "fix_rotate_x", "double", "0", "0", "360"));
 665                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Z"), "fix_rotate_z", "double", "0", "0", "360"));
 666                 paramList.append(quickParameterFill(ret, i18n("Shear Y"), "shear_y", "double", "0", "0", "360"));
 667                 paramList.append(quickParameterFill(ret, i18n("Shear X"), "shear_x", "double", "0", "0", "360"));
 668                 paramList.append(quickParameterFill(ret, i18n("Shear Z"), "shear_z", "double", "0", "0", "360"));*/
 669                 /*paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
 670                 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
 671                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));*/
 672
 673                 paramList.append(quickParameterFill(ret, "keyed", "keyed", "fixed", "1", "1", "1"));
 674                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry",  "0/0:100%x100%:100%", "0/0:100%x100%:100%", "0/0:100%x100%:100%", "", "", "", "", "", "true"));
 675                 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
 676                 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
 677                 paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
 678                 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
 679                 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));
 680                 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));*/
 681
 682                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "shear_y", "double", "0", "0", "360"));
 683                 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "shear_x", "double", "0", "0", "360"));
 684                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "shear_z", "double", "0", "0", "360"));
 685             } else if (name == "mix") {
 686                 tname.appendChild(ret.createTextNode(i18n("Mix")));
 687             } else if (name == "region") {
 688                 ktrans.setAttribute("id", name);
 689                 tname.appendChild(ret.createTextNode(i18n("Region")));
 690                 desc.appendChild(ret.createTextNode(i18n("Use alpha channel of another clip to create a transition.")));
 691                 paramList.append(quickParameterFill(ret, i18n("Transparency clip"), "resource", "url", "", "", "", "", "", ""));
 692                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "composite.geometry", "geometry", "0%/0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
 693                 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "composite.operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
 694                 paramList.append(quickParameterFill(ret, i18n("Align"), "composite.aligned", "bool", "1", "0", "1"));
 695                 paramList.append(quickParameterFill(ret, i18n("Fill"), "composite.fill", "bool", "1", "0", "1"));
 696                 paramList.append(quickParameterFill(ret, i18n("Distort"), "composite.distort", "bool", "0", "0", "1"));
 697                 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "composite.luma", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
 698                 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "composite.softness", "double", "0", "0", "100", "", "", "100"));
 699                 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "composite.luma_invert", "bool", "0", "0", "1"));
 700                 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "composite.progressive", "bool", "1", "0", "1"));
 701                 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "composite.deinterlace", "bool", "0", "0", "1"));
 702             }
 703             foreach(const QDomElement & e, paramList)
 704             ktrans.appendChild(e);
 705         }
 706         delete metadata;
 707         metadata = 0;
 708         // Add the transition to the global list.
 709         transitions->append(ret.documentElement());
 710         //kDebug() << ret.toString();
 711     }
 712
 713     // Add some virtual transitions.
 714     QString slidetrans = "<ktransition tag=\"composite\" id=\"slide\"><name>" + i18n("Slide") + "</name><description>" + i18n("Slide image from one side to another.") + "</description><parameter tag=\"geometry\" type=\"wipe\" default=\"-100%,0%:100%x100%;-1=0%,0%:100%x100%\" name=\"geometry\"><name>" + i18n("Direction") + "</name>                                               </parameter><parameter tag=\"aligned\" default=\"0\" type=\"bool\" name=\"aligned\" ><name>" + i18n("Align") + "</name></parameter><parameter tag=\"progressive\" default=\"1\" type=\"bool\" name=\"progressive\" ><name>" + i18n("Force Progressive Rendering") + "</name></parameter><parameter tag=\"deinterlace\" default=\"0\" type=\"bool\" name=\"deinterlace\" ><name>" + i18n("Force Deinterlace Overlay") + "</name></parameter><parameter tag=\"invert\" default=\"0\" type=\"bool\" name=\"invert\" ><name>" + i18nc("@property: means that the image is inverted", "Invert") + "</name></parameter></ktransition>";
 715     QDomDocument ret;
 716     ret.setContent(slidetrans);
 717     transitions->append(ret.documentElement());
 718
 719     QString dissolve = "<ktransition tag=\"luma\" id=\"dissolve\"><name>" + i18n("Dissolve") + "</name><description>" + i18n("Fade out one video while fading in the other video.") + "</description><parameter tag=\"reverse\" default=\"0\" type=\"bool\" name=\"reverse\" ><name>" + i18n("Reverse") + "</name></parameter></ktransition>";
 720     ret.setContent(dissolve);
 721     transitions->append(ret.documentElement());
 722
 723     /*QString alphatrans = "<ktransition tag=\"composite\" id=\"alphatransparency\" ><name>" + i18n("Alpha Transparency") + "</name><description>" + i18n("Make alpha channel transparent.") + "</description><parameter tag=\"geometry\" type=\"fixed\" default=\"0%,0%:100%x100%\" name=\"geometry\"><name>" + i18n("Direction") + "</name></parameter><parameter tag=\"fill\" default=\"0\" type=\"bool\" name=\"fill\" ><name>" + i18n("Rescale") + "</name></parameter><parameter tag=\"aligned\" default=\"0\" type=\"bool\" name=\"aligned\" ><name>" + i18n("Align") + "</name></parameter></ktransition>";
 724     ret.setContent(alphatrans);
 725     transitions->append(ret.documentElement());*/
 726 }
 727
 728 QDomElement initEffects::quickParameterFill(QDomDocument & doc, QString name, QString tag, QString type, QString def, QString min, QString max, QString list, QString listdisplaynames, QString factor, QString namedesc, QString format, QString opacity)
 729 {
 730     QDomElement parameter = doc.createElement("parameter");
 731     parameter.setAttribute("tag", tag);
 732     parameter.setAttribute("default", def);
 733     parameter.setAttribute("type", type);
 734     parameter.setAttribute("name", tag);
 735     parameter.setAttribute("max", max);
 736     parameter.setAttribute("min", min);
 737     if (!list.isEmpty())
 738         parameter.setAttribute("paramlist", list);
 739     if (!listdisplaynames.isEmpty())
 740         parameter.setAttribute("paramlistdisplay", listdisplaynames);
 741     if (!factor.isEmpty())
 742         parameter.setAttribute("factor", factor);
 743     if (!namedesc.isEmpty())
 744         parameter.setAttribute("namedesc", namedesc);
 745     if (!format.isEmpty())
 746         parameter.setAttribute("format", format);
 747     if (!opacity.isEmpty())
 748         parameter.setAttribute("opacity", opacity);
 749     QDomElement pname = doc.createElement("name");
 750     pname.appendChild(doc.createTextNode(name));
 751     parameter.appendChild(pname);
 752
 753     return parameter;
 754 }