]> git.sesse.net Git - kdenlive/blob - src/docclipbase.cpp
*Re-introduce slideshow clips
[kdenlive] / src / docclipbase.cpp
1 /**************************1*************************************************
2                           DocClipBase.cpp  -  description
3                              -------------------
4     begin                : Fri Apr 12 2002
5     copyright            : (C) 2002 by Jason Wood
6     email                : jasonwood@blueyonder.co.uk
7  ***************************************************************************/
8
9 /***************************************************************************
10  *                                                                         *
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.                                   *
15  *                                                                         *
16  ***************************************************************************/
17
18 #include <KDebug>
19
20 #include "kdenlivesettings.h"
21 #include "docclipbase.h"
22 #include "kthumb.h"
23 #include "clipmanager.h"
24
25 DocClipBase::DocClipBase(ClipManager *clipManager, QDomElement xml, uint id):
26         m_id(id), m_description(QString()), m_refcount(0), m_projectThumbFrame(0), m_audioThumbCreated(false), m_duration(GenTime()), m_thumbProd(NULL), m_audioTimer(NULL) {
27     int type = xml.attribute("type").toInt();
28     m_clipType = (CLIPTYPE) type;
29     m_name = xml.attribute("name");
30     m_id = id;
31
32     QDomNamedNodeMap attributes = xml.attributes();
33     for (unsigned int i = 0; i < attributes.count(); i++) {
34         m_properties.insert(attributes.item(i).nodeName(), attributes.item(i).nodeValue());
35     }
36
37     KUrl url = KUrl(xml.attribute("resource"));
38     int out = xml.attribute("out").toInt();
39     if (out != 0) {
40         setDuration(GenTime(out, 25));
41         //m_properties.insert("out", QString::number(out));
42     }
43     if (m_name.isEmpty()) m_name = url.fileName();
44
45     if (!url.isEmpty()) {
46         m_thumbProd = new KThumb(clipManager, url);
47         if (m_clipType == AV || m_clipType == AUDIO) slotCreateAudioTimer();
48     }
49     //kDebug() << "type is video" << (m_clipType == AV) << " " << m_clipType;
50 }
51
52
53
54 DocClipBase::DocClipBase(const DocClipBase& clip) {
55     m_id = clip.getId();
56     m_clipType = clip.clipType();
57     m_name = clip.name();
58     m_duration = clip.duration();
59     m_audioThumbCreated = clip.audioThumbCreated();
60     m_properties = clip.properties();
61 }
62
63 DocClipBase & DocClipBase::operator=(const DocClipBase & clip) {
64     DocClipBase::operator=(clip);
65     m_id = clip.getId();
66     m_clipType = clip.clipType();
67     m_name = clip.name();
68     m_duration = clip.duration();
69     m_audioThumbCreated = clip.audioThumbCreated();
70     m_properties = clip.properties();
71     return *this;
72 }
73
74 DocClipBase::~DocClipBase() {
75     if (m_thumbProd) delete m_thumbProd;
76 }
77
78 void DocClipBase::slotCreateAudioTimer() {
79     connect(m_thumbProd, SIGNAL(audioThumbReady(QMap <int, QMap <int, QByteArray> >)), this , SLOT(updateAudioThumbnail(QMap <int, QMap <int, QByteArray> >)));
80     connect(this, SIGNAL(getAudioThumbs()), this , SLOT(slotGetAudioThumbs()));
81     m_audioTimer = new QTimer(this);
82     connect(m_audioTimer, SIGNAL(timeout()), this, SLOT(slotGetAudioThumbs()));
83 }
84
85 void DocClipBase::slotRequestAudioThumbs() {
86     emit getAudioThumbs();
87 }
88
89 void DocClipBase::slotClearAudioCache() {
90     audioFrameChache.clear();
91     m_audioThumbCreated = false;
92 }
93
94 KThumb *DocClipBase::thumbProducer() {
95     return m_thumbProd;
96 }
97
98 bool DocClipBase::audioThumbCreated() const {
99     return m_audioThumbCreated;
100 }
101
102 void DocClipBase::setName(const QString name) {
103     m_name = name;
104 }
105
106 const QString & DocClipBase::name() const {
107
108     return m_name;
109 }
110
111 uint DocClipBase::getId() const {
112     return m_id;
113 }
114
115 void DocClipBase::setId(const uint &newId) {
116     m_id = newId;
117 }
118
119 const CLIPTYPE & DocClipBase::clipType() const {
120     return m_clipType;
121 }
122
123 void DocClipBase::setClipType(CLIPTYPE type) {
124     m_clipType = type;
125     if (m_audioTimer == NULL && (m_clipType == AV || m_clipType == AUDIO))
126         slotCreateAudioTimer();
127 }
128
129 KUrl DocClipBase::fileURL() const {
130     QString res = m_properties.value("resource");
131     if (m_clipType != COLOR && !res.isEmpty()) return KUrl(res);
132     return KUrl();
133 }
134
135 void DocClipBase::setProjectThumbFrame(const uint &ix) {
136     m_projectThumbFrame = ix;
137 }
138
139 uint DocClipBase::getProjectThumbFrame() const {
140     return m_projectThumbFrame;
141 }
142
143 const QString DocClipBase::description() const {
144     return m_properties.value("description");
145 }
146
147 const QString DocClipBase::getProperty(const QString prop) const {
148     return m_properties.value(prop);
149 }
150
151 void DocClipBase::setDuration(GenTime dur) {
152     m_duration = dur;
153 }
154
155 const GenTime &DocClipBase::duration() const {
156     return m_duration;
157 }
158
159 const GenTime &DocClipBase::maxDuration() const {
160     if (m_clipType == COLOR || m_clipType == IMAGE || m_clipType == TEXT || (m_clipType == SLIDESHOW &&  m_properties.value("loop") == "1")) {
161         GenTime dur(10000, KdenliveSettings::project_fps());
162         return dur;
163     }
164     return m_duration;
165 }
166
167 bool DocClipBase::hasFileSize() const {
168     return true;
169 }
170
171
172 // virtual
173 QDomElement DocClipBase::toXML() const {
174     QDomDocument doc;
175
176     QDomElement clip = doc.createElement("producer");
177
178     QMapIterator<QString, QString> i(m_properties);
179     while (i.hasNext()) {
180         i.next();
181         if (!i.value().isEmpty()) clip.setAttribute(i.key(), i.value());
182     }
183     //doc.appendChild(clip);
184     //kDebug()<<"/// CLIP XML: "<<doc.toString();
185     return clip;
186 }
187
188 DocClipBase *DocClipBase::
189 createClip(KdenliveDoc *doc, const QDomElement & element) {
190     DocClipBase *clip = 0;
191     QString description;
192     QDomNode node = element;
193     node.normalize();
194     if (element.tagName() != "kdenliveclip") {
195         kWarning() <<
196         "DocClipBase::createClip() element has unknown tagName : " <<
197         element.tagName() << endl;
198         return 0;
199     }
200
201     QDomNode n = element.firstChild();
202
203     while (!n.isNull()) {
204         QDomElement e = n.toElement();
205         if (!e.isNull()) {
206             QString tagName = e.tagName();
207             if (e.tagName() == "avfile") {
208                 // clip = DocClipAVFile::createClip(e);
209             } else if (e.tagName() == "DocTrackBaseList") {
210                 // clip = DocClipProject::createClip(doc, e);
211             }
212         } else {
213             QDomText text = n.toText();
214             if (!text.isNull()) {
215                 description = text.nodeValue();
216             }
217         }
218
219         n = n.nextSibling();
220     }
221     if (clip == 0) {
222         kWarning() << "DocClipBase::createClip() unable to create clip" <<
223         endl;
224     } else {
225         // setup DocClipBase specifics of the clip.
226         QMap <QString, QString> props;
227         props.insert("description", description);
228         clip->setProperties(props);
229         clip->setAudioThumbCreated(false);
230     }
231     return clip;
232 }
233
234 void DocClipBase::setAudioThumbCreated(bool isDone) {
235     m_audioThumbCreated = isDone;
236 }
237
238
239 QDomDocument DocClipBase::generateSceneList(bool, bool) const {
240 }
241
242 void DocClipBase::setThumbnail(const QPixmap & pixmap) {
243     m_thumbnail = pixmap;
244 }
245
246 const QPixmap & DocClipBase::thumbnail() const {
247     return m_thumbnail;
248 }
249
250 void DocClipBase::updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data) {
251     kDebug() << "CLIPBASE RECIEDVED AUDIO DATA*********************************************";
252     audioFrameChache = data;
253     m_audioThumbCreated = true;
254     emit gotAudioData();
255 }
256
257 QList < GenTime > DocClipBase::snapMarkers() const {
258     QList < GenTime > markers;
259
260     for (uint count = 0; count < m_snapMarkers.count(); ++count) {
261         markers.append(m_snapMarkers[count].time());
262     }
263
264     return markers;
265 }
266
267 QList < CommentedTime > DocClipBase::commentedSnapMarkers() const {
268     return m_snapMarkers;
269 }
270
271 void DocClipBase::setSnapMarkers(QList < CommentedTime > markers) {
272     m_snapMarkers = markers;
273 }
274
275 void DocClipBase::addSnapMarker(const GenTime & time, QString comment) {
276     QList < CommentedTime >::Iterator it = m_snapMarkers.begin();
277     for (it = m_snapMarkers.begin(); it != m_snapMarkers.end(); ++it) {
278         if ((*it).time() >= time)
279             break;
280     }
281
282     if ((it != m_snapMarkers.end()) && ((*it).time() == time)) {
283         kError() <<
284         "trying to add Snap Marker that already exists, this will cause inconsistancies with undo/redo"
285         << endl;
286     } else {
287         CommentedTime t(time, comment);
288         m_snapMarkers.insert(it, t);
289     }
290
291 }
292
293 void DocClipBase::editSnapMarker(const GenTime & time, QString comment) {
294     QList < CommentedTime >::Iterator it;
295     for (it = m_snapMarkers.begin(); it != m_snapMarkers.end(); ++it) {
296         if ((*it).time() == time)
297             break;
298     }
299     if (it != m_snapMarkers.end()) {
300         (*it).setComment(comment);
301     } else {
302         kError() <<
303         "trying to edit Snap Marker that does not already exists"  << endl;
304     }
305 }
306
307 QString DocClipBase::deleteSnapMarker(const GenTime & time) {
308     QString result = i18n("Marker");
309     QList < CommentedTime >::Iterator itt = m_snapMarkers.begin();
310
311     while (itt != m_snapMarkers.end()) {
312         if ((*itt).time() == time)
313             break;
314         ++itt;
315     }
316
317     if ((itt != m_snapMarkers.end()) && ((*itt).time() == time)) {
318         result = (*itt).comment();
319         m_snapMarkers.erase(itt);
320     }
321     return result;
322 }
323
324
325 GenTime DocClipBase::hasSnapMarkers(const GenTime & time) {
326     QList < CommentedTime >::Iterator itt = m_snapMarkers.begin();
327
328     while (itt != m_snapMarkers.end()) {
329         if ((*itt).time() == time)
330             return time;
331         ++itt;
332     }
333
334     return GenTime(0.0);
335 }
336
337 GenTime DocClipBase::findPreviousSnapMarker(const GenTime & currTime) {
338     int it;
339     for (it = 0; it < m_snapMarkers.count(); it++) {
340         if (m_snapMarkers[it].time() >= currTime)
341             break;
342     }
343     if (it == 0) return GenTime();
344     else if (it == m_snapMarkers.count() - 1 && m_snapMarkers[it].time() < currTime)
345         return m_snapMarkers[it].time();
346     else return m_snapMarkers[it-1].time();
347 }
348
349 GenTime DocClipBase::findNextSnapMarker(const GenTime & currTime) {
350     int it;
351     for (it = 0; it < m_snapMarkers.count(); it++) {
352         if (m_snapMarkers[it].time() > currTime)
353             break;
354     }
355     if (it < m_snapMarkers.count() && m_snapMarkers[it].time() > currTime) return m_snapMarkers[it].time();
356     return duration();
357 }
358
359 QString DocClipBase::markerComment(GenTime t) {
360     QList < CommentedTime >::Iterator itt = m_snapMarkers.begin();
361
362     while (itt != m_snapMarkers.end()) {
363         if ((*itt).time() == t)
364             return (*itt).comment();
365         ++itt;
366     }
367     return QString::null;
368 }
369
370 void DocClipBase::setProperties(QMap <QString, QString> properties) {
371     QMapIterator<QString, QString> i(properties);
372     while (i.hasNext()) {
373         i.next();
374         m_properties.insert(i.key(), i.value());
375     }
376 }
377
378 void DocClipBase::setProperty(QString key, QString value) {
379     m_properties.insert(key, value);
380 }
381
382 QMap <QString, QString> DocClipBase::properties() const {
383     return m_properties;
384 }
385
386 void DocClipBase::slotGetAudioThumbs() {
387
388     if (m_audioThumbCreated) {
389         if (m_audioTimer != NULL)
390             m_audioTimer->stop();
391     } else {
392         if (m_audioTimer != NULL)
393             m_audioTimer->start(2000);
394         double lengthInFrames = duration().frames(/*framesPerSecond()*/25);
395         m_thumbProd->getAudioThumbs(2, 0, lengthInFrames /*must be number of frames*/, 20);
396     }
397 }
398
399
400