]> git.sesse.net Git - kdenlive/blobdiff - src/clipitem.h
Volume envelope calculation
[kdenlive] / src / clipitem.h
index 56bbd77a3b378669f4a4c3dd7645dd438d9bb2cb..c28709938f444eb41f03de68cb51930b9f0d31e4 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
 {
     Q_OBJECT
 
 public:
-    ClipItem(DocClipBase *clip, ItemInfo info, double fps, double speed, int strobe, bool generateThumbs = true);
+    ClipItem(DocClipBase *clip, 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, double speed = 1.0);
-    void resizeEnd(int posx, double speed = 1.0);
+    void resizeStart(int posx, bool size = true);
+    void resizeEnd(int posx);
     OPERATIONTYPE operationMode(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;
+    QDomElement itemXml() const;
     ClipItem *clone(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 */
+
+    /** @brief Adds an effect to the clip.
+    * @return The parameters that will be passed to Mlt */
     EffectsParameterList addEffect(const QDomElement effect, bool animate = true);
-    /** Get the effect parameters that will be passed to Mlt */
-    EffectsParameterList getEffectArgs(QDomElement effect);
-    /** Delete effect with id index */
+
+    /** @brief Deletes the effect with id @param index. */
     void deleteEffect(QString index);
-    /** return the number of effects in that clip */
+
+    /** @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 a copy of the xml of effect at index ix in stack */
+
+    /** @brief Gets a copy of the xml of an effect.
+    * @param ix The effect's index in effectlist
+    * @return A copy of the effect's xml */
     QDomElement effectAt(int ix) const;
-    /** return the xml of effect at index ix in stack */
+
+    /** @brief Gets the xml of an effect.
+    * @param ix The effect's index in effectlist
+    * @return The effect's xml */
     QDomElement getEffectAt(int ix) const;
-    /** Replace effect at pos ix with given value */
+
+    /** @brief Replaces an effect.
+    * @param ix The effect's index in effectlist
+    * @param effect The new effect */
     void setEffectAt(int ix, QDomElement effect);
     void flashClip();
     void addTransition(Transition*);
-    /** regenerate audio and video thumbnails */
+
+    /** @brief Regenerates audio and video thumbnails.
+    * @param clearExistingThumbs true = regenerate all thumbs, false = only create missing thumbs. */
     void resetThumbs(bool clearExistingThumbs);
-    /** update clip properties from base clip */
-    void refreshClip(bool checkDuration);
-    /** Returns a list of times for this clip's markers */
+
+    /** @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;
+
+    /** @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, int diff = 0);
-    QString keyframes(const int index);
-    void setKeyframes(const int ix, const QString keyframes);
+
+    /** @brief Gets all keyframes.
+    * @param index Number of the effect
+    * @return a list of strings of keyframes (one string per param) */
+    QStringList keyframes(const int index);
+
+    /** @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 cropStart() const;
-    GenTime endPos() const;
-    GenTime cropDuration() const;
+    GenTime speedIndependantCropStart() const;
+    GenTime speedIndependantCropDuration() const;
+    const ItemInfo speedIndependantInfo() const;
     int hasEffect(const QString &tag, const QString &id) const;
+
+    /** @brief Makes sure all keyframes are in the clip's cropped duration.
+    * @return Whether or not changes were made */
     bool checkKeyFrames();
     QPixmap startThumb() const;
     QPixmap endThumb() const;
@@ -112,8 +156,25 @@ public:
     void setAudioOnly(bool force);
     bool isVideoOnly() const;
     bool isAudioOnly() const;
-    /** Called when clip start is resized, adjust keyframes values */
-    bool checkEffectsKeyframesPos(const int previous, const int current, bool fromStart);
+
+    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);
+
+    /** @brief Adjusts effects after a clip duration change. */
+    QMap<int, QDomElement> adjustEffectsToDuration(int width, int height, 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();
 
 protected:
     //virtual void mouseMoveEvent(QGraphicsSceneMouseEvent * event);
@@ -126,6 +187,7 @@ protected:
 
 private:
     DocClipBase *m_clip;
+    ItemInfo m_speedIndependantInfo;
     QString m_producer;
     CLIPTYPE m_clipType;
     QString m_clipName;
@@ -138,6 +200,7 @@ private:
 
     QPixmap m_startPix;
     QPixmap m_endPix;
+
     bool m_hasThumbs;
     QTimer m_startThumbTimer;
     QTimer m_endThumbTimer;
@@ -158,6 +221,9 @@ private:
 
     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 slotGetStartThumb();
@@ -167,7 +233,9 @@ private slots:
     void animate(qreal value);
     void slotSetStartThumb(QImage img);
     void slotSetEndThumb(QImage img);
-    void slotThumbReady(int frame, QPixmap pix);
+    void slotThumbReady(int frame, QImage img);
+    /** @brief The thumbnailer has finished to cache all required thumbs. */
+    void slotGotThumbsCache();
 
 public slots:
     void slotFetchThumbs();