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 /** @brief Add effect to current clip */
83 void slotAddEffect(QDomElement effect, GenTime pos, int track);
84 void slotAddGroupEffect(QDomElement effect, AbstractGroupItem *group);
85 void addEffect(int track, GenTime pos, QDomElement effect);
86 void deleteEffect(int track, GenTime pos, QDomElement effect);
87 void updateEffect(int track, GenTime pos, QDomElement insertedEffect, bool refreshEffectStack = false);
88 /** @brief Enable / disable a list of effects */
89 void updateEffectState(int track, GenTime pos, QList <int> effectIndexes, bool disable, bool updateEffectStack);
90 void moveEffect(int track, GenTime pos, QList <int> oldPos, QList <int> newPos);
91 void addTransition(ItemInfo transitionInfo, int endTrack, QDomElement params, bool refresh);
92 void deleteTransition(ItemInfo transitionInfo, int endTrack, QDomElement params, bool refresh);
93 void updateTransition(int track, GenTime pos, QDomElement oldTransition, QDomElement transition, bool updateTransitionWidget);
94 void moveTransition(GenTime oldpos, GenTime newpos);
95 void activateMonitor();
97 void deleteSelectedClips();
98 /** @brief Cuts all clips that are selected at the timeline cursor position. */
99 void cutSelectedClips();
100 void setContextMenu(QMenu *timeline, QMenu *clip, QMenu *transition, QActionGroup *clipTypeGroup, QMenu *markermenu);
101 bool checkTrackHeight();
102 void updateSceneFrameWidth();
103 //QList <TrackInfo> tracksList() const;
104 void setTool(PROJECTTOOL tool);
105 ClipItem *cutClip(ItemInfo info, GenTime cutTime, bool cut, bool execute = true);
106 void slotSeekToPreviousSnap();
107 void slotSeekToNextSnap();
108 double getSnapPointForPos(double pos);
109 void editKeyFrame(const GenTime &pos, const int track, const int index, const QString &keyframes);
110 bool findString(const QString &text);
111 void selectFound(QString track, QString pos);
112 bool findNextString(const QString &text);
113 void initSearchStrings();
114 void clearSearchStrings();
115 QList<ItemInfo> findId(const QString &clipId);
118 void doChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, const double speed, const double oldspeed, int strobe, const QString &id);
119 /** @brief Sets the document as modified. */
120 void setDocumentModified();
124 /** @brief Prepares inserting space.
126 * Shows a dialog to configure length and track. */
127 void slotInsertSpace();
128 /** @brief Prepares removing space. */
129 void slotRemoveSpace();
130 void insertSpace(QList<ItemInfo> clipsToMove, QList<ItemInfo> transToMove, int track, const GenTime &duration, const GenTime &offset);
131 ClipItem *getActiveClipUnderCursor(bool allowOutsideCursor = false) const;
132 void deleteTimelineTrack(int ix, TrackInfo trackinfo);
133 void saveThumbnails();
134 void autoTransition();
135 void initCursorPos(int pos);
137 /** @brief Locks or unlocks a track.
138 * @param ix number of track
139 * @param lock whether to lock or unlock
140 * @param requestUpdate (default = true) Whether to request an update of the icon in the track header
142 * Makes sure no clip on track to lock is selected. */
143 void lockTrack(int ix, bool lock, bool requestUpdate = true);
144 void groupClips(bool group = true);
145 void doGroupClips(QList <ItemInfo> clipInfos, QList <ItemInfo> transitionInfos, bool group);
146 void loadGroups(const QDomNodeList &groups);
148 /** @brief Creates SplitAudioCommands for selected clips. */
151 /// Define which clip to take as reference for automatic audio alignment
152 void setAudioAlignReference();
154 /// Automatically align the currently selected clips to synchronize their audio with the reference's audio
157 /** @brief Seperates the audio of a clip to a audio track.
158 * @param pos Position of the clip to split
159 * @param track Track of the clip
160 * @param split Split or unsplit */
161 void doSplitAudio(const GenTime &pos, int track, EffectsList effects, bool split);
164 void setAudioAndVideo();
165 void doChangeClipType(const GenTime &pos, int track, bool videoOnly, bool audioOnly);
166 int hasGuide(int pos, int offset);
167 void reloadTransitionLumas();
168 void updateProjectFps();
170 int selectedTrack() const;
171 QStringList selectedClips() const;
172 QList<ClipItem *> selectedClipItems() const;
173 /** @brief Checks wheter an item can be inserted (make sure it does not overlap another item) */
174 bool canBePastedTo(ItemInfo info, int type) const;
176 /** @brief Selects a clip.
177 * @param add Whether to select or deselect
178 * @param group (optional) Whether to add the clip to a group
179 * @param track (optional) The track of the clip (has to be combined with @param pos)
180 * @param pos (optional) The position of the clip (has to be combined with @param track) */
181 void selectClip(bool add, bool group = false, int track = -1, int pos = -1);
182 void selectTransition(bool add, bool group = false);
183 QStringList extractTransitionsLumas();
184 void setEditMode(EDITMODE mode);
186 /** @brief Inserts @param clip.
187 * @param clip The clip to insert
188 * @param in The inpoint of the clip (crop from start)
189 * @param out The outpoint of the clip (crop from end)
191 * Inserts at the position of timeline cursor and selected track. */
192 void insertClipCut(DocClipBase *clip, int in, int out);
193 void clearSelection(bool emitInfo = true);
194 void editItemDuration();
195 void buildGuidesMenu(QMenu *goMenu) const;
196 /** update the timeline objects when palette changes */
197 void updatePalette();
198 /** @brief Returns true if a track has audio data on it.
199 * @param track The track number
201 * Check whether given track has a clip with audio in it. */
202 bool hasAudio(int track) const;
205 /** @brief Returns last requested seeking pos (or SEEK_INACTIVE if no seek). */
206 int seekPosition() const;
209 /** @brief Send seek request to MLT. */
210 void seekCursorPos(int pos);
211 /** @brief Move timeline cursor to new position. */
212 void setCursorPos(int pos);
213 void moveCursorPos(int delta);
214 void updateCursorPos();
215 void slotDeleteEffect(ClipItem *clip, int track, QDomElement effect, bool affectGroup = true);
216 void slotChangeEffectState(ClipItem *clip, int track, QList <int> effectIndexes, bool disable);
217 void slotChangeEffectPosition(ClipItem *clip, int track, QList <int> currentPos, int newPos);
218 void slotUpdateClipEffect(ClipItem *clip, int track, QDomElement oldeffect, QDomElement effect, int ix, bool refreshEffectStack = true);
219 void slotUpdateClipRegion(ClipItem *clip, int ix, QString region);
220 void slotRefreshEffects(ClipItem *clip);
221 void setDuration(int duration);
222 void slotAddTransition(ClipItem* clip, ItemInfo transitionInfo, int endTrack, QDomElement transition = QDomElement());
223 void slotAddTransitionToSelectedClips(QDomElement transition);
224 void slotTransitionUpdated(Transition *, QDomElement);
225 void slotSwitchTrackAudio(int ix);
226 void slotSwitchTrackVideo(int ix);
227 void slotSwitchTrackLock(int ix);
228 void slotUpdateClip(const QString &clipId, bool reload = true);
230 /** @brief Creates a AddClipCommand to add, edit or delete a marker.
231 * @param id Id of the marker's clip
232 * @param t Position of the marker
233 * @param c Comment of the marker */
234 void slotAddClipMarker(const QString &id, GenTime t, QString c);
235 bool addGuide(const GenTime &pos, const QString &comment);
237 /** @brief Shows a dialog for adding a guide.
238 * @param dialog (default = true) false = do not show the dialog but use current position as position and comment */
239 void slotAddGuide(bool dialog = true);
240 void slotEditGuide(CommentedTime guide);
241 void slotEditGuide(int guidePos = -1);
242 void slotDeleteGuide(int guidePos = -1);
243 void slotDeleteAllGuides();
244 void editGuide(const GenTime &oldPos, const GenTime &pos, const QString &comment);
247 void pasteClipEffects();
248 void slotUpdateAllThumbs();
249 void slotCheckPositionScrolling();
250 void slotInsertTrack(int ix);
252 /** @brief Shows a dialog for selecting a track to delete.
253 * @param ix Number of the track, which should be pre-selected in the dialog */
254 void slotDeleteTrack(int ix);
255 /** @brief Shows the configure tracks dialog. */
256 void slotConfigTracks(int ix);
257 void clipNameChanged(const QString &id, const QString &name);
259 void slotTrackDown();
260 void slotSelectTrack(int ix);
261 void insertZoneOverwrite(QStringList data, int in);
263 /** @brief Rebuilds a group to fit again after children changed.
264 * @param childTrack the track of one of the groups children
265 * @param childPos The position of the same child */
266 void rebuildGroup(int childTrack, GenTime childPos);
267 /** @brief Rebuilds a group to fit again after children changed.
268 * @param group The group to rebuild */
269 void rebuildGroup(AbstractGroupItem *group);
271 /** @brief Cuts a group into two parts.
272 * @param clips1 Clips before the cut
273 * @param transitions1 Transitions before the cut
274 * @param clipsCut Clips that need to be cut
275 * @param transitionsCut Transitions that need to be cut
276 * @param clips2 Clips behind the cut
277 * @param transitions2 Transitions behind the cut
278 * @param cutPos Absolute position of the cut
279 * @param cut true = cut, false = "uncut" */
280 void slotRazorGroup(QList <ItemInfo> clips1, QList <ItemInfo> transitions1, QList <ItemInfo> clipsCut, QList <ItemInfo> transitionsCut, QList <ItemInfo> clips2, QList <ItemInfo> transitions2, GenTime cutPos, bool cut);
282 /** @brief Add en effect to a track.
283 * @param effect The new effect xml
284 * @param ix The track index */
285 void slotAddTrackEffect(const QDomElement &effect, int ix);
286 /** @brief Select all clips in selected track. */
287 void slotSelectClipsInTrack();
288 /** @brief Select all clips in timeline. */
289 void slotSelectAllClips();
291 /** @brief Update the list of snap points (sticky timeline hotspots).
292 * @param selected The currently selected clip if any
293 * @param offsetList The list of points that should also snap (for example when movin a clip, start and end points should snap
294 * @param skipSelectedItems if true, the selected item start and end points will not be added to snap list */
295 void updateSnapPoints(AbstractClipItem *selected, QList <GenTime> offsetList = QList <GenTime> (), bool skipSelectedItems = false);
297 void slotAddEffect(ClipItem *clip, QDomElement effect);
300 virtual void drawBackground(QPainter * painter, const QRectF & rect);
301 //virtual void drawForeground ( QPainter * painter, const QRectF & rect );
302 virtual void dragEnterEvent(QDragEnterEvent * event);
303 virtual void dragMoveEvent(QDragMoveEvent * event);
304 virtual void dragLeaveEvent(QDragLeaveEvent * event);
305 /** @brief Something has been dropped onto the timeline */
306 virtual void dropEvent(QDropEvent * event);
307 virtual void wheelEvent(QWheelEvent * e);
308 virtual void keyPressEvent(QKeyEvent * event);
309 virtual QStringList mimeTypes() const;
310 virtual Qt::DropActions supportedDropActions() const;
315 int m_projectDuration;
317 KdenliveDoc *m_document;
318 CustomTrackScene *m_scene;
319 QGraphicsLineItem *m_cursorLine;
320 ItemInfo m_dragItemInfo;
321 ItemInfo m_selectionGroupInfo;
322 OPERATIONTYPE m_operationMode;
323 OPERATIONTYPE m_moveOpMode;
324 AbstractClipItem *m_dragItem;
326 QUndoStack *m_commandStack;
327 QGraphicsItem *m_visualTip;
328 QGraphicsItemAnimation *m_animation;
329 QTimeLine *m_animationTimer;
334 QList <CommentedTime> m_searchPoints;
335 QList <Guide *> m_guides;
337 ClipItem *getClipItemAt(int pos, int track);
338 ClipItem *getClipItemAt(GenTime pos, int track);
339 ClipItem *getClipItemAtEnd(GenTime pos, int track);
340 ClipItem *getClipItemAtStart(GenTime pos, int track);
341 Transition *getTransitionItem(TransitionInfo info);
342 Transition *getTransitionItemAt(int pos, int track);
343 Transition *getTransitionItemAt(GenTime pos, int track);
344 Transition *getTransitionItemAtEnd(GenTime pos, int track);
345 Transition *getTransitionItemAtStart(GenTime pos, int track);
346 void checkScrolling();
347 /** Should we auto scroll while playing (keep in sync with KdenliveSettings::autoscroll() */
349 void displayContextMenu(QPoint pos, AbstractClipItem *clip, AbstractGroupItem *group);
350 QMenu *m_timelineContextMenu;
351 QMenu *m_timelineContextClipMenu;
352 QMenu *m_timelineContextTransitionMenu;
354 QAction *m_autoTransition;
355 QAction *m_pasteEffectsAction;
356 QAction *m_ungroupAction;
357 QAction *m_editGuide;
358 QAction *m_deleteGuide;
359 QActionGroup *m_clipTypeGroup;
360 QTimer m_scrollTimer;
361 QTimer m_thumbsTimer;
367 QCursor m_razorCursor;
368 QCursor m_spacerCursor;
369 /** list containing items currently copied in the timeline */
370 QList<AbstractClipItem *> m_copiedItems;
371 /** Used to get the point in timeline where a context menu was opened */
372 QPoint m_menuPosition;
374 AbstractGroupItem *m_selectionGroup;
375 QList <ClipItem *> m_waitingThumbs;
380 QWaitCondition m_producerNotReady;
381 KStatefulBrush m_activeTrackBrush;
383 AudioCorrelation *m_audioCorrelator;
384 ClipItem *m_audioAlignmentReference;
386 /** stores the state of the control modifier during mouse press.
387 * Will then be used to identify whether we resize a group or only one item of it. */
388 bool m_controlModifier;
390 /** Get the index of the video track that is just below current track */
391 int getPreviousVideoTrack(int track);
392 void updatePositionEffects(ClipItem * item, ItemInfo info, bool standalone = true);
393 bool insertDropClips(const QMimeData *data, const QPoint &pos);
394 bool canBePastedTo(QList <ItemInfo> infoList, int type) const;
395 bool canBePasted(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
396 bool canBeMoved(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
397 ClipItem *getClipUnderCursor() const;
398 AbstractClipItem *getMainActiveClip() const;
399 void resetSelectionGroup(bool selectItems = true);
400 void groupSelectedItems(bool force = false, bool createNewGroup = false);
401 /** Get available space for clip move (min and max free positions) */
402 void getClipAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
403 /** Get available space for transition move (min and max free positions) */
404 void getTransitionAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
405 void updateClipTypeActions(ClipItem *clip);
406 /** Whether an item can be moved to a new position without colliding with similar items */
407 bool itemCollision(AbstractClipItem *item, ItemInfo newPos);
408 /** Selects all items in the scene rect, and sets ok to false if a group going over several tracks is found in it */
409 QList<QGraphicsItem *> checkForGroups(const QRectF &rect, bool *ok);
410 /** Adjust clips under another one when working in overwrite mode */
411 void adjustTimelineClips(EDITMODE mode, ClipItem *item, ItemInfo posinfo, QUndoCommand *command);
412 void adjustTimelineTransitions(EDITMODE mode, Transition *item, QUndoCommand *command);
413 /** Adjust keyframes when pasted to another clip */
414 void adjustKeyfames(GenTime oldstart, GenTime newstart, GenTime duration, QDomElement xml);
416 /** @brief Removes the tip and stops the animation timer. */
417 void removeTipAnimation();
418 /** @brief Creates a new tip animation.
419 * @param clip clip to display the tip on
420 * @param mode operation mode for which the tip should be displayed
421 * @param size size of the tip */
422 void setTipAnimation(AbstractClipItem *clip, OPERATIONTYPE mode, const double size);
424 /** @brief Takes care of updating effects and attached transitions during a resize from start.
425 * @param item Item to resize
426 * @param oldInfo The item's info before resizement (set to item->info() is @param check true)
427 * @param pos New startPos
428 * @param check (optional, default = false) Whether to check for collisions
429 * @param command (optional) Will be used as parent command (for undo history) */
430 void prepareResizeClipStart(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
432 /** @brief Takes care of updating effects and attached transitions during a resize from end.
433 * @param item Item to resize
434 * @param oldInfo The item's info before resizement (set to item->info() is @param check true)
435 * @param pos New endPos
436 * @param check (optional, default = false) Whether to check for collisions
437 * @param command (optional) Will be used as parent command (for undo history) */
438 void prepareResizeClipEnd(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
440 /** @brief Collects information about the group's children to pass it on to RazorGroupCommand.
441 * @param group The group to cut
442 * @param cutPos The absolute position of the cut */
443 void razorGroup(AbstractGroupItem *group, GenTime cutPos);
445 /** @brief Gets the effect parameters that will be passed to Mlt. */
446 EffectsParameterList getEffectArgs(const QDomElement &effect);
448 /** @brief Update Tracknames to fit again after track was added/deleted.
449 * @param track Number of track which was added/deleted
450 * @param added true = track added, false = track deleted
452 * The default track name consists of type + number. If we add/delete a track the number has to be adjusted
453 * if the name is still the default one. */
454 void updateTrackNames(int track, bool added);
456 /** @brief Updates the duration stored in a track's TrackInfo.
457 * @param track Number of track as used in ItemInfo (not the numbering used in KdenliveDoc) (negative for all tracks)
458 * @param command If effects need to be updated the commands to do this will be attached to this undo command
460 * In addition to update the duration in TrackInfo it updates effects with keyframes on the track. */
461 void updateTrackDuration(int track, QUndoCommand *command);
463 /** @brief Adjusts effects after a clip resize.
464 * @param item The item that was resized
465 * @param oldInfo pre resize info
466 * @param fromStart false = resize from end
467 * @param command Used as a parent for EditEffectCommand */
468 void adjustEffects(ClipItem *item, ItemInfo oldInfo, QUndoCommand *command);
470 /** @brief Prepare an add clip command for an effect */
471 void processEffect(ClipItem *item, QDomElement effect, int offset, QUndoCommand *effectCommand);
473 /** @brief Get effect parameters ready for MLT*/
474 void adjustEffectParameters(EffectsParameterList ¶meters, QDomNodeList params, const QString &prefix = QString());
477 void slotRefreshGuides();
478 void slotEnableRefresh();
479 void slotCheckMouseScrolling();
480 void slotEditTimeLineGuide();
481 void slotDeleteTimeLineGuide();
482 void slotFetchNextThumbs();
483 void checkTrackSequence(int track);
484 void slotGoToMarker(QAction *action);
485 void slotResetMenuPosition();
486 void slotDoResetMenuPosition();
487 /** @brief Re-create the clip thumbnails.
488 * @param id The clip's Id string.
489 * @param resetThumbs Should we recreate the timeline thumbnails. */
490 void slotRefreshThumbs(const QString &id, bool resetThumbs);
491 /** @brief A Filter job producer results. */
492 void slotGotFilterJobResults(const QString &id, int startPos, int track, const QString &filter, stringMap filterParams);
496 void cursorMoved(int, int);
499 void mousePosition(int);
500 /** @brief A clip was selected in timeline, update the effect stack
501 * @param clip The clip
502 * @param raise If true, the effect stack widget will be raised (come to front). */
503 void clipItemSelected(ClipItem *clip, bool raise = true);
504 void transitionItemSelected(Transition*, int track = 0, QPoint p = QPoint(), bool update = false);
505 void activateDocumentMonitor();
506 void trackHeightChanged();
507 void tracksChanged();
508 void displayMessage(const QString &, MessageType);
509 void showClipFrame(DocClipBase *, QPoint, bool, const int);
510 void doTrackLock(int, bool);
511 void updateClipMarkers(DocClipBase *);
512 void updateTrackHeaders();
514 /** @brief Monitor document changes (for example the presence of audio data in timeline for export widget.*/
515 void documentModified();
516 void forceClipProcessing(const QString &);
517 void showTrackEffects(int, TrackInfo);
518 /** @brief Update the track effect button that shows if a track has effects or not.*/
519 void updateTrackEffectState(int);
520 /** @brief Cursor position changed, repaint ruler.*/