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 "definitions.h"
40 class DocClipTextFile;
42 class EffectDescriptionList;*/
48 CommentedTime(): t(GenTime(0)) {}
49 CommentedTime( const GenTime time, QString comment)
50 : t( time ), c( comment )
53 QString comment() const { return (c.isEmpty() ? i18n("Marker") : c);}
54 GenTime time() const { return t; }
55 void setComment( QString comm) { c = comm; }
62 class DocClipBase:public QObject {
64 /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
65 * - e.g. if you can have audio and video seperately, it should be possible to combin the two, as is
66 * done here. If a new clip type is added then it should be possible to combine it with both audio
69 DocClipBase(QDomElement xml, uint id);
70 DocClipBase(const DocClipBase& clip);
71 DocClipBase & operator=(const DocClipBase & clip);
72 virtual ~ DocClipBase();
74 /** sets the name of this clip. */
75 void setName(const QString name);
77 /** returns the name of this clip. */
78 const QString & name() const;
80 /** Sets the description for this clip. */
81 void setDescription(const QString & descripton);
83 /** Returns the description of this clip. */
84 const QString & description() const;
86 /** Returns the internal unique id of the clip. */
88 void setId( const uint &newId);
90 //KThumb *thumbCreator;
91 bool audioThumbCreated() const;
93 /** returns the duration of this clip */
94 const GenTime & duration() const;
95 /** returns the duration of this clip */
96 void setDuration(GenTime dur);
98 /** returns clip type (audio, text, image,...) */
99 const CLIPTYPE & clipType() const;
100 /** set clip type (audio, text, image,...) */
101 void setClipType(CLIPTYPE type);
103 /** remove tmp file if the clip has one (for example text clips) */
104 void removeTmpFile() const;
106 /** Returns a url to a file describing this clip. Exactly what this url is,
107 whether it is temporary or not, and whether it provokes a render will
108 depend entirely on what the clip consists of. */
109 KUrl fileURL() const;
111 /** Returns true if the clip duration is known, false otherwise. */
112 bool durationKnown() const;
113 // Returns the number of frames per second that this clip should play at.
114 double framesPerSecond() const;
116 bool isDocClipAVFile() const {
120 /*virtual DocClipAVFile *toDocClipAVFile() {
124 virtual DocClipTextFile *toDocClipTextFile() {
128 virtual bool isDocClipTextFile() const {
132 virtual bool isDocClipVirtual() const {
136 virtual DocClipVirtual *toDocClipVirtual() {
140 /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
141 * where it returns true. */
142 bool isProjectClip() const {
145 // Appends scene times for this clip to the passed vector.
146 /* virtual void populateSceneTimes(QList < GenTime >
147 &toPopulate) const = 0;*/
149 /** Reads in the element structure and creates a clip out of it.*/
150 // Returns an XML document that describes part of the current scene.
151 QDomDocument sceneToXML(const GenTime & startTime,
152 const GenTime & endTime) const;
153 /** returns a QString containing all of the XML data required to recreate this clip. */
154 QDomElement toXML() const;
155 QDomDocument generateSceneList(bool addProducers = true, bool rendering = false) const;
157 /** Returns true if the xml passed matches the values in this clip */
158 bool matchesXML(const QDomElement & element) const;
160 void addReference() {
163 void removeReference() {
166 uint numReferences() const {
169 /** Returns true if this clip has a meaningful filesize. */
170 bool hasFileSize() const;
172 /** Returns the filesize, or 0 if there is no appropriate filesize. */
173 uint fileSize() const;
175 /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
176 * it uses it as part of it's own composition. */
177 bool referencesClip(DocClipBase * clip) const;
179 /** Sets the thumbnail to be used by this clip */
180 void setThumbnail(const QPixmap & pixmap);
182 /** Returns the thumbnail producer used by this clip */
183 KThumb *thumbProducer();
185 /** Returns the thumbnail used by this clip */
186 const QPixmap & thumbnail() const;
188 static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
189 /** Cache for every audio Frame with 10 Bytes */
190 /** format is frame -> channel ->bytes */
191 QMap<int,QMap<int,QByteArray> > audioFrameChache;
193 /** return english name for clip type */
194 static QString getTypeName(CLIPTYPE type);
196 private: // Private attributes
197 /** The name of this clip */
199 /** A description of this clip */
200 QString m_description;
201 /** The number of times this clip is used in the project - the number of references to this clip
207 /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
208 QList < CommentedTime > m_snapMarkers;
211 /** A thumbnail for this clip */
215 QTimer *m_audioTimer;
217 bool m_audioThumbCreated;
219 /** a unique numeric id */
221 uint m_projectThumbFrame;
222 void setAudioThumbCreated(bool isDone);
225 void updateAudioThumbnail(QMap<int,QMap<int,QByteArray> > data);
226 void slotGetAudioThumbs();
227 QList < CommentedTime > commentedSnapMarkers() const;
228 void setSnapMarkers(QList < CommentedTime > markers);
229 GenTime findNextSnapMarker(const GenTime & currTime);
230 GenTime findPreviousSnapMarker(const GenTime & currTime);
231 GenTime hasSnapMarkers(const GenTime & time);
232 QString deleteSnapMarker(const GenTime & time);
233 void editSnapMarker(const GenTime & time, QString comment);
234 void addSnapMarker(const GenTime & time, QString comment);
235 QList < GenTime > snapMarkers() const;
236 QString markerComment(GenTime t);
237 void setProjectThumbFrame( const uint &ix);
238 uint getProjectThumbFrame() const;
240 void getAudioThumbs();