1 /***************************************************************************
2 docclipbase.h - description
4 begin : Fri Apr 12 2002
5 copyright : (C) 2002 by Jason Wood
6 email : jasonwood@blueyonder.co.uk
7 ***************************************************************************/
9 /***************************************************************************
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. *
16 ***************************************************************************/
21 /**DocClip is a class for the various types of clip
33 #include "definitions.h"
38 class DocClipTextFile;
40 class EffectDescriptionList;*/
50 class DocClipBase: public QObject {
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
57 DocClipBase(ClipManager *clipManager, QDomElement xml, const QString &id);
58 // DocClipBase & operator=(const DocClipBase & clip);
59 virtual ~ DocClipBase();
61 /** returns the name of this clip. */
62 const QString & name() const;
64 /** Returns the description of this clip. */
65 const QString description() const;
66 /** Does this clip need a transparent background (e.g. for titles). */
67 bool isTransparent() const;
69 /** Returns any property of this clip. */
70 const QString getProperty(const QString prop) const;
71 void setProperty(const QString &key, const QString &value);
72 void clearProperty(const QString &key);
74 /** Returns the internal unique id of the clip. */
75 const QString &getId() const;
76 void setId(const QString &newId);
78 //KThumb *thumbCreator;
79 bool audioThumbCreated() const;
80 /*void getClipMainThumb();*/
82 /** returns the duration of this clip */
83 const GenTime & duration() const;
84 const GenTime &maxDuration() const;
85 /** returns the duration of this clip */
86 void setDuration(GenTime dur);
88 /** returns clip type (audio, text, image,...) */
89 const CLIPTYPE & clipType() const;
90 /** set clip type (audio, text, image,...) */
91 void setClipType(CLIPTYPE type);
93 /** remove tmp file if the clip has one (for example text clips) */
94 void removeTmpFile() const;
96 /** Returns a url to a file describing this clip. Exactly what this url is,
97 whether it is temporary or not, and whether it provokes a render will
98 depend entirely on what the clip consists of. */
101 /** Returns true if the clip duration is known, false otherwise. */
102 bool durationKnown() const;
103 // Returns the number of frames per second that this clip should play at.
104 double framesPerSecond() const;
106 bool isDocClipAVFile() const {
110 void setProducer(Mlt::Producer *producer);
111 Mlt::Producer *producer(int track = -1);
113 /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
114 * where it returns true. */
115 bool isProjectClip() const {
119 /** Reads in the element structure and creates a clip out of it.*/
120 // Returns an XML document that describes part of the current scene.
121 QDomDocument sceneToXML(const GenTime & startTime,
122 const GenTime & endTime) const;
123 /** returns a QString containing all of the XML data required to recreate this clip. */
124 QDomElement toXML() const;
126 /** Returns true if the xml passed matches the values in this clip */
127 bool matchesXML(const QDomElement & element) const;
129 void addReference() {
132 void removeReference() {
135 uint numReferences() const {
138 /** Returns true if this clip has a meaningful filesize. */
139 bool hasFileSize() const;
141 /** Returns the filesize, or 0 if there is no appropriate filesize. */
142 uint fileSize() const;
144 /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
145 * it uses it as part of it's own composition. */
146 bool referencesClip(DocClipBase * clip) const;
148 /** Sets the thumbnail to be used by this clip */
149 void setThumbnail(const QPixmap & pixmap);
151 /** Returns the thumbnail producer used by this clip */
152 KThumb *thumbProducer();
154 /** Returns the thumbnail used by this clip */
155 const QPixmap & thumbnail() const;
157 static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
158 /** Cache for every audio Frame with 10 Bytes */
159 /** format is frame -> channel ->bytes */
160 QMap<int, QMap<int, QByteArray> > audioFrameChache;
162 /** Free cache data */
163 void slotClearAudioCache();
164 void askForAudioThumbs();
165 QString getClipHash() const;
166 void refreshThumbUrl();
167 const char *producerProperty(const char *name) const;
168 void setProducerProperty(const char *name, const char *data);
169 void deleteProducers();
171 /** Set default play zone for clip monitor */
172 void setZone(QPoint zone);
173 /** Get default play zone for clip monitor */
176 private: // Private attributes
178 /** A description of this clip */
179 QString m_description;
180 /** The number of times this clip is used in the project - the number of references to this clip
183 QList <Mlt::Producer *> m_baseTrackProducers;
186 /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
187 QList < CommentedTime > m_snapMarkers;
189 /** A thumbnail for this clip */
193 QTimer *m_audioTimer;
195 bool m_audioThumbCreated;
197 /** a unique numeric id */
199 void setAudioThumbCreated(bool isDone);
200 /** Holds clip infos like fps, size,... */
201 QMap <QString, QString> m_properties;
202 /** Holds clip metadata like author, copyright,... */
203 QMap <QString, QString> m_metadata;
204 /** Create connections for audio thumbnails */
205 void slotCreateAudioTimer();
206 void slotRefreshProducer();
207 void setProducerProperty(const char *name, int data);
208 void getFileHash(const QString &url);
211 void updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data);
212 bool slotGetAudioThumbs();
213 QList < CommentedTime > commentedSnapMarkers() const;
214 void setSnapMarkers(QList < CommentedTime > markers);
215 GenTime findNextSnapMarker(const GenTime & currTime);
216 GenTime findPreviousSnapMarker(const GenTime & currTime);
217 GenTime hasSnapMarkers(const GenTime & time);
218 QString deleteSnapMarker(const GenTime & time);
219 void editSnapMarker(const GenTime & time, QString comment);
220 void addSnapMarker(const GenTime & time, QString comment);
221 QList < GenTime > snapMarkers() const;
222 QString markerComment(GenTime t);
223 void setClipThumbFrame(const uint &ix);
224 uint getClipThumbFrame() const;
225 void setProperties(QMap <QString, QString> properties);
226 void setMetadata(QMap <QString, QString> properties);
227 QMap <QString, QString> properties() const;
228 QMap <QString, QString> metadata() const;
232 void getAudioThumbs();