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     void slotAddClipMarker(const QString &id, GenTime t, QString c);
 208     bool addGuide(const GenTime pos, const QString &comment);
 209     void slotAddGuide();
 210     void slotEditGuide(CommentedTime guide);
 211     void slotEditGuide(int guidePos = -1);
 212     void slotDeleteGuide(int guidePos = -1);
 213     void slotDeleteAllGuides();
 214     void editGuide(const GenTime oldPos, const GenTime pos, const QString &comment);
 215     void copyClip();
 216     void pasteClip();
 217     void pasteClipEffects();
 218     void slotUpdateAllThumbs();
 219     void slotCheckPositionScrolling();
 220     void slotInsertTrack(int ix);
 221
 222     /** @brief Shows a dialog for selecting a track to delete.
 223     * @param ix Number of the track, which should be pre-selected in the dialog */
 224     void slotDeleteTrack(int ix);
 225     /** @brief Shows the configure tracks dialog. */
 226     void slotConfigTracks(int ix);
 227     void clipNameChanged(const QString id, const QString name);
 228     void slotTrackUp();
 229     void slotTrackDown();
 230     void slotSelectTrack(int ix);
 231     void insertZoneOverwrite(QStringList data, int in);
 232
 233     /** @brief Rebuilds a group to fit again after children changed.
 234     * @param childTrack the track of one of the groups children
 235     * @param childPos The position of the same child */
 236     void rebuildGroup(int childTrack, GenTime childPos);
 237     /** @brief Rebuilds a group to fit again after children changed.
 238     * @param group The group to rebuild */
 239     void rebuildGroup(AbstractGroupItem *group);
 240
 241     /** @brief Cuts a group into two parts.
 242     * @param clips1 Clips before the cut
 243     * @param transitions1 Transitions before the cut
 244     * @param clipsCut Clips that need to be cut
 245     * @param transitionsCut Transitions that need to be cut
 246     * @param clips2 Clips behind the cut
 247     * @param transitions2 Transitions behind the cut
 248     * @param cutPos Absolute position of the cut
 249     * @param cut true = cut, false = "uncut" */
 250     void slotRazorGroup(QList <ItemInfo> clips1, QList <ItemInfo> transitions1, QList <ItemInfo> clipsCut, QList <ItemInfo> transitionsCut, QList <ItemInfo> clips2, QList <ItemInfo> transitions2, GenTime cutPos, bool cut);
 251
 252     /** @brief Add en effect to a track.
 253     * @param effect The new effect xml
 254     * @param ix The track index */
 255     void slotAddTrackEffect(const QDomElement effect, int ix);
 256
 257     /** @brief Update the list of snap points (sticky timeline hotspots).
 258     * @param selected The currently selected clip if any
 259     * @param offsetList The list of points that should also snap (for example when movin a clip, start and end points should snap
 260     * @param skipSelectedItems if true, the selected item start and end points will not be added to snap list */
 261     void updateSnapPoints(AbstractClipItem *selected, QList <GenTime> offsetList = QList <GenTime> (), bool skipSelectedItems = false);
 262
 263 protected:
 264     virtual void drawBackground(QPainter * painter, const QRectF & rect);
 265     //virtual void drawForeground ( QPainter * painter, const QRectF & rect );
 266     virtual void dragEnterEvent(QDragEnterEvent * event);
 267     virtual void dragMoveEvent(QDragMoveEvent * event);
 268     virtual void dragLeaveEvent(QDragLeaveEvent * event);
 269     /** @brief Something has been dropped onto the timeline */
 270     virtual void dropEvent(QDropEvent * event);
 271     virtual void wheelEvent(QWheelEvent * e);
 272     virtual void keyPressEvent(QKeyEvent * event);
 273     virtual QStringList mimeTypes() const;
 274     virtual Qt::DropActions supportedDropActions() const;
 275
 276 private:
 277     int m_tracksHeight;
 278     int m_projectDuration;
 279     int m_cursorPos;
 280     KdenliveDoc *m_document;
 281     CustomTrackScene *m_scene;
 282     QGraphicsLineItem *m_cursorLine;
 283     ItemInfo m_dragItemInfo;
 284     ItemInfo m_selectionGroupInfo;
 285     OPERATIONTYPE m_operationMode;
 286     OPERATIONTYPE m_moveOpMode;
 287     AbstractClipItem *m_dragItem;
 288     Guide *m_dragGuide;
 289     QUndoStack *m_commandStack;
 290     QGraphicsItem *m_visualTip;
 291     QGraphicsItemAnimation *m_animation;
 292     QTimeLine *m_animationTimer;
 293     QColor m_tipColor;
 294     QPen m_tipPen;
 295     QPoint m_clickPoint;
 296     QPoint m_clickEvent;
 297     QList <CommentedTime> m_searchPoints;
 298     QList <Guide *> m_guides;
 299
 300     ClipItem *getClipItemAt(int pos, int track);
 301     ClipItem *getClipItemAt(GenTime pos, int track);
 302     ClipItem *getClipItemAtEnd(GenTime pos, int track);
 303     ClipItem *getClipItemAtStart(GenTime pos, int track);
 304     Transition *getTransitionItemAt(int pos, int track);
 305     Transition *getTransitionItemAt(GenTime pos, int track);
 306     Transition *getTransitionItemAtEnd(GenTime pos, int track);
 307     Transition *getTransitionItemAtStart(GenTime pos, int track);
 308     void checkScrolling();
 309     /** Should we auto scroll while playing (keep in sync with KdenliveSettings::autoscroll() */
 310     bool m_autoScroll;
 311     void displayContextMenu(QPoint pos, AbstractClipItem *clip, AbstractGroupItem *group);
 312     QMenu *m_timelineContextMenu;
 313     QMenu *m_timelineContextClipMenu;
 314     QMenu *m_timelineContextTransitionMenu;
 315     QMenu *m_markerMenu;
 316     QAction *m_autoTransition;
 317     QAction *m_pasteEffectsAction;
 318     QAction *m_ungroupAction;
 319     QAction *m_editGuide;
 320     QAction *m_deleteGuide;
 321     QActionGroup *m_clipTypeGroup;
 322     QTimer m_scrollTimer;
 323     QTimer m_thumbsTimer;
 324     int m_scrollOffset;
 325     bool m_clipDrag;
 326
 327     int m_findIndex;
 328     PROJECTTOOL m_tool;
 329     QCursor m_razorCursor;
 330     QCursor m_spacerCursor;
 331     /** list containing items currently copied in the timeline */
 332     QList<AbstractClipItem *> m_copiedItems;
 333     /** Used to get the point in timeline where a context menu was opened */
 334     QPoint m_menuPosition;
 335     bool m_blockRefresh;
 336     AbstractGroupItem *m_selectionGroup;
 337     QList <ClipItem *> m_waitingThumbs;
 338     int m_selectedTrack;
 339     int m_spacerOffset;
 340
 341     QMutex m_mutex;
 342     QWaitCondition m_producerNotReady;
 343     KStatefulBrush m_activeTrackBrush;
 344
 345     /** stores the state of the control modifier during mouse press.
 346      * Will then be used to identify whether we resize a group or only one item of it. */
 347     bool m_controlModifier;
 348
 349     /** Get the index of the video track that is just below current track */
 350     int getPreviousVideoTrack(int track);
 351     void updatePositionEffects(ClipItem * item, ItemInfo info);
 352     bool insertDropClips(const QMimeData *data, const QPoint pos);
 353     bool canBePastedTo(ItemInfo info, int type) const;
 354     bool canBePastedTo(QList <ItemInfo> infoList, int type) const;
 355     bool canBePasted(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
 356     bool canBeMoved(QList<AbstractClipItem *> items, GenTime offset, int trackOffset) const;
 357     ClipItem *getClipUnderCursor() const;
 358     AbstractClipItem *getMainActiveClip() const;
 359     void resetSelectionGroup(bool selectItems = true);
 360     void groupSelectedItems(bool force = false, bool createNewGroup = false);
 361     /** Get available space for clip move (min and max free positions) */
 362     void getClipAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
 363     /** Get available space for transition move (min and max free positions) */
 364     void getTransitionAvailableSpace(AbstractClipItem *item, GenTime &minimum, GenTime &maximum);
 365     void updateClipTypeActions(ClipItem *clip);
 366     /** Whether an item can be moved to a new position without colliding with similar items */
 367     bool itemCollision(AbstractClipItem *item, ItemInfo newPos);
 368     /** Selects all items in the scene rect, and sets ok to false if a group going over several tracks is found in it */
 369     QList<QGraphicsItem *> checkForGroups(const QRectF &rect, bool *ok);
 370     /** Adjust clips under another one when working in overwrite mode */
 371     void adjustTimelineClips(EDITMODE mode, ClipItem *item, ItemInfo posinfo, QUndoCommand *command);
 372     void adjustTimelineTransitions(EDITMODE mode, Transition *item, QUndoCommand *command);
 373     /** Adjust keyframes when pasted to another clip */
 374     void adjustKeyfames(GenTime oldstart, GenTime newstart, GenTime duration, QDomElement xml);
 375
 376     /** @brief Removes the tip and stops the animation timer. */
 377     void removeTipAnimation();
 378     /** @brief Creates a new tip animation.
 379     * @param clip clip to display the tip on
 380     * @param mode operation mode for which the tip should be displayed
 381     * @param size size of the tip */
 382     void setTipAnimation(AbstractClipItem *clip, OPERATIONTYPE mode, const double size);
 383
 384     /** @brief Takes care of updating effects and attached transitions during a resize from start.
 385     * @param item Item to resize
 386     * @param oldInfo The item's info before resizement (set to item->info() is @param check true)
 387     * @param pos New startPos
 388     * @param check (optional, default = false) Whether to check for collisions
 389     * @param command (optional) Will be used as parent command (for undo history) */
 390     void prepareResizeClipStart(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
 391
 392     /** @brief Takes care of updating effects and attached transitions during a resize from end.
 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 endPos
 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 prepareResizeClipEnd(AbstractClipItem *item, ItemInfo oldInfo, int pos, bool check = false, QUndoCommand *command = NULL);
 399
 400     /** @brief Collects information about the group's children to pass it on to RazorGroupCommand.
 401     * @param group The group to cut
 402     * @param cutPos The absolute position of the cut */
 403     void razorGroup(AbstractGroupItem *group, GenTime cutPos);
 404
 405     /** @brief Gets the effect parameters that will be passed to Mlt. */
 406     EffectsParameterList getEffectArgs(const QDomElement effect);
 407
 408     /** @brief Updates @param item's pan and zoom effect after resize or cut.
 409      * @param item clip whose pan and zoom effect should be updated
 410      * @param cutPos (optional) if clip was cut, cut position relative to the original's clip position */
 411     void updatePanZoom(ClipItem *item, GenTime cutPos = GenTime());
 412
 413     /** @brief Update Tracknames to fit again after track was added/deleted.
 414      * @param track Number of track which was added/deleted
 415      * @param added true = track added, false = track deleted
 416      *
 417      * The default track name consists of type + number. If we add/delete a track the number has to be adjusted
 418      * if the name is still the default one. */
 419     void updateTrackNames(int track, bool added);
 420
 421 private slots:
 422     void slotRefreshGuides();
 423     void slotEnableRefresh();
 424     void slotCheckMouseScrolling();
 425     void slotEditTimeLineGuide();
 426     void slotDeleteTimeLineGuide();
 427     void slotFetchNextThumbs();
 428     void checkTrackSequence(int track);
 429     void slotGoToMarker(QAction *action);
 430     void slotResetMenuPosition();
 431     void slotDoResetMenuPosition();
 432
 433 signals:
 434     void cursorMoved(int, int);
 435     void zoomIn();
 436     void zoomOut();
 437     void mousePosition(int);
 438     void clipItemSelected(ClipItem*, int ix = -1);
 439     void transitionItemSelected(Transition*, int track = 0, QPoint p = QPoint(), bool update = false);
 440     void activateDocumentMonitor();
 441     void trackHeightChanged();
 442     void tracksChanged();
 443     void displayMessage(const QString, MessageType);
 444     void showClipFrame(DocClipBase *, QPoint, const int);
 445     void doTrackLock(int, bool);
 446     void updateClipMarkers(DocClipBase *);
 447     void updateTrackHeaders();
 448     void playMonitor();
 449     /** @brief Monitor document changes (for example the presence of audio data in timeline for export widget.*/
 450     void documentModified();
 451     void forceClipProcessing(const QString &);
 452     void showTrackEffects(int, TrackInfo);
 453     /** @brief Update the track effect button that shows if a track has effects or not.*/
 454     void updateTrackEffectState(int);
 455 };
 456
 457 #endif
 458