]> git.sesse.net Git - kdenlive/blobdiff - src/clipitem.h
Integrate with the required MLT hooks for getting Movit to work.
[kdenlive] / src / clipitem.h
index c1589cd74bcff254270fcba901514518e28681d9..4ee13a690fe2c815129ab481e8d90ad41f259232 100644 (file)
@@ -26,6 +26,7 @@
 #include <QDomElement>
 #include <QGraphicsSceneMouseEvent>
 #include <QTimer>
+#include <QFuture>
 
 #include "definitions.h"
 #include "gentime.h"
 class DocClipBase;
 class Transition;
 
+namespace Mlt
+{
+class Producer;
+}
 
-class ClipItem : public AbstractClipItem {
+class ClipItem : public AbstractClipItem
+{
     Q_OBJECT
 
 public:
-    ClipItem(DocClipBase *clip, ItemInfo info, double fps);
+    ClipItem(DocClipBase *clip, const ItemInfo &info, double fps, double speed, int strobe, int frame_width, bool generateThumbs = true);
     virtual ~ ClipItem();
     virtual void paint(QPainter *painter,
                        const QStyleOptionGraphicsItem *option,
                        QWidget *);
     virtual int type() const;
-    void resizeStart(int posx);
-    void resizeEnd(int posx);
-    OPERATIONTYPE operationMode(QPointF pos);
-    const QString &clipProducer() const;
+    void resizeStart(int posx, bool size = true, bool emitChange = true);
+    void resizeEnd(int posx, bool emitChange = true);
+    OperationType operationMode(const QPointF &pos);
+    static int itemHeight();
+    const QString clipProducer() const;
     int clipType() const;
     DocClipBase *baseClip() const;
     QString clipName() const;
+    void setClipName(const QString &name);
     QDomElement xml() const;
-    ClipItem *clone(ItemInfo info) const;
-    const EffectsList effectList();
+    QDomElement itemXml() const;
+    ClipItem *clone(const ItemInfo &info) const;
+    const EffectsList effectList() const;
     void setFadeOut(int pos);
     void setFadeIn(int pos);
-    /** Give a string list of the clip's effect names */
+    void setFades(int in, int out);
+
+    /** @brief Gets the clip's effect names.
+    * @return The names of the effects in a string list */
     QStringList effectNames();
-    /** Add an effect to the clip and return the parameters that will be passed to Mlt */
-    QHash <QString, QString> addEffect(QDomElement effect, bool animate = true);
-    /** Get the effect parameters that will be passed to Mlt */
-    QHash <QString, QString> getEffectArgs(QDomElement effect);
-    /** Delete effect with id index */
-    void deleteEffect(QString index);
-    /** return the number of effects in that clip */
+
+    /** @brief Adds an effect to the clip.
+    * @return The parameters that will be passed to Mlt */
+    EffectsParameterList addEffect(QDomElement effect, bool animate = true);
+
+    /** @brief Deletes the effect with id @param index. */
+    void deleteEffect(const QString &index);
+
+    /** @brief Gets the number of effects in this clip. */
     int effectsCount();
-    /** return a unique effect id */
+
+    /** @brief Gets a unique (?) effect id. */
     int effectsCounter();
-    /** return the xml of effect at index ix in stack */
-    QDomElement effectAt(int ix);
-    /** Replace effect at pos ix with given value */
-    void setEffectAt(int ix, QDomElement effect);
+    
+        /** @brief Gets a copy of the xml of an effect.
+    * @param ix The effect's list index (starting from 0)
+    * @return A copy of the effect's xml */
+    QDomElement effect(int ix) const;
+
+    /** @brief Gets a copy of the xml of an effect.
+    * @param ix The effect's index in effectlist (starting from 1)
+    * @return A copy of the effect's xml */
+    QDomElement effectAtIndex(int ix) const;
+
+    /** @brief Gets the xml of an effect.
+    * @param ix The effect's index in effectlist (starting from 1)
+    * @return The effect's xml */
+    QDomElement getEffectAtIndex(int ix) const;
+
+    /** @brief Replaces an effect.
+    * @param ix The effect's index in effectlist
+    * @param effect The new effect */
+    void updateEffect(QDomElement effect);
+    /** @brief Enable / disable a list of effect from their indexes. */
+    void enableEffects(QList <int> indexes, bool disable);
+    bool moveEffect(QDomElement effect, int ix);
     void flashClip();
     void addTransition(Transition*);
-    /** regenerate audio and video thumbnails */
-    void resetThumbs();
-    /** update clip properties from base clip */
-    void refreshClip();
-    /** Returns a list of times for this clip's markers */
+
+    /** @brief Regenerates audio and video thumbnails.
+    * @param clearExistingThumbs true = regenerate all thumbs, false = only create missing thumbs. */
+    void resetThumbs(bool clearExistingThumbs);
+
+    /** @brief Updates clip properties from base clip.
+    * @param checkDuration whether or not to check for a valid duration. 
+    * @param resetThumbs whether or not to recreate the image thumbnails. */
+    void refreshClip(bool checkDuration, bool resetThumbs);
+
+    /** @brief Gets clip's marker times.
+    * @return A list of the times. */
     QList <GenTime> snapMarkers() const;
     QList <CommentedTime> commentedSnapMarkers() const;
-    uint fadeIn() const;
-    uint fadeOut() const;
+
+    /** @brief Gets the position of the fade in effect. */
+    int fadeIn() const;
+
+    /** @brief Gets the position of the fade out effect. */
+    int fadeOut() const;
     void setSelectedEffect(const int ix);
     void updateKeyframeEffect();
     QDomElement selectedEffect();
     int selectedEffectIndex() const;
-    void initEffect(QDomElement effect);
-    QString keyframes(const int index);
-    void setKeyframes(const int ix, const QString keyframes);
-    void setEffectList(const EffectsList effectList);
-    void setSpeed(const double speed);
+    
+    void initEffect(QDomElement effect, int diff = 0, int offset = 0);
+
+    /** @brief Gets all keyframes.
+    * @param index Index of the effect
+    * @return a list of strings of keyframes (one string per param) */
+    QStringList keyframes(const int index);
+
+    /** @brief Adjust all geometry keyframes.
+    * @param index Index of the effect */
+    void resizeGeometries(const int index, int width, int height, int previousDuration, int start, int duration);
+
+    /** @brief Sets params with keyframes and updates the visible keyframes.
+    * @param ix Number of the effect
+    * @param keyframes a list of strings of keyframes (one string per param), which should be used */
+    void setKeyframes(const int ix, const QStringList &keyframes);
+    void setEffectList(const EffectsList &effectList);
+    void setSpeed(const double speed, int strobe);
     double speed() const;
+    int strobe() const;
     GenTime maxDuration() const;
+    GenTime speedIndependantCropStart() const;
+    GenTime speedIndependantCropDuration() const;
+    const ItemInfo speedIndependantInfo() const;
     int hasEffect(const QString &tag, const QString &id) const;
 
+    /** @brief Adjust keyframes to the new clip. */
+    const QString adjustKeyframes(const QString &keyframes, int offset);
+    /** @brief Makes sure all keyframes are in the clip's cropped duration.
+     * @param cutPos the frame number where the new clip starts
+    * @return Whether or not changes were made */
+    bool checkKeyFrames(int width, int height, int previousDuration, int cutPos = -1);
+    QPixmap startThumb() const;
+    QPixmap endThumb() const;
+    void setVideoOnly(bool force);
+    void setAudioOnly(bool force);
+    bool isVideoOnly() const;
+    bool isAudioOnly() const;
+
+    void insertKeyframe(QDomElement effect, int pos, int val);
+    void movedKeyframe(QDomElement effect, int oldpos, int newpos, double value);
+    void updateKeyframes(QDomElement effect);
+    void updateGeometryKeyframes(QDomElement effect, int paramIndex, int width, int height, ItemInfo oldInfo);
+    bool updateNormalKeyframes(QDomElement parameter, ItemInfo oldInfo);
+
+    /** @brief Adjusts effects after a clip duration change. */
+    QMap<int, QDomElement> adjustEffectsToDuration(int width, int height, const ItemInfo &oldInfo);
+
+    /** Returns the necessary (audio, video, general) producer.
+     * @param track Track of the requested producer
+     * @param trackSpecific (default = true) Whether to return general producer for a specific track.
+     * @return Fitting producer
+     * Which producer is returned depends on the type of this clip (audioonly, videoonly, normal) */
+    Mlt::Producer *getProducer(int track, bool trackSpecific = true);
+    void resetFrameWidth(int width);
+    /** @brief Clip is about to be deleted, block thumbs. */
+    void stopThumbs();
+    
+    /** @brief Get a free index value for effect group. */
+    int nextFreeEffectGroupIndex() const;
+
 protected:
     //virtual void mouseMoveEvent(QGraphicsSceneMouseEvent * event);
-    virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent * event);
-    virtual void mousePressEvent(QGraphicsSceneMouseEvent * event);
-    virtual void dragEnterEvent(QGraphicsSceneDragDropEvent *event);
-    virtual void dragLeaveEvent(QGraphicsSceneDragDropEvent *event);
-    virtual void dropEvent(QGraphicsSceneDragDropEvent *event);
-    virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *);
-    virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *);
-    virtual QVariant itemChange(GraphicsItemChange change, const QVariant &value);
+    void dragEnterEvent(QGraphicsSceneDragDropEvent *event);
+    void dragLeaveEvent(QGraphicsSceneDragDropEvent *event);
+    void dropEvent(QGraphicsSceneDragDropEvent *event);
+    //virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *);
+    //virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *);
+    QVariant itemChange(GraphicsItemChange change, const QVariant &value);
 
 private:
     DocClipBase *m_clip;
