1 /**************************1*************************************************
2 DocClipBase.cpp - 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 ***************************************************************************/
18 #include <QCryptographicHash>
22 #include "kdenlivesettings.h"
23 #include "docclipbase.h"
25 #include "clipmanager.h"
27 DocClipBase::DocClipBase(ClipManager *clipManager, QDomElement xml, const QString &id):
28 m_id(id), m_description(QString()), m_refcount(0), m_audioThumbCreated(false), m_duration(GenTime()), m_thumbProd(NULL), m_audioTimer(NULL), m_properties(QMap <QString, QString> ()), audioFrameChache(QMap<int, QMap<int, QByteArray> > ()), m_baseTrackProducers(QList <Mlt::Producer *>()), m_snapMarkers(QList < CommentedTime > ()) {
29 int type = xml.attribute("type").toInt();
30 m_clipType = (CLIPTYPE) type;
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());
37 KUrl url = KUrl(xml.attribute("resource"));
38 if (!m_properties.contains("file_hash") && !url.isEmpty()) getFileHash(url.path());
39 int out = xml.attribute("out").toInt();
41 setDuration(GenTime(out, KdenliveSettings::project_fps()));
43 out = xml.attribute("duration").toInt();
44 if (out != 0) setDuration(GenTime(out, KdenliveSettings::project_fps()));
46 if (!m_properties.contains("name")) m_properties.insert("name", url.fileName());
48 //if (!url.isEmpty() && QFile::exists(url.path()))
50 m_thumbProd = new KThumb(clipManager, url, m_id, m_properties.value("file_hash"));
51 if (m_clipType == AV || m_clipType == AUDIO) slotCreateAudioTimer();
53 //kDebug() << "type is video" << (m_clipType == AV) << " " << m_clipType;
56 /*DocClipBase & DocClipBase::operator=(const DocClipBase & clip) {
57 DocClipBase::operator=(clip);
59 m_clipType = clip.clipType();
61 m_duration = clip.duration();
62 m_audioThumbCreated = clip.audioThumbCreated();
63 m_properties = clip.properties();
67 DocClipBase::~DocClipBase() {
75 qDeleteAll(m_baseTrackProducers);
76 m_baseTrackProducers.clear();
79 void DocClipBase::setZone(QPoint zone) {
80 m_properties.insert("zone_in", QString::number(zone.x()));
81 m_properties.insert("zone_out", QString::number(zone.y()));
84 QPoint DocClipBase::zone() const {
86 zone.setX(m_properties.value("zone_in").toInt());
87 zone.setY(m_properties.value("zone_out", "50").toInt());
91 void DocClipBase::slotCreateAudioTimer() {
92 connect(m_thumbProd, SIGNAL(audioThumbReady(QMap <int, QMap <int, QByteArray> >)), this , SLOT(updateAudioThumbnail(QMap <int, QMap <int, QByteArray> >)));
93 connect(this, SIGNAL(getAudioThumbs()), this , SLOT(slotGetAudioThumbs()));
94 m_audioTimer = new QTimer(this);
95 connect(m_audioTimer, SIGNAL(timeout()), this, SLOT(slotGetAudioThumbs()));
98 void DocClipBase::askForAudioThumbs() {
99 if (m_thumbProd) m_thumbProd->askForAudioThumbs(getId());
102 void DocClipBase::slotClearAudioCache() {
103 if (m_thumbProd) m_thumbProd->stopAudioThumbs();
104 if (m_audioTimer != NULL) m_audioTimer->stop();
105 audioFrameChache.clear();
106 m_audioThumbCreated = false;
109 /*void DocClipBase::getClipMainThumb() {
110 if (m_thumbProd) m_thumbProd->getMainThumb(m_properties.value("thumbnail").toInt());
113 KThumb *DocClipBase::thumbProducer() {
117 bool DocClipBase::audioThumbCreated() const {
118 return m_audioThumbCreated;
121 const QString & DocClipBase::name() const {
123 return m_properties.value("name");
126 const QString &DocClipBase::getId() const {
130 void DocClipBase::setId(const QString &newId) {
134 const CLIPTYPE & DocClipBase::clipType() const {
138 void DocClipBase::setClipType(CLIPTYPE type) {
141 m_properties.insert("type", QString::number((int) type));
142 if (m_thumbProd && m_audioTimer == NULL && (m_clipType == AV || m_clipType == AUDIO))
143 slotCreateAudioTimer();
146 KUrl DocClipBase::fileURL() const {
147 QString res = m_properties.value("resource");
148 if (m_clipType != COLOR && !res.isEmpty()) return KUrl(res);
152 void DocClipBase::setClipThumbFrame(const uint &ix) {
153 m_properties.insert("thumbnail", QString::number((int) ix));
156 uint DocClipBase::getClipThumbFrame() const {
157 return (uint) m_properties.value("thumbnail").toInt();
160 const QString DocClipBase::description() const {
161 return m_properties.value("description");
164 bool DocClipBase::isTransparent() const {
165 return (m_properties.value("transparency") == "1");
168 const QString DocClipBase::getProperty(const QString prop) const {
169 return m_properties.value(prop);
172 void DocClipBase::setDuration(GenTime dur) {
174 m_properties.insert("duration", QString::number((int) dur.frames(KdenliveSettings::project_fps())));
177 const GenTime &DocClipBase::duration() const {
181 const GenTime &DocClipBase::maxDuration() const {
182 if (m_clipType == COLOR || m_clipType == IMAGE || m_clipType == TEXT || (m_clipType == SLIDESHOW && m_properties.value("loop") == "1")) {
183 const GenTime dur(15000, KdenliveSettings::project_fps());
189 bool DocClipBase::hasFileSize() const {
195 QDomElement DocClipBase::toXML() const {
197 QDomElement clip = doc.createElement("producer");
199 QMapIterator<QString, QString> i(m_properties);
200 while (i.hasNext()) {
202 if (!i.value().isEmpty()) clip.setAttribute(i.key(), i.value());
204 doc.appendChild(clip);
205 //kDebug()<<"/// CLIP XML: "<<doc.toString();
206 return doc.documentElement();
209 DocClipBase *DocClipBase::
210 createClip(KdenliveDoc *doc, const QDomElement & element) {
211 DocClipBase *clip = 0;
213 QDomNode node = element;
215 if (element.tagName() != "kdenliveclip") {
217 "DocClipBase::createClip() element has unknown tagName : " << element.tagName();
221 QDomNode n = element.firstChild();
223 while (!n.isNull()) {
224 QDomElement e = n.toElement();
226 QString tagName = e.tagName();
227 if (e.tagName() == "avfile") {
228 // clip = DocClipAVFile::createClip(e);
229 } else if (e.tagName() == "DocTrackBaseList") {
230 // clip = DocClipProject::createClip(doc, e);
233 QDomText text = n.toText();
234 if (!text.isNull()) {
235 description = text.nodeValue();
242 kWarning() << "DocClipBase::createClip() unable to create clip";
244 // setup DocClipBase specifics of the clip.
245 QMap <QString, QString> props;
246 props.insert("description", description);
247 clip->setProperties(props);
248 clip->setAudioThumbCreated(false);
253 void DocClipBase::setAudioThumbCreated(bool isDone) {
254 m_audioThumbCreated = isDone;
258 void DocClipBase::setThumbnail(const QPixmap & pixmap) {
259 m_thumbnail = pixmap;
262 const QPixmap & DocClipBase::thumbnail() const {
266 void DocClipBase::updateAudioThumbnail(QMap<int, QMap<int, QByteArray> > data) {
267 //kDebug() << "CLIPBASE RECIEDVEDÂ AUDIOÂ DATA*********************************************";
268 audioFrameChache = data;
269 m_audioThumbCreated = true;
273 QList < GenTime > DocClipBase::snapMarkers() const {
274 QList < GenTime > markers;
276 for (uint count = 0; count < m_snapMarkers.count(); ++count) {
277 markers.append(m_snapMarkers[count].time());
283 QList < CommentedTime > DocClipBase::commentedSnapMarkers() const {
284 return m_snapMarkers;
287 void DocClipBase::setSnapMarkers(QList < CommentedTime > markers) {
288 m_snapMarkers = markers;
291 void DocClipBase::addSnapMarker(const GenTime & time, QString comment) {
292 QList < CommentedTime >::Iterator it = m_snapMarkers.begin();
293 for (it = m_snapMarkers.begin(); it != m_snapMarkers.end(); ++it) {
294 if ((*it).time() >= time)
298 if ((it != m_snapMarkers.end()) && ((*it).time() == time)) {
299 (*it).setComment(comment);
300 //kError() << "trying to add Snap Marker that already exists, this will cause inconsistancies with undo/redo";
302 CommentedTime t(time, comment);
303 m_snapMarkers.insert(it, t);
308 void DocClipBase::editSnapMarker(const GenTime & time, QString comment) {
309 QList < CommentedTime >::Iterator it;
310 for (it = m_snapMarkers.begin(); it != m_snapMarkers.end(); ++it) {
311 if ((*it).time() == time)
314 if (it != m_snapMarkers.end()) {
315 (*it).setComment(comment);
317 kError() << "trying to edit Snap Marker that does not already exists";
321 QString DocClipBase::deleteSnapMarker(const GenTime & time) {
322 QString result = i18n("Marker");
323 QList < CommentedTime >::Iterator itt = m_snapMarkers.begin();
325 while (itt != m_snapMarkers.end()) {
326 if ((*itt).time() == time)
331 if ((itt != m_snapMarkers.end()) && ((*itt).time() == time)) {
332 result = (*itt).comment();
333 m_snapMarkers.erase(itt);
339 GenTime DocClipBase::hasSnapMarkers(const GenTime & time) {
340 QList < CommentedTime >::Iterator itt = m_snapMarkers.begin();
342 while (itt != m_snapMarkers.end()) {
343 if ((*itt).time() == time)
351 GenTime DocClipBase::findPreviousSnapMarker(const GenTime & currTime) {
353 for (it = 0; it < m_snapMarkers.count(); it++) {
354 if (m_snapMarkers[it].time() >= currTime)
357 if (it == 0) return GenTime();
358 else if (it == m_snapMarkers.count() - 1 && m_snapMarkers[it].time() < currTime)
359 return m_snapMarkers[it].time();
360 else return m_snapMarkers[it-1].time();
363 GenTime DocClipBase::findNextSnapMarker(const GenTime & currTime) {
365 for (it = 0; it < m_snapMarkers.count(); it++) {
366 if (m_snapMarkers[it].time() > currTime)
369 if (it < m_snapMarkers.count() && m_snapMarkers[it].time() > currTime) return m_snapMarkers[it].time();
373 QString DocClipBase::markerComment(GenTime t) {
374 QList < CommentedTime >::Iterator itt = m_snapMarkers.begin();
376 while (itt != m_snapMarkers.end()) {
377 if ((*itt).time() == t)
378 return (*itt).comment();
381 return QString::null;
384 void DocClipBase::deleteProducers() {
385 qDeleteAll(m_baseTrackProducers);
386 m_baseTrackProducers.clear();
387 if (m_thumbProd) m_thumbProd->clearProducer();
390 void DocClipBase::setProducer(Mlt::Producer *producer) {
391 if (producer == NULL) return;
392 QString id = producer->get("id");
393 if (id.contains('_')) {
394 // this is a subtrack producer, insert it at correct place
395 int pos = id.section('_', 1, 1).toInt();
396 if (pos >= m_baseTrackProducers.count()) {
397 while (m_baseTrackProducers.count() - 1 < pos) {
398 m_baseTrackProducers.append(NULL);
401 if (m_baseTrackProducers.at(pos) == NULL) m_baseTrackProducers[pos] = producer;
403 if (m_baseTrackProducers.isEmpty()) m_baseTrackProducers.append(producer);
404 else if (m_baseTrackProducers.at(0) == NULL) m_baseTrackProducers[0] = producer;
406 //m_clipProducer = producer;
407 //m_clipProducer->set("transparency", m_properties.value("transparency").toInt());
408 if (m_thumbProd && !m_thumbProd->hasProducer()) m_thumbProd->setProducer(producer);
411 Mlt::Producer *DocClipBase::producer(int track) {
412 /*for (int i = 0; i < m_baseTrackProducers.count(); i++) {
413 if (m_baseTrackProducers.at(i)) kDebug() << "// PROD: " << i << ", ID: " << m_baseTrackProducers.at(i)->get("id");
415 if (track == -1 || (m_clipType != AUDIO && m_clipType != AV)) {
416 if (m_baseTrackProducers.count() == 0) return NULL;
418 for (int i = 0; i < m_baseTrackProducers.count(); i++) {
419 if (m_baseTrackProducers.at(i) != NULL)
420 return m_baseTrackProducers.at(i);
424 if (track >= m_baseTrackProducers.count()) {
425 while (m_baseTrackProducers.count() - 1 < track) {
426 m_baseTrackProducers.append(NULL);
429 if (m_baseTrackProducers.at(track) == NULL) {
431 for (i = 0; i < m_baseTrackProducers.count(); i++)
432 if (m_baseTrackProducers.at(i) != NULL) break;
433 if (i >= m_baseTrackProducers.count()) return NULL;
434 m_baseTrackProducers[track] = new Mlt::Producer(*m_baseTrackProducers.at(i)->profile(), m_baseTrackProducers.at(i)->get("resource"));
435 if (m_properties.contains("force_aspect_ratio")) m_baseTrackProducers[track]->set("force_aspect_ratio", m_properties.value("force_aspect_ratio").toDouble());
436 if (m_properties.contains("threads")) m_baseTrackProducers[track]->set("threads", m_properties.value("threads").toInt());
437 if (m_properties.contains("video_index")) m_baseTrackProducers[track]->set("video_index", m_properties.value("video_index").toInt());
438 if (m_properties.contains("audio_index")) m_baseTrackProducers[track]->set("audio_index", m_properties.value("audio_index").toInt());
439 char *tmp = (char *) qstrdup(QString(getId() + '_' + QString::number(track)).toUtf8().data());
440 m_baseTrackProducers[track]->set("id", tmp);
442 if (KdenliveSettings::dropbframes() && m_baseTrackProducers.at(i)->get("skip_loop_filter") && strcmp(m_baseTrackProducers.at(i)->get("skip_loop_filter"), "all") == 0) {
443 m_baseTrackProducers[track]->set("skip_loop_filter", "all");
444 m_baseTrackProducers[track]->set("skip_frame", "bidir");
447 return m_baseTrackProducers.at(track);
450 void DocClipBase::setProducerProperty(const char *name, int data) {
451 for (int i = 0; i < m_baseTrackProducers.count(); i++) {
452 if (m_baseTrackProducers.at(i) != NULL)
453 m_baseTrackProducers[i]->set(name, data);
457 void DocClipBase::setProducerProperty(const char *name, const char *data) {
458 for (int i = 0; i < m_baseTrackProducers.count(); i++) {
459 if (m_baseTrackProducers.at(i) != NULL)
460 m_baseTrackProducers[i]->set(name, data);
464 const char *DocClipBase::producerProperty(const char *name) const {
465 for (int i = 0; i < m_baseTrackProducers.count(); i++) {
466 if (m_baseTrackProducers.at(i) != NULL) {
467 return m_baseTrackProducers.at(i)->get(name);
474 void DocClipBase::slotRefreshProducer() {
475 if (m_baseTrackProducers.count() == 0) return;
476 kDebug() << "//////////// REFRESH CLIP !!!!!!!!!!!!!!!!";
477 if (m_clipType == SLIDESHOW) {
478 /*char *tmp = (char *) qstrdup(getProperty("resource").toUtf8().data());
479 Mlt::Producer producer(*(m_clipProducer->profile()), tmp);
481 delete m_clipProducer;
482 m_clipProducer = new Mlt::Producer(producer.get_producer());
483 if (!getProperty("out").isEmpty()) m_clipProducer->set_in_and_out(getProperty("in").toInt(), getProperty("out").toInt());*/
484 setProducerProperty("ttl", getProperty("ttl").toInt());
485 //m_clipProducer->set("id", getProperty("id"));
486 if (getProperty("fade") == "1") {
487 // we want a fade filter effect
488 kDebug() << "//////////// FADE WANTED";
489 Mlt::Service clipService(m_baseTrackProducers.at(0)->get_service());
491 Mlt::Filter *filter = clipService.filter(ct);
493 if (filter->get("mlt_service") == "luma") {
497 filter = clipService.filter(ct);
500 if (filter && filter->get("mlt_service") == "luma") {
501 filter->set("period", getProperty("ttl").toInt() - 1);
502 filter->set("luma.out", getProperty("luma_duration").toInt());
503 QString resource = getProperty("luma_file");
504 char *tmp = (char *) qstrdup(resource.toUtf8().data());
505 filter->set("luma.resource", tmp);
507 if (getProperty("softness") != QString()) {
508 int soft = getProperty("softness").toInt();
509 filter->set("luma.softness", (double) soft / 100.0);
512 // filter does not exist, create it...
513 Mlt::Filter *filter = new Mlt::Filter(*(m_baseTrackProducers.at(0)->profile()), "luma");
514 filter->set("period", getProperty("ttl").toInt() - 1);
515 filter->set("luma.out", getProperty("luma_duration").toInt());
516 QString resource = getProperty("luma_file");
517 char *tmp = (char *) qstrdup(resource.toUtf8().data());
518 filter->set("luma.resource", tmp);
520 if (getProperty("softness") != QString()) {
521 int soft = getProperty("softness").toInt();
522 filter->set("luma.softness", (double) soft / 100.0);
524 clipService.attach(*filter);
527 kDebug() << "//////////// FADE NOT WANTED!!!";
528 Mlt::Service clipService(m_baseTrackProducers.at(0)->get_service());
530 Mlt::Filter *filter = clipService.filter(0);
532 if (filter->get("mlt_service") == "luma") {
533 clipService.detach(*filter);
535 filter = clipService.filter(ct);
541 void DocClipBase::setProperties(QMap <QString, QString> properties) {
542 // changing clip type is not allowed
543 properties.remove("type");
544 QMapIterator<QString, QString> i(properties);
545 bool refreshProducer = false;
547 keys << "luma_duration" << "luma_file" << "fade" << "ttl" << "softness";
548 while (i.hasNext()) {
550 setProperty(i.key(), i.value());
551 if (m_clipType == SLIDESHOW && keys.contains(i.key())) refreshProducer = true;
553 if (refreshProducer) slotRefreshProducer();
556 void DocClipBase::setMetadata(QMap <QString, QString> properties) {
557 m_metadata = properties;
560 QMap <QString, QString> DocClipBase::metadata() const {
564 void DocClipBase::clearProperty(const QString &key) {
565 m_properties.remove(key);
568 void DocClipBase::getFileHash(const QString &url) {
569 if (m_clipType == SLIDESHOW) return;
571 if (file.open(QIODevice::ReadOnly)) { // write size and hash only if resource points to a file
574 //kDebug() << "SETTING HASH of" << value;
575 m_properties.insert("file_size", QString::number(file.size()));
577 * 1 MB = 1 second per 450 files (or faster)
578 * 10 MB = 9 seconds per 450 files (or faster)
580 if (file.size() > 1000000*2) {
581 fileData = file.read(1000000);
582 if (file.seek(file.size() - 1000000))
583 fileData.append(file.readAll());
585 fileData = file.readAll();
587 fileHash = QCryptographicHash::hash(fileData, QCryptographicHash::Md5);
588 m_properties.insert("file_hash", QString(fileHash.toHex()));
589 //kDebug() << file.fileName() << file.size() << fileHash.toHex();
593 QString DocClipBase::getClipHash() const {
595 if (m_clipType == SLIDESHOW) hash = QCryptographicHash::hash(m_properties.value("resource").toAscii().data(), QCryptographicHash::Md5).toHex();
596 else if (m_clipType == COLOR) hash = QCryptographicHash::hash(m_properties.value("colour").toAscii().data(), QCryptographicHash::Md5).toHex();
597 else hash = m_properties.value("file_hash");
601 void DocClipBase::refreshThumbUrl() {
602 if (m_thumbProd) m_thumbProd->updateThumbUrl(m_properties.value("file_hash"));
605 void DocClipBase::setProperty(const QString &key, const QString &value) {
606 m_properties.insert(key, value);
607 if (key == "resource") {
609 if (m_thumbProd) m_thumbProd->updateClipUrl(KUrl(value), m_properties.value("file_hash"));
610 } else if (key == "out") setDuration(GenTime(value.toInt(), KdenliveSettings::project_fps()));
611 //else if (key == "transparency") m_clipProducer->set("transparency", value.toInt());
612 else if (key == "colour") {
613 char *tmp = (char *) qstrdup(value.toUtf8().data());
614 setProducerProperty("colour", tmp);
616 } else if (key == "xmldata") {
617 setProducerProperty("force_reload", 1);
618 } else if (key == "force_aspect_ratio") {
619 if (value.isEmpty()) {
620 m_properties.remove("force_aspect_ratio");
621 setProducerProperty("force_aspect_ratio", 0);
622 } else setProducerProperty("force_aspect_ratio", value.toDouble());
623 } else if (key == "threads") {
624 if (value.isEmpty()) {
625 m_properties.remove("threads");
626 setProducerProperty("threads", 1);
627 } else setProducerProperty("threads", value.toInt());
628 } else if (key == "video_index") {
629 if (value.isEmpty()) {
630 m_properties.remove("video_index");
631 setProducerProperty("video_index", m_properties.value("default_video").toInt());
632 } else setProducerProperty("video_index", value.toInt());
633 } else if (key == "audio_index") {
634 if (value.isEmpty()) {
635 m_properties.remove("audio_index");
636 setProducerProperty("audio_index", m_properties.value("default_audio").toInt());
637 } else setProducerProperty("audio_index", value.toInt());
641 QMap <QString, QString> DocClipBase::properties() const {
645 bool DocClipBase::slotGetAudioThumbs() {
646 if (m_thumbProd == NULL) return false;
647 if (!KdenliveSettings::audiothumbnails()) {
648 if (m_audioTimer != NULL) m_audioTimer->stop();
651 if (m_audioThumbCreated) {
652 if (m_audioTimer != NULL) m_audioTimer->stop();
655 if (m_audioTimer != NULL)
656 m_audioTimer->start(1500);
657 double lengthInFrames = duration().frames(KdenliveSettings::project_fps());
658 m_thumbProd->getAudioThumbs(2, 0, lengthInFrames /*must be number of frames*/, 20);