1 /***************************************************************************
2 initeffects.cpp - description
5 copyright : (C) 2006 by Jean-Baptiste Mardelle
7 copyright : (C) 2008 Marco Gittler
8 email : g.marco@freenet.de
9 ***************************************************************************/
11 /***************************************************************************
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. *
18 ***************************************************************************/
20 #include "initeffects.h"
21 #include "kdenlivesettings.h"
22 #include "effectslist.h"
23 #include "effectstackedit.h"
24 #include "mainwindow.h"
28 #include <KStandardDirs>
35 initEffectsThumbnailer::initEffectsThumbnailer() :
40 void initEffectsThumbnailer::prepareThumbnailsCall(const QStringList& list)
47 void initEffectsThumbnailer::run()
49 foreach(const QString &entry, m_list) {
51 if (!entry.isEmpty() && (entry.endsWith(".png") || entry.endsWith(".pgm"))) {
52 if (!EffectStackEdit::iconCache.contains(entry)) {
55 EffectStackEdit::iconCache[entry] = pix.scaled(30, 30);
62 initEffectsThumbnailer initEffects::thumbnailer;
65 void initEffects::refreshLumas()
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();
71 filters << "*.pgm" << "*.png";
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);
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);
92 imagefiles.append(path.toLocalFile());
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(","));
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(","));
118 Mlt::Repository *initEffects::parseEffectFiles()
120 QStringList::Iterator more;
121 QStringList::Iterator it;
122 QStringList fileList;
125 Mlt::Repository *repository = Mlt::Factory::init();
127 kDebug() << "Repository didn't finish initialisation" ;
131 // Retrieve the list of MLT's available effects.
132 Mlt::Properties *filters = repository->filters();
133 QStringList filtersList;
134 for (int i = 0; i < filters->count(); ++i)
135 filtersList << filters->get_name(i);
138 // Retrieve the list of available producers.
139 Mlt::Properties *producers = repository->producers();
140 QStringList producersList;
141 for (int i = 0; i < producers->count(); ++i)
142 producersList << producers->get_name(i);
143 KdenliveSettings::setProducerslist(producersList);
146 // Retrieve the list of available transitions.
147 Mlt::Properties *transitions = repository->transitions();
148 QStringList transitionsItemList;
149 for (int i = 0; i < transitions->count(); ++i)
150 transitionsItemList << transitions->get_name(i);
153 // Remove blacklisted transitions from the list.
154 QFile file(KStandardDirs::locate("appdata", "blacklisted_transitions.txt"));
155 if (file.open(QIODevice::ReadOnly)) {
156 QTextStream in(&file);
157 while (!in.atEnd()) {
158 QString black = in.readLine().simplified();
159 if (!black.isEmpty() && !black.startsWith('#') &&
160 transitionsItemList.contains(black))
161 transitionsItemList.removeAll(black);
166 // Fill transitions list.
167 fillTransitionsList(repository, &MainWindow::transitions, transitionsItemList);
169 // Set the directories to look into for ladspa plugins.
170 KGlobal::dirs()->addResourceType("ladspa_plugin", 0, "lib/ladspa");
171 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/lib/ladspa");
172 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/local/lib/ladspa");
173 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/opt/lib/ladspa");
174 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/opt/local/lib/ladspa");
175 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/lib64/ladspa");
176 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/local/lib64/ladspa");
178 // Set the directories to look into for effects.
179 QStringList direc = KGlobal::dirs()->findDirs("appdata", "effects");
181 // Iterate through effects directories to parse all XML files.
182 for (more = direc.begin(); more != direc.end(); ++more) {
183 QDir directory(*more);
186 fileList = directory.entryList(filter, QDir::Files);
187 for (it = fileList.begin(); it != fileList.end(); ++it) {
188 itemName = KUrl(*more + *it).path();
189 parseEffectFile(&MainWindow::customEffects,
190 &MainWindow::audioEffects,
191 &MainWindow::videoEffects,
192 itemName, filtersList, producersList);
196 // Remove blacklisted effects from the filters list.
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 filtersList.contains(black))
204 filtersList.removeAll(black);
210 * Cleanup the global lists. We use QMap because of its automatic sorting
211 * (by key) and key uniqueness (using insert() instead of insertMulti()).
212 * This introduces some more cycles (while removing them from other parts of
213 * the code and centralising them), but due to the way this methods, QMap
214 * and EffectsList are implemented, there's no easy way to make it
215 * differently without reinplementing something (which should really be
218 QDomElement effectInfo;
219 QMap<QString, QDomElement> effectsMap;
220 for (int i = 0; i < MainWindow::transitions.count(); ++i) {
221 effectInfo = MainWindow::transitions.at(i);
222 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
224 MainWindow::transitions.clearList();
225 foreach(const QDomElement &effect, effectsMap)
226 MainWindow::transitions.append(effect);
228 for (int i = 0; i < MainWindow::customEffects.count(); ++i) {
229 effectInfo = MainWindow::customEffects.at(i);
230 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
232 MainWindow::customEffects.clearList();
233 foreach(const QDomElement &effect, effectsMap)
234 MainWindow::customEffects.append(effect);
236 for (int i = 0; i < MainWindow::audioEffects.count(); ++i) {
237 effectInfo = MainWindow::audioEffects.at(i);
238 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
240 MainWindow::audioEffects.clearList();
241 foreach(const QDomElement &effect, effectsMap)
242 MainWindow::audioEffects.append(effect);
244 for (int i = 0; i < MainWindow::videoEffects.count(); ++i) {
245 effectInfo = MainWindow::videoEffects.at(i);
246 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
248 // Add remaining filters to the list of video effects.
249 foreach(const QString &filtername, filtersList) {
250 QDomDocument doc = createDescriptionFromMlt(repository, "filters", filtername);
252 effectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
254 MainWindow::videoEffects.clearList();
255 foreach(const QDomElement &effect, effectsMap)
256 MainWindow::videoEffects.append(effect);
262 void initEffects::parseCustomEffectsFile()
264 MainWindow::customEffects.clearList();
266 * Why a QMap? See parseEffectFiles(). It's probably useless here, but we
267 * cannot be sure about it.
269 QMap<QString, QDomElement> effectsMap;
270 QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
271 QDir directory = QDir(path);
274 const QStringList fileList = directory.entryList(filter, QDir::Files);
276 * We need to declare these variables outside the foreach, or the QMap will
277 * refer to non existing variables (QMap::insert() takes references as
281 QDomNodeList effects;
283 foreach(const QString &filename, fileList) {
284 QString itemName = KUrl(path + filename).path();
285 QFile file(itemName);
286 doc.setContent(&file, false);
288 effects = doc.elementsByTagName("effect");
289 if (effects.count() != 1) {
290 kDebug() << "More than one effect in file " << itemName << ", not supported yet";
292 e = effects.item(0).toElement();
293 effectsMap.insert(e.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), e);
296 foreach(const QDomElement &effect, effectsMap)
297 MainWindow::customEffects.append(effect);
301 void initEffects::parseEffectFile(EffectsList *customEffectList, EffectsList *audioEffectList, EffectsList *videoEffectList, QString name, QStringList filtersList, QStringList producersList)
305 doc.setContent(&file, false);
307 QDomElement documentElement = doc.documentElement();
308 QDomNodeList effects = doc.elementsByTagName("effect");
310 if (effects.count() == 0) {
311 kDebug() << "Effect broken: " << name;
316 if (doc.elementsByTagName("effectgroup").item(0).toElement().tagName() == "effectgroup")
317 groupName = documentElement.attribute("name", QString());*/
319 for (int i = 0; !effects.item(i).isNull(); ++i) {
320 documentElement = effects.item(i).toElement();
321 QString tag = documentElement.attribute("tag", QString());
322 bool ladspaOk = true;
323 if (tag == "ladspa") {
324 QString library = documentElement.attribute("library", QString());
325 if (KStandardDirs::locate("ladspa_plugin", library).isEmpty()) ladspaOk = false;
328 // Parse effect information.
329 if ((filtersList.contains(tag) || producersList.contains(tag)) && ladspaOk) {
330 QString type = documentElement.attribute("type", QString());
332 audioEffectList->append(documentElement);
333 else if (type == "custom")
334 customEffectList->append(documentElement);
336 videoEffectList->append(documentElement);
340 QDomNode n = documentElement.firstChild();
341 QString id, effectName, effectTag, paramType;
346 EffectParamDescFactory effectDescParamFactory;
347 EffectDesc *effect = NULL;
350 QDomNode namenode = documentElement.elementsByTagName("name").item(0);
351 if (!namenode.isNull()) effectName = i18n(namenode.toElement().text());
352 if (!groupName.isEmpty()) effectName.prepend("_" + groupName + "_");
354 QDomNode propsnode = documentElement.elementsByTagName("properties").item(0);
355 if (!propsnode.isNull()) {
356 QDomElement propselement = propsnode.toElement();
357 id = propselement.attribute("id", QString());
358 effectTag = propselement.attribute("tag", QString());
359 if (propselement.attribute("type", QString()) == "audio") type = AUDIOEFFECT;
360 else if (propselement.attribute("type", QString()) == "custom") type = CUSTOMEFFECT;
361 else type = VIDEOEFFECT;
364 QString effectDescription;
365 QDomNode descnode = documentElement.elementsByTagName("description").item(0);
366 if (!descnode.isNull()) effectDescription = descnode.toElement().text() + "<br />";
368 QString effectAuthor;
369 QDomNode authnode = documentElement.elementsByTagName("author").item(0);
370 if (!authnode.isNull()) effectAuthor = authnode.toElement().text() + "<br />";
372 if (effectName.isEmpty() || id.isEmpty() || effectTag.isEmpty()) return;
374 effect = new EffectDesc(effectName, id, effectTag, effectDescription, effectAuthor, type);
376 QDomNodeList paramList = documentElement.elementsByTagName("parameter");
377 if (paramList.count() == 0) {
378 QDomElement fixed = doc.createElement("parameter");
379 fixed.setAttribute("type", "fixed");
380 effect->addParameter(effectDescParamFactory.createParameter(fixed));
382 else for (int i = 0; i < paramList.count(); i++) {
383 QDomElement e = paramList.item(i).toElement();
386 QDomNamedNodeMap attrs = e.attributes();
389 while (!attrs.item(i).isNull()) {
390 QDomNode n = attrs.item(i);
391 value = n.nodeValue();
392 if (value.find("MAX_WIDTH") != -1)
393 value.replace("MAX_WIDTH", QString::number(KdenliveSettings::defaultwidth()));
394 if (value.find("MID_WIDTH") != -1)
395 value.replace("MID_WIDTH", QString::number(KdenliveSettings::defaultwidth() / 2));
396 if (value.find("MAX_HEIGHT") != -1)
397 value.replace("MAX_HEIGHT", QString::number(KdenliveSettings::defaultheight()));
398 if (value.find("MID_HEIGHT") != -1)
399 value.replace("MID_HEIGHT", QString::number(KdenliveSettings::defaultheight() / 2));
400 n.setNodeValue(value);
403 effect->addParameter(effectDescParamFactory.createParameter(e));
406 effectList->append(effect);
412 const char* initEffects::ladspaEffectString(int ladspaId, QStringList params)
414 if (ladspaId == 1433) //Pitch
415 return ladspaPitchEffectString(params);
416 else if (ladspaId == 1216) //Room Reverb
417 return ladspaRoomReverbEffectString(params);
418 else if (ladspaId == 1423) //Reverb
419 return ladspaReverbEffectString(params);
420 else if (ladspaId == 1901) //Reverb
421 return ladspaEqualizerEffectString(params);
423 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
424 return "<jackrack></jackrack>";
429 void initEffects::ladspaEffectFile(const QString & fname, int ladspaId, QStringList params)
431 const char *filterString;
434 filterString = ladspaPitchEffectString(params);
437 filterString = ladspaVinylEffectString(params);
439 case 1216 : //Room Reverb
440 filterString = ladspaRoomReverbEffectString(params);
443 filterString = ladspaReverbEffectString(params);
445 case 1195: //Declipper
446 filterString = ladspaDeclipEffectString(params);
449 filterString = ladspaEqualizerEffectString(params);
451 case 1913: // Limiter
452 filterString = ladspaLimiterEffectString(params);
454 case 1193: // Pitch Shifter
455 filterString = ladspaPitchShifterEffectString(params);
457 case 1417: // Rate Scaler
458 filterString = ladspaRateScalerEffectString(params);
461 filterString = ladspaPhaserEffectString(params);
464 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
470 if (f.open(QIODevice::WriteOnly)) {
471 QTextStream stream(&f);
472 stream << filterString;
474 } else kDebug() << "++++++++++ ERROR CANNOT WRITE TO: " << KdenliveSettings::currenttmpfolder() + fname << endl;
475 delete [] filterString;
478 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>";
481 const char* initEffects::ladspaDeclipEffectString(QStringList)
483 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());
487 const char* initEffects::ladspaVocoderEffectString(QStringList params)
489 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]));
492 const char* initEffects::ladspaVinylEffectString(QStringList params)
494 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());
497 const char* initEffects::ladspaPitchEffectString(QStringList params)
499 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());
502 const char* initEffects::ladspaRoomReverbEffectString(QStringList params)
504 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());
507 const char* initEffects::ladspaReverbEffectString(QStringList params)
509 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());
512 const char* initEffects::ladspaEqualizerEffectString(QStringList params)
514 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());
517 const char* initEffects::ladspaLimiterEffectString(QStringList params)
519 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());
522 const char* initEffects::ladspaPitchShifterEffectString(QStringList params)
524 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());
527 const char* initEffects::ladspaRateScalerEffectString(QStringList params)
529 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());
532 const char* initEffects::ladspaPhaserEffectString(QStringList params)
534 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());
538 QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository, const QString& /*type*/, const QString& filtername)
542 Mlt::Properties *metadata = repository->metadata(filter_type, filtername.toAscii().data());
543 //kDebug() << filtername;
544 if (metadata && metadata->is_valid()) {
545 if (metadata->get("title") && metadata->get("identifier")) {
546 QDomElement eff = ret.createElement("effect");
547 eff.setAttribute("tag", metadata->get("identifier"));
548 eff.setAttribute("id", metadata->get("identifier"));
550 QDomElement name = ret.createElement("name");
551 name.appendChild(ret.createTextNode(metadata->get("title")));
553 QDomElement desc = ret.createElement("description");
554 desc.appendChild(ret.createTextNode(metadata->get("description")));
556 QDomElement author = ret.createElement("author");
557 author.appendChild(ret.createTextNode(metadata->get("creator")));
559 eff.appendChild(name);
560 eff.appendChild(author);
561 eff.appendChild(desc);
563 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
564 for (int j = 0; param_props.is_valid() && j < param_props.count(); j++) {
565 QDomElement params = ret.createElement("parameter");
567 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(j)));
569 params.setAttribute("name", paramdesc.get("identifier"));
571 if (paramdesc.get("maximum")) params.setAttribute("max", paramdesc.get("maximum"));
572 if (paramdesc.get("minimum")) params.setAttribute("min", paramdesc.get("minimum"));
573 if (QString(paramdesc.get("type")) == "integer")
574 params.setAttribute("type", "constant");
575 if (QString(paramdesc.get("type")) == "float") {
576 params.setAttribute("type", "constant");
577 params.setAttribute("factor", "1000");
578 if (paramdesc.get("maximum")) params.setAttribute("max", QString(paramdesc.get("maximum")).toFloat()*1000.0);
579 if (paramdesc.get("minimum")) params.setAttribute("min", QString(paramdesc.get("minimum")).toFloat()*1000.0);
581 if (QString(paramdesc.get("type")) == "boolean")
582 params.setAttribute("type", "bool");
583 if (!QString(paramdesc.get("format")).isEmpty() && QString(paramdesc.get("type")) != "geometry") {
584 params.setAttribute("type", "geometry");
585 params.setAttribute("format", paramdesc.get("format"));
587 if (!QString(paramdesc.get("format")).isEmpty() && QString(paramdesc.get("type")) == "geometry") {
588 params.setAttribute("type", "geometry");
589 //params.setAttribute("format", paramdesc.get("format"));
591 if (paramdesc.get("default")) params.setAttribute("default", paramdesc.get("default"));
592 if (paramdesc.get("value")) {
593 params.setAttribute("value", paramdesc.get("value"));
595 params.setAttribute("value", paramdesc.get("default"));
599 QDomElement pname = ret.createElement("name");
600 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
601 params.appendChild(pname);
603 eff.appendChild(params);
605 ret.appendChild(eff);
611 QTextStream str(&outstr);
613 kDebug() << outstr;*/
617 void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *transitions, QStringList names)
619 // Remove transitions that are not implemented.
620 int pos = names.indexOf("mix");
623 pos = names.indexOf("region");
627 foreach(const QString &name, names) {
629 QDomElement ktrans = ret.createElement("ktransition");
630 ret.appendChild(ktrans);
631 ktrans.setAttribute("tag", name);
633 QDomElement tname = ret.createElement("name");
634 QDomElement desc = ret.createElement("description");
635 ktrans.appendChild(tname);
636 ktrans.appendChild(desc);
638 Mlt::Properties *metadata = repository->metadata(transition_type, name.toUtf8().data());
639 if (metadata && metadata->is_valid()) {
640 // If possible, set name and description.
641 if (metadata->get("title") && metadata->get("identifier"))
642 tname.appendChild(ret.createTextNode(metadata->get("title")));
643 desc.appendChild(ret.createTextNode(metadata->get("description")));
645 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
646 for (int i = 0; param_props.is_valid() && i < param_props.count(); ++i) {
647 QDomElement params = ret.createElement("parameter");
649 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(i)));
651 params.setAttribute("name", paramdesc.get("identifier"));
653 if (paramdesc.get("maximum"))
654 params.setAttribute("max", paramdesc.get("maximum"));
655 if (paramdesc.get("minimum"))
656 params.setAttribute("min", paramdesc.get("minimum"));
657 if (QString(paramdesc.get("type")) == "integer") {
658 params.setAttribute("type", "constant");
659 params.setAttribute("factor", "100");
661 if (QString(paramdesc.get("type")) == "boolean")
662 params.setAttribute("type", "bool");
663 if (!QString(paramdesc.get("format")).isEmpty()) {
664 params.setAttribute("type", "complex");
665 params.setAttribute("format", paramdesc.get("format"));
667 if (paramdesc.get("default"))
668 params.setAttribute("default", paramdesc.get("default"));
669 if (paramdesc.get("value"))
670 params.setAttribute("value", paramdesc.get("value"));
672 params.setAttribute("value", paramdesc.get("default"));
674 QDomElement pname = ret.createElement("name");
675 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
676 params.appendChild(pname);
677 ktrans.appendChild(params);
683 * Check for Kdenlive installed luma files, add empty string at
684 * start for no luma file.
686 QStringList imagenamelist = QStringList() << i18n("None");
687 QStringList imagefiles = QStringList() << QString();
689 filters << "*.pgm" << "*.png";
690 QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
691 foreach(QString folder, customLumas) {
692 if (!folder.endsWith('/'))
694 QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
695 foreach(const QString &fname, filesnames) {
696 imagenamelist.append(fname);
697 imagefiles.append(folder + fname);
701 // Check for MLT luma files.
702 KUrl folder(mlt_environment("MLT_DATA"));
703 folder.addPath("lumas");
704 folder.addPath(mlt_environment("MLT_NORMALISATION"));
705 QDir lumafolder(folder.path());
706 QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
707 foreach(const QString &fname, filesnames) {
708 imagenamelist.append(fname);
711 imagefiles.append(path.toLocalFile());
714 // Implement default transitions.
715 QList<QDomElement> paramList;
716 if (name == "luma") {
717 ktrans.setAttribute("id", name);
718 tname.appendChild(ret.createTextNode(i18n("Wipe")));
719 desc.appendChild(ret.createTextNode(i18n("Applies a stationary transition between the current and next frames.")));
721 paramList.append(quickParameterFill(ret, i18n("Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
722 paramList.append(quickParameterFill(ret, i18n("Invert"), "invert", "bool", "0", "0", "1"));
723 paramList.append(quickParameterFill(ret, i18n("Image File"), "resource", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
724 paramList.append(quickParameterFill(ret, i18n("Reverse Transition"), "reverse", "bool", "0", "0", "1"));
725 //thumbnailer.prepareThumbnailsCall(imagelist);
726 } else if (name == "composite") {
727 ktrans.setAttribute("id", name);
728 tname.appendChild(ret.createTextNode(i18n("Composite")));
729 desc.appendChild(ret.createTextNode(i18n("A key-framable alpha-channel compositor for two frames.")));
730 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0%,0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
731 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "operator", "list", "over", "", "", "over,and,or,xor", "over,and,or,xor"));
732 paramList.append(quickParameterFill(ret, i18n("Align"), "aligned", "bool", "1", "0", "1"));
733 paramList.append(quickParameterFill(ret, i18n("Fill"), "fill", "bool", "1", "0", "1"));
734 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
735 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "luma", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
736 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
737 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "luma_invert", "bool", "0", "0", "1"));
738 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "progressive", "bool", "1", "0", "1"));
739 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "deinterlace", "bool", "0", "0", "1"));
740 } else if (name == "affine") {
741 tname.appendChild(ret.createTextNode(i18n("Affine")));
742 paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "double", "0", "0", "360"));
743 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "double", "0", "0", "360"));
744 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "double", "0", "0", "360"));
745 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Y"), "fix_rotate_y", "double", "0", "0", "360"));
746 paramList.append(quickParameterFill(ret, i18n("Fix Rotate X"), "fix_rotate_x", "double", "0", "0", "360"));
747 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Z"), "fix_rotate_z", "double", "0", "0", "360"));
748 paramList.append(quickParameterFill(ret, i18n("Shear Y"), "shear_y", "double", "0", "0", "360"));
749 paramList.append(quickParameterFill(ret, i18n("Shear X"), "shear_x", "double", "0", "0", "360"));
750 paramList.append(quickParameterFill(ret, i18n("Shear Z"), "shear_z", "double", "0", "0", "360"));
751 paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
752 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
753 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));
754 paramList.append(quickParameterFill(ret, i18n("Mirror"), "mirror_off", "bool", "0", "0", "1"));
755 paramList.append(quickParameterFill(ret, i18n("Repeat"), "repeat_off", "bool", "0", "0", "1"));
756 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0,0,100%,100%,100%", "0,0,100%,100%,100%", "0,0,100%,100%,100%", "", "", "", "", "", "false"));
757 } else if (name == "mix") {
758 tname.appendChild(ret.createTextNode(i18n("Mix")));
759 } else if (name == "region") {
760 tname.appendChild(ret.createTextNode(i18n("Region")));
762 foreach(const QDomElement &e, paramList)
763 ktrans.appendChild(e);
766 // Add the transition to the global list.
767 transitions->append(ret.documentElement());
768 //kDebug() << ret.toString();
771 // Add some virtual transitions.
772 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>";
774 ret.setContent(slidetrans);
775 transitions->append(ret.documentElement());
777 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>";
778 ret.setContent(dissolve);
779 transitions->append(ret.documentElement());
781 /*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>";
782 ret.setContent(alphatrans);
783 transitions->append(ret.documentElement());*/
786 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)
788 QDomElement parameter = doc.createElement("parameter");
789 parameter.setAttribute("tag", tag);
790 parameter.setAttribute("default", def);
791 parameter.setAttribute("type", type);
792 parameter.setAttribute("name", tag);
793 parameter.setAttribute("max", max);
794 parameter.setAttribute("min", min);
796 parameter.setAttribute("paramlist", list);
797 if (!listdisplaynames.isEmpty())
798 parameter.setAttribute("paramlistdisplay", listdisplaynames);
799 if (!factor.isEmpty())
800 parameter.setAttribute("factor", factor);
801 if (!namedesc.isEmpty())
802 parameter.setAttribute("namedesc", namedesc);
803 if (!format.isEmpty())
804 parameter.setAttribute("format", format);
805 if (!opacity.isEmpty())
806 parameter.setAttribute("opacity", opacity);
807 QDomElement pname = doc.createElement("name");
808 pname.appendChild(doc.createTextNode(name));
809 parameter.appendChild(pname);