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(const 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
 207         }
 208         file2.close();
 209     }
 210
 211     /*
 212      * Cleanup the global lists. We use QMap because of its automatic sorting
 213      * (by key) and key uniqueness (using insert() instead of insertMulti()).
 214      * This introduces some more cycles (while removing them from other parts of
 215      * the code and centralising them), but due to the way this methods, QMap
 216      * and EffectsList are implemented, there's no easy way to make it
 217      * differently without reinplementing something (which should really be
 218      * done).
 219      */
 220     QDomElement effectInfo;
 221     QMap<QString, QDomElement> effectsMap;
 222     QMap<QString, QDomElement> videoEffectsMap;
 223     QMap<QString, QDomElement> audioEffectsMap;
 224
 225     // Create transitions
 226     max = MainWindow::transitions.count();
 227     for (int i = 0; i < max; ++i) {
 228         effectInfo = MainWindow::transitions.at(i);
 229         effectsMap.insert(effectInfo.firstChildElement("name").text().toLower().toUtf8().data(), effectInfo);
 230     }
 231     MainWindow::transitions.clearList();
 232     foreach(const QDomElement & effect, effectsMap)
 233         MainWindow::transitions.append(effect);
 234     effectsMap.clear();
 235     // Create effects from MLT
 236     foreach(const QString & filtername, mltFiltersList) {
 237         QDomDocument doc = createDescriptionFromMlt(repository, "filters", filtername);
 238         //WARNING: TEMPORARY FIX for empty MLT effects descriptions - disable effects without parameters - jbm 09-06-2011
 239         if (!doc.isNull() && doc.elementsByTagName("parameter").count() > 0) {
 240             if (doc.documentElement().attribute("type") == "audio") {
 241                 if (doc.elementsByTagName("description").count() > 0) {
 242                     QString desc = doc.documentElement().firstChildElement("description").text();
 243                     //WARNING: TEMPORARY FIX for unusable MLT SOX parameters description
 244                     if (desc.startsWith("Process audio using a SoX")) {
 245                         // Remove MLT's SOX generated effects since the parameters properties are unusable for us
 246                     }
 247                     else {
 248                         audioEffectsMap.insert(doc.documentElement().firstChildElement("name").text().toLower().toUtf8().data(), doc.documentElement());
 249                     }
 250                 }
 251             }
 252             else
 253                 videoEffectsMap.insert(doc.documentElement().firstChildElement("name").text().toLower().toUtf8().data(), doc.documentElement());
 254         }
 255     }
 256
 257     // Set the directories to look into for effects.
 258     QStringList direc = KGlobal::dirs()->findDirs("appdata", "effects");
 259     // Iterate through effects directories to parse all XML files.
 260     for (more = direc.begin(); more != direc.end(); ++more) {
 261         QDir directory(*more);
 262         QStringList filter;
 263         filter << "*.xml";
 264         fileList = directory.entryList(filter, QDir::Files);
 265         for (it = fileList.begin(); it != fileList.end(); ++it) {
 266             itemName = KUrl(*more + *it).path();
 267             parseEffectFile(&MainWindow::customEffects,
 268                             &MainWindow::audioEffects,
 269                             &MainWindow::videoEffects,
 270                             itemName, filtersList, producersList, repository);
 271         }
 272     }
 273
 274     // Create custom effects
 275     max = MainWindow::customEffects.count();
 276     for (int i = 0; i < max; ++i) {
 277         effectInfo = MainWindow::customEffects.at(i);
 278         if (effectInfo.tagName() == "effectgroup") {
 279             effectsMap.insert(effectInfo.attribute("name").toUtf8().data(), effectInfo);
 280         }
 281         else effectsMap.insert(effectInfo.firstChildElement("name").text().toUtf8().data(), effectInfo);
 282     }
 283     MainWindow::customEffects.clearList();
 284     foreach(const QDomElement & effect, effectsMap)
 285         MainWindow::customEffects.append(effect);
 286     effectsMap.clear();
 287
 288     // Create audio effects
 289     max = MainWindow::audioEffects.count();
 290     for (int i = 0; i < max; ++i) {
 291         effectInfo = MainWindow::audioEffects.at(i);
 292         audioEffectsMap.insert(effectInfo.firstChildElement("name").text().toLower().toUtf8().data(), effectInfo);
 293     }
 294     MainWindow::audioEffects.clearList();
 295     foreach(const QDomElement & effect, audioEffectsMap)
 296         MainWindow::audioEffects.append(effect);
 297
 298     // Create video effects
 299     max = MainWindow::videoEffects.count();
 300     for (int i = 0; i < max; ++i) {
 301         effectInfo = MainWindow::videoEffects.at(i);
 302         videoEffectsMap.insert(effectInfo.firstChildElement("name").text().toLower().toUtf8().data(), effectInfo);
 303     }
 304     MainWindow::videoEffects.clearList();
 305     foreach(const QDomElement & effect, videoEffectsMap)
 306         MainWindow::videoEffects.append(effect);
 307 }
 308
 309 // static
 310 void initEffects::parseCustomEffectsFile()
 311 {
 312     MainWindow::customEffects.clearList();
 313     /*
 314      * Why a QMap? See parseEffectFiles(). It's probably useless here, but we
 315      * cannot be sure about it.
 316      */
 317     QMap<QString, QDomElement> effectsMap;
 318     QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
 319     QDir directory = QDir(path);
 320     QStringList filter;
 321     filter << "*.xml";
 322     const QStringList fileList = directory.entryList(filter, QDir::Files);
 323     /*
 324      * We need to declare these variables outside the foreach, or the QMap will
 325      * refer to non existing variables (QMap::insert() takes references as
 326      * parameters).
 327      */
 328     QDomDocument doc;
 329     QDomNodeList effects;
 330     QDomElement e;
 331     int unknownGroupCount = 0;
 332     foreach(const QString & filename, fileList) {
 333         QString itemName = KUrl(path + filename).path();
 334         QFile file(itemName);
 335         doc.setContent(&file, false);
 336         file.close();
 337         QDomElement base = doc.documentElement();
 338         if (base.tagName() == "effectgroup") {
 339             QString groupName = base.attribute("name");
 340             if (groupName.isEmpty()) {
 341                 groupName = i18n("Group %1", unknownGroupCount);
 342                 base.setAttribute("name", groupName);
 343                 unknownGroupCount++;
 344             }
 345             effectsMap.insert(groupName.toLower().toUtf8().data(), base);
 346         } else if (base.tagName() == "effect") {
 347             effectsMap.insert(base.firstChildElement("name").text().toLower().toUtf8().data(), base);
 348         }
 349         else kDebug() << "Unsupported effect file: " << itemName;
 350     }
 351     foreach(const QDomElement & effect, effectsMap)
 352         MainWindow::customEffects.append(effect);
 353 }
 354
 355 // static
 356 void initEffects::parseEffectFile(EffectsList *customEffectList, EffectsList *audioEffectList, EffectsList *videoEffectList, const QString &name, QStringList filtersList, QStringList producersList, Mlt::Repository *repository)
 357 {
 358     QDomDocument doc;
 359     QFile file(name);
 360     doc.setContent(&file, false);
 361     file.close();
 362     QDomElement documentElement;
 363     QDomNodeList effects;
 364     QDomElement base = doc.documentElement();
 365     effects = doc.elementsByTagName("effect");
 366
 367     if (effects.count() == 0) {
 368         kDebug() << "Effect broken: " << name;
 369         return;
 370     }
 371
 372     bool needsLocaleConversion = false;
 373     for (int i = 0; !effects.item(i).isNull(); ++i) {
 374         QLocale locale;
 375         documentElement = effects.item(i).toElement();
 376         QString tag = documentElement.attribute("tag", QString());
 377         if (documentElement.hasAttribute("LC_NUMERIC")) {
 378             // set a locale for that file
 379             locale = QLocale(documentElement.attribute("LC_NUMERIC"));
 380             if (locale.decimalPoint() != QLocale().decimalPoint()) {
 381                 needsLocaleConversion = true;
 382             }
 383         }
 384         locale.setNumberOptions(QLocale::OmitGroupSeparator);
 385
 386         if (needsLocaleConversion) {
 387             // we need to convert all numbers to the system's locale (for example 0.5 -> 0,5)
 388             QChar separator = QLocale().decimalPoint();
 389             QChar oldSeparator = locale.decimalPoint();
 390             QDomNodeList params = documentElement.elementsByTagName("parameter");
 391             for (int j = 0; j < params.count(); j++) {
 392                 QDomNamedNodeMap attrs = params.at(j).attributes();
 393                 for (int k = 0; k < attrs.count(); k++) {
 394                     QString nodeName = attrs.item(k).nodeName();
 395                     if (nodeName != "type" && nodeName != "name") {
 396                             QString val = attrs.item(k).nodeValue();
 397                             if (val.contains(oldSeparator)) {
 398                                 QString newVal = val.replace(oldSeparator, separator);
 399                                 attrs.item(k).setNodeValue(newVal);
 400                             }
 401                     }
 402                 }
 403             }
 404         }
 405
 406         double version = -1;
 407         Mlt::Properties *metadata = repository->metadata(filter_type, tag.toUtf8().data());
 408         if (metadata && metadata->is_valid()) {
 409             version = metadata->get_double("version");
 410         }
 411         if (metadata) delete metadata;
 412         if (documentElement.hasAttribute("version")) {
 413             // a specific version of the filter is required
 414             if (locale.toDouble(documentElement.attribute("version")) > version) {
 415                 return;
 416             }
 417         }
 418         if (version > -1) {
 419             // Add version info to XML
 420             QDomNode versionNode = doc.createElement("version");
 421             versionNode.appendChild(doc.createTextNode(QLocale().toString(version)));
 422             documentElement.appendChild(versionNode);
 423         }
 424
 425         // Parse effect information.
 426         if (base.tagName() != "effectgroup" && (filtersList.contains(tag) || producersList.contains(tag))) {
 427             QString type = documentElement.attribute("type", QString());
 428             if (type == "audio")
 429                 audioEffectList->append(documentElement);
 430             else if (type == "custom")
 431                 customEffectList->append(documentElement);
 432             else
 433                 videoEffectList->append(documentElement);
 434         }
 435     }
 436     if (base.tagName() == "effectgroup") {
 437         QString type = base.attribute("type", QString());
 438         if (type == "audio")
 439             audioEffectList->append(base);
 440         else if (type == "custom")
 441             customEffectList->append(base);
 442         else
 443             videoEffectList->append(base);
 444     }
 445 }
 446
 447 QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository, const QString& /*type*/, const QString& filtername)
 448 {
 449
 450     QDomDocument ret;
 451     Mlt::Properties *metadata = repository->metadata(filter_type, filtername.toAscii().data());
 452     //kDebug() << filtername;
 453     if (metadata && metadata->is_valid()) {
 454         if (metadata->get("title") && metadata->get("identifier")) {
 455             QDomElement eff = ret.createElement("effect");
 456             QString id = metadata->get("identifier");
 457             eff.setAttribute("tag", id);
 458             eff.setAttribute("id", id);
 459             //kDebug()<<"Effect: "<<id;
 460
 461             QDomElement name = ret.createElement("name");
 462             name.appendChild(ret.createTextNode(metadata->get("title")));
 463
 464             QDomElement desc = ret.createElement("description");
 465             desc.appendChild(ret.createTextNode(metadata->get("description")));
 466
 467             QDomElement author = ret.createElement("author");
 468             author.appendChild(ret.createTextNode(metadata->get("creator")));
 469
 470             QDomElement version = ret.createElement("version");
 471             version.appendChild(ret.createTextNode(metadata->get("version")));
 472
 473             eff.appendChild(name);
 474             eff.appendChild(author);
 475             eff.appendChild(desc);
 476             eff.appendChild(version);
 477
 478             Mlt::Properties tags((mlt_properties) metadata->get_data("tags"));
 479             if (QString(tags.get(0)) == "Audio") eff.setAttribute("type", "audio");
 480             /*for (int i = 0; i < tags.count(); ++i)
 481                 kDebug()<<tags.get_name(i)<<"="<<tags.get(i);*/
 482
 483             Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
 484             for (int j = 0; param_props.is_valid() && j < param_props.count(); j++) {
 485                 QDomElement params = ret.createElement("parameter");
 486
 487                 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(j)));
 488                 params.setAttribute("name", paramdesc.get("identifier"));
 489                 if (params.attribute("name") == "argument") {
 490                     // This parameter has to be given as attribute when using command line, do not show it in Kdenlive
 491                     continue;
 492                 }
 493
 494                 if (paramdesc.get("maximum")) params.setAttribute("max", paramdesc.get("maximum"));
 495                 if (paramdesc.get("minimum")) params.setAttribute("min", paramdesc.get("minimum"));
 496
 497                 QString paramType = paramdesc.get("type");
 498
 499                 if (paramType == "integer") {
 500                     if (params.attribute("min") == "0" && params.attribute("max") == "1")
 501                         params.setAttribute("type", "bool");
 502                     else params.setAttribute("type", "constant");
 503
 504                 }
 505                 else if (paramType == "float") {
 506                     params.setAttribute("type", "constant");
 507                     // param type is float, set default decimals to 3
 508                     params.setAttribute("decimals", "3");
 509                 }
 510                 else if (paramType == "boolean")
 511                     params.setAttribute("type", "bool");
 512                 else if (paramType == "geometry") {
 513                     params.setAttribute("type", "geometry");
 514                 }
 515                 else {
 516                     params.setAttribute("type", paramType);
 517                     if (!QString(paramdesc.get("format")).isEmpty()) params.setAttribute("format", paramdesc.get("format"));
 518                 }
 519                 if (paramdesc.get("default")) params.setAttribute("default", paramdesc.get("default"));
 520                 if (paramdesc.get("value")) {
 521                     params.setAttribute("value", paramdesc.get("value"));
 522                 } else {
 523                     params.setAttribute("value", paramdesc.get("default"));
 524                 }
 525
 526                 QDomElement pname = ret.createElement("name");
 527                 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
 528                 params.appendChild(pname);
 529
 530                 if (paramdesc.get("description")) {
 531                     QDomElement desc = ret.createElement("comment");
 532                     desc.appendChild(ret.createTextNode(paramdesc.get("description")));
 533                     params.appendChild(desc);
 534                 }
 535
 536                 eff.appendChild(params);
 537             }
 538             ret.appendChild(eff);
 539         }
 540     }
 541     delete metadata;
 542     metadata = 0;
 543     /*QString outstr;
 544      QTextStream str(&outstr);
 545      ret.save(str, 2);
 546      kDebug() << outstr;*/
 547     return ret;
 548 }
 549
 550 void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *transitions, QStringList names)
 551 {
 552     // Remove transitions that are not implemented.
 553     int pos = names.indexOf("mix");
 554     if (pos != -1)
 555         names.takeAt(pos);
 556
 557     QStringList imagenamelist = QStringList() << i18n("None");
 558     QStringList imagefiles = QStringList() << QString();
 559     QStringList filters;
 560     filters << "*.pgm" << "*.png";
 561     QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
 562     foreach(QString folder, customLumas) {
 563         if (!folder.endsWith('/'))
 564             folder.append('/');
 565         QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
 566         foreach(const QString & fname, filesnames) {
 567             imagenamelist.append(fname);
 568             imagefiles.append(folder + fname);
 569         }
 570     }
 571
 572     // Check for MLT luma files.
 573     KUrl folder(mlt_environment("MLT_DATA"));
 574     folder.addPath("lumas");
 575     folder.addPath(mlt_environment("MLT_NORMALISATION"));
 576     QDir lumafolder(folder.path());
 577     QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
 578     foreach(const QString & fname, filesnames) {
 579         imagenamelist.append(fname);
 580         KUrl path(folder);
 581         path.addPath(fname);
 582         imagefiles.append(path.toLocalFile());
 583     }
 584
 585     //WARNING: this is a hack to get around temporary invalid metadata in MLT, 2nd of june 2011 JBM
 586     QStringList customTransitions;
 587     customTransitions << "composite" << "luma" << "affine" << "mix" << "region";
 588
 589     foreach(const QString & name, names) {
 590         QDomDocument ret;
 591         QDomElement ktrans = ret.createElement("ktransition");
 592         ret.appendChild(ktrans);
 593         ktrans.setAttribute("tag", name);
 594
 595         QDomElement tname = ret.createElement("name");
 596         QDomElement desc = ret.createElement("description");
 597         ktrans.appendChild(tname);
 598         ktrans.appendChild(desc);
 599         Mlt::Properties *metadata = NULL;
 600         if (!customTransitions.contains(name)) metadata = repository->metadata(transition_type, name.toUtf8().data());
 601         if (metadata && metadata->is_valid()) {
 602             // If possible, set name and description.
 603             if (metadata->get("title") && metadata->get("identifier"))
 604                 tname.appendChild(ret.createTextNode(metadata->get("title")));
 605             desc.appendChild(ret.createTextNode(metadata->get("description")));
 606
 607             Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
 608             for (int i = 0; param_props.is_valid() && i < param_props.count(); ++i) {
 609                 QDomElement params = ret.createElement("parameter");
 610
 611                 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(i)));
 612
 613                 params.setAttribute("name", paramdesc.get("identifier"));
 614
 615                 if (paramdesc.get("maximum"))
 616                     params.setAttribute("max", paramdesc.get("maximum"));
 617                 if (paramdesc.get("minimum"))
 618                     params.setAttribute("min", paramdesc.get("minimum"));
 619                 if (QString(paramdesc.get("type")) == "integer") {
 620                     params.setAttribute("type", "constant");
 621                     params.setAttribute("factor", "100");
 622                 }
 623                 if (QString(paramdesc.get("type")) == "boolean")
 624                     params.setAttribute("type", "bool");
 625                 if (!QString(paramdesc.get("format")).isEmpty()) {
 626                     params.setAttribute("type", "complex");
 627                     params.setAttribute("format", paramdesc.get("format"));
 628                 }
 629                 if (paramdesc.get("default"))
 630                     params.setAttribute("default", paramdesc.get("default"));
 631                 if (paramdesc.get("value"))
 632                     params.setAttribute("value", paramdesc.get("value"));
 633                 else
 634                     params.setAttribute("value", paramdesc.get("default"));
 635
 636                 QDomElement pname = ret.createElement("name");
 637                 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
 638                 params.appendChild(pname);
 639                 ktrans.appendChild(params);
 640             }
 641         } else {
 642             /*
 643              * Check for Kdenlive installed luma files, add empty string at
 644              * start for no luma file.
 645              */
 646
 647             // Implement default transitions.
 648             QList<QDomElement> paramList;
 649             if (name == "luma") {
 650                 ktrans.setAttribute("id", name);
 651                 tname.appendChild(ret.createTextNode(i18n("Wipe")));
 652                 desc.appendChild(ret.createTextNode(i18n("Applies a stationary transition between the current and next frames.")));
 653
 654                 paramList.append(quickParameterFill(ret, i18n("Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
 655                 paramList.append(quickParameterFill(ret, i18nc("@property: means that the image is inverted", "Invert"), "invert", "bool", "0", "0", "1"));
 656                 paramList.append(quickParameterFill(ret, i18n("Image File"), "resource", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
 657                 paramList.append(quickParameterFill(ret, i18n("Reverse Transition"), "reverse", "bool", "0", "0", "1"));
 658                 //thumbnailer.prepareThumbnailsCall(imagelist);
 659             } else if (name == "composite") {
 660                 ktrans.setAttribute("id", name);
 661                 tname.appendChild(ret.createTextNode(i18n("Composite")));
 662                 desc.appendChild(ret.createTextNode(i18n("A key-framable alpha-channel compositor for two frames.")));
 663                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0%/0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
 664                 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
 665                 paramList.append(quickParameterFill(ret, i18n("Align"), "aligned", "bool", "1", "0", "1"));
 666                 paramList.append(quickParameterFill(ret, i18n("Fill"), "fill", "bool", "1", "0", "1"));
 667                 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
 668                 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "luma", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
 669                 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
 670                 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "luma_invert", "bool", "0", "0", "1"));
 671                 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "progressive", "bool", "1", "0", "1"));
 672                 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "deinterlace", "bool", "0", "0", "1"));
 673             } else if (name == "affine") {
 674                 tname.appendChild(ret.createTextNode(i18n("Affine")));
 675                 ret.documentElement().setAttribute("showrotation", "1");
 676                 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "double", "0", "0", "360"));
 677                 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "double", "0", "0", "360"));
 678                 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "double", "0", "0", "360"));
 679                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Y"), "fix_rotate_y", "double", "0", "0", "360"));
 680                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate X"), "fix_rotate_x", "double", "0", "0", "360"));
 681                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Z"), "fix_rotate_z", "double", "0", "0", "360"));
 682                 paramList.append(quickParameterFill(ret, i18n("Shear Y"), "shear_y", "double", "0", "0", "360"));
 683                 paramList.append(quickParameterFill(ret, i18n("Shear X"), "shear_x", "double", "0", "0", "360"));
 684                 paramList.append(quickParameterFill(ret, i18n("Shear Z"), "shear_z", "double", "0", "0", "360"));*/
 685                 /*paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
 686                 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
 687                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));*/
 688
 689                 paramList.append(quickParameterFill(ret, "keyed", "keyed", "fixed", "1", "1", "1"));
 690                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry",  "0/0:100%x100%:100%", "0/0:100%x100%:100%", "0/0:100%x100%:100%", "", "", "", "", "", "true"));
 691                 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
 692                 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
 693                 paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
 694                 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
 695                 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));
 696                 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));*/
 697
 698                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "shear_y", "double", "0", "0", "360"));
 699                 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "shear_x", "double", "0", "0", "360"));
 700                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "shear_z", "double", "0", "0", "360"));
 701             } else if (name == "mix") {
 702                 tname.appendChild(ret.createTextNode(i18n("Mix")));
 703             } else if (name == "region") {
 704                 ktrans.setAttribute("id", name);
 705                 tname.appendChild(ret.createTextNode(i18n("Region")));
 706                 desc.appendChild(ret.createTextNode(i18n("Use alpha channel of another clip to create a transition.")));
 707                 paramList.append(quickParameterFill(ret, i18n("Transparency clip"), "resource", "url", "", "", "", "", "", ""));
 708                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "composite.geometry", "geometry", "0%/0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
 709                 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "composite.operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
 710                 paramList.append(quickParameterFill(ret, i18n("Align"), "composite.aligned", "bool", "1", "0", "1"));
 711                 paramList.append(quickParameterFill(ret, i18n("Fill"), "composite.fill", "bool", "1", "0", "1"));
 712                 paramList.append(quickParameterFill(ret, i18n("Distort"), "composite.distort", "bool", "0", "0", "1"));
 713                 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "composite.luma", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
 714                 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "composite.softness", "double", "0", "0", "100", "", "", "100"));
 715                 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "composite.luma_invert", "bool", "0", "0", "1"));
 716                 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "composite.progressive", "bool", "1", "0", "1"));
 717                 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "composite.deinterlace", "bool", "0", "0", "1"));
 718             }
 719             foreach(const QDomElement & e, paramList)
 720             ktrans.appendChild(e);
 721         }
 722         delete metadata;
 723         metadata = 0;
 724         // Add the transition to the global list.
 725         transitions->append(ret.documentElement());
 726         //kDebug() << ret.toString();
 727     }
 728
 729     // Add some virtual transitions.
 730     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>";
 731     QDomDocument ret;
 732     ret.setContent(slidetrans);
 733     transitions->append(ret.documentElement());
 734
 735     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>";
 736     ret.setContent(dissolve);
 737     transitions->append(ret.documentElement());
 738
 739     /*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>";
 740     ret.setContent(alphatrans);
 741     transitions->append(ret.documentElement());*/
 742 }
 743
 744 QDomElement initEffects::quickParameterFill(QDomDocument & doc, const QString &name, const QString &tag, const QString &type, const QString &def, const QString &min, const QString &max, const QString &list, const QString &listdisplaynames, const QString &factor, const QString &namedesc, const QString &format, const QString &opacity)
 745 {
 746     QDomElement parameter = doc.createElement("parameter");
 747     parameter.setAttribute("tag", tag);
 748     parameter.setAttribute("default", def);
 749     parameter.setAttribute("type", type);
 750     parameter.setAttribute("name", tag);
 751     parameter.setAttribute("max", max);
 752     parameter.setAttribute("min", min);
 753     if (!list.isEmpty())
 754         parameter.setAttribute("paramlist", list);
 755     if (!listdisplaynames.isEmpty())
 756         parameter.setAttribute("paramlistdisplay", listdisplaynames);
 757     if (!factor.isEmpty())
 758         parameter.setAttribute("factor", factor);
 759     if (!namedesc.isEmpty())
 760         parameter.setAttribute("namedesc", namedesc);
 761     if (!format.isEmpty())
 762         parameter.setAttribute("format", format);
 763     if (!opacity.isEmpty())
 764         parameter.setAttribute("opacity", opacity);
 765     QDomElement pname = doc.createElement("name");
 766     pname.appendChild(doc.createTextNode(name));
 767     parameter.appendChild(pname);
 768
 769     return parameter;
 770 }
 771
 772 #include "initeffects.moc"