1 /***************************************************************************
2 * Copyright (C) 2007 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 "kdenlivedoc.h"
22 #include "docclipbase.h"
23 #include "profilesdialog.h"
24 #include "kdenlivesettings.h"
26 #include "clipmanager.h"
27 #include "titlewidget.h"
28 #include "mainwindow.h"
29 #include "documentchecker.h"
30 #include "documentvalidator.h"
31 #include "kdenlive-config.h"
34 #include <KStandardDirs>
35 #include <KMessageBox>
37 #include <KFileDialog>
38 #include <KIO/NetAccess>
39 #include <KIO/CopyJob>
40 #include <KApplication>
42 #include <QCryptographicHash>
44 #include <QInputDialog>
46 #include <mlt++/Mlt.h>
48 const double DOCUMENTVERSION = 0.84;
50 KdenliveDoc::KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, QString profileName, const QPoint tracks, Render *render, MainWindow *parent) :
55 m_commandStack(new QUndoStack(undoGroup)),
57 m_projectFolder(projectFolder),
58 m_documentLoadingStep(0.0),
59 m_documentLoadingProgress(0),
62 m_clipManager = new ClipManager(this);
63 m_autoSaveTimer = new QTimer(this);
64 m_autoSaveTimer->setSingleShot(true);
67 // init default document properties
68 m_documentProperties["zoom"] = "7";
69 m_documentProperties["verticalzoom"] = "1";
70 m_documentProperties["zonein"] = "0";
71 m_documentProperties["zoneout"] = "100";
75 success = KIO::NetAccess::download(url.path(), tmpFile, parent);
76 if (!success) // The file cannot be opened
77 KMessageBox::error(parent, KIO::NetAccess::lastErrorString());
81 success = m_document.setContent(&file, false, &errorMsg);
83 KIO::NetAccess::removeTempFile(tmpFile);
84 if (!success) // It is corrupted
85 KMessageBox::error(parent, errorMsg);
87 DocumentValidator validator(m_document);
88 success = validator.isProject();
89 if (!success) // It is not a project file
90 parent->slotGotProgressInfo(i18n("File %1 is not a Kdenlive project file.", m_url.path()), 100);
93 * Validate the file against the current version (upgrade
94 * and recover it if needed). It is NOT a passive operation
96 // TODO: backup the document or alert the user?
97 success = validator.validate(DOCUMENTVERSION);
98 if (success) { // Let the validator handle error messages
99 QDomElement mlt = m_document.firstChildElement("mlt");
100 QDomElement infoXml = mlt.firstChildElement("kdenlivedoc");
102 profileName = infoXml.attribute("profile");
103 m_projectFolder = KUrl(infoXml.attribute("projectfolder"));
104 QDomElement docproperties = infoXml.firstChildElement("documentproperties");
105 QDomNamedNodeMap props = docproperties.attributes();
106 for (int i = 0; i < props.count(); i++) {
107 m_documentProperties.insert(props.item(i).nodeName(), props.item(i).nodeValue());
111 QDomElement tracksinfo = infoXml.firstChildElement("tracksinfo");
112 TrackInfo projectTrack;
113 if (!tracksinfo.isNull()) {
114 QDomNodeList trackslist = tracksinfo.childNodes();
115 int maxchild = trackslist.count();
116 for (int k = 0; k < maxchild; k++) {
117 e = trackslist.at(k).toElement();
118 if (e.tagName() == "trackinfo") {
119 if (e.attribute("type") == "audio") projectTrack.type = AUDIOTRACK;
120 else projectTrack.type = VIDEOTRACK;
121 projectTrack.isMute = e.attribute("mute").toInt();
122 projectTrack.isBlind = e.attribute("blind").toInt();
123 projectTrack.isLocked = e.attribute("locked").toInt();
124 m_tracksList.append(projectTrack);
127 mlt.removeChild(tracksinfo);
129 QDomNodeList producers = m_document.elementsByTagName("producer");
130 QDomNodeList infoproducers = m_document.elementsByTagName("kdenlive_producer");
131 if (checkDocumentClips(infoproducers) == false) m_abortLoading = true;
132 const int max = producers.count();
133 const int infomax = infoproducers.count();
135 QDomNodeList folders = m_document.elementsByTagName("folder");
136 for (int i = 0; i < folders.count(); i++) {
137 e = folders.item(i).cloneNode().toElement();
138 m_clipManager->addFolder(e.attribute("id"), e.attribute("name"));
142 m_documentLoadingStep = 100.0 / (max + infomax + m_document.elementsByTagName("entry").count());
143 parent->slotGotProgressInfo(i18n("Loading project clips"), (int) m_documentLoadingProgress);
147 for (int i = 0; i < infomax && !m_abortLoading; i++) {
148 e = infoproducers.item(i).cloneNode().toElement();
149 if (m_documentLoadingStep > 0) {
150 m_documentLoadingProgress += m_documentLoadingStep;
151 parent->slotGotProgressInfo(QString(), (int) m_documentLoadingProgress);
152 //qApp->processEvents();
154 QString prodId = e.attribute("id");
155 if (!e.isNull() && prodId != "black" && !prodId.startsWith("slowmotion") && !m_abortLoading) {
156 e.setTagName("producer");
157 // Get MLT's original producer properties
159 for (int j = 0; j < max; j++) {
160 QDomElement o = producers.item(j).cloneNode().toElement();
161 QString origId = o.attribute("id").section('_', 0, 0);
162 if (origId == prodId) {
167 addClipInfo(e, orig, prodId);
168 kDebug() << "// KDENLIVE PRODUCER: " << prodId;
171 if (m_abortLoading) {
172 //parent->slotGotProgressInfo(i18n("File %1 is not a Kdenlive project file."), 100);
173 emit resetProjectList();
174 m_documentProperties.remove("position");
176 m_tracksList.clear();
177 kWarning() << "Aborted loading of: " << url.path();
178 m_document = createEmptyDocument(KdenliveSettings::videotracks(), KdenliveSettings::audiotracks());
179 setProfilePath(KdenliveSettings::default_profile());
180 m_clipManager->clear();
182 QDomElement markers = infoXml.firstChildElement("markers");
183 if (!markers.isNull()) {
184 QDomNodeList markerslist = markers.childNodes();
185 int maxchild = markerslist.count();
186 for (int k = 0; k < maxchild; k++) {
187 e = markerslist.at(k).toElement();
188 if (e.tagName() == "marker") {
189 m_clipManager->getClipById(e.attribute("id"))->addSnapMarker(GenTime(e.attribute("time").toDouble()), e.attribute("comment"));
192 infoXml.removeChild(markers);
194 setProfilePath(profileName);
195 setModified(validator.isModified());
196 kDebug() << "Reading file: " << url.path() << ", found clips: " << producers.count();
202 } else setProfilePath(profileName);
204 // Something went wrong, or a new file was requested: create a new project
206 setProfilePath(QString());
208 m_document = createEmptyDocument(tracks.x(), tracks.y());
211 // Set the video profile (empty == default)
213 // Make sure the project folder is usable
214 if (m_projectFolder.isEmpty() || !KIO::NetAccess::exists(m_projectFolder.path(), KIO::NetAccess::DestinationSide, parent)) {
215 KMessageBox::information(parent, i18n("Document project folder is invalid, setting it to the default one: %1", KdenliveSettings::defaultprojectfolder()));
216 m_projectFolder = KUrl(KdenliveSettings::defaultprojectfolder());
219 // Make sure that the necessary folders exist
220 KStandardDirs::makeDir(m_projectFolder.path(KUrl::AddTrailingSlash) + "titles/");
221 KStandardDirs::makeDir(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/");
222 KStandardDirs::makeDir(m_projectFolder.path(KUrl::AddTrailingSlash) + "ladspa/");
224 kDebug() << "Kdenlive document, init timecode: " << m_fps;
225 if (m_fps == 30000.0 / 1001.0) m_timecode.setFormat(30, true);
226 else m_timecode.setFormat((int) m_fps);
228 //kDebug() << "// SETTING SCENE LIST:\n\n" << m_document.toString();
229 connect(m_autoSaveTimer, SIGNAL(timeout()), this, SLOT(slotAutoSave()));
232 KdenliveDoc::~KdenliveDoc()
234 delete m_commandStack;
235 delete m_clipManager;
236 delete m_autoSaveTimer;
238 if (!m_autosave->fileName().isEmpty()) m_autosave->remove();
243 int KdenliveDoc::setSceneList()
245 if (m_render->setSceneList(m_document.toString(), m_documentProperties.value("position").toInt()) == -1) {
246 // INVALID MLT Consumer, something is wrong
249 m_documentProperties.remove("position");
250 // m_document xml is now useless, clear it
256 QDomDocument KdenliveDoc::createEmptyDocument(const int videotracks, const int audiotracks)
258 // Creating new document
260 QDomElement mlt = doc.createElement("mlt");
261 doc.appendChild(mlt);
264 TrackInfo videoTrack;
265 videoTrack.type = VIDEOTRACK;
266 videoTrack.isMute = false;
267 videoTrack.isBlind = false;
268 videoTrack.isLocked = false;
270 TrackInfo audioTrack;
271 audioTrack.type = AUDIOTRACK;
272 audioTrack.isMute = false;
273 audioTrack.isBlind = true;
274 audioTrack.isLocked = false;
276 QDomElement tractor = doc.createElement("tractor");
277 tractor.setAttribute("id", "maintractor");
278 QDomElement multitrack = doc.createElement("multitrack");
279 QDomElement playlist = doc.createElement("playlist");
280 playlist.setAttribute("id", "black_track");
281 mlt.appendChild(playlist);
285 int total = audiotracks + videotracks + 1;
287 for (int i = 1; i < total; i++) {
288 QDomElement playlist = doc.createElement("playlist");
289 playlist.setAttribute("id", "playlist" + QString::number(i));
290 mlt.appendChild(playlist);
293 QDomElement track0 = doc.createElement("track");
294 track0.setAttribute("producer", "black_track");
295 tractor.appendChild(track0);
297 // create audio tracks
298 for (int i = 1; i < audiotracks + 1; i++) {
299 QDomElement track = doc.createElement("track");
300 track.setAttribute("producer", "playlist" + QString::number(i));
301 track.setAttribute("hide", "video");
302 tractor.appendChild(track);
303 m_tracksList.append(audioTrack);
306 // create video tracks
307 for (int i = audiotracks + 1; i < total; i++) {
308 QDomElement track = doc.createElement("track");
309 track.setAttribute("producer", "playlist" + QString::number(i));
310 tractor.appendChild(track);
311 m_tracksList.append(videoTrack);
314 for (int i = 2; i < total ; i++) {
315 QDomElement transition = doc.createElement("transition");
316 transition.setAttribute("always_active", "1");
318 QDomElement property = doc.createElement("property");
319 property.setAttribute("name", "a_track");
320 QDomText value = doc.createTextNode(QString::number(1));
321 property.appendChild(value);
322 transition.appendChild(property);
324 property = doc.createElement("property");
325 property.setAttribute("name", "b_track");
326 value = doc.createTextNode(QString::number(i));
327 property.appendChild(value);
328 transition.appendChild(property);
330 property = doc.createElement("property");
331 property.setAttribute("name", "mlt_service");
332 value = doc.createTextNode("mix");
333 property.appendChild(value);
334 transition.appendChild(property);
336 property = doc.createElement("property");
337 property.setAttribute("name", "combine");
338 value = doc.createTextNode("1");
339 property.appendChild(value);
340 transition.appendChild(property);
342 property = doc.createElement("property");
343 property.setAttribute("name", "internal_added");
344 value = doc.createTextNode("237");
345 property.appendChild(value);
346 transition.appendChild(property);
347 tractor.appendChild(transition);
349 mlt.appendChild(tractor);
354 void KdenliveDoc::syncGuides(QList <Guide *> guides)
357 QDomElement guideNode = m_guidesXml.createElement("guides");
358 m_guidesXml.appendChild(guideNode);
361 for (int i = 0; i < guides.count(); i++) {
362 e = m_guidesXml.createElement("guide");
363 e.setAttribute("time", guides.at(i)->position().ms() / 1000);
364 e.setAttribute("comment", guides.at(i)->label());
365 guideNode.appendChild(e);
368 emit guidesUpdated();
371 QDomElement KdenliveDoc::guidesXml() const
373 return m_guidesXml.documentElement();
376 void KdenliveDoc::slotAutoSave()
378 if (m_render && m_autosave) {
379 if (!m_autosave->isOpen() && !m_autosave->open(QIODevice::ReadWrite)) {
380 // show error: could not open the autosave file
381 kDebug() << "ERROR; CANNOT CREATE AUTOSAVE FILE";
383 kDebug() << "// AUTOSAVE FILE: " << m_autosave->fileName();
385 if (KdenliveSettings::dropbframes()) {
386 KdenliveSettings::setDropbframes(false);
387 m_clipManager->updatePreviewSettings();
388 doc = m_render->sceneList();
389 KdenliveSettings::setDropbframes(true);
390 m_clipManager->updatePreviewSettings();
391 } else doc = m_render->sceneList();
392 saveSceneList(m_autosave->fileName(), doc);
396 void KdenliveDoc::setZoom(int horizontal, int vertical)
398 m_documentProperties["zoom"] = QString::number(horizontal);
399 m_documentProperties["verticalzoom"] = QString::number(vertical);
402 QPoint KdenliveDoc::zoom() const
404 return QPoint(m_documentProperties.value("zoom").toInt(), m_documentProperties.value("verticalzoom").toInt());
407 void KdenliveDoc::setZone(int start, int end)
409 m_documentProperties["zonein"] = QString::number(start);
410 m_documentProperties["zoneout"] = QString::number(end);
413 QPoint KdenliveDoc::zone() const
415 return QPoint(m_documentProperties.value("zonein").toInt(), m_documentProperties.value("zoneout").toInt());
418 bool KdenliveDoc::saveSceneList(const QString &path, const QString &scene)
420 QDomDocument sceneList;
421 sceneList.setContent(scene, true);
422 QDomElement mlt = sceneList.firstChildElement("mlt");
423 QDomElement addedXml = sceneList.createElement("kdenlivedoc");
424 mlt.appendChild(addedXml);
426 QDomElement markers = sceneList.createElement("markers");
427 addedXml.setAttribute("version", DOCUMENTVERSION);
428 addedXml.setAttribute("kdenliveversion", VERSION);
429 addedXml.setAttribute("profile", profilePath());
430 addedXml.setAttribute("projectfolder", m_projectFolder.path());
432 QDomElement docproperties = sceneList.createElement("documentproperties");
433 QMapIterator<QString, QString> i(m_documentProperties);
434 while (i.hasNext()) {
436 docproperties.setAttribute(i.key(), i.value());
438 docproperties.setAttribute("position", m_render->seekPosition().frames(m_fps));
439 addedXml.appendChild(docproperties);
442 QDomElement profileinfo = sceneList.createElement("profileinfo");
443 profileinfo.setAttribute("description", m_profile.description);
444 profileinfo.setAttribute("frame_rate_num", m_profile.frame_rate_num);
445 profileinfo.setAttribute("frame_rate_den", m_profile.frame_rate_den);
446 profileinfo.setAttribute("width", m_profile.width);
447 profileinfo.setAttribute("height", m_profile.height);
448 profileinfo.setAttribute("progressive", m_profile.progressive);
449 profileinfo.setAttribute("sample_aspect_num", m_profile.sample_aspect_num);
450 profileinfo.setAttribute("sample_aspect_den", m_profile.sample_aspect_den);
451 profileinfo.setAttribute("display_aspect_num", m_profile.display_aspect_num);
452 profileinfo.setAttribute("display_aspect_den", m_profile.display_aspect_den);
453 addedXml.appendChild(profileinfo);
456 QDomElement tracksinfo = sceneList.createElement("tracksinfo");
457 foreach(const TrackInfo &info, m_tracksList) {
458 QDomElement trackinfo = sceneList.createElement("trackinfo");
459 if (info.type == AUDIOTRACK) trackinfo.setAttribute("type", "audio");
460 trackinfo.setAttribute("mute", info.isMute);
461 trackinfo.setAttribute("blind", info.isBlind);
462 trackinfo.setAttribute("locked", info.isLocked);
463 tracksinfo.appendChild(trackinfo);
465 addedXml.appendChild(tracksinfo);
467 // save project folders
468 QMap <QString, QString> folderlist = m_clipManager->documentFolderList();
470 QMapIterator<QString, QString> f(folderlist);
471 while (f.hasNext()) {
473 QDomElement folder = sceneList.createElement("folder");
474 folder.setAttribute("id", f.key());
475 folder.setAttribute("name", f.value());
476 addedXml.appendChild(folder);
479 // Save project clips
481 QList <DocClipBase*> list = m_clipManager->documentClipList();
482 for (int i = 0; i < list.count(); i++) {
483 e = list.at(i)->toXML();
484 e.setTagName("kdenlive_producer");
485 addedXml.appendChild(sceneList.importNode(e, true));
486 QList < CommentedTime > marks = list.at(i)->commentedSnapMarkers();
487 for (int j = 0; j < marks.count(); j++) {
488 QDomElement marker = sceneList.createElement("marker");
489 marker.setAttribute("time", marks.at(j).time().ms() / 1000);
490 marker.setAttribute("comment", marks.at(j).comment());
491 marker.setAttribute("id", e.attribute("id"));
492 markers.appendChild(marker);
495 addedXml.appendChild(markers);
498 if (!m_guidesXml.isNull()) addedXml.appendChild(sceneList.importNode(m_guidesXml.documentElement(), true));
501 addedXml.appendChild(sceneList.importNode(m_clipManager->groupsXml(), true));
503 //wes.appendChild(doc.importNode(kdenliveData, true));
506 if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {
507 kWarning() << "////// ERROR writing to file: " << path;
508 KMessageBox::error(kapp->activeWindow(), i18n("Cannot write to file %1", path));
512 file.write(sceneList.toString().toUtf8());
513 if (file.error() != QFile::NoError) {
514 KMessageBox::error(kapp->activeWindow(), i18n("Cannot write to file %1", path));
522 ClipManager *KdenliveDoc::clipManager()
524 return m_clipManager;
527 KUrl KdenliveDoc::projectFolder() const
529 //if (m_projectFolder.isEmpty()) return KUrl(KStandardDirs::locateLocal("appdata", "/projects/"));
530 return m_projectFolder;
533 void KdenliveDoc::setProjectFolder(KUrl url)
535 if (url == m_projectFolder) return;
537 KStandardDirs::makeDir(url.path());
538 KStandardDirs::makeDir(url.path(KUrl::AddTrailingSlash) + "titles/");
539 KStandardDirs::makeDir(url.path(KUrl::AddTrailingSlash) + "thumbs/");
540 if (KMessageBox::questionYesNo(kapp->activeWindow(), i18n("You have changed the project folder. Do you want to copy the cached data from %1 to the new folder %2?").arg(m_projectFolder.path(), url.path())) == KMessageBox::Yes) moveProjectData(url);
541 m_projectFolder = url;
544 void KdenliveDoc::moveProjectData(KUrl url)
546 QList <DocClipBase*> list = m_clipManager->documentClipList();
547 //TODO: Also move ladspa effects files
548 for (int i = 0; i < list.count(); i++) {
549 DocClipBase *clip = list.at(i);
550 if (clip->clipType() == TEXT) {
551 // the image for title clip must be moved
552 KUrl oldUrl = clip->fileURL();
553 KUrl newUrl = KUrl(url.path(KUrl::AddTrailingSlash) + "titles/" + oldUrl.fileName());
554 KIO::Job *job = KIO::copy(oldUrl, newUrl);
555 if (KIO::NetAccess::synchronousRun(job, 0)) clip->setProperty("resource", newUrl.path());
557 QString hash = clip->getClipHash();
558 KUrl oldVideoThumbUrl = KUrl(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".png");
559 KUrl oldAudioThumbUrl = KUrl(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".thumb");
560 if (KIO::NetAccess::exists(oldVideoThumbUrl, KIO::NetAccess::SourceSide, 0)) {
561 KUrl newUrl = KUrl(url.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".png");
562 KIO::Job *job = KIO::copy(oldVideoThumbUrl, newUrl);
563 KIO::NetAccess::synchronousRun(job, 0);
565 if (KIO::NetAccess::exists(oldAudioThumbUrl, KIO::NetAccess::SourceSide, 0)) {
566 KUrl newUrl = KUrl(url.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".thumb");
567 KIO::Job *job = KIO::copy(oldAudioThumbUrl, newUrl);
568 if (KIO::NetAccess::synchronousRun(job, 0)) clip->refreshThumbUrl();
573 const QString &KdenliveDoc::profilePath() const
575 return m_profile.path;
578 MltVideoProfile KdenliveDoc::mltProfile() const
583 void KdenliveDoc::setProfilePath(QString path)
585 if (path.isEmpty()) path = KdenliveSettings::default_profile();
586 if (path.isEmpty()) path = "dv_pal";
587 m_profile = ProfilesDialog::getVideoProfile(path);
588 if (m_profile.path.isEmpty()) {
589 // Profile not found, use embedded profile
590 QDomElement profileInfo = m_document.elementsByTagName("profileinfo").at(0).toElement();
591 if (profileInfo.isNull()) {
592 KMessageBox::information(kapp->activeWindow(), i18n("Project profile was not found, using default profile."), i18n("Missing Profile"));
593 m_profile = ProfilesDialog::getVideoProfile(KdenliveSettings::default_profile());
595 m_profile.description = profileInfo.attribute("description");
596 m_profile.frame_rate_num = profileInfo.attribute("frame_rate_num").toInt();
597 m_profile.frame_rate_den = profileInfo.attribute("frame_rate_den").toInt();
598 m_profile.width = profileInfo.attribute("width").toInt();
599 m_profile.height = profileInfo.attribute("height").toInt();
600 m_profile.progressive = profileInfo.attribute("progressive").toInt();
601 m_profile.sample_aspect_num = profileInfo.attribute("sample_aspect_num").toInt();
602 m_profile.sample_aspect_den = profileInfo.attribute("sample_aspect_den").toInt();
603 m_profile.display_aspect_num = profileInfo.attribute("display_aspect_num").toInt();
604 m_profile.display_aspect_den = profileInfo.attribute("display_aspect_den").toInt();
605 QString existing = ProfilesDialog::existingProfile(m_profile);
606 if (!existing.isEmpty()) {
607 m_profile = ProfilesDialog::getVideoProfile(existing);
608 KMessageBox::information(kapp->activeWindow(), i18n("Project profile not found, replacing with existing one: %1", m_profile.description), i18n("Missing Profile"));
610 QString newDesc = m_profile.description;
612 while (ok && (newDesc.isEmpty() || ProfilesDialog::existingProfileDescription(newDesc))) {
613 newDesc = QInputDialog::getText(kapp->activeWindow(), i18n("Existing Profile"), i18n("Your project uses an unknown profile.\nIt uses an existing profile name: %1.\nPlease choose a new name to save it", newDesc), QLineEdit::Normal, newDesc, &ok);
616 // User canceled, use default profile
617 m_profile = ProfilesDialog::getVideoProfile(KdenliveSettings::default_profile());
619 if (newDesc != m_profile.description) {
620 // Profile description existed, was replaced by new one
621 m_profile.description = newDesc;
623 KMessageBox::information(kapp->activeWindow(), i18n("Project profile was not found, it will be added to your system now."), i18n("Missing Profile"));
625 ProfilesDialog::saveProfile(m_profile);
632 KdenliveSettings::setProject_display_ratio((double) m_profile.display_aspect_num / m_profile.display_aspect_den);
633 m_fps = (double) m_profile.frame_rate_num / m_profile.frame_rate_den;
634 KdenliveSettings::setProject_fps(m_fps);
635 m_width = m_profile.width;
636 m_height = m_profile.height;
637 kDebug() << "Kdenlive document, init timecode from path: " << path << ", " << m_fps;
638 if (m_fps == 30000.0 / 1001.0) m_timecode.setFormat(30, true);
639 else m_timecode.setFormat((int) m_fps);
642 double KdenliveDoc::dar()
644 return (double) m_profile.display_aspect_num / m_profile.display_aspect_den;
647 void KdenliveDoc::setThumbsProgress(const QString &message, int progress)
649 emit progressInfo(message, progress);
652 void KdenliveDoc::loadingProgressed()
654 m_documentLoadingProgress += m_documentLoadingStep;
655 emit progressInfo(QString(), (int) m_documentLoadingProgress);
658 QUndoStack *KdenliveDoc::commandStack()
660 return m_commandStack;
664 void KdenliveDoc::setRenderer(Render *render) {
665 if (m_render) return;
667 emit progressInfo(i18n("Loading playlist..."), 0);
668 //qApp->processEvents();
670 m_render->setSceneList(m_document.toString(), m_startPos);
671 kDebug() << "// SETTING SCENE LIST:\n\n" << m_document.toString();
674 emit progressInfo(QString(), -1);
677 void KdenliveDoc::checkProjectClips()
679 kDebug() << "+++++++++++++ + + + + CHK PCLIPS";
680 if (m_render == NULL) return;
681 m_clipManager->resetProducersList(m_render->producersList());
684 void KdenliveDoc::updatePreviewSettings()
686 m_clipManager->updatePreviewSettings();
687 m_render->updatePreviewSettings();
688 m_clipManager->resetProducersList(m_render->producersList());
692 Render *KdenliveDoc::renderer()
697 void KdenliveDoc::updateClip(const QString &id)
699 emit updateClipDisplay(id);
702 int KdenliveDoc::getFramePos(QString duration)
704 return m_timecode.getFrameCount(duration, m_fps);
707 QString KdenliveDoc::producerName(const QString &id)
709 QString result = "unnamed";
710 QDomNodeList prods = producersList();
711 int ct = prods.count();
712 for (int i = 0; i < ct ; i++) {
713 QDomElement e = prods.item(i).toElement();
714 if (e.attribute("id") != "black" && e.attribute("id") == id) {
715 result = e.attribute("name");
716 if (result.isEmpty()) result = KUrl(e.attribute("resource")).fileName();
723 QDomDocument KdenliveDoc::toXml()
728 Timecode KdenliveDoc::timecode() const
733 QDomNodeList KdenliveDoc::producersList()
735 return m_document.elementsByTagName("producer");
738 double KdenliveDoc::projectDuration() const
741 return GenTime(m_render->getLength(), m_fps).ms() / 1000;
746 double KdenliveDoc::fps() const
751 int KdenliveDoc::width() const
756 int KdenliveDoc::height() const
761 KUrl KdenliveDoc::url() const
766 void KdenliveDoc::setUrl(KUrl url)
771 void KdenliveDoc::setModified(bool mod)
773 if (!m_url.isEmpty() && mod && KdenliveSettings::crashrecovery()) {
774 m_autoSaveTimer->start(3000);
776 if (mod == m_modified) return;
778 emit docModified(m_modified);
781 bool KdenliveDoc::isModified() const
786 const QString KdenliveDoc::description() const
789 return i18n("Untitled") + " / " + m_profile.description;
791 return m_url.fileName() + " / " + m_profile.description;
794 void KdenliveDoc::addClip(QDomElement elem, QString clipId, bool createClipItem)
796 const QString producerId = clipId.section('_', 0, 0);
797 DocClipBase *clip = m_clipManager->getClipById(producerId);
800 elem.setAttribute("id", producerId);
801 QString path = elem.attribute("resource");
803 if (elem.attribute("type").toInt() == SLIDESHOW) {
804 extension = KUrl(path).fileName();
805 path = KUrl(path).directory();
806 } else if (elem.attribute("type").toInt() == TEXT && QFile::exists(path) == false) {
807 kDebug() << "// TITLE: " << elem.attribute("name") << " Preview file: " << elem.attribute("resource") << " DOES NOT EXIST";
808 QString titlename = elem.attribute("name");
809 QString titleresource;
810 if (titlename.isEmpty()) {
811 QStringList titleInfo = TitleWidget::getFreeTitleInfo(projectFolder());
812 titlename = titleInfo.at(0);
813 titleresource = titleInfo.at(1);
814 elem.setAttribute("name", titlename);
815 kDebug() << "// New title set to: " << titlename;
817 titleresource = TitleWidget::getFreeTitleInfo(projectFolder()).at(1);
818 //titleresource = TitleWidget::getTitleResourceFromName(projectFolder(), titlename);
820 TitleWidget *dia_ui = new TitleWidget(KUrl(), KUrl(titleresource).directory(), m_render, kapp->activeWindow());
822 doc.setContent(elem.attribute("xmldata"));
824 QImage pix = dia_ui->renderedPixmap();
825 pix.save(titleresource);
826 elem.setAttribute("resource", titleresource);
827 setNewClipResource(clipId, titleresource);
831 if (path.isEmpty() == false && QFile::exists(path) == false && elem.attribute("type").toInt() != TEXT && !elem.hasAttribute("placeholder")) {
832 kDebug() << "// FOUND MISSING CLIP: " << path << ", TYPE: " << elem.attribute("type").toInt();
833 const QString size = elem.attribute("file_size");
834 const QString hash = elem.attribute("file_hash");
836 int action = KMessageBox::No;
837 if (!size.isEmpty() && !hash.isEmpty()) {
838 if (!m_searchFolder.isEmpty()) newpath = searchFileRecursively(m_searchFolder, size, hash);
839 else action = (KMessageBox::ButtonCode) KMessageBox::questionYesNoCancel(kapp->activeWindow(), i18n("Clip <b>%1</b><br>is invalid, what do you want to do?", path), i18n("File not found"), KGuiItem(i18n("Search automatically")), KGuiItem(i18n("Keep as placeholder")));
841 if (elem.attribute("type").toInt() == SLIDESHOW) {
842 int res = KMessageBox::questionYesNoCancel(kapp->activeWindow(), i18n("Clip <b>%1</b><br>is invalid or missing, what do you want to do?", path), i18n("File not found"), KGuiItem(i18n("Search manually")), KGuiItem(i18n("Keep as placeholder")));
843 if (res == KMessageBox::Yes)
844 newpath = KFileDialog::getExistingDirectory(KUrl("kfiledialog:///clipfolder"), kapp->activeWindow(), i18n("Looking for %1", path));
846 // Abort project loading
850 int res = KMessageBox::questionYesNoCancel(kapp->activeWindow(), i18n("Clip <b>%1</b><br>is invalid or missing, what do you want to do?", path), i18n("File not found"), KGuiItem(i18n("Search manually")), KGuiItem(i18n("Keep as placeholder")));
851 if (res == KMessageBox::Yes)
852 newpath = KFileDialog::getOpenFileName(KUrl("kfiledialog:///clipfolder"), QString(), kapp->activeWindow(), i18n("Looking for %1", path));
854 // Abort project loading
859 if (action == KMessageBox::Yes) {
860 kDebug() << "// ASKED FOR SRCH CLIP: " << clipId;
861 m_searchFolder = KFileDialog::getExistingDirectory(KUrl("kfiledialog:///clipfolder"), kapp->activeWindow());
862 if (!m_searchFolder.isEmpty()) {
863 newpath = searchFileRecursively(QDir(m_searchFolder), size, hash);
865 } else if (action == KMessageBox::Cancel) {
866 m_abortLoading = true;
868 } else if (action == KMessageBox::No) {
869 // Keep clip as placeHolder
870 elem.setAttribute("placeholder", '1');
872 if (!newpath.isEmpty()) {
873 if (elem.attribute("type").toInt() == SLIDESHOW) newpath.append('/' + extension);
874 elem.setAttribute("resource", newpath);
875 setNewClipResource(clipId, newpath);
879 clip = new DocClipBase(m_clipManager, elem, producerId);
880 m_clipManager->addClip(clip);
883 if (createClipItem) {
884 emit addProjectClip(clip);
885 qApp->processEvents();
886 m_render->getFileProperties(clip->toXML(), clip->getId(), true);
891 void KdenliveDoc::setNewClipResource(const QString &id, const QString &path)
893 QDomNodeList prods = m_document.elementsByTagName("producer");
894 int maxprod = prods.count();
895 for (int i = 0; i < maxprod; i++) {
896 QDomNode m = prods.at(i);
897 QString prodId = m.toElement().attribute("id");
898 if (prodId == id || prodId.startsWith(id + '_')) {
899 QDomNodeList params = m.childNodes();
900 for (int j = 0; j < params.count(); j++) {
901 QDomElement e = params.item(j).toElement();
902 if (e.attribute("name") == "resource") {
903 e.firstChild().setNodeValue(path);
911 QString KdenliveDoc::searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const
913 QString foundFileName;
916 QStringList filesAndDirs = dir.entryList(QDir::Files | QDir::Readable);
917 for (int i = 0; i < filesAndDirs.size() && foundFileName.isEmpty(); i++) {
918 QFile file(dir.absoluteFilePath(filesAndDirs.at(i)));
919 if (file.open(QIODevice::ReadOnly)) {
920 if (QString::number(file.size()) == matchSize) {
922 * 1 MB = 1 second per 450 files (or faster)
923 * 10 MB = 9 seconds per 450 files (or faster)
925 if (file.size() > 1000000*2) {
926 fileData = file.read(1000000);
927 if (file.seek(file.size() - 1000000))
928 fileData.append(file.readAll());
930 fileData = file.readAll();
932 fileHash = QCryptographicHash::hash(fileData, QCryptographicHash::Md5);
933 if (QString(fileHash.toHex()) == matchHash)
934 return file.fileName();
937 kDebug() << filesAndDirs.at(i) << file.size() << fileHash.toHex();
939 filesAndDirs = dir.entryList(QDir::Dirs | QDir::Readable | QDir::Executable | QDir::NoDotAndDotDot);
940 for (int i = 0; i < filesAndDirs.size() && foundFileName.isEmpty(); i++) {
941 foundFileName = searchFileRecursively(dir.absoluteFilePath(filesAndDirs.at(i)), matchSize, matchHash);
942 if (!foundFileName.isEmpty())
945 return foundFileName;
948 void KdenliveDoc::addClipInfo(QDomElement elem, QDomElement orig, QString clipId)
950 DocClipBase *clip = m_clipManager->getClipById(clipId);
952 addClip(elem, clipId, false);
954 QMap <QString, QString> properties;
955 QDomNamedNodeMap attributes = elem.attributes();
957 for (int i = 0; i < attributes.count(); i++) {
958 attrname = attributes.item(i).nodeName();
959 if (attrname != "resource")
960 properties.insert(attrname, attributes.item(i).nodeValue());
961 kDebug() << attrname << " = " << attributes.item(i).nodeValue();
963 clip->setProperties(properties);
964 emit addProjectClip(clip, false);
966 if (orig != QDomElement()) {
967 QMap<QString, QString> meta;
968 QDomNode m = orig.firstChild();
969 while (!m.isNull()) {
970 QString name = m.toElement().attribute("name");
971 if (name.startsWith("meta.attr")) {
972 meta.insert(name.section('.', 2, 3), m.firstChild().nodeValue());
976 if (!meta.isEmpty()) {
977 if (clip == NULL) clip = m_clipManager->getClipById(clipId);
978 if (clip) clip->setMetadata(meta);
983 void KdenliveDoc::deleteProjectClip(QList <QString> ids)
985 for (int i = 0; i < ids.size(); ++i) {
986 emit deleteTimelineClip(ids.at(i));
987 m_clipManager->slotDeleteClip(ids.at(i));
992 void KdenliveDoc::deleteClip(const QString &clipId)
994 emit signalDeleteProjectClip(clipId);
995 m_clipManager->deleteClip(clipId);
998 void KdenliveDoc::slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId)
1000 m_clipManager->slotAddClipList(urls, group, groupId);
1001 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1006 void KdenliveDoc::slotAddClipFile(const KUrl url, const QString group, const QString &groupId)
1008 m_clipManager->slotAddClipFile(url, group, groupId);
1009 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1013 const QString KdenliveDoc::getFreeClipId()
1015 return QString::number(m_clipManager->getFreeClipId());
1018 DocClipBase *KdenliveDoc::getBaseClip(const QString &clipId)
1020 return m_clipManager->getClipById(clipId);
1023 void KdenliveDoc::slotCreateColorClip(const QString &name, const QString &color, const QString &duration, QString group, const QString &groupId)
1025 m_clipManager->slotAddColorClipFile(name, color, duration, group, groupId);
1027 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1030 void KdenliveDoc::slotCreateSlideshowClipFile(const QString name, const QString path, int count, const QString duration, const bool loop, const bool fade, const QString &luma_duration, const QString &luma_file, const int softness, QString group, const QString &groupId)
1032 m_clipManager->slotAddSlideshowClipFile(name, path, count, duration, loop, fade, luma_duration, luma_file, softness, group, groupId);
1034 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1037 void KdenliveDoc::slotCreateTextClip(QString group, const QString &groupId, const QString &templatePath)
1039 QString titlesFolder = projectFolder().path(KUrl::AddTrailingSlash) + "titles/";
1040 KStandardDirs::makeDir(titlesFolder);
1041 TitleWidget *dia_ui = new TitleWidget(templatePath, titlesFolder, m_render, kapp->activeWindow());
1042 if (dia_ui->exec() == QDialog::Accepted) {
1043 QStringList titleInfo = TitleWidget::getFreeTitleInfo(projectFolder());
1044 QImage pix = dia_ui->renderedPixmap();
1045 pix.save(titleInfo.at(1));
1046 //dia_ui->saveTitle(path + ".kdenlivetitle");
1047 m_clipManager->slotAddTextClipFile(titleInfo.at(0), titleInfo.at(1), dia_ui->xml().toString(), group, groupId);
1049 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1054 void KdenliveDoc::slotCreateTextTemplateClip(QString group, const QString &groupId, KUrl path)
1056 QString titlesFolder = projectFolder().path(KUrl::AddTrailingSlash) + "titles/";
1057 if (path.isEmpty()) {
1058 path = KFileDialog::getOpenUrl(KUrl(titlesFolder), "*.kdenlivetitle", kapp->activeWindow(), i18n("Enter Template Path"));
1061 if (path.isEmpty()) return;
1063 QStringList titleInfo = TitleWidget::getFreeTitleInfo(projectFolder(), true);
1065 TitleWidget *dia_ui = new TitleWidget(path, titlesFolder, m_render, kapp->activeWindow());
1066 QImage pix = dia_ui->renderedPixmap();
1067 pix.save(titleInfo.at(1));
1069 m_clipManager->slotAddTextTemplateClip(titleInfo.at(0), titleInfo.at(1), path, group, groupId);
1071 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1074 int KdenliveDoc::tracksCount() const
1076 return m_tracksList.count();
1079 TrackInfo KdenliveDoc::trackInfoAt(int ix) const
1081 return m_tracksList.at(ix);
1084 void KdenliveDoc::switchTrackAudio(int ix, bool hide)
1086 m_tracksList[ix].isMute = hide; // !m_tracksList.at(ix).isMute;
1089 void KdenliveDoc::switchTrackLock(int ix, bool lock)
1091 m_tracksList[ix].isLocked = lock;
1094 bool KdenliveDoc::isTrackLocked(int ix) const
1096 return m_tracksList.at(ix).isLocked;
1099 void KdenliveDoc::switchTrackVideo(int ix, bool hide)
1101 m_tracksList[ix].isBlind = hide; // !m_tracksList.at(ix).isBlind;
1104 void KdenliveDoc::insertTrack(int ix, TrackInfo type)
1106 if (ix == -1) m_tracksList << type;
1107 else m_tracksList.insert(ix, type);
1110 void KdenliveDoc::deleteTrack(int ix)
1112 m_tracksList.removeAt(ix);
1115 void KdenliveDoc::setTrackType(int ix, TrackInfo type)
1117 m_tracksList[ix].type = type.type;
1118 m_tracksList[ix].isMute = type.isMute;
1119 m_tracksList[ix].isBlind = type.isBlind;
1120 m_tracksList[ix].isLocked = type.isLocked;
1123 const QList <TrackInfo> KdenliveDoc::tracksList() const
1125 return m_tracksList;
1128 QPoint KdenliveDoc::getTracksCount() const
1132 foreach(const TrackInfo &info, m_tracksList) {
1133 if (info.type == VIDEOTRACK) video++;
1136 return QPoint(video, audio);
1139 void KdenliveDoc::cachePixmap(const QString &fileId, const QPixmap &pix) const
1141 pix.save(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/" + fileId + ".png");
1144 QString KdenliveDoc::getLadspaFile() const
1147 QString counter = QString::number(ct).rightJustified(5, '0', false);
1148 while (QFile::exists(m_projectFolder.path(KUrl::AddTrailingSlash) + "ladspa/" + counter + ".ladspa")) {
1150 counter = QString::number(ct).rightJustified(5, '0', false);
1152 return m_projectFolder.path(KUrl::AddTrailingSlash) + "ladspa/" + counter + ".ladspa";
1155 bool KdenliveDoc::checkDocumentClips(QDomNodeList infoproducers)
1161 QList <QDomElement> missingClips;
1162 for (int i = 0; i < infoproducers.count(); i++) {
1163 e = infoproducers.item(i).toElement();
1164 clipType = e.attribute("type").toInt();
1165 if (clipType == COLOR) continue;
1166 if (clipType == TEXT) {
1167 //TODO: Check is clip template is missing (xmltemplate) or hash changed
1170 id = e.attribute("id");
1171 resource = e.attribute("resource");
1172 if (clipType == SLIDESHOW) resource = KUrl(resource).directory();
1173 if (!KIO::NetAccess::exists(KUrl(resource), KIO::NetAccess::SourceSide, 0)) {
1174 // Missing clip found
1175 missingClips.append(e);
1177 // Check if the clip has changed
1178 if (clipType != SLIDESHOW && e.hasAttribute("file_hash")) {
1179 if (e.attribute("file_hash") != DocClipBase::getHash(e.attribute("resource")))
1180 e.removeAttribute("file_hash");
1184 if (missingClips.isEmpty()) return true;
1185 DocumentChecker d(missingClips, m_document);
1186 return (d.exec() == QDialog::Accepted);
1189 void KdenliveDoc::setDocumentProperty(const QString &name, const QString &value)
1191 m_documentProperties[name] = value;
1194 const QString KdenliveDoc::getDocumentProperty(const QString &name) const
1196 return m_documentProperties.value(name);
1199 #include "kdenlivedoc.moc"