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>
45 #include <QDomImplementation>
47 #include <mlt++/Mlt.h>
49 const double DOCUMENTVERSION = 0.85;
51 KdenliveDoc::KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, QString profileName, const QPoint tracks, Render *render, MainWindow *parent) :
56 m_commandStack(new QUndoStack(undoGroup)),
58 m_projectFolder(projectFolder),
61 m_clipManager = new ClipManager(this);
62 m_autoSaveTimer = new QTimer(this);
63 m_autoSaveTimer->setSingleShot(true);
66 // init default document properties
67 m_documentProperties["zoom"] = "7";
68 m_documentProperties["verticalzoom"] = "1";
69 m_documentProperties["zonein"] = "0";
70 m_documentProperties["zoneout"] = "100";
74 success = KIO::NetAccess::download(url.path(), tmpFile, parent);
75 if (!success) // The file cannot be opened
76 KMessageBox::error(parent, KIO::NetAccess::lastErrorString());
80 QDomImplementation impl;
81 impl.setInvalidDataPolicy(QDomImplementation::DropInvalidChars);
82 success = m_document.setContent(&file, false, &errorMsg);
84 KIO::NetAccess::removeTempFile(tmpFile);
86 if (!success) // It is corrupted
87 KMessageBox::error(parent, errorMsg);
89 parent->slotGotProgressInfo(i18n("Validating"), 0);
90 DocumentValidator validator(m_document);
91 success = validator.isProject();
93 // It is not a project file
94 parent->slotGotProgressInfo(i18n("File %1 is not a Kdenlive project file", m_url.path()), 0);
97 * Validate the file against the current version (upgrade
98 * and recover it if needed). It is NOT a passive operation
100 // TODO: backup the document or alert the user?
101 success = validator.validate(DOCUMENTVERSION);
102 if (success) { // Let the validator handle error messages
103 parent->slotGotProgressInfo(i18n("Loading"), 0);
104 QDomElement mlt = m_document.firstChildElement("mlt");
105 QDomElement infoXml = mlt.firstChildElement("kdenlivedoc");
107 profileName = infoXml.attribute("profile");
108 m_projectFolder = KUrl(infoXml.attribute("projectfolder"));
109 QDomElement docproperties = infoXml.firstChildElement("documentproperties");
110 QDomNamedNodeMap props = docproperties.attributes();
111 for (int i = 0; i < props.count(); i++) {
112 m_documentProperties.insert(props.item(i).nodeName(), props.item(i).nodeValue());
116 QDomElement tracksinfo = infoXml.firstChildElement("tracksinfo");
117 if (!tracksinfo.isNull()) {
118 QDomNodeList trackslist = tracksinfo.childNodes();
119 int maxchild = trackslist.count();
120 for (int k = 0; k < maxchild; k++) {
121 e = trackslist.at(k).toElement();
122 if (e.tagName() == "trackinfo") {
123 TrackInfo projectTrack;
124 if (e.attribute("type") == "audio") projectTrack.type = AUDIOTRACK;
125 else projectTrack.type = VIDEOTRACK;
126 projectTrack.isMute = e.attribute("mute").toInt();
127 projectTrack.isBlind = e.attribute("blind").toInt();
128 projectTrack.isLocked = e.attribute("locked").toInt();
129 projectTrack.trackName = e.attribute("trackname");
130 m_tracksList.append(projectTrack);
133 mlt.removeChild(tracksinfo);
135 QDomNodeList producers = m_document.elementsByTagName("producer");
136 QDomNodeList infoproducers = m_document.elementsByTagName("kdenlive_producer");
137 parent->slotGotProgressInfo(i18n("Check missing clips"), 0);
138 if (checkDocumentClips(infoproducers) == false) m_abortLoading = true;
139 const int max = producers.count();
140 const int infomax = infoproducers.count();
142 QDomNodeList folders = m_document.elementsByTagName("folder");
143 for (int i = 0; i < folders.count(); i++) {
144 e = folders.item(i).cloneNode().toElement();
145 m_clipManager->addFolder(e.attribute("id"), e.attribute("name"));
148 for (int i = 0; i < infomax && !m_abortLoading; i++) {
149 e = infoproducers.item(i).cloneNode().toElement();
150 QString prodId = e.attribute("id");
151 if (!e.isNull() && prodId != "black" && !prodId.startsWith("slowmotion") && !m_abortLoading) {
152 e.setTagName("producer");
153 // Get MLT's original producer properties
155 for (int j = 0; j < max; j++) {
156 QDomElement o = producers.item(j).cloneNode().toElement();
157 QString origId = o.attribute("id").section('_', 0, 0);
158 if (origId == prodId) {
163 addClipInfo(e, orig, prodId);
166 if (m_abortLoading) {
167 //parent->slotGotProgressInfo(i18n("File %1 is not a Kdenlive project file."), 100);
168 emit resetProjectList();
169 m_documentProperties.remove("position");
171 m_tracksList.clear();
172 kWarning() << "Aborted loading of: " << url.path();
173 m_document = createEmptyDocument(KdenliveSettings::videotracks(), KdenliveSettings::audiotracks());
174 setProfilePath(KdenliveSettings::default_profile());
175 m_clipManager->clear();
177 QDomElement markers = infoXml.firstChildElement("markers");
178 if (!markers.isNull()) {
179 QDomNodeList markerslist = markers.childNodes();
180 int maxchild = markerslist.count();
181 for (int k = 0; k < maxchild; k++) {
182 e = markerslist.at(k).toElement();
183 if (e.tagName() == "marker") {
184 m_clipManager->getClipById(e.attribute("id"))->addSnapMarker(GenTime(e.attribute("time").toDouble()), e.attribute("comment"));
187 infoXml.removeChild(markers);
189 setProfilePath(profileName);
190 setModified(validator.isModified());
191 kDebug() << "Reading file: " << url.path() << ", found clips: " << producers.count();
199 // Something went wrong, or a new file was requested: create a new project
201 setProfilePath(profileName);
203 m_document = createEmptyDocument(tracks.x(), tracks.y());
206 // Set the video profile (empty == default)
207 KdenliveSettings::setCurrent_profile(profilePath());
209 // Ask to create the project directory if it does not exist
210 if (!QFile::exists(m_projectFolder.path())) {
211 int create = KMessageBox::questionYesNo(parent, i18n("Project directory %1 does not exist. Create it?", m_projectFolder.path()));
212 if (create == KMessageBox::Yes) {
213 QDir projectDir(m_projectFolder.path());
214 bool ok = projectDir.mkpath(m_projectFolder.path());
216 KMessageBox::sorry(parent, i18n("The directory %1, could not be created.\nPlease make sure you have the required permissions.", m_projectFolder.path()));
221 // Make sure the project folder is usable
222 if (m_projectFolder.isEmpty() || !KIO::NetAccess::exists(m_projectFolder.path(), KIO::NetAccess::DestinationSide, parent)) {
223 KMessageBox::information(parent, i18n("Document project folder is invalid, setting it to the default one: %1", KdenliveSettings::defaultprojectfolder()));
224 m_projectFolder = KUrl(KdenliveSettings::defaultprojectfolder());
227 // Make sure that the necessary folders exist
228 KStandardDirs::makeDir(m_projectFolder.path(KUrl::AddTrailingSlash) + "titles/");
229 KStandardDirs::makeDir(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/");
230 KStandardDirs::makeDir(m_projectFolder.path(KUrl::AddTrailingSlash) + "ladspa/");
232 //kDebug() << "// SETTING SCENE LIST:\n\n" << m_document.toString();
233 connect(m_autoSaveTimer, SIGNAL(timeout()), this, SLOT(slotAutoSave()));
236 KdenliveDoc::~KdenliveDoc()
238 m_autoSaveTimer->stop();
239 delete m_commandStack;
240 kDebug() << "// DEL CLP MAN";
241 delete m_clipManager;
242 kDebug() << "// DEL CLP MAN done";
243 delete m_autoSaveTimer;
245 if (!m_autosave->fileName().isEmpty()) m_autosave->remove();
250 int KdenliveDoc::setSceneList()
252 m_render->resetProfile(KdenliveSettings::current_profile());
253 if (m_render->setSceneList(m_document.toString(), m_documentProperties.value("position").toInt()) == -1) {
254 // INVALID MLT Consumer, something is wrong
257 m_documentProperties.remove("position");
258 // m_document xml is now useless, clear it
263 QDomDocument KdenliveDoc::createEmptyDocument(int videotracks, int audiotracks)
265 m_tracksList.clear();
267 // Tracks are added «backwards», so we need to reverse the track numbering
268 // mbt 331: http://www.kdenlive.org/mantis/view.php?id=331
269 // Better default names for tracks: Audio 1 etc. instead of blank numbers
270 for (int i = 0; i < audiotracks; i++) {
271 TrackInfo audioTrack;
272 audioTrack.type = AUDIOTRACK;
273 audioTrack.isMute = false;
274 audioTrack.isBlind = true;
275 audioTrack.isLocked = false;
276 audioTrack.trackName = QString("Audio ") + QString::number(audiotracks - i);
277 m_tracksList.append(audioTrack);
280 for (int i = 0; i < videotracks; i++) {
281 TrackInfo videoTrack;
282 videoTrack.type = VIDEOTRACK;
283 videoTrack.isMute = false;
284 videoTrack.isBlind = false;
285 videoTrack.isLocked = false;
286 videoTrack.trackName = QString("Video ") + QString::number(videotracks - i);
287 m_tracksList.append(videoTrack);
289 return createEmptyDocument(m_tracksList);
292 QDomDocument KdenliveDoc::createEmptyDocument(QList <TrackInfo> tracks)
294 // Creating new document
296 QDomElement mlt = doc.createElement("mlt");
297 doc.appendChild(mlt);
300 // Create black producer
301 // For some unknown reason, we have to build the black producer here and not in renderer.cpp, otherwise
302 // the composite transitions with the black track are corrupted.
303 QDomElement blk = doc.createElement("producer");
304 blk.setAttribute("in", 0);
305 blk.setAttribute("out", 500);
306 blk.setAttribute("id", "black");
308 QDomElement property = doc.createElement("property");
309 property.setAttribute("name", "mlt_type");
310 QDomText value = doc.createTextNode("producer");
311 property.appendChild(value);
312 blk.appendChild(property);
314 property = doc.createElement("property");
315 property.setAttribute("name", "aspect_ratio");
316 value = doc.createTextNode(QString::number(0.0));
317 property.appendChild(value);
318 blk.appendChild(property);
320 property = doc.createElement("property");
321 property.setAttribute("name", "length");
322 value = doc.createTextNode(QString::number(15000));
323 property.appendChild(value);
324 blk.appendChild(property);
326 property = doc.createElement("property");
327 property.setAttribute("name", "eof");
328 value = doc.createTextNode("pause");
329 property.appendChild(value);
330 blk.appendChild(property);
332 property = doc.createElement("property");
333 property.setAttribute("name", "resource");
334 value = doc.createTextNode("black");
335 property.appendChild(value);
336 blk.appendChild(property);
338 property = doc.createElement("property");
339 property.setAttribute("name", "mlt_service");
340 value = doc.createTextNode("colour");
341 property.appendChild(value);
342 blk.appendChild(property);
344 mlt.appendChild(blk);
347 QDomElement tractor = doc.createElement("tractor");
348 tractor.setAttribute("id", "maintractor");
349 QDomElement multitrack = doc.createElement("multitrack");
350 QDomElement playlist = doc.createElement("playlist");
351 playlist.setAttribute("id", "black_track");
352 mlt.appendChild(playlist);
354 QDomElement blank0 = doc.createElement("entry");
355 blank0.setAttribute("in", "0");
356 blank0.setAttribute("out", "1");
357 blank0.setAttribute("producer", "black");
358 playlist.appendChild(blank0);
361 int total = tracks.count() + 1;
363 for (int i = 1; i < total; i++) {
364 QDomElement playlist = doc.createElement("playlist");
365 playlist.setAttribute("id", "playlist" + QString::number(i));
366 mlt.appendChild(playlist);
369 QDomElement track0 = doc.createElement("track");
370 track0.setAttribute("producer", "black_track");
371 tractor.appendChild(track0);
373 // create audio and video tracks
374 for (int i = 1; i < total; i++) {
375 QDomElement track = doc.createElement("track");
376 track.setAttribute("producer", "playlist" + QString::number(i));
377 if (tracks.at(i - 1).type == AUDIOTRACK) {
378 track.setAttribute("hide", "video");
379 } else if (tracks.at(i - 1).isBlind)
380 track.setAttribute("hide", "video");
381 if (tracks.at(i - 1).isMute)
382 track.setAttribute("hide", "audio");
383 tractor.appendChild(track);
386 for (int i = 2; i < total ; i++) {
387 QDomElement transition = doc.createElement("transition");
388 transition.setAttribute("always_active", "1");
390 QDomElement property = doc.createElement("property");
391 property.setAttribute("name", "a_track");
392 QDomText value = doc.createTextNode(QString::number(1));
393 property.appendChild(value);
394 transition.appendChild(property);
396 property = doc.createElement("property");
397 property.setAttribute("name", "b_track");
398 value = doc.createTextNode(QString::number(i));
399 property.appendChild(value);
400 transition.appendChild(property);
402 property = doc.createElement("property");
403 property.setAttribute("name", "mlt_service");
404 value = doc.createTextNode("mix");
405 property.appendChild(value);
406 transition.appendChild(property);
408 property = doc.createElement("property");
409 property.setAttribute("name", "combine");
410 value = doc.createTextNode("1");
411 property.appendChild(value);
412 transition.appendChild(property);
414 property = doc.createElement("property");
415 property.setAttribute("name", "internal_added");
416 value = doc.createTextNode("237");
417 property.appendChild(value);
418 transition.appendChild(property);
419 tractor.appendChild(transition);
421 mlt.appendChild(tractor);
426 void KdenliveDoc::syncGuides(QList <Guide *> guides)
429 QDomElement guideNode = m_guidesXml.createElement("guides");
430 m_guidesXml.appendChild(guideNode);
433 for (int i = 0; i < guides.count(); i++) {
434 e = m_guidesXml.createElement("guide");
435 e.setAttribute("time", guides.at(i)->position().ms() / 1000);
436 e.setAttribute("comment", guides.at(i)->label());
437 guideNode.appendChild(e);
440 emit guidesUpdated();
443 QDomElement KdenliveDoc::guidesXml() const
445 return m_guidesXml.documentElement();
448 void KdenliveDoc::slotAutoSave()
450 if (m_render && m_autosave) {
451 if (!m_autosave->isOpen() && !m_autosave->open(QIODevice::ReadWrite)) {
452 // show error: could not open the autosave file
453 kDebug() << "ERROR; CANNOT CREATE AUTOSAVE FILE";
455 kDebug() << "// AUTOSAVE FILE: " << m_autosave->fileName();
457 if (KdenliveSettings::dropbframes()) {
458 KdenliveSettings::setDropbframes(false);
459 m_clipManager->updatePreviewSettings();
460 doc = m_render->sceneList();
461 KdenliveSettings::setDropbframes(true);
462 m_clipManager->updatePreviewSettings();
463 } else doc = m_render->sceneList();
464 saveSceneList(m_autosave->fileName(), doc);
468 void KdenliveDoc::setZoom(int horizontal, int vertical)
470 m_documentProperties["zoom"] = QString::number(horizontal);
471 m_documentProperties["verticalzoom"] = QString::number(vertical);
474 QPoint KdenliveDoc::zoom() const
476 return QPoint(m_documentProperties.value("zoom").toInt(), m_documentProperties.value("verticalzoom").toInt());
479 void KdenliveDoc::setZone(int start, int end)
481 m_documentProperties["zonein"] = QString::number(start);
482 m_documentProperties["zoneout"] = QString::number(end);
485 QPoint KdenliveDoc::zone() const
487 return QPoint(m_documentProperties.value("zonein").toInt(), m_documentProperties.value("zoneout").toInt());
490 bool KdenliveDoc::saveSceneList(const QString &path, const QString &scene)
492 QDomDocument sceneList;
493 sceneList.setContent(scene, true);
494 QDomElement mlt = sceneList.firstChildElement("mlt");
495 if (mlt.isNull() || !mlt.hasChildNodes()) {
496 //Make sure we don't save if scenelist is corrupted
497 KMessageBox::error(kapp->activeWindow(), i18n("Cannot write to file %1, scene list is corrupted.", path));
500 QDomElement addedXml = sceneList.createElement("kdenlivedoc");
501 mlt.appendChild(addedXml);
503 QDomElement markers = sceneList.createElement("markers");
504 addedXml.setAttribute("version", DOCUMENTVERSION);
505 addedXml.setAttribute("kdenliveversion", VERSION);
506 addedXml.setAttribute("profile", profilePath());
507 addedXml.setAttribute("projectfolder", m_projectFolder.path());
509 QDomElement docproperties = sceneList.createElement("documentproperties");
510 QMapIterator<QString, QString> i(m_documentProperties);
511 while (i.hasNext()) {
513 docproperties.setAttribute(i.key(), i.value());
515 docproperties.setAttribute("position", m_render->seekPosition().frames(m_fps));
516 addedXml.appendChild(docproperties);
519 QDomElement profileinfo = sceneList.createElement("profileinfo");
520 profileinfo.setAttribute("description", m_profile.description);
521 profileinfo.setAttribute("frame_rate_num", m_profile.frame_rate_num);
522 profileinfo.setAttribute("frame_rate_den", m_profile.frame_rate_den);
523 profileinfo.setAttribute("width", m_profile.width);
524 profileinfo.setAttribute("height", m_profile.height);
525 profileinfo.setAttribute("progressive", m_profile.progressive);
526 profileinfo.setAttribute("sample_aspect_num", m_profile.sample_aspect_num);
527 profileinfo.setAttribute("sample_aspect_den", m_profile.sample_aspect_den);
528 profileinfo.setAttribute("display_aspect_num", m_profile.display_aspect_num);
529 profileinfo.setAttribute("display_aspect_den", m_profile.display_aspect_den);
530 addedXml.appendChild(profileinfo);
533 QDomElement tracksinfo = sceneList.createElement("tracksinfo");
534 foreach(const TrackInfo & info, m_tracksList) {
535 QDomElement trackinfo = sceneList.createElement("trackinfo");
536 if (info.type == AUDIOTRACK) trackinfo.setAttribute("type", "audio");
537 trackinfo.setAttribute("mute", info.isMute);
538 trackinfo.setAttribute("blind", info.isBlind);
539 trackinfo.setAttribute("locked", info.isLocked);
540 trackinfo.setAttribute("trackname", info.trackName);
541 tracksinfo.appendChild(trackinfo);
543 addedXml.appendChild(tracksinfo);
545 // save project folders
546 QMap <QString, QString> folderlist = m_clipManager->documentFolderList();
548 QMapIterator<QString, QString> f(folderlist);
549 while (f.hasNext()) {
551 QDomElement folder = sceneList.createElement("folder");
552 folder.setAttribute("id", f.key());
553 folder.setAttribute("name", f.value());
554 addedXml.appendChild(folder);
557 // Save project clips
559 QList <DocClipBase*> list = m_clipManager->documentClipList();
560 for (int i = 0; i < list.count(); i++) {
561 e = list.at(i)->toXML();
562 e.setTagName("kdenlive_producer");
563 addedXml.appendChild(sceneList.importNode(e, true));
564 QList < CommentedTime > marks = list.at(i)->commentedSnapMarkers();
565 for (int j = 0; j < marks.count(); j++) {
566 QDomElement marker = sceneList.createElement("marker");
567 marker.setAttribute("time", marks.at(j).time().ms() / 1000);
568 marker.setAttribute("comment", marks.at(j).comment());
569 marker.setAttribute("id", e.attribute("id"));
570 markers.appendChild(marker);
573 addedXml.appendChild(markers);
576 if (!m_guidesXml.isNull()) addedXml.appendChild(sceneList.importNode(m_guidesXml.documentElement(), true));
579 addedXml.appendChild(sceneList.importNode(m_clipManager->groupsXml(), true));
581 //wes.appendChild(doc.importNode(kdenliveData, true));
584 if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {
585 kWarning() << "////// ERROR writing to file: " << path;
586 KMessageBox::error(kapp->activeWindow(), i18n("Cannot write to file %1", path));
590 file.write(sceneList.toString().toUtf8());
591 if (file.error() != QFile::NoError) {
592 KMessageBox::error(kapp->activeWindow(), i18n("Cannot write to file %1", path));
600 ClipManager *KdenliveDoc::clipManager()
602 return m_clipManager;
605 KUrl KdenliveDoc::projectFolder() const
607 //if (m_projectFolder.isEmpty()) return KUrl(KStandardDirs::locateLocal("appdata", "/projects/"));
608 return m_projectFolder;
611 void KdenliveDoc::setProjectFolder(KUrl url)
613 if (url == m_projectFolder) return;
615 KStandardDirs::makeDir(url.path());
616 KStandardDirs::makeDir(url.path(KUrl::AddTrailingSlash) + "titles/");
617 KStandardDirs::makeDir(url.path(KUrl::AddTrailingSlash) + "thumbs/");
618 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);
619 m_projectFolder = url;
622 void KdenliveDoc::moveProjectData(KUrl url)
624 QList <DocClipBase*> list = m_clipManager->documentClipList();
625 //TODO: Also move ladspa effects files
626 for (int i = 0; i < list.count(); i++) {
627 DocClipBase *clip = list.at(i);
628 if (clip->clipType() == TEXT) {
629 // the image for title clip must be moved
630 KUrl oldUrl = clip->fileURL();
631 KUrl newUrl = KUrl(url.path(KUrl::AddTrailingSlash) + "titles/" + oldUrl.fileName());
632 KIO::Job *job = KIO::copy(oldUrl, newUrl);
633 if (KIO::NetAccess::synchronousRun(job, 0)) clip->setProperty("resource", newUrl.path());
635 QString hash = clip->getClipHash();
636 KUrl oldVideoThumbUrl = KUrl(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".png");
637 KUrl oldAudioThumbUrl = KUrl(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".thumb");
638 if (KIO::NetAccess::exists(oldVideoThumbUrl, KIO::NetAccess::SourceSide, 0)) {
639 KUrl newUrl = KUrl(url.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".png");
640 KIO::Job *job = KIO::copy(oldVideoThumbUrl, newUrl);
641 KIO::NetAccess::synchronousRun(job, 0);
643 if (KIO::NetAccess::exists(oldAudioThumbUrl, KIO::NetAccess::SourceSide, 0)) {
644 KUrl newUrl = KUrl(url.path(KUrl::AddTrailingSlash) + "thumbs/" + hash + ".thumb");
645 KIO::Job *job = KIO::copy(oldAudioThumbUrl, newUrl);
646 if (KIO::NetAccess::synchronousRun(job, 0)) clip->refreshThumbUrl();
651 const QString &KdenliveDoc::profilePath() const
653 return m_profile.path;
656 MltVideoProfile KdenliveDoc::mltProfile() const
661 bool KdenliveDoc::setProfilePath(QString path)
663 if (path.isEmpty()) path = KdenliveSettings::default_profile();
664 if (path.isEmpty()) path = "dv_pal";
665 m_profile = ProfilesDialog::getVideoProfile(path);
666 bool current_fps = m_fps;
667 if (m_profile.path.isEmpty()) {
668 // Profile not found, use embedded profile
669 QDomElement profileInfo = m_document.elementsByTagName("profileinfo").at(0).toElement();
670 if (profileInfo.isNull()) {
671 KMessageBox::information(kapp->activeWindow(), i18n("Project profile was not found, using default profile."), i18n("Missing Profile"));
672 m_profile = ProfilesDialog::getVideoProfile(KdenliveSettings::default_profile());
674 m_profile.description = profileInfo.attribute("description");
675 m_profile.frame_rate_num = profileInfo.attribute("frame_rate_num").toInt();
676 m_profile.frame_rate_den = profileInfo.attribute("frame_rate_den").toInt();
677 m_profile.width = profileInfo.attribute("width").toInt();
678 m_profile.height = profileInfo.attribute("height").toInt();
679 m_profile.progressive = profileInfo.attribute("progressive").toInt();
680 m_profile.sample_aspect_num = profileInfo.attribute("sample_aspect_num").toInt();
681 m_profile.sample_aspect_den = profileInfo.attribute("sample_aspect_den").toInt();
682 m_profile.display_aspect_num = profileInfo.attribute("display_aspect_num").toInt();
683 m_profile.display_aspect_den = profileInfo.attribute("display_aspect_den").toInt();
684 QString existing = ProfilesDialog::existingProfile(m_profile);
685 if (!existing.isEmpty()) {
686 m_profile = ProfilesDialog::getVideoProfile(existing);
687 KMessageBox::information(kapp->activeWindow(), i18n("Project profile not found, replacing with existing one: %1", m_profile.description), i18n("Missing Profile"));
689 QString newDesc = m_profile.description;
691 while (ok && (newDesc.isEmpty() || ProfilesDialog::existingProfileDescription(newDesc))) {
692 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);
695 // User canceled, use default profile
696 m_profile = ProfilesDialog::getVideoProfile(KdenliveSettings::default_profile());
698 if (newDesc != m_profile.description) {
699 // Profile description existed, was replaced by new one
700 m_profile.description = newDesc;
702 KMessageBox::information(kapp->activeWindow(), i18n("Project profile was not found, it will be added to your system now."), i18n("Missing Profile"));
704 ProfilesDialog::saveProfile(m_profile);
711 KdenliveSettings::setProject_display_ratio((double) m_profile.display_aspect_num / m_profile.display_aspect_den);
712 m_fps = (double) m_profile.frame_rate_num / m_profile.frame_rate_den;
713 KdenliveSettings::setProject_fps(m_fps);
714 m_width = m_profile.width;
715 m_height = m_profile.height;
716 kDebug() << "Kdenlive document, init timecode from path: " << path << ", " << m_fps;
717 m_timecode.setFormat(m_fps);
718 return (current_fps != m_fps);
721 double KdenliveDoc::dar()
723 return (double) m_profile.display_aspect_num / m_profile.display_aspect_den;
726 void KdenliveDoc::setThumbsProgress(const QString &message, int progress)
728 emit progressInfo(message, progress);
731 QUndoStack *KdenliveDoc::commandStack()
733 return m_commandStack;
737 void KdenliveDoc::setRenderer(Render *render) {
738 if (m_render) return;
740 emit progressInfo(i18n("Loading playlist..."), 0);
741 //qApp->processEvents();
743 m_render->setSceneList(m_document.toString(), m_startPos);
744 kDebug() << "// SETTING SCENE LIST:\n\n" << m_document.toString();
747 emit progressInfo(QString(), -1);
750 void KdenliveDoc::checkProjectClips()
752 if (m_render == NULL) return;
753 m_clipManager->resetProducersList(m_render->producersList());
756 void KdenliveDoc::updatePreviewSettings()
758 m_clipManager->updatePreviewSettings();
759 m_render->updatePreviewSettings();
760 QList <Mlt::Producer *> prods = m_render->producersList();
761 m_clipManager->resetProducersList(m_render->producersList());
766 Render *KdenliveDoc::renderer()
771 void KdenliveDoc::updateClip(const QString id)
773 emit updateClipDisplay(id);
776 int KdenliveDoc::getFramePos(QString duration)
778 return m_timecode.getFrameCount(duration);
781 QString KdenliveDoc::producerName(const QString &id)
783 QString result = "unnamed";
784 QDomNodeList prods = producersList();
785 int ct = prods.count();
786 for (int i = 0; i < ct ; i++) {
787 QDomElement e = prods.item(i).toElement();
788 if (e.attribute("id") != "black" && e.attribute("id") == id) {
789 result = e.attribute("name");
790 if (result.isEmpty()) result = KUrl(e.attribute("resource")).fileName();
797 QDomDocument KdenliveDoc::toXml()
802 Timecode KdenliveDoc::timecode() const
807 QDomNodeList KdenliveDoc::producersList()
809 return m_document.elementsByTagName("producer");
812 double KdenliveDoc::projectDuration() const
815 return GenTime(m_render->getLength(), m_fps).ms() / 1000;
820 double KdenliveDoc::fps() const
825 int KdenliveDoc::width() const
830 int KdenliveDoc::height() const
835 KUrl KdenliveDoc::url() const
840 void KdenliveDoc::setUrl(KUrl url)
845 void KdenliveDoc::setModified(bool mod)
847 if (!m_url.isEmpty() && mod && KdenliveSettings::crashrecovery()) {
848 m_autoSaveTimer->start(3000);
850 if (mod == m_modified) return;
852 emit docModified(m_modified);
855 bool KdenliveDoc::isModified() const
860 const QString KdenliveDoc::description() const
863 return i18n("Untitled") + " / " + m_profile.description;
865 return m_url.fileName() + " / " + m_profile.description;
868 void KdenliveDoc::addClip(QDomElement elem, QString clipId, bool createClipItem)
870 const QString producerId = clipId.section('_', 0, 0);
871 DocClipBase *clip = m_clipManager->getClipById(producerId);
874 elem.setAttribute("id", producerId);
875 QString path = elem.attribute("resource");
877 if (elem.attribute("type").toInt() == SLIDESHOW) {
878 extension = KUrl(path).fileName();
879 path = KUrl(path).directory();
882 if (path.isEmpty() == false && QFile::exists(path) == false && elem.attribute("type").toInt() != TEXT && !elem.hasAttribute("placeholder")) {
883 kDebug() << "// FOUND MISSING CLIP: " << path << ", TYPE: " << elem.attribute("type").toInt();
884 const QString size = elem.attribute("file_size");
885 const QString hash = elem.attribute("file_hash");
887 int action = KMessageBox::No;
888 if (!size.isEmpty() && !hash.isEmpty()) {
889 if (!m_searchFolder.isEmpty()) newpath = searchFileRecursively(m_searchFolder, size, hash);
890 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")));
892 if (elem.attribute("type").toInt() == SLIDESHOW) {
893 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")));
894 if (res == KMessageBox::Yes)
895 newpath = KFileDialog::getExistingDirectory(KUrl("kfiledialog:///clipfolder"), kapp->activeWindow(), i18n("Looking for %1", path));
897 // Abort project loading
901 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")));
902 if (res == KMessageBox::Yes)
903 newpath = KFileDialog::getOpenFileName(KUrl("kfiledialog:///clipfolder"), QString(), kapp->activeWindow(), i18n("Looking for %1", path));
905 // Abort project loading
910 if (action == KMessageBox::Yes) {
911 kDebug() << "// ASKED FOR SRCH CLIP: " << clipId;
912 m_searchFolder = KFileDialog::getExistingDirectory(KUrl("kfiledialog:///clipfolder"), kapp->activeWindow());
913 if (!m_searchFolder.isEmpty()) {
914 newpath = searchFileRecursively(QDir(m_searchFolder), size, hash);
916 } else if (action == KMessageBox::Cancel) {
917 m_abortLoading = true;
919 } else if (action == KMessageBox::No) {
920 // Keep clip as placeHolder
921 elem.setAttribute("placeholder", '1');
923 if (!newpath.isEmpty()) {
924 if (elem.attribute("type").toInt() == SLIDESHOW) newpath.append('/' + extension);
925 elem.setAttribute("resource", newpath);
926 setNewClipResource(clipId, newpath);
930 clip = new DocClipBase(m_clipManager, elem, producerId);
931 m_clipManager->addClip(clip);
934 if (createClipItem) {
935 emit addProjectClip(clip);
936 //qApp->processEvents();
940 void KdenliveDoc::setNewClipResource(const QString &id, const QString &path)
942 QDomNodeList prods = m_document.elementsByTagName("producer");
943 int maxprod = prods.count();
944 for (int i = 0; i < maxprod; i++) {
945 QDomNode m = prods.at(i);
946 QString prodId = m.toElement().attribute("id");
947 if (prodId == id || prodId.startsWith(id + '_')) {
948 QDomNodeList params = m.childNodes();
949 for (int j = 0; j < params.count(); j++) {
950 QDomElement e = params.item(j).toElement();
951 if (e.attribute("name") == "resource") {
952 e.firstChild().setNodeValue(path);
960 QString KdenliveDoc::searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const
962 QString foundFileName;
965 QStringList filesAndDirs = dir.entryList(QDir::Files | QDir::Readable);
966 for (int i = 0; i < filesAndDirs.size() && foundFileName.isEmpty(); i++) {
967 QFile file(dir.absoluteFilePath(filesAndDirs.at(i)));
968 if (file.open(QIODevice::ReadOnly)) {
969 if (QString::number(file.size()) == matchSize) {
971 * 1 MB = 1 second per 450 files (or faster)
972 * 10 MB = 9 seconds per 450 files (or faster)
974 if (file.size() > 1000000 * 2) {
975 fileData = file.read(1000000);
976 if (file.seek(file.size() - 1000000))
977 fileData.append(file.readAll());
979 fileData = file.readAll();
981 fileHash = QCryptographicHash::hash(fileData, QCryptographicHash::Md5);
982 if (QString(fileHash.toHex()) == matchHash)
983 return file.fileName();
986 kDebug() << filesAndDirs.at(i) << file.size() << fileHash.toHex();
988 filesAndDirs = dir.entryList(QDir::Dirs | QDir::Readable | QDir::Executable | QDir::NoDotAndDotDot);
989 for (int i = 0; i < filesAndDirs.size() && foundFileName.isEmpty(); i++) {
990 foundFileName = searchFileRecursively(dir.absoluteFilePath(filesAndDirs.at(i)), matchSize, matchHash);
991 if (!foundFileName.isEmpty())
994 return foundFileName;
997 void KdenliveDoc::addClipInfo(QDomElement elem, QDomElement orig, QString clipId)
999 DocClipBase *clip = m_clipManager->getClipById(clipId);
1001 addClip(elem, clipId, false);
1003 QMap <QString, QString> properties;
1004 QDomNamedNodeMap attributes = elem.attributes();
1006 for (int i = 0; i < attributes.count(); i++) {
1007 attrname = attributes.item(i).nodeName();
1008 if (attrname != "resource")
1009 properties.insert(attrname, attributes.item(i).nodeValue());
1010 kDebug() << attrname << " = " << attributes.item(i).nodeValue();
1012 clip->setProperties(properties);
1013 emit addProjectClip(clip, false);
1015 if (orig != QDomElement()) {
1016 QMap<QString, QString> meta;
1017 QDomNode m = orig.firstChild();
1018 while (!m.isNull()) {
1019 QString name = m.toElement().attribute("name");
1020 if (name.startsWith("meta.attr")) {
1021 meta.insert(name.section('.', 2, 3), m.firstChild().nodeValue());
1023 m = m.nextSibling();
1025 if (!meta.isEmpty()) {
1026 if (clip == NULL) clip = m_clipManager->getClipById(clipId);
1027 if (clip) clip->setMetadata(meta);
1033 void KdenliveDoc::deleteClip(const QString &clipId)
1035 emit signalDeleteProjectClip(clipId);
1038 void KdenliveDoc::slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId)
1040 m_clipManager->slotAddClipList(urls, group, groupId);
1041 //emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1046 void KdenliveDoc::slotAddClipFile(const KUrl url, const QString group, const QString &groupId)
1048 m_clipManager->slotAddClipFile(url, group, groupId);
1049 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1053 const QString KdenliveDoc::getFreeClipId()
1055 return QString::number(m_clipManager->getFreeClipId());
1058 DocClipBase *KdenliveDoc::getBaseClip(const QString &clipId)
1060 return m_clipManager->getClipById(clipId);
1063 void KdenliveDoc::slotCreateXmlClip(const QString &name, const QDomElement xml, QString group, const QString &groupId)
1065 m_clipManager->slotAddXmlClipFile(name, xml, group, groupId);
1067 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1070 void KdenliveDoc::slotCreateColorClip(const QString &name, const QString &color, const QString &duration, QString group, const QString &groupId)
1072 m_clipManager->slotAddColorClipFile(name, color, duration, group, groupId);
1074 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1077 void KdenliveDoc::slotCreateSlideshowClipFile(const QString name, const QString path, int count, const QString duration, const bool loop, const bool crop, const bool fade, const QString &luma_duration, const QString &luma_file, const int softness, QString group, const QString &groupId)
1079 m_clipManager->slotAddSlideshowClipFile(name, path, count, duration, loop, crop, fade, luma_duration, luma_file, softness, group, groupId);
1081 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1084 void KdenliveDoc::slotCreateTextClip(QString group, const QString &groupId, const QString &templatePath)
1086 QString titlesFolder = projectFolder().path(KUrl::AddTrailingSlash) + "titles/";
1087 KStandardDirs::makeDir(titlesFolder);
1088 TitleWidget *dia_ui = new TitleWidget(templatePath, m_timecode, titlesFolder, m_render, kapp->activeWindow());
1089 if (dia_ui->exec() == QDialog::Accepted) {
1090 m_clipManager->slotAddTextClipFile(i18n("Title clip"), dia_ui->outPoint(), dia_ui->xml().toString(), group, groupId);
1092 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1097 void KdenliveDoc::slotCreateTextTemplateClip(QString group, const QString &groupId, KUrl path)
1099 QString titlesFolder = projectFolder().path(KUrl::AddTrailingSlash) + "titles/";
1100 if (path.isEmpty()) {
1101 path = KFileDialog::getOpenUrl(KUrl(titlesFolder), "*.kdenlivetitle", kapp->activeWindow(), i18n("Enter Template Path"));
1104 if (path.isEmpty()) return;
1106 //TODO: rewrite with new title system (just set resource)
1107 m_clipManager->slotAddTextTemplateClip(i18n("Template title clip"), path, group, groupId);
1109 emit selectLastAddedClip(QString::number(m_clipManager->lastClipId()));
1112 int KdenliveDoc::tracksCount() const
1114 return m_tracksList.count();
1117 TrackInfo KdenliveDoc::trackInfoAt(int ix) const
1119 if (ix < 0 || ix >= m_tracksList.count()) {
1120 kWarning() << "Track INFO outisde of range";
1123 return m_tracksList.at(ix);
1126 void KdenliveDoc::switchTrackAudio(int ix, bool hide)
1128 if (ix < 0 || ix >= m_tracksList.count()) {
1129 kWarning() << "SWITCH Track outisde of range";
1132 m_tracksList[ix].isMute = hide; // !m_tracksList.at(ix).isMute;
1135 void KdenliveDoc::switchTrackLock(int ix, bool lock)
1137 if (ix < 0 || ix >= m_tracksList.count()) {
1138 kWarning() << "Track Lock outisde of range";
1141 m_tracksList[ix].isLocked = lock;
1144 bool KdenliveDoc::isTrackLocked(int ix) const
1146 if (ix < 0 || ix >= m_tracksList.count()) {
1147 kWarning() << "Track Lock outisde of range";
1150 return m_tracksList.at(ix).isLocked;
1153 void KdenliveDoc::switchTrackVideo(int ix, bool hide)
1155 if (ix < 0 || ix >= m_tracksList.count()) {
1156 kWarning() << "SWITCH Track outisde of range";
1159 m_tracksList[ix].isBlind = hide; // !m_tracksList.at(ix).isBlind;
1162 void KdenliveDoc::insertTrack(int ix, TrackInfo type)
1164 if (ix == -1) m_tracksList << type;
1165 else m_tracksList.insert(ix, type);
1168 void KdenliveDoc::deleteTrack(int ix)
1170 if (ix < 0 || ix >= m_tracksList.count()) {
1171 kWarning() << "Delete Track outisde of range";
1174 m_tracksList.removeAt(ix);
1177 void KdenliveDoc::setTrackType(int ix, TrackInfo type)
1179 if (ix < 0 || ix >= m_tracksList.count()) {
1180 kWarning() << "SET Track Type outisde of range";
1183 m_tracksList[ix].type = type.type;
1184 m_tracksList[ix].isMute = type.isMute;
1185 m_tracksList[ix].isBlind = type.isBlind;
1186 m_tracksList[ix].isLocked = type.isLocked;
1187 m_tracksList[ix].trackName = type.trackName;
1190 const QList <TrackInfo> KdenliveDoc::tracksList() const
1192 return m_tracksList;
1195 QPoint KdenliveDoc::getTracksCount() const
1199 foreach(const TrackInfo & info, m_tracksList) {
1200 if (info.type == VIDEOTRACK) video++;
1203 return QPoint(video, audio);
1206 void KdenliveDoc::cachePixmap(const QString &fileId, const QPixmap &pix) const
1208 pix.save(m_projectFolder.path(KUrl::AddTrailingSlash) + "thumbs/" + fileId + ".png");
1211 QString KdenliveDoc::getLadspaFile() const
1214 QString counter = QString::number(ct).rightJustified(5, '0', false);
1215 while (QFile::exists(m_projectFolder.path(KUrl::AddTrailingSlash) + "ladspa/" + counter + ".ladspa")) {
1217 counter = QString::number(ct).rightJustified(5, '0', false);
1219 return m_projectFolder.path(KUrl::AddTrailingSlash) + "ladspa/" + counter + ".ladspa";
1222 bool KdenliveDoc::checkDocumentClips(QDomNodeList infoproducers)
1224 DocumentChecker d(infoproducers, m_document);
1225 return (d.hasMissingClips() == false);
1231 QList <QDomElement> missingClips;
1232 for (int i = 0; i < infoproducers.count(); i++) {
1233 e = infoproducers.item(i).toElement();
1234 clipType = e.attribute("type").toInt();
1235 if (clipType == COLOR) continue;
1236 if (clipType == TEXT) {
1237 //TODO: Check is clip template is missing (xmltemplate) or hash changed
1240 id = e.attribute("id");
1241 resource = e.attribute("resource");
1242 if (clipType == SLIDESHOW) resource = KUrl(resource).directory();
1243 if (!KIO::NetAccess::exists(KUrl(resource), KIO::NetAccess::SourceSide, 0)) {
1244 // Missing clip found
1245 missingClips.append(e);
1247 // Check if the clip has changed
1248 if (clipType != SLIDESHOW && e.hasAttribute("file_hash")) {
1249 if (e.attribute("file_hash") != DocClipBase::getHash(e.attribute("resource")))
1250 e.removeAttribute("file_hash");
1254 if (missingClips.isEmpty()) return true;
1255 DocumentChecker d(missingClips, m_document);
1256 return (d.exec() == QDialog::Accepted);*/
1259 void KdenliveDoc::setDocumentProperty(const QString &name, const QString &value)
1261 m_documentProperties[name] = value;
1264 const QString KdenliveDoc::getDocumentProperty(const QString &name) const
1266 return m_documentProperties.value(name);
1269 QMap <QString, QString> KdenliveDoc::getRenderProperties() const
1271 QMap <QString, QString> renderProperties;
1272 QMapIterator<QString, QString> i(m_documentProperties);
1273 while (i.hasNext()) {
1275 if (i.key().startsWith("render")) renderProperties.insert(i.key(), i.value());
1277 return renderProperties;
1280 void KdenliveDoc::addTrackEffect(int ix, QDomElement effect)
1282 if (ix < 0 || ix >= m_tracksList.count()) {
1283 kWarning() << "Add Track effect outisde of range";
1286 effect.setAttribute("kdenlive_ix", m_tracksList.at(ix).effectsList.count() + 1);
1287 m_tracksList[ix].effectsList.append(effect);
1290 void KdenliveDoc::removeTrackEffect(int ix, QDomElement effect)
1292 if (ix < 0 || ix >= m_tracksList.count()) {
1293 kWarning() << "Remove Track effect outisde of range";
1297 QString toRemove = effect.attribute("kdenlive_ix");
1298 for (int i = 0; i < m_tracksList.at(ix).effectsList.count(); ++i) {
1299 index = m_tracksList.at(ix).effectsList.at(i).attribute("kdenlive_ix");
1300 if (toRemove == index) {
1301 m_tracksList[ix].effectsList.removeAt(i);
1303 } else if (index.toInt() > toRemove.toInt()) {
1304 m_tracksList[ix].effectsList.item(i).setAttribute("kdenlive_ix", index.toInt() - 1);
1309 void KdenliveDoc::setTrackEffect(int trackIndex, int effectIndex, QDomElement effect)
1311 if (trackIndex < 0 || trackIndex >= m_tracksList.count()) {
1312 kWarning() << "Set Track effect outisde of range";
1315 if (effectIndex < 0 || effectIndex > (m_tracksList.at(trackIndex).effectsList.count() - 1) || effect.isNull()) {
1316 kDebug() << "Invalid effect index: " << effectIndex;
1319 effect.setAttribute("kdenlive_ix", effectIndex + 1);
1320 m_tracksList[trackIndex].effectsList.replace(effectIndex, effect);
1323 const EffectsList KdenliveDoc::getTrackEffects(int ix)
1325 if (ix < 0 || ix >= m_tracksList.count()) {
1326 kWarning() << "Get Track effects outisde of range";
1327 return EffectsList();
1329 return m_tracksList.at(ix).effectsList;
1332 QDomElement KdenliveDoc::getTrackEffect(int trackIndex, int effectIndex) const
1334 if (trackIndex < 0 || trackIndex >= m_tracksList.count()) {
1335 kWarning() << "Get Track effect outisde of range";
1336 return QDomElement();
1338 EffectsList list = m_tracksList.at(trackIndex).effectsList;
1339 if (effectIndex > list.count() - 1 || effectIndex < 0 || list.at(effectIndex).isNull()) return QDomElement();
1340 return list.at(effectIndex).cloneNode().toElement();
1343 #include "kdenlivedoc.moc"