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, uint 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
  70     /** Returns any property of this clip. */
  71     const QString getProperty(const QString prop) const;
  72     void setProperty(QString key, QString value);
  73
  74     /** Returns the internal unique id of the clip. */
  75     uint getId() const;
  76     void setId(const uint &newId);
  77
  78     //KThumb *thumbCreator;
  79     bool audioThumbCreated() const;
  80
  81     /** returns the duration of this clip */
  82     const GenTime & duration() const;
  83     const GenTime &maxDuration() const;
  84     /** returns the duration of this clip */
  85     void setDuration(GenTime dur);
  86
  87     /** returns clip type (audio, text, image,...) */
  88     const CLIPTYPE & clipType() const;
  89     /** set clip type (audio, text, image,...) */
  90     void setClipType(CLIPTYPE type);
  91
  92     /** remove tmp file if the clip has one (for example text clips) */
  93     void removeTmpFile() const;
  94
  95     /** Returns a url to a file describing this clip. Exactly what this url is,
  96     whether it is temporary or not, and whether it provokes a render will
  97     depend entirely on what the clip consists of. */
  98     KUrl fileURL() const;
  99
 100     /** Returns true if the clip duration is known, false otherwise. */
 101     bool durationKnown() const;
 102     // Returns the number of frames per second that this clip should play at.
 103     double framesPerSecond() const;
 104
 105     bool isDocClipAVFile() const {
 106         return false;
 107     }
 108
 109     void setProducer(Mlt::Producer *producer);
 110     Mlt::Producer *producer();
 111
 112     /*virtual DocClipAVFile *toDocClipAVFile() {
 113     return 0;
 114     }
 115
 116     virtual DocClipTextFile *toDocClipTextFile() {
 117         return 0;
 118     }
 119
 120     virtual bool isDocClipTextFile() const {
 121         return false;
 122     }
 123
 124     virtual bool isDocClipVirtual() const {
 125         return false;
 126     }
 127
 128     virtual DocClipVirtual *toDocClipVirtual() {
 129         return 0;
 130     }*/
 131
 132     /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
 133      * where it returns true. */
 134     bool isProjectClip() const {
 135         return false;
 136     }
 137     // Appends scene times for this clip to the passed vector.
 138     /* virtual void populateSceneTimes(QList < GenTime >
 139      &toPopulate) const = 0;*/
 140
 141     /** Reads in the element structure and creates a clip out of it.*/
 142     // Returns an XML document that describes part of the current scene.
 143     QDomDocument sceneToXML(const GenTime & startTime,
 144                             const GenTime & endTime) const;
 145     /** returns a QString containing all of the XML data required to recreate this clip. */
 146     QDomElement toXML() const;
 147
 148     /** Returns true if the xml passed matches the values in this clip */
 149     bool matchesXML(const QDomElement & element) const;
 150
 151     void addReference() {
 152         ++m_refcount;
 153     }
 154     void removeReference() {
 155         --m_refcount;
 156     }
 157     uint numReferences() const {
 158         return m_refcount;
 159     }
 160     /** Returns true if this clip has a meaningful filesize. */
 161     bool hasFileSize() const;
 162
 163     /** Returns the filesize, or 0 if there is no appropriate filesize. */
 164     uint fileSize() const;
 165
 166     /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
 167      * it uses it as part of it's own composition. */
 168     bool referencesClip(DocClipBase * clip) const;
 169
 170     /** Sets the thumbnail to be used by this clip */
 171     void setThumbnail(const QPixmap & pixmap);
 172
 173     /** Returns the thumbnail producer used by this clip */
 174     KThumb *thumbProducer();
 175
 176     /** Returns the thumbnail used by this clip */
 177     const QPixmap & thumbnail() const;
 178
 179     static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
 180     /** Cache for every audio Frame with 10 Bytes */
 181     /** format is frame -> channel ->bytes */
 182     QMap<int, QMap<int, QByteArray> > audioFrameChache;
 183
 184     /** Clip is ready to get thumbs */
 185     void slotRequestAudioThumbs();
 186     /** Free cache data */
 187     void slotClearAudioCache();
 188
 189 private:   // Private attributes
 190     /** The name of this clip */
 191     QString m_name;
 192     /** A description of this clip */
 193     QString m_description;
 194     /** The number of times this clip is used in the project - the number of references to this clip
 195      * that exist. */
 196     uint m_refcount;
 197     Mlt::Producer *m_clipProducer;
 198     CLIPTYPE m_clipType;
 199
 200     /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
 201     QList < CommentedTime > m_snapMarkers;
 202
 203     /** A thumbnail for this clip */
 204     QPixmap m_thumbnail;
 205     GenTime m_duration;
 206
 207     QTimer *m_audioTimer;
 208     KThumb *m_thumbProd;
 209     bool m_audioThumbCreated;
 210
 211     /** a unique numeric id */
 212     uint m_id;
 213     void setAudioThumbCreated(bool isDone);
 214     /** Holds clip infos like fps, size,... */
 215     QMap <QString, QString> m_properties;
 216     /** Create connections for audio thumbnails */
 217     void slotCreateAudioTimer();
 218     void slotRefreshProducer();
 219
 220 public slots:
 221     void updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data);
 222     void slotGetAudioThumbs();
 223     QList < CommentedTime > commentedSnapMarkers() const;
 224     void setSnapMarkers(QList < CommentedTime > markers);
 225     GenTime findNextSnapMarker(const GenTime & currTime);
 226     GenTime findPreviousSnapMarker(const GenTime & currTime);
 227     GenTime hasSnapMarkers(const GenTime & time);
 228     QString deleteSnapMarker(const GenTime & time);
 229     void editSnapMarker(const GenTime & time, QString comment);
 230     void addSnapMarker(const GenTime & time, QString comment);
 231     QList < GenTime > snapMarkers() const;
 232     QString markerComment(GenTime t);
 233     void setClipThumbFrame(const uint &ix);
 234     uint getClipThumbFrame() const;
 235     void setProperties(QMap <QString, QString> properties);
 236     QMap <QString, QString> properties() const;
 237
 238 signals:
 239     void getAudioThumbs();
 240     void gotAudioData();
 241 };
 242
 243 #endif