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"
39 class DocClipTextFile;
41 class EffectDescriptionList;*/
47 CommentedTime(): t(GenTime(0)) {}
48 CommentedTime( const GenTime time, QString comment)
49 : t( time ), c( comment )
52 QString comment() const { return (c.isEmpty() ? i18n("Marker") : c);}
53 GenTime time() const { return t; }
54 void setComment( QString comm) { c = comm; }
61 class DocClipBase:public QObject {
63 /** this enum determines the types of "feed" available within this clip. types must be non-exclusive
64 * - e.g. if you can have audio and video seperately, it should be possible to combin the two, as is
65 * done here. If a new clip type is added then it should be possible to combine it with both audio
68 DocClipBase(QDomElement xml, uint id);
69 DocClipBase(const DocClipBase& clip);
70 DocClipBase & operator=(const DocClipBase & clip);
71 virtual ~ DocClipBase();
73 /** sets the name of this clip. */
74 void setName(const QString name);
76 /** returns the name of this clip. */
77 const QString & name() const;
79 /** Sets the description for this clip. */
80 void setDescription(const QString & descripton);
82 /** Returns the description of this clip. */
83 const QString & description() const;
85 /** Returns the internal unique id of the clip. */
87 void setId( const uint &newId);
89 //KThumb *thumbCreator;
90 bool audioThumbCreated;
92 /** returns the duration of this clip */
93 const GenTime & duration() 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 const 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 /*virtual DocClipAVFile *toDocClipAVFile() {
123 virtual DocClipTextFile *toDocClipTextFile() {
127 virtual bool isDocClipTextFile() const {
131 virtual bool isDocClipVirtual() const {
135 virtual DocClipVirtual *toDocClipVirtual() {
139 /** Returns true if this clip is a project clip, false otherwise. Overridden in DocClipProject,
140 * where it returns true. */
141 bool isProjectClip() const {
144 // Appends scene times for this clip to the passed vector.
145 /* virtual void populateSceneTimes(QList < GenTime >
146 &toPopulate) const = 0;*/
148 /** Reads in the element structure and creates a clip out of it.*/
149 // Returns an XML document that describes part of the current scene.
150 QDomDocument sceneToXML(const GenTime & startTime,
151 const GenTime & endTime) const;
152 /** returns a QString containing all of the XML data required to recreate this clip. */
153 QDomElement toXML() const;
154 QDomDocument generateSceneList(bool addProducers = true, bool rendering = false) const;
156 /** Returns true if the xml passed matches the values in this clip */
157 bool matchesXML(const QDomElement & element) const;
159 void addReference() {
162 void removeReference() {
165 uint numReferences() const {
168 /** Returns true if this clip has a meaningful filesize. */
169 bool hasFileSize() const;
171 /** Returns the filesize, or 0 if there is no appropriate filesize. */
172 uint fileSize() const;
174 /** Returns true if this clip refers to the clip passed in. A clip refers to another clip if
175 * it uses it as part of it's own composition. */
176 bool referencesClip(DocClipBase * clip) const;
178 /** Sets the thumbnail to be used by this clip */
179 void setThumbnail(const QPixmap & pixmap);
181 /** Returns the thumbnail producer used by this clip */
182 KThumb *thumbProducer();
184 /** Returns the thumbnail used by this clip */
185 const QPixmap & thumbnail() const;
187 static DocClipBase *createClip(KdenliveDoc *doc, const QDomElement & element);
188 /** Cache for every audio Frame with 10 Bytes */
189 /** format is frame -> channel ->bytes */
190 QMap<int,QMap<int,QByteArray> > audioFrameChache;
192 /** return english name for clip type */
193 static QString getTypeName(CLIPTYPE type);
195 private: // Private attributes
196 /** The name of this clip */
198 /** A description of this clip */
199 QString m_description;
200 /** The number of times this clip is used in the project - the number of references to this clip
206 /** A list of snap markers; these markers are added to a clips snap-to points, and are displayed as necessary. */
207 QList < CommentedTime > m_snapMarkers;
210 /** A thumbnail for this clip */
216 /** a unique numeric id */
218 uint m_projectThumbFrame;
219 void setAudioThumbCreated(bool isDone);
222 void updateAudioThumbnail(QMap<int,QMap<int,QByteArray> > data);
223 QList < CommentedTime > commentedSnapMarkers() const;
224 void setSnapMarkers(QList < CommentedTime > markers);
225 GenTime findNextSnapMarker(const GenTime & currTime);
226 GenTime findPreviousSnapMarker(const GenTime & currTime);
227 GenTime hasSnapMarkers(const GenTime & time);
228 QString deleteSnapMarker(const GenTime & time);
229 void editSnapMarker(const GenTime & time, QString comment);
230 void addSnapMarker(const GenTime & time, QString comment);
231 QList < GenTime > snapMarkers() const;
232 QString markerComment(GenTime t);
233 void setProjectThumbFrame( const uint &ix);
234 uint getProjectThumbFrame() const;