]> git.sesse.net Git - kdenlive/blob - src/effectstackview.cpp
Initial support for keyframes in track effects (WIP)
[kdenlive] / src / effectstackview.cpp
1 /***************************************************************************
2                           effecstackview.cpp  -  description
3                              -------------------
4     begin                : Feb 15 2008
5     copyright            : (C) 2008 by Marco Gittler
6     email                : g.marco@freenet.de
7  ***************************************************************************/
8
9 /***************************************************************************
10  *                                                                         *
11  *   This program is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU General Public License as published by  *
13  *   the Free Software Foundation; either version 2 of the License, or     *
14  *   (at your option) any later version.                                   *
15  *                                                                         *
16  ***************************************************************************/
17
18
19 #include "effectstackview.h"
20 #include "effectslist.h"
21 #include "clipitem.h"
22 #include "mainwindow.h"
23 #include "docclipbase.h"
24 #include "projectlist.h"
25 #include "kthumb.h"
26 #include "monitorscene.h"
27 #include "kdenlivesettings.h"
28
29 #include <KDebug>
30 #include <KLocale>
31 #include <KMessageBox>
32 #include <KStandardDirs>
33 #include <KFileDialog>
34
35 #include <QMenu>
36 #include <QTextStream>
37 #include <QFile>
38 #include <QInputDialog>
39
40
41 EffectStackView::EffectStackView(Monitor *monitor, QWidget *parent) :
42         QWidget(parent),
43         m_monitor(monitor),
44         m_clipref(NULL),
45         m_trackMode(false),
46         m_trackindex(-1)
47 {
48     m_ui.setupUi(this);
49     QVBoxLayout *vbox1 = new QVBoxLayout(m_ui.frame);
50     m_effectedit = new EffectStackEdit(monitor, m_ui.frame);
51     vbox1->setContentsMargins(0, 0, 0, 0);
52     vbox1->setSpacing(0);
53     vbox1->addWidget(m_effectedit);
54     m_ui.frame->setSizePolicy(QSizePolicy(QSizePolicy::Expanding, QSizePolicy::Minimum));
55     //m_ui.region_url->fileDialog()->setFilter(ProjectList::getExtensions());
56     //m_ui.effectlist->horizontalHeader()->setVisible(false);
57     //m_ui.effectlist->verticalHeader()->setVisible(false);
58
59     m_ui.buttonNew->setIcon(KIcon("document-new"));
60     m_ui.buttonNew->setToolTip(i18n("Add new effect"));
61     m_ui.buttonUp->setIcon(KIcon("go-up"));
62     m_ui.buttonUp->setToolTip(i18n("Move effect up"));
63     m_ui.buttonDown->setIcon(KIcon("go-down"));
64     m_ui.buttonDown->setToolTip(i18n("Move effect down"));
65     m_ui.buttonDel->setIcon(KIcon("edit-delete"));
66     m_ui.buttonDel->setToolTip(i18n("Delete effect"));
67     m_ui.buttonSave->setIcon(KIcon("document-save"));
68     m_ui.buttonSave->setToolTip(i18n("Save effect"));
69     m_ui.buttonReset->setIcon(KIcon("view-refresh"));
70     m_ui.buttonReset->setToolTip(i18n("Reset effect"));
71     m_ui.checkAll->setToolTip(i18n("Enable/Disable all effects"));
72
73
74     m_ui.effectlist->setDragDropMode(QAbstractItemView::NoDragDrop); //use internal if drop is recognised right
75
76     //connect(m_ui.region_url, SIGNAL(urlSelected(const KUrl &)), this , SLOT(slotRegionChanged()));
77     //connect(m_ui.region_url, SIGNAL(returnPressed()), this , SLOT(slotRegionChanged()));
78     connect(m_ui.effectlist, SIGNAL(itemSelectionChanged()), this , SLOT(slotItemSelectionChanged()));
79     connect(m_ui.effectlist, SIGNAL(itemChanged(QListWidgetItem *)), this , SLOT(slotItemChanged(QListWidgetItem *)));
80     connect(m_ui.buttonUp, SIGNAL(clicked()), this, SLOT(slotItemUp()));
81     connect(m_ui.buttonDown, SIGNAL(clicked()), this, SLOT(slotItemDown()));
82     connect(m_ui.buttonDel, SIGNAL(clicked()), this, SLOT(slotItemDel()));
83     connect(m_ui.buttonSave, SIGNAL(clicked()), this, SLOT(slotSaveEffect()));
84     connect(m_ui.buttonReset, SIGNAL(clicked()), this, SLOT(slotResetEffect()));
85     connect(m_ui.checkAll, SIGNAL(stateChanged(int)), this, SLOT(slotCheckAll(int)));
86     connect(m_effectedit, SIGNAL(parameterChanged(const QDomElement, const QDomElement)), this , SLOT(slotUpdateEffectParams(const QDomElement, const QDomElement)));
87     connect(m_effectedit, SIGNAL(seekTimeline(int)), this , SLOT(slotSeekTimeline(int)));
88     connect(m_effectedit, SIGNAL(displayMessage(const QString&, int)), this, SIGNAL(displayMessage(const QString&, int)));
89     connect(m_effectedit, SIGNAL(checkMonitorPosition(int)), this, SLOT(slotCheckMonitorPosition(int)));
90     connect(monitor, SIGNAL(renderPosition(int)), this, SLOT(slotRenderPos(int)));
91     m_effectLists["audio"] = &MainWindow::audioEffects;
92     m_effectLists["video"] = &MainWindow::videoEffects;
93     m_effectLists["custom"] = &MainWindow::customEffects;
94     m_ui.splitter->setStretchFactor(1, 10);
95     m_ui.splitter->setStretchFactor(0, 1);
96     setEnabled(false);
97 }
98
99 EffectStackView::~EffectStackView()
100 {
101     m_effectLists.clear();
102     delete m_effectedit;
103 }
104
105 void EffectStackView::updateTimecodeFormat()
106 {
107     m_effectedit->updateTimecodeFormat();
108 }
109
110 void EffectStackView::setMenu(QMenu *menu)
111 {
112     m_ui.buttonNew->setMenu(menu);
113 }
114
115 void EffectStackView::updateProjectFormat(MltVideoProfile profile, Timecode t)
116 {
117     m_effectedit->updateProjectFormat(profile, t);
118 }
119
120 void EffectStackView::slotSaveEffect()
121 {
122     QString name = QInputDialog::getText(this, i18n("Save Effect"), i18n("Name for saved effect: "));
123     if (name.isEmpty()) return;
124     QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
125     path = path + name + ".xml";
126     if (QFile::exists(path)) if (KMessageBox::questionYesNo(this, i18n("File %1 already exists.\nDo you want to overwrite it?", path)) == KMessageBox::No) return;
127
128     int i = m_ui.effectlist->currentRow();
129     QDomDocument doc;
130     QDomElement effect = m_currentEffectList.at(i).cloneNode().toElement();
131     doc.appendChild(doc.importNode(effect, true));
132     effect = doc.firstChild().toElement();
133     effect.removeAttribute("kdenlive_ix");
134     effect.setAttribute("id", name);
135     effect.setAttribute("type", "custom");
136     QDomElement effectname = effect.firstChildElement("name");
137     effect.removeChild(effectname);
138     effectname = doc.createElement("name");
139     QDomText nametext = doc.createTextNode(name);
140     effectname.appendChild(nametext);
141     effect.insertBefore(effectname, QDomNode());
142     QDomElement effectprops = effect.firstChildElement("properties");
143     effectprops.setAttribute("id", name);
144     effectprops.setAttribute("type", "custom");
145
146     QFile file(path);
147     if (file.open(QFile::WriteOnly | QFile::Truncate)) {
148         QTextStream out(&file);
149         out << doc.toString();
150     }
151     file.close();
152     emit reloadEffects();
153 }
154
155 void EffectStackView::slotUpdateEffectParams(const QDomElement old, const QDomElement e)
156 {
157     if (m_trackMode)
158         emit updateEffect(NULL, m_trackindex, old, e, m_ui.effectlist->currentRow());
159     else if (m_clipref)
160         emit updateEffect(m_clipref, -1, old, e, m_ui.effectlist->currentRow());
161 }
162
163 void EffectStackView::slotClipItemSelected(ClipItem* c, int ix)
164 {
165     if (c && !c->isEnabled()) return;
166     if (c && c == m_clipref) {
167         if (ix == -1) ix = m_ui.effectlist->currentRow();
168         //if (ix == -1 || ix == m_ui.effectlist->currentRow()) return;
169     } else {
170         m_clipref = c;
171         if (c) {
172             QString cname = m_clipref->clipName();
173             if (cname.length() > 20) {
174                 m_ui.checkAll->setToolTip(i18n("Effects for %1").arg(cname));
175                 cname.truncate(17);
176                 m_ui.checkAll->setText(i18n("Effects for %1").arg(cname) + "...");
177             } else {
178                 m_ui.checkAll->setToolTip(QString());
179                 m_ui.checkAll->setText(i18n("Effects for %1").arg(cname));
180             }
181             ix = c->selectedEffectIndex();
182             QString size = c->baseClip()->getProperty("frame_size");
183             double factor = c->baseClip()->getProperty("aspect_ratio").toDouble();
184             QPoint p((int)(size.section('x', 0, 0).toInt() * factor + 0.5), size.section('x', 1, 1).toInt());
185             m_effectedit->setFrameSize(p);
186             m_effectedit->setFrameSize(p);
187         } else ix = 0;
188     }
189     if (m_clipref == NULL) {
190         m_ui.effectlist->blockSignals(true);
191         m_ui.effectlist->clear();
192         m_effectedit->transferParamDesc(QDomElement(), 0, 0, 0);
193         //m_ui.region_url->clear();
194         m_ui.effectlist->blockSignals(false);
195         m_ui.checkAll->setToolTip(QString());
196         m_ui.checkAll->setText(QString());
197         setEnabled(false);
198         return;
199     }
200     setEnabled(true);
201     m_trackMode = false;
202     m_currentEffectList = m_clipref->effectList();
203     setupListView(ix);
204 }
205
206 void EffectStackView::slotTrackItemSelected(int ix, const TrackInfo info)
207 {
208     m_clipref = NULL;
209     m_trackMode = true;
210     m_currentEffectList = info.effectsList;
211     m_trackInfo = info;
212     kDebug() << "// TRACK; " << ix << ", EFFECTS: " << m_currentEffectList.count();
213     setEnabled(true);
214     m_ui.checkAll->setToolTip(QString());
215     m_ui.checkAll->setText(i18n("Effects for track %1").arg(info.trackName.isEmpty() ? QString::number(ix) : info.trackName));
216     m_trackindex = ix;
217     setupListView(0);
218 }
219
220 void EffectStackView::slotItemChanged(QListWidgetItem *item)
221 {
222     bool disable = true;
223     if (item->checkState() == Qt::Checked) disable = false;
224     m_ui.frame_layout->setEnabled(!disable);
225     m_ui.buttonReset->setEnabled(!disable);
226     int activeRow = m_ui.effectlist->currentRow();
227     if (activeRow >= 0) {
228         m_effectedit->updateParameter("disable", QString::number((int) disable));
229         if (m_trackMode)
230             emit changeEffectState(NULL, m_trackindex, activeRow, disable);
231         else
232             emit changeEffectState(m_clipref, -1, activeRow, disable);
233     }
234     slotUpdateCheckAllButton();
235 }
236
237
238 void EffectStackView::setupListView(int ix)
239 {
240     m_ui.effectlist->blockSignals(true);
241     m_ui.effectlist->clear();
242
243     // Issue 238: Add icons for effect type in effectstack.
244     KIcon videoIcon("kdenlive-show-video");
245     KIcon audioIcon("kdenlive-show-audio");
246     KIcon customIcon("kdenlive-custom-effect");
247     QListWidgetItem* item;
248
249     for (int i = 0; i < m_currentEffectList.count(); i++) {
250         const QDomElement d = m_currentEffectList.at(i).cloneNode().toElement();
251         if (d.isNull()) {
252             kDebug() << " . . . . WARNING, NULL EFFECT IN STACK!!!!!!!!!";
253             continue;
254         }
255
256         /*QDomDocument doc;
257         doc.appendChild(doc.importNode(d, true));
258         kDebug() << "IMPORTED STK: " << doc.toString();*/
259
260         QDomNode namenode = d.elementsByTagName("name").item(0);
261         if (!namenode.isNull()) {
262             // Issue 238: Add icons for effect type in effectstack.
263             // Logic more or less copied from initeffects.cpp
264             QString type = d.attribute("type", QString());
265             if ("audio" == type) {
266                 item = new QListWidgetItem(audioIcon, i18n(namenode.toElement().text().toUtf8().data()), m_ui.effectlist);
267             } else if ("custom" == type) {
268                 item = new QListWidgetItem(customIcon, i18n(namenode.toElement().text().toUtf8().data()), m_ui.effectlist);
269             } else {
270                 item = new QListWidgetItem(videoIcon, i18n(namenode.toElement().text().toUtf8().data()), m_ui.effectlist);
271             }
272             item->setFlags(Qt::ItemIsSelectable | Qt::ItemIsDragEnabled | Qt::ItemIsUserCheckable | Qt::ItemIsEnabled);
273             if (d.attribute("disable") == "1")
274                 item->setCheckState(Qt::Unchecked);
275             else
276                 item->setCheckState(Qt::Checked);
277         }
278     }
279     if (m_ui.effectlist->count() == 0) {
280         m_ui.buttonDel->setEnabled(false);
281         m_ui.buttonSave->setEnabled(false);
282         m_ui.buttonReset->setEnabled(false);
283         m_ui.buttonUp->setEnabled(false);
284         m_ui.buttonDown->setEnabled(false);
285         m_ui.checkAll->setEnabled(false);
286     } else {
287         qMin(ix, 0);
288         qMax(ix, m_ui.effectlist->count() - 1);
289         m_ui.effectlist->setCurrentRow(ix);
290         m_ui.checkAll->setEnabled(true);
291     }
292     m_ui.effectlist->blockSignals(false);
293     if (m_ui.effectlist->count() == 0) {
294         m_effectedit->transferParamDesc(QDomElement(), 0, 0, 0);
295         //m_ui.region_url->clear();
296     } else slotItemSelectionChanged(false);
297     slotUpdateCheckAllButton();
298 }
299
300 void EffectStackView::slotItemSelectionChanged(bool update)
301 {
302     bool hasItem = m_ui.effectlist->currentItem();
303     int activeRow = m_ui.effectlist->currentRow();
304     bool isChecked = false;
305     if (hasItem && m_ui.effectlist->currentItem()->checkState() == Qt::Checked) isChecked = true;
306     if (hasItem && m_ui.effectlist->currentItem()->isSelected()) {
307         QDomElement eff = m_currentEffectList.at(activeRow);
308         if (m_trackMode) {
309             // showing track effects
310             m_effectedit->transferParamDesc(eff, 0, 0, m_trackInfo.duration);
311         } else m_effectedit->transferParamDesc(eff,
312                                                    0,
313                                                    m_clipref->cropStart().frames(KdenliveSettings::project_fps()),
314                                                    (m_clipref->cropStart() + m_clipref->cropDuration()).frames(KdenliveSettings::project_fps()) - 1); //minx max frame
315         //m_ui.region_url->setUrl(KUrl(eff.attribute("region")));
316     }
317     if (!m_trackMode && m_clipref && update) m_clipref->setSelectedEffect(activeRow);
318     m_ui.buttonDel->setEnabled(hasItem);
319     m_ui.buttonSave->setEnabled(hasItem);
320     m_ui.buttonReset->setEnabled(hasItem && isChecked);
321     m_ui.buttonUp->setEnabled(activeRow > 0);
322     m_ui.buttonDown->setEnabled((activeRow < m_ui.effectlist->count() - 1) && hasItem);
323     m_ui.frame_layout->setEnabled(isChecked);
324 }
325
326 void EffectStackView::slotItemUp()
327 {
328     int activeRow = m_ui.effectlist->currentRow();
329     if (activeRow <= 0) return;
330     if (m_trackMode) emit changeEffectPosition(NULL, m_trackindex, activeRow + 1, activeRow);
331     else emit changeEffectPosition(m_clipref, -1, activeRow + 1, activeRow);
332 }
333
334 void EffectStackView::slotItemDown()
335 {
336     int activeRow = m_ui.effectlist->currentRow();
337     if (activeRow >= m_ui.effectlist->count() - 1) return;
338     if (m_trackMode) emit changeEffectPosition(NULL, m_trackindex, activeRow + 1, activeRow + 2);
339     else emit changeEffectPosition(m_clipref, -1, activeRow + 1, activeRow + 2);
340 }
341
342 void EffectStackView::slotItemDel()
343 {
344     int activeRow = m_ui.effectlist->currentRow();
345     if (activeRow >= 0) {
346         if (m_trackMode) emit removeEffect(NULL, m_trackindex, m_currentEffectList.at(activeRow).cloneNode().toElement());
347         else emit removeEffect(m_clipref, -1, m_clipref->effectAt(activeRow));
348         slotUpdateCheckAllButton();
349     }
350 }
351
352 void EffectStackView::slotResetEffect()
353 {
354     int activeRow = m_ui.effectlist->currentRow();
355     if (activeRow < 0) return;
356     QDomElement old = m_currentEffectList.at(activeRow).cloneNode().toElement();
357     QDomElement dom;
358     QString effectName = m_ui.effectlist->currentItem()->text();
359     foreach(const QString &type, m_effectLists.keys()) {
360         EffectsList *list = m_effectLists[type];
361         if (list->effectNames().contains(effectName)) {
362             dom = list->getEffectByName(effectName).cloneNode().toElement();
363             break;
364         }
365     }
366     if (!dom.isNull()) {
367         dom.setAttribute("kdenlive_ix", old.attribute("kdenlive_ix"));
368         if (m_trackMode) {
369             EffectsList::setParameter(dom, "in", QString::number(0));
370             EffectsList::setParameter(dom, "out", QString::number(m_trackInfo.duration));
371             m_effectedit->transferParamDesc(dom, 0, 0, m_trackInfo.duration);//minx max frame
372             emit updateEffect(NULL, m_trackindex, old, dom, activeRow);
373         } else {
374             m_clipref->initEffect(dom);
375             m_effectedit->transferParamDesc(dom, 0, m_clipref->cropStart().frames(KdenliveSettings::project_fps()), (m_clipref->cropStart() + m_clipref->cropDuration()).frames(KdenliveSettings::project_fps()));//minx max frame
376             //m_ui.region_url->setUrl(KUrl(dom.attribute("region")));
377             emit updateEffect(m_clipref, -1, old, dom, activeRow);
378         }
379     }
380 }
381
382
383 void EffectStackView::raiseWindow(QWidget* dock)
384 {
385     if ((m_clipref || m_trackMode) && dock)
386         dock->raise();
387 }
388
389 void EffectStackView::clear()
390 {
391     m_ui.effectlist->blockSignals(true);
392     m_ui.effectlist->clear();
393     m_ui.buttonDel->setEnabled(false);
394     m_ui.buttonSave->setEnabled(false);
395     m_ui.buttonReset->setEnabled(false);
396     m_ui.buttonUp->setEnabled(false);
397     m_ui.buttonDown->setEnabled(false);
398     m_ui.checkAll->setEnabled(false);
399     m_effectedit->transferParamDesc(QDomElement(), 0, 0, 0);
400     //m_ui.region_url->clear();
401     m_ui.effectlist->blockSignals(false);
402 }
403
404
405 void EffectStackView::slotSeekTimeline(int pos)
406 {
407     if (m_trackMode) {
408         emit seekTimeline(pos);
409     } else if (m_clipref) {
410         emit seekTimeline(m_clipref->startPos().frames(KdenliveSettings::project_fps()) + pos);
411     }
412 }
413
414 void EffectStackView::slotUpdateCheckAllButton()
415 {
416     bool hasEnabled = false;
417     bool hasDisabled = false;
418     for (int i = 0; i < m_ui.effectlist->count(); ++i) {
419         if (m_ui.effectlist->item(i)->checkState() == Qt::Checked)
420             hasEnabled = true;
421         else
422             hasDisabled = true;
423     }
424
425     m_ui.checkAll->blockSignals(true);
426     if (hasEnabled && hasDisabled)
427         m_ui.checkAll->setCheckState(Qt::PartiallyChecked);
428     else if (hasEnabled)
429         m_ui.checkAll->setCheckState(Qt::Checked);
430     else
431         m_ui.checkAll->setCheckState(Qt::Unchecked);
432     m_ui.checkAll->blockSignals(false);
433 }
434
435 void EffectStackView::slotCheckAll(int state)
436 {
437     if (state == 1) {
438         state = 2;
439         m_ui.checkAll->blockSignals(true);
440         m_ui.checkAll->setCheckState(Qt::Checked);
441         m_ui.checkAll->blockSignals(false);
442     }
443
444     bool disabled = (state != 2);
445     m_effectedit->updateParameter("disable", QString::number((int) disabled));
446     for (int i = 0; i < m_ui.effectlist->count(); ++i) {
447         if (m_ui.effectlist->item(i)->checkState() != (Qt::CheckState)state) {
448             m_ui.effectlist->item(i)->setCheckState((Qt::CheckState)state);
449             if (m_trackMode)
450                 emit changeEffectState(NULL, m_trackindex, i, disabled);
451             else
452                 emit changeEffectState(m_clipref, -1, i, disabled);
453         }
454     }
455 }
456
457 /*void EffectStackView::slotRegionChanged()
458 {
459     if (!m_trackMode) emit updateClipRegion(m_clipref, m_ui.effectlist->currentRow(), m_ui.region_url->text());
460 }*/
461
462 void EffectStackView::slotCheckMonitorPosition(int renderPos)
463 {
464     if (m_trackMode || (renderPos >= m_clipref->startPos().frames(KdenliveSettings::project_fps()) && renderPos <= m_clipref->endPos().frames(KdenliveSettings::project_fps()))) {
465         if (!m_monitor->getEffectScene()->views().at(0)->isVisible())
466             m_monitor->slotEffectScene(true);
467     } else {
468         m_monitor->slotEffectScene(false);
469     }
470 }
471
472 void EffectStackView::slotRenderPos(int pos)
473 {
474     if (m_effectedit) {
475         if (m_trackMode) {
476             m_effectedit->slotSyncEffectsPos(pos);
477         } else if (m_clipref) {
478             m_effectedit->slotSyncEffectsPos(pos - m_clipref->startPos().frames(KdenliveSettings::project_fps()));
479         }
480     }
481 }
482
483 int EffectStackView::isTrackMode(bool *ok) const
484 {
485     *ok = m_trackMode;
486     return m_trackindex;
487 }
488
489 #include "effectstackview.moc"