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