]> git.sesse.net Git - kdenlive/blob - src/keyframeedit.cpp
Make it possible to add a comment explaining effect parameters (for now only double...
[kdenlive] / src / keyframeedit.cpp
1 /***************************************************************************
2                           geomeytrval.cpp  -  description
3                              -------------------
4     begin                : 03 Aug 2008
5     copyright            : (C) 2008 by Marco Gittler
6     email                : g.marco@freenet.de
7  ***************************************************************************/
8
9 /***************************************************************************
10  *                                                                         *
11  *   This program is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU General Public License as published by  *
13  *   the Free Software Foundation; either version 2 of the License, or     *
14  *   (at your option) any later version.                                   *
15  *                                                                         *
16  ***************************************************************************/
17
18 #include "keyframeedit.h"
19 #include "doubleparameterwidget.h"
20 #include "kdenlivesettings.h"
21
22 #include <KDebug>
23 #include <KGlobalSettings>
24
25 #include <QHeaderView>
26 #include <QButtonGroup>
27 #include <QRadioButton>
28
29 KeyframeEdit::KeyframeEdit(QDomElement e, int minFrame, int maxFrame, Timecode tc, int activeKeyframe, QWidget* parent) :
30         QWidget(parent),
31         m_min(minFrame),
32         m_max(maxFrame),
33         m_timecode(tc)
34 {
35     setupUi(this);
36     if (m_max == -1) {
37         // special case: keyframe for tracks, do not allow keyframes
38         widgetTable->setHidden(true);
39     }
40     keyframe_list->setFont(KGlobalSettings::generalFont());
41     buttonSeek->setChecked(KdenliveSettings::keyframeseek());
42     connect(buttonSeek, SIGNAL(toggled(bool)), this, SLOT(slotSetSeeking(bool)));
43
44     buttonKeyframes->setIcon(KIcon("list-add"));
45     button_add->setIcon(KIcon("list-add"));
46     button_add->setToolTip(i18n("Add keyframe"));
47     button_delete->setIcon(KIcon("list-remove"));
48     button_delete->setToolTip(i18n("Delete keyframe"));
49     buttonResetKeyframe->setIcon(KIcon("edit-undo"));
50     buttonSeek->setIcon(KIcon("insert-link"));
51     connect(keyframe_list, SIGNAL(itemSelectionChanged()), this, SLOT(slotAdjustKeyframeInfo()));
52     connect(keyframe_list, SIGNAL(cellChanged(int, int)), this, SLOT(slotGenerateParams(int, int)));
53
54     m_showButtons = new QButtonGroup(this);
55     m_slidersLayout = new QGridLayout(param_sliders);
56     keyframe_list->setSelectionBehavior(QAbstractItemView::SelectRows);
57     keyframe_list->setSelectionMode(QAbstractItemView::SingleSelection);
58     addParameter(e, activeKeyframe);
59     keyframe_list->resizeRowsToContents();
60
61     //keyframe_list->horizontalHeader()->resizeSections(QHeaderView::ResizeToContents);
62     connect(button_delete, SIGNAL(clicked()), this, SLOT(slotDeleteKeyframe()));
63     connect(button_add, SIGNAL(clicked()), this, SLOT(slotAddKeyframe()));
64     connect(buttonKeyframes, SIGNAL(clicked()), this, SLOT(slotKeyframeMode()));
65     connect(buttonResetKeyframe, SIGNAL(clicked()), this, SLOT(slotResetKeyframe()));
66     connect(keyframe_pos, SIGNAL(valueChanged(int)), this, SLOT(slotAdjustKeyframePos(int)));
67     connect(m_showButtons, SIGNAL(buttonClicked(int)), this, SLOT(slotUpdateVisibleParameter(int)));
68
69     //connect(keyframe_list, SIGNAL(itemDoubleClicked(QTreeWidgetItem *, int)), this, SLOT(slotSaveCurrentParam(QTreeWidgetItem *, int)));
70
71     keyframe_pos->setPageStep(1);
72     if (!keyframe_list->currentItem()) {
73         keyframe_list->setCurrentCell(0, 0);
74         keyframe_list->selectRow(0);
75     }
76     // ensure the keyframe list shows at least 3 lines
77     keyframe_list->setMinimumHeight(QFontInfo(keyframe_list->font()).pixelSize() * 9);
78
79     // Do not show keyframe table if only one keyframe exists at the beginning
80     if (keyframe_list->rowCount() < 2 && getPos(0) == m_min && m_max != -1)
81         widgetTable->setHidden(true);
82     else
83         buttonKeyframes->setHidden(true);
84 }
85
86 KeyframeEdit::~KeyframeEdit()
87 {
88     keyframe_list->blockSignals(true);
89     keyframe_list->clear();
90     QLayoutItem *child;
91     while ((child = m_slidersLayout->takeAt(0)) != 0) {
92         QWidget *wid = child->widget();
93         delete child;
94         if (wid)
95             delete wid;
96     }
97 }
98
99 void KeyframeEdit::addParameter(QDomElement e, int activeKeyframe)
100 {
101     keyframe_list->blockSignals(true);
102     m_params.append(e.cloneNode().toElement());
103
104     QDomNode na = e.firstChildElement("name");
105     QString paramName = i18n(na.toElement().text().toUtf8().data());
106     QDomNode commentNode = e.firstChildElement("comment");
107     QString comment;
108     if (!commentNode.isNull())
109         comment = i18n(commentNode.toElement().text().toUtf8().data());
110
111     int columnId = keyframe_list->columnCount();
112     keyframe_list->insertColumn(columnId);
113     keyframe_list->setHorizontalHeaderItem(columnId, new QTableWidgetItem(paramName));
114
115     DoubleParameterWidget *doubleparam = new DoubleParameterWidget(paramName, 0,
116             m_params.at(columnId).attribute("min").toInt(), m_params.at(columnId).attribute("max").toInt(),
117             m_params.at(columnId).attribute("default").toInt(), comment, m_params.at(columnId).attribute("suffix"), this);
118     connect(doubleparam, SIGNAL(valueChanged(int)), this, SLOT(slotAdjustKeyframeValue(int)));
119     m_slidersLayout->addWidget(doubleparam, columnId, 0);
120
121     QRadioButton *radio = new QRadioButton(this);
122     m_showButtons->addButton(radio, columnId);
123     if (e.attribute("intimeline") == "1")
124         radio->setChecked(true);
125     m_slidersLayout->addWidget(radio, columnId, 1);
126
127     QStringList frames = e.attribute("keyframes").split(";", QString::SkipEmptyParts);
128     for (int i = 0; i < frames.count(); i++) {
129         int frame = frames.at(i).section(':', 0, 0).toInt();
130         bool found = false;
131         int j;
132         for (j = 0; j < keyframe_list->rowCount(); j++) {
133             int currentPos = getPos(j);
134             if (frame == currentPos) {
135                 keyframe_list->setItem(j, columnId, new QTableWidgetItem(frames.at(i).section(':', 1, 1)));
136                 found = true;
137                 break;
138             } else if (currentPos > frame) {
139                 break;
140             }
141         }
142         if (!found) {
143             keyframe_list->insertRow(j);
144             keyframe_list->setVerticalHeaderItem(j, new QTableWidgetItem(getPosString(frame)));
145             keyframe_list->setItem(j, columnId, new QTableWidgetItem(frames.at(i).section(':', 1, 1)));
146             keyframe_list->resizeRowToContents(j);
147         }
148         if ((activeKeyframe > -1) && (activeKeyframe == frame)) {
149             keyframe_list->setCurrentCell(i, columnId);
150             keyframe_list->selectRow(i);
151         }
152     }
153     keyframe_list->resizeColumnsToContents();
154     keyframe_list->blockSignals(false);
155     slotAdjustKeyframeInfo(false);
156     button_delete->setEnabled(keyframe_list->rowCount() > 1);
157 }
158
159 void KeyframeEdit::slotDeleteKeyframe()
160 {
161     if (keyframe_list->rowCount() < 2)
162         return;
163     int col = keyframe_list->currentColumn();
164     int row = keyframe_list->currentRow();
165     keyframe_list->removeRow(keyframe_list->currentRow());
166     row = qMin(row, keyframe_list->rowCount() - 1);
167     keyframe_list->setCurrentCell(row, col);
168     keyframe_list->selectRow(row);
169     generateAllParams();
170     button_delete->setEnabled(keyframe_list->rowCount() > 1);
171 }
172
173 void KeyframeEdit::slotAddKeyframe()
174 {
175     keyframe_list->blockSignals(true);
176     QTableWidgetItem *item = keyframe_list->currentItem();
177     int row = keyframe_list->currentRow();
178     int col = keyframe_list->currentColumn();
179     int newrow = row;
180     int pos1 = getPos(row);
181
182     int result;
183     if (row < (keyframe_list->rowCount() - 1)) {
184         result = pos1 + (getPos(row + 1) - pos1) / 2;
185         newrow++;
186     } else if (row == 0) {
187         if (pos1 == m_min) {
188             result = m_max - 1;
189             newrow++;
190         } else {
191             result = m_min;
192         }
193     } else {
194         int pos2 = getPos(row - 1);
195         result = pos2 + (pos1 - pos2) / 2;
196     }
197
198     keyframe_list->insertRow(newrow);
199     keyframe_list->setVerticalHeaderItem(newrow, new QTableWidgetItem(getPosString(result)));
200     for (int i = 0; i < keyframe_list->columnCount(); i++)
201         keyframe_list->setItem(newrow, i, new QTableWidgetItem(keyframe_list->item(item->row(), i)->text()));
202
203     keyframe_list->resizeRowsToContents();
204     slotAdjustKeyframeInfo();
205     keyframe_list->blockSignals(false);
206     generateAllParams();
207     button_delete->setEnabled(keyframe_list->rowCount() > 1);
208     keyframe_list->setCurrentCell(newrow, col);
209     keyframe_list->selectRow(newrow);
210     //slotGenerateParams(newrow, 0);
211 }
212
213 void KeyframeEdit::slotGenerateParams(int row, int column)
214 {
215     if (column == -1) {
216         // position of keyframe changed
217         QTableWidgetItem *item = keyframe_list->item(row, 0);
218         if (item == NULL)
219             return;
220
221         int pos = getPos(row);
222         if (pos <= m_min)
223             pos = m_min;
224         if (m_max != -1 && pos > m_max)
225             pos = m_max;
226         QString val = getPosString(pos);
227         if (val != keyframe_list->verticalHeaderItem(row)->text())
228             keyframe_list->verticalHeaderItem(row)->setText(val);
229
230         for (int col = 0; col < keyframe_list->horizontalHeader()->count(); col++) {
231             item = keyframe_list->item(row, col);
232             int v = item->text().toInt();
233             if (v >= m_params.at(col).attribute("max").toInt())
234                 item->setText(m_params.at(col).attribute("max"));
235             if (v <= m_params.at(col).attribute("min").toInt())
236                 item->setText(m_params.at(col).attribute("min"));
237             QString keyframes;
238             for (int i = 0; i < keyframe_list->rowCount(); i++) {
239                 if (keyframe_list->item(i, col))
240                     keyframes.append(QString::number(getPos(i)) + ':' + keyframe_list->item(i, col)->text() + ';');
241             }
242             m_params[col].setAttribute("keyframes", keyframes);
243         }
244
245         emit parameterChanged();
246         return;
247
248     }
249     QTableWidgetItem *item = keyframe_list->item(row, column);
250     if (item == NULL)
251         return;
252
253     int pos = getPos(row);
254     if (pos <= m_min)
255         pos = m_min;
256     if (m_max != -1 && pos > m_max)
257         pos = m_max;
258     /*QList<QTreeWidgetItem *> duplicates = keyframe_list->findItems(val, Qt::MatchExactly, 0);
259     duplicates.removeAll(item);
260     if (!duplicates.isEmpty()) {
261         // Trying to insert a keyframe at existing value, revert it
262         val = m_timecode.getTimecodeFromFrames(m_previousPos);
263     }*/
264     QString val = getPosString(pos);
265     if (val != keyframe_list->verticalHeaderItem(row)->text())
266         keyframe_list->verticalHeaderItem(row)->setText(val);
267
268     int v = item->text().toInt();
269     if (v >= m_params.at(column).attribute("max").toInt())
270         item->setText(m_params.at(column).attribute("max"));
271     if (v <= m_params.at(column).attribute("min").toInt())
272         item->setText(m_params.at(column).attribute("min"));
273     slotAdjustKeyframeInfo(false);
274
275     QString keyframes;
276     for (int i = 0; i < keyframe_list->rowCount(); i++) {
277         if (keyframe_list->item(i, column))
278             keyframes.append(QString::number(getPos(i)) + ':' + keyframe_list->item(i, column)->text() + ';');
279     }
280     m_params[column].setAttribute("keyframes", keyframes);
281     emit parameterChanged();
282 }
283
284 void KeyframeEdit::generateAllParams()
285 {
286     for (int col = 0; col < keyframe_list->columnCount(); col++) {
287         QString keyframes;
288         for (int i = 0; i < keyframe_list->rowCount(); i++) {
289             if (keyframe_list->item(i, col))
290                 keyframes.append(QString::number(getPos(i)) + ':' + keyframe_list->item(i, col)->text() + ';');
291         }
292         m_params[col].setAttribute("keyframes", keyframes);
293     }
294     emit parameterChanged();
295 }
296
297 const QString KeyframeEdit::getValue(const QString &name)
298 {
299     for (int col = 0; col < keyframe_list->columnCount(); col++) {
300         QDomNode na = m_params.at(col).firstChildElement("name");
301         QString paramName = i18n(na.toElement().text().toUtf8().data());
302         if (paramName == name)
303             return m_params.at(col).attribute("keyframes");
304     }
305     return QString();
306 }
307
308 void KeyframeEdit::slotAdjustKeyframeInfo(bool seek)
309 {
310     QTableWidgetItem *item = keyframe_list->currentItem();
311     if (!item)
312         return;
313     int min = m_min;
314     int max = m_max;
315     QTableWidgetItem *above = keyframe_list->item(item->row() - 1, item->column());
316     QTableWidgetItem *below = keyframe_list->item(item->row() + 1, item->column());
317     if (above)
318         min = getPos(above->row()) + 1;
319     if (below)
320         max = getPos(below->row()) - 1;
321
322     keyframe_pos->blockSignals(true);
323     keyframe_pos->setRange(min, max);
324     keyframe_pos->setValue(getPos(item->row()));
325     keyframe_pos->blockSignals(false);
326     for (int col = 0; col < keyframe_list->columnCount(); col++) {
327         DoubleParameterWidget *doubleparam = static_cast <DoubleParameterWidget*>(m_slidersLayout->itemAtPosition(col, 0)->widget());
328         if (!doubleparam)
329             continue;
330         doubleparam->blockSignals(true);
331         if (keyframe_list->item(item->row(), col)) {
332             doubleparam->setValue(keyframe_list->item(item->row(), col)->text().toInt());
333         } else {
334             kDebug() << "Null pointer exception caught: http://www.kdenlive.org/mantis/view.php?id=1771";
335         }
336         doubleparam->blockSignals(false);
337     }
338     if (KdenliveSettings::keyframeseek() && seek)
339         emit seekToPos(keyframe_pos->value() - m_min);
340 }
341
342 void KeyframeEdit::slotAdjustKeyframePos(int value)
343 {
344     QTableWidgetItem *item = keyframe_list->currentItem();
345     keyframe_list->verticalHeaderItem(item->row())->setText(getPosString(value));
346     slotGenerateParams(item->row(), -1);
347     if (KdenliveSettings::keyframeseek())
348         emit seekToPos(value - m_min);
349 }
350
351 void KeyframeEdit::slotAdjustKeyframeValue(int value)
352 {
353     Q_UNUSED(value);
354
355     QTableWidgetItem *item = keyframe_list->currentItem();
356     for (int col = 0; col < keyframe_list->columnCount(); col++) {
357         DoubleParameterWidget *doubleparam = static_cast <DoubleParameterWidget*>(m_slidersLayout->itemAtPosition(col, 0)->widget());
358         if (!doubleparam)
359             continue;
360         int val = doubleparam->getValue();
361         QTableWidgetItem *nitem = keyframe_list->item(item->row(), col);
362         if (nitem->text().toInt() != val)
363             nitem->setText(QString::number(val));
364     }
365     //keyframe_list->item(item->row() - 1, item->column());
366
367 }
368
369 int KeyframeEdit::getPos(int row)
370 {
371     if (KdenliveSettings::frametimecode())
372         return keyframe_list->verticalHeaderItem(row)->text().toInt();
373     else
374         return m_timecode.getFrameCount(keyframe_list->verticalHeaderItem(row)->text());
375 }
376
377 QString KeyframeEdit::getPosString(int pos)
378 {
379     if (KdenliveSettings::frametimecode())
380         return QString::number(pos);
381     else
382         return m_timecode.getTimecodeFromFrames(pos);
383 }
384
385 void KeyframeEdit::slotSetSeeking(bool seek)
386 {
387     KdenliveSettings::setKeyframeseek(seek);
388 }
389
390 void KeyframeEdit::updateTimecodeFormat()
391 {
392     for (int row = 0; row < keyframe_list->rowCount(); ++row) {
393         QString pos = keyframe_list->verticalHeaderItem(row)->text();
394         if (KdenliveSettings::frametimecode())
395             keyframe_list->verticalHeaderItem(row)->setText(QString::number(m_timecode.getFrameCount(pos)));
396         else
397             keyframe_list->verticalHeaderItem(row)->setText(m_timecode.getTimecodeFromFrames(pos.toInt()));
398     }
399 }
400
401 void KeyframeEdit::slotKeyframeMode()
402 {
403     widgetTable->setHidden(false);
404     buttonKeyframes->setHidden(true);
405     slotAddKeyframe();
406 }
407
408 void KeyframeEdit::slotResetKeyframe()
409 {
410     for (int col = 0; col < keyframe_list->columnCount(); ++col) {
411         DoubleParameterWidget *doubleparam = static_cast<DoubleParameterWidget*>(m_slidersLayout->itemAtPosition(col, 0)->widget());
412         if (doubleparam)
413             doubleparam->slotReset();
414     }
415 }
416
417 void KeyframeEdit::slotUpdateVisibleParameter(int id, bool update)
418 {
419     for (int i = 0; i < m_params.count(); ++i)
420         m_params[i].setAttribute("intimeline", (i == id ? "1" : "0"));
421     if (update) emit parameterChanged();
422 }
423
424 bool KeyframeEdit::isVisibleParam(const QString& name)
425 {
426     for (int col = 0; col < keyframe_list->columnCount(); ++col) {
427         QDomNode na = m_params.at(col).firstChildElement("name");
428         QString paramName = i18n(na.toElement().text().toUtf8().data());
429         if (paramName == name)
430             return m_params.at(col).attribute("intimeline") == "1";
431     }
432     return false;
433 }
434
435 void KeyframeEdit::checkVisibleParam()
436 {
437     if (m_params.count() == 0)
438         return;
439
440     foreach(QDomElement elem, m_params) {
441         if (elem.attribute("intimeline") == "1")
442             return;
443     }
444
445     slotUpdateVisibleParameter(0, false);
446     QRadioButton *radio = static_cast<QRadioButton*>(m_slidersLayout->itemAtPosition(0, 1)->widget());
447     if (radio)
448         radio->setChecked(true);
449 }
450
451 #include "keyframeedit.moc"