git.sesse.net Git - kdenlive/blob - src/docclipbase.h

   1 /***************************************************************************
   2                           docclipbase.h  -  description
   3                              -------------------
   4     begin                : Fri Apr 12 2002
   5     copyright            : (C) 2002 by Jason Wood
   6     email                : jasonwood@blueyonder.co.uk
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef DOCCLIPBASE_H
  19 #define DOCCLIPBASE_H
  20
  21 /**DocClip is a class for the various types of clip
  22   *@author Jason Wood
  23   */
  24
  25 #include <qdom.h>
  26 #include <QPixmap>
  27 #include <QObject>
  28 #include <QTimer>
  29
  30 #include <KUrl>
  31
  32 #include "gentime.h"
  33 #include "definitions.h"
  34
  35 /*
  36 class DocTrackBase;
  37 class DocClipAVFile;
  38 class DocClipTextFile;
  39 class DocClipVirtual;
  40 class EffectDescriptionList;*/
  41 class KdenliveDoc;
  42 class KThumb;
  43 class ClipManager;
  44
  45 namespace Mlt {
  46 class Producer;
  47 };
  48
  49
  50 class DocClipBase: public QObject {
  51 Q_OBJECT public:
  52     /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
  53      * - e.g. if you can have audio and video seperately, it should be possible to combin the two, as is
  54      *   done here. If a new clip type is added then it should be possible to combine it with both audio
  55      *   and video. */
  56
  57     DocClipBase(ClipManager *clipManager, QDomElement xml, const QString &id);
  58 //    DocClipBase & operator=(const DocClipBase & clip);
  59     virtual ~ DocClipBase();
  60
  61     /** sets the name of this clip. */
  62     void setName(const QString name);
  63
  64     /** returns the name of this clip. */
  65     const QString & name() const;
  66
  67     /** Returns the description of this clip. */
  68     const QString description() const;
  69     /** Does this clip need a transparent background (e.g. for titles). */
  70     bool isTransparent() const;
  71
  72     /** Returns any property of this clip. */
  73     const QString getProperty(const QString prop) const;
  74     void setProperty(const QString &key, const QString &value);
  75     void clearProperty(const QString &key);
  76
  77     /** Returns the internal unique id of the clip. */
  78     const QString &getId() const;
  79     void setId(const QString &newId);
  80
  81     //KThumb *thumbCreator;
  82     bool audioThumbCreated() const;
  83     /*void getClipMainThumb();*/
  84
  85     /** returns the duration of this clip */
  86     const GenTime & duration() const;
  87     const GenTime &maxDuration() const;
  88     /** returns the duration of this clip */
  89     void setDuration(GenTime dur);
  90
  91     /** returns clip type (audio, text, image,...) */
  92     const CLIPTYPE & clipType() const;
  93     /** set clip type (audio, text, image,...) */
  94     void setClipType(CLIPTYPE type);
  95
  96     /** remove tmp file if the clip has one (for example text clips) */
  97     void removeTmpFile() const;
  98
  99     /** Returns a url to a file describing this clip. Exactly what this url is,
 100     whether it is temporary or not, and whether it provokes a render will
 101     depend entirely on what the clip consists of. */
 102     KUrl fileURL() const;
 103
 104     /** Returns true if the clip duration is known, false otherwise. */
 105     bool durationKnown() const;
 106     // Returns the number of frames per second that this clip should play at.
 107     double framesPerSecond() const;
 108
 109     bool isDocClipAVFile() const {
 110         return false;
 111     }
 112
 113     void setProducer(Mlt::Producer *producer);
 114     Mlt::Producer *producer(int track = -1);
 115
 116     /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
 117      * where it returns true. */
 118     bool isProjectClip() const {
 119         return false;
 120     }
 121
 122     /** Reads in the element structure and creates a clip out of it.*/
 123     // Returns an XML document that describes part of the current scene.
 124     QDomDocument sceneToXML(const GenTime & startTime,
 125                             const GenTime & endTime) const;
 126     /** returns a QString containing all of the XML data required to recreate this clip. */
 127     QDomElement toXML() const;
 128
 129     /** Returns true if the xml passed matches the values in this clip */
 130     bool matchesXML(const QDomElement & element) const;
 131
 132     void addReference() {
 133         ++m_refcount;
 134     }
 135     void removeReference() {
 136         --m_refcount;
 137     }
 138     uint numReferences() const {
 139         return m_refcount;
 140     }
 141     /** Returns true if this clip has a meaningful filesize. */
 142     bool hasFileSize() const;
 143
 144     /** Returns the filesize, or 0 if there is no appropriate filesize. */
 145     uint fileSize() const;
 146
 147     /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
 148      * it uses it as part of it's own composition. */
 149     bool referencesClip(DocClipBase * clip) const;
 150
 151     /** Sets the thumbnail to be used by this clip */
 152     void setThumbnail(const QPixmap & pixmap);
 153
 154     /** Returns the thumbnail producer used by this clip */
 155     KThumb *thumbProducer();
 156
 157     /** Returns the thumbnail used by this clip */
 158     const QPixmap & thumbnail() const;
 159
 160     static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
 161     /** Cache for every audio Frame with 10 Bytes */
 162     /** format is frame -> channel ->bytes */
 163     QMap<int, QMap<int, QByteArray> > audioFrameChache;
 164
 165     /** Free cache data */
 166     void slotClearAudioCache();
 167     void askForAudioThumbs();
 168     QString getClipHash() const;
 169     void refreshThumbUrl();
 170     const char *producerProperty(const char *name) const;
 171     void setProducerProperty(const char *name, const char *data);
 172     void deleteProducers();
 173
 174 private:   // Private attributes
 175     /** The name of this clip */
 176     QString m_name;
 177     /** A description of this clip */
 178     QString m_description;
 179     /** The number of times this clip is used in the project - the number of references to this clip
 180      * that exist. */
 181     uint m_refcount;
 182     QList <Mlt::Producer *> m_baseTrackProducers;
 183     CLIPTYPE m_clipType;
 184
 185     /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
 186     QList < CommentedTime > m_snapMarkers;
 187
 188     /** A thumbnail for this clip */
 189     QPixmap m_thumbnail;
 190     GenTime m_duration;
 191
 192     QTimer *m_audioTimer;
 193     KThumb *m_thumbProd;
 194     bool m_audioThumbCreated;
 195
 196     /** a unique numeric id */
 197     QString m_id;
 198     void setAudioThumbCreated(bool isDone);
 199     /** Holds clip infos like fps, size,... */
 200     QMap <QString, QString> m_properties;
 201     /** Holds clip metadata like author, copyright,... */
 202     QMap <QString, QString> m_metadata;
 203     /** Create connections for audio thumbnails */
 204     void slotCreateAudioTimer();
 205     void slotRefreshProducer();
 206     void setProducerProperty(const char *name, int data);
 207     void getFileHash(const QString &url);
 208
 209 public slots:
 210     void updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data);
 211     bool slotGetAudioThumbs();
 212     QList < CommentedTime > commentedSnapMarkers() const;
 213     void setSnapMarkers(QList < CommentedTime > markers);
 214     GenTime findNextSnapMarker(const GenTime & currTime);
 215     GenTime findPreviousSnapMarker(const GenTime & currTime);
 216     GenTime hasSnapMarkers(const GenTime & time);
 217     QString deleteSnapMarker(const GenTime & time);
 218     void editSnapMarker(const GenTime & time, QString comment);
 219     void addSnapMarker(const GenTime & time, QString comment);
 220     QList < GenTime > snapMarkers() const;
 221     QString markerComment(GenTime t);
 222     void setClipThumbFrame(const uint &ix);
 223     uint getClipThumbFrame() const;
 224     void setProperties(QMap <QString, QString> properties);
 225     void setMetadata(QMap <QString, QString> properties);
 226     QMap <QString, QString> properties() const;
 227     QMap <QString, QString> metadata() const;
 228
 229
 230 signals:
 231     void getAudioThumbs();
 232     void gotAudioData();
 233 };
 234
 235 #endif