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 QDomDocument initEffects::getUsedCustomEffects(QMap <QString, QString> effectids)
120 QMapIterator<QString, QString> i(effectids);
123 QDomElement list = doc.createElement("customeffects");
124 doc.appendChild(list);
125 while (i.hasNext()) {
127 ix = MainWindow::customEffects.hasEffect(i.value(), i.key());
129 QDomElement e = MainWindow::customEffects.at(ix);
130 list.appendChild(doc.importNode(e, true));
137 Mlt::Repository *initEffects::parseEffectFiles()
139 QStringList::Iterator more;
140 QStringList::Iterator it;
141 QStringList fileList;
144 Mlt::Repository *repository = Mlt::Factory::init();
146 kDebug() << "Repository didn't finish initialisation" ;
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);
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);
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);
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);
185 // Fill transitions list.
186 fillTransitionsList(repository, &MainWindow::transitions, transitionsItemList);
188 //WARNING: deprecated, we now use MLT to detect LADSPA filters
190 // Set the directories to look into for ladspa plugins.
191 KGlobal::dirs()->addResourceType("ladspa_plugin", 0, "lib/ladspa");
192 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/lib/ladspa");
193 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/local/lib/ladspa");
194 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/opt/lib/ladspa");
195 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/opt/local/lib/ladspa");
196 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/lib64/ladspa");
197 KGlobal::dirs()->addResourceDir("ladspa_plugin", "/usr/local/lib64/ladspa");*/
199 // Remove blacklisted effects from the filters list.
200 QFile file2(KStandardDirs::locate("appdata", "blacklisted_effects.txt"));
201 if (file2.open(QIODevice::ReadOnly)) {
202 QTextStream in(&file2);
203 while (!in.atEnd()) {
204 QString black = in.readLine().simplified();
205 if (!black.isEmpty() && !black.startsWith('#') &&
206 filtersList.contains(black))
207 filtersList.removeAll(black);
213 * Cleanup the global lists. We use QMap because of its automatic sorting
214 * (by key) and key uniqueness (using insert() instead of insertMulti()).
215 * This introduces some more cycles (while removing them from other parts of
216 * the code and centralising them), but due to the way this methods, QMap
217 * and EffectsList are implemented, there's no easy way to make it
218 * differently without reinplementing something (which should really be
221 QDomElement effectInfo;
222 QMap<QString, QDomElement> effectsMap;
223 QMap<QString, QDomElement> videoEffectsMap;
224 QMap<QString, QDomElement> audioEffectsMap;
226 // Create transitions
227 for (int i = 0; i < MainWindow::transitions.count(); ++i) {
228 effectInfo = MainWindow::transitions.at(i);
229 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
231 MainWindow::transitions.clearList();
232 foreach(const QDomElement & effect, effectsMap)
233 MainWindow::transitions.append(effect);
236 // Create effects from MLT
237 foreach(const QString & filtername, filtersList) {
238 QDomDocument doc = createDescriptionFromMlt(repository, "filters", filtername);
239 //WARNING: TEMPORARY FIX for empty MLT effects descriptions - disable effects without parameters - jbm 09-06-2011
240 if (!doc.isNull() && doc.elementsByTagName("parameter").count() > 0) {
241 if (doc.documentElement().attribute("type") == "audio") {
242 audioEffectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
245 videoEffectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
249 // Set the directories to look into for effects.
250 QStringList direc = KGlobal::dirs()->findDirs("appdata", "effects");
251 // Iterate through effects directories to parse all XML files.
252 for (more = direc.begin(); more != direc.end(); ++more) {
253 QDir directory(*more);
256 fileList = directory.entryList(filter, QDir::Files);
257 for (it = fileList.begin(); it != fileList.end(); ++it) {
258 itemName = KUrl(*more + *it).path();
259 parseEffectFile(&MainWindow::customEffects,
260 &MainWindow::audioEffects,
261 &MainWindow::videoEffects,
262 itemName, filtersList, producersList, repository);
266 // Create custom effects
267 for (int i = 0; i < MainWindow::customEffects.count(); ++i) {
268 effectInfo = MainWindow::customEffects.at(i);
269 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
271 MainWindow::customEffects.clearList();
272 foreach(const QDomElement & effect, effectsMap)
273 MainWindow::customEffects.append(effect);
276 // Create audio effects
277 for (int i = 0; i < MainWindow::audioEffects.count(); ++i) {
278 effectInfo = MainWindow::audioEffects.at(i);
279 audioEffectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
281 MainWindow::audioEffects.clearList();
282 foreach(const QDomElement & effect, audioEffectsMap)
283 MainWindow::audioEffects.append(effect);
285 // Create video effects
286 for (int i = 0; i < MainWindow::videoEffects.count(); ++i) {
287 effectInfo = MainWindow::videoEffects.at(i);
288 videoEffectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
290 MainWindow::videoEffects.clearList();
291 foreach(const QDomElement & effect, videoEffectsMap)
292 MainWindow::videoEffects.append(effect);
298 void initEffects::parseCustomEffectsFile()
300 MainWindow::customEffects.clearList();
302 * Why a QMap? See parseEffectFiles(). It's probably useless here, but we
303 * cannot be sure about it.
305 QMap<QString, QDomElement> effectsMap;
306 QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
307 QDir directory = QDir(path);
310 const QStringList fileList = directory.entryList(filter, QDir::Files);
312 * We need to declare these variables outside the foreach, or the QMap will
313 * refer to non existing variables (QMap::insert() takes references as
317 QDomNodeList effects;
319 foreach(const QString & filename, fileList) {
320 QString itemName = KUrl(path + filename).path();
321 QFile file(itemName);
322 doc.setContent(&file, false);
324 effects = doc.elementsByTagName("effect");
325 if (effects.count() != 1) {
326 kDebug() << "More than one effect in file " << itemName << ", not supported yet";
328 e = effects.item(0).toElement();
329 effectsMap.insert(e.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), e);
332 foreach(const QDomElement & effect, effectsMap)
333 MainWindow::customEffects.append(effect);
337 void initEffects::parseEffectFile(EffectsList *customEffectList, EffectsList *audioEffectList, EffectsList *videoEffectList, QString name, QStringList filtersList, QStringList producersList, Mlt::Repository *repository)
341 doc.setContent(&file, false);
343 QDomElement documentElement = doc.documentElement();
344 QDomNodeList effects = doc.elementsByTagName("effect");
346 if (effects.count() == 0) {
347 kDebug() << "Effect broken: " << name;
351 for (int i = 0; !effects.item(i).isNull(); ++i) {
352 documentElement = effects.item(i).toElement();
353 QString tag = documentElement.attribute("tag", QString());
355 if (documentElement.hasAttribute("version")) {
356 // a specific version of the filter is required
357 Mlt::Properties *metadata = repository->metadata(filter_type, tag.toUtf8().data());
358 if (metadata && metadata->is_valid()) {
359 double version = metadata->get_double("version");
360 if (documentElement.attribute("version").toDouble() > version) {
368 // Parse effect information.
369 if ((filtersList.contains(tag) || producersList.contains(tag))) {
370 QString type = documentElement.attribute("type", QString());
372 audioEffectList->append(documentElement);
373 else if (type == "custom")
374 customEffectList->append(documentElement);
376 videoEffectList->append(documentElement);
380 QDomNode n = documentElement.firstChild();
381 QString id, effectName, effectTag, paramType;
386 EffectParamDescFactory effectDescParamFactory;
387 EffectDesc *effect = NULL;
390 QDomNode namenode = documentElement.elementsByTagName("name").item(0);
391 if (!namenode.isNull()) effectName = i18n(namenode.toElement().text());
392 if (!groupName.isEmpty()) effectName.prepend("_" + groupName + "_");
394 QDomNode propsnode = documentElement.elementsByTagName("properties").item(0);
395 if (!propsnode.isNull()) {
396 QDomElement propselement = propsnode.toElement();
397 id = propselement.attribute("id", QString());
398 effectTag = propselement.attribute("tag", QString());
399 if (propselement.attribute("type", QString()) == "audio") type = AUDIOEFFECT;
400 else if (propselement.attribute("type", QString()) == "custom") type = CUSTOMEFFECT;
401 else type = VIDEOEFFECT;
404 QString effectDescription;
405 QDomNode descnode = documentElement.elementsByTagName("description").item(0);
406 if (!descnode.isNull()) effectDescription = descnode.toElement().text() + "<br />";
408 QString effectAuthor;
409 QDomNode authnode = documentElement.elementsByTagName("author").item(0);
410 if (!authnode.isNull()) effectAuthor = authnode.toElement().text() + "<br />";
412 if (effectName.isEmpty() || id.isEmpty() || effectTag.isEmpty()) return;
414 effect = new EffectDesc(effectName, id, effectTag, effectDescription, effectAuthor, type);
416 QDomNodeList paramList = documentElement.elementsByTagName("parameter");
417 if (paramList.count() == 0) {
418 QDomElement fixed = doc.createElement("parameter");
419 fixed.setAttribute("type", "fixed");
420 effect->addParameter(effectDescParamFactory.createParameter(fixed));
422 else for (int i = 0; i < paramList.count(); i++) {
423 QDomElement e = paramList.item(i).toElement();
426 QDomNamedNodeMap attrs = e.attributes();
429 while (!attrs.item(i).isNull()) {
430 QDomNode n = attrs.item(i);
431 value = n.nodeValue();
432 if (value.find("MAX_WIDTH") != -1)
433 value.replace("MAX_WIDTH", QString::number(KdenliveSettings::defaultwidth()));
434 if (value.find("MID_WIDTH") != -1)
435 value.replace("MID_WIDTH", QString::number(KdenliveSettings::defaultwidth() / 2));
436 if (value.find("MAX_HEIGHT") != -1)
437 value.replace("MAX_HEIGHT", QString::number(KdenliveSettings::defaultheight()));
438 if (value.find("MID_HEIGHT") != -1)
439 value.replace("MID_HEIGHT", QString::number(KdenliveSettings::defaultheight() / 2));
440 n.setNodeValue(value);
443 effect->addParameter(effectDescParamFactory.createParameter(e));
446 effectList->append(effect);
452 const char* initEffects::ladspaEffectString(int ladspaId, QStringList params)
454 if (ladspaId == 1433) //Pitch
455 return ladspaPitchEffectString(params);
456 else if (ladspaId == 1216) //Room Reverb
457 return ladspaRoomReverbEffectString(params);
458 else if (ladspaId == 1423) //Reverb
459 return ladspaReverbEffectString(params);
460 else if (ladspaId == 1901) //Reverb
461 return ladspaEqualizerEffectString(params);
463 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
464 return "<jackrack></jackrack>";
469 void initEffects::ladspaEffectFile(const QString & fname, int ladspaId, QStringList params)
471 const char *filterString;
474 filterString = ladspaPitchEffectString(params);
477 filterString = ladspaVinylEffectString(params);
479 case 1216 : //Room Reverb
480 filterString = ladspaRoomReverbEffectString(params);
483 filterString = ladspaReverbEffectString(params);
485 case 1195: //Declipper
486 filterString = ladspaDeclipEffectString(params);
489 filterString = ladspaEqualizerEffectString(params);
491 case 1913: // Limiter
492 filterString = ladspaLimiterEffectString(params);
494 case 1193: // Pitch Shifter
495 filterString = ladspaPitchShifterEffectString(params);
497 case 1417: // Rate Scaler
498 filterString = ladspaRateScalerEffectString(params);
501 filterString = ladspaPhaserEffectString(params);
503 case 1197: // 15 Band Equalizer
504 filterString = ladspaEqualizer15EffectString(params);
507 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
513 if (f.open(QIODevice::WriteOnly)) {
514 QTextStream stream(&f);
515 stream << filterString;
517 } else kDebug() << "++++++++++ ERROR CANNOT WRITE TO: " << KdenliveSettings::currenttmpfolder() + fname << endl;
518 delete [] filterString;
521 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>";
524 const char* initEffects::ladspaDeclipEffectString(QStringList)
526 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());
530 const char* initEffects::ladspaVocoderEffectString(QStringList params)
532 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]));
535 const char* initEffects::ladspaVinylEffectString(QStringList params)
537 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());
540 const char* initEffects::ladspaPitchEffectString(QStringList params)
542 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());
545 const char* initEffects::ladspaRoomReverbEffectString(QStringList params)
547 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());
550 const char* initEffects::ladspaReverbEffectString(QStringList params)
552 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());
555 const char* initEffects::ladspaEqualizerEffectString(QStringList params)
557 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());
560 const char* initEffects::ladspaLimiterEffectString(QStringList params)
562 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());
565 const char* initEffects::ladspaPitchShifterEffectString(QStringList params)
567 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());
570 const char* initEffects::ladspaRateScalerEffectString(QStringList params)
572 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());
575 const char* initEffects::ladspaPhaserEffectString(QStringList params)
577 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());
579 const char* initEffects::ladspaEqualizer15EffectString(QStringList params)
581 return qstrdup(QString(jackString + "1197</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><controlrow><lock>true</lock><value>%5</value><value>%5</value></controlrow><controlrow><lock>true</lock><value>%6</value><value>%6</value></controlrow><controlrow><lock>true</lock><value>%7</value><value>%7</value></controlrow><controlrow><lock>true</lock><value>%8</value><value>%8</value></controlrow><controlrow><lock>true</lock><value>%9</value><value>%9</value></controlrow><controlrow><lock>true</lock><value>%10</value><value>%10</value></controlrow><controlrow><lock>true</lock><value>%11</value><value>%11</value></controlrow><controlrow><lock>true</lock><value>%12</value><value>%12</value></controlrow><controlrow><lock>true</lock><value>%13</value><value>%13</value></controlrow><controlrow><lock>true</lock><value>%14</value><value>%14</value></controlrow><controlrow><lock>true</lock><value>%15</value><value>%15</value></controlrow></plugin></jackrack>").arg(params[0]).arg(params[1]).arg(params[2]).arg(params[3]).arg(params[4]).arg(params[5]).arg(params[6]).arg(params[7]).arg(params[8]).arg(params[9]).arg(params[10]).arg(params[11]).arg(params[12]).arg(params[13]).arg(params[14]).toUtf8());
585 QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository, const QString& /*type*/, const QString& filtername)
589 Mlt::Properties *metadata = repository->metadata(filter_type, filtername.toAscii().data());
590 //kDebug() << filtername;
591 if (metadata && metadata->is_valid()) {
592 if (metadata->get("title") && metadata->get("identifier")) {
593 QDomElement eff = ret.createElement("effect");
594 QString id = metadata->get("identifier");
595 eff.setAttribute("tag", id);
596 eff.setAttribute("id", id);
597 //kDebug()<<"Effect: "<<id;
599 QDomElement name = ret.createElement("name");
600 name.appendChild(ret.createTextNode(metadata->get("title")));
602 QDomElement desc = ret.createElement("description");
603 desc.appendChild(ret.createTextNode(metadata->get("description")));
605 QDomElement author = ret.createElement("author");
606 author.appendChild(ret.createTextNode(metadata->get("creator")));
608 eff.appendChild(name);
609 eff.appendChild(author);
610 eff.appendChild(desc);
612 Mlt::Properties tags((mlt_properties) metadata->get_data("tags"));
613 if (QString(tags.get(0)) == "Audio") eff.setAttribute("type", "audio");
614 /*for (int i = 0; i < tags.count(); i++)
615 kDebug()<<tags.get_name(i)<<"="<<tags.get(i);*/
617 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
618 for (int j = 0; param_props.is_valid() && j < param_props.count(); j++) {
619 QDomElement params = ret.createElement("parameter");
621 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(j)));
623 params.setAttribute("name", paramdesc.get("identifier"));
625 if (paramdesc.get("maximum")) params.setAttribute("max", paramdesc.get("maximum"));
626 if (paramdesc.get("minimum")) params.setAttribute("min", paramdesc.get("minimum"));
628 QString paramType = paramdesc.get("type");
630 if (paramType == "integer")
631 params.setAttribute("type", "constant");
632 else if (paramType == "float") {
633 params.setAttribute("type", "constant");
634 // param type is float, set default decimals to 3
635 params.setAttribute("decimals", "3");
637 else if (paramType == "boolean")
638 params.setAttribute("type", "bool");
639 else if (paramType == "geometry") {
640 params.setAttribute("type", "geometry");
643 params.setAttribute("type", paramType);
644 if (!QString(paramdesc.get("format")).isEmpty()) params.setAttribute("format", paramdesc.get("format"));
646 if (paramdesc.get("default")) params.setAttribute("default", paramdesc.get("default"));
647 if (paramdesc.get("value")) {
648 params.setAttribute("value", paramdesc.get("value"));
650 params.setAttribute("value", paramdesc.get("default"));
653 QDomElement pname = ret.createElement("name");
654 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
655 params.appendChild(pname);
657 eff.appendChild(params);
659 ret.appendChild(eff);
665 QTextStream str(&outstr);
667 kDebug() << outstr;*/
671 void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *transitions, QStringList names)
673 // Remove transitions that are not implemented.
674 int pos = names.indexOf("mix");
678 QStringList imagenamelist = QStringList() << i18n("None");
679 QStringList imagefiles = QStringList() << QString();
681 filters << "*.pgm" << "*.png";
682 QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
683 foreach(QString folder, customLumas) {
684 if (!folder.endsWith('/'))
686 QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
687 foreach(const QString & fname, filesnames) {
688 imagenamelist.append(fname);
689 imagefiles.append(folder + fname);
693 // Check for MLT luma files.
694 KUrl folder(mlt_environment("MLT_DATA"));
695 folder.addPath("lumas");
696 folder.addPath(mlt_environment("MLT_NORMALISATION"));
697 QDir lumafolder(folder.path());
698 QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
699 foreach(const QString & fname, filesnames) {
700 imagenamelist.append(fname);
703 imagefiles.append(path.toLocalFile());
706 //WARNING: this is a hack to get around temporary invalid metadata in MLT, 2nd of june 2011 JBM
707 QStringList customTransitions;
708 customTransitions << "composite" << "luma" << "affine" << "mix" << "region";
710 foreach(const QString & name, names) {
712 QDomElement ktrans = ret.createElement("ktransition");
713 ret.appendChild(ktrans);
714 ktrans.setAttribute("tag", name);
716 QDomElement tname = ret.createElement("name");
717 QDomElement desc = ret.createElement("description");
718 ktrans.appendChild(tname);
719 ktrans.appendChild(desc);
720 Mlt::Properties *metadata = repository->metadata(transition_type, name.toUtf8().data());
721 if (!customTransitions.contains(name) && metadata && metadata->is_valid()) {
722 // If possible, set name and description.
723 if (metadata->get("title") && metadata->get("identifier"))
724 tname.appendChild(ret.createTextNode(metadata->get("title")));
725 desc.appendChild(ret.createTextNode(metadata->get("description")));
727 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
728 for (int i = 0; param_props.is_valid() && i < param_props.count(); ++i) {
729 QDomElement params = ret.createElement("parameter");
731 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(i)));
733 params.setAttribute("name", paramdesc.get("identifier"));
735 if (paramdesc.get("maximum"))
736 params.setAttribute("max", paramdesc.get("maximum"));
737 if (paramdesc.get("minimum"))
738 params.setAttribute("min", paramdesc.get("minimum"));
739 if (QString(paramdesc.get("type")) == "integer") {
740 params.setAttribute("type", "constant");
741 params.setAttribute("factor", "100");
743 if (QString(paramdesc.get("type")) == "boolean")
744 params.setAttribute("type", "bool");
745 if (!QString(paramdesc.get("format")).isEmpty()) {
746 params.setAttribute("type", "complex");
747 params.setAttribute("format", paramdesc.get("format"));
749 if (paramdesc.get("default"))
750 params.setAttribute("default", paramdesc.get("default"));
751 if (paramdesc.get("value"))
752 params.setAttribute("value", paramdesc.get("value"));
754 params.setAttribute("value", paramdesc.get("default"));
756 QDomElement pname = ret.createElement("name");
757 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
758 params.appendChild(pname);
759 ktrans.appendChild(params);
765 * Check for Kdenlive installed luma files, add empty string at
766 * start for no luma file.
769 // Implement default transitions.
770 QList<QDomElement> paramList;
771 if (name == "luma") {
772 ktrans.setAttribute("id", name);
773 tname.appendChild(ret.createTextNode(i18n("Wipe")));
774 desc.appendChild(ret.createTextNode(i18n("Applies a stationary transition between the current and next frames.")));
776 paramList.append(quickParameterFill(ret, i18n("Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
777 paramList.append(quickParameterFill(ret, i18nc("@property: means that the image is inverted", "Invert"), "invert", "bool", "0", "0", "1"));
778 paramList.append(quickParameterFill(ret, i18n("Image File"), "resource", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
779 paramList.append(quickParameterFill(ret, i18n("Reverse Transition"), "reverse", "bool", "0", "0", "1"));
780 //thumbnailer.prepareThumbnailsCall(imagelist);
781 } else if (name == "composite") {
782 ktrans.setAttribute("id", name);
783 tname.appendChild(ret.createTextNode(i18n("Composite")));
784 desc.appendChild(ret.createTextNode(i18n("A key-framable alpha-channel compositor for two frames.")));
785 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0%,0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
786 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
787 paramList.append(quickParameterFill(ret, i18n("Align"), "aligned", "bool", "1", "0", "1"));
788 paramList.append(quickParameterFill(ret, i18n("Fill"), "fill", "bool", "1", "0", "1"));
789 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
790 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "luma", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
791 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
792 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "luma_invert", "bool", "0", "0", "1"));
793 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "progressive", "bool", "1", "0", "1"));
794 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "deinterlace", "bool", "0", "0", "1"));
795 } else if (name == "affine") {
796 tname.appendChild(ret.createTextNode(i18n("Affine")));
797 ret.documentElement().setAttribute("showrotation", "1");
798 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "double", "0", "0", "360"));
799 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "double", "0", "0", "360"));
800 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "double", "0", "0", "360"));
801 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Y"), "fix_rotate_y", "double", "0", "0", "360"));
802 paramList.append(quickParameterFill(ret, i18n("Fix Rotate X"), "fix_rotate_x", "double", "0", "0", "360"));
803 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Z"), "fix_rotate_z", "double", "0", "0", "360"));
804 paramList.append(quickParameterFill(ret, i18n("Shear Y"), "shear_y", "double", "0", "0", "360"));
805 paramList.append(quickParameterFill(ret, i18n("Shear X"), "shear_x", "double", "0", "0", "360"));
806 paramList.append(quickParameterFill(ret, i18n("Shear Z"), "shear_z", "double", "0", "0", "360"));*/
807 /*paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
808 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
809 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));*/
811 paramList.append(quickParameterFill(ret, "keyed", "keyed", "fixed", "1", "1", "1"));
812 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0,0,100%,100%,100%", "0,0,100%,100%,100%", "0,0,100%,100%,100%", "", "", "", "", "", "true"));
814 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
815 paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
816 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
817 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));
818 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));*/
820 paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
821 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
822 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));
823 } else if (name == "mix") {
824 tname.appendChild(ret.createTextNode(i18n("Mix")));
825 } else if (name == "region") {
826 ktrans.setAttribute("id", name);
827 tname.appendChild(ret.createTextNode(i18n("Region")));
828 desc.appendChild(ret.createTextNode(i18n("Use alpha channel of another clip to create a transition.")));
829 paramList.append(quickParameterFill(ret, i18n("Transparency clip"), "resource", "url", "", "", "", "", "", ""));
830 paramList.append(quickParameterFill(ret, i18n("Geometry"), "composite.geometry", "geometry", "0%,0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
831 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "composite.operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
832 paramList.append(quickParameterFill(ret, i18n("Align"), "composite.aligned", "bool", "1", "0", "1"));
833 paramList.append(quickParameterFill(ret, i18n("Fill"), "composite.fill", "bool", "1", "0", "1"));
834 paramList.append(quickParameterFill(ret, i18n("Distort"), "composite.distort", "bool", "0", "0", "1"));
835 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "composite.luma", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
836 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "composite.softness", "double", "0", "0", "100", "", "", "100"));
837 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "composite.luma_invert", "bool", "0", "0", "1"));
838 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "composite.progressive", "bool", "1", "0", "1"));
839 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "composite.deinterlace", "bool", "0", "0", "1"));
841 foreach(const QDomElement & e, paramList)
842 ktrans.appendChild(e);
845 // Add the transition to the global list.
846 transitions->append(ret.documentElement());
847 //kDebug() << ret.toString();
850 // Add some virtual transitions.
851 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>";
853 ret.setContent(slidetrans);
854 transitions->append(ret.documentElement());
856 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>";
857 ret.setContent(dissolve);
858 transitions->append(ret.documentElement());
860 /*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>";
861 ret.setContent(alphatrans);
862 transitions->append(ret.documentElement());*/
865 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)
867 QDomElement parameter = doc.createElement("parameter");
868 parameter.setAttribute("tag", tag);
869 parameter.setAttribute("default", def);
870 parameter.setAttribute("type", type);
871 parameter.setAttribute("name", tag);
872 parameter.setAttribute("max", max);
873 parameter.setAttribute("min", min);
875 parameter.setAttribute("paramlist", list);
876 if (!listdisplaynames.isEmpty())
877 parameter.setAttribute("paramlistdisplay", listdisplaynames);
878 if (!factor.isEmpty())
879 parameter.setAttribute("factor", factor);
880 if (!namedesc.isEmpty())
881 parameter.setAttribute("namedesc", namedesc);
882 if (!format.isEmpty())
883 parameter.setAttribute("format", format);
884 if (!opacity.isEmpty())
885 parameter.setAttribute("opacity", opacity);
886 QDomElement pname = doc.createElement("name");
887 pname.appendChild(doc.createTextNode(name));
888 parameter.appendChild(pname);