oak-editor/app/node/processor/renderer/renderer.cpp

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2019 Olive Team

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

***/

#include "renderer.h"

#include <QApplication>
#include <QCryptographicHash>
#include <QDateTime>
#include <QDebug>
#include <QDir>
#include <QImage>
#include <QtMath>

#include "common/filefunctions.h"

RendererProcessor::RendererProcessor() :
  started_(false),
  width_(0),
  height_(0),
  caching_(false)
{
  texture_input_ = new NodeInput("tex_in");
  texture_input_->add_data_input(NodeInput::kTexture);
  AddParameter(texture_input_);

  texture_output_ = new NodeOutput("tex_out");
  texture_output_->set_data_type(NodeInput::kTexture);
  AddParameter(texture_output_);
}

QString RendererProcessor::Name()
{
  return tr("Renderer");
}

QString RendererProcessor::Category()
{
  return tr("Processor");
}

QString RendererProcessor::Description()
{
  return tr("A multi-threaded OpenGL hardware-accelerated node compositor.");
}

QString RendererProcessor::id()
{
  return "org.olivevideoeditor.Olive.renderervenus";
}

void RendererProcessor::SetCacheName(const QString &s)
{
  cache_name_ = s;
  cache_time_ = QDateTime::currentMSecsSinceEpoch();

  GenerateCacheIDInternal();
}

#include <QFileInfo>
QVariant RendererProcessor::Value(NodeOutput* output, const rational& time)
{
  if (output == texture_output_) {
    if (!texture_input_->IsConnected()) {
      // Nothing is connected - nothing to show or render
      return 0;
    }

    if (cache_id_.isEmpty()) {
      qWarning() << "RendererProcessor has no cache ID";
      return 0;
    }

    if (timebase_.isNull()) {
      qWarning() << "RendererProcessor has no timebase";
      return 0;
    }

    // FIXME: Test code only
    QString fn = CachePathName(time);
    if (QFileInfo::exists(fn)) {
      QFile cache_img(fn);

      if (cache_img.open(QFile::ReadOnly)) {

        QByteArray bytes = cache_img.readAll();

        master_texture_->Upload(bytes.constData());

        cache_img.close();

        return QVariant::fromValue(master_texture_);
      }
    }
    // End test code
  }

  return 0;
}

void RendererProcessor::Release()
{
  Stop();
}

void RendererProcessor::InvalidateCache(const rational &start_range, const rational &end_range)
{
  qDebug() << "[RendererProcessor] Cache invalidated between"
           << start_range.toDouble()
           << "and"
           << end_range.toDouble();

  // Snap start_range to timebase
  double start_range_dbl = start_range.toDouble();
  double start_range_numf = start_range_dbl * static_cast<double>(timebase_.denominator());
  int64_t start_range_numround = qFloor(start_range_numf/static_cast<double>(timebase_.numerator())) * timebase_.numerator();
  rational true_start_range(start_range_numround, timebase_.denominator());

  for (rational r=true_start_range;r<=end_range;r+=timebase_) {
    if (!cache_queue_.contains(r)) {
      cache_queue_.append(r);
    }
  }

  CacheNext();

  Node::InvalidateCache(start_range, end_range);
}

void RendererProcessor::SetTimebase(const rational &timebase)
{
  timebase_ = timebase;
  timebase_dbl_ = timebase_.toDouble();
}

void RendererProcessor::SetParameters(const int &width,
                                      const int &height,
                                      const olive::PixelFormat &format,
                                      const olive::RenderMode &mode)
{
  // Since we're changing parameters, all the existing threads are invalid and must be removed. They will start again
  // next time this Node has to process anything.
  Stop();

  // Set new parameters
  width_ = width;
  height_ = height;
  format_ = format;
  mode_ = mode;

  // Regenerate the cache ID
  GenerateCacheIDInternal();
}