-    OPERATIONTYPE m_resizeMode;
-    int m_grabPoint;
+    ItemInfo m_speedIndependantInfo;
     QString m_producer;
-    CLIPTYPE m_clipType;
+    ClipType m_clipType;
     QString m_clipName;
     QString m_effectNames;
-    uint m_startFade;
-    uint m_endFade;
-    int m_maxTrack;
+    int m_startFade;
+    int m_endFade;
+    bool m_audioOnly;
+    bool m_videoOnly;
+    QColor m_baseColor;
+    QColor m_paintColor;
 
     QPixmap m_startPix;
     QPixmap m_endPix;
+
     bool m_hasThumbs;
-    QTimer *startThumbTimer;
-    QTimer *endThumbTimer;
+    QTimer m_startThumbTimer;
+    QTimer m_endThumbTimer;
 
-    /** counter used to provide a unique id to each effect */
-    int m_effectsCounter;
     int m_selectedEffect;
-    double m_opacity;
     QTimeLine *m_timeLine;
     bool m_startThumbRequested;
     bool m_endThumbRequested;
-    bool m_hover;
+    //bool m_hover;
     double m_speed;
+    int m_strobe;
 
     EffectsList m_effectList;
     QList <Transition*> m_transitionsList;
-    QMap<int, QPixmap> audioThumbCachePic;
-    bool audioThumbWasDrawn, audioThumbReady;
-    double framePixelWidth;
-    QMap<int, QPainterPath > channelPaths;
-    /** Called when clip start is resized, adjust keyframes values */
-    void checkEffectsKeyframesPos(const int previous, const int current, bool fromStart);
+    QMap<int, QPixmap> m_audioThumbCachePic;
+    bool m_audioThumbReady;
+    double m_framePixelWidth;
+
+    QPixmap m_videoPix;
+    QPixmap m_audioPix;
+    /** @brief Keyframes type can be "keyframe" or "simplekeyframe" which have to be painted differently.
+     * True if keyframe type is "keyframe" */
+    bool m_limitedKeyFrames;
 
 private slots:
