]> git.sesse.net Git - kdenlive/blobdiff - src/docclipbase.h
use const ref
[kdenlive] / src / docclipbase.h
index 17c56579c22d59aeb6fb57c8e8462b64442932d1..0e22c4dad85a311889bbc874d006f6e314a3f0b8 100644 (file)
 #include <QPixmap>
 #include <QObject>
 #include <QTimer>
+#include <QProcess>
+#include <QFuture>
 
 #include <KUrl>
-#include <klocale.h>
 
 #include "gentime.h"
 #include "definitions.h"
- #include "kthumb.h"
 
 /*
-class DocTrackBase;
 class DocClipAVFile;
-class DocClipTextFile;
-class DocClipVirtual;
 class EffectDescriptionList;*/
-class KdenliveDoc;
+class KThumb;
+class ClipManager;
 
-class CommentedTime
-    {
-    public:
-        CommentedTime(): t(GenTime(0)) {}
-        CommentedTime( const GenTime time, QString comment)
-            : t( time ), c( comment )
-        { }
-
-        QString comment()   const          { return (c.isEmpty() ? i18n("Marker") : c);}
-        GenTime time() const          { return t; }
-        void    setComment( QString comm) { c = comm; }
-    private:
-        GenTime t;
-        QString c;
-    };
+namespace Mlt
+{
+class Producer;
+}
 
+struct CutZoneInfo {
+    QPoint zone;
+    QString description;
+};
 
