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"
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(),
52 m_folderIdCounter = 1;
53 m_modifiedTimer.setInterval(1500);
54 connect(&m_fileWatcher, SIGNAL(dirty(const QString &)), this, SLOT(slotClipModified(const QString &)));
55 connect(&m_fileWatcher, SIGNAL(deleted(const QString &)), this, SLOT(slotClipMissing(const QString &)));
56 connect(&m_fileWatcher, SIGNAL(created(const QString &)), this, SLOT(slotClipAvailable(const QString &)));
57 connect(&m_modifiedTimer, SIGNAL(timeout()), this, SLOT(slotProcessModifiedClips()));
59 #if KDE_IS_VERSION(4,5,0)
60 KImageCache::deleteCache("kdenlive-thumbs");
61 pixmapCache = new KImageCache("kdenlive-thumbs", 1000000);
62 pixmapCache->setEvictionPolicy(KSharedDataCache::EvictOldest);
66 ClipManager::~ClipManager()
69 m_requestedThumbs.clear();
70 m_thumbsMutex.unlock();
72 m_thumbsThread.waitForFinished();
73 m_audioThumbsQueue.clear();
74 m_generatingAudioId.clear();
76 m_requestedThumbs.clear();
77 m_thumbsMutex.unlock();
78 qDeleteAll(m_clipList);
80 #if KDE_IS_VERSION(4,5,0)
85 void ClipManager::clear()
88 m_requestedThumbs.clear();
89 m_thumbsMutex.unlock();
91 m_thumbsThread.waitForFinished();
94 m_audioThumbsQueue.clear();
95 m_modifiedClips.clear();
96 qDeleteAll(m_clipList);
99 m_folderIdCounter = 1;
100 #if KDE_IS_VERSION(4,5,0)
101 pixmapCache->clear();
105 void ClipManager::clearCache()
107 #if KDE_IS_VERSION(4,5,0)
108 pixmapCache->clear();
112 void ClipManager::requestThumbs(const QString id, QList <int> frames)
114 kDebug()<<"// Request thbs: "<<id<<": "<<frames;
115 m_thumbsMutex.lock();
116 foreach (int frame, frames) {
117 m_requestedThumbs.insertMulti(id, frame);
119 m_thumbsMutex.unlock();
120 if (!m_thumbsThread.isRunning() && !m_abortThumb) {
121 m_thumbsThread = QtConcurrent::run(this, &ClipManager::slotGetThumbs);
125 void ClipManager::stopThumbs(const QString &id)
128 m_thumbsThread.waitForFinished();
129 m_thumbsMutex.lock();
130 m_requestedThumbs.remove(id);
131 m_thumbsMutex.unlock();
132 m_abortThumb = false;
133 if (!m_thumbsThread.isRunning()) {
134 m_thumbsThread = QtConcurrent::run(this, &ClipManager::slotGetThumbs);
138 void ClipManager::slotGetThumbs()
140 QMap<QString, int>::const_iterator i = m_requestedThumbs.constBegin();
141 while (i != m_requestedThumbs.constEnd() && !m_abortThumb) {
142 const QString producerId = i.key();
143 m_thumbsMutex.lock();
144 QList<int> values = m_requestedThumbs.values(producerId);
145 m_requestedThumbs.remove(producerId);
146 m_thumbsMutex.unlock();
148 DocClipBase *clip = getClipById(producerId);
150 while (!values.isEmpty() && clip->thumbProducer() && !m_abortThumb) {
151 clip->thumbProducer()->getThumb(values.takeFirst());
154 // keep the requested frames that were not processed
155 m_thumbsMutex.lock();
156 foreach (int frame, values)
157 m_requestedThumbs.insertMulti(producerId, frame);
158 m_thumbsMutex.unlock();
160 i = m_requestedThumbs.constBegin();
164 void ClipManager::checkAudioThumbs()
166 if (!KdenliveSettings::audiothumbnails()) {
167 if (!m_generatingAudioId.isEmpty()) {
168 DocClipBase *clip = getClipById(m_generatingAudioId);
169 if (clip) clip->slotClearAudioCache();
171 m_audioThumbsQueue.clear();
172 m_generatingAudioId.clear();
176 for (int i = 0; i < m_clipList.count(); i++) {
177 m_audioThumbsQueue.append(m_clipList.at(i)->getId());
179 if (m_generatingAudioId.isEmpty()) startAudioThumbsGeneration();
182 void ClipManager::askForAudioThumb(const QString &id)
184 DocClipBase *clip = getClipById(id);
185 if (clip && KdenliveSettings::audiothumbnails()) {
186 m_audioThumbsQueue.append(id);
187 if (m_generatingAudioId.isEmpty()) startAudioThumbsGeneration();
191 void ClipManager::startAudioThumbsGeneration()
193 if (!KdenliveSettings::audiothumbnails()) {
194 m_audioThumbsQueue.clear();
195 m_generatingAudioId.clear();
198 if (!m_audioThumbsQueue.isEmpty()) {
199 m_generatingAudioId = m_audioThumbsQueue.takeFirst();
200 DocClipBase *clip = getClipById(m_generatingAudioId);
201 if (!clip || !clip->slotGetAudioThumbs())
202 endAudioThumbsGeneration(m_generatingAudioId);
204 m_generatingAudioId.clear();
208 void ClipManager::endAudioThumbsGeneration(const QString &requestedId)
210 if (!KdenliveSettings::audiothumbnails()) {
211 m_audioThumbsQueue.clear();
212 m_generatingAudioId.clear();
215 if (!m_audioThumbsQueue.isEmpty()) {
216 if (m_generatingAudioId == requestedId) {
217 startAudioThumbsGeneration();
220 m_generatingAudioId.clear();
224 void ClipManager::setThumbsProgress(const QString &message, int progress)
226 m_doc->setThumbsProgress(message, progress);
229 QList <DocClipBase*> ClipManager::documentClipList() const
234 QMap <QString, QString> ClipManager::documentFolderList() const
239 void ClipManager::addClip(DocClipBase *clip)
241 m_clipList.append(clip);
242 if (clip->clipType() != COLOR && clip->clipType() != SLIDESHOW && !clip->fileURL().isEmpty()) {
243 // listen for file change
244 //kDebug() << "// LISTEN FOR: " << clip->fileURL().path();
245 m_fileWatcher.addFile(clip->fileURL().path());
247 const QString id = clip->getId();
248 if (id.toInt() >= m_clipIdCounter) m_clipIdCounter = id.toInt() + 1;
249 const QString gid = clip->getProperty("groupid");
250 if (!gid.isEmpty() && gid.toInt() >= m_folderIdCounter) m_folderIdCounter = gid.toInt() + 1;
253 void ClipManager::slotDeleteClips(QStringList ids)
255 QUndoCommand *delClips = new QUndoCommand();
256 delClips->setText(i18np("Delete clip", "Delete clips", ids.size()));
258 for (int i = 0; i < ids.size(); i++) {
259 DocClipBase *clip = getClipById(ids.at(i));
261 new AddClipCommand(m_doc, clip->toXML(), ids.at(i), false, delClips);
264 m_doc->commandStack()->push(delClips);
267 void ClipManager::deleteClip(const QString &clipId)
269 for (int i = 0; i < m_clipList.count(); i++) {
270 if (m_clipList.at(i)->getId() == clipId) {
271 if (m_clipList.at(i)->clipType() != COLOR && m_clipList.at(i)->clipType() != SLIDESHOW && !m_clipList.at(i)->fileURL().isEmpty()) {
272 //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())) {
273 // listen for file change
274 m_fileWatcher.removeFile(m_clipList.at(i)->fileURL().path());
276 DocClipBase *clip = m_clipList.takeAt(i);
284 DocClipBase *ClipManager::getClipAt(int pos)
286 return m_clipList.at(pos);
289 DocClipBase *ClipManager::getClipById(QString clipId)
291 //kDebug() << "++++ CLIP MAN, LOOKING FOR CLIP ID: " << clipId;
292 clipId = clipId.section('_', 0, 0);
293 for (int i = 0; i < m_clipList.count(); i++) {
294 if (m_clipList.at(i)->getId() == clipId) {
295 //kDebug() << "++++ CLIP MAN, FOUND FOR CLIP ID: " << clipId;
296 return m_clipList.at(i);
302 const QList <DocClipBase *> ClipManager::getClipByResource(QString resource)
304 QList <DocClipBase *> list;
305 QString clipResource;
306 QString proxyResource;
307 for (int i = 0; i < m_clipList.count(); i++) {
308 clipResource = m_clipList.at(i)->getProperty("resource");
309 proxyResource = m_clipList.at(i)->getProperty("proxy");
310 if (clipResource.isEmpty()) clipResource = m_clipList.at(i)->getProperty("colour");
311 if (clipResource == resource || proxyResource == resource) {
312 list.append(m_clipList.at(i));
319 void ClipManager::clearUnusedProducers()
321 for (int i = 0; i < m_clipList.count(); i++) {
322 if (m_clipList.at(i)->numReferences() == 0) m_clipList.at(i)->deleteProducers();
326 void ClipManager::resetProducersList(const QList <Mlt::Producer *> prods, bool displayRatioChanged, bool fpsChanged)
328 for (int i = 0; i < m_clipList.count(); i++) {
329 if (m_clipList.at(i)->numReferences() > 0 || displayRatioChanged || fpsChanged) {
330 m_clipList.at(i)->deleteProducers();
334 for (int i = 0; i < prods.count(); i++) {
335 id = prods.at(i)->get("id");
336 if (id.contains('_')) id = id.section('_', 0, 0);
337 DocClipBase *clip = getClipById(id);
339 clip->setProducer(prods.at(i), false, true);
342 emit checkAllClips(displayRatioChanged, fpsChanged);
345 void ClipManager::slotAddClipList(const KUrl::List urls, const QString &group, const QString &groupId)
347 QUndoCommand *addClips = new QUndoCommand();
349 foreach(const KUrl & file, urls) {
350 if (KIO::NetAccess::exists(file, KIO::NetAccess::SourceSide, NULL)) {
351 if (!getClipByResource(file.path()).empty()) {
352 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)
355 kDebug() << "Adding clip: " << file.path();
357 QDomElement prod = doc.createElement("producer");
358 doc.appendChild(prod);
359 prod.setAttribute("resource", file.path());
360 uint id = m_clipIdCounter++;
361 prod.setAttribute("id", QString::number(id));
362 if (!group.isEmpty()) {
363 prod.setAttribute("groupname", group);
364 prod.setAttribute("groupid", groupId);
366 KMimeType::Ptr type = KMimeType::findByUrl(file);
367 if (type->name().startsWith("image/")) {
368 prod.setAttribute("type", (int) IMAGE);
369 prod.setAttribute("in", 0);
370 prod.setAttribute("out", m_doc->getFramePos(KdenliveSettings::image_duration()));
371 if (KdenliveSettings::autoimagetransparency()) prod.setAttribute("transparency", 1);
372 // Read EXIF metadata for JPEG
373 if (type->is("image/jpeg")) {
374 KFileMetaInfo metaInfo(file.path(), QString("image/jpeg"), KFileMetaInfo::TechnicalInfo);
375 const QHash<QString, KFileMetaInfoItem> metaInfoItems = metaInfo.items();
376 foreach(const KFileMetaInfoItem & metaInfoItem, metaInfoItems) {
377 prod.setAttribute("meta.attr." + metaInfoItem.name().section("#", 1), metaInfoItem.value().toString());
380 } else if (type->is("application/x-kdenlivetitle")) {
381 // opening a title file
382 QDomDocument txtdoc("titledocument");
383 QFile txtfile(file.path());
384 if (txtfile.open(QIODevice::ReadOnly) && txtdoc.setContent(&txtfile)) {
386 prod.setAttribute("type", (int) TEXT);
387 // extract embeded images
388 QDomNodeList items = txtdoc.elementsByTagName("content");
389 for (int i = 0; i < items.count() ; i++) {
390 QDomElement content = items.item(i).toElement();
391 if (content.hasAttribute("base64")) {
392 QString titlesFolder = m_doc->projectFolder().path(KUrl::AddTrailingSlash) + "titles/";
393 QString path = TitleDocument::extractBase64Image(titlesFolder, content.attribute("base64"));
394 if (!path.isEmpty()) {
395 content.setAttribute("url", path);
396 content.removeAttribute("base64");
400 QString titleData = txtdoc.toString();
401 prod.setAttribute("xmldata", titleData);
402 prod.setAttribute("transparency", 1);
403 prod.setAttribute("in", 0);
404 int out = txtdoc.documentElement().attribute("out").toInt();
406 prod.setAttribute("out", out);
408 prod.setAttribute("out", m_doc->getFramePos(KdenliveSettings::title_duration()));
412 new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true, addClips);
415 if (addClips->childCount() > 0) {
416 addClips->setText(i18np("Add clip", "Add clips", addClips->childCount()));
417 m_doc->commandStack()->push(addClips);
421 void ClipManager::slotAddClipFile(const KUrl &url, const QString &group, const QString &groupId)
423 slotAddClipList(KUrl::List(url), group, groupId);
426 void ClipManager::slotAddXmlClipFile(const QString &name, const QDomElement &xml, const QString &group, const QString &groupId)
429 doc.appendChild(doc.importNode(xml, true));
430 QDomElement prod = doc.documentElement();
431 prod.setAttribute("type", (int) PLAYLIST);
432 uint id = m_clipIdCounter++;
433 prod.setAttribute("id", QString::number(id));
434 prod.setAttribute("name", name);
435 if (!group.isEmpty()) {
436 prod.setAttribute("groupname", group);
437 prod.setAttribute("groupid", groupId);
439 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
440 m_doc->commandStack()->push(command);
443 void ClipManager::slotAddColorClipFile(const QString &name, const QString &color, QString duration, const QString &group, const QString &groupId)
446 QDomElement prod = doc.createElement("producer");
447 doc.appendChild(prod);
448 prod.setAttribute("mlt_service", "colour");
449 prod.setAttribute("colour", color);
450 prod.setAttribute("type", (int) COLOR);
451 uint id = m_clipIdCounter++;
452 prod.setAttribute("id", QString::number(id));
453 prod.setAttribute("in", "0");
454 prod.setAttribute("out", m_doc->getFramePos(duration));
455 prod.setAttribute("name", name);
456 if (!group.isEmpty()) {
457 prod.setAttribute("groupname", group);
458 prod.setAttribute("groupid", groupId);
460 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
461 m_doc->commandStack()->push(command);
464 void ClipManager::slotAddSlideshowClipFile(const QString &name, const QString &path, int count, const QString &duration,
465 const bool loop, const bool crop, const bool fade,
466 const QString &luma_duration, const QString &luma_file, const int softness,
467 const QString &animation, const QString &group, const QString &groupId)
470 QDomElement prod = doc.createElement("producer");
471 doc.appendChild(prod);
472 prod.setAttribute("resource", path);
473 prod.setAttribute("type", (int) SLIDESHOW);
474 uint id = m_clipIdCounter++;
475 prod.setAttribute("id", QString::number(id));
476 prod.setAttribute("in", "0");
477 prod.setAttribute("out", m_doc->getFramePos(duration) * count);
478 prod.setAttribute("ttl", m_doc->getFramePos(duration));
479 prod.setAttribute("luma_duration", m_doc->getFramePos(luma_duration));
480 prod.setAttribute("name", name);
481 prod.setAttribute("loop", loop);
482 prod.setAttribute("crop", crop);
483 prod.setAttribute("fade", fade);
484 prod.setAttribute("softness", QString::number(softness));
485 prod.setAttribute("luma_file", luma_file);
486 prod.setAttribute("animation", animation);
487 if (!group.isEmpty()) {
488 prod.setAttribute("groupname", group);
489 prod.setAttribute("groupid", groupId);
491 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
492 m_doc->commandStack()->push(command);
497 void ClipManager::slotAddTextClipFile(const QString &titleName, int out, const QString &xml, const QString &group, const QString &groupId)
500 QDomElement prod = doc.createElement("producer");
501 doc.appendChild(prod);
502 //prod.setAttribute("resource", imagePath);
503 prod.setAttribute("name", titleName);
504 prod.setAttribute("xmldata", xml);
505 uint id = m_clipIdCounter++;
506 prod.setAttribute("id", QString::number(id));
507 if (!group.isEmpty()) {
508 prod.setAttribute("groupname", group);
509 prod.setAttribute("groupid", groupId);
511 prod.setAttribute("type", (int) TEXT);
512 prod.setAttribute("transparency", "1");
513 prod.setAttribute("in", "0");
514 prod.setAttribute("out", out);
515 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
516 m_doc->commandStack()->push(command);
519 void ClipManager::slotAddTextTemplateClip(QString titleName, const KUrl &path, const QString &group, const QString &groupId)
522 QDomElement prod = doc.createElement("producer");
523 doc.appendChild(prod);
524 prod.setAttribute("name", titleName);
525 prod.setAttribute("resource", path.path());
526 uint id = m_clipIdCounter++;
527 prod.setAttribute("id", QString::number(id));
528 if (!group.isEmpty()) {
529 prod.setAttribute("groupname", group);
530 prod.setAttribute("groupid", groupId);
532 prod.setAttribute("type", (int) TEXT);
533 prod.setAttribute("transparency", "1");
534 prod.setAttribute("in", "0");
537 QDomDocument titledoc;
538 QFile txtfile(path.path());
539 if (txtfile.open(QIODevice::ReadOnly) && titledoc.setContent(&txtfile)) {
541 out = titledoc.documentElement().attribute("out").toInt();
542 } else txtfile.close();
544 if (out == 0) out = m_doc->getFramePos(KdenliveSettings::image_duration());
545 prod.setAttribute("out", out);
547 AddClipCommand *command = new AddClipCommand(m_doc, doc.documentElement(), QString::number(id), true);
548 m_doc->commandStack()->push(command);
551 int ClipManager::getFreeClipId()
553 return m_clipIdCounter++;
556 int ClipManager::getFreeFolderId()
558 return m_folderIdCounter++;
561 int ClipManager::lastClipId() const
563 return m_clipIdCounter - 1;
566 QString ClipManager::projectFolder() const
568 return m_doc->projectFolder().path();
571 void ClipManager::addFolder(const QString &id, const QString &name)
573 m_folderList.insert(id, name);
576 void ClipManager::deleteFolder(const QString &id)
578 m_folderList.remove(id);
581 AbstractGroupItem *ClipManager::createGroup()
583 AbstractGroupItem *group = new AbstractGroupItem(m_doc->fps());
584 m_groupsList.append(group);
588 void ClipManager::removeGroup(AbstractGroupItem *group)
590 m_groupsList.removeAll(group);
593 QDomElement ClipManager::groupsXml() const
596 QDomElement groups = doc.createElement("groups");
597 doc.appendChild(groups);
598 for (int i = 0; i < m_groupsList.count(); i++) {
599 QDomElement group = doc.createElement("group");
600 groups.appendChild(group);
601 QList <QGraphicsItem *> children = m_groupsList.at(i)->childItems();
602 for (int j = 0; j < children.count(); j++) {
603 if (children.at(j)->type() == AVWIDGET || children.at(j)->type() == TRANSITIONWIDGET) {
604 AbstractClipItem *item = static_cast <AbstractClipItem *>(children.at(j));
605 ItemInfo info = item->info();
606 if (item->type() == AVWIDGET) {
607 QDomElement clip = doc.createElement("clipitem");
608 clip.setAttribute("track", info.track);
609 clip.setAttribute("position", info.startPos.frames(m_doc->fps()));
610 group.appendChild(clip);
611 } else if (item->type() == TRANSITIONWIDGET) {
612 QDomElement clip = doc.createElement("transitionitem");
613 clip.setAttribute("track", info.track);
614 clip.setAttribute("position", info.startPos.frames(m_doc->fps()));
615 group.appendChild(clip);
620 return doc.documentElement();
624 void ClipManager::slotClipModified(const QString &path)
626 //kDebug() << "// CLIP: " << path << " WAS MODIFIED";
627 const QList <DocClipBase *> list = getClipByResource(path);
628 for (int i = 0; i < list.count(); i++) {
629 DocClipBase *clip = list.at(i);
631 QString id = clip->getId();
632 if (!m_modifiedClips.contains(id))
633 emit modifiedClip(id);
634 m_modifiedClips[id] = QTime::currentTime();
637 if (!m_modifiedTimer.isActive()) m_modifiedTimer.start();
640 void ClipManager::slotProcessModifiedClips()
642 if (!m_modifiedClips.isEmpty()) {
643 QMapIterator<QString, QTime> i(m_modifiedClips);
644 while (i.hasNext()) {
646 if (QTime::currentTime().msecsTo(i.value()) <= -1500) {
647 emit reloadClip(i.key());
648 m_modifiedClips.remove(i.key());
653 if (m_modifiedClips.isEmpty()) m_modifiedTimer.stop();
656 void ClipManager::slotClipMissing(const QString &path)
658 // kDebug() << "// CLIP: " << path << " WAS MISSING";
659 const QList <DocClipBase *> list = getClipByResource(path);
660 for (int i = 0; i < list.count(); i++) {
661 DocClipBase *clip = list.at(i);
662 if (clip != NULL) emit missingClip(clip->getId());
666 void ClipManager::slotClipAvailable(const QString &path)
668 // kDebug() << "// CLIP: " << path << " WAS ADDED";
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 availableClip(clip->getId());
676 int ClipManager::clipsCount() const
678 return m_clipList.count();