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 QStringList mltFiltersList = filtersList;
201 QFile file2(KStandardDirs::locate("appdata", "blacklisted_effects.txt"));
202 if (file2.open(QIODevice::ReadOnly)) {
203 QTextStream in(&file2);
204 while (!in.atEnd()) {
205 QString black = in.readLine().simplified();
206 if (!black.isEmpty() && !black.startsWith('#') &&
207 mltFiltersList.contains(black))
208 mltFiltersList.removeAll(black);
214 * Cleanup the global lists. We use QMap because of its automatic sorting
215 * (by key) and key uniqueness (using insert() instead of insertMulti()).
216 * This introduces some more cycles (while removing them from other parts of
217 * the code and centralising them), but due to the way this methods, QMap
218 * and EffectsList are implemented, there's no easy way to make it
219 * differently without reinplementing something (which should really be
222 QDomElement effectInfo;
223 QMap<QString, QDomElement> effectsMap;
224 QMap<QString, QDomElement> videoEffectsMap;
225 QMap<QString, QDomElement> audioEffectsMap;
227 // Create transitions
228 for (int i = 0; i < MainWindow::transitions.count(); ++i) {
229 effectInfo = MainWindow::transitions.at(i);
230 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
232 MainWindow::transitions.clearList();
233 foreach(const QDomElement & effect, effectsMap)
234 MainWindow::transitions.append(effect);
237 // Create effects from MLT
238 foreach(const QString & filtername, mltFiltersList) {
239 QDomDocument doc = createDescriptionFromMlt(repository, "filters", filtername);
240 //WARNING: TEMPORARY FIX for empty MLT effects descriptions - disable effects without parameters - jbm 09-06-2011
241 if (!doc.isNull() && doc.elementsByTagName("parameter").count() > 0) {
242 if (doc.documentElement().attribute("type") == "audio") {
243 if (doc.elementsByTagName("description").count() > 0) {
244 QString desc = doc.documentElement().elementsByTagName("description").item(0).toElement().text();
245 //WARNING: TEMPORARY FIX for unusable MLT SOX parameters description
246 if (desc.startsWith("Process audio using a SoX")) {
247 // Remove MLT's SOX generated effects since the parameters properties are unusable for us
249 else audioEffectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
253 videoEffectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
257 // Set the directories to look into for effects.
258 QStringList direc = KGlobal::dirs()->findDirs("appdata", "effects");
259 // Iterate through effects directories to parse all XML files.
260 for (more = direc.begin(); more != direc.end(); ++more) {
261 QDir directory(*more);
264 fileList = directory.entryList(filter, QDir::Files);
265 for (it = fileList.begin(); it != fileList.end(); ++it) {
266 itemName = KUrl(*more + *it).path();
267 parseEffectFile(&MainWindow::customEffects,
268 &MainWindow::audioEffects,
269 &MainWindow::videoEffects,
270 itemName, filtersList, producersList, repository);
274 // Create custom effects
275 for (int i = 0; i < MainWindow::customEffects.count(); ++i) {
276 effectInfo = MainWindow::customEffects.at(i);
277 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
279 MainWindow::customEffects.clearList();
280 foreach(const QDomElement & effect, effectsMap)
281 MainWindow::customEffects.append(effect);
284 // Create audio effects
285 for (int i = 0; i < MainWindow::audioEffects.count(); ++i) {
286 effectInfo = MainWindow::audioEffects.at(i);
287 audioEffectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
289 MainWindow::audioEffects.clearList();
290 foreach(const QDomElement & effect, audioEffectsMap)
291 MainWindow::audioEffects.append(effect);
293 // Create video effects
294 for (int i = 0; i < MainWindow::videoEffects.count(); ++i) {
295 effectInfo = MainWindow::videoEffects.at(i);
296 videoEffectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
298 MainWindow::videoEffects.clearList();
299 foreach(const QDomElement & effect, videoEffectsMap)
300 MainWindow::videoEffects.append(effect);
306 void initEffects::parseCustomEffectsFile()
308 MainWindow::customEffects.clearList();
310 * Why a QMap? See parseEffectFiles(). It's probably useless here, but we
311 * cannot be sure about it.
313 QMap<QString, QDomElement> effectsMap;
314 QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
315 QDir directory = QDir(path);
318 const QStringList fileList = directory.entryList(filter, QDir::Files);
320 * We need to declare these variables outside the foreach, or the QMap will
321 * refer to non existing variables (QMap::insert() takes references as
325 QDomNodeList effects;
327 foreach(const QString & filename, fileList) {
328 QString itemName = KUrl(path + filename).path();
329 QFile file(itemName);
330 doc.setContent(&file, false);
332 effects = doc.elementsByTagName("effect");
333 if (effects.count() != 1) {
334 kDebug() << "More than one effect in file " << itemName << ", not supported yet";
336 e = effects.item(0).toElement();
337 effectsMap.insert(e.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), e);
340 foreach(const QDomElement & effect, effectsMap)
341 MainWindow::customEffects.append(effect);
345 void initEffects::parseEffectFile(EffectsList *customEffectList, EffectsList *audioEffectList, EffectsList *videoEffectList, QString name, QStringList filtersList, QStringList producersList, Mlt::Repository *repository)
349 doc.setContent(&file, false);
351 QDomElement documentElement = doc.documentElement();
352 QDomNodeList effects = doc.elementsByTagName("effect");
354 if (effects.count() == 0) {
355 kDebug() << "Effect broken: " << name;
359 bool needsLocaleConversion = false;
360 for (int i = 0; !effects.item(i).isNull(); ++i) {
361 documentElement = effects.item(i).toElement();
362 QString tag = documentElement.attribute("tag", QString());
363 if (documentElement.hasAttribute("LC_NUMERIC")) {
364 // set a locale for that file
365 locale = QLocale(documentElement.attribute("LC_NUMERIC"));
366 if (locale.decimalPoint() != QLocale().decimalPoint()) {
367 needsLocaleConversion = true;
370 if (documentElement.hasAttribute("version")) {
371 // a specific version of the filter is required
372 Mlt::Properties *metadata = repository->metadata(filter_type, tag.toUtf8().data());
373 if (metadata && metadata->is_valid()) {
374 double version = metadata->get_double("version");
375 if (locale.toDouble(documentElement.attribute("version")) > version) {
383 if (needsLocaleConversion) {
384 // we need to convert all numbers to the system's locale (for example 0.5 -> 0,5)
385 QChar separator = QLocale().decimalPoint();
386 QChar oldSeparator = locale.decimalPoint();
387 QDomNodeList params = documentElement.elementsByTagName("parameter");
388 for (int j = 0; j < params.count(); j++) {
389 QDomNamedNodeMap attrs = params.at(j).attributes();
390 for (int k = 0; k < attrs.count(); k++) {
391 QString name = attrs.item(k).nodeName();
392 if (name != "type" && name != "name") {
393 QString val = attrs.item(k).nodeValue();
394 if (val.contains(oldSeparator)) {
395 QString newVal = val.replace(oldSeparator, separator);
396 attrs.item(k).setNodeValue(newVal);
403 // Parse effect information.
404 if ((filtersList.contains(tag) || producersList.contains(tag))) {
405 QString type = documentElement.attribute("type", QString());
407 audioEffectList->append(documentElement);
408 else if (type == "custom")
409 customEffectList->append(documentElement);
411 videoEffectList->append(documentElement);
415 QDomNode n = documentElement.firstChild();
416 QString id, effectName, effectTag, paramType;
421 EffectParamDescFactory effectDescParamFactory;
422 EffectDesc *effect = NULL;
425 QDomNode namenode = documentElement.elementsByTagName("name").item(0);
426 if (!namenode.isNull()) effectName = i18n(namenode.toElement().text());
427 if (!groupName.isEmpty()) effectName.prepend("_" + groupName + "_");
429 QDomNode propsnode = documentElement.elementsByTagName("properties").item(0);
430 if (!propsnode.isNull()) {
431 QDomElement propselement = propsnode.toElement();
432 id = propselement.attribute("id", QString());
433 effectTag = propselement.attribute("tag", QString());
434 if (propselement.attribute("type", QString()) == "audio") type = AUDIOEFFECT;
435 else if (propselement.attribute("type", QString()) == "custom") type = CUSTOMEFFECT;
436 else type = VIDEOEFFECT;
439 QString effectDescription;
440 QDomNode descnode = documentElement.elementsByTagName("description").item(0);
441 if (!descnode.isNull()) effectDescription = descnode.toElement().text() + "<br />";
443 QString effectAuthor;
444 QDomNode authnode = documentElement.elementsByTagName("author").item(0);
445 if (!authnode.isNull()) effectAuthor = authnode.toElement().text() + "<br />";
447 if (effectName.isEmpty() || id.isEmpty() || effectTag.isEmpty()) return;
449 effect = new EffectDesc(effectName, id, effectTag, effectDescription, effectAuthor, type);
451 QDomNodeList paramList = documentElement.elementsByTagName("parameter");
452 if (paramList.count() == 0) {
453 QDomElement fixed = doc.createElement("parameter");
454 fixed.setAttribute("type", "fixed");
455 effect->addParameter(effectDescParamFactory.createParameter(fixed));
457 else for (int i = 0; i < paramList.count(); i++) {
458 QDomElement e = paramList.item(i).toElement();
461 QDomNamedNodeMap attrs = e.attributes();
464 while (!attrs.item(i).isNull()) {
465 QDomNode n = attrs.item(i);
466 value = n.nodeValue();
467 if (value.find("MAX_WIDTH") != -1)
468 value.replace("MAX_WIDTH", QString::number(KdenliveSettings::defaultwidth()));
469 if (value.find("MID_WIDTH") != -1)
470 value.replace("MID_WIDTH", QString::number(KdenliveSettings::defaultwidth() / 2));
471 if (value.find("MAX_HEIGHT") != -1)
472 value.replace("MAX_HEIGHT", QString::number(KdenliveSettings::defaultheight()));
473 if (value.find("MID_HEIGHT") != -1)
474 value.replace("MID_HEIGHT", QString::number(KdenliveSettings::defaultheight() / 2));
475 n.setNodeValue(value);
478 effect->addParameter(effectDescParamFactory.createParameter(e));
481 effectList->append(effect);
487 const char* initEffects::ladspaEffectString(int ladspaId, QStringList params)
489 if (ladspaId == 1433) //Pitch
490 return ladspaPitchEffectString(params);
491 else if (ladspaId == 1216) //Room Reverb
492 return ladspaRoomReverbEffectString(params);
493 else if (ladspaId == 1423) //Reverb
494 return ladspaReverbEffectString(params);
495 else if (ladspaId == 1901) //Reverb
496 return ladspaEqualizerEffectString(params);
498 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
499 return "<jackrack></jackrack>";
504 void initEffects::ladspaEffectFile(const QString & fname, int ladspaId, QStringList params)
506 const char *filterString;
509 filterString = ladspaPitchEffectString(params);
512 filterString = ladspaVinylEffectString(params);
514 case 1216 : //Room Reverb
515 filterString = ladspaRoomReverbEffectString(params);
518 filterString = ladspaReverbEffectString(params);
520 case 1195: //Declipper
521 filterString = ladspaDeclipEffectString(params);
524 filterString = ladspaEqualizerEffectString(params);
526 case 1913: // Limiter
527 filterString = ladspaLimiterEffectString(params);
529 case 1193: // Pitch Shifter
530 filterString = ladspaPitchShifterEffectString(params);
532 case 1417: // Rate Scaler
533 filterString = ladspaRateScalerEffectString(params);
536 filterString = ladspaPhaserEffectString(params);
538 case 1197: // 15 Band Equalizer
539 filterString = ladspaEqualizer15EffectString(params);
542 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
548 if (f.open(QIODevice::WriteOnly)) {
549 QTextStream stream(&f);
550 stream << filterString;
552 } else kDebug() << "++++++++++ ERROR CANNOT WRITE TO: " << KdenliveSettings::currenttmpfolder() + fname << endl;
553 delete [] filterString;
556 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>";
559 const char* initEffects::ladspaDeclipEffectString(QStringList)
561 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());
565 const char* initEffects::ladspaVocoderEffectString(QStringList params)
567 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]));
570 const char* initEffects::ladspaVinylEffectString(QStringList params)
572 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());
575 const char* initEffects::ladspaPitchEffectString(QStringList params)
577 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());
580 const char* initEffects::ladspaRoomReverbEffectString(QStringList params)
582 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());
585 const char* initEffects::ladspaReverbEffectString(QStringList params)
587 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());
590 const char* initEffects::ladspaEqualizerEffectString(QStringList params)
592 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());
595 const char* initEffects::ladspaLimiterEffectString(QStringList params)
597 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());
600 const char* initEffects::ladspaPitchShifterEffectString(QStringList params)
602 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());
605 const char* initEffects::ladspaRateScalerEffectString(QStringList params)
607 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());
610 const char* initEffects::ladspaPhaserEffectString(QStringList params)
612 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());
614 const char* initEffects::ladspaEqualizer15EffectString(QStringList params)
616 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());
620 QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository, const QString& /*type*/, const QString& filtername)
624 Mlt::Properties *metadata = repository->metadata(filter_type, filtername.toAscii().data());
625 //kDebug() << filtername;
626 if (metadata && metadata->is_valid()) {
627 if (metadata->get("title") && metadata->get("identifier")) {
628 QDomElement eff = ret.createElement("effect");
629 QString id = metadata->get("identifier");
630 eff.setAttribute("tag", id);
631 eff.setAttribute("id", id);
632 //kDebug()<<"Effect: "<<id;
634 QDomElement name = ret.createElement("name");
635 name.appendChild(ret.createTextNode(metadata->get("title")));
637 QDomElement desc = ret.createElement("description");
638 desc.appendChild(ret.createTextNode(metadata->get("description")));
640 QDomElement author = ret.createElement("author");
641 author.appendChild(ret.createTextNode(metadata->get("creator")));
643 eff.appendChild(name);
644 eff.appendChild(author);
645 eff.appendChild(desc);
647 Mlt::Properties tags((mlt_properties) metadata->get_data("tags"));
648 if (QString(tags.get(0)) == "Audio") eff.setAttribute("type", "audio");
649 /*for (int i = 0; i < tags.count(); i++)
650 kDebug()<<tags.get_name(i)<<"="<<tags.get(i);*/
652 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
653 for (int j = 0; param_props.is_valid() && j < param_props.count(); j++) {
654 QDomElement params = ret.createElement("parameter");
656 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(j)));
658 params.setAttribute("name", paramdesc.get("identifier"));
660 if (paramdesc.get("maximum")) params.setAttribute("max", paramdesc.get("maximum"));
661 if (paramdesc.get("minimum")) params.setAttribute("min", paramdesc.get("minimum"));
663 QString paramType = paramdesc.get("type");
665 if (paramType == "integer")
666 params.setAttribute("type", "constant");
667 else if (paramType == "float") {
668 params.setAttribute("type", "constant");
669 // param type is float, set default decimals to 3
670 params.setAttribute("decimals", "3");
672 else if (paramType == "boolean")
673 params.setAttribute("type", "bool");
674 else if (paramType == "geometry") {
675 params.setAttribute("type", "geometry");
678 params.setAttribute("type", paramType);
679 if (!QString(paramdesc.get("format")).isEmpty()) params.setAttribute("format", paramdesc.get("format"));
681 if (paramdesc.get("default")) params.setAttribute("default", paramdesc.get("default"));
682 if (paramdesc.get("value")) {
683 params.setAttribute("value", paramdesc.get("value"));
685 params.setAttribute("value", paramdesc.get("default"));
688 QDomElement pname = ret.createElement("name");
689 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
690 params.appendChild(pname);
692 eff.appendChild(params);
694 ret.appendChild(eff);
700 QTextStream str(&outstr);
702 kDebug() << outstr;*/
706 void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *transitions, QStringList names)
708 // Remove transitions that are not implemented.
709 int pos = names.indexOf("mix");
713 QStringList imagenamelist = QStringList() << i18n("None");
714 QStringList imagefiles = QStringList() << QString();
716 filters << "*.pgm" << "*.png";
717 QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
718 foreach(QString folder, customLumas) {
719 if (!folder.endsWith('/'))
721 QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
722 foreach(const QString & fname, filesnames) {
723 imagenamelist.append(fname);
724 imagefiles.append(folder + fname);
728 // Check for MLT luma files.
729 KUrl folder(mlt_environment("MLT_DATA"));
730 folder.addPath("lumas");
731 folder.addPath(mlt_environment("MLT_NORMALISATION"));
732 QDir lumafolder(folder.path());
733 QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
734 foreach(const QString & fname, filesnames) {
735 imagenamelist.append(fname);
738 imagefiles.append(path.toLocalFile());
741 //WARNING: this is a hack to get around temporary invalid metadata in MLT, 2nd of june 2011 JBM
742 QStringList customTransitions;
743 customTransitions << "composite" << "luma" << "affine" << "mix" << "region";
745 foreach(const QString & name, names) {
747 QDomElement ktrans = ret.createElement("ktransition");
748 ret.appendChild(ktrans);
749 ktrans.setAttribute("tag", name);
751 QDomElement tname = ret.createElement("name");
752 QDomElement desc = ret.createElement("description");
753 ktrans.appendChild(tname);
754 ktrans.appendChild(desc);
755 Mlt::Properties *metadata = repository->metadata(transition_type, name.toUtf8().data());
756 if (!customTransitions.contains(name) && metadata && metadata->is_valid()) {
757 // If possible, set name and description.
758 if (metadata->get("title") && metadata->get("identifier"))
759 tname.appendChild(ret.createTextNode(metadata->get("title")));
760 desc.appendChild(ret.createTextNode(metadata->get("description")));
762 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
763 for (int i = 0; param_props.is_valid() && i < param_props.count(); ++i) {
764 QDomElement params = ret.createElement("parameter");
766 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(i)));
768 params.setAttribute("name", paramdesc.get("identifier"));
770 if (paramdesc.get("maximum"))
771 params.setAttribute("max", paramdesc.get("maximum"));
772 if (paramdesc.get("minimum"))
773 params.setAttribute("min", paramdesc.get("minimum"));
774 if (QString(paramdesc.get("type")) == "integer") {
775 params.setAttribute("type", "constant");
776 params.setAttribute("factor", "100");
778 if (QString(paramdesc.get("type")) == "boolean")
779 params.setAttribute("type", "bool");
780 if (!QString(paramdesc.get("format")).isEmpty()) {
781 params.setAttribute("type", "complex");
782 params.setAttribute("format", paramdesc.get("format"));
784 if (paramdesc.get("default"))
785 params.setAttribute("default", paramdesc.get("default"));
786 if (paramdesc.get("value"))
787 params.setAttribute("value", paramdesc.get("value"));
789 params.setAttribute("value", paramdesc.get("default"));
791 QDomElement pname = ret.createElement("name");
792 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
793 params.appendChild(pname);
794 ktrans.appendChild(params);
800 * Check for Kdenlive installed luma files, add empty string at
801 * start for no luma file.
804 // Implement default transitions.
805 QList<QDomElement> paramList;
806 if (name == "luma") {
807 ktrans.setAttribute("id", name);
808 tname.appendChild(ret.createTextNode(i18n("Wipe")));
809 desc.appendChild(ret.createTextNode(i18n("Applies a stationary transition between the current and next frames.")));
811 paramList.append(quickParameterFill(ret, i18n("Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
812 paramList.append(quickParameterFill(ret, i18nc("@property: means that the image is inverted", "Invert"), "invert", "bool", "0", "0", "1"));
813 paramList.append(quickParameterFill(ret, i18n("Image File"), "resource", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
814 paramList.append(quickParameterFill(ret, i18n("Reverse Transition"), "reverse", "bool", "0", "0", "1"));
815 //thumbnailer.prepareThumbnailsCall(imagelist);
816 } else if (name == "composite") {
817 ktrans.setAttribute("id", name);
818 tname.appendChild(ret.createTextNode(i18n("Composite")));
819 desc.appendChild(ret.createTextNode(i18n("A key-framable alpha-channel compositor for two frames.")));
820 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0%/0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
821 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
822 paramList.append(quickParameterFill(ret, i18n("Align"), "aligned", "bool", "1", "0", "1"));
823 paramList.append(quickParameterFill(ret, i18n("Fill"), "fill", "bool", "1", "0", "1"));
824 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
825 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "luma", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
826 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
827 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "luma_invert", "bool", "0", "0", "1"));
828 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "progressive", "bool", "1", "0", "1"));
829 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "deinterlace", "bool", "0", "0", "1"));
830 } else if (name == "affine") {
831 tname.appendChild(ret.createTextNode(i18n("Affine")));
832 ret.documentElement().setAttribute("showrotation", "1");
833 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "double", "0", "0", "360"));
834 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "double", "0", "0", "360"));
835 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "double", "0", "0", "360"));
836 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Y"), "fix_rotate_y", "double", "0", "0", "360"));
837 paramList.append(quickParameterFill(ret, i18n("Fix Rotate X"), "fix_rotate_x", "double", "0", "0", "360"));
838 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Z"), "fix_rotate_z", "double", "0", "0", "360"));
839 paramList.append(quickParameterFill(ret, i18n("Shear Y"), "shear_y", "double", "0", "0", "360"));
840 paramList.append(quickParameterFill(ret, i18n("Shear X"), "shear_x", "double", "0", "0", "360"));
841 paramList.append(quickParameterFill(ret, i18n("Shear Z"), "shear_z", "double", "0", "0", "360"));*/
842 /*paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
843 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
844 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));*/
846 paramList.append(quickParameterFill(ret, "keyed", "keyed", "fixed", "1", "1", "1"));
847 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0/0:100%x100%:100%", "0/0:100%x100%:100%", "0/0:100%x100%:100%", "", "", "", "", "", "true"));
849 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
850 paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
851 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
852 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));
853 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));*/
855 paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
856 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
857 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));
858 } else if (name == "mix") {
859 tname.appendChild(ret.createTextNode(i18n("Mix")));
860 } else if (name == "region") {
861 ktrans.setAttribute("id", name);
862 tname.appendChild(ret.createTextNode(i18n("Region")));
863 desc.appendChild(ret.createTextNode(i18n("Use alpha channel of another clip to create a transition.")));
864 paramList.append(quickParameterFill(ret, i18n("Transparency clip"), "resource", "url", "", "", "", "", "", ""));
865 paramList.append(quickParameterFill(ret, i18n("Geometry"), "composite.geometry", "geometry", "0%/0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
866 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "composite.operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
867 paramList.append(quickParameterFill(ret, i18n("Align"), "composite.aligned", "bool", "1", "0", "1"));
868 paramList.append(quickParameterFill(ret, i18n("Fill"), "composite.fill", "bool", "1", "0", "1"));
869 paramList.append(quickParameterFill(ret, i18n("Distort"), "composite.distort", "bool", "0", "0", "1"));
870 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "composite.luma", "list", "", "", "", imagefiles.join(";"), imagenamelist.join(",")));
871 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "composite.softness", "double", "0", "0", "100", "", "", "100"));
872 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "composite.luma_invert", "bool", "0", "0", "1"));
873 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "composite.progressive", "bool", "1", "0", "1"));
874 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "composite.deinterlace", "bool", "0", "0", "1"));
876 foreach(const QDomElement & e, paramList)
877 ktrans.appendChild(e);
880 // Add the transition to the global list.
881 transitions->append(ret.documentElement());
882 //kDebug() << ret.toString();
885 // Add some virtual transitions.
886 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>";
888 ret.setContent(slidetrans);
889 transitions->append(ret.documentElement());
891 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>";
892 ret.setContent(dissolve);
893 transitions->append(ret.documentElement());
895 /*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>";
896 ret.setContent(alphatrans);
897 transitions->append(ret.documentElement());*/
900 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)
902 QDomElement parameter = doc.createElement("parameter");
903 parameter.setAttribute("tag", tag);
904 parameter.setAttribute("default", def);
905 parameter.setAttribute("type", type);
906 parameter.setAttribute("name", tag);
907 parameter.setAttribute("max", max);
908 parameter.setAttribute("min", min);
910 parameter.setAttribute("paramlist", list);
911 if (!listdisplaynames.isEmpty())
912 parameter.setAttribute("paramlistdisplay", listdisplaynames);
913 if (!factor.isEmpty())
914 parameter.setAttribute("factor", factor);
915 if (!namedesc.isEmpty())
916 parameter.setAttribute("namedesc", namedesc);
917 if (!format.isEmpty())
918 parameter.setAttribute("format", format);
919 if (!opacity.isEmpty())
920 parameter.setAttribute("opacity", opacity);
921 QDomElement pname = doc.createElement("name");
922 pname.appendChild(doc.createTextNode(name));
923 parameter.appendChild(pname);