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