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