void RendererProcessor::Start()
{
  if (started_) {
    return;
  }

  QOpenGLContext* ctx = QOpenGLContext::currentContext();

  threads_.resize(QThread::idealThreadCount());

  for (int i=0;i<threads_.size();i++) {
    threads_[i] = std::make_shared<RendererProcessThread>(ctx, width_, height_, format_, mode_);
    threads_[i]->StartThread(QThread::HighPriority);

    // Ensure this connection is "Queued" so that it always runs in this object's threaded rather than any of the
    // other threads
    connect(threads_[i].get(), SIGNAL(FinishedPath()), this, SLOT(ThreadCallback()), Qt::QueuedConnection);
    connect(threads_[i].get(), SIGNAL(RequestSibling(NodeDependency)), this, SLOT(ThreadRequestSibling(NodeDependency)), Qt::QueuedConnection);
  }

  // Create download thread
  download_thread_ = std::make_shared<RendererDownloadThread>(ctx, width_, height_, format_, mode_);
  download_thread_->StartThread(QThread::HighPriority);

  // Create master texture (the one sent to the viewer)
  master_texture_ = std::make_shared<RenderTexture>();
  master_texture_->Create(ctx, width_, height_, format_);

  started_ = true;
}

void RendererProcessor::Stop()
{
  if (!started_) {
    return;
  }

  started_ = false;

  foreach (RendererProcessThreadPtr process_thread, threads_) {
    process_thread->Cancel();
  }
  threads_.clear();

  download_thread_->Cancel();
  download_thread_ = nullptr;

  master_texture_ = nullptr;
}

void RendererProcessor::GenerateCacheIDInternal()
{
  if (cache_name_.isEmpty() || width_ == 0 || height_ == 0) {
    return;
  }

  // Generate an ID that is more or less guaranteed to be unique to this Sequence
  QCryptographicHash hash(QCryptographicHash::Sha1);
  hash.addData(cache_name_.toUtf8());
  hash.addData(QString::number(cache_time_).toUtf8());
  hash.addData(QString::number(width_).toUtf8());
  hash.addData(QString::number(height_).toUtf8());
  hash.addData(QString::number(format_).toUtf8());

  QByteArray bytes = hash.result();
  cache_id_ = bytes.toHex();
}

void RendererProcessor::CacheNext()
{
  if (cache_queue_.isEmpty() || !texture_input_->IsConnected() || caching_) {
    return;
  }

  // Make sure cache has started
  Start();

  cache_frame_ = cache_queue_.takeFirst();

  qDebug() << "[RendererProcessor] Caching" << cache_frame_.toDouble();

  // Run this probe in another thread
  master_thread_ = threads_.at(0).get();
  master_thread_->Queue(NodeDependency(texture_input_->get_connected_output(), cache_frame_), true);

  caching_ = true;
}

QString RendererProcessor::CachePathName(const rational &time)
{
  QDir this_cache_dir = QDir(GetMediaCacheLocation()).filePath(cache_id_);
  this_cache_dir.mkpath(".");

  QString filename = QString("%1.%2.jpg").arg(QString::number(time.numerator()), QString::number(time.denominator()));

  return this_cache_dir.filePath(filename);
}

void RendererProcessor::ThreadCallback()
{
  if (sender() == master_thread_) {
    // Threads are all done now, time to proceed
    caching_ = false;

    // FIXME: Save the texture results here
    RenderTexturePtr texture = texture_input_->get_value(cache_frame_).value<RenderTexturePtr>();


    QString fn = CachePathName(cache_frame_);
    if (texture == nullptr && QFileInfo::exists(fn)) {
      QFile(fn).remove();
    } else {
      download_thread_->Queue(texture, fn);
    }

    CacheNext();
  }
}

void RendererProcessor::ThreadRequestSibling(NodeDependency dep)
{
  // Try to queue another thread to run this dep in advance
  for (int i=0;i<threads_.size();i++) {
    if (threads_.at(i)->Queue(dep, false)) {
      return;
    }
  }
}

RendererThreadBase* RendererProcessor::CurrentThread()
{
  return dynamic_cast<RendererThreadBase*>(QThread::currentThread());
}

RenderInstance *RendererProcessor::CurrentInstance()
{
  RendererThreadBase* thread = CurrentThread();

  if (thread != nullptr) {
    return thread->render_instance();
  }

  return nullptr;
}

NodeInput *RendererProcessor::texture_input()
{
  return texture_input_;
}

NodeOutput *RendererProcessor::texture_output()
{
  return texture_output_;
}