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 #include <klocale.h>
  32
  33 #include "gentime.h"
  34 #include "definitions.h"
  35
  36 /*
  37 class DocTrackBase;
  38 class DocClipAVFile;
  39 class DocClipTextFile;
  40 class DocClipVirtual;
  41 class EffectDescriptionList;*/
  42 class KdenliveDoc;
  43 class KThumb;
  44 class ClipManager;
  45
  46 class CommentedTime {
  47 public:
  48     CommentedTime(): t(GenTime(0)) {}
  49     CommentedTime(const GenTime time, QString comment)
  50             : t(time), c(comment) { }
  51
  52     QString comment()   const          {
  53         return (c.isEmpty() ? i18n("Marker") : c);
  54     }
  55     GenTime time() const          {
  56         return t;
  57     }
  58     void    setComment(QString comm) {
  59         c = comm;
  60     }
  61 private:
  62     GenTime t;
  63     QString c;
  64 };
  65
  66
  67 class DocClipBase: public QObject {
  68 Q_OBJECT public:
  69     /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
  70      * - e.g. if you can have audio and video seperately, it should be possible to combin the two, as is
  71      *   done here. If a new clip type is added then it should be possible to combine it with both audio
  72      *   and video. */
  73
  74     DocClipBase(ClipManager *clipManager, QDomElement xml, uint id);
  75     DocClipBase(const DocClipBase& clip);
  76     DocClipBase & operator=(const DocClipBase & clip);
  77     virtual ~ DocClipBase();
  78
  79     /** sets the name of this clip. */
  80     void setName(const QString name);
  81
  82     /** returns the name of this clip. */
  83     const QString & name() const;
  84
  85     /** Sets the description for this clip. */
  86     void setDescription(const QString & descripton);
  87
  88     /** Returns the description of this clip. */
  89     const QString & description() const;
  90
  91     /** Returns the internal unique id of the clip. */
  92     uint getId() const;
  93     void setId(const uint &newId);
  94
  95     //KThumb *thumbCreator;
  96     bool audioThumbCreated() const;
  97
  98     /** returns the duration of this clip */
  99     const GenTime & duration() const;
 100     /** returns the duration of this clip */
 101     void setDuration(GenTime dur);
 102
 103     /** returns clip type (audio, text, image,...) */
 104     const CLIPTYPE & clipType() const;
 105     /** set clip type (audio, text, image,...) */
 106     void setClipType(CLIPTYPE type);
 107
 108     /** remove tmp file if the clip has one (for example text clips) */
 109     void removeTmpFile() const;
 110
 111     /** Returns a url to a file describing this clip. Exactly what this url is,
 112     whether it is temporary or not, and whether it provokes a render will
 113     depend entirely on what the clip consists of. */
 114     KUrl fileURL() const;
 115
 116     /** Returns true if the clip duration is known, false otherwise. */
 117     bool durationKnown() const;
 118     // Returns the number of frames per second that this clip should play at.
 119     double framesPerSecond() const;
 120
 121     bool isDocClipAVFile() const {
 122         return false;
 123     }
 124
 125     /*virtual DocClipAVFile *toDocClipAVFile() {
 126     return 0;
 127     }
 128
 129     virtual DocClipTextFile *toDocClipTextFile() {
 130         return 0;
 131     }
 132
 133     virtual bool isDocClipTextFile() const {
 134         return false;
 135     }
 136
 137     virtual bool isDocClipVirtual() const {
 138         return false;
 139     }
 140
 141     virtual DocClipVirtual *toDocClipVirtual() {
 142         return 0;
 143     }*/
 144
 145     /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
 146      * where it returns true. */
 147     bool isProjectClip() const {
 148         return false;
 149     }
 150     // Appends scene times for this clip to the passed vector.
 151     /* virtual void populateSceneTimes(QList < GenTime >
 152      &toPopulate) const = 0;*/
 153
 154     /** Reads in the element structure and creates a clip out of it.*/
 155     // Returns an XML document that describes part of the current scene.
 156     QDomDocument sceneToXML(const GenTime & startTime,
 157                             const GenTime & endTime) const;
 158     /** returns a QString containing all of the XML data required to recreate this clip. */
 159     QDomElement toXML() const;
 160     QDomDocument generateSceneList(bool addProducers = true, bool rendering = false) const;
 161
 162     /** Returns true if the xml passed matches the values in this clip */
 163     bool matchesXML(const QDomElement & element) const;
 164
 165     void addReference() {
 166         ++m_refcount;
 167     }
 168     void removeReference() {
 169         --m_refcount;
 170     }
 171     uint numReferences() const {
 172         return m_refcount;
 173     }
 174     /** Returns true if this clip has a meaningful filesize. */
 175     bool hasFileSize() const;
 176
 177     /** Returns the filesize, or 0 if there is no appropriate filesize. */
 178     uint fileSize() const;
 179
 180     /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
 181      * it uses it as part of it's own composition. */
 182     bool referencesClip(DocClipBase * clip) const;
 183
 184     /** Sets the thumbnail to be used by this clip */
 185     void setThumbnail(const QPixmap & pixmap);
 186
 187     /** Returns the thumbnail producer used by this clip */
 188     KThumb *thumbProducer();
 189
 190     /** Returns the thumbnail used by this clip */
 191     const QPixmap & thumbnail() const;
 192
 193     static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
 194     /** Cache for every audio Frame with 10 Bytes */
 195     /** format is frame -> channel ->bytes */
 196     QMap<int, QMap<int, QByteArray> > audioFrameChache;
 197
 198     /** return english name for clip type */
 199     static QString getTypeName(CLIPTYPE type);
 200
 201     /** Clip is ready to get thumbs */
 202     void slotRequestAudioThumbs();
 203     /** Free cache data */
 204     void slotClearAudioCache();
 205     /** puts the clip in a group (used for folder grouping) */
 206     void setGroup(const QString name, const QString id);
 207
 208
 209 private:   // Private attributes
 210     /** The name of this clip */
 211     QString m_name;
 212     /** A description of this clip */
 213     QString m_description;
 214     /** The number of times this clip is used in the project - the number of references to this clip
 215      * that exist. */
 216     uint m_refcount;
 217
 218     CLIPTYPE m_clipType;
 219
 220     /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
 221     QList < CommentedTime > m_snapMarkers;
 222     QDomElement m_xml;
 223
 224     /** A thumbnail for this clip */
 225     QPixmap m_thumbnail;
 226     GenTime m_duration;
 227
 228     QTimer *m_audioTimer;
 229     KThumb *m_thumbProd;
 230     bool m_audioThumbCreated;
 231
 232     /** a unique numeric id */
 233     uint m_id;
 234     uint m_projectThumbFrame;
 235     void setAudioThumbCreated(bool isDone);
 236
 237 public slots:
 238     void updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data);
 239     void slotGetAudioThumbs();
 240     QList < CommentedTime > commentedSnapMarkers() const;
 241     void setSnapMarkers(QList < CommentedTime > markers);
 242     GenTime findNextSnapMarker(const GenTime & currTime);
 243     GenTime findPreviousSnapMarker(const GenTime & currTime);
 244     GenTime hasSnapMarkers(const GenTime & time);
 245     QString deleteSnapMarker(const GenTime & time);
 246     void editSnapMarker(const GenTime & time, QString comment);
 247     void addSnapMarker(const GenTime & time, QString comment);
 248     QList < GenTime > snapMarkers() const;
 249     QString markerComment(GenTime t);
 250     void setProjectThumbFrame(const uint &ix);
 251     uint getProjectThumbFrame() const;
 252
 253 signals:
 254     void getAudioThumbs();
 255     void gotAudioData();
 256 };
 257
 258 #endif