-    void slotFetchThumbs();
     void slotGetStartThumb();
     void slotGetEndThumb();
     void slotGotAudioData();
-    void slotPrepareAudioThumb(double pixelForOneFrame, int startpixel, int endpixel, int channels);
+    void slotPrepareAudioThumb(double pixelForOneFrame, int startpixel, int endpixel, int channels, int pixelHeight);
     void animate(qreal value);
-    void slotSetStartThumb(QImage img);
-    void slotSetEndThumb(QImage img);
-    void slotSetStartThumb(QPixmap pix);
-    void slotSetEndThumb(QPixmap pix);
-    void slotThumbReady(int frame, QPixmap pix);
+    void slotSetStartThumb(const QImage &img);
+    void slotSetEndThumb(const QImage &img);
+    void slotThumbReady(int frame, const QImage &img);
+    /** @brief The thumbnailer has finished to cache all required thumbs. */
+    void slotGotThumbsCache();
+
+public slots:
+    void slotFetchThumbs();
+    void slotSetStartThumb(const QPixmap &pix);
+    void slotSetEndThumb(const QPixmap &pix);
+    void slotUpdateRange();
 
 signals:
-    void getThumb(int, int);
-    void prepareAudioThumb(double, int, int, int);
+    void prepareAudioThumb(double, int, int, int, int);
+    void updateRange();
 };
 
 #endif