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