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