git.sesse.net Git - kdenlive/blob - renderer/renderjob.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
   3  *                                                                         *
   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.                                   *
   8  *                                                                         *
   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.                          *
  13  *                                                                         *
  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  ***************************************************************************/
  19
  20
  21 #include "renderjob.h"
  22
  23 #include <stdlib.h> // for getenv, posix portable to Windows: http://msdn.microsoft.com/en-us/library/tehxacec(VS.80).aspx
  24
  25 #include <QtDBus>
  26 #include <QFile>
  27 #include <QThread>
  28 #include <QStringList>
  29
  30
  31 // Can't believe I need to do this to sleep.
  32 class SleepThread : QThread
  33 {
  34 public:
  35     virtual void run() {};
  36     static void msleep(unsigned long msecs) {
  37         QThread::msleep(msecs);
  38     }
  39 };
  40
  41 static QDBusConnection connection(QLatin1String(""));
  42
  43 RenderJob::RenderJob(bool erase, bool usekuiserver, 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) :
  44     QObject(),
  45     m_jobUiserver(NULL),
  46     m_kdenliveinterface(NULL),
  47     m_usekuiserver(usekuiserver),
  48     m_enablelog(false)
  49 {
  50     m_scenelist = scenelist;
  51     m_dest = dest;
  52     m_player = player;
  53     m_progress = 0;
  54     m_erase = erase;
  55     m_renderProcess = new QProcess;
  56
  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);
  62 #else
  63     QStringList env = QProcess::systemEnvironment();
  64     env << "MLT_NO_VDPAU=1";
  65     m_renderProcess->setEnvironment(env);
  66 #endif
  67
  68     m_prog = renderer;
  69     m_args << scenelist;
  70     if (in != -1) m_args << "in=" + QString::number(in);
  71     if (out != -1) m_args << "out=" + QString::number(out);
  72
  73     m_args << preargs;
  74     //qDebug()<<"PRE ARGS: "<<preargs;
  75     m_args << "-profile" << profile;
  76     m_args << "-consumer" << rendermodule + ':' + m_dest << "progress=1" << args;
  77
  78     m_dualpass = false;
  79     if (args.contains("pass=1")) m_dualpass = true;
  80
  81     connect(m_renderProcess, SIGNAL(stateChanged(QProcess::ProcessState)), this, SLOT(slotCheckProcess(QProcess::ProcessState)));
  82     m_renderProcess->setReadChannel(QProcess::StandardError);
  83
  84     m_enablelog = (getenv("KDENLIVE_RENDER_LOG") != NULL);
  85     if (m_enablelog) {
  86         // Create a log of every render process.
  87         m_logfile.setAutoRemove(false);
  88         m_logfile.setFileTemplate(QDir::tempPath() + "/kdenlive_render.log.XXXXXXXX");
  89         if (m_logfile.open()) {
  90             qDebug() << "Writing render log to " << m_logfile.fileName();
  91
  92         } else {
  93             qDebug() << "Unable to log to " << m_logfile.fileName();
  94         }
  95         m_logstream.setDevice(&m_logfile);
  96         QString tmplist = scenelist;
  97         if (tmplist.contains("consumer:")) {
  98             QStringList tl = tmplist.split("consumer:");
  99             if (tl.count() == 2) {
 100                 tmplist = tl[1];
 101             }
 102         }
 103         m_logstream << "Log starting. Dumping contents of " << tmplist << endl;
 104         QFile file(tmplist);
 105         if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
 106             m_logstream << "Unable to read contents of " << tmplist << endl;
 107         } else {
 108             m_logstream.flush();
 109             QTextStream in(&file);
 110             m_logstream << in.readAll() << endl;
 111         }
 112     }
 113 }
 114
 115
 116 RenderJob::~RenderJob()
 117 {
 118     if (m_renderProcess) delete m_renderProcess;
 119     if (m_enablelog) {
 120         m_logfile.close();
 121     }
 122 }
 123
 124 void RenderJob::slotAbort(const QString& url)
 125 {
 126     if (m_dest == url) slotAbort();
 127 }
 128
 129 void RenderJob::slotAbort()
 130 {
 131     qDebug() << "Kdenlive-render: JOB ABORTED BY USER...";
 132     m_renderProcess->kill();
 133
 134     if (m_kdenliveinterface) {
 135         m_dbusargs[1] = -3;
 136         m_dbusargs.append(QString());
 137         m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
 138     }
 139     if (m_jobUiserver) m_jobUiserver->call("terminate", QString());
 140     if (m_erase) {
 141         QFile f(m_scenelist);
 142         f.remove();
 143     }
 144     QFile f(m_dest);
 145     f.remove();
 146     if (m_enablelog) {
 147         m_logstream << "Job aborted by user" << endl;
 148         m_logstream.flush();
 149         m_logfile.close();
 150     }
 151     qApp->quit();
 152 }
 153
 154 void RenderJob::receivedStderr()
 155 {
 156     QString result = QString(m_renderProcess->readAllStandardError()).simplified();
 157     //fprintf(stderr, "* * * *RENDER LG: %s\n", result.toUtf8().data());
 158     if (!result.startsWith("Current Frame")) m_errorMessage.append(result + "<br>");
 159     else {
 160         if (m_enablelog) m_logstream << "ReceivedStderr from melt: " << result << endl;
 161         result = result.section(' ', -1);
 162         int pro = result.toInt();
 163         if (pro < 0 || pro > 100) return;
 164         if (pro > m_progress) {
 165             m_progress = pro;
 166             if (m_args.contains("pass=1")) {
 167                 m_progress /= 2.0;
 168             } else if (m_args.contains("pass=2")) {
 169                 m_progress = 50 + m_progress / 2.0;
 170             }
 171             if (m_kdenliveinterface) {
 172                 if (!m_kdenliveinterface->isValid()) {
 173                     delete m_kdenliveinterface;
 174                     m_kdenliveinterface = NULL;
 175                     // qDebug() << "BROKEN COMMUNICATION WITH KDENLIVE";
 176                 } else {
 177                     m_dbusargs[1] = m_progress;
 178                     m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingProgress", m_dbusargs);
 179                 }
 180             } else if (pro % 5 == 0) {
 181                 // Try to restart communication with Kdenlive every 5 percents
 182                 // qDebug() << "TRYING TO RESTART COMMUNICATION WITH KDENLIVE";
 183                 initKdenliveDbusInterface();
 184             }
 185
 186             if (m_jobUiserver) {
 187                 m_jobUiserver->call("setPercent", (uint) m_progress);
 188                 /*int seconds = m_startTime.secsTo(QTime::currentTime());
 189                 seconds = seconds * (100 - m_progress) / m_progress;
 190                 m_jobUiserver->call("setDescriptionField", (uint) 1, tr("Remaining time"), QTime().addSecs(seconds).toString("hh:mm:ss"));*/
 191             }
 192         }
 193     }
 194 }
 195
 196 void RenderJob::start()
 197 {
 198     QDBusConnectionInterface* interface = QDBusConnection::sessionBus().interface();
 199     if (interface && m_usekuiserver) {
 200         if (!interface->isServiceRegistered("org.kde.JobViewServer")) {
 201             qDebug() << "No org.kde.JobViewServer registered, trying to start kuiserver";
 202             if (m_enablelog) m_logstream << "No org.kde.JobViewServer registered, trying to start kuiserver";
 203             if (QProcess::startDetached("kuiserver")) {
 204                 qDebug() << "Started kuiserver";
 205                 if (m_enablelog) m_logstream << "Started kuiserver";
 206                 // Give it a couple of seconds to start
 207                 QTime t;
 208                 t.start();
 209                 while (!interface->isServiceRegistered("org.kde.JobViewServer") && t.elapsed() < 3000) {
 210                     SleepThread::msleep(100);   //Sleep 100 ms
 211                 }
 212             } else {
 213                 qDebug() << "Failed to start kuiserver";
 214                 if (m_enablelog) m_logstream << "Failed to start kuiserver";
 215             }
 216         }
 217
 218         if (interface->isServiceRegistered("org.kde.JobViewServer")) {
 219             QDBusInterface kuiserver("org.kde.JobViewServer", "/JobViewServer", "org.kde.JobViewServer");
 220             QDBusReply<QDBusObjectPath> objectPath = kuiserver.call("requestView", "kdenlive", "kdenlive", 0x0001);
 221             QString reply = ((QDBusObjectPath) objectPath).path();
 222             m_jobUiserver = new QDBusInterface("org.kde.JobViewServer", reply, "org.kde.JobView");
 223             if (m_jobUiserver) {
 224                 m_startTime = QTime::currentTime();
 225                 if (!m_args.contains("pass=2"))
 226                     m_jobUiserver->call("setPercent", (uint) 0);
 227                 m_jobUiserver->call("setInfoMessage", tr("Rendering %1").arg(QFileInfo(m_dest).fileName()));
 228                 //m_jobUiserver->call("setDescriptionField", (uint) 0, tr("Rendering to"), m_dest);
 229                 QDBusConnection::sessionBus().connect("org.kde.JobViewServer", reply, "org.kde.JobView", "cancelRequested", this, SLOT(slotAbort()));
 230             }
 231         }
 232     }
 233
 234     initKdenliveDbusInterface();
 235
 236     // Make sure the destination file is writable
 237     QFile checkDestination(m_dest);
 238     if (!checkDestination.open(QIODevice::WriteOnly)) {
 239         slotIsOver(QProcess::NormalExit, false);
 240     }
 241     checkDestination.close();
 242
 243     // Because of the logging, we connect to stderr in all cases.
 244     connect(m_renderProcess, SIGNAL(readyReadStandardError()), this, SLOT(receivedStderr()));
 245     m_renderProcess->start(m_prog, m_args);
 246     if (m_enablelog) m_logstream << "Started render process: " << m_prog << " " << m_args.join(" ") << endl;
 247     qDebug() << "Started render process: " << m_prog << " " << m_args.join(" ");
 248 }
 249
 250
 251 void RenderJob::initKdenliveDbusInterface()
 252 {
 253     QString kdenliveId;
 254     QDBusConnection connection = QDBusConnection::sessionBus();
 255     QDBusConnectionInterface* ibus = connection.interface();
 256     const QStringList services = ibus->registeredServiceNames();
 257     foreach(const QString & service, services) {
 258         if (!service.startsWith("org.kde.kdenlive"))
 259             continue;
 260         kdenliveId = service;
 261         break;
 262     }
 263     m_dbusargs.clear();
 264     if (kdenliveId.isEmpty()) return;
 265     m_kdenliveinterface = new QDBusInterface(kdenliveId,
 266             "/MainWindow",
 267             "org.kdenlive.MainWindow",
 268             connection,
 269             this);
 270
 271     if (m_kdenliveinterface) {
 272         m_dbusargs.append(m_dest);
 273         m_dbusargs.append((int) 0);
 274         if (!m_args.contains("pass=2"))
 275             m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingProgress", m_dbusargs);
 276         connect(m_kdenliveinterface, SIGNAL(abortRenderJob(const QString&)),
 277                 this, SLOT(slotAbort(const QString&)));
 278     }
 279 }
 280
 281
 282 void RenderJob::slotCheckProcess(QProcess::ProcessState state)
 283 {
 284     if (state == QProcess::NotRunning) slotIsOver(m_renderProcess->exitStatus());
 285 }
 286
 287
 288
 289 void RenderJob::slotIsOver(QProcess::ExitStatus status, bool isWritable)
 290 {
 291     if (m_jobUiserver) m_jobUiserver->call("terminate", QString());
 292     if (!isWritable) {
 293         QString error = tr("Cannot write to %1, check the permissions.").arg(m_dest);
 294         if (m_kdenliveinterface) {
 295             m_dbusargs[1] = (int) - 2;
 296             m_dbusargs.append(error);
 297             m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
 298         }
 299         QStringList args;
 300         args << "--error" << error;
 301         if (m_enablelog) m_logstream << error << endl;
 302         qDebug() << error;
 303         QProcess::startDetached("kdialog", args);
 304         qApp->quit();
 305     }
 306     if (m_erase) {
 307         QFile f(m_scenelist);
 308         f.remove();
 309     }
 310     if (status == QProcess::CrashExit || m_renderProcess->error() != QProcess::UnknownError) {
 311         // rendering crashed
 312         if (m_kdenliveinterface) {
 313             m_dbusargs[1] = (int) - 2;
 314             m_dbusargs.append(m_errorMessage);
 315             m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
 316         }
 317         QStringList args;
 318         QString error = tr("Rendering of %1 aborted, resulting video will probably be corrupted.").arg(m_dest);
 319         args << "--error" << error;
 320         if (m_enablelog) m_logstream << error << endl;
 321         qDebug() << error;
 322         QProcess::startDetached("kdialog", args);
 323         qApp->quit();
 324     } else {
 325         if (!m_dualpass && m_kdenliveinterface) {
 326             m_dbusargs[1] = (int) - 1;
 327             m_dbusargs.append(QString());
 328             m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
 329         }
 330         QDBusConnectionInterface* interface = QDBusConnection::sessionBus().interface();
 331         if (!m_dualpass && interface && interface->isServiceRegistered("org.kde.knotify")) {
 332             QDBusMessage m = QDBusMessage::createMethodCall("org.kde.knotify",
 333                              "/Notify",
 334                              "org.kde.KNotify",
 335                              "event");
 336             int seconds = m_startTime.secsTo(QTime::currentTime());
 337             QList<QVariant> args;
 338             args.append(QString("RenderFinished"));   // action name
 339             args.append(QString("kdenlive"));   // app name
 340             args.append(QVariantList());   // contexts
 341             args.append(tr("Rendering of %1 finished in %2").arg(m_dest, QTime(0, 0, seconds).toString("hh:mm:ss")));   // body
 342             args.append(QByteArray());   // app icon
 343             QStringList actionList;
 344             args.append(actionList);   // actions
 345             qlonglong wid = 0;
 346             args.append(wid);   // win id
 347
 348             m.setArguments(args);
 349             QDBusMessage replyMsg = QDBusConnection::sessionBus().call(m);
 350         }
 351         if (m_enablelog) m_logstream << "Rendering of " << m_dest << " finished" << endl;
 352         qDebug() << "Rendering of " << m_dest << " finished";
 353         if (!m_dualpass && m_player != "-") {
 354             if (m_enablelog) m_logstream << "Starting player" << endl;
 355             QStringList args;
 356             args << m_dest;
 357             QProcess::startDetached(m_player, args);
 358         }
 359         if (m_dualpass) {
 360             emit renderingFinished();
 361             deleteLater();
 362         } else qApp->quit();
 363     }
 364 }
 365
 366 #include "renderjob.moc"