1 /***************************************************************************
2 * Copyright (C) 2008 by Jean-Baptiste Mardelle (jb@kdenlive.org) *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
18 ***************************************************************************/
21 #include "clipmanager.h"
22 #include "addclipcommand.h"
23 #include "kdenlivesettings.h"
24 #include "docclipbase.h"
25 #include "kdenlivedoc.h"
26 #include "abstractclipitem.h"
27 #include "abstractgroupitem.h"
28 #include "titledocument.h"
30 #include <mlt++/Mlt.h>
33 #include <KMessageBox>
34 #include <KFileDialog>
35 #include <KApplication>
36 #include <kio/netaccess.h>
38 #include <QGraphicsItemGroup>
40 #include <KFileMetaInfo>
42 ClipManager::ClipManager(KdenliveDoc *doc) :
49 m_folderIdCounter = 1;
50 m_modifiedTimer.setInterval(1500);
51 connect(&m_fileWatcher, SIGNAL(dirty(const QString &)), this, SLOT(slotClipModified(const QString &)));
52 connect(&m_fileWatcher, SIGNAL(deleted(const QString &)), this, SLOT(slotClipMissing(const QString &)));
53 connect(&m_fileWatcher, SIGNAL(created(const QString &)), this, SLOT(slotClipAvailable(const QString &)));
54 connect(&m_modifiedTimer, SIGNAL(timeout()), this, SLOT(slotProcessModifiedClips()));
56 #if KDE_IS_VERSION(4,5,0)
57 pixmapCache = new KImageCache("kdenlive-thumbs", 1000000);
61 ClipManager::~ClipManager()
63 m_audioThumbsQueue.clear();
64 m_generatingAudioId.clear();
65 qDeleteAll(m_clipList);
67 #if KDE_IS_VERSION(4,5,0)
72 void ClipManager::clear()
75 m_audioThumbsQueue.clear();
76 m_modifiedClips.clear();
77 qDeleteAll(m_clipList);
80 m_folderIdCounter = 1;
81 #if KDE_IS_VERSION(4,5,0)
86 void ClipManager::checkAudioThumbs()
88 if (!KdenliveSettings::audiothumbnails()) {
89 if (!m_generatingAudioId.isEmpty()) {
90 DocClipBase *clip = getClipById(m_generatingAudioId);
91 if (clip) clip->slotClearAudioCache();
93 m_audioThumbsQueue.clear();
94 m_generatingAudioId.clear();
98 for (int i = 0; i < m_clipList.count(); i++) {
99 m_audioThumbsQueue.append(m_clipList.at(i)->getId());
101 if (m_generatingAudioId.isEmpty()) startAudioThumbsGeneration();
104 void ClipManager::askForAudioThumb(const QString &id)
106 DocClipBase *clip = getClipById(id);
107 if (clip && KdenliveSettings::audiothumbnails()) {
108 m_audioThumbsQueue.append(id);
109 if (m_generatingAudioId.isEmpty()) startAudioThumbsGeneration();
113 void ClipManager::startAudioThumbsGeneration()
115 if (!KdenliveSettings::audiothumbnails()) {
116 m_audioThumbsQueue.clear();
117 m_generatingAudioId.clear();
120 if (!m_audioThumbsQueue.isEmpty()) {
121 m_generatingAudioId = m_audioThumbsQueue.takeFirst();
122 DocClipBase *clip = getClipById(m_generatingAudioId);
123 if (!clip || !clip->slotGetAudioThumbs())
124 endAudioThumbsGeneration(m_generatingAudioId);
126 m_generatingAudioId.clear();
130 void ClipManager::endAudioThumbsGeneration(const QString &requestedId)
132 if (!KdenliveSettings::audiothumbnails()) {
133 m_audioThumbsQueue.clear();
134 m_generatingAudioId.clear();
137 if (!m_audioThumbsQueue.isEmpty()) {
138 if (m_generatingAudioId == requestedId) {
139 startAudioThumbsGeneration();
142 m_generatingAudioId.clear();
146 void ClipManager::setThumbsProgress(const QString &message, int progress)
148 m_doc->setThumbsProgress(message, progress);
151 QList <DocClipBase*> ClipManager::documentClipList() const
156 QMap <QString, QString> ClipManager::documentFolderList() const
161 void ClipManager::addClip(DocClipBase *clip)
163 m_clipList.append(clip);
164 if (clip->clipType() != COLOR && clip->clipType() != SLIDESHOW && !clip->fileURL().isEmpty()) {
165 // listen for file change
166 //kDebug() << "// LISTEN FOR: " << clip->fileURL().path();
167 m_fileWatcher.addFile(clip->fileURL().path());
169 const QString id = clip->getId();
170 if (id.toInt() >= m_clipIdCounter) m_clipIdCounter = id.toInt() + 1;
171 const QString gid = clip->getProperty("groupid");
172 if (!gid.isEmpty() && gid.toInt() >= m_folderIdCounter) m_folderIdCounter = gid.toInt() + 1;
175 void ClipManager::slotDeleteClips(QStringList ids)
177 QUndoCommand *delClips = new QUndoCommand();
178 delClips->setText(i18np("Delete clip", "Delete clips", ids.size()));
180 for (int i = 0; i < ids.size(); i++) {
181 DocClipBase *clip = getClipById(ids.at(i));
183 new AddClipCommand(m_doc, clip->toXML(), ids.at(i), false, delClips);
186 m_doc->commandStack()->push(delClips);
189 void ClipManager::deleteClip(const QString &clipId)
191 for (int i = 0; i < m_clipList.count(); i++) {
192 if (m_clipList.at(i)->getId() == clipId) {
193 if (m_clipList.at(i)->clipType() != COLOR && m_clipList.at(i)->clipType() != SLIDESHOW && !m_clipList.at(i)->fileURL().isEmpty()) {
194 //if (m_clipList.at(i)->clipType() == IMAGE || m_clipList.at(i)->clipType() == AUDIO || (m_clipList.at(i)->clipType() == TEXT && !m_clipList.at(i)->fileURL().isEmpty())) {
195 // listen for file change
196 m_fileWatcher.removeFile(m_clipList.at(i)->fileURL().path());
198 DocClipBase *clip = m_clipList.takeAt(i);
206 DocClipBase *ClipManager::getClipAt(int pos)
208 return m_clipList.at(pos);
211 DocClipBase *ClipManager::getClipById(QString clipId)
213 //kDebug() << "++++ CLIP MAN, LOOKING FOR CLIP ID: " << clipId;
214 clipId = clipId.section('_', 0, 0);
215 for (int i = 0; i < m_clipList.count(); i++) {
216 if (m_clipList.at(i)->getId() == clipId) {
217 //kDebug() << "++++ CLIP MAN, FOUND FOR CLIP ID: " << clipId;
218 return m_clipList.at(i);
224 const QList <DocClipBase *> ClipManager::getClipByResource(QString resource)
226 QList <DocClipBase *> list;
227 QString clipResource;
228 QString proxyResource;
229 for (int i = 0; i < m_clipList.count(); i++) {
230 clipResource = m_clipList.at(i)->getProperty("resource");
231 proxyResource = m_clipList.at(i)->getProperty("proxy");
232 if (clipResource.isEmpty()) clipResource = m_clipList.at(i)->getProperty("colour");
233 if (clipResource == resource || proxyResource == resource) {
234 list.append(m_clipList.at(i));
241 void ClipManager::clearUnusedProducers()
243 for (int i = 0; i < m_clipList.count(); i++) {
244 if (m_clipList.at(i)->numReferences() == 0) m_clipList.at(i)->deleteProducers();
248 void ClipManager::resetProducersList(const QList <Mlt::Producer *> prods, bool displayRatioChanged, bool fpsChanged)
250 for (int i = 0; i < m_clipList.count(); i++) {
251 if (m_clipList.at(i)->numReferences() > 0 || displayRatioChanged || fpsChanged) {
252 m_clipList.at(i)->deleteProducers(true);
256 for (int i = 0; i < prods.count(); i++) {
257 id = prods.at(i)->get("id");
258 if (id.contains('_')) id = id.section('_', 0, 0);
259 DocClipBase *clip = getClipById(id);
261 clip->setProducer(prods.at(i), false, true);
264 emit checkAllClips(displayRatioChanged, fpsChanged);
267 void ClipManager::slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId)
269 QUndoCommand *addClips = new QUndoCommand();
271 foreach(const KUrl & file, urls) {
272 if (KIO::NetAccess::exists(file, KIO::NetAccess::SourceSide, NULL)) {
273 if (!getClipByResource(file.path()).empty()) {
274 if (KMessageBox::warningContinueCancel(kapp->activeWindow(), i18n("Clip <b>%1</b><br />already exists in project, what do you want to do?", file.path()), i18n("Clip already exists")) == KMessageBox::Cancel)
277 kDebug() << "Adding clip: " << file.path();
279 QDomElement prod = doc.createElement("producer");
280 doc.appendChild(prod);
281 prod.setAttribute("resource", file.path());
282 uint id = m_clipIdCounter++;
283 prod.setAttribute("id", QString::number(id));
284 if (!group.isEmpty()) {
285 prod.setAttribute("groupname", group);
286 prod.setAttribute("groupid", groupId);
288 KMimeType::Ptr type = KMimeType::findByUrl(file);
289 if (type->name().startsWith("image/")) {
290 prod.setAttribute("type", (int) IMAGE);
291 prod.setAttribute("in", 0);
292 prod.setAttribute("out", m_doc->getFramePos(KdenliveSettings::image_duration()));
293 if (KdenliveSettings::autoimagetransparency()) prod.setAttribute("transparency", 1);
294 // Read EXIF metadata for JPEG
295 if (type->is("image/jpeg")) {
296 KFileMetaInfo metaInfo(file.path(), QString("image/jpeg"), KFileMetaInfo::TechnicalInfo);
297 const QHash<QString, KFileMetaInfoItem> metaInfoItems = metaInfo.items();
298 foreach(const KFileMetaInfoItem & metaInfoItem, metaInfoItems) {
299 prod.setAttribute("meta.attr." + metaInfoItem.name().section("#", 1), metaInfoItem.value().toString());
302 } else if (type->is("application/x-kdenlivetitle")) {
303 // opening a title file
304 QDomDocument txtdoc("titledocument");
305 QFile txtfile(file.path());
306 if (txtfile.open(QIODevice::ReadOnly) && txtdoc.setContent(&txtfile)) {
308 prod.setAttribute("type", (int) TEXT);
309 // extract embeded images
310 QDomNodeList items = txtdoc.elementsByTagName("content");
311 for (int i = 0; i < items.count() ; i++) {
312 QDomElement content = items.item(i).toElement();
313 if (content.hasAttribute("base64")) {
314 QString titlesFolder = m_doc->projectFolder().path(KUrl::AddTrailingSlash) + "titles/";
315 QString path = TitleDocument::extractBase64Image(titlesFolder, content.attribute("base64"));
316 if (!path.isEmpty()) {
317 content.setAttribute("url", path);
318 content.removeAttribute("base64");
322 QString titleData = txtdoc.toString();
323 prod.setAttribute("xmldata", titleData);
324 prod.setAttribute("transparency", 1);
325 prod.setAttribute("in", 0);
326 int out = txtdoc.documentElement().attribute("out").toInt();
328 prod.setAttribute("out", out);
330 prod.setAttribute("out", m_doc->getFramePos(KdenliveSettings::title_duration()));
334 new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true, addClips);
337 if (addClips->childCount() > 0) {
338 addClips->setText(i18np("Add clip", "Add clips", addClips->childCount()));
339 m_doc->commandStack()->push(addClips);
343 void ClipManager::slotAddClipFile(const KUrl url, const QString group, const QString &groupId)
345 slotAddClipList(KUrl::List(url), group, groupId);
348 void ClipManager::slotAddXmlClipFile(const QString name, const QDomElement xml, const QString group, const QString &groupId)
351 doc.appendChild(doc.importNode(xml, true));
352 QDomElement prod = doc.documentElement();
353 prod.setAttribute("type", (int) PLAYLIST);
354 uint id = m_clipIdCounter++;
355 prod.setAttribute("id", QString::number(id));
356 prod.setAttribute("name", name);
357 if (!group.isEmpty()) {
358 prod.setAttribute("groupname", group);
359 prod.setAttribute("groupid", groupId);
361 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
362 m_doc->commandStack()->push(command);
365 void ClipManager::slotAddColorClipFile(const QString name, const QString color, QString duration, const QString group, const QString &groupId)
368 QDomElement prod = doc.createElement("producer");
369 doc.appendChild(prod);
370 prod.setAttribute("mlt_service", "colour");
371 prod.setAttribute("colour", color);
372 prod.setAttribute("type", (int) COLOR);
373 uint id = m_clipIdCounter++;
374 prod.setAttribute("id", QString::number(id));
375 prod.setAttribute("in", "0");
376 prod.setAttribute("out", m_doc->getFramePos(duration));
377 prod.setAttribute("name", name);
378 if (!group.isEmpty()) {
379 prod.setAttribute("groupname", group);
380 prod.setAttribute("groupid", groupId);
382 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
383 m_doc->commandStack()->push(command);
386 void ClipManager::slotAddSlideshowClipFile(const QString name, const QString path, int count, const QString duration,
387 const bool loop, const bool crop, const bool fade,
388 const QString &luma_duration, const QString &luma_file, const int softness,
389 const QString &animation, QString group, const QString &groupId)
392 QDomElement prod = doc.createElement("producer");
393 doc.appendChild(prod);
394 prod.setAttribute("resource", path);
395 prod.setAttribute("type", (int) SLIDESHOW);
396 uint id = m_clipIdCounter++;
397 prod.setAttribute("id", QString::number(id));
398 prod.setAttribute("in", "0");
399 prod.setAttribute("out", m_doc->getFramePos(duration) * count);
400 prod.setAttribute("ttl", m_doc->getFramePos(duration));
401 prod.setAttribute("luma_duration", m_doc->getFramePos(luma_duration));
402 prod.setAttribute("name", name);
403 prod.setAttribute("loop", loop);
404 prod.setAttribute("crop", crop);
405 prod.setAttribute("fade", fade);
406 prod.setAttribute("softness", QString::number(softness));
407 prod.setAttribute("luma_file", luma_file);
408 prod.setAttribute("animation", animation);
409 if (!group.isEmpty()) {
410 prod.setAttribute("groupname", group);
411 prod.setAttribute("groupid", groupId);
413 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
414 m_doc->commandStack()->push(command);
419 void ClipManager::slotAddTextClipFile(const QString titleName, int out, const QString xml, const QString group, const QString &groupId)
422 QDomElement prod = doc.createElement("producer");
423 doc.appendChild(prod);
424 //prod.setAttribute("resource", imagePath);
425 prod.setAttribute("name", titleName);
426 prod.setAttribute("xmldata", xml);
427 uint id = m_clipIdCounter++;
428 prod.setAttribute("id", QString::number(id));
429 if (!group.isEmpty()) {
430 prod.setAttribute("groupname", group);
431 prod.setAttribute("groupid", groupId);
433 prod.setAttribute("type", (int) TEXT);
434 prod.setAttribute("transparency", "1");
435 prod.setAttribute("in", "0");
436 prod.setAttribute("out", out);
437 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
438 m_doc->commandStack()->push(command);
441 void ClipManager::slotAddTextTemplateClip(QString titleName, const KUrl path, const QString group, const QString &groupId)
444 QDomElement prod = doc.createElement("producer");
445 doc.appendChild(prod);
446 prod.setAttribute("name", titleName);
447 prod.setAttribute("resource", path.path());
448 uint id = m_clipIdCounter++;
449 prod.setAttribute("id", QString::number(id));
450 if (!group.isEmpty()) {
451 prod.setAttribute("groupname", group);
452 prod.setAttribute("groupid", groupId);
454 prod.setAttribute("type", (int) TEXT);
455 prod.setAttribute("transparency", "1");
456 prod.setAttribute("in", "0");
459 QDomDocument titledoc;
460 QFile txtfile(path.path());
461 if (txtfile.open(QIODevice::ReadOnly) && titledoc.setContent(&txtfile)) {
463 out = titledoc.documentElement().attribute("out").toInt();
464 } else txtfile.close();
466 if (out == 0) out = m_doc->getFramePos(KdenliveSettings::image_duration());
467 prod.setAttribute("out", out);
469 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
470 m_doc->commandStack()->push(command);
473 int ClipManager::getFreeClipId()
475 return m_clipIdCounter++;
478 int ClipManager::getFreeFolderId()
480 return m_folderIdCounter++;
483 int ClipManager::lastClipId() const
485 return m_clipIdCounter - 1;
488 QString ClipManager::projectFolder() const
490 return m_doc->projectFolder().path();
493 void ClipManager::addFolder(const QString &id, const QString &name)
495 m_folderList.insert(id, name);
498 void ClipManager::deleteFolder(const QString &id)
500 m_folderList.remove(id);
503 AbstractGroupItem *ClipManager::createGroup()
505 AbstractGroupItem *group = new AbstractGroupItem(m_doc->fps());
506 m_groupsList.append(group);
510 void ClipManager::removeGroup(AbstractGroupItem *group)
512 m_groupsList.removeAll(group);
515 QDomElement ClipManager::groupsXml() const
518 QDomElement groups = doc.createElement("groups");
519 doc.appendChild(groups);
520 for (int i = 0; i < m_groupsList.count(); i++) {
521 QDomElement group = doc.createElement("group");
522 groups.appendChild(group);
523 QList <QGraphicsItem *> children = m_groupsList.at(i)->childItems();
524 for (int j = 0; j < children.count(); j++) {
525 if (children.at(j)->type() == AVWIDGET || children.at(j)->type() == TRANSITIONWIDGET) {
526 AbstractClipItem *item = static_cast <AbstractClipItem *>(children.at(j));
527 ItemInfo info = item->info();
528 if (item->type() == AVWIDGET) {
529 QDomElement clip = doc.createElement("clipitem");
530 clip.setAttribute("track", info.track);
531 clip.setAttribute("position", info.startPos.frames(m_doc->fps()));
532 group.appendChild(clip);
533 } else if (item->type() == TRANSITIONWIDGET) {
534 QDomElement clip = doc.createElement("transitionitem");
535 clip.setAttribute("track", info.track);
536 clip.setAttribute("position", info.startPos.frames(m_doc->fps()));
537 group.appendChild(clip);
542 return doc.documentElement();
546 void ClipManager::slotClipModified(const QString &path)
548 //kDebug() << "// CLIP: " << path << " WAS MODIFIED";
549 const QList <DocClipBase *> list = getClipByResource(path);
550 for (int i = 0; i < list.count(); i++) {
551 DocClipBase *clip = list.at(i);
553 QString id = clip->getId();
554 if (!m_modifiedClips.contains(id))
555 emit modifiedClip(id);
556 m_modifiedClips[id] = QTime::currentTime();
559 if (!m_modifiedTimer.isActive()) m_modifiedTimer.start();
562 void ClipManager::slotProcessModifiedClips()
564 if (!m_modifiedClips.isEmpty()) {
565 QMapIterator<QString, QTime> i(m_modifiedClips);
566 while (i.hasNext()) {
568 if (QTime::currentTime().msecsTo(i.value()) <= -1500) {
569 emit reloadClip(i.key());
570 m_modifiedClips.remove(i.key());
575 if (m_modifiedClips.isEmpty()) m_modifiedTimer.stop();
578 void ClipManager::slotClipMissing(const QString &path)
580 // kDebug() << "// CLIP: " << path << " WAS MISSING";
581 const QList <DocClipBase *> list = getClipByResource(path);
582 for (int i = 0; i < list.count(); i++) {
583 DocClipBase *clip = list.at(i);
584 if (clip != NULL) emit missingClip(clip->getId());
588 void ClipManager::slotClipAvailable(const QString &path)
590 // kDebug() << "// CLIP: " << path << " WAS ADDED";
591 const QList <DocClipBase *> list = getClipByResource(path);
592 for (int i = 0; i < list.count(); i++) {
593 DocClipBase *clip = list.at(i);
594 if (clip != NULL) emit availableClip(clip->getId());
598 int ClipManager::clipsCount() const
600 return m_clipList.count();