]> git.sesse.net Git - kdenlive/blob - src/effectstack/collapsibleeffect.cpp
Merge branch 'master' into feature/pkey
[kdenlive] / src / effectstack / collapsibleeffect.cpp
1 /***************************************************************************
2  *   Copyright (C) 2008 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
3  *                                                                         *
4  *   This program is free software; you can redistribute it and/or modify  *
5  *   it under the terms of the GNU General Public License as published by  *
6  *   the Free Software Foundation; either version 2 of the License, or     *
7  *   (at your option) any later version.                                   *
8  *                                                                         *
9  *   This program is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU General Public License for more details.                          *
13  *                                                                         *
14  *   You should have received a copy of the GNU General Public License     *
15  *   along with this program; if not, write to the                         *
16  *   Free Software Foundation, Inc.,                                       *
17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
18  ***************************************************************************/
19
20
21 #include "collapsibleeffect.h"
22 #include "effectslist.h"
23 #include "kdenlivesettings.h"
24 #include "projectlist.h"
25
26 #include <QInputDialog>
27 #include <QDialog>
28 #include <QMenu>
29 #include <QVBoxLayout>
30 #include <QLabel>
31 #include <QProgressBar>
32 #include <QWheelEvent>
33
34 #include <KDebug>
35 #include <KComboBox>
36 #include <KGlobalSettings>
37 #include <KLocale>
38 #include <KMessageBox>
39 #include <KStandardDirs>
40 #include <KFileDialog>
41 #include <KApplication>
42
43
44 CollapsibleEffect::CollapsibleEffect(QDomElement effect, QDomElement original_effect, ItemInfo info, EffectMetaInfo *metaInfo, bool lastEffect, QWidget * parent) :
45         AbstractCollapsibleWidget(parent),
46         m_paramWidget(NULL),
47         m_effect(effect),
48         m_original_effect(original_effect),
49         m_lastEffect(lastEffect),
50         m_regionEffect(false)
51 {
52     if (m_effect.attribute("tag") == "region") {
53         m_regionEffect = true;
54         decoframe->setObjectName("decoframegroup");
55     }
56     filterWheelEvent = true;
57     m_info.fromString(effect.attribute("kdenlive_info"));
58     setFont(KGlobalSettings::smallestReadableFont());
59     buttonUp->setIcon(KIcon("kdenlive-up"));
60     buttonUp->setToolTip(i18n("Move effect up"));
61     if (!lastEffect) {
62         buttonDown->setIcon(KIcon("kdenlive-down"));
63         buttonDown->setToolTip(i18n("Move effect down"));
64     }
65     buttonDel->setIcon(KIcon("kdenlive-deleffect"));
66     buttonDel->setToolTip(i18n("Delete effect"));
67     if (effectIndex() == 1) buttonUp->setVisible(false);
68     if (m_lastEffect) buttonDown->setVisible(false);
69     //buttonUp->setVisible(false);
70     //buttonDown->setVisible(false);
71     
72     /*buttonReset->setIcon(KIcon("view-refresh"));
73     buttonReset->setToolTip(i18n("Reset effect"));*/
74     //checkAll->setToolTip(i18n("Enable/Disable all effects"));
75     //buttonShowComments->setIcon(KIcon("help-about"));
76     //buttonShowComments->setToolTip(i18n("Show additional information for the parameters"));
77     m_menu = new QMenu;
78     m_menu->addAction(KIcon("view-refresh"), i18n("Reset Effect"), this, SLOT(slotResetEffect()));
79     m_menu->addAction(KIcon("document-save"), i18n("Save Effect"), this, SLOT(slotSaveEffect()));
80     
81     QDomElement namenode = m_effect.firstChildElement("name");
82     if (namenode.isNull()) return;
83     QString effectname = i18n(namenode.text().toUtf8().data());
84     if (m_regionEffect) effectname.append(':' + KUrl(EffectsList::parameter(m_effect, "resource")).fileName());
85     
86     QHBoxLayout *l = static_cast <QHBoxLayout *>(frame->layout());
87     title = new QLabel(this);
88     l->insertWidget(2, title);
89     
90     title->setText(effectname);
91     /*
92      * Do not show icon, makes too much visual noise
93     QString type = m_effect.attribute("type", QString());
94     KIcon icon;
95     if (type == "audio") icon = KIcon("kdenlive-show-audio");
96     else if (m_effect.attribute("tag") == "region") icon = KIcon("kdenlive-mask-effect");
97     else if (type == "custom") icon = KIcon("kdenlive-custom-effect");
98     else icon = KIcon("kdenlive-show-video");
99     effecticon->setPixmap(icon.pixmap(16,16));*/
100     m_groupAction = new QAction(KIcon("folder-new"), i18n("Create Group"), this);
101     connect(m_groupAction, SIGNAL(triggered(bool)), this, SLOT(slotCreateGroup()));
102
103     if (!m_regionEffect) {
104         if (m_info.groupIndex == -1) m_menu->addAction(m_groupAction);
105         m_menu->addAction(KIcon("folder-new"), i18n("Create Region"), this, SLOT(slotCreateRegion()));
106     }
107     setupWidget(info, metaInfo);
108     setAcceptDrops(true);
109     menuButton->setIcon(KIcon("kdenlive-menu"));
110     menuButton->setMenu(m_menu);
111     
112     if (m_effect.attribute("disable") == "1") {
113         title->setEnabled(false);
114         enabledButton->setChecked(true);
115         enabledButton->setIcon(KIcon("novisible"));
116     }
117     else {
118         enabledButton->setChecked(false);
119         enabledButton->setIcon(KIcon("visible"));
120     }
121
122     connect(collapseButton, SIGNAL(clicked()), this, SLOT(slotSwitch()));
123     connect(enabledButton, SIGNAL(toggled(bool)), this, SLOT(slotDisable(bool)));
124     connect(buttonUp, SIGNAL(clicked()), this, SLOT(slotEffectUp()));
125     connect(buttonDown, SIGNAL(clicked()), this, SLOT(slotEffectDown()));
126     connect(buttonDel, SIGNAL(clicked()), this, SLOT(slotDeleteEffect()));
127
128     Q_FOREACH( QSpinBox * sp, findChildren<QSpinBox*>() ) {
129         sp->installEventFilter( this );
130         sp->setFocusPolicy( Qt::StrongFocus );
131     }
132     Q_FOREACH( KComboBox * cb, findChildren<KComboBox*>() ) {
133         cb->installEventFilter( this );
134         cb->setFocusPolicy( Qt::StrongFocus );
135     }
136     Q_FOREACH( QProgressBar * cb, findChildren<QProgressBar*>() ) {
137         cb->installEventFilter( this );
138         cb->setFocusPolicy( Qt::StrongFocus );
139     }
140 }
141
142 CollapsibleEffect::~CollapsibleEffect()
143 {
144     if (m_paramWidget) delete m_paramWidget;
145     delete m_menu;
146 }
147
148 void CollapsibleEffect::slotCreateGroup()
149 {
150     emit createGroup(effectIndex());
151 }
152
153 void CollapsibleEffect::slotCreateRegion()
154 {
155     QString allExtensions = ProjectList::getExtensions();
156     const QString dialogFilter = allExtensions + ' ' + QLatin1Char('|') + i18n("All Supported Files") + "\n* " + QLatin1Char('|') + i18n("All Files");
157     QPointer<KFileDialog> d = new KFileDialog(KUrl("kfiledialog:///clipfolder"), dialogFilter, kapp->activeWindow());
158     d->setOperationMode(KFileDialog::Opening);
159     d->setMode(KFile::File);
160     if (d->exec() == QDialog::Accepted) {
161         KUrl url = d->selectedUrl();
162         if (!url.isEmpty()) emit createRegion(effectIndex(), url);
163     }
164     delete d;
165 }
166
167 void CollapsibleEffect::slotUnGroup()
168 {
169     emit unGroup(this);
170 }
171
172 bool CollapsibleEffect::eventFilter( QObject * o, QEvent * e ) 
173 {
174     if (e->type() == QEvent::Enter) {
175         frame->setProperty("mouseover", true);
176         frame->setStyleSheet(frame->styleSheet());
177         return QWidget::eventFilter(o, e);
178     }
179     if (e->type() == QEvent::Wheel) {
180         QWheelEvent *we = static_cast<QWheelEvent *>(e);
181         if (!filterWheelEvent || we->modifiers() != Qt::NoModifier) {
182             e->accept();
183             return false;
184         }
185         if (qobject_cast<QAbstractSpinBox*>(o)) {
186             if(qobject_cast<QAbstractSpinBox*>(o)->focusPolicy() == Qt::WheelFocus)
187             {
188                 e->accept();
189                 return false;
190             }
191             else
192             {
193                 e->ignore();
194                 return true;
195             }
196         }
197         if (qobject_cast<KComboBox*>(o)) {
198             if(qobject_cast<KComboBox*>(o)->focusPolicy() == Qt::WheelFocus)
199             {
200                 e->accept();
201                 return false;
202             }
203             else
204             {
205                 e->ignore();
206                 return true;
207             }
208         }
209         if (qobject_cast<QProgressBar*>(o)) {
210             if(qobject_cast<QProgressBar*>(o)->focusPolicy() == Qt::WheelFocus)
211             {
212                 e->accept();
213                 return false;
214             }
215             else
216             {
217                 e->ignore();
218                 return true;
219             }
220         }
221     }
222     return QWidget::eventFilter(o, e);
223 }
224
225 QDomElement CollapsibleEffect::effect() const
226 {
227     return m_effect;
228 }
229
230 bool CollapsibleEffect::isActive() const
231 {
232     return decoframe->property("active").toBool();
233 }
234
235 void CollapsibleEffect::setActive(bool activate)
236 {
237     decoframe->setProperty("active", activate);
238     decoframe->setStyleSheet(decoframe->styleSheet());
239 }
240
241 void CollapsibleEffect::mouseDoubleClickEvent ( QMouseEvent * event )
242 {
243     if (frame->underMouse() && collapseButton->isEnabled()) {
244         event->accept();
245         slotSwitch();
246     }
247     else event->ignore();
248 }
249
250 void CollapsibleEffect::mouseReleaseEvent( QMouseEvent *event )
251 {
252   if (!decoframe->property("active").toBool()) emit activateEffect(effectIndex());
253   QWidget::mouseReleaseEvent(event);
254 }
255
256 void CollapsibleEffect::slotDisable(bool disable, bool emitInfo)
257 {
258     title->setEnabled(!disable);
259     enabledButton->blockSignals(true);
260     enabledButton->setChecked(disable);
261     enabledButton->blockSignals(false);
262     enabledButton->setIcon(disable ? KIcon("novisible") : KIcon("visible"));
263     m_effect.setAttribute("disable", disable ? 1 : 0);
264     if (!disable || KdenliveSettings::disable_effect_parameters()) {
265         widgetFrame->setEnabled(!disable);
266     }
267     if (emitInfo) emit effectStateChanged(disable, effectIndex(), isActive() && needsMonitorEffectScene());
268 }
269
270 void CollapsibleEffect::slotDeleteEffect()
271 {
272     emit deleteEffect(m_effect);
273 }
274
275 void CollapsibleEffect::slotEffectUp()
276 {
277     emit changeEffectPosition(QList <int>() <<effectIndex(), true);
278 }
279
280 void CollapsibleEffect::slotEffectDown()
281 {
282     emit changeEffectPosition(QList <int>() <<effectIndex(), false);
283 }
284
285 void CollapsibleEffect::slotSaveEffect()
286 {
287     QString name = QInputDialog::getText(this, i18n("Save Effect"), i18n("Name for saved effect: "));
288     if (name.isEmpty()) return;
289     QString path = KStandardDirs::locateLocal("appdata", "effects/", true);
290     path = path + name + ".xml";
291     if (QFile::exists(path)) if (KMessageBox::questionYesNo(this, i18n("File %1 already exists.\nDo you want to overwrite it?", path)) == KMessageBox::No) return;
292
293     QDomDocument doc;
294     QDomElement effect = m_effect.cloneNode().toElement();
295     doc.appendChild(doc.importNode(effect, true));
296     effect = doc.firstChild().toElement();
297     effect.removeAttribute("kdenlive_ix");
298     effect.setAttribute("id", name);
299     effect.setAttribute("type", "custom");
300     QDomElement effectname = effect.firstChildElement("name");
301     effect.removeChild(effectname);
302     effectname = doc.createElement("name");
303     QDomText nametext = doc.createTextNode(name);
304     effectname.appendChild(nametext);
305     effect.insertBefore(effectname, QDomNode());
306     QDomElement effectprops = effect.firstChildElement("properties");
307     effectprops.setAttribute("id", name);
308     effectprops.setAttribute("type", "custom");
309
310     QFile file(path);
311     if (file.open(QFile::WriteOnly | QFile::Truncate)) {
312         QTextStream out(&file);
313         out << doc.toString();
314     }
315     file.close();
316     emit reloadEffects();
317 }
318
319 void CollapsibleEffect::slotResetEffect()
320 {
321     emit resetEffect(effectIndex());
322 }
323
324 void CollapsibleEffect::slotSwitch()
325 {
326     bool enable = !widgetFrame->isVisible();
327     slotShow(enable);
328 }
329
330 void CollapsibleEffect::slotShow(bool show)
331 {
332     widgetFrame->setVisible(show);
333     if (show) {
334         collapseButton->setArrowType(Qt::DownArrow);
335         m_info.isCollapsed = false;
336     }
337     else {
338         collapseButton->setArrowType(Qt::RightArrow);
339         m_info.isCollapsed = true;
340     }
341     updateCollapsedState();
342 }
343
344 void CollapsibleEffect::groupStateChanged(bool collapsed)
345 {
346     m_info.groupIsCollapsed = collapsed;
347     updateCollapsedState();
348 }
349
350 void CollapsibleEffect::updateCollapsedState()
351 {
352     QString info = m_info.toString();
353     if (info != m_effect.attribute("kdenlive_info")) {
354         m_effect.setAttribute("kdenlive_info", info);
355         emit parameterChanged(m_original_effect, m_effect, effectIndex());   
356     }
357 }
358
359 void CollapsibleEffect::setGroupIndex(int ix)
360 {
361     if (m_info.groupIndex == -1 && ix != -1) {
362         m_menu->removeAction(m_groupAction); 
363     }
364     else if (m_info.groupIndex != -1 && ix == -1) {
365         m_menu->addAction(m_groupAction); 
366     }
367     m_info.groupIndex = ix;
368     m_effect.setAttribute("kdenlive_info", m_info.toString());
369 }
370
371 void CollapsibleEffect::setGroupName(const QString &groupName)
372 {
373     m_info.groupName = groupName;
374     m_effect.setAttribute("kdenlive_info", m_info.toString());
375 }
376
377 QString CollapsibleEffect::infoString() const
378 {
379     return m_info.toString();
380 }
381
382 void CollapsibleEffect::removeFromGroup()
383 {
384     if (m_info.groupIndex != -1) {
385         m_menu->addAction(m_groupAction); 
386     }
387     m_info.groupIndex = -1;
388     m_info.groupName.clear();
389     m_effect.setAttribute("kdenlive_info", m_info.toString());
390     emit parameterChanged(m_original_effect, m_effect, effectIndex());
391 }
392
393 int CollapsibleEffect::groupIndex() const
394 {
395     return m_info.groupIndex;
396 }
397
398 int CollapsibleEffect::effectIndex() const
399 {
400     if (m_effect.isNull()) return -1;
401     return m_effect.attribute("kdenlive_ix").toInt();
402 }
403
404 void CollapsibleEffect::updateWidget(ItemInfo info, QDomElement effect, EffectMetaInfo *metaInfo)
405 {
406     if (m_paramWidget) {
407         // cleanup
408         delete m_paramWidget;
409         m_paramWidget = NULL;
410     }
411     m_effect = effect;
412     setupWidget(info, metaInfo);
413 }
414
415 void CollapsibleEffect::setupWidget(ItemInfo info, EffectMetaInfo *metaInfo)
416 {
417     if (m_effect.isNull()) {
418 //         kDebug() << "// EMPTY EFFECT STACK";
419         return;
420     }
421
422     if (m_effect.attribute("tag") == "region") {
423         m_regionEffect = true;
424         QDomNodeList effects =  m_effect.elementsByTagName("effect");
425         QDomNodeList origin_effects =  m_original_effect.elementsByTagName("effect");
426         m_paramWidget = new ParameterContainer(m_effect, info, metaInfo, widgetFrame);
427         QWidget *container = new QWidget(widgetFrame);
428         QVBoxLayout *vbox = static_cast<QVBoxLayout *> (widgetFrame->layout());
429         vbox->addWidget(container);
430        // m_paramWidget = new ParameterContainer(m_effect.toElement(), info, metaInfo, container);
431         for (int i = 0; i < effects.count(); i++) {
432             CollapsibleEffect *coll = new CollapsibleEffect(effects.at(i).toElement(), origin_effects.at(i).toElement(), info, metaInfo, container);
433             m_subParamWidgets.append(coll);
434             connect(coll, SIGNAL(parameterChanged(const QDomElement, const QDomElement, int)), this , SLOT(slotUpdateRegionEffectParams(const QDomElement, const QDomElement, int)));
435             //container = new QWidget(widgetFrame);
436             vbox->addWidget(coll);
437             //p = new ParameterContainer(effects.at(i).toElement(), info, isEffect, container);
438         }
439         
440     }
441     else {
442         m_paramWidget = new ParameterContainer(m_effect, info, metaInfo, widgetFrame);
443         connect(m_paramWidget, SIGNAL(disableCurrentFilter(bool)), this, SLOT(slotDisableEffect(bool)));
444         if (m_effect.firstChildElement("parameter").isNull()) {
445             // Effect has no parameter, don't allow expand
446             collapseButton->setEnabled(false);
447             collapseButton->setVisible(false);
448             widgetFrame->setVisible(false);            
449         }
450     }
451     if (collapseButton->isEnabled() && m_info.isCollapsed) {
452         widgetFrame->setVisible(false);
453         collapseButton->setArrowType(Qt::RightArrow);
454         
455     }
456     connect (m_paramWidget, SIGNAL(parameterChanged(const QDomElement, const QDomElement, int)), this, SIGNAL(parameterChanged(const QDomElement, const QDomElement, int)));
457     
458     connect(m_paramWidget, SIGNAL(startFilterJob(QString,QString,QString,QString,const QMap <QString, QString>)), this, SIGNAL(startFilterJob(QString,QString,QString,QString,const QMap <QString, QString>)));
459     
460     connect (this, SIGNAL(syncEffectsPos(int)), m_paramWidget, SIGNAL(syncEffectsPos(int)));
461     connect (m_paramWidget, SIGNAL(checkMonitorPosition(int)), this, SIGNAL(checkMonitorPosition(int)));
462     connect (m_paramWidget, SIGNAL(seekTimeline(int)), this, SIGNAL(seekTimeline(int)));
463     connect(m_paramWidget, SIGNAL(importClipKeyframes()), this, SIGNAL(importClipKeyframes()));
464     
465     
466 }
467
468 void CollapsibleEffect::slotDisableEffect(bool disable)
469 {
470     title->setEnabled(!disable);
471     enabledButton->blockSignals(true);
472     enabledButton->setChecked(disable);
473     enabledButton->blockSignals(false);
474     enabledButton->setIcon(disable ? KIcon("novisible") : KIcon("visible"));
475     m_effect.setAttribute("disable", disable ? 1 : 0);
476     emit effectStateChanged(disable, effectIndex(), isActive() && needsMonitorEffectScene());
477 }
478
479 bool CollapsibleEffect::isGroup() const
480 {
481     return false;
482 }
483
484 void CollapsibleEffect::updateTimecodeFormat()
485 {
486     m_paramWidget->updateTimecodeFormat();
487     if (!m_subParamWidgets.isEmpty()) {
488         // we have a group
489         for (int i = 0; i < m_subParamWidgets.count(); i++)
490             m_subParamWidgets.at(i)->updateTimecodeFormat();
491     }
492 }
493
494 void CollapsibleEffect::slotUpdateRegionEffectParams(const QDomElement /*old*/, const QDomElement /*e*/, int /*ix*/)
495 {
496     kDebug()<<"// EMIT CHANGE SUBEFFECT.....:";
497     emit parameterChanged(m_original_effect, m_effect, effectIndex());
498 }
499
500 void CollapsibleEffect::slotSyncEffectsPos(int pos)
501 {
502     emit syncEffectsPos(pos);
503 }
504
505 void CollapsibleEffect::dragEnterEvent(QDragEnterEvent *event)
506 {
507     if (event->mimeData()->hasFormat("kdenlive/effectslist")) {
508         frame->setProperty("target", true);
509         frame->setStyleSheet(frame->styleSheet());
510         event->acceptProposedAction();
511     }
512 }
513
514 void CollapsibleEffect::dragLeaveEvent(QDragLeaveEvent */*event*/)
515 {
516     frame->setProperty("target", false);
517     frame->setStyleSheet(frame->styleSheet());
518 }
519
520 void CollapsibleEffect::dropEvent(QDropEvent *event)
521 {
522     frame->setProperty("target", false);
523     frame->setStyleSheet(frame->styleSheet());
524     const QString effects = QString::fromUtf8(event->mimeData()->data("kdenlive/effectslist"));
525     //event->acceptProposedAction();
526     QDomDocument doc;
527     doc.setContent(effects, true);
528     QDomElement e = doc.documentElement();
529     int ix = e.attribute("kdenlive_ix").toInt();
530     int currentEffectIx = effectIndex();
531     if (ix == currentEffectIx) {
532         // effect dropped on itself, reject
533         event->ignore();
534         return;
535     }
536     if (ix == 0 || e.tagName() == "effectgroup") {
537         if (e.tagName() == "effectgroup") {
538             // moving a group
539             QDomNodeList subeffects = e.elementsByTagName("effect");
540             if (subeffects.isEmpty()) {
541                 event->ignore();
542                 return;
543             }
544             EffectInfo info;
545             info.fromString(subeffects.at(0).toElement().attribute("kdenlive_info"));
546             event->setDropAction(Qt::MoveAction);
547             event->accept();
548             if (info.groupIndex >= 0) {
549                 // Moving group
550                 QList <int> effectsIds;
551                 // Collect moved effects ids
552                 for (int i = 0; i < subeffects.count(); i++) {
553                     QDomElement effect = subeffects.at(i).toElement();
554                     effectsIds << effect.attribute("kdenlive_ix").toInt();
555                 }
556                 emit moveEffect(effectsIds, currentEffectIx, info.groupIndex, info.groupName);
557             }
558             else {
559                 // group effect dropped from effect list
560                 if (m_info.groupIndex > -1) {
561                     // TODO: Should we merge groups??
562                     
563                 }
564                 emit addEffect(e);
565             }
566             return;
567         }
568         // effect dropped from effects list, add it
569         e.setAttribute("kdenlive_ix", ix);
570         if (m_info.groupIndex > -1) {
571             // Dropped on a group
572             e.setAttribute("kdenlive_info", m_info.toString());
573         }
574         event->setDropAction(Qt::CopyAction);
575         event->accept();
576         emit addEffect(e);
577         return;
578     }
579     emit moveEffect(QList <int> () <<ix, currentEffectIx, m_info.groupIndex, m_info.groupName);
580     event->setDropAction(Qt::MoveAction);
581     event->accept();
582 }
583
584
585 void CollapsibleEffect::adjustButtons(int ix, int max)
586 {
587     buttonUp->setVisible(ix > 0);
588     buttonDown->setVisible(ix < max - 1);
589 }
590
591 bool CollapsibleEffect::needsMonitorEffectScene() const
592 {
593     return m_paramWidget->needsMonitorEffectScene();
594 }
595
596 void CollapsibleEffect::setRange(int inPoint , int outPoint)
597 {
598     m_paramWidget->setRange(inPoint, outPoint);
599 }