]> git.sesse.net Git - kdenlive/blob - src/initeffects.cpp
Embed custom effects in project file:
[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     // Set the directories to look into for ladspa plugins.
189     KGlobal::dirs()->addResourceType("ladspa_plugin", 0, "lib/ladspa");
190     KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/lib/ladspa");
191     KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/local/lib/ladspa");
192     KGlobal::dirs()->addResourceDir("ladspa_plugin", "/opt/lib/ladspa");
193     KGlobal::dirs()->addResourceDir("ladspa_plugin", "/opt/local/lib/ladspa");
194     KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/lib64/ladspa");
195     KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/local/lib64/ladspa");
196
197     // Set the directories to look into for effects.
198     QStringList direc = KGlobal::dirs()->findDirs("appdata", "effects");
199
200     // Iterate through effects directories to parse all XML files.
201     for (more = direc.begin(); more != direc.end(); ++more) {
202         QDir directory(*more);
203         QStringList filter;
204         filter << "*.xml";
205         fileList = directory.entryList(filter, QDir::Files);
206         for (it = fileList.begin(); it != fileList.end(); ++it) {
207             itemName = KUrl(*more + *it).path();
208             parseEffectFile(&MainWindow::customEffects,
209                             &MainWindow::audioEffects,
210                             &MainWindow::videoEffects,
211                             itemName, filtersList, producersList);
212         }
213     }
214
215     // Remove blacklisted effects from the filters list.
216     QFile file2(KStandardDirs::locate("appdata", "blacklisted_effects.txt"));
217     if (file2.open(QIODevice::ReadOnly)) {
218         QTextStream in(&file2);
219         while (!in.atEnd()) {
220             QString black = in.readLine().simplified();
221             if (!black.isEmpty() && !black.startsWith('#') &&
222                     filtersList.contains(black))
223                 filtersList.removeAll(black);
224         }
225         file2.close();
226     }
227
228     /*
229      * Cleanup the global lists. We use QMap because of its automatic sorting
230      * (by key) and key uniqueness (using insert() instead of insertMulti()).
231      * This introduces some more cycles (while removing them from other parts of
232      * the code and centralising them), but due to the way this methods, QMap
233      * and EffectsList are implemented, there's no easy way to make it
234      * differently without reinplementing something (which should really be
235      * done).
236      */
237     QDomElement effectInfo;
238     QMap<QString, QDomElement> effectsMap;
239     for (int i = 0; i < MainWindow::transitions.count(); ++i) {
240         effectInfo = MainWindow::transitions.at(i);
241         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
242     }
243     MainWindow::transitions.clearList();
244     foreach(const QDomElement & effect, effectsMap)
245     MainWindow::transitions.append(effect);
246     effectsMap.clear();
247     for (int i = 0; i < MainWindow::customEffects.count(); ++i) {
248         effectInfo = MainWindow::customEffects.at(i);
249         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
250     }
251     MainWindow::customEffects.clearList();
252     foreach(const QDomElement & effect, effectsMap)
253     MainWindow::customEffects.append(effect);
254     effectsMap.clear();
255     for (int i = 0; i < MainWindow::audioEffects.count(); ++i) {
256         effectInfo = MainWindow::audioEffects.at(i);
257         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
258     }
259     MainWindow::audioEffects.clearList();
260     foreach(const QDomElement & effect, effectsMap)
261     MainWindow::audioEffects.append(effect);
262     effectsMap.clear();
263     for (int i = 0; i < MainWindow::videoEffects.count(); ++i) {
264         effectInfo = MainWindow::videoEffects.at(i);
265         effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
266     }
267     // Add remaining filters to the list of video effects.
268     foreach(const QString & filtername, filtersList) {
269         QDomDocument doc = createDescriptionFromMlt(repository, "filters", filtername);
270         if (!doc.isNull())
271             effectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
272     }
273     MainWindow::videoEffects.clearList();
274     foreach(const QDomElement & effect, effectsMap)
275     MainWindow::videoEffects.append(effect);
276
277     return repository;
278 }
279
280 // static
281 void initEffects::parseCustomEffectsFile()
282 {
283     MainWindow::customEffects.clearList();
284     /*
285      * Why a QMap? See parseEffectFiles(). It's probably useless here, but we
286      * cannot be sure about it.
287      */
288     QMap<QString, QDomElement> effectsMap;
289     QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
290     QDir directory = QDir(path);
291     QStringList filter;
292     filter << "*.xml";
293     const QStringList fileList = directory.entryList(filter, QDir::Files);
294     /*
295      * We need to declare these variables outside the foreach, or the QMap will
296      * refer to non existing variables (QMap::insert() takes references as
297      * parameters).
298      */
299     QDomDocument doc;
300     QDomNodeList effects;
301     QDomElement e;
302     foreach(const QString & filename, fileList) {
303         QString itemName = KUrl(path + filename).path();
304         QFile file(itemName);
305         doc.setContent(&file, false);
306         file.close();
307         effects = doc.elementsByTagName("effect");
308         if (effects.count() != 1) {
309             kDebug() << "More than one effect in file " << itemName << ", not supported yet";
310         } else {
311             e = effects.item(0).toElement();
312             effectsMap.insert(e.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), e);
313         }
314     }
315     foreach(const QDomElement & effect, effectsMap)
316     MainWindow::customEffects.append(effect);
317 }
318
319 // static
320 void initEffects::parseEffectFile(EffectsList *customEffectList, EffectsList *audioEffectList, EffectsList *videoEffectList, QString name, QStringList filtersList, QStringList producersList)
321 {
322     QDomDocument doc;
323     QFile file(name);
324     doc.setContent(&file, false);
325     file.close();
326     QDomElement documentElement = doc.documentElement();
327     QDomNodeList effects = doc.elementsByTagName("effect");
328
329     if (effects.count() == 0) {
330         kDebug() << "Effect broken: " << name;
331         return;
332     }
333
334     /*QString groupName;
335     if (doc.elementsByTagName("effectgroup").item(0).toElement().tagName() == "effectgroup")
336         groupName = documentElement.attribute("name", QString());*/
337
338     for (int i = 0; !effects.item(i).isNull(); ++i) {
339         documentElement = effects.item(i).toElement();
340         QString tag = documentElement.attribute("tag", QString());
341         bool ladspaOk = true;
342         if (tag == "ladspa") {
343             QString library = documentElement.attribute("library", QString());
344             if (KStandardDirs::locate("ladspa_plugin", library).isEmpty()) ladspaOk = false;
345         }
346
347         // Parse effect information.
348         if ((filtersList.contains(tag) || producersList.contains(tag)) && ladspaOk) {
349             QString type = documentElement.attribute("type", QString());
350             if (type == "audio")
351                 audioEffectList->append(documentElement);
352             else if (type == "custom")
353                 customEffectList->append(documentElement);
354             else
355                 videoEffectList->append(documentElement);
356         }
357
358         /*
359              QDomNode n = documentElement.firstChild();
360          QString id, effectName, effectTag, paramType;
361          int paramCount = 0;
362          EFFECTTYPE type;
363
364                 // Create Effect
365                 EffectParamDescFactory effectDescParamFactory;
366                 EffectDesc *effect = NULL;
367
368          // parse effect file
369          QDomNode namenode = documentElement.elementsByTagName("name").item(0);
370          if (!namenode.isNull()) effectName = i18n(namenode.toElement().text());
371          if (!groupName.isEmpty()) effectName.prepend("_" + groupName + "_");
372
373          QDomNode propsnode = documentElement.elementsByTagName("properties").item(0);
374          if (!propsnode.isNull()) {
375              QDomElement propselement = propsnode.toElement();
376              id = propselement.attribute("id", QString());
377              effectTag = propselement.attribute("tag", QString());
378              if (propselement.attribute("type", QString()) == "audio") type = AUDIOEFFECT;
379              else if (propselement.attribute("type", QString()) == "custom") type = CUSTOMEFFECT;
380              else type = VIDEOEFFECT;
381          }
382
383          QString effectDescription;
384          QDomNode descnode = documentElement.elementsByTagName("description").item(0);
385          if (!descnode.isNull()) effectDescription = descnode.toElement().text() + "<br />";
386
387          QString effectAuthor;
388          QDomNode authnode = documentElement.elementsByTagName("author").item(0);
389          if (!authnode.isNull()) effectAuthor = authnode.toElement().text() + "<br />";
390
391          if (effectName.isEmpty() || id.isEmpty() || effectTag.isEmpty()) return;
392
393          effect = new EffectDesc(effectName, id, effectTag, effectDescription, effectAuthor, type);
394
395          QDomNodeList paramList = documentElement.elementsByTagName("parameter");
396          if (paramList.count() == 0) {
397              QDomElement fixed = doc.createElement("parameter");
398              fixed.setAttribute("type", "fixed");
399              effect->addParameter(effectDescParamFactory.createParameter(fixed));
400          }
401          else for (int i = 0; i < paramList.count(); i++) {
402              QDomElement e = paramList.item(i).toElement();
403              if (!e.isNull()) {
404           paramCount++;
405            QDomNamedNodeMap attrs = e.attributes();
406           int i = 0;
407           QString value;
408           while (!attrs.item(i).isNull()) {
409               QDomNode n = attrs.item(i);
410               value = n.nodeValue();
411               if (value.find("MAX_WIDTH") != -1)
412            value.replace("MAX_WIDTH", QString::number(KdenliveSettings::defaultwidth()));
413               if (value.find("MID_WIDTH") != -1)
414            value.replace("MID_WIDTH", QString::number(KdenliveSettings::defaultwidth() / 2));
415               if (value.find("MAX_HEIGHT") != -1)
416            value.replace("MAX_HEIGHT", QString::number(KdenliveSettings::defaultheight()));
417               if (value.find("MID_HEIGHT") != -1)
418            value.replace("MID_HEIGHT", QString::number(KdenliveSettings::defaultheight() / 2));
419               n.setNodeValue(value);
420               i++;
421           }
422           effect->addParameter(effectDescParamFactory.createParameter(e));
423              }
424          }
425                 effectList->append(effect);
426          }*/
427     }
428 }
429
430 //static
431 const char* initEffects::ladspaEffectString(int ladspaId, QStringList params)
432 {
433     if (ladspaId == 1433)  //Pitch
434         return ladspaPitchEffectString(params);
435     else if (ladspaId == 1216)  //Room Reverb
436         return ladspaRoomReverbEffectString(params);
437     else if (ladspaId == 1423)  //Reverb
438         return ladspaReverbEffectString(params);
439     else if (ladspaId == 1901)  //Reverb
440         return ladspaEqualizerEffectString(params);
441     else {
442         kDebug() << "++++++++++  ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
443         return "<jackrack></jackrack>";
444     }
445 }
446
447 //static
448 void initEffects::ladspaEffectFile(const QString & fname, int ladspaId, QStringList params)
449 {
450     const char *filterString;
451     switch (ladspaId) {
452     case 1433: //Pitch
453         filterString = ladspaPitchEffectString(params);
454         break;
455     case 1905: //Vinyl
456         filterString = ladspaVinylEffectString(params);
457         break;
458     case 1216 : //Room Reverb
459         filterString = ladspaRoomReverbEffectString(params);
460         break;
461     case 1423: //Reverb
462         filterString = ladspaReverbEffectString(params);
463         break;
464     case 1195: //Declipper
465         filterString = ladspaDeclipEffectString(params);
466         break;
467     case 1901:  //Reverb
468         filterString = ladspaEqualizerEffectString(params);
469         break;
470     case 1913: // Limiter
471         filterString = ladspaLimiterEffectString(params);
472         break;
473     case 1193: // Pitch Shifter
474         filterString = ladspaPitchShifterEffectString(params);
475         break;
476     case 1417: // Rate Scaler
477         filterString = ladspaRateScalerEffectString(params);
478         break;
479     case 1217: // Phaser
480         filterString = ladspaPhaserEffectString(params);
481         break;
482     default:
483         kDebug() << "++++++++++  ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
484         return;
485         break;
486     }
487
488     QFile f(fname);
489     if (f.open(QIODevice::WriteOnly)) {
490         QTextStream stream(&f);
491         stream << filterString;
492         f.close();
493     } else kDebug() << "++++++++++  ERROR CANNOT WRITE TO: " << KdenliveSettings::currenttmpfolder() +  fname << endl;
494     delete [] filterString;
495 }
496
497 const QString jackString = "<?xml version=\"1.0\"?><!DOCTYPE jackrack SYSTEM \"http://purge.bash.sh/~rah/jack_rack_1.2.dtd\"><jackrack><channels>2</channels><samplerate>48000</samplerate><plugin><id>";
498
499
500 const char* initEffects::ladspaDeclipEffectString(QStringList)
501 {
502     return qstrdup(QString(jackString + "1195</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><lockall>true</lockall></plugin></jackrack>").toUtf8());
503 }
504
505 /*
506 const char* initEffects::ladspaVocoderEffectString(QStringList params)
507 {
508  return qstrdup( QString(jackString + "1441</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><lockall>true</lockall><controlrow><lock>true</lock><value>0.000000</value><value>0.000000</value></controlrow><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow><controlrow><lock>true</lock><value>%2</value><value>%2</value></controlrow><controlrow><lock>true</lock><value>%2</value><value>%2</value></controlrow><controlrow><lock>true</lock><value>%2</value><value>%2</value></controlrow><controlrow><lock>true</lock><value>%2</value><value>%2</value></controlrow><controlrow><lock>true</lock><value>%3</value><value>%3</value></controlrow><controlrow><lock>true</lock><value>%3</value><value>%3</value></controlrow><controlrow><lock>true</lock><value>%3</value><value>%3</value></controlrow><controlrow><lock>true</lock><value>%3</value><value>%3</value></controlrow><controlrow><lock>true</lock><value>%4</value><value>%4</value></controlrow><controlrow><lock>true</lock><value>%4</value><value>%4</value></controlrow><controlrow><lock>true</lock><value>%4</value><value>%4</value></controlrow><controlrow><lock>true</lock><value>%4</value><value>%4</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).arg(params[2]).arg(params[3]));
509 }*/
510
511 const char* initEffects::ladspaVinylEffectString(QStringList params)
512 {
513     return qstrdup(QString(jackString + "1905</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><controlrow><value>%1</value></controlrow><controlrow><value>%2</value></controlrow><controlrow><value>%3</value></controlrow><controlrow><value>%4</value></controlrow><controlrow><value>%5</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).arg(params[2]).arg(params[3]).arg(params[4]).toUtf8());
514 }
515
516 const char* initEffects::ladspaPitchEffectString(QStringList params)
517 {
518     return qstrdup(QString(jackString + "1433</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.0</value><value>1.0</value></wet_dry_values><lockall>true</lockall><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow><controlrow><lock>true</lock><value>4.000000</value><value>4.000000</value></controlrow></plugin></jackrack>").arg(params[0]).toUtf8());
519 }
520
521 const char* initEffects::ladspaRoomReverbEffectString(QStringList params)
522 {
523     return qstrdup(QString(jackString + "1216</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><lockall>true</lockall><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow><controlrow><lock>true</lock><value>%2</value><value>%2</value></controlrow><controlrow><lock>true</lock><value>%3</value><value>%3</value></controlrow><controlrow><lock>true</lock><value>0.750000</value><value>0.750000</value></controlrow><controlrow><lock>true</lock><value>-70.000000</value><value>-70.000000</value></controlrow><controlrow><lock>true</lock><value>0.000000</value><value>0.000000</value></controlrow><controlrow><lock>true</lock><value>-17.500000</value><value>-17.500000</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).arg(params[2]).toUtf8());
524 }
525
526 const char* initEffects::ladspaReverbEffectString(QStringList params)
527 {
528     return qstrdup(QString(jackString + "1423</id><enabled>true</enabled>  <wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked>    <wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values>    <lockall>true</lockall><controlrow><lock>true</lock><value>%1</value>      <value>%1</value></controlrow><controlrow><lock>true</lock><value>%2</value><value>%2</value></controlrow><controlrow><lock>true</lock><value>0.250000</value><value>0.250000</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).toUtf8());
529 }
530
531 const char* initEffects::ladspaEqualizerEffectString(QStringList params)
532 {
533     return qstrdup(QString(jackString + "1901</id><enabled>true</enabled>    <wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked>    <wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><controlrow><value>%1</value></controlrow><controlrow><value>%2</value></controlrow>    <controlrow><value>%3</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).arg(params[2]).toUtf8());
534 }
535
536 const char* initEffects::ladspaLimiterEffectString(QStringList params)
537 {
538     return qstrdup(QString(jackString + "1913</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><controlrow><value>%1</value></controlrow><controlrow><value>%2</value></controlrow><controlrow><value>%3</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).arg(params[2]).toUtf8());
539 }
540
541 const char* initEffects::ladspaPitchShifterEffectString(QStringList params)
542 {
543     return qstrdup(QString(jackString + "1193</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><lockall>true</lockall><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow></plugin></jackrack>").arg(params[0]).toUtf8());
544 }
545
546 const char* initEffects::ladspaRateScalerEffectString(QStringList params)
547 {
548     return qstrdup(QString(jackString + "1417</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><lockall>true</lockall><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow></plugin></jackrack>").arg(params[0]).toUtf8());
549 }
550
551 const char* initEffects::ladspaPhaserEffectString(QStringList params)
552 {
553     return qstrdup(QString(jackString + "1217</id><enabled>true</enabled><wet_dry_enabled>false</wet_dry_enabled><wet_dry_locked>true</wet_dry_locked><wet_dry_values><value>1.000000</value><value>1.000000</value></wet_dry_values><lockall>true</lockall><controlrow><lock>true</lock><value>%1</value><value>%1</value></controlrow><controlrow><lock>true</lock><value>%2</value><value>%2</value></controlrow><controlrow><lock>true</lock><value>%3</value><value>%3</value></controlrow><controlrow><lock>true</lock><value>%4</value><value>%4</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).arg(params[2]).arg(params[3]).toUtf8());
554 }
555
556
557 QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository, const QString& /*type*/, const QString& filtername)
558 {
559
560     QDomDocument ret;
561     Mlt::Properties *metadata = repository->metadata(filter_type, filtername.toAscii().data());
562     //kDebug() << filtername;
563     if (metadata && metadata->is_valid()) {
564         if (metadata->get("title") && metadata->get("identifier")) {
565             QDomElement eff = ret.createElement("effect");
566             eff.setAttribute("tag", metadata->get("identifier"));
567             eff.setAttribute("id", metadata->get("identifier"));
568
569             QDomElement name = ret.createElement("name");
570             name.appendChild(ret.createTextNode(metadata->get("title")));
571
572             QDomElement desc = ret.createElement("description");
573             desc.appendChild(ret.createTextNode(metadata->get("description")));
574
575             QDomElement author = ret.createElement("author");
576             author.appendChild(ret.createTextNode(metadata->get("creator")));
577
578             eff.appendChild(name);
579             eff.appendChild(author);
580             eff.appendChild(desc);
581
582             Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
583             for (int j = 0; param_props.is_valid() && j < param_props.count(); j++) {
584                 QDomElement params = ret.createElement("parameter");
585
586                 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(j)));
587
588                 params.setAttribute("name", paramdesc.get("identifier"));
589
590                 if (paramdesc.get("maximum")) params.setAttribute("max", paramdesc.get("maximum"));
591                 if (paramdesc.get("minimum")) params.setAttribute("min", paramdesc.get("minimum"));
592                 if (QString(paramdesc.get("type")) == "integer")
593                     params.setAttribute("type", "constant");
594                 if (QString(paramdesc.get("type")) == "float") {
595                     params.setAttribute("type", "constant");
596                     params.setAttribute("factor", "1000");
597                     if (paramdesc.get("maximum")) params.setAttribute("max", QString(paramdesc.get("maximum")).toFloat() * 1000.0);
598                     if (paramdesc.get("minimum")) params.setAttribute("min", QString(paramdesc.get("minimum")).toFloat() * 1000.0);
599                 }
600                 if (QString(paramdesc.get("type")) == "boolean")
601                     params.setAttribute("type", "bool");
602                 if (!QString(paramdesc.get("format")).isEmpty() && QString(paramdesc.get("type")) != "geometry") {
603                     params.setAttribute("type", "geometry");
604                     params.setAttribute("format", paramdesc.get("format"));
605                 }
606                 if (!QString(paramdesc.get("format")).isEmpty() && QString(paramdesc.get("type")) == "geometry") {
607                     params.setAttribute("type", "geometry");
608                     //params.setAttribute("format", paramdesc.get("format"));
609                 }
610                 if (paramdesc.get("default")) params.setAttribute("default", paramdesc.get("default"));
611                 if (paramdesc.get("value")) {
612                     params.setAttribute("value", paramdesc.get("value"));
613                 } else {
614                     params.setAttribute("value", paramdesc.get("default"));
615                 }
616
617
618                 QDomElement pname = ret.createElement("name");
619                 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
620                 params.appendChild(pname);
621
622                 eff.appendChild(params);
623             }
624             ret.appendChild(eff);
625         }
626     }
627     delete metadata;
628     metadata = 0;
629     /* QString outstr;
630      QTextStream str(&outstr);
631      ret.save(str, 2);
632      kDebug() << outstr;*/
633     return ret;
634 }
635
636 void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *transitions, QStringList names)
637 {
638     // Remove transitions that are not implemented.
639     int pos = names.indexOf("mix");
640     if (pos != -1)
641         names.takeAt(pos);
642
643     QStringList imagenamelist = QStringList() << i18n("None");
644     QStringList imagefiles = QStringList() << QString();
645     QStringList filters;
646     filters << "*.pgm" << "*.png";
647     QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
648     foreach(QString folder, customLumas) {
649         if (!folder.endsWith('/'))
650             folder.append('/');
651         QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
652         foreach(const QString & fname, filesnames) {
653             imagenamelist.append(fname);
654             imagefiles.append(folder + fname);
655         }
656     }
657
658     // Check for MLT luma files.
659     KUrl folder(mlt_environment("MLT_DATA"));
660     folder.addPath("lumas");
661     folder.addPath(mlt_environment("MLT_NORMALISATION"));
662     QDir lumafolder(folder.path());
663     QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
664     foreach(const QString & fname, filesnames) {
665         imagenamelist.append(fname);
666         KUrl path(folder);
667         path.addPath(fname);
668         imagefiles.append(path.toLocalFile());
669     }
670
671     foreach(const QString & name, names) {
672         QDomDocument ret;
673         QDomElement ktrans = ret.createElement("ktransition");
674         ret.appendChild(ktrans);
675         ktrans.setAttribute("tag", name);
676
677         QDomElement tname = ret.createElement("name");
678         QDomElement desc = ret.createElement("description");
679         ktrans.appendChild(tname);
680         ktrans.appendChild(desc);
681         Mlt::Properties *metadata = repository->metadata(transition_type, name.toUtf8().data());
682         if (metadata && metadata->is_valid()) {
683             // If possible, set name and description.
684             if (metadata->get("title") && metadata->get("identifier"))
685                 tname.appendChild(ret.createTextNode(metadata->get("title")));
686             desc.appendChild(ret.createTextNode(metadata->get("description")));
687
688             Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
689             for (int i = 0; param_props.is_valid() && i < param_props.count(); ++i) {
690                 QDomElement params = ret.createElement("parameter");
691
692                 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(i)));
693
694                 params.setAttribute("name", paramdesc.get("identifier"));
695
696                 if (paramdesc.get("maximum"))
697                     params.setAttribute("max", paramdesc.get("maximum"));
698                 if (paramdesc.get("minimum"))
699                     params.setAttribute("min", paramdesc.get("minimum"));
700                 if (QString(paramdesc.get("type")) == "integer") {
701                     params.setAttribute("type", "constant");
702                     params.setAttribute("factor", "100");
703                 }
704                 if (QString(paramdesc.get("type")) == "boolean")
705                     params.setAttribute("type", "bool");
706                 if (!QString(paramdesc.get("format")).isEmpty()) {
707                     params.setAttribute("type", "complex");
708                     params.setAttribute("format", paramdesc.get("format"));
709                 }
710                 if (paramdesc.get("default"))
711                     params.setAttribute("default", paramdesc.get("default"));
712                 if (paramdesc.get("value"))
713                     params.setAttribute("value", paramdesc.get("value"));
714                 else
715                     params.setAttribute("value", paramdesc.get("default"));
716
717                 QDomElement pname = ret.createElement("name");
718                 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
719                 params.appendChild(pname);
720                 ktrans.appendChild(params);
721             }
722             delete metadata;
723             metadata = 0;
724         } else {
725             /*
726              * Check for Kdenlive installed luma files, add empty string at
727              * start for no luma file.
728              */
729
730             // Implement default transitions.
731             QList<QDomElement> paramList;
732             if (name == "luma") {
733                 ktrans.setAttribute("id", name);
734                 tname.appendChild(ret.createTextNode(i18n("Wipe")));
735                 desc.appendChild(ret.createTextNode(i18n("Applies a stationary transition between the current and next frames.")));
736
737                 paramList.append(quickParameterFill(ret, i18n("Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
738                 paramList.append(quickParameterFill(ret, i18n("Invert"), "invert", "bool", "0", "0", "1"));
739                 paramList.append(quickParameterFill(ret, i18n("Image File"), "resource", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
740                 paramList.append(quickParameterFill(ret, i18n("Reverse Transition"), "reverse", "bool", "0", "0", "1"));
741                 //thumbnailer.prepareThumbnailsCall(imagelist);
742             } else if (name == "composite") {
743                 ktrans.setAttribute("id", name);
744                 tname.appendChild(ret.createTextNode(i18n("Composite")));
745                 desc.appendChild(ret.createTextNode(i18n("A key-framable alpha-channel compositor for two frames.")));
746                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0%,0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
747                 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "operator", "list", "over", "", "", "over,and,or,xor", "over,and,or,xor"));
748                 paramList.append(quickParameterFill(ret, i18n("Align"), "aligned", "bool", "1", "0", "1"));
749                 paramList.append(quickParameterFill(ret, i18n("Fill"), "fill", "bool", "1", "0", "1"));
750                 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
751                 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "luma", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
752                 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
753                 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "luma_invert", "bool", "0", "0", "1"));
754                 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "progressive", "bool", "1", "0", "1"));
755                 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "deinterlace", "bool", "0", "0", "1"));
756             } else if (name == "affine") {
757                 tname.appendChild(ret.createTextNode(i18n("Affine")));
758                 paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "double", "0", "0", "360"));
759                 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "double", "0", "0", "360"));
760                 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "double", "0", "0", "360"));
761                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Y"), "fix_rotate_y", "double", "0", "0", "360"));
762                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate X"), "fix_rotate_x", "double", "0", "0", "360"));
763                 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Z"), "fix_rotate_z", "double", "0", "0", "360"));
764                 paramList.append(quickParameterFill(ret, i18n("Shear Y"), "shear_y", "double", "0", "0", "360"));
765                 paramList.append(quickParameterFill(ret, i18n("Shear X"), "shear_x", "double", "0", "0", "360"));
766                 paramList.append(quickParameterFill(ret, i18n("Shear Z"), "shear_z", "double", "0", "0", "360"));
767                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
768                 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
769                 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));
770                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry",  "0,0,100%,100%,100%", "0,0,100%,100%,100%", "0,0,100%,100%,100%", "", "", "", "", "", "false"));
771             } else if (name == "mix") {
772                 tname.appendChild(ret.createTextNode(i18n("Mix")));
773             } else if (name == "region") {
774                 ktrans.setAttribute("id", name);
775                 tname.appendChild(ret.createTextNode(i18n("Region")));
776                 desc.appendChild(ret.createTextNode(i18n("Use alpha channel of another clip to create a transition.")));
777                 paramList.append(quickParameterFill(ret, i18n("Transparency clip"), "resource", "url", "", "", "", "", "", ""));
778                 paramList.append(quickParameterFill(ret, i18n("Geometry"), "composite.geometry", "geometry", "0%,0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
779                 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "composite.operator", "list", "over", "", "", "over,and,or,xor", "over,and,or,xor"));
780                 paramList.append(quickParameterFill(ret, i18n("Align"), "composite.aligned", "bool", "1", "0", "1"));
781                 paramList.append(quickParameterFill(ret, i18n("Fill"), "composite.fill", "bool", "1", "0", "1"));
782                 paramList.append(quickParameterFill(ret, i18n("Distort"), "composite.distort", "bool", "0", "0", "1"));
783                 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "composite.luma", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
784                 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "composite.softness", "double", "0", "0", "100", "", "", "100"));
785                 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "composite.luma_invert", "bool", "0", "0", "1"));
786                 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "composite.progressive", "bool", "1", "0", "1"));
787                 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "composite.deinterlace", "bool", "0", "0", "1"));
788             }
789             foreach(const QDomElement & e, paramList)
790             ktrans.appendChild(e);
791         }
792
793         // Add the transition to the global list.
794         transitions->append(ret.documentElement());
795         //kDebug() << ret.toString();
796     }
797
798     // Add some virtual transitions.
799     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>" + i18n("Invert") + "</name></parameter></ktransition>";
800     QDomDocument ret;
801     ret.setContent(slidetrans);
802     transitions->append(ret.documentElement());
803
804     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>";
805     ret.setContent(dissolve);
806     transitions->append(ret.documentElement());
807
808     /*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>";
809     ret.setContent(alphatrans);
810     transitions->append(ret.documentElement());*/
811 }
812
813 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)
814 {
815     QDomElement parameter = doc.createElement("parameter");
816     parameter.setAttribute("tag", tag);
817     parameter.setAttribute("default", def);
818     parameter.setAttribute("type", type);
819     parameter.setAttribute("name", tag);
820     parameter.setAttribute("max", max);
821     parameter.setAttribute("min", min);
822     if (!list.isEmpty())
823         parameter.setAttribute("paramlist", list);
824     if (!listdisplaynames.isEmpty())
825         parameter.setAttribute("paramlistdisplay", listdisplaynames);
826     if (!factor.isEmpty())
827         parameter.setAttribute("factor", factor);
828     if (!namedesc.isEmpty())
829         parameter.setAttribute("namedesc", namedesc);
830     if (!format.isEmpty())
831         parameter.setAttribute("format", format);
832     if (!opacity.isEmpty())
833         parameter.setAttribute("opacity", opacity);
834     QDomElement pname = doc.createElement("name");
835     pname.appendChild(doc.createTextNode(name));
836     parameter.appendChild(pname);
837
838     return parameter;
839 }