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 if (doc.elementsByTagName("description").count() > 0) {
243 QString desc = doc.documentElement().elementsByTagName("description").item(0).toElement().text();
244 //WARNING: TEMPORARY FIX for unusable MLT SOX parameters description
245 if (desc.startsWith("Process audio using a SoX")) {
246 // Remove MLT's SOX generated effects since the parameters properties are unusable for us
248 else audioEffectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
252 videoEffectsMap.insert(doc.documentElement().elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), doc.documentElement());
256 // Set the directories to look into for effects.
257 QStringList direc = KGlobal::dirs()->findDirs("appdata", "effects");
258 // Iterate through effects directories to parse all XML files.
259 for (more = direc.begin(); more != direc.end(); ++more) {
260 QDir directory(*more);
263 fileList = directory.entryList(filter, QDir::Files);
264 for (it = fileList.begin(); it != fileList.end(); ++it) {
265 itemName = KUrl(*more + *it).path();
266 parseEffectFile(&MainWindow::customEffects,
267 &MainWindow::audioEffects,
268 &MainWindow::videoEffects,
269 itemName, filtersList, producersList, repository);
273 // Create custom effects
274 for (int i = 0; i < MainWindow::customEffects.count(); ++i) {
275 effectInfo = MainWindow::customEffects.at(i);
276 effectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
278 MainWindow::customEffects.clearList();
279 foreach(const QDomElement & effect, effectsMap)
280 MainWindow::customEffects.append(effect);
283 // Create audio effects
284 for (int i = 0; i < MainWindow::audioEffects.count(); ++i) {
285 effectInfo = MainWindow::audioEffects.at(i);
286 audioEffectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
288 MainWindow::audioEffects.clearList();
289 foreach(const QDomElement & effect, audioEffectsMap)
290 MainWindow::audioEffects.append(effect);
292 // Create video effects
293 for (int i = 0; i < MainWindow::videoEffects.count(); ++i) {
294 effectInfo = MainWindow::videoEffects.at(i);
295 videoEffectsMap.insert(effectInfo.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), effectInfo);
297 MainWindow::videoEffects.clearList();
298 foreach(const QDomElement & effect, videoEffectsMap)
299 MainWindow::videoEffects.append(effect);
305 void initEffects::parseCustomEffectsFile()
307 MainWindow::customEffects.clearList();
309 * Why a QMap? See parseEffectFiles(). It's probably useless here, but we
310 * cannot be sure about it.
312 QMap<QString, QDomElement> effectsMap;
313 QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
314 QDir directory = QDir(path);
317 const QStringList fileList = directory.entryList(filter, QDir::Files);
319 * We need to declare these variables outside the foreach, or the QMap will
320 * refer to non existing variables (QMap::insert() takes references as
324 QDomNodeList effects;
326 foreach(const QString & filename, fileList) {
327 QString itemName = KUrl(path + filename).path();
328 QFile file(itemName);
329 doc.setContent(&file, false);
331 effects = doc.elementsByTagName("effect");
332 if (effects.count() != 1) {
333 kDebug() << "More than one effect in file " << itemName << ", not supported yet";
335 e = effects.item(0).toElement();
336 effectsMap.insert(e.elementsByTagName("name").item(0).toElement().text().toLower().toUtf8().data(), e);
339 foreach(const QDomElement & effect, effectsMap)
340 MainWindow::customEffects.append(effect);
344 void initEffects::parseEffectFile(EffectsList *customEffectList, EffectsList *audioEffectList, EffectsList *videoEffectList, QString name, QStringList filtersList, QStringList producersList, Mlt::Repository *repository)
348 doc.setContent(&file, false);
350 QDomElement documentElement = doc.documentElement();
351 QDomNodeList effects = doc.elementsByTagName("effect");
353 if (effects.count() == 0) {
354 kDebug() << "Effect broken: " << name;
358 for (int i = 0; !effects.item(i).isNull(); ++i) {
359 documentElement = effects.item(i).toElement();
360 QString tag = documentElement.attribute("tag", QString());
362 if (documentElement.hasAttribute("version")) {
363 // a specific version of the filter is required
364 Mlt::Properties *metadata = repository->metadata(filter_type, tag.toUtf8().data());
365 if (metadata && metadata->is_valid()) {
366 double version = metadata->get_double("version");
367 if (documentElement.attribute("version").toDouble() > version) {
375 // Parse effect information.
376 if ((filtersList.contains(tag) || producersList.contains(tag))) {
377 QString type = documentElement.attribute("type", QString());
379 audioEffectList->append(documentElement);
380 else if (type == "custom")
381 customEffectList->append(documentElement);
383 videoEffectList->append(documentElement);
387 QDomNode n = documentElement.firstChild();
388 QString id, effectName, effectTag, paramType;
393 EffectParamDescFactory effectDescParamFactory;
394 EffectDesc *effect = NULL;
397 QDomNode namenode = documentElement.elementsByTagName("name").item(0);
398 if (!namenode.isNull()) effectName = i18n(namenode.toElement().text());
399 if (!groupName.isEmpty()) effectName.prepend("_" + groupName + "_");
401 QDomNode propsnode = documentElement.elementsByTagName("properties").item(0);
402 if (!propsnode.isNull()) {
403 QDomElement propselement = propsnode.toElement();
404 id = propselement.attribute("id", QString());
405 effectTag = propselement.attribute("tag", QString());
406 if (propselement.attribute("type", QString()) == "audio") type = AUDIOEFFECT;
407 else if (propselement.attribute("type", QString()) == "custom") type = CUSTOMEFFECT;
408 else type = VIDEOEFFECT;
411 QString effectDescription;
412 QDomNode descnode = documentElement.elementsByTagName("description").item(0);
413 if (!descnode.isNull()) effectDescription = descnode.toElement().text() + "<br />";
415 QString effectAuthor;
416 QDomNode authnode = documentElement.elementsByTagName("author").item(0);
417 if (!authnode.isNull()) effectAuthor = authnode.toElement().text() + "<br />";
419 if (effectName.isEmpty() || id.isEmpty() || effectTag.isEmpty()) return;
421 effect = new EffectDesc(effectName, id, effectTag, effectDescription, effectAuthor, type);
423 QDomNodeList paramList = documentElement.elementsByTagName("parameter");
424 if (paramList.count() == 0) {
425 QDomElement fixed = doc.createElement("parameter");
426 fixed.setAttribute("type", "fixed");
427 effect->addParameter(effectDescParamFactory.createParameter(fixed));
429 else for (int i = 0; i < paramList.count(); i++) {
430 QDomElement e = paramList.item(i).toElement();
433 QDomNamedNodeMap attrs = e.attributes();
436 while (!attrs.item(i).isNull()) {
437 QDomNode n = attrs.item(i);
438 value = n.nodeValue();
439 if (value.find("MAX_WIDTH") != -1)
440 value.replace("MAX_WIDTH", QString::number(KdenliveSettings::defaultwidth()));
441 if (value.find("MID_WIDTH") != -1)
442 value.replace("MID_WIDTH", QString::number(KdenliveSettings::defaultwidth() / 2));
443 if (value.find("MAX_HEIGHT") != -1)
444 value.replace("MAX_HEIGHT", QString::number(KdenliveSettings::defaultheight()));
445 if (value.find("MID_HEIGHT") != -1)
446 value.replace("MID_HEIGHT", QString::number(KdenliveSettings::defaultheight() / 2));
447 n.setNodeValue(value);
450 effect->addParameter(effectDescParamFactory.createParameter(e));
453 effectList->append(effect);
459 const char* initEffects::ladspaEffectString(int ladspaId, QStringList params)
461 if (ladspaId == 1433) //Pitch
462 return ladspaPitchEffectString(params);
463 else if (ladspaId == 1216) //Room Reverb
464 return ladspaRoomReverbEffectString(params);
465 else if (ladspaId == 1423) //Reverb
466 return ladspaReverbEffectString(params);
467 else if (ladspaId == 1901) //Reverb
468 return ladspaEqualizerEffectString(params);
470 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
471 return "<jackrack></jackrack>";
476 void initEffects::ladspaEffectFile(const QString & fname, int ladspaId, QStringList params)
478 const char *filterString;
481 filterString = ladspaPitchEffectString(params);
484 filterString = ladspaVinylEffectString(params);
486 case 1216 : //Room Reverb
487 filterString = ladspaRoomReverbEffectString(params);
490 filterString = ladspaReverbEffectString(params);
492 case 1195: //Declipper
493 filterString = ladspaDeclipEffectString(params);
496 filterString = ladspaEqualizerEffectString(params);
498 case 1913: // Limiter
499 filterString = ladspaLimiterEffectString(params);
501 case 1193: // Pitch Shifter
502 filterString = ladspaPitchShifterEffectString(params);
504 case 1417: // Rate Scaler
505 filterString = ladspaRateScalerEffectString(params);
508 filterString = ladspaPhaserEffectString(params);
510 case 1197: // 15 Band Equalizer
511 filterString = ladspaEqualizer15EffectString(params);
514 kDebug() << "++++++++++ ASKING FOR UNKNOWN LADSPA EFFECT: " << ladspaId << endl;
520 if (f.open(QIODevice::WriteOnly)) {
521 QTextStream stream(&f);
522 stream << filterString;
524 } else kDebug() << "++++++++++ ERROR CANNOT WRITE TO: " << KdenliveSettings::currenttmpfolder() + fname << endl;
525 delete [] filterString;
528 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>";
531 const char* initEffects::ladspaDeclipEffectString(QStringList)
533 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());
537 const char* initEffects::ladspaVocoderEffectString(QStringList params)
539 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]));
542 const char* initEffects::ladspaVinylEffectString(QStringList params)
544 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());
547 const char* initEffects::ladspaPitchEffectString(QStringList params)
549 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());
552 const char* initEffects::ladspaRoomReverbEffectString(QStringList params)
554 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());
557 const char* initEffects::ladspaReverbEffectString(QStringList params)
559 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());
562 const char* initEffects::ladspaEqualizerEffectString(QStringList params)
564 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());
567 const char* initEffects::ladspaLimiterEffectString(QStringList params)
569 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());
572 const char* initEffects::ladspaPitchShifterEffectString(QStringList params)
574 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());
577 const char* initEffects::ladspaRateScalerEffectString(QStringList params)
579 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());
582 const char* initEffects::ladspaPhaserEffectString(QStringList params)
584 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());
586 const char* initEffects::ladspaEqualizer15EffectString(QStringList params)
588 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());
592 QDomDocument initEffects::createDescriptionFromMlt(Mlt::Repository* repository, const QString& /*type*/, const QString& filtername)
596 Mlt::Properties *metadata = repository->metadata(filter_type, filtername.toAscii().data());
597 //kDebug() << filtername;
598 if (metadata && metadata->is_valid()) {
599 if (metadata->get("title") && metadata->get("identifier")) {
600 QDomElement eff = ret.createElement("effect");
601 QString id = metadata->get("identifier");
602 eff.setAttribute("tag", id);
603 eff.setAttribute("id", id);
604 //kDebug()<<"Effect: "<<id;
606 QDomElement name = ret.createElement("name");
607 name.appendChild(ret.createTextNode(metadata->get("title")));
609 QDomElement desc = ret.createElement("description");
610 desc.appendChild(ret.createTextNode(metadata->get("description")));
612 QDomElement author = ret.createElement("author");
613 author.appendChild(ret.createTextNode(metadata->get("creator")));
615 eff.appendChild(name);
616 eff.appendChild(author);
617 eff.appendChild(desc);
619 Mlt::Properties tags((mlt_properties) metadata->get_data("tags"));
620 if (QString(tags.get(0)) == "Audio") eff.setAttribute("type", "audio");
621 /*for (int i = 0; i < tags.count(); i++)
622 kDebug()<<tags.get_name(i)<<"="<<tags.get(i);*/
624 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
625 for (int j = 0; param_props.is_valid() && j < param_props.count(); j++) {
626 QDomElement params = ret.createElement("parameter");
628 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(j)));
630 params.setAttribute("name", paramdesc.get("identifier"));
632 if (paramdesc.get("maximum")) params.setAttribute("max", paramdesc.get("maximum"));
633 if (paramdesc.get("minimum")) params.setAttribute("min", paramdesc.get("minimum"));
635 QString paramType = paramdesc.get("type");
637 if (paramType == "integer")
638 params.setAttribute("type", "constant");
639 else if (paramType == "float") {
640 params.setAttribute("type", "constant");
641 // param type is float, set default decimals to 3
642 params.setAttribute("decimals", "3");
644 else if (paramType == "boolean")
645 params.setAttribute("type", "bool");
646 else if (paramType == "geometry") {
647 params.setAttribute("type", "geometry");
650 params.setAttribute("type", paramType);
651 if (!QString(paramdesc.get("format")).isEmpty()) params.setAttribute("format", paramdesc.get("format"));
653 if (paramdesc.get("default")) params.setAttribute("default", paramdesc.get("default"));
654 if (paramdesc.get("value")) {
655 params.setAttribute("value", paramdesc.get("value"));
657 params.setAttribute("value", paramdesc.get("default"));
660 QDomElement pname = ret.createElement("name");
661 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
662 params.appendChild(pname);
664 eff.appendChild(params);
666 ret.appendChild(eff);
672 QTextStream str(&outstr);
674 kDebug() << outstr;*/
678 void initEffects::fillTransitionsList(Mlt::Repository *repository, EffectsList *transitions, QStringList names)
680 // Remove transitions that are not implemented.
681 int pos = names.indexOf("mix");
685 QStringList imagenamelist = QStringList() << i18n("None");
686 QStringList imagefiles = QStringList() << QString();
688 filters << "*.pgm" << "*.png";
689 QStringList customLumas = KGlobal::dirs()->findDirs("appdata", "lumas");
690 foreach(QString folder, customLumas) {
691 if (!folder.endsWith('/'))
693 QStringList filesnames = QDir(folder).entryList(filters, QDir::Files);
694 foreach(const QString & fname, filesnames) {
695 imagenamelist.append(fname);
696 imagefiles.append(folder + fname);
700 // Check for MLT luma files.
701 KUrl folder(mlt_environment("MLT_DATA"));
702 folder.addPath("lumas");
703 folder.addPath(mlt_environment("MLT_NORMALISATION"));
704 QDir lumafolder(folder.path());
705 QStringList filesnames = lumafolder.entryList(filters, QDir::Files);
706 foreach(const QString & fname, filesnames) {
707 imagenamelist.append(fname);
710 imagefiles.append(path.toLocalFile());
713 //WARNING: this is a hack to get around temporary invalid metadata in MLT, 2nd of june 2011 JBM
714 QStringList customTransitions;
715 customTransitions << "composite" << "luma" << "affine" << "mix" << "region";
717 foreach(const QString & name, names) {
719 QDomElement ktrans = ret.createElement("ktransition");
720 ret.appendChild(ktrans);
721 ktrans.setAttribute("tag", name);
723 QDomElement tname = ret.createElement("name");
724 QDomElement desc = ret.createElement("description");
725 ktrans.appendChild(tname);
726 ktrans.appendChild(desc);
727 Mlt::Properties *metadata = repository->metadata(transition_type, name.toUtf8().data());
728 if (!customTransitions.contains(name) && metadata && metadata->is_valid()) {
729 // If possible, set name and description.
730 if (metadata->get("title") && metadata->get("identifier"))
731 tname.appendChild(ret.createTextNode(metadata->get("title")));
732 desc.appendChild(ret.createTextNode(metadata->get("description")));
734 Mlt::Properties param_props((mlt_properties) metadata->get_data("parameters"));
735 for (int i = 0; param_props.is_valid() && i < param_props.count(); ++i) {
736 QDomElement params = ret.createElement("parameter");
738 Mlt::Properties paramdesc((mlt_properties) param_props.get_data(param_props.get_name(i)));
740 params.setAttribute("name", paramdesc.get("identifier"));
742 if (paramdesc.get("maximum"))
743 params.setAttribute("max", paramdesc.get("maximum"));
744 if (paramdesc.get("minimum"))
745 params.setAttribute("min", paramdesc.get("minimum"));
746 if (QString(paramdesc.get("type")) == "integer") {
747 params.setAttribute("type", "constant");
748 params.setAttribute("factor", "100");
750 if (QString(paramdesc.get("type")) == "boolean")
751 params.setAttribute("type", "bool");
752 if (!QString(paramdesc.get("format")).isEmpty()) {
753 params.setAttribute("type", "complex");
754 params.setAttribute("format", paramdesc.get("format"));
756 if (paramdesc.get("default"))
757 params.setAttribute("default", paramdesc.get("default"));
758 if (paramdesc.get("value"))
759 params.setAttribute("value", paramdesc.get("value"));
761 params.setAttribute("value", paramdesc.get("default"));
763 QDomElement pname = ret.createElement("name");
764 pname.appendChild(ret.createTextNode(paramdesc.get("title")));
765 params.appendChild(pname);
766 ktrans.appendChild(params);
772 * Check for Kdenlive installed luma files, add empty string at
773 * start for no luma file.
776 // Implement default transitions.
777 QList<QDomElement> paramList;
778 if (name == "luma") {
779 ktrans.setAttribute("id", name);
780 tname.appendChild(ret.createTextNode(i18n("Wipe")));
781 desc.appendChild(ret.createTextNode(i18n("Applies a stationary transition between the current and next frames.")));
783 paramList.append(quickParameterFill(ret, i18n("Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
784 paramList.append(quickParameterFill(ret, i18nc("@property: means that the image is inverted", "Invert"), "invert", "bool", "0", "0", "1"));
785 paramList.append(quickParameterFill(ret, i18n("Image File"), "resource", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
786 paramList.append(quickParameterFill(ret, i18n("Reverse Transition"), "reverse", "bool", "0", "0", "1"));
787 //thumbnailer.prepareThumbnailsCall(imagelist);
788 } else if (name == "composite") {
789 ktrans.setAttribute("id", name);
790 tname.appendChild(ret.createTextNode(i18n("Composite")));
791 desc.appendChild(ret.createTextNode(i18n("A key-framable alpha-channel compositor for two frames.")));
792 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0%,0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
793 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
794 paramList.append(quickParameterFill(ret, i18n("Align"), "aligned", "bool", "1", "0", "1"));
795 paramList.append(quickParameterFill(ret, i18n("Fill"), "fill", "bool", "1", "0", "1"));
796 paramList.append(quickParameterFill(ret, i18n("Distort"), "distort", "bool", "0", "0", "1"));
797 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "luma", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
798 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "softness", "double", "0", "0", "100", "", "", "100"));
799 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "luma_invert", "bool", "0", "0", "1"));
800 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "progressive", "bool", "1", "0", "1"));
801 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "deinterlace", "bool", "0", "0", "1"));
802 } else if (name == "affine") {
803 tname.appendChild(ret.createTextNode(i18n("Affine")));
804 ret.documentElement().setAttribute("showrotation", "1");
805 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "double", "0", "0", "360"));
806 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "double", "0", "0", "360"));
807 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "double", "0", "0", "360"));
808 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Y"), "fix_rotate_y", "double", "0", "0", "360"));
809 paramList.append(quickParameterFill(ret, i18n("Fix Rotate X"), "fix_rotate_x", "double", "0", "0", "360"));
810 paramList.append(quickParameterFill(ret, i18n("Fix Rotate Z"), "fix_rotate_z", "double", "0", "0", "360"));
811 paramList.append(quickParameterFill(ret, i18n("Shear Y"), "shear_y", "double", "0", "0", "360"));
812 paramList.append(quickParameterFill(ret, i18n("Shear X"), "shear_x", "double", "0", "0", "360"));
813 paramList.append(quickParameterFill(ret, i18n("Shear Z"), "shear_z", "double", "0", "0", "360"));*/
814 /*paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
815 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
816 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));*/
818 paramList.append(quickParameterFill(ret, "keyed", "keyed", "fixed", "1", "1", "1"));
819 paramList.append(quickParameterFill(ret, i18n("Geometry"), "geometry", "geometry", "0,0,100%,100%,100%", "0,0,100%,100%,100%", "0,0,100%,100%,100%", "", "", "", "", "", "true"));
821 paramList.append(quickParameterFill(ret, i18n("Rotate X"), "rotate_x", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
822 paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
823 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "addedgeometry", "0", "-1800", "1800", QString(), QString(), "10"));
824 /*paramList.append(quickParameterFill(ret, i18n("Rotate Y"), "rotate_y", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));
825 paramList.append(quickParameterFill(ret, i18n("Rotate Z"), "rotate_z", "simplekeyframe", "0", "-1800", "1800", QString(), QString(), "10"));*/
827 paramList.append(quickParameterFill(ret, i18n("Fix Shear Y"), "fix_shear_y", "double", "0", "0", "360"));
828 paramList.append(quickParameterFill(ret, i18n("Fix Shear X"), "fix_shear_x", "double", "0", "0", "360"));
829 paramList.append(quickParameterFill(ret, i18n("Fix Shear Z"), "fix_shear_z", "double", "0", "0", "360"));
830 } else if (name == "mix") {
831 tname.appendChild(ret.createTextNode(i18n("Mix")));
832 } else if (name == "region") {
833 ktrans.setAttribute("id", name);
834 tname.appendChild(ret.createTextNode(i18n("Region")));
835 desc.appendChild(ret.createTextNode(i18n("Use alpha channel of another clip to create a transition.")));
836 paramList.append(quickParameterFill(ret, i18n("Transparency clip"), "resource", "url", "", "", "", "", "", ""));
837 paramList.append(quickParameterFill(ret, i18n("Geometry"), "composite.geometry", "geometry", "0%,0%:100%x100%:100", "-500;-500;-500;-500;0", "500;500;500;500;100"));
838 paramList.append(quickParameterFill(ret, i18n("Alpha Channel Operation"), "composite.operator", "list", "over", "", "", "over,and,or,xor", i18n("Over,And,Or,Xor")));
839 paramList.append(quickParameterFill(ret, i18n("Align"), "composite.aligned", "bool", "1", "0", "1"));
840 paramList.append(quickParameterFill(ret, i18n("Fill"), "composite.fill", "bool", "1", "0", "1"));
841 paramList.append(quickParameterFill(ret, i18n("Distort"), "composite.distort", "bool", "0", "0", "1"));
842 paramList.append(quickParameterFill(ret, i18n("Wipe File"), "composite.luma", "list", "", "", "", imagefiles.join(","), imagenamelist.join(",")));
843 paramList.append(quickParameterFill(ret, i18n("Wipe Softness"), "composite.softness", "double", "0", "0", "100", "", "", "100"));
844 paramList.append(quickParameterFill(ret, i18n("Wipe Invert"), "composite.luma_invert", "bool", "0", "0", "1"));
845 paramList.append(quickParameterFill(ret, i18n("Force Progressive Rendering"), "composite.progressive", "bool", "1", "0", "1"));
846 paramList.append(quickParameterFill(ret, i18n("Force Deinterlace Overlay"), "composite.deinterlace", "bool", "0", "0", "1"));
848 foreach(const QDomElement & e, paramList)
849 ktrans.appendChild(e);
852 // Add the transition to the global list.
853 transitions->append(ret.documentElement());
854 //kDebug() << ret.toString();
857 // Add some virtual transitions.
858 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>";
860 ret.setContent(slidetrans);
861 transitions->append(ret.documentElement());
863 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>";
864 ret.setContent(dissolve);
865 transitions->append(ret.documentElement());
867 /*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>";
868 ret.setContent(alphatrans);
869 transitions->append(ret.documentElement());*/
872 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)
874 QDomElement parameter = doc.createElement("parameter");
875 parameter.setAttribute("tag", tag);
876 parameter.setAttribute("default", def);
877 parameter.setAttribute("type", type);
878 parameter.setAttribute("name", tag);
879 parameter.setAttribute("max", max);
880 parameter.setAttribute("min", min);
882 parameter.setAttribute("paramlist", list);
883 if (!listdisplaynames.isEmpty())
884 parameter.setAttribute("paramlistdisplay", listdisplaynames);
885 if (!factor.isEmpty())
886 parameter.setAttribute("factor", factor);
887 if (!namedesc.isEmpty())
888 parameter.setAttribute("namedesc", namedesc);
889 if (!format.isEmpty())
890 parameter.setAttribute("format", format);
891 if (!opacity.isEmpty())
892 parameter.setAttribute("opacity", opacity);
893 QDomElement pname = doc.createElement("name");
894 pname.appendChild(doc.createTextNode(name));
895 parameter.appendChild(pname);