-class DocClipBase:public QObject {
-  Q_OBJECT public:
-       /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
-        * - e.g. if you can have audio and video seperately, it should be possible to combin the two, as is
-        *   done here. If a new clip type is added then it should be possible to combine it with both audio
-        *   and video. */
 
-     DocClipBase(QDomElement xml, uint id);
-     DocClipBase(const DocClipBase& clip);
-     DocClipBase & operator=(const DocClipBase & clip);
-     virtual ~ DocClipBase();
+class DocClipBase: public QObject
+{
+Q_OBJECT
+public:
+    /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
+     * - e.g. if you can have audio and video separately, it should be possible to combin the two, as is
+     *   done here. If a new clip type is added then it should be possible to combine it with both audio
+     *   and video. */
 
-       /** sets the name of this clip. */
-    void setName(const QString name);
+    DocClipBase(ClipManager *clipManager, QDomElement xml, const QString &id);
+//    DocClipBase & operator=(const DocClipBase & clip);
+    virtual ~ DocClipBase();
 
-       /** returns the name of this clip. */
-    const QString name() const;
+    /** returns the name of this clip. */
+    const QString name() const;
 
-       /** Sets the description for this clip. */
-    void setDescription(const QString & descripton);
+    /** Returns the description of this clip. */
+    const QString description() const;
+    /** Does this clip need a transparent background (e.g. for titles). */
+    bool isTransparent() const;
 
-       /** Returns the description of this clip. */
-    const QString & description() const;
+    /** Returns any property of this clip. */
+    const QString getProperty(const QString &prop) const;
+    void setProperty(const QString &key, const QString &value);
+    void clearProperty(const QString &key);
 
     /** Returns the internal unique id of the clip. */
-    uint getId() const;
-    void setId( const uint &newId);
+    const QString &getId() const;
 
+    bool hasAudioThumb() const;
     //KThumb *thumbCreator;
     bool audioThumbCreated() const;
-    
-       /** returns the duration of this clip */
+    /*void getClipMainThumb();*/
+
+    /** returns the duration of this clip */
     const GenTime & duration() const;
-       /** returns the duration of this clip */
+    const GenTime maxDuration() const;
+    /** returns the duration of this clip */
     void setDuration(GenTime dur);
 
-       /** returns clip type (audio, text, image,...) */
+    /** returns clip type (audio, text, image,...) */
     const CLIPTYPE & clipType() const;
-       /** set clip type (audio, text, image,...) */
+    /** set clip type (audio, text, image,...) */
     void setClipType(CLIPTYPE type);
 
-       /** remove tmp file if the clip has one (for example text clips) */
+    /** remove tmp file if the clip has one (for example text clips) */
     void removeTmpFile() const;
 
-       /** Returns a url to a file describing this clip. Exactly what this url is,
-       whether it is temporary or not, and whether it provokes a render will
-       depend entirely on what the clip consists of. */
+    /** Returns a url to a file describing this clip. Exactly what this url is,
+    whether it is temporary or not, and whether it provokes a render will
+    depend entirely on what the clip consists of. */
     KUrl fileURL() const;
 
-       /** Returns true if the clip duration is known, false otherwise. */
+    /** Returns true if the clip duration is known, false otherwise. */
     bool durationKnown() const;
     // Returns the number of frames per second that this clip should play at.
     double framesPerSecond() const;
 
     bool isDocClipAVFile() const {
-       return false;
-    } 
-    
-    /*virtual DocClipAVFile *toDocClipAVFile() {
-       return 0;
-    }
-
-    virtual DocClipTextFile *toDocClipTextFile() {
-        return 0;
-    }
-    
-    virtual bool isDocClipTextFile() const {
         return false;
     }
 
-    virtual bool isDocClipVirtual() const {
-        return false;
-    } 
-    
-    virtual DocClipVirtual *toDocClipVirtual() {
-        return 0;
-    }*/
-    
-       /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
-        * where it returns true. */ 
+    /** Sets producers for the current clip (one for each track due to a limitation in MLT's track mixing */
+    void setProducer(Mlt::Producer *producer, bool reset = false, bool readPropertiesFromProducer = false);
+    /** Retrieve a producer for a track */
+    Mlt::Producer *getProducer(int track = -1);
+    /** Get a copy of the producer, for use in the clip monitor */
+    Mlt::Producer *getCloneProducer();
+    /** Retrieve the producer that shows only video */
+    Mlt::Producer *videoProducer(int track);
+    /** Retrieve the producer that shows only audio */
+    Mlt::Producer *audioProducer(int track);
+
+    /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
+     * where it returns true. */
     bool isProjectClip() const {
-       return false;
+        return false;
     }
-    // Appends scene times for this clip to the passed vector.
-/*     virtual void populateSceneTimes(QList < GenTime >
-       &toPopulate) const = 0;*/
 
-       /** Reads in the element structure and creates a clip out of it.*/
+    /** Reads in the element structure and creates a clip out of it.*/
     // Returns an XML document that describes part of the current scene.
     QDomDocument sceneToXML(const GenTime & startTime,
-       const GenTime & endTime) const;
-       /** returns a QString containing all of the XML data required to recreate this clip. */
-    QDomElement toXML() const;
-    QDomDocument generateSceneList(bool addProducers = true, bool rendering = false) const;
+                            const GenTime & endTime) const;
+    /** returns a QString containing all of the XML data required to recreate this clip. */
+    QDomElement toXML(bool hideTemporaryProperties = false) const;
 
-       /** Returns true if the xml passed matches the values in this clip */
+    /** Returns true if the xml passed matches the values in this clip */
     bool matchesXML(const QDomElement & element) const;
 
     void addReference() {
-       ++m_refcount;
+        ++m_refcount;
     }
     void removeReference() {
-       --m_refcount;
+        --m_refcount;
     }
     uint numReferences() const {
-       return m_refcount;
+        return m_refcount;
     }
-       /** Returns true if this clip has a meaningful filesize. */
-       bool hasFileSize() const;
+    /** Returns true if this clip has a meaningful filesize. */
+    bool hasFileSize() const;
 
-       /** Returns the filesize, or 0 if there is no appropriate filesize. */
-    uint fileSize() const;
+    /** Returns the filesize, or 0 if there is no appropriate filesize. */
+    qulonglong fileSize() const;
 
-       /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
-        * it uses it as part of it's own composition. */
+    /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
+     * it uses it as part of it's own composition. */
     bool referencesClip(DocClipBase * clip) const;
 
-       /** Sets the thumbnail to be used by this clip */
-    void setThumbnail(const QPixmap & pixmap);
-
-       /** Returns the thumbnail producer used by this clip */
+    /** Returns the thumbnail producer used by this clip */
     KThumb *thumbProducer();
 
-       /** Returns the thumbnail used by this clip */
-    const QPixmap & thumbnail() const;
-
-    static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
+    /** Free cache data */
+    void slotClearAudioCache();
+    QString getClipHash() const;
+    void refreshThumbUrl();
+    const char *producerProperty(const char *name) const;
+    void setProducerProperty(const char *name, const char *data);
+    void resetProducerProperty(const char *name);
+    void deleteProducers();
+
+    /** Set default play zone for clip monitor */
+    void setZone(QPoint zone);
+    /** Get default play zone for clip monitor */
+    QPoint zone() const;
+
+    /** Returns true is clip is missing but user wants to keep it as placeholder */
+    bool isPlaceHolder() const;
+    void setValid();
+    static QString getHash(const QString &path);
+
+    void addCutZone(int in, int out, QString desc = QString());
+    bool hasCutZone(QPoint p) const;
+    void removeCutZone(int in, int out);
+    QList <CutZoneInfo> cutZones() const;
+    void updateCutZone(int oldin, int oldout, int in, int out, QString desc = QString());
+
+    bool hasVideoCodec(const QString &codec) const;
+    bool hasAudioCodec(const QString &codec) const;
+    bool checkHash() const;
+    void setPlaceHolder(bool place);
+    QImage extractImage(int frame, int width, int height);
+    void clearThumbProducer();
+    void reloadThumbProducer();
+    void cleanupProducers();
+    bool isClean() const;
+    bool getAudioThumbs();
+    void setAnalysisData(const QString &name, const QString &data, int offset = 0);
+    QMap <QString, QString> analysisData() const;
+    int lastSeekPosition;
     /** Cache for every audio Frame with 10 Bytes */
     /** format is frame -> channel ->bytes */
-    QMap<int,QMap<int,QByteArray> > audioFrameChache;
-
-       /** return english name for clip type */
-    static QString getTypeName(CLIPTYPE type);
-
-  private:                     // Private attributes
-       /** The name of this clip */
-    QString m_name;
-       /** A description of this clip */
-    QString m_description;
-       /** The number of times this clip is used in the project - the number of references to this clip
-        * that exist. */
+    QMap<int, QMap<int, QByteArray> > audioFrameCache;
+    /** Returns all current properties for this clip */
+    QMap <QString, QString> properties() const;
+    /** Return the current values for a set of properties */
+    QMap <QString, QString> currentProperties(QMap <QString, QString> props);
+    QMap <QString, QStringList> metadata() const;
+    /** @brief Returns a short info string about the clip to display in tooltip */
+    const QString shortInfo() const;
+
+private:   // Private attributes
+    /** The number of times this clip is used in the project - the number of references to this clip
+     * that exist. */
     uint m_refcount;
-
+    QList <Mlt::Producer *> m_baseTrackProducers;
+    QList <Mlt::Producer *> m_videoTrackProducers;
+    QList <Mlt::Producer *> m_audioTrackProducers;
+    QList <Mlt::Producer *> m_toDeleteProducers;
     CLIPTYPE m_clipType;
 
-       /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
+    /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
     QList < CommentedTime > m_snapMarkers;
-    QDomElement m_xml;
-
-       /** A thumbnail for this clip */
-    QPixmap m_thumbnail;
     GenTime m_duration;
 
-    QTimer *m_audioTimer;
     KThumb *m_thumbProd;
     bool m_audioThumbCreated;
-    
+
     /** a unique numeric id */
-    uint m_id;
-    uint m_projectThumbFrame;
+    QString m_id;
+
+    /** Wheter the clip is a placeholder (clip missing but user wants to see it) */
+    bool m_placeHolder;
+
+    QList <CutZoneInfo> m_cutZones;
+
     void setAudioThumbCreated(bool isDone);
-       
-  public slots:
-       void updateAudioThumbnail(QMap<int,QMap<int,QByteArray> > data);
-       void slotGetAudioThumbs();
-       QList < CommentedTime > commentedSnapMarkers() const;
-       void setSnapMarkers(QList < CommentedTime > markers);
-       GenTime findNextSnapMarker(const GenTime & currTime);
-       GenTime findPreviousSnapMarker(const GenTime & currTime);
-       GenTime hasSnapMarkers(const GenTime & time);
-       QString deleteSnapMarker(const GenTime & time);
-       void editSnapMarker(const GenTime & time, QString comment);
-       void addSnapMarker(const GenTime & time, QString comment);
-       QList < GenTime > snapMarkers() const;
-       QString markerComment(GenTime t);
-       void setProjectThumbFrame( const uint &ix);
-       uint getProjectThumbFrame() const;
-       signals:
-               void getAudioThumbs();
+    /** Holds clip infos like fps, size,... */
+    QMap <QString, QString> m_properties;
+    /** Holds clip metadata like author, copyright,... */
+    QMap <QString, QStringList> m_metadata;
+    /** Holds clip analysis data that can be used later to create markers or keyframes */
+    QMap <QString, QString> m_analysisdata;
+    
+    /** Try to make sure we don't delete a producer while using it */
+    QMutex m_producerMutex;
+    QMutex m_replaceMutex;
+    
+    /** @brief This timer will trigger creation of audio thumbnails. */
+    QTimer m_audioTimer;
+
+    /** Create connections for audio thumbnails */
+    void slotRefreshProducer();
+    void setProducerProperty(const char *name, int data);
+    void setProducerProperty(const char *name, double data);
+    void getFileHash(const QString &url);
+    /** @brief When duplicating a producer, make sure all manually set properties are passed to it. */
+    void adjustProducerProperties(Mlt::Producer *prod, const QString &id, bool mute, bool blind);
+    /** @brief Create another instance of a producer. */
+    Mlt::Producer *cloneProducer(Mlt::Producer *source);
+    /** @brief Offset all keyframes of a geometry. */
+    const QString geometryWithOffset(QString data, int offset);
+
+   
+public slots:
+    void updateAudioThumbnail(const audioByteArray& data);
+    QList < CommentedTime > commentedSnapMarkers() const;
+    GenTime findNextSnapMarker(const GenTime & currTime);
+    GenTime findPreviousSnapMarker(const GenTime & currTime);
+    GenTime hasSnapMarkers(const GenTime & time);
+    QString deleteSnapMarker(const GenTime & time);
+    void editSnapMarker(const GenTime & time, QString comment);
+    void addSnapMarker(const CommentedTime marker);
+    QList < GenTime > snapMarkers() const;
+    QString markerComment(GenTime t) const;
+    CommentedTime markerAt(GenTime t) const;
+    void setClipThumbFrame(const uint &ix);
+    uint getClipThumbFrame() const;
+    void setProperties(QMap <QString, QString> properties);
+    void setMetadata(QMap <QString, QString> properties, QString tool = QString());
+    void slotExtractImage(QList <int> frames);
+
+signals:
+    void gotAudioData();
+    /** @brief Generate a proxy clip (lower resolution copy) named like the clip's hash. */
+    void createProxy(const QString &id);
+    /** @brief Abort creation of the proxy clip (lower resolution copy). */
+    void abortProxy(const QString &id, const QString &proxyPath);
 };
 
 #endif