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 "renderjob.h"
23 #include <stdlib.h> // for getenv, posix portable to Windows: http://msdn.microsoft.com/en-us/library/tehxacec(VS.80).aspx
28 #include <QStringList>
31 // Can't believe I need to do this to sleep.
32 class SleepThread : QThread
35 virtual void run() {};
36 static void msleep(unsigned long msecs) {
37 QThread::msleep(msecs);
42 RenderJob::RenderJob(bool erase, bool usekuiserver, int pid, const QString& renderer, const QString& profile, const QString& rendermodule, const QString& player, const QString& scenelist, const QString& dest, const QStringList& preargs, const QStringList& args, int in, int out) :
45 m_kdenliveinterface(NULL),
46 m_usekuiserver(usekuiserver),
50 m_scenelist = scenelist;
55 m_renderProcess = new QProcess;
57 // Disable VDPAU so that rendering will work even if there is a Kdenlive instance using VDPAU
58 #if QT_VERSION >= 0x040600
59 QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
60 env.insert("MLT_NO_VDPAU", "1");
61 m_renderProcess->setProcessEnvironment(env);
63 QStringList env = QProcess::systemEnvironment();
64 env << "MLT_NO_VDPAU=1";
65 m_renderProcess->setEnvironment(env);
70 if (in != -1) m_args << "in=" + QString::number(in);
71 if (out != -1) m_args << "out=" + QString::number(out);
74 //qDebug()<<"PRE ARGS: "<<preargs;
75 if (scenelist.startsWith("consumer:")) {
76 // Use MLT's producer_consumer, needs a different syntax for profile:
77 m_args << "profile=" + profile;
78 } else m_args << "-profile" << profile;
79 m_args << "-consumer" << rendermodule + ':' + m_dest << "progress=1" << args;
82 if (args.contains("pass=1")) m_dualpass = true;
84 connect(m_renderProcess, SIGNAL(stateChanged(QProcess::ProcessState)), this, SLOT(slotCheckProcess(QProcess::ProcessState)));
85 m_renderProcess->setReadChannel(QProcess::StandardError);
87 m_enablelog = (getenv("KDENLIVE_RENDER_LOG") != NULL);
89 // Create a log of every render process.
90 m_logfile.setAutoRemove(false);
91 m_logfile.setFileTemplate(QDir::tempPath() + "/kdenlive_render.log.XXXXXXXX");
92 if (m_logfile.open()) {
93 qDebug() << "Writing render log to " << m_logfile.fileName();
96 qDebug() << "Unable to log to " << m_logfile.fileName();
98 m_logstream.setDevice(&m_logfile);
99 QString tmplist = scenelist;
100 if (tmplist.contains("consumer:")) {
101 QStringList tl = tmplist.split("consumer:");
102 if (tl.count() == 2) {
106 m_logstream << "Log starting. Dumping contents of " << tmplist << endl;
108 if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
109 m_logstream << "Unable to read contents of " << tmplist << endl;
112 QTextStream in(&file);
113 m_logstream << in.readAll() << endl;
119 RenderJob::~RenderJob()
121 if (m_renderProcess) delete m_renderProcess;
127 void RenderJob::setLocale(const QString &locale)
129 #if QT_VERSION >= 0x040600
130 QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
131 env.insert("LC_NUMERIC", locale);
132 m_renderProcess->setProcessEnvironment(env);
134 QStringList env = QProcess::systemEnvironment();
135 env << QString("LC_NUMERIC=%1").arg(locale);
136 m_renderProcess->setEnvironment(env);
140 void RenderJob::slotAbort(const QString& url)
142 if (m_dest == url) slotAbort();
145 void RenderJob::slotAbort()
147 qDebug() << "Kdenlive-render: JOB ABORTED BY USER...";
148 m_renderProcess->kill();
150 if (m_kdenliveinterface) {
152 m_dbusargs.append(QString());
153 m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
155 if (m_jobUiserver) m_jobUiserver->call("terminate", QString());
157 QFile f(m_scenelist);
163 m_logstream << "Job aborted by user" << endl;
170 void RenderJob::receivedStderr()
172 QString result = QString(m_renderProcess->readAllStandardError()).simplified();
173 //fprintf(stderr, "* * * *RENDER LG: %s\n", result.toUtf8().data());
174 if (!result.startsWith("Current Frame")) m_errorMessage.append(result + "<br>");
176 if (m_enablelog) m_logstream << "ReceivedStderr from melt: " << result << endl;
177 result = result.section(' ', -1);
178 int pro = result.toInt();
179 if (pro < 0 || pro > 100) return;
180 if (pro > m_progress) {
182 if (m_args.contains("pass=1")) {
184 } else if (m_args.contains("pass=2")) {
185 m_progress = 50 + m_progress / 2.0;
187 if (m_kdenliveinterface) {
188 if (!m_kdenliveinterface->isValid()) {
189 delete m_kdenliveinterface;
190 m_kdenliveinterface = NULL;
191 // qDebug() << "BROKEN COMMUNICATION WITH KDENLIVE";
193 m_dbusargs[1] = m_progress;
194 m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingProgress", m_dbusargs);
196 } else if (pro % 5 == 0) {
197 // Try to restart communication with Kdenlive every 5 percents
198 // qDebug() << "TRYING TO RESTART COMMUNICATION WITH KDENLIVE";
199 initKdenliveDbusInterface();
203 m_jobUiserver->call("setPercent", (uint) m_progress);
204 /*int seconds = m_startTime.secsTo(QTime::currentTime());
205 seconds = seconds * (100 - m_progress) / m_progress;
206 m_jobUiserver->call("setDescriptionField", (uint) 1, tr("Remaining time"), QTime().addSecs(seconds).toString("hh:mm:ss"));*/
212 void RenderJob::start()
214 QDBusConnectionInterface* interface = QDBusConnection::sessionBus().interface();
215 if (interface && m_usekuiserver) {
216 if (!interface->isServiceRegistered("org.kde.JobViewServer")) {
217 qDebug() << "No org.kde.JobViewServer registered, trying to start kuiserver";
218 if (m_enablelog) m_logstream << "No org.kde.JobViewServer registered, trying to start kuiserver";
219 if (QProcess::startDetached("kuiserver")) {
220 qDebug() << "Started kuiserver";
221 if (m_enablelog) m_logstream << "Started kuiserver";
222 // Give it a couple of seconds to start
225 while (!interface->isServiceRegistered("org.kde.JobViewServer") && t.elapsed() < 3000) {
226 SleepThread::msleep(100); //Sleep 100 ms
229 qDebug() << "Failed to start kuiserver";
230 if (m_enablelog) m_logstream << "Failed to start kuiserver";
234 if (interface->isServiceRegistered("org.kde.JobViewServer")) {
235 QDBusInterface kuiserver("org.kde.JobViewServer", "/JobViewServer", "org.kde.JobViewServer");
236 QDBusReply<QDBusObjectPath> objectPath = kuiserver.call("requestView", "Kdenlive", "kdenlive", 0x0001);
237 QString reply = ((QDBusObjectPath) objectPath).path();
239 // Use of the KDE JobViewServer is an ugly hack, it is not reliable
240 QString dbusView = "org.kde.JobViewV2";
241 m_jobUiserver = new QDBusInterface("org.kde.JobViewServer", reply, dbusView);
242 if (!m_jobUiserver || !m_jobUiserver->isValid()) {
243 dbusView = "org.kde.JobView";
244 m_jobUiserver = new QDBusInterface("org.kde.JobViewServer", reply, dbusView);
247 if (m_jobUiserver && m_jobUiserver->isValid()) {
248 m_startTime = QTime::currentTime();
249 if (!m_args.contains("pass=2"))
250 m_jobUiserver->call("setPercent", (uint) 0);
251 //m_jobUiserver->call("setInfoMessage", tr("Rendering %1").arg(QFileInfo(m_dest).fileName()));
252 m_jobUiserver->call("setDescriptionField", (uint) 0, tr("Rendering"), m_dest);
253 QDBusConnection::sessionBus().connect("org.kde.JobViewServer", reply, dbusView, "cancelRequested", this, SLOT(slotAbort()));
258 initKdenliveDbusInterface();
260 // Make sure the destination file is writable
261 QFile checkDestination(m_dest);
262 if (!checkDestination.open(QIODevice::WriteOnly)) {
263 slotIsOver(QProcess::NormalExit, false);
265 checkDestination.close();
267 // Because of the logging, we connect to stderr in all cases.
268 connect(m_renderProcess, SIGNAL(readyReadStandardError()), this, SLOT(receivedStderr()));
269 m_renderProcess->start(m_prog, m_args);
270 if (m_enablelog) m_logstream << "Started render process: " << m_prog << " " << m_args.join(" ") << endl;
271 qDebug() << "Started render process: " << m_prog << " " << m_args.join(" ");
275 void RenderJob::initKdenliveDbusInterface()
278 QDBusConnection connection = QDBusConnection::sessionBus();
279 QDBusConnectionInterface* ibus = connection.interface();
280 kdenliveId = QString("org.kde.kdenlive-%1").arg(m_pid);
281 if (!ibus->isServiceRegistered(kdenliveId))
284 const QStringList services = ibus->registeredServiceNames();
285 foreach(const QString & service, services) {
286 if (!service.startsWith("org.kde.kdenlive"))
288 kdenliveId = service;
293 if (kdenliveId.isEmpty()) return;
294 m_kdenliveinterface = new QDBusInterface(kdenliveId,
296 "org.kdenlive.MainWindow",
300 if (m_kdenliveinterface) {
301 m_dbusargs.append(m_dest);
302 m_dbusargs.append((int) 0);
303 if (!m_args.contains("pass=2"))
304 m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingProgress", m_dbusargs);
305 connect(m_kdenliveinterface, SIGNAL(abortRenderJob(const QString&)),
306 this, SLOT(slotAbort(const QString&)));
311 void RenderJob::slotCheckProcess(QProcess::ProcessState state)
313 if (state == QProcess::NotRunning) slotIsOver(m_renderProcess->exitStatus());
318 void RenderJob::slotIsOver(QProcess::ExitStatus status, bool isWritable)
320 if (m_jobUiserver) m_jobUiserver->call("terminate", QString());
322 QString error = tr("Cannot write to %1, check the permissions.").arg(m_dest);
323 if (m_kdenliveinterface) {
324 m_dbusargs[1] = (int) - 2;
325 m_dbusargs.append(error);
326 m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
329 args << "--error" << error;
330 if (m_enablelog) m_logstream << error << endl;
332 QProcess::startDetached("kdialog", args);
336 QFile f(m_scenelist);
339 if (status == QProcess::CrashExit || m_renderProcess->error() != QProcess::UnknownError) {
341 if (m_kdenliveinterface) {
342 m_dbusargs[1] = (int) - 2;
343 m_dbusargs.append(m_errorMessage);
344 m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
347 QString error = tr("Rendering of %1 aborted, resulting video will probably be corrupted.").arg(m_dest);
348 args << "--error" << error;
349 if (m_enablelog) m_logstream << error << endl;
351 QProcess::startDetached("kdialog", args);
354 if (!m_dualpass && m_kdenliveinterface) {
355 m_dbusargs[1] = (int) - 1;
356 m_dbusargs.append(QString());
357 m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
359 QDBusConnectionInterface* interface = QDBusConnection::sessionBus().interface();
360 if (!m_dualpass && interface && interface->isServiceRegistered("org.kde.knotify")) {
361 QDBusMessage m = QDBusMessage::createMethodCall("org.kde.knotify",
365 int seconds = m_startTime.secsTo(QTime::currentTime());
366 QList<QVariant> args;
367 args.append(QString("RenderFinished")); // action name
368 args.append(QString("kdenlive")); // app name
369 args.append(QVariantList()); // contexts
370 args.append(tr("Rendering of %1 finished in %2").arg(m_dest, QTime(0, 0, seconds).toString("hh:mm:ss"))); // body
371 args.append(QByteArray()); // app icon
372 QStringList actionList;
373 args.append(actionList); // actions
375 args.append(wid); // win id
377 m.setArguments(args);
378 QDBusMessage replyMsg = QDBusConnection::sessionBus().call(m);
380 if (m_enablelog) m_logstream << "Rendering of " << m_dest << " finished" << endl;
381 qDebug() << "Rendering of " << m_dest << " finished";
382 if (!m_dualpass && m_player != "-") {
383 if (m_enablelog) m_logstream << "Starting player" << endl;
386 QProcess::startDetached(m_player, args);
389 emit renderingFinished();
395 #include "renderjob.moc"