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 <KPixmapCache>
26 #include <QGraphicsView>
27 #include <QGraphicsItemAnimation>
32 #include "kdenlivedoc.h"
33 #include "docclipbase.h"
35 #include "effectslist.h"
36 #include "customtrackscene.h"
39 class AbstractClipItem;
40 class AbstractGroupItem;
43 class CustomTrackView : public QGraphicsView
48 CustomTrackView(KdenliveDoc *doc, CustomTrackScene* projectscene, QWidget *parent = 0);
49 virtual ~ CustomTrackView();
50 virtual void mousePressEvent(QMouseEvent * event);
51 virtual void mouseReleaseEvent(QMouseEvent * event);
52 virtual void mouseMoveEvent(QMouseEvent * event);
53 virtual void mouseDoubleClickEvent(QMouseEvent *event);
54 void addTrack(TrackInfo type, int ix = -1);
55 void removeTrack(int ix);
56 /** @brief Makes the document use new track infos (name, type, ...). */
57 void configTracks(QList <TrackInfo> trackInfos);
59 void checkAutoScroll();
60 void moveClip(const ItemInfo start, const ItemInfo end, bool refresh);
61 void moveGroup(QList <ItemInfo> startClip, QList <ItemInfo> startTransition, const GenTime offset, const int trackOffset, bool reverseMove = false);
62 /** move transition, startPos = (old start, old end), endPos = (new start, new end) */
63 void moveTransition(const ItemInfo start, const ItemInfo end, bool m_refresh);
64 void resizeClip(const ItemInfo start, const ItemInfo end, bool dontWorry = false);
65 void addClip(QDomElement xml, const QString &clipId, ItemInfo info, EffectsList list = EffectsList(), bool overwrite = false, bool push = false, bool refresh = true);
66 void deleteClip(ItemInfo info, bool refresh = true);
67 void slotDeleteClipMarker(const QString &comment, const QString &id, const GenTime &position);
68 void slotDeleteAllClipMarkers(const QString &id);
69 void addMarker(const QString &id, const GenTime &pos, const QString comment);
70 void setScale(double scaleFactor, double verticalScale);
71 void deleteClip(const QString &clipId);
72 void slotAddEffect(QDomElement effect, GenTime pos, int track);
73 void slotAddGroupEffect(QDomElement effect, AbstractGroupItem *group);
74 void addEffect(int track, GenTime pos, QDomElement effect);
75 void deleteEffect(int track, GenTime pos, QDomElement effect);
76 void updateEffect(int track, GenTime pos, QDomElement insertedEffect, int ix, bool triggeredByUser = true);
77 void moveEffect(int track, GenTime pos, int oldPos, int newPos);
78 void addTransition(ItemInfo transitionInfo, int endTrack, QDomElement params, bool refresh);
79 void deleteTransition(ItemInfo transitionInfo, int endTrack, QDomElement params, bool refresh);
80 void updateTransition(int track, GenTime pos, QDomElement oldTransition, QDomElement transition, bool updateTransitionWidget);
81 void moveTransition(GenTime oldpos, GenTime newpos);
82 void activateMonitor();
84 void deleteSelectedClips();
85 /** @brief Cuts all clips that are selected at the timeline cursor position. */
86 void cutSelectedClips();
87 void setContextMenu(QMenu *timeline, QMenu *clip, QMenu *transition, QActionGroup *clipTypeGroup, QMenu *markermenu);
88 void checkTrackHeight();
89 //QList <TrackInfo> tracksList() const;
90 void setTool(PROJECTTOOL tool);
91 ClipItem *cutClip(ItemInfo info, GenTime cutTime, bool cut, bool execute = true);
92 void slotSeekToPreviousSnap();
93 void slotSeekToNextSnap();
94 double getSnapPointForPos(double pos);
95 void editKeyFrame(const GenTime pos, const int track, const int index, const QString keyframes);
96 bool findString(const QString &text);
97 void selectFound(QString track, QString pos);
98 bool findNextString(const QString &text);
99 void initSearchStrings();
100 void clearSearchStrings();
101 QList<ItemInfo> findId(const QString &clipId);
104 void changeClipSpeed();
105 void doChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, const double speed, const double oldspeed, int strobe, const QString &id);
106 /** @brief Sets the document as modified. */
107 void setDocumentModified();
111 /** @brief Prepares inserting space.
113 * Shows a dialog to configure length and track. */
114 void slotInsertSpace();
115 /** @brief Prepares removing space. */
116 void slotRemoveSpace();
117 void insertSpace(QList<ItemInfo> clipsToMove, QList<ItemInfo> transToMove, int track, const GenTime duration, const GenTime offset);
118 ClipItem *getActiveClipUnderCursor(bool allowOutsideCursor = false) const;
119 void deleteTimelineTrack(int ix, TrackInfo trackinfo);
120 void saveThumbnails();
121 void autoTransition();
122 QStringList getLadspaParams(QDomElement effect) const;
123 void initCursorPos(int pos);
125 /** @brief Locks or unlocks a track.
126 * @param ix number of track
127 * @param lock whether to lock or unlock
129 * Makes sure no clip on track to lock is selected. */
130 void lockTrack(int ix, bool lock);
131 void groupClips(bool group = true);
132 void doGroupClips(QList <ItemInfo> clipInfos, QList <ItemInfo> transitionInfos, bool group);
133 void loadGroups(const QDomNodeList groups);
135 /** @brief Creates SplitAudioCommands for selected clips. */
138 /** @brief Seperates the audio of a clip to a audio track.
139 * @param pos Position of the clip to split
140 * @param track Track of the clip
141 * @param split Split or unsplit */
142 void doSplitAudio(const GenTime &pos, int track, bool split);
145 void setAudioAndVideo();
146 void doChangeClipType(const GenTime &pos, int track, bool videoOnly, bool audioOnly);
147 int hasGuide(int pos, int offset);
148 void reloadTransitionLumas();
149 void updateProjectFps();
151 int selectedTrack() const;
152 QStringList selectedClips() const;
153 QList<ClipItem *> selectedClipItems() const;
155 /** @brief Selects a clip.
156 * @param add Whether to select or deselect
157 * @param group (optional) Whether to add the clip to a group
158 * @param track (optional) The track of the clip (has to be combined with @param pos)
159 * @param pos (optional) The position of the clip (has to be combined with @param track) */
160 void selectClip(bool add, bool group = false, int track = -1, int pos = -1);
161 void selectTransition(bool add, bool group = false);
162 QStringList extractTransitionsLumas();
163 void setEditMode(EDITMODE mode);
165 /** @brief Inserts @param clip.
166 * @param clip The clip to insert
167 * @param in The inpoint of the clip (crop from start)
168 * @param out The outpoint of the clip (crop from end)
170 * Inserts at the position of timeline cursor and selected track. */
171 void insertClipCut(DocClipBase *clip, int in, int out);
172 void clearSelection();
173 void editItemDuration();
174 void buildGuidesMenu(QMenu *goMenu) const;
175 KPixmapCache* pixmapCache;
176 /** update the timeline objects when palette changes */
177 void updatePalette();
178 /** @brief Returns true if a track has audio data on it.
179 * @param track The track number
181 * Check whether given track has a clip with audio in it. */
182 bool hasAudio(int track) const;
185 void setCursorPos(int pos, bool seek = true);
186 void moveCursorPos(int delta);
187 void updateCursorPos();
188 void slotDeleteEffect(ClipItem *clip, QDomElement effect, bool affectGroup = true);
189 void slotChangeEffectState(ClipItem *clip, int effectPos, bool disable);
190 void slotChangeEffectPosition(ClipItem *clip, int currentPos, int newPos);
191 void slotUpdateClipEffect(ClipItem *clip, QDomElement oldeffect, QDomElement effect, int ix);
192 void slotUpdateClipRegion(ClipItem *clip, int ix, QString region);
193 void slotRefreshEffects(ClipItem *clip);
194 void setDuration(int duration);
195 void slotAddTransition(ClipItem* clip, ItemInfo transitionInfo, int endTrack, QDomElement transition = QDomElement());
196 void slotAddTransitionToSelectedClips(QDomElement transition);
197 void slotTransitionUpdated(Transition *, QDomElement);
198 void slotSwitchTrackAudio(int ix);
199 void slotSwitchTrackVideo(int ix);
200 void slotSwitchTrackLock(int ix);
201 void slotUpdateClip(const QString &clipId, bool reload = true);
202 void slotAddClipMarker(const QString &id, GenTime t, QString c);
203 bool addGuide(const GenTime pos, const QString &comment);
205 void slotEditGuide(CommentedTime guide);
206 void slotEditGuide(int guidePos = -1);
207 void slotDeleteGuide(int guidePos = -1);
208 void slotDeleteAllGuides();
209 void editGuide(const GenTime oldPos, const GenTime pos, const QString &comment);
212 void pasteClipEffects();
213 void slotUpdateAllThumbs();
214 void slotCheckPositionScrolling();
215 void slotInsertTrack(int ix);
217 /** @brief Shows a dialog for selecting a track to delete.
218 * @param ix Number of the track, which should be pre-selected in the dialog */
219 void slotDeleteTrack(int ix);
220 /** @brief Shows the configure tracks dialog. */
221 void slotConfigTracks(int ix);
222 void clipNameChanged(const QString id, const QString name);
224 void slotTrackDown();
225 void slotSelectTrack(int ix);
226 void insertZoneOverwrite(QStringList data, int in);
228 /** @brief Rebuilds a group to fit again after children changed.
229 * @param childTrack the track of one of the groups children
230 * @param childPos The position of the same child */
231 void rebuildGroup(int childTrack, GenTime childPos);
232 /** @brief Rebuilds a group to fit again after children changed.
233 * @param group The group to rebuild */
234 void rebuildGroup(AbstractGroupItem *group);
236 /** @brief Cuts a group into two parts.
237 * @param clips1 Clips before the cut
238 * @param transitions1 Transitions before the cut
239 * @param clipsCut Clips that need to be cut
240 * @param transitionsCut Transitions that need to be cut
241 * @param clips2 Clips behind the cut
242 * @param transitions2 Transitions behind the cut
243 * @param cutPos Absolute position of the cut
244 * @param cut true = cut, false = "uncut" */
245 void slotRazorGroup(QList <ItemInfo> clips1, QList <ItemInfo> transitions1, QList <ItemInfo> clipsCut, QList <ItemInfo> transitionsCut, QList <ItemInfo> clips2, QList <ItemInfo> transitions2, GenTime cutPos, bool cut);
248 virtual void drawBackground(QPainter * painter, const QRectF & rect);
249 //virtual void drawForeground ( QPainter * painter, const QRectF & rect );
250 virtual void dragEnterEvent(QDragEnterEvent * event);
251 virtual void dragMoveEvent(QDragMoveEvent * event);
252 virtual void dragLeaveEvent(QDragLeaveEvent * event);
253 /** @brief Something has been dropped onto the timeline */
254 virtual void dropEvent(QDropEvent * event);
255 virtual void wheelEvent(QWheelEvent * e);
256 virtual void keyPressEvent(QKeyEvent * event);
257 virtual QStringList mimeTypes() const;
258 virtual Qt::DropActions supportedDropActions() const;
262 int m_projectDuration;
264 KdenliveDoc *m_document;
265 CustomTrackScene *m_scene;
266 QGraphicsLineItem *m_cursorLine;
267 ItemInfo m_dragItemInfo;
268 ItemInfo m_selectionGroupInfo;
269 OPERATIONTYPE m_operationMode;
270 OPERATIONTYPE m_moveOpMode;
271 AbstractClipItem *m_dragItem;
273 QUndoStack *m_commandStack;
274 QGraphicsItem *m_visualTip;
275 QGraphicsItemAnimation *m_animation;
276 QTimeLine *m_animationTimer;
281 QList <CommentedTime> m_searchPoints;
282 QList <Guide *> m_guides;
283 void updateSnapPoints(AbstractClipItem *selected, QList <GenTime> offsetList = QList <GenTime> (), bool skipSelectedItems = false);
284 ClipItem *getClipItemAt(int pos, int track);
285 ClipItem *getClipItemAt(GenTime pos, int track);
286 ClipItem *getClipItemAtEnd(GenTime pos, int track);
287 ClipItem *getClipItemAtStart(GenTime pos, int track);
288 Transition *getTransitionItemAt(int pos, int track);
289 Transition *getTransitionItemAt(GenTime pos, int track);
290 Transition *getTransitionItemAtEnd(GenTime pos, int track);
291 Transition *getTransitionItemAtStart(GenTime pos, int track);
292 void checkScrolling();
293 /** Should we auto scroll while playing (keep in sync with KdenliveSettings::autoscroll() */
295 void displayContextMenu(QPoint pos, AbstractClipItem *clip, AbstractGroupItem *group);
296 QMenu *m_timelineContextMenu;
297 QMenu *m_timelineContextClipMenu;
298 QMenu *m_timelineContextTransitionMenu;
300 QAction *m_autoTransition;
301 QAction *m_pasteEffectsAction;
302 QAction *m_ungroupAction;
303 QAction *m_editGuide;
304 QAction *m_deleteGuide;
305 QActionGroup *m_clipTypeGroup;
306 QTimer m_scrollTimer;
307 QTimer m_thumbsTimer;
308 /** @brief Monitor for changes in timeline (do we have audio data) */
309 QTimer m_audioMonitorTimer;
315 QCursor m_razorCursor;
316 QCursor m_spacerCursor;
317 /** list containing items currently copied in the timeline */
318 QList<AbstractClipItem *> m_copiedItems;
319 /** Used to get the point in timeline where a context menu was opened */
320 QPoint m_menuPosition;
322 AbstractGroupItem *m_selectionGroup;
323 QList <ClipItem *> m_waitingThumbs;
327 /** Get the index of the video track that is just below current track */
328 int getPreviousVideoTrack(int track);
329 void updatePositionEffects(ClipItem * item, ItemInfo info);
330 bool insertDropClips(const QMimeData *data, const QPoint pos);
331 bool canBePastedTo(ItemInfo info, int type) const;
332 bool canBePastedTo(QList <ItemInfo> infoList, int type) const;
333 bool canBePasted(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
334 bool canBeMoved(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
335 ClipItem *getClipUnderCursor() const;
336 AbstractClipItem *getMainActiveClip() const;
337 void resetSelectionGroup(bool selectItems = true);
338 void groupSelectedItems(bool force = false, bool createNewGroup = false);
339 /** Get available space for clip move (min and max free positions) */
340 void getClipAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
341 /** Get available space for transition move (min and max free positions) */
342 void getTransitionAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
343 void updateClipTypeActions(ClipItem *clip);
344 /** Whether an item can be moved to a new position without colliding with similar items */
345 bool itemCollision(AbstractClipItem *item, ItemInfo newPos);
346 /** Selects all items in the scene rect, and sets ok to false if a group going over several tracks is found in it */
347 QList<QGraphicsItem *> checkForGroups(const QRectF &rect, bool *ok);
348 /** Adjust clips under another one when working in overwrite mode */
349 void adjustTimelineClips(EDITMODE mode, ClipItem *item, ItemInfo posinfo, QUndoCommand *command);
350 void adjustTimelineTransitions(EDITMODE mode, Transition *item, QUndoCommand *command);
351 /** Adjust keyframes when pasted to another clip */
352 void adjustKeyfames(GenTime oldstart, GenTime newstart, GenTime duration, QDomElement xml);
354 /** @brief Removes the tip and stops the animation timer. */
355 void removeTipAnimation();
356 /** @brief Creates a new tip animation.
357 * @param clip clip to display the tip on
358 * @param mode operation mode for which the tip should be displayed
359 * @param size size of the tip */
360 void setTipAnimation(AbstractClipItem *clip, OPERATIONTYPE mode, const double size);
362 /** @brief Takes care of updating effects and attached transitions during a resize from start.
363 * @param item Item to resize
364 * @param oldInfo The item's info before resizement (set to item->info() is @param check true)
365 * @param pos New startPos
366 * @param check (optional, default = false) Whether to check for collisions
367 * @param command (optional) Will be used as parent command (for undo history) */
368 void prepareResizeClipStart(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
370 /** @brief Takes care of updating effects and attached transitions during a resize from end.
371 * @param item Item to resize
372 * @param oldInfo The item's info before resizement (set to item->info() is @param check true)
373 * @param pos New endPos
374 * @param check (optional, default = false) Whether to check for collisions
375 * @param command (optional) Will be used as parent command (for undo history) */
376 void prepareResizeClipEnd(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
378 /** @brief Collects information about the group's children to pass it on to RazorGroupCommand.
379 * @param group The group to cut
380 * @param cutPos The absolute position of the cut */
381 void razorGroup(AbstractGroupItem *group, GenTime cutPos);
384 void slotRefreshGuides();
385 void slotEnableRefresh();
386 void slotCheckMouseScrolling();
387 void slotEditTimeLineGuide();
388 void slotDeleteTimeLineGuide();
389 void slotFetchNextThumbs();
390 void checkTrackSequence(int track);
391 void slotGoToMarker(QAction *action);
392 void slotResetMenuPosition();
393 void slotDoResetMenuPosition();
396 void cursorMoved(int, int);
399 void mousePosition(int);
400 void clipItemSelected(ClipItem*, int ix = -1);
401 void transitionItemSelected(Transition*, int track = 0, QPoint p = QPoint(), bool update = false);
402 void activateDocumentMonitor();
403 void trackHeightChanged();
404 void tracksChanged();
405 void displayMessage(const QString, MessageType);
406 void showClipFrame(DocClipBase *, QPoint, const int);
407 void doTrackLock(int, bool);
408 void updateClipMarkers(DocClipBase *);
409 void updateTrackHeaders();
411 /** @brief Monitor document changes (for example the presence of audio data in timeline for export widget.*/
412 void documentModified();