Files
kdenlive/renderer/renderjob.cpp

359 lines
13 KiB
C++

/*
SPDX-FileCopyrightText: 2007 Jean-Baptiste Mardelle <jb@kdenlive.org>
SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
*/
#include "renderjob.h"
#include <QApplication>
#include <QDebug>
#include <QDir>
#include <QElapsedTimer>
#include <QJsonDocument>
#include <QJsonObject>
#include <QStandardPaths>
#include <QStringList>
#include <QThread>
#include <utility>
// Can't believe I need to do this to sleep.
class SleepThread : QThread
{
public:
void run() override {}
static void msleep(unsigned long msecs) { QThread::msleep(msecs); }
};
RenderJob::RenderJob(const QString &render, const QString &scenelist, const QString &target, int pid, int in, int out, const QString &subtitleFile,
bool debugMode, QObject *parent)
: QObject(parent)
, m_scenelist(scenelist)
, m_dest(target)
, m_progress(0)
, m_prog(render)
, m_kdenlivesocket(new QLocalSocket(this))
, m_logfile(m_dest + QStringLiteral(".log"))
, m_erase(scenelist.startsWith(QDir::tempPath()) || scenelist.startsWith(QString("xml:%2").arg(QDir::tempPath())))
, m_seconds(0)
, m_frame(in)
, m_framein(in)
, m_frameout(out)
, m_pid(pid)
, m_dualpass(false)
, m_subtitleFile(subtitleFile)
, m_debugMode(debugMode)
{
m_renderProcess = new QProcess(&m_looper);
m_renderProcess->setReadChannel(QProcess::StandardError);
connect(m_renderProcess, &QProcess::finished, this, &RenderJob::slotCheckProcess);
// Disable VDPAU so that rendering will work even if there is a Kdenlive instance using VDPAU
qputenv("MLT_NO_VDPAU", "1");
if (m_debugMode) {
// Enforce repository since we have a failure in kdenlive-test-suite where MLT's repository is randomly set to usr/bin/lib/mlt-7 instead of
// usr/lib/mlt-7
QDir dataDir = QFileInfo(m_prog).absoluteDir();
if (dataDir.cd("../lib/mlt-7")) {
m_args << "-repository" << dataDir.absolutePath();
}
}
m_args << "-progress2" << scenelist;
// Create a log of every render process.
if (!m_logfile.open(QIODevice::WriteOnly | QIODevice::Text)) {
qWarning() << "Unable to log to " << m_logfile.fileName();
} else {
m_logstream.setDevice(&m_logfile);
}
m_connectTimer.setSingleShot(true);
m_connectTimer.setInterval(5000);
}
RenderJob::~RenderJob()
{
if (m_kdenlivesocket->state() == QLocalSocket::ConnectedState) {
m_kdenlivesocket->disconnectFromServer();
}
delete m_kdenlivesocket;
delete m_renderProcess;
m_logfile.close();
}
void RenderJob::slotAbort(const QString &url)
{
if (m_dest == url) {
slotAbort();
}
}
void RenderJob::sendFinish(int status, const QString &error)
{
if (m_kdenlivesocket->state() == QLocalSocket::ConnectedState) {
QJsonObject method, args;
args["url"] = m_dest;
args["status"] = status;
args["error"] = error;
method["setRenderingFinished"] = args;
m_kdenlivesocket->write(QJsonDocument(method).toJson());
m_kdenlivesocket->flush();
} else {
if (!QFile::exists(m_dest)) {
qDebug() << "Rendering to" << m_dest << "finished. Status:" << status << "Errors: Result file does not exist!!!";
qDebug() << "===================\nJOB OUTPUT: " << m_renderProcess->readAllStandardOutput();
} else {
qDebug() << "Rendering to" << m_dest << "finished. Status:" << status << "Errors:" << error;
}
}
}
void RenderJob::slotAbort()
{
m_renderProcess->kill();
sendFinish(-3, QString());
if (m_erase) {
QFile(m_scenelist).remove();
}
QFile(m_dest).remove();
m_logstream << "Job aborted by user"
<< "\n";
m_logstream.flush();
m_logfile.close();
qApp->quit();
}
void RenderJob::receivedStderr()
{
QString result = QString::fromLocal8Bit(m_renderProcess->readAllStandardError());
if (!result.contains(QLatin1Char('\n'))) {
m_outputData.append(result);
return;
}
result.prepend(m_outputData);
m_outputData.clear();
result = result.simplified();
if (!result.startsWith(QLatin1String("Current Frame"))) {
m_errorMessage.append(result + QStringLiteral("<br>"));
m_logstream << result;
} else {
bool ok;
int progress = result.section(QLatin1Char(' '), -1).toInt(&ok);
if (!ok) {
return;
}
int frame = result.section(QLatin1Char(','), 0, 0).section(QLatin1Char(' '), -1).toInt(&ok);
if (!ok || progress <= m_progress || progress <= 0 || progress > 100 || frame < m_frame) {
return;
}
m_progress = progress;
if (m_args.contains(QStringLiteral("pass=1"))) {
m_progress /= 2;
} else if (m_args.contains(QStringLiteral("pass=2"))) {
m_progress = 50 + m_progress / 2;
}
qint64 elapsedTime = m_startTime.secsTo(QDateTime::currentDateTime());
if (elapsedTime == m_seconds) {
return;
}
m_seconds = elapsedTime;
m_frame = frame;
updateProgress();
}
}
void RenderJob::updateProgress()
{
if (m_kdenlivesocket->state() == QLocalSocket::ConnectedState) {
QJsonObject method, args;
args["url"] = m_dest;
args["progress"] = m_progress;
args["frame"] = m_frame;
method["setRenderingProgress"] = args;
m_kdenlivesocket->write(QJsonDocument(method).toJson());
m_kdenlivesocket->flush();
#if defined(Q_OS_WIN) || defined(Q_OS_MAC)
}
#else
} else if (!m_connectTimer.isActive()) {
// Linux, try to reconnect if we have a Kdenlive instance
QStringList files = QDir::temp().entryList({QStringLiteral("org.kde.kdenlive*")}, QDir::System);
qDebug() << "=== FOUND POSS MATHCES:" << files;
if (!files.isEmpty()) {
qDebug() << "::: FOUND POSSIBLE RUNNING INSTANCE: " << files.first();
bool ok;
int pid = files.first().section(QLatin1Char('-'), -1).toInt(&ok);
qDebug() << "::: FOUND POSSIBLE RUNNING INSTANCE PID: " << pid;
if (ok && pid > -1) {
m_pid = pid;
QString servername = QStringLiteral("org.kde.kdenlive-%1").arg(m_pid);
m_kdenlivesocket->connectToServer(servername);
}
}
m_connectTimer.start();
qDebug() << "Progress:" << m_progress << "%,"
<< "frame" << m_frame;
}
#endif
m_logstream << QStringLiteral("%1\t%2\t%3\n").arg(m_seconds).arg(m_frame).arg(m_progress);
}
void RenderJob::start()
{
m_startTime = QDateTime::currentDateTime();
if (m_pid > -1) {
connect(m_kdenlivesocket, &QLocalSocket::connected, this, [this]() {
QJsonObject obj;
obj["url"] = m_dest;
m_kdenlivesocket->write(QJsonDocument(obj).toJson());
m_kdenlivesocket->flush();
QJsonObject method, args;
args["url"] = m_dest;
args["progress"] = 0;
args["frame"] = 0;
method["setRenderingProgress"] = args;
m_kdenlivesocket->write(QJsonDocument(method).toJson());
m_kdenlivesocket->flush();
});
connect(m_kdenlivesocket, &QLocalSocket::readyRead, this, [this]() {
QByteArray msg = m_kdenlivesocket->readAll();
if (msg == "abort") {
slotAbort();
}
});
QString servername = QStringLiteral("org.kde.kdenlive-%1").arg(m_pid);
m_kdenlivesocket->connectToServer(servername);
}
// Because of the logging, we connect to stderr in all cases.
connect(m_renderProcess, &QProcess::readyReadStandardError, this, &RenderJob::receivedStderr);
m_logstream << "Started render process: " << m_prog << ' ' << m_args.join(QLatin1Char(' ')) << "\n";
m_renderProcess->start(m_prog, m_args);
if (m_debugMode) {
m_logstream << "Using MLT REPOSITORY: " << qgetenv("MLT_REPOSITORY") << "\n";
m_logstream << "Using MLT DATA: " << qgetenv("MLT_DATA") << "\n";
m_logstream << "Using MLT APPDIR: " << qgetenv("MLT_APPDIR") << "\n";
}
m_logstream.flush();
m_looper.exec();
}
void RenderJob::slotCheckProcess(int /*exitCode*/, QProcess::ExitStatus exitStatus)
{
slotIsOver(exitStatus);
}
void RenderJob::slotIsOver(QProcess::ExitStatus status, bool isWritable)
{
if (!isWritable) {
QString error = tr("Cannot write to %1, check permissions.").arg(m_dest);
sendFinish(-2, error);
// assumes kdialog installed!!
QProcess::startDetached(QStringLiteral("kdialog"), {QStringLiteral("--error"), error});
m_logstream << error << "\n";
Q_EMIT renderingFinished();
// qApp->quit();
}
if (m_erase) {
QFile(m_scenelist).remove();
}
if (status == QProcess::CrashExit || m_renderProcess->error() != QProcess::UnknownError || m_renderProcess->exitCode() != 0) {
// rendering crashed
sendFinish(-2, m_errorMessage);
QStringList args;
QString error = tr("Rendering of %1 aborted, resulting video will probably be corrupted.").arg(m_dest);
if (m_frame > 0) {
error += QLatin1Char('\n') + tr("Frame: %1").arg(m_frame);
}
args << QStringLiteral("--error") << error;
m_logstream << error << "\n";
QProcess::startDetached(QStringLiteral("kdialog"), args);
Q_EMIT renderingFinished();
} else {
m_logstream << "Rendering of " << m_dest << " finished"
<< "\n";
m_logstream.flush();
if (m_dualpass) {
deleteLater();
} else {
if (!m_debugMode && QFile::exists(m_dest)) {
m_logfile.remove();
}
if (!m_subtitleFile.isEmpty()) {
// Embed subtitles
QString ffmpegExe = QStandardPaths::findExecutable(QStringLiteral("ffmpeg"));
if (!ffmpegExe.isEmpty()) {
QFileInfo videoRender(m_dest);
m_temporaryRenderFile = QDir::temp().absoluteFilePath(videoRender.fileName());
QStringList args = {
"-y", "-v", "quiet", "-stats", "-i", m_dest, "-i", m_subtitleFile, "-c", "copy", "-f", "matroska", m_temporaryRenderFile};
qDebug() << "::: JOB ARGS: " << args;
m_progress = 0;
disconnect(m_renderProcess, &QProcess::finished, this, &RenderJob::slotCheckProcess);
disconnect(m_renderProcess, &QProcess::readyReadStandardError, this, &RenderJob::receivedStderr);
m_subsProcess = new QProcess(&m_looper);
m_subsProcess->setProcessChannelMode(QProcess::MergedChannels);
connect(m_subsProcess, &QProcess::readyReadStandardOutput, this, &RenderJob::receivedSubtitleProgress);
m_subsProcess->start(ffmpegExe, args);
m_subsProcess->waitForStarted(-1);
m_subsProcess->waitForFinished(-1);
slotCheckSubtitleProcess(m_subsProcess->exitCode(), m_subsProcess->exitStatus());
return;
}
}
sendFinish(-1, QString());
}
}
Q_EMIT renderingFinished();
m_looper.quit();
}
void RenderJob::receivedSubtitleProgress()
{
QString outputData = QString::fromLocal8Bit(m_subsProcess->readAllStandardOutput()).simplified();
if (outputData.isEmpty()) {
return;
}
QStringList output = outputData.split(QLatin1Char(' '));
m_errorMessage.append(outputData + QStringLiteral("<br>"));
QString result = output.takeFirst();
bool ok = false;
int frame = -1;
if (result == (QLatin1String("frame=")) && !output.isEmpty()) {
// Frame number is the second parameter
result = output.takeFirst();
frame = result.toInt(&ok);
} else if (result.startsWith(QLatin1String("frame="))) {
frame = result.section(QLatin1Char('='), 1).toInt(&ok);
}
if (ok && frame > 0) {
m_frame = frame;
m_progress = 100 * frame / (m_frameout - m_framein);
if (m_progress > 0) {
updateProgress();
}
}
}
void RenderJob::slotCheckSubtitleProcess(int exitCode, QProcess::ExitStatus exitStatus)
{
if (exitStatus == QProcess::CrashExit || !QFile::exists(m_temporaryRenderFile)) {
// rendering crashed
qDebug() << ":::: FOUND ERROR IN SUBS: " << exitStatus << " / " << exitCode << ", FILE EXISTS: " << QFile::exists(m_temporaryRenderFile);
QString error = tr("Rendering of %1 aborted when adding subtitles.").arg(m_dest);
m_errorMessage.append(error);
sendFinish(-2, m_errorMessage);
QStringList args;
if (m_frame > 0) {
error += QLatin1Char('\n') + tr("Frame: %1").arg(m_frame);
}
args << QStringLiteral("--error") << error;
m_logstream << error << "\n";
QProcess::startDetached(QStringLiteral("kdialog"), args);
} else {
QFile::remove(m_dest);
QFile::rename(m_temporaryRenderFile, m_dest);
sendFinish(-1, QString());
}
QFile::remove(m_subtitleFile);
Q_EMIT renderingFinished();
m_looper.quit();
}