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