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