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
35 #include "definitions.h"
40 class DocClipTextFile;
42 class EffectDescriptionList;*/
58 class DocClipBase: public QObject
61 /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
62 * - e.g. if you can have audio and video separately, it should be possible to combin the two, as is
63 * done here. If a new clip type is added then it should be possible to combine it with both audio
66 DocClipBase(ClipManager *clipManager, QDomElement xml, const QString &id);
67 // DocClipBase & operator=(const DocClipBase & clip);
68 virtual ~ DocClipBase();
70 /** returns the name of this clip. */
71 const QString name() const;
73 /** Returns the description of this clip. */
74 const QString description() const;
75 /** Does this clip need a transparent background (e.g. for titles). */
76 bool isTransparent() const;
78 /** Returns any property of this clip. */
79 const QString getProperty(const QString &prop) const;
80 void setProperty(const QString &key, const QString &value);
81 void clearProperty(const QString &key);
83 /** Returns the internal unique id of the clip. */
84 const QString &getId() const;
85 void setId(const QString &newId);
87 //KThumb *thumbCreator;
88 bool audioThumbCreated() const;
89 /*void getClipMainThumb();*/
91 /** returns the duration of this clip */
92 const GenTime & duration() const;
93 const GenTime maxDuration() const;
94 /** returns the duration of this clip */
95 void setDuration(GenTime dur);
97 /** returns clip type (audio, text, image,...) */
98 const CLIPTYPE & clipType() const;
99 /** set clip type (audio, text, image,...) */
100 void setClipType(CLIPTYPE type);
102 /** remove tmp file if the clip has one (for example text clips) */
103 void removeTmpFile() const;
105 /** Returns a url to a file describing this clip. Exactly what this url is,
106 whether it is temporary or not, and whether it provokes a render will
107 depend entirely on what the clip consists of. */
108 KUrl fileURL() const;
110 /** Returns true if the clip duration is known, false otherwise. */
111 bool durationKnown() const;
112 // Returns the number of frames per second that this clip should play at.
113 double framesPerSecond() const;
115 bool isDocClipAVFile() const {
119 /** Sets producers for the current clip (one for each track due to a limitation in MLT's track mixing */
120 void setProducer(Mlt::Producer *producer, bool reset = false, bool readPropertiesFromProducer = false);
121 /** Retrieve a producer for a track */
122 Mlt::Producer *producer(int track = -1);
123 /** Retrieve the producer that shows only video */
124 Mlt::Producer *videoProducer();
125 /** Retrieve the producer that shows only audio */
126 Mlt::Producer *audioProducer(int track);
128 /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
129 * where it returns true. */
130 bool isProjectClip() const {
134 /** Reads in the element structure and creates a clip out of it.*/
135 // Returns an XML document that describes part of the current scene.
136 QDomDocument sceneToXML(const GenTime & startTime,
137 const GenTime & endTime) const;
138 /** returns a QString containing all of the XML data required to recreate this clip. */
139 QDomElement toXML() const;
141 /** Returns true if the xml passed matches the values in this clip */
142 bool matchesXML(const QDomElement & element) const;
144 void addReference() {
147 void removeReference() {
150 uint numReferences() const {
153 /** Returns true if this clip has a meaningful filesize. */
154 bool hasFileSize() const;
156 /** Returns the filesize, or 0 if there is no appropriate filesize. */
157 qulonglong fileSize() const;
159 /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
160 * it uses it as part of it's own composition. */
161 bool referencesClip(DocClipBase * clip) const;
163 /** Sets the thumbnail to be used by this clip */
164 void setThumbnail(const QPixmap & pixmap);
166 /** Returns the thumbnail producer used by this clip */
167 KThumb *thumbProducer();
169 /** Returns the thumbnail used by this clip */
170 const QPixmap & thumbnail() const;
172 /** Cache for every audio Frame with 10 Bytes */
173 /** format is frame -> channel ->bytes */
174 QMap<int, QMap<int, QByteArray> > m_audioFrameCache;
176 /** Free cache data */
177 void slotClearAudioCache();
178 void askForAudioThumbs();
179 QString getClipHash() const;
180 void refreshThumbUrl();
181 const char *producerProperty(const char *name) const;
182 void setProducerProperty(const char *name, const char *data);
183 void resetProducerProperty(const char *name);
184 void deleteProducers(bool clearThumbCreator = true);
186 /** Set default play zone for clip monitor */
187 void setZone(QPoint zone);
188 /** Get default play zone for clip monitor */
191 /** Returns true is clip is missing but user wants to keep it as placeholder */
192 bool isPlaceHolder() const;
194 static QString getHash(const QString &path);
196 void addCutZone(int in, int out, QString desc = QString());
197 bool hasCutZone(QPoint p) const;
198 void removeCutZone(int in, int out);
199 QList <CutZoneInfo> cutZones() const;
200 void updateCutZone(int oldin, int oldout, int in, int out, QString desc = QString());
202 bool hasVideoCodec(const QString &codec) const;
203 bool hasAudioCodec(const QString &codec) const;
204 bool checkHash() const;
205 void setPlaceHolder(bool place);
206 QPixmap extractImage(int frame, int width, int height);
208 private: // Private attributes
210 /** The number of times this clip is used in the project - the number of references to this clip
213 QList <Mlt::Producer *> m_baseTrackProducers;
214 QList <Mlt::Producer *> m_audioTrackProducers;
215 Mlt::Producer *m_videoOnlyProducer;
218 /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
219 QList < CommentedTime > m_snapMarkers;
221 /** A thumbnail for this clip */
225 QTimer *m_audioTimer;
227 bool m_audioThumbCreated;
229 /** a unique numeric id */
232 /** Wheter the clip is a placeholder (clip missing but user wants to see it) */
235 QList <CutZoneInfo> m_cutZones;
237 void setAudioThumbCreated(bool isDone);
238 /** Holds clip infos like fps, size,... */
239 QMap <QString, QString> m_properties;
240 /** Holds clip metadata like author, copyright,... */
241 QMap <QString, QString> m_metadata;
243 /** Try to make sure we don't delete a producer while using it */
244 QMutex m_producerMutex;
246 /** Create connections for audio thumbnails */
247 void slotCreateAudioTimer();
248 void slotRefreshProducer();
249 void setProducerProperty(const char *name, int data);
250 void setProducerProperty(const char *name, double data);
251 void getFileHash(const QString &url);
252 /** @brief When duplicating a producer, make sure all manually set properties are passed to it. */
253 void adjustProducerProperties(Mlt::Producer *prod, const QString &id, bool mute, bool blind);
254 /** @brief Create another instance of a producer. */
255 Mlt::Producer *cloneProducer(Mlt::Producer *source);
259 void updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data);
260 bool slotGetAudioThumbs();
261 QList < CommentedTime > commentedSnapMarkers() const;
262 GenTime findNextSnapMarker(const GenTime & currTime);
263 GenTime findPreviousSnapMarker(const GenTime & currTime);
264 GenTime hasSnapMarkers(const GenTime & time);
265 QString deleteSnapMarker(const GenTime & time);
266 void editSnapMarker(const GenTime & time, QString comment);
267 void addSnapMarker(const GenTime & time, QString comment);
268 QList < GenTime > snapMarkers() const;
269 QString markerComment(GenTime t);
270 void setClipThumbFrame(const uint &ix);
271 uint getClipThumbFrame() const;
272 void setProperties(QMap <QString, QString> properties);
273 void setMetadata(QMap <QString, QString> properties);
274 QMap <QString, QString> properties() const;
275 QMap <QString, QString> metadata() const;
276 void slotExtractImage(int frame, int frame2);
280 /** @brief Generate a proxy clip (lower resolution copy) named like the clip's hash. */
281 void createProxy(const QString &id);
282 /** @brief Abort creation of the proxy clip (lower resolution copy). */
283 void abortProxy(const QString &id, const QString &proxyPath);