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     m_prog = renderer;
  57     m_args << scenelist;
  58     if (in != -1) m_args << "in=" + QString::number(in);
  59     if (out != -1) m_args << "out=" + QString::number(out);
  60
  61     m_args << preargs;
  62     //qDebug()<<"PRE ARGS: "<<preargs;
  63     if (scenelist.startsWith("consumer:")) {
  64         // Use MLT's producer_consumer, needs a different syntax for profile:
  65         m_args << "profile=" + profile;
  66     } else m_args << "-profile" << profile;
  67     m_args << "-consumer" << rendermodule + ':' + m_dest << "progress=1" << args;
  68
  69     m_dualpass = false;
  70     if (args.contains("pass=1")) m_dualpass = true;
  71
  72     connect(m_renderProcess, SIGNAL(stateChanged(QProcess::ProcessState)), this, SLOT(slotCheckProcess(QProcess::ProcessState)));
  73     //connect(m_renderProcess, SIGNAL(finished(int, QProcess::ExitStatus)), this, SLOT(slotIsOver(int, QProcess::ExitStatus)));
  74     m_renderProcess->setReadChannel(QProcess::StandardError);
  75
  76     m_enablelog = (getenv("KDENLIVE_RENDER_LOG") != NULL);
  77     if (m_enablelog) {
  78         // Create a log of every render process.
  79         m_logfile.setAutoRemove(false);
  80         m_logfile.setFileTemplate(QDir::tempPath() + "/kdenlive_render.log.XXXXXXXX");
  81         if (m_logfile.open()) {
  82             qDebug() << "Writing render log to " << m_logfile.fileName();
  83
  84         } else {
  85             qDebug() << "Unable to log to " << m_logfile.fileName();
  86         }
  87         m_logstream.setDevice(&m_logfile);
  88         QString tmplist = scenelist;
  89         if (tmplist.contains("consumer:")) {
  90             QStringList tl = tmplist.split("consumer:");
  91             if (tl.count() == 2) {
  92                 tmplist = tl[1];
  93             }
  94         }
  95         m_logstream << "Log starting. Dumping contents of " << tmplist << endl;
  96         QFile file(tmplist);
  97         if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
  98             m_logstream << "Unable to read contents of " << tmplist << endl;
  99         } else {
 100             m_logstream.flush();
 101             QTextStream in(&file);
 102             m_logstream << in.readAll() << endl;
 103         }
 104     }
 105 }
 106
 107
 108 RenderJob::~RenderJob()
 109 {
 110     if (m_renderProcess) delete m_renderProcess;
 111     if (m_enablelog) {
 112         m_logfile.close();
 113     }
 114 }
 115
 116 void RenderJob::slotAbort(const QString& url)
 117 {
 118     if (m_dest == url) slotAbort();
 119 }
 120
 121 void RenderJob::slotAbort()
 122 {
 123     qDebug() << "Kdenlive-render: JOB ABORTED BY USER...";
 124     m_renderProcess->kill();
 125
 126     if (m_kdenliveinterface) {
 127         m_dbusargs[1] = -3;
 128         m_dbusargs.append(QString());
 129         m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
 130     }
 131     if (m_jobUiserver) m_jobUiserver->call("terminate", QString());
 132     if (m_erase) {
 133         QFile f(m_scenelist);
 134         f.remove();
 135     }
 136     QFile f(m_dest);
 137     f.remove();
 138     if (m_enablelog) {
 139         m_logstream << "Job aborted by user" << endl;
 140         m_logstream.flush();
 141         m_logfile.close();
 142     }
 143     qApp->quit();
 144 }
 145
 146 void RenderJob::receivedStderr()
 147 {
 148     QString result = QString(m_renderProcess->readAllStandardError()).simplified();
 149     if (!result.startsWith("Current Frame")) m_errorMessage.append(result + "<br>");
 150     else {
 151         if (m_enablelog) m_logstream << "ReceivedStderr from melt: " << result << endl;
 152         result = result.section(' ', -1);
 153         int pro = result.toInt();
 154         if (pro < 0 || pro > 100) return;
 155         if (pro > m_progress) {
 156             m_progress = pro;
 157             if (m_kdenliveinterface) {
 158                 if (!m_kdenliveinterface->isValid()) {
 159                     delete m_kdenliveinterface;
 160                     m_kdenliveinterface = NULL;
 161                     // qDebug() << "BROKEN COMMUNICATION WITH KDENLIVE";
 162                 } else {
 163                     m_dbusargs[1] = pro;
 164                     m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingProgress", m_dbusargs);
 165                 }
 166             } else if (pro % 5 == 0) {
 167                 // Try to restart communication with Kdenlive every 5 percents
 168                 // qDebug() << "TRYING TO RESTART COMMUNICATION WITH KDENLIVE";
 169                 initKdenliveDbusInterface();
 170             }
 171
 172             if (m_jobUiserver) {
 173                 m_jobUiserver->call("setPercent", (uint) m_progress);
 174                 /*int seconds = m_startTime.secsTo(QTime::currentTime());
 175                 seconds = seconds * (100 - m_progress) / m_progress;
 176                 m_jobUiserver->call("setDescriptionField", (uint) 1, tr("Remaining time"), QTime().addSecs(seconds).toString("hh:mm:ss"));*/
 177             }
 178         }
 179     }
 180 }
 181
 182 void RenderJob::start()
 183 {
 184     QDBusConnectionInterface* interface = QDBusConnection::sessionBus().interface();
 185     if (interface && m_usekuiserver) {
 186         if (!interface->isServiceRegistered("org.kde.JobViewServer")) {
 187             qDebug() << "No org.kde.JobViewServer registered, trying to start kuiserver";
 188             if (m_enablelog) m_logstream << "No org.kde.JobViewServer registered, trying to start kuiserver";
 189             if (QProcess::startDetached("kuiserver")) {
 190                 qDebug() << "Started kuiserver";
 191                 if (m_enablelog) m_logstream << "Started kuiserver";
 192                 // Give it a couple of seconds to start
 193                 QTime t;
 194                 t.start();
 195                 while (!interface->isServiceRegistered("org.kde.JobViewServer") && t.elapsed() < 3000) {
 196                     SleepThread::msleep(100);   //Sleep 100 ms
 197                 }
 198             } else {
 199                 qDebug() << "Failed to start kuiserver";
 200                 if (m_enablelog) m_logstream << "Failed to start kuiserver";
 201             }
 202         }
 203
 204         if (interface->isServiceRegistered("org.kde.JobViewServer")) {
 205             QDBusInterface kuiserver("org.kde.JobViewServer", "/JobViewServer", "org.kde.JobViewServer");
 206             QDBusReply<QDBusObjectPath> objectPath = kuiserver.call("requestView", "kdenlive", "kdenlive", 0x0001);
 207             QString reply = ((QDBusObjectPath) objectPath).path();
 208             m_jobUiserver = new QDBusInterface("org.kde.JobViewServer", reply, "org.kde.JobView");
 209             if (m_jobUiserver) {
 210                 m_startTime = QTime::currentTime();
 211                 m_jobUiserver->call("setPercent", (uint) 0);
 212                 m_jobUiserver->call("setInfoMessage", tr("Rendering %1").arg(QFileInfo(m_dest).fileName()));
 213                 //m_jobUiserver->call("setDescriptionField", (uint) 0, tr("Rendering to"), m_dest);
 214                 QDBusConnection::sessionBus().connect("org.kde.JobViewServer", reply, "org.kde.JobView", "cancelRequested", this, SLOT(slotAbort()));
 215             }
 216         }
 217     }
 218
 219     initKdenliveDbusInterface();
 220
 221     // Because of the logging, we connect to stderr in all cases.
 222     connect(m_renderProcess, SIGNAL(readyReadStandardError()), this, SLOT(receivedStderr()));
 223     m_renderProcess->start(m_prog, m_args);
 224     if (m_enablelog) m_logstream << "Started render process: " << m_prog << " " << m_args.join(" ") << endl;
 225     qDebug() << "Started render process: " << m_prog << " " << m_args.join(" ");
 226 }
 227
 228
 229 void RenderJob::initKdenliveDbusInterface()
 230 {
 231     QString kdenliveId;
 232     QDBusConnection connection = QDBusConnection::sessionBus();
 233     QDBusConnectionInterface *ibus = connection.interface();
 234     const QStringList services = ibus->registeredServiceNames();
 235     foreach(const QString &service, services) {
 236         if (!service.startsWith("org.kde.kdenlive"))
 237             continue;
 238         kdenliveId = service;
 239         break;
 240     }
 241     m_dbusargs.clear();
 242     if (kdenliveId.isEmpty()) return;
 243     m_kdenliveinterface = new QDBusInterface(kdenliveId,
 244             "/MainWindow",
 245             "org.kdenlive.MainWindow",
 246             connection,
 247             this);
 248
 249     if (m_kdenliveinterface) {
 250         m_dbusargs.append(m_dest);
 251         m_dbusargs.append((int) 0);
 252         m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingProgress", m_dbusargs);
 253         connect(m_kdenliveinterface, SIGNAL(abortRenderJob(const QString &)),
 254                 this, SLOT(slotAbort(const QString&)));
 255     }
 256 }
 257
 258
 259 void RenderJob::slotCheckProcess(QProcess::ProcessState state)
 260 {
 261     if (state == QProcess::NotRunning) slotIsOver(m_renderProcess->exitStatus());
 262 }
 263
 264
 265
 266 void RenderJob::slotIsOver(QProcess::ExitStatus status)
 267 {
 268     if (m_jobUiserver) m_jobUiserver->call("terminate", QString());
 269     if (m_erase) {
 270         QFile f(m_scenelist);
 271         f.remove();
 272     }
 273     if (status == QProcess::CrashExit || m_renderProcess->error() != QProcess::UnknownError) {
 274         // rendering crashed
 275         if (m_kdenliveinterface) {
 276             m_dbusargs[1] = (int) - 2;
 277             m_dbusargs.append(m_errorMessage);
 278             m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
 279         }
 280         QStringList args;
 281         args << "--error" << tr("Rendering of %1 aborted, resulting video will probably be corrupted.").arg(m_dest);
 282         if (m_enablelog) m_logstream << "Rendering of " << m_dest << " aborted, resulting video will probably be corrupted." << endl;
 283         qDebug() << "Rendering of " << m_dest << " aborted, resulting video will probably be corrupted.";
 284         QProcess::startDetached("kdialog", args);
 285         qApp->quit();
 286     } else {
 287         if (!m_dualpass && m_kdenliveinterface) {
 288             m_dbusargs[1] = (int) - 1;
 289             m_dbusargs.append(QString());
 290             m_kdenliveinterface->callWithArgumentList(QDBus::NoBlock, "setRenderingFinished", m_dbusargs);
 291         }
 292         QDBusConnectionInterface* interface = QDBusConnection::sessionBus().interface();
 293         if (!m_dualpass && interface && interface->isServiceRegistered("org.kde.knotify")) {
 294             QDBusMessage m = QDBusMessage::createMethodCall("org.kde.knotify",
 295                              "/Notify",
 296                              "org.kde.KNotify",
 297                              "event");
 298             int seconds = m_startTime.secsTo(QTime::currentTime());
 299             QList<QVariant> args;
 300             args.append(QString("RenderFinished"));   // action name
 301             args.append(QString("kdenlive"));   // app name
 302             args.append(QVariantList());   // contexts
 303             args.append(tr("Rendering of %1 finished in %2").arg(m_dest, QTime(0, 0, seconds).toString("hh:mm:ss")));   // body
 304             args.append(QByteArray());   // app icon
 305             QStringList actionList;
 306             args.append(actionList);   // actions
 307             qlonglong wid = 0;
 308             args.append(wid);   // win id
 309
 310             m.setArguments(args);
 311             QDBusMessage replyMsg = QDBusConnection::sessionBus().call(m);
 312         }
 313         if (m_enablelog) m_logstream << "Rendering of " << m_dest << " finished" << endl;
 314         qDebug() << "Rendering of " << m_dest << " finished";
 315         if (!m_dualpass && m_player != "-") {
 316             if (m_enablelog) m_logstream << "Starting player" << endl;
 317             QStringList args;
 318             args << m_dest;
 319             QProcess::startDetached(m_player, args);
 320         }
 321         if (m_dualpass) {
 322             emit renderingFinished();
 323             deleteLater();
 324         } else qApp->quit();
 325     }
 326 }
 327
 328 #include "renderjob.moc"