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 "commands/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"
31 #include <mlt++/Mlt.h>
34 #include <KMessageBox>
35 #include <KFileDialog>
36 #include <KApplication>
37 #include <kio/netaccess.h>
39 #include <QGraphicsItemGroup>
40 #include <QtConcurrentRun>
42 #include <KFileMetaInfo>
44 ClipManager::ClipManager(KdenliveDoc *doc) :
48 m_generatingAudioId(),
53 m_folderIdCounter = 1;
54 m_modifiedTimer.setInterval(1500);
55 connect(&m_fileWatcher, SIGNAL(dirty(const QString &)), this, SLOT(slotClipModified(const QString &)));
56 connect(&m_fileWatcher, SIGNAL(deleted(const QString &)), this, SLOT(slotClipMissing(const QString &)));
57 connect(&m_fileWatcher, SIGNAL(created(const QString &)), this, SLOT(slotClipAvailable(const QString &)));
58 connect(&m_modifiedTimer, SIGNAL(timeout()), this, SLOT(slotProcessModifiedClips()));
60 #if KDE_IS_VERSION(4,5,0)
61 KImageCache::deleteCache("kdenlive-thumbs");
62 pixmapCache = new KImageCache("kdenlive-thumbs", 1000000);
63 pixmapCache->setEvictionPolicy(KSharedDataCache::EvictOldest);
67 ClipManager::~ClipManager()
71 m_thumbsThread.waitForFinished();
73 m_requestedThumbs.clear();
74 m_thumbsMutex.unlock();
75 m_audioThumbsQueue.clear();
76 m_generatingAudioId.clear();
78 m_requestedThumbs.clear();
79 m_thumbsMutex.unlock();
80 qDeleteAll(m_clipList);
82 #if KDE_IS_VERSION(4,5,0)
87 void ClipManager::clear()
90 m_thumbsThread.waitForFinished();
92 m_requestedThumbs.clear();
93 m_thumbsMutex.unlock();
96 m_audioThumbsQueue.clear();
97 m_modifiedClips.clear();
98 qDeleteAll(m_clipList);
101 m_folderIdCounter = 1;
102 #if KDE_IS_VERSION(4,5,0)
103 pixmapCache->clear();
107 void ClipManager::clearCache()
109 #if KDE_IS_VERSION(4,5,0)
110 pixmapCache->clear();
114 void ClipManager::requestThumbs(const QString id, QList <int> frames)
116 m_thumbsMutex.lock();
117 foreach (int frame, frames) {
118 m_requestedThumbs.insertMulti(id, frame);
120 m_thumbsMutex.unlock();
121 if (!m_thumbsThread.isRunning() && !m_abortThumb) {
122 m_thumbsThread = QtConcurrent::run(this, &ClipManager::slotGetThumbs);
126 void ClipManager::stopThumbs(const QString &id)
128 if (m_requestedThumbs.isEmpty() || m_closing) return;
130 m_thumbsThread.waitForFinished();
131 m_thumbsMutex.lock();
132 m_requestedThumbs.remove(id);
133 m_thumbsMutex.unlock();
134 m_abortThumb = false;
135 if (!m_thumbsThread.isRunning()) {
136 m_thumbsThread = QtConcurrent::run(this, &ClipManager::slotGetThumbs);
140 void ClipManager::slotGetThumbs()
142 QMap<QString, int>::iterator i = m_requestedThumbs.begin();
145 while (i != m_requestedThumbs.end() && !m_abortThumb) {
146 QString producerId = i.key();
147 m_thumbsMutex.lock();
148 QList<int> values = m_requestedThumbs.values(producerId);
149 m_requestedThumbs.remove(producerId);
150 i = m_requestedThumbs.begin();
151 m_thumbsMutex.unlock();
153 DocClipBase *clip = getClipById(producerId);
155 max = m_requestedThumbs.size() + values.count();
156 while (!values.isEmpty() && clip->thumbProducer() && !m_abortThumb) {
157 clip->thumbProducer()->getThumb(values.takeFirst());
159 if (max > 3) emit displayMessage(i18n("Loading thumbnails"), 100 * done / max);
162 emit displayMessage(QString(), -1);
165 void ClipManager::checkAudioThumbs()
167 if (!KdenliveSettings::audiothumbnails()) {
168 if (!m_generatingAudioId.isEmpty()) {
169 DocClipBase *clip = getClipById(m_generatingAudioId);
170 if (clip) clip->slotClearAudioCache();
172 m_audioThumbsQueue.clear();
173 m_generatingAudioId.clear();
177 for (int i = 0; i < m_clipList.count(); i++) {
178 m_audioThumbsQueue.append(m_clipList.at(i)->getId());
180 if (m_generatingAudioId.isEmpty()) startAudioThumbsGeneration();
183 void ClipManager::askForAudioThumb(const QString &id)
185 DocClipBase *clip = getClipById(id);
186 if (clip && KdenliveSettings::audiothumbnails()) {
187 m_audioThumbsQueue.append(id);
188 if (m_generatingAudioId.isEmpty()) startAudioThumbsGeneration();
192 void ClipManager::startAudioThumbsGeneration()
194 if (!KdenliveSettings::audiothumbnails()) {
195 m_audioThumbsQueue.clear();
196 m_generatingAudioId.clear();
199 if (!m_audioThumbsQueue.isEmpty()) {
200 m_generatingAudioId = m_audioThumbsQueue.takeFirst();
201 DocClipBase *clip = getClipById(m_generatingAudioId);
202 if (!clip || !clip->slotGetAudioThumbs())
203 endAudioThumbsGeneration(m_generatingAudioId);
205 m_generatingAudioId.clear();
209 void ClipManager::endAudioThumbsGeneration(const QString &requestedId)
211 if (!KdenliveSettings::audiothumbnails()) {
212 m_audioThumbsQueue.clear();
213 m_generatingAudioId.clear();
216 if (!m_audioThumbsQueue.isEmpty()) {
217 if (m_generatingAudioId == requestedId) {
218 startAudioThumbsGeneration();
221 m_generatingAudioId.clear();
225 void ClipManager::setThumbsProgress(const QString &message, int progress)
227 m_doc->setThumbsProgress(message, progress);
230 QList <DocClipBase*> ClipManager::documentClipList() const
235 QMap <QString, QString> ClipManager::documentFolderList() const
240 void ClipManager::addClip(DocClipBase *clip)
242 m_clipList.append(clip);
243 if (clip->clipType() != COLOR && clip->clipType() != SLIDESHOW && !clip->fileURL().isEmpty()) {
244 // listen for file change
245 //kDebug() << "// LISTEN FOR: " << clip->fileURL().path();
246 m_fileWatcher.addFile(clip->fileURL().path());
248 const QString id = clip->getId();
249 if (id.toInt() >= m_clipIdCounter) m_clipIdCounter = id.toInt() + 1;
250 const QString gid = clip->getProperty("groupid");
251 if (!gid.isEmpty() && gid.toInt() >= m_folderIdCounter) m_folderIdCounter = gid.toInt() + 1;
254 void ClipManager::slotDeleteClips(QStringList ids)
256 QUndoCommand *delClips = new QUndoCommand();
257 delClips->setText(i18np("Delete clip", "Delete clips", ids.size()));
259 for (int i = 0; i < ids.size(); i++) {
260 DocClipBase *clip = getClipById(ids.at(i));
262 new AddClipCommand(m_doc, clip->toXML(), ids.at(i), false, delClips);
265 m_doc->commandStack()->push(delClips);
268 void ClipManager::deleteClip(const QString &clipId)
270 for (int i = 0; i < m_clipList.count(); i++) {
271 if (m_clipList.at(i)->getId() == clipId) {
272 if (m_clipList.at(i)->clipType() != COLOR && m_clipList.at(i)->clipType() != SLIDESHOW && !m_clipList.at(i)->fileURL().isEmpty()) {
273 //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())) {
274 // listen for file change
275 m_fileWatcher.removeFile(m_clipList.at(i)->fileURL().path());
277 DocClipBase *clip = m_clipList.takeAt(i);
285 DocClipBase *ClipManager::getClipAt(int pos)
287 return m_clipList.at(pos);
290 DocClipBase *ClipManager::getClipById(QString clipId)
292 //kDebug() << "++++ CLIP MAN, LOOKING FOR CLIP ID: " << clipId;
293 clipId = clipId.section('_', 0, 0);
294 for (int i = 0; i < m_clipList.count(); i++) {
295 if (m_clipList.at(i)->getId() == clipId) {
296 //kDebug() << "++++ CLIP MAN, FOUND FOR CLIP ID: " << clipId;
297 return m_clipList.at(i);
303 const QList <DocClipBase *> ClipManager::getClipByResource(QString resource)
305 QList <DocClipBase *> list;
306 QString clipResource;
307 QString proxyResource;
308 for (int i = 0; i < m_clipList.count(); i++) {
309 clipResource = m_clipList.at(i)->getProperty("resource");
310 proxyResource = m_clipList.at(i)->getProperty("proxy");
311 if (clipResource.isEmpty()) clipResource = m_clipList.at(i)->getProperty("colour");
312 if (clipResource == resource || proxyResource == resource) {
313 list.append(m_clipList.at(i));
320 void ClipManager::clearUnusedProducers()
322 for (int i = 0; i < m_clipList.count(); i++) {
323 if (m_clipList.at(i)->numReferences() == 0) m_clipList.at(i)->deleteProducers();
327 void ClipManager::resetProducersList(const QList <Mlt::Producer *> prods, bool displayRatioChanged, bool fpsChanged)
329 for (int i = 0; i < m_clipList.count(); i++) {
330 if (m_clipList.at(i)->numReferences() > 0 || displayRatioChanged || fpsChanged) {
331 m_clipList.at(i)->deleteProducers();
336 QStringList brokenClips;
337 for (int i = 0; i < prods.count(); i++) {
339 id = prod->get("id");
340 if (id.contains('_')) id = id.section('_', 0, 0);
341 DocClipBase *clip = getClipById(id);
342 QString markup = prod->get("markup");
343 if (prod->is_blank() || !prod->is_valid() || !markup.isEmpty()) {
344 // The clip is broken (missing proxy or source clip)
345 kDebug()<<"// WARNING, CLIP "<<id<<" Cannot be loaded";
349 clip->setProducer(prod, false, true);
352 emit checkAllClips(displayRatioChanged, fpsChanged, brokenClips);
355 void ClipManager::slotAddClipList(const KUrl::List urls, const QString &group, const QString &groupId)
357 QUndoCommand *addClips = new QUndoCommand();
359 foreach(const KUrl & file, urls) {
360 if (KIO::NetAccess::exists(file, KIO::NetAccess::SourceSide, NULL)) {
361 if (!getClipByResource(file.path()).empty()) {
362 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)
365 kDebug() << "Adding clip: " << file.path();
367 QDomElement prod = doc.createElement("producer");
368 doc.appendChild(prod);
369 prod.setAttribute("resource", file.path());
370 uint id = m_clipIdCounter++;
371 prod.setAttribute("id", QString::number(id));
372 if (!group.isEmpty()) {
373 prod.setAttribute("groupname", group);
374 prod.setAttribute("groupid", groupId);
376 KMimeType::Ptr type = KMimeType::findByUrl(file);
377 if (type->name().startsWith("image/")) {
378 prod.setAttribute("type", (int) IMAGE);
379 prod.setAttribute("in", 0);
380 prod.setAttribute("out", m_doc->getFramePos(KdenliveSettings::image_duration()));
381 if (KdenliveSettings::autoimagetransparency()) prod.setAttribute("transparency", 1);
382 // Read EXIF metadata for JPEG
383 if (type->is("image/jpeg")) {
384 KFileMetaInfo metaInfo(file.path(), QString("image/jpeg"), KFileMetaInfo::TechnicalInfo);
385 const QHash<QString, KFileMetaInfoItem> metaInfoItems = metaInfo.items();
386 foreach(const KFileMetaInfoItem & metaInfoItem, metaInfoItems) {
387 prod.setAttribute("meta.attr." + metaInfoItem.name().section("#", 1), metaInfoItem.value().toString());
390 } else if (type->is("application/x-kdenlivetitle")) {
391 // opening a title file
392 QDomDocument txtdoc("titledocument");
393 QFile txtfile(file.path());
394 if (txtfile.open(QIODevice::ReadOnly) && txtdoc.setContent(&txtfile)) {
396 prod.setAttribute("type", (int) TEXT);
397 // extract embeded images
398 QDomNodeList items = txtdoc.elementsByTagName("content");
399 for (int i = 0; i < items.count() ; i++) {
400 QDomElement content = items.item(i).toElement();
401 if (content.hasAttribute("base64")) {
402 QString titlesFolder = m_doc->projectFolder().path(KUrl::AddTrailingSlash) + "titles/";
403 QString path = TitleDocument::extractBase64Image(titlesFolder, content.attribute("base64"));
404 if (!path.isEmpty()) {
405 content.setAttribute("url", path);
406 content.removeAttribute("base64");
410 QString titleData = txtdoc.toString();
411 prod.setAttribute("xmldata", titleData);
412 prod.setAttribute("transparency", 1);
413 prod.setAttribute("in", 0);
414 int out = txtdoc.documentElement().attribute("out").toInt();
416 prod.setAttribute("out", out);
418 prod.setAttribute("out", m_doc->getFramePos(KdenliveSettings::title_duration()));
422 new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true, addClips);
425 if (addClips->childCount() > 0) {
426 addClips->setText(i18np("Add clip", "Add clips", addClips->childCount()));
427 m_doc->commandStack()->push(addClips);
431 void ClipManager::slotAddClipFile(const KUrl &url, const QString &group, const QString &groupId)
433 slotAddClipList(KUrl::List(url), group, groupId);
436 void ClipManager::slotAddXmlClipFile(const QString &name, const QDomElement &xml, const QString &group, const QString &groupId)
439 doc.appendChild(doc.importNode(xml, true));
440 QDomElement prod = doc.documentElement();
441 prod.setAttribute("type", (int) PLAYLIST);
442 uint id = m_clipIdCounter++;
443 prod.setAttribute("id", QString::number(id));
444 prod.setAttribute("name", name);
445 if (!group.isEmpty()) {
446 prod.setAttribute("groupname", group);
447 prod.setAttribute("groupid", groupId);
449 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
450 m_doc->commandStack()->push(command);
453 void ClipManager::slotAddColorClipFile(const QString &name, const QString &color, QString duration, const QString &group, const QString &groupId)
456 QDomElement prod = doc.createElement("producer");
457 doc.appendChild(prod);
458 prod.setAttribute("mlt_service", "colour");
459 prod.setAttribute("colour", color);
460 prod.setAttribute("type", (int) COLOR);
461 uint id = m_clipIdCounter++;
462 prod.setAttribute("id", QString::number(id));
463 prod.setAttribute("in", "0");
464 prod.setAttribute("out", m_doc->getFramePos(duration));
465 prod.setAttribute("name", name);
466 if (!group.isEmpty()) {
467 prod.setAttribute("groupname", group);
468 prod.setAttribute("groupid", groupId);
470 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
471 m_doc->commandStack()->push(command);
474 void ClipManager::slotAddSlideshowClipFile(const QString &name, const QString &path, int count, const QString &duration,
475 const bool loop, const bool crop, const bool fade,
476 const QString &luma_duration, const QString &luma_file, const int softness,
477 const QString &animation, const QString &group, const QString &groupId)
480 QDomElement prod = doc.createElement("producer");
481 doc.appendChild(prod);
482 prod.setAttribute("resource", path);
483 prod.setAttribute("type", (int) SLIDESHOW);
484 uint id = m_clipIdCounter++;
485 prod.setAttribute("id", QString::number(id));
486 prod.setAttribute("in", "0");
487 prod.setAttribute("out", m_doc->getFramePos(duration) * count);
488 prod.setAttribute("ttl", m_doc->getFramePos(duration));
489 prod.setAttribute("luma_duration", m_doc->getFramePos(luma_duration));
490 prod.setAttribute("name", name);
491 prod.setAttribute("loop", loop);
492 prod.setAttribute("crop", crop);
493 prod.setAttribute("fade", fade);
494 prod.setAttribute("softness", QString::number(softness));
495 prod.setAttribute("luma_file", luma_file);
496 prod.setAttribute("animation", animation);
497 if (!group.isEmpty()) {
498 prod.setAttribute("groupname", group);
499 prod.setAttribute("groupid", groupId);
501 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
502 m_doc->commandStack()->push(command);
507 void ClipManager::slotAddTextClipFile(const QString &titleName, int out, const QString &xml, const QString &group, const QString &groupId)
510 QDomElement prod = doc.createElement("producer");
511 doc.appendChild(prod);
512 //prod.setAttribute("resource", imagePath);
513 prod.setAttribute("name", titleName);
514 prod.setAttribute("xmldata", xml);
515 uint id = m_clipIdCounter++;
516 prod.setAttribute("id", QString::number(id));
517 if (!group.isEmpty()) {
518 prod.setAttribute("groupname", group);
519 prod.setAttribute("groupid", groupId);
521 prod.setAttribute("type", (int) TEXT);
522 prod.setAttribute("transparency", "1");
523 prod.setAttribute("in", "0");
524 prod.setAttribute("out", out);
525 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
526 m_doc->commandStack()->push(command);
529 void ClipManager::slotAddTextTemplateClip(QString titleName, const KUrl &path, const QString &group, const QString &groupId)
532 QDomElement prod = doc.createElement("producer");
533 doc.appendChild(prod);
534 prod.setAttribute("name", titleName);
535 prod.setAttribute("resource", path.path());
536 uint id = m_clipIdCounter++;
537 prod.setAttribute("id", QString::number(id));
538 if (!group.isEmpty()) {
539 prod.setAttribute("groupname", group);
540 prod.setAttribute("groupid", groupId);
542 prod.setAttribute("type", (int) TEXT);
543 prod.setAttribute("transparency", "1");
544 prod.setAttribute("in", "0");
547 QDomDocument titledoc;
548 QFile txtfile(path.path());
549 if (txtfile.open(QIODevice::ReadOnly) && titledoc.setContent(&txtfile)) {
551 out = titledoc.documentElement().attribute("out").toInt();
552 } else txtfile.close();
554 if (out == 0) out = m_doc->getFramePos(KdenliveSettings::image_duration());
555 prod.setAttribute("out", out);
557 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
558 m_doc->commandStack()->push(command);
561 int ClipManager::getFreeClipId()
563 return m_clipIdCounter++;
566 int ClipManager::getFreeFolderId()
568 return m_folderIdCounter++;
571 int ClipManager::lastClipId() const
573 return m_clipIdCounter - 1;
576 QString ClipManager::projectFolder() const
578 return m_doc->projectFolder().path();
581 void ClipManager::addFolder(const QString &id, const QString &name)
583 m_folderList.insert(id, name);
586 void ClipManager::deleteFolder(const QString &id)
588 m_folderList.remove(id);
591 AbstractGroupItem *ClipManager::createGroup()
593 AbstractGroupItem *group = new AbstractGroupItem(m_doc->fps());
594 m_groupsList.append(group);
598 void ClipManager::removeGroup(AbstractGroupItem *group)
600 m_groupsList.removeAll(group);
603 QDomElement ClipManager::groupsXml() const
606 QDomElement groups = doc.createElement("groups");
607 doc.appendChild(groups);
608 for (int i = 0; i < m_groupsList.count(); i++) {
609 QDomElement group = doc.createElement("group");
610 groups.appendChild(group);
611 QList <QGraphicsItem *> children = m_groupsList.at(i)->childItems();
612 for (int j = 0; j < children.count(); j++) {
613 if (children.at(j)->type() == AVWIDGET || children.at(j)->type() == TRANSITIONWIDGET) {
614 AbstractClipItem *item = static_cast <AbstractClipItem *>(children.at(j));
615 ItemInfo info = item->info();
616 if (item->type() == AVWIDGET) {
617 QDomElement clip = doc.createElement("clipitem");
618 clip.setAttribute("track", info.track);
619 clip.setAttribute("position", info.startPos.frames(m_doc->fps()));
620 group.appendChild(clip);
621 } else if (item->type() == TRANSITIONWIDGET) {
622 QDomElement clip = doc.createElement("transitionitem");
623 clip.setAttribute("track", info.track);
624 clip.setAttribute("position", info.startPos.frames(m_doc->fps()));
625 group.appendChild(clip);
630 return doc.documentElement();
634 void ClipManager::slotClipModified(const QString &path)
636 //kDebug() << "// CLIP: " << path << " WAS MODIFIED";
637 const QList <DocClipBase *> list = getClipByResource(path);
638 for (int i = 0; i < list.count(); i++) {
639 DocClipBase *clip = list.at(i);
641 QString id = clip->getId();
642 if (!m_modifiedClips.contains(id))
643 emit modifiedClip(id);
644 m_modifiedClips[id] = QTime::currentTime();
647 if (!m_modifiedTimer.isActive()) m_modifiedTimer.start();
650 void ClipManager::slotProcessModifiedClips()
652 if (!m_modifiedClips.isEmpty()) {
653 QMapIterator<QString, QTime> i(m_modifiedClips);
654 while (i.hasNext()) {
656 if (QTime::currentTime().msecsTo(i.value()) <= -1500) {
657 emit reloadClip(i.key());
658 m_modifiedClips.remove(i.key());
663 if (m_modifiedClips.isEmpty()) m_modifiedTimer.stop();
666 void ClipManager::slotClipMissing(const QString &path)
668 // kDebug() << "// CLIP: " << path << " WAS MISSING";
669 const QList <DocClipBase *> list = getClipByResource(path);
670 for (int i = 0; i < list.count(); i++) {
671 DocClipBase *clip = list.at(i);
672 if (clip != NULL) emit missingClip(clip->getId());
676 void ClipManager::slotClipAvailable(const QString &path)
678 // kDebug() << "// CLIP: " << path << " WAS ADDED";
679 const QList <DocClipBase *> list = getClipByResource(path);
680 for (int i = 0; i < list.count(); i++) {
681 DocClipBase *clip = list.at(i);
682 if (clip != NULL) emit availableClip(clip->getId());
686 int ClipManager::clipsCount() const
688 return m_clipList.count();