1 /***************************************************************************
2 * Copyright (C) 2007 by Jean-Baptiste Mardelle (jb@kdenlive.org) *
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. *
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. *
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 ***************************************************************************/
21 #ifndef CUSTOMTRACKVIEW_H
22 #define CUSTOMTRACKVIEW_H
24 #include <kdeversion.h>
25 #include <KColorScheme>
27 #include <QGraphicsView>
28 #include <QGraphicsItemAnimation>
33 #include <QWaitCondition>
35 #include "kdenlivedoc.h"
36 #include "docclipbase.h"
38 #include "effectslist.h"
39 #include "customtrackscene.h"
42 class AbstractClipItem;
43 class AbstractGroupItem;
45 class AudioCorrelation;
47 class CustomTrackView : public QGraphicsView
52 CustomTrackView(KdenliveDoc *doc, CustomTrackScene* projectscene, QWidget *parent = 0);
53 virtual ~ CustomTrackView();
54 virtual void mousePressEvent(QMouseEvent * event);
55 virtual void mouseReleaseEvent(QMouseEvent * event);
56 virtual void mouseMoveEvent(QMouseEvent * event);
57 virtual void mouseDoubleClickEvent(QMouseEvent *event);
58 void addTrack(TrackInfo type, int ix = -1);
59 void removeTrack(int ix);
60 /** @brief Makes the document use new track infos (name, type, ...). */
61 void configTracks(QList <TrackInfo> trackInfos);
63 void checkAutoScroll();
65 Move the clip at \c start to \c end.
67 If \c out_actualEnd is not NULL, it will be set to the position the clip really ended up at.
68 For example, attempting to move a clip to t = -1 s will actually move it to t = 0 s.
70 bool moveClip(const ItemInfo &start, const ItemInfo &end, bool refresh, ItemInfo *out_actualEnd = NULL);
71 void moveGroup(QList <ItemInfo> startClip, QList <ItemInfo> startTransition, const GenTime &offset, const int trackOffset, bool reverseMove = false);
72 /** move transition, startPos = (old start, old end), endPos = (new start, new end) */
73 void moveTransition(const ItemInfo &start, const ItemInfo &end, bool refresh);
74 void resizeClip(const ItemInfo &start, const ItemInfo &end, bool dontWorry = false);
75 void addClip(QDomElement xml, const QString &clipId, ItemInfo info, EffectsList list = EffectsList(), bool overwrite = false, bool push = false, bool refresh = true);
76 void deleteClip(ItemInfo info, bool refresh = true);
77 void slotDeleteClipMarker(const QString &comment, const QString &id, const GenTime &position);
78 void slotDeleteAllClipMarkers(const QString &id);
79 void addMarker(const QString &id, const GenTime &pos, const QString &comment);
80 void setScale(double scaleFactor, double verticalScale);
81 void deleteClip(const QString &clipId);
82 void slotAddEffect(QDomElement effect, GenTime pos, int track);
83 void slotAddGroupEffect(QDomElement effect, AbstractGroupItem *group);
84 void addEffect(int track, GenTime pos, QDomElement effect);
85 void deleteEffect(int track, GenTime pos, QDomElement effect);
86 void updateEffect(int track, GenTime pos, QDomElement insertedEffect, bool refreshEffectStack = false);
87 /** @brief Enable / disable a list of effects */
88 void updateEffectState(int track, GenTime pos, QList <int> effectIndexes, bool disable, bool updateEffectStack);
89 void moveEffect(int track, GenTime pos, QList <int> oldPos, QList <int> newPos);
90 void addTransition(ItemInfo transitionInfo, int endTrack, QDomElement params, bool refresh);
91 void deleteTransition(ItemInfo transitionInfo, int endTrack, QDomElement params, bool refresh);
92 void updateTransition(int track, GenTime pos, QDomElement oldTransition, QDomElement transition, bool updateTransitionWidget);
93 void moveTransition(GenTime oldpos, GenTime newpos);
94 void activateMonitor();
96 void deleteSelectedClips();
97 /** @brief Cuts all clips that are selected at the timeline cursor position. */
98 void cutSelectedClips();
99 void setContextMenu(QMenu *timeline, QMenu *clip, QMenu *transition, QActionGroup *clipTypeGroup, QMenu *markermenu);
100 bool checkTrackHeight();
101 void updateSceneFrameWidth();
102 //QList <TrackInfo> tracksList() const;
103 void setTool(PROJECTTOOL tool);
104 ClipItem *cutClip(ItemInfo info, GenTime cutTime, bool cut, bool execute = true);
105 void slotSeekToPreviousSnap();
106 void slotSeekToNextSnap();
107 double getSnapPointForPos(double pos);
108 void editKeyFrame(const GenTime &pos, const int track, const int index, const QString &keyframes);
109 bool findString(const QString &text);
110 void selectFound(QString track, QString pos);
111 bool findNextString(const QString &text);
112 void initSearchStrings();
113 void clearSearchStrings();
114 QList<ItemInfo> findId(const QString &clipId);
117 void doChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, const double speed, const double oldspeed, int strobe, const QString &id);
118 /** @brief Sets the document as modified. */
119 void setDocumentModified();
123 /** @brief Prepares inserting space.
125 * Shows a dialog to configure length and track. */
126 void slotInsertSpace();
127 /** @brief Prepares removing space. */
128 void slotRemoveSpace();
129 void insertSpace(QList<ItemInfo> clipsToMove, QList<ItemInfo> transToMove, int track, const GenTime &duration, const GenTime &offset);
130 ClipItem *getActiveClipUnderCursor(bool allowOutsideCursor = false) const;
131 void deleteTimelineTrack(int ix, TrackInfo trackinfo);
132 void saveThumbnails();
133 void autoTransition();
134 void initCursorPos(int pos);
136 /** @brief Locks or unlocks a track.
137 * @param ix number of track
138 * @param lock whether to lock or unlock
139 * @param requestUpdate (default = true) Whether to request an update of the icon in the track header
141 * Makes sure no clip on track to lock is selected. */
142 void lockTrack(int ix, bool lock, bool requestUpdate = true);
143 void groupClips(bool group = true);
144 void doGroupClips(QList <ItemInfo> clipInfos, QList <ItemInfo> transitionInfos, bool group);
145 void loadGroups(const QDomNodeList &groups);
147 /** @brief Creates SplitAudioCommands for selected clips. */
150 /// Define which clip to take as reference for automatic audio alignment
151 void setAudioAlignReference();
153 /// Automatically align the currently selected clips to synchronize their audio with the reference's audio
156 /** @brief Seperates the audio of a clip to a audio track.
157 * @param pos Position of the clip to split
158 * @param track Track of the clip
159 * @param split Split or unsplit */
160 void doSplitAudio(const GenTime &pos, int track, EffectsList effects, bool split);
163 void setAudioAndVideo();
164 void doChangeClipType(const GenTime &pos, int track, bool videoOnly, bool audioOnly);
165 int hasGuide(int pos, int offset);
166 void reloadTransitionLumas();
167 void updateProjectFps();
169 int selectedTrack() const;
170 QStringList selectedClips() const;
171 QList<ClipItem *> selectedClipItems() const;
172 /** @brief Checks wheter an item can be inserted (make sure it does not overlap another item) */
173 bool canBePastedTo(ItemInfo info, int type) const;
175 /** @brief Selects a clip.
176 * @param add Whether to select or deselect
177 * @param group (optional) Whether to add the clip to a group
178 * @param track (optional) The track of the clip (has to be combined with @param pos)
179 * @param pos (optional) The position of the clip (has to be combined with @param track) */
180 void selectClip(bool add, bool group = false, int track = -1, int pos = -1);
181 void selectTransition(bool add, bool group = false);
182 QStringList extractTransitionsLumas();
183 void setEditMode(EDITMODE mode);
185 /** @brief Inserts @param clip.
186 * @param clip The clip to insert
187 * @param in The inpoint of the clip (crop from start)
188 * @param out The outpoint of the clip (crop from end)
190 * Inserts at the position of timeline cursor and selected track. */
191 void insertClipCut(DocClipBase *clip, int in, int out);
192 void clearSelection(bool emitInfo = true);
193 void editItemDuration();
194 void buildGuidesMenu(QMenu *goMenu) const;
195 /** update the timeline objects when palette changes */
196 void updatePalette();
197 /** @brief Returns true if a track has audio data on it.
198 * @param track The track number
200 * Check whether given track has a clip with audio in it. */
201 bool hasAudio(int track) const;
206 void setCursorPos(int pos, bool seek = true);
207 void moveCursorPos(int delta);
208 void updateCursorPos();
209 void slotDeleteEffect(ClipItem *clip, int track, QDomElement effect, bool affectGroup = true);
210 void slotChangeEffectState(ClipItem *clip, int track, QList <int> effectIndexes, bool disable);
211 void slotChangeEffectPosition(ClipItem *clip, int track, QList <int> currentPos, int newPos);
212 void slotUpdateClipEffect(ClipItem *clip, int track, QDomElement oldeffect, QDomElement effect, int ix, bool refreshEffectStack = true);
213 void slotUpdateClipRegion(ClipItem *clip, int ix, QString region);
214 void slotRefreshEffects(ClipItem *clip);
215 void setDuration(int duration);
216 void slotAddTransition(ClipItem* clip, ItemInfo transitionInfo, int endTrack, QDomElement transition = QDomElement());
217 void slotAddTransitionToSelectedClips(QDomElement transition);
218 void slotTransitionUpdated(Transition *, QDomElement);
219 void slotSwitchTrackAudio(int ix);
220 void slotSwitchTrackVideo(int ix);
221 void slotSwitchTrackLock(int ix);
222 void slotUpdateClip(const QString &clipId, bool reload = true);
224 /** @brief Creates a AddClipCommand to add, edit or delete a marker.
225 * @param id Id of the marker's clip
226 * @param t Position of the marker
227 * @param c Comment of the marker */
228 void slotAddClipMarker(const QString &id, GenTime t, QString c);
229 bool addGuide(const GenTime &pos, const QString &comment);
231 /** @brief Shows a dialog for adding a guide.
232 * @param dialog (default = true) false = do not show the dialog but use current position as position and comment */
233 void slotAddGuide(bool dialog = true);
234 void slotEditGuide(CommentedTime guide);
235 void slotEditGuide(int guidePos = -1);
236 void slotDeleteGuide(int guidePos = -1);
237 void slotDeleteAllGuides();
238 void editGuide(const GenTime &oldPos, const GenTime &pos, const QString &comment);
241 void pasteClipEffects();
242 void slotUpdateAllThumbs();
243 void slotCheckPositionScrolling();
244 void slotInsertTrack(int ix);
246 /** @brief Shows a dialog for selecting a track to delete.
247 * @param ix Number of the track, which should be pre-selected in the dialog */
248 void slotDeleteTrack(int ix);
249 /** @brief Shows the configure tracks dialog. */
250 void slotConfigTracks(int ix);
251 void clipNameChanged(const QString &id, const QString &name);
253 void slotTrackDown();
254 void slotSelectTrack(int ix);
255 void insertZoneOverwrite(QStringList data, int in);
257 /** @brief Rebuilds a group to fit again after children changed.
258 * @param childTrack the track of one of the groups children
259 * @param childPos The position of the same child */
260 void rebuildGroup(int childTrack, GenTime childPos);
261 /** @brief Rebuilds a group to fit again after children changed.
262 * @param group The group to rebuild */
263 void rebuildGroup(AbstractGroupItem *group);
265 /** @brief Cuts a group into two parts.
266 * @param clips1 Clips before the cut
267 * @param transitions1 Transitions before the cut
268 * @param clipsCut Clips that need to be cut
269 * @param transitionsCut Transitions that need to be cut
270 * @param clips2 Clips behind the cut
271 * @param transitions2 Transitions behind the cut
272 * @param cutPos Absolute position of the cut
273 * @param cut true = cut, false = "uncut" */
274 void slotRazorGroup(QList <ItemInfo> clips1, QList <ItemInfo> transitions1, QList <ItemInfo> clipsCut, QList <ItemInfo> transitionsCut, QList <ItemInfo> clips2, QList <ItemInfo> transitions2, GenTime cutPos, bool cut);
276 /** @brief Add en effect to a track.
277 * @param effect The new effect xml
278 * @param ix The track index */
279 void slotAddTrackEffect(const QDomElement &effect, int ix);
280 /** @brief Select all clips in selected track. */
281 void slotSelectClipsInTrack();
282 /** @brief Select all clips in timeline. */
283 void slotSelectAllClips();
285 /** @brief Update the list of snap points (sticky timeline hotspots).
286 * @param selected The currently selected clip if any
287 * @param offsetList The list of points that should also snap (for example when movin a clip, start and end points should snap
288 * @param skipSelectedItems if true, the selected item start and end points will not be added to snap list */
289 void updateSnapPoints(AbstractClipItem *selected, QList <GenTime> offsetList = QList <GenTime> (), bool skipSelectedItems = false);
291 void slotAddEffect(ClipItem *clip, QDomElement effect);
294 virtual void drawBackground(QPainter * painter, const QRectF & rect);
295 //virtual void drawForeground ( QPainter * painter, const QRectF & rect );
296 virtual void dragEnterEvent(QDragEnterEvent * event);
297 virtual void dragMoveEvent(QDragMoveEvent * event);
298 virtual void dragLeaveEvent(QDragLeaveEvent * event);
299 /** @brief Something has been dropped onto the timeline */
300 virtual void dropEvent(QDropEvent * event);
301 virtual void wheelEvent(QWheelEvent * e);
302 virtual void keyPressEvent(QKeyEvent * event);
303 virtual QStringList mimeTypes() const;
304 virtual Qt::DropActions supportedDropActions() const;
309 int m_projectDuration;
311 KdenliveDoc *m_document;
312 CustomTrackScene *m_scene;
313 QGraphicsLineItem *m_cursorLine;
314 ItemInfo m_dragItemInfo;
315 ItemInfo m_selectionGroupInfo;
316 OPERATIONTYPE m_operationMode;
317 OPERATIONTYPE m_moveOpMode;
318 AbstractClipItem *m_dragItem;
320 QUndoStack *m_commandStack;
321 QGraphicsItem *m_visualTip;
322 QGraphicsItemAnimation *m_animation;
323 QTimeLine *m_animationTimer;
328 QList <CommentedTime> m_searchPoints;
329 QList <Guide *> m_guides;
331 ClipItem *getClipItemAt(int pos, int track);
332 ClipItem *getClipItemAt(GenTime pos, int track);
333 ClipItem *getClipItemAtEnd(GenTime pos, int track);
334 ClipItem *getClipItemAtStart(GenTime pos, int track);
335 Transition *getTransitionItem(TransitionInfo info);
336 Transition *getTransitionItemAt(int pos, int track);
337 Transition *getTransitionItemAt(GenTime pos, int track);
338 Transition *getTransitionItemAtEnd(GenTime pos, int track);
339 Transition *getTransitionItemAtStart(GenTime pos, int track);
340 void checkScrolling();
341 /** Should we auto scroll while playing (keep in sync with KdenliveSettings::autoscroll() */
343 void displayContextMenu(QPoint pos, AbstractClipItem *clip, AbstractGroupItem *group);
344 QMenu *m_timelineContextMenu;
345 QMenu *m_timelineContextClipMenu;
346 QMenu *m_timelineContextTransitionMenu;
348 QAction *m_autoTransition;
349 QAction *m_pasteEffectsAction;
350 QAction *m_ungroupAction;
351 QAction *m_editGuide;
352 QAction *m_deleteGuide;
353 QActionGroup *m_clipTypeGroup;
354 QTimer m_scrollTimer;
355 QTimer m_thumbsTimer;
361 QCursor m_razorCursor;
362 QCursor m_spacerCursor;
363 /** list containing items currently copied in the timeline */
364 QList<AbstractClipItem *> m_copiedItems;
365 /** Used to get the point in timeline where a context menu was opened */
366 QPoint m_menuPosition;
368 AbstractGroupItem *m_selectionGroup;
369 QList <ClipItem *> m_waitingThumbs;
374 QWaitCondition m_producerNotReady;
375 KStatefulBrush m_activeTrackBrush;
377 AudioCorrelation *m_audioCorrelator;
378 ClipItem *m_audioAlignmentReference;
380 /** stores the state of the control modifier during mouse press.
381 * Will then be used to identify whether we resize a group or only one item of it. */
382 bool m_controlModifier;
384 /** Get the index of the video track that is just below current track */
385 int getPreviousVideoTrack(int track);
386 void updatePositionEffects(ClipItem * item, ItemInfo info, bool standalone = true);
387 bool insertDropClips(const QMimeData *data, const QPoint &pos);
388 bool canBePastedTo(QList <ItemInfo> infoList, int type) const;
389 bool canBePasted(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
390 bool canBeMoved(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
391 ClipItem *getClipUnderCursor() const;
392 AbstractClipItem *getMainActiveClip() const;
393 void resetSelectionGroup(bool selectItems = true);
394 void groupSelectedItems(bool force = false, bool createNewGroup = false);
395 /** Get available space for clip move (min and max free positions) */
396 void getClipAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
397 /** Get available space for transition move (min and max free positions) */
398 void getTransitionAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
399 void updateClipTypeActions(ClipItem *clip);
400 /** Whether an item can be moved to a new position without colliding with similar items */
401 bool itemCollision(AbstractClipItem *item, ItemInfo newPos);
402 /** Selects all items in the scene rect, and sets ok to false if a group going over several tracks is found in it */
403 QList<QGraphicsItem *> checkForGroups(const QRectF &rect, bool *ok);
404 /** Adjust clips under another one when working in overwrite mode */
405 void adjustTimelineClips(EDITMODE mode, ClipItem *item, ItemInfo posinfo, QUndoCommand *command);
406 void adjustTimelineTransitions(EDITMODE mode, Transition *item, QUndoCommand *command);
407 /** Adjust keyframes when pasted to another clip */
408 void adjustKeyfames(GenTime oldstart, GenTime newstart, GenTime duration, QDomElement xml);
410 /** @brief Removes the tip and stops the animation timer. */
411 void removeTipAnimation();
412 /** @brief Creates a new tip animation.
413 * @param clip clip to display the tip on
414 * @param mode operation mode for which the tip should be displayed
415 * @param size size of the tip */
416 void setTipAnimation(AbstractClipItem *clip, OPERATIONTYPE mode, const double size);
418 /** @brief Takes care of updating effects and attached transitions during a resize from start.
419 * @param item Item to resize
420 * @param oldInfo The item's info before resizement (set to item->info() is @param check true)
421 * @param pos New startPos
422 * @param check (optional, default = false) Whether to check for collisions
423 * @param command (optional) Will be used as parent command (for undo history) */
424 void prepareResizeClipStart(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
426 /** @brief Takes care of updating effects and attached transitions during a resize from end.
427 * @param item Item to resize
428 * @param oldInfo The item's info before resizement (set to item->info() is @param check true)
429 * @param pos New endPos
430 * @param check (optional, default = false) Whether to check for collisions
431 * @param command (optional) Will be used as parent command (for undo history) */
432 void prepareResizeClipEnd(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
434 /** @brief Collects information about the group's children to pass it on to RazorGroupCommand.
435 * @param group The group to cut
436 * @param cutPos The absolute position of the cut */
437 void razorGroup(AbstractGroupItem *group, GenTime cutPos);
439 /** @brief Gets the effect parameters that will be passed to Mlt. */
440 EffectsParameterList getEffectArgs(const QDomElement &effect);
442 /** @brief Update Tracknames to fit again after track was added/deleted.
443 * @param track Number of track which was added/deleted
444 * @param added true = track added, false = track deleted
446 * The default track name consists of type + number. If we add/delete a track the number has to be adjusted
447 * if the name is still the default one. */
448 void updateTrackNames(int track, bool added);
450 /** @brief Updates the duration stored in a track's TrackInfo.
451 * @param track Number of track as used in ItemInfo (not the numbering used in KdenliveDoc) (negative for all tracks)
452 * @param command If effects need to be updated the commands to do this will be attached to this undo command
454 * In addition to update the duration in TrackInfo it updates effects with keyframes on the track. */
455 void updateTrackDuration(int track, QUndoCommand *command);
457 /** @brief Adjusts effects after a clip resize.
458 * @param item The item that was resized
459 * @param oldInfo pre resize info
460 * @param fromStart false = resize from end
461 * @param command Used as a parent for EditEffectCommand */
462 void adjustEffects(ClipItem *item, ItemInfo oldInfo, QUndoCommand *command);
464 /** @brief Prepare an add clip command for an effect */
465 void processEffect(ClipItem *item, QDomElement effect, QUndoCommand *effectCommand);
467 /** @brief Get effect parameters ready for MLT*/
468 void adjustEffectParameters(EffectsParameterList ¶meters, QDomNodeList params, const QString &prefix = QString());
471 void slotRefreshGuides();
472 void slotEnableRefresh();
473 void slotCheckMouseScrolling();
474 void slotEditTimeLineGuide();
475 void slotDeleteTimeLineGuide();
476 void slotFetchNextThumbs();
477 void checkTrackSequence(int track);
478 void slotGoToMarker(QAction *action);
479 void slotResetMenuPosition();
480 void slotDoResetMenuPosition();
481 /** @brief Re-create the clip thumbnails.
482 * @param id The clip's Id string.
483 * @param resetThumbs Should we recreate the timeline thumbnails. */
484 void slotRefreshThumbs(const QString &id, bool resetThumbs);
485 /** @brief A Filter job producer results. */
486 void slotGotFilterJobResults(const QString &id, int startPos, int track, const QString &filter, stringMap filterParams);
490 void cursorMoved(int, int);
493 void mousePosition(int);
494 /** @brief A clip was selected in timeline, update the effect stack
495 * @param clip The clip
496 * @param raise If true, the effect stack widget will be raised (come to front). */
497 void clipItemSelected(ClipItem *clip, bool raise = true);
498 void transitionItemSelected(Transition*, int track = 0, QPoint p = QPoint(), bool update = false);
499 void activateDocumentMonitor();
500 void trackHeightChanged();
501 void tracksChanged();
502 void displayMessage(const QString &, MessageType);
503 void showClipFrame(DocClipBase *, QPoint, bool, const int);
504 void doTrackLock(int, bool);
505 void updateClipMarkers(DocClipBase *);
506 void updateTrackHeaders();
508 /** @brief Monitor document changes (for example the presence of audio data in timeline for export widget.*/
509 void documentModified();
510 void forceClipProcessing(const QString &);
511 void showTrackEffects(int, TrackInfo);
512 /** @brief Update the track effect button that shows if a track has effects or not.*/
513 void updateTrackEffectState(int);