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