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