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