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
34 #include "clipmanager.h"
35 #include "definitions.h"
41 class DocClipTextFile;
43 class EffectDescriptionList;*/
48 CommentedTime(): t(GenTime(0)) {}
49 CommentedTime(const GenTime time, QString comment)
50 : t(time), c(comment) { }
52 QString comment() const {
53 return (c.isEmpty() ? i18n("Marker") : c);
55 GenTime time() const {
58 void setComment(QString comm) {
67 class DocClipBase: public QObject {
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
74 DocClipBase(ClipManager *clipManager, QDomElement xml, uint id);
75 DocClipBase(const DocClipBase& clip);
76 DocClipBase & operator=(const DocClipBase & clip);
77 virtual ~ DocClipBase();
79 /** sets the name of this clip. */
80 void setName(const QString name);
82 /** returns the name of this clip. */
83 const QString & name() const;
85 /** Sets the description for this clip. */
86 void setDescription(const QString & descripton);
88 /** Returns the description of this clip. */
89 const QString & description() const;
91 /** Returns the internal unique id of the clip. */
93 void setId(const uint &newId);
95 //KThumb *thumbCreator;
96 bool audioThumbCreated() const;
98 /** returns the duration of this clip */
99 const GenTime & duration() const;
100 /** returns the duration of this clip */
101 void setDuration(GenTime dur);
103 /** returns clip type (audio, text, image,...) */
104 const CLIPTYPE & clipType() const;
105 /** set clip type (audio, text, image,...) */
106 void setClipType(CLIPTYPE type);
108 /** remove tmp file if the clip has one (for example text clips) */
109 void removeTmpFile() const;
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;
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;
121 bool isDocClipAVFile() const {
125 /*virtual DocClipAVFile *toDocClipAVFile() {
129 virtual DocClipTextFile *toDocClipTextFile() {
133 virtual bool isDocClipTextFile() const {
137 virtual bool isDocClipVirtual() const {
141 virtual DocClipVirtual *toDocClipVirtual() {
145 /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
146 * where it returns true. */
147 bool isProjectClip() const {
150 // Appends scene times for this clip to the passed vector.
151 /* virtual void populateSceneTimes(QList < GenTime >
152 &toPopulate) const = 0;*/
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;
162 /** Returns true if the xml passed matches the values in this clip */
163 bool matchesXML(const QDomElement & element) const;
165 void addReference() {
168 void removeReference() {
171 uint numReferences() const {
174 /** Returns true if this clip has a meaningful filesize. */
175 bool hasFileSize() const;
177 /** Returns the filesize, or 0 if there is no appropriate filesize. */
178 uint fileSize() const;
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;
184 /** Sets the thumbnail to be used by this clip */
185 void setThumbnail(const QPixmap & pixmap);
187 /** Returns the thumbnail producer used by this clip */
188 KThumb *thumbProducer();
190 /** Returns the thumbnail used by this clip */
191 const QPixmap & thumbnail() const;
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;
198 /** return english name for clip type */
199 static QString getTypeName(CLIPTYPE type);
201 /** Clip is ready to get thumbs */
202 void slotRequestAudioThumbs();
203 /** Free cache data */
204 void slotClearAudioCache();
207 private: // Private attributes
208 /** The name of this clip */
210 /** A description of this clip */
211 QString m_description;
212 /** The number of times this clip is used in the project - the number of references to this clip
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;
222 /** A thumbnail for this clip */
226 QTimer *m_audioTimer;
228 bool m_audioThumbCreated;
230 /** a unique numeric id */
232 uint m_projectThumbFrame;
233 void setAudioThumbCreated(bool isDone);
236 void updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data);
237 void slotGetAudioThumbs();
238 QList < CommentedTime > commentedSnapMarkers() const;
239 void setSnapMarkers(QList < CommentedTime > markers);
240 GenTime findNextSnapMarker(const GenTime & currTime);
241 GenTime findPreviousSnapMarker(const GenTime & currTime);
242 GenTime hasSnapMarkers(const GenTime & time);
243 QString deleteSnapMarker(const GenTime & time);
244 void editSnapMarker(const GenTime & time, QString comment);
245 void addSnapMarker(const GenTime & time, QString comment);
246 QList < GenTime > snapMarkers() const;
247 QString markerComment(GenTime t);
248 void setProjectThumbFrame(const uint &ix);
249 uint getProjectThumbFrame() const;
252 void getAudioThumbs();