oak-editor/app/node/traverser.cpp

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2021 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 "traverser.h"

#include "node.h"
#include "render/job/footagejob.h"
#include "render/rendermanager.h"

namespace olive {

NodeValueDatabase NodeTraverser::GenerateDatabase(const Node* node, const TimeRange &range)
{
  NodeValueDatabase database;

  // We need to insert tables into the database for each input
  foreach (const QString& input, node->inputs()) {
    if (IsCancelled()) {
      return NodeValueDatabase();
    }

    database.Insert(input, ProcessInput(node, input, range));
  }

  return database;
}

NodeValueRow NodeTraverser::GenerateRow(NodeValueDatabase *database, const Node *node, const TimeRange &range)
{
  // Generate row
  NodeValueRow row;
  for (auto it=database->begin(); it!=database->end(); it++) {
    // Get hint for which value should be pulled
    NodeValue value = GenerateRowValue(node, it.key(), &it.value());
    row.insert(it.key(), value);
  }

  PreProcessRow(range, row);

  return row;
}

NodeValueRow NodeTraverser::GenerateRow(const Node *node, const TimeRange &range)
{
  // Generate database of input values of node
  NodeValueDatabase database = GenerateDatabase(node, range);

  return GenerateRow(&database, node, range);
}

NodeValue NodeTraverser::GenerateRowValue(const Node *node, const QString &input, NodeValueTable *table)
{
  NodeValue value = GenerateRowValueElement(node, input, -1, table);

  if (value.array()) {
    // Resolve each element of array
    QVector<NodeValueTable> tables = value.data().value<QVector<NodeValueTable> >();
    QVector<NodeValue> output(tables.size());

    for (int i=0; i<tables.size(); i++) {
      output[i] = GenerateRowValueElement(node, input, i, &tables[i]);
    }

    value = NodeValue(value.type(), QVariant::fromValue(output), value.source(), value.array(), value.tag());
  }

  return value;
}

NodeValue NodeTraverser::GenerateRowValueElement(const Node *node, const QString &input, int element, NodeValueTable *table)
{
  return GenerateRowValueElement(node->GetValueHintForInput(input, element), node->GetInputDataType(input), table);
}

NodeValue NodeTraverser::GenerateRowValueElement(const Node::ValueHint &hint, NodeValue::Type preferred_type, NodeValueTable *table)
{
  int value_index = GenerateRowValueElementIndex(hint, preferred_type, table);

  if (value_index == -1) {
    // If value was -1, try getting the last value
    value_index = table->Count() - 1;
  }

  if (value_index == -1) {
    // If value is still -1, assume the table is empty and return nothing
    return NodeValue();
  }

  return table->TakeAt(value_index);
}

int NodeTraverser::GenerateRowValueElementIndex(const Node::ValueHint &hint, NodeValue::Type preferred_type, const NodeValueTable *table)
{
  QVector<NodeValue::Type> types = hint.types();

  if (types.isEmpty()) {
    types.append(preferred_type);
  }

  if (hint.index() == -1) {
    // Get most recent value with this type and tag
    return table->GetValueIndex(types, hint.tag());
  } else {
    // Try to find value at this index
    int index = table->Count() - 1 - hint.index();
    int diff = 0;

    while (index + diff < table->Count() && index - diff >= 0) {
      if (index + diff < table->Count() && types.contains(table->at(index + diff).type())) {
        return index + diff;
      }
      if (index - diff >= 0 && types.contains(table->at(index - diff).type())) {
        return index - diff;
      }
      diff++;
    }

    return -1;
  }
}

int NodeTraverser::GenerateRowValueElementIndex(const Node *node, const QString &input, int element, const NodeValueTable *table)
{
  return GenerateRowValueElementIndex(node->GetValueHintForInput(input, element), node->GetInputDataType(input), table);
}

NodeGlobals NodeTraverser::GenerateGlobals(const VideoParams &params, const TimeRange &time)
{
  return NodeGlobals(QVector2D(params.width(), params.height()), params.pixel_aspect_ratio(), time);
}

int NodeTraverser::GetChannelCountFromJob(const GenerateJob &job)
{
  int max_channel_count = 0;

  // Find maximum channel count
  for (auto it=job.GetValues().cbegin(); it!=job.GetValues().cend(); it++) {
    if (it.value().type() == NodeValue::kTexture) {
      TexturePtr tex = it.value().data().value<TexturePtr>();
      if (tex) {
        max_channel_count = qMax(max_channel_count, tex->channel_count());
      }
    }
  }
  if (max_channel_count == 0) {
    max_channel_count = VideoParams::kRGBChannelCount;
  }

  switch (job.GetAlphaChannelRequired()) {
  case GenerateJob::kAlphaForceOn:
    return VideoParams::kRGBAChannelCount;
  case GenerateJob::kAlphaForceOff:
    if (max_channel_count >= 1 && max_channel_count < VideoParams::kRGBChannelCount) {
      return max_channel_count;
    } else {
      return VideoParams::kRGBChannelCount;
    }
  case GenerateJob::kAlphaAuto:
    return max_channel_count;
  }

  // Default fallback, should never get here
  return VideoParams::kRGBAChannelCount;
}

NodeValueTable NodeTraverser::ProcessInput(const Node* node, const QString& input, const TimeRange& range)
{
  // If input is connected, retrieve value directly
  if (node->IsInputConnected(input)) {

    TimeRange adjusted_range = node->InputTimeAdjustment(input, -1, range);

    // Value will equal something from the connected node, follow it
    return GenerateTable(node->GetConnectedOutput(input), node->GetValueHintForInput(input), adjusted_range);

  } else {

    // Store node
    QVariant return_val;
    bool is_array = node->InputIsArray(input);

    if (is_array) {

      // Value is an array, we will return a list of NodeValueTables
      QVector<NodeValueTable> array_tbl(node->InputArraySize(input));

      for (int i=0; i<array_tbl.size(); i++) {
        NodeValueTable& sub_tbl = array_tbl[i];
        TimeRange adjusted_range = node->InputTimeAdjustment(input, i, range);

        if (node->IsInputConnected(input, i)) {
          sub_tbl = GenerateTable(node->GetConnectedOutput(input, i), node->GetValueHintForInput(input, i), adjusted_range);
        } else {
          QVariant input_value = node->GetValueAtTime(input, adjusted_range.in(), i);
          sub_tbl.Push(node->GetInputDataType(input), input_value, node);
        }
      }

      return_val = QVariant::fromValue(array_tbl);

    } else {

      // Not connected or an array, just pull the immediate
      TimeRange adjusted_range = node->InputTimeAdjustment(input, -1, range);

      return_val = node->GetValueAtTime(input, adjusted_range.in());

    }

    NodeValueTable return_table;
    return_table.Push(node->GetInputDataType(input), return_val, node, is_array);
    return return_table;

  }
}

NodeTraverser::NodeTraverser() :
  cancel_(nullptr)
{
}

NodeValueTable NodeTraverser::GenerateTable(const Node *n, const Node::ValueHint &hint, const TimeRange& range)
{
  const Track* track = dynamic_cast<const Track*>(n);
  if (track) {
    // If the range is not wholly contained in this Block, we'll need to do some extra processing
    return GenerateBlockTable(track, range);
  }

  // FIXME: Cache certain values here if we've already processed them before

  // Generate row for node
  NodeValueDatabase database = GenerateDatabase(n, range);

  // Check for bypass
  bool is_enabled;
  if (!database[Node::kEnabledInput].Has(NodeValue::kBoolean)) {
    // Fallback if we couldn't find a bool value
    is_enabled = true;
  } else {
    is_enabled = database[Node::kEnabledInput].Get(NodeValue::kBoolean).toBool();
  }

  if (is_enabled) {
    NodeValueRow row = GenerateRow(&database, n, range);

    // Generate output table
    NodeValueTable table = database.Merge();

    // By this point, the node should have all the inputs it needs to render correctly
    n->Value(row, GenerateGlobals(video_params_, range), &table);

    return table;
  } else {
    // If this node has an effect input, ensure that is pushed last
    NodeValueTable primary;
    if (!n->GetEffectInputID().isEmpty()) {
      primary = database.Take(n->GetEffectInputID());
    }

    NodeValueTable m = database.Merge();
    m.Push(primary);
    return m;
  }
}

NodeValueTable NodeTraverser::GenerateBlockTable(const Track *track, const TimeRange &range)
{
  // By default, just follow the in point
  Block* active_block = track->BlockAtTime(range.in());

  NodeValueTable table;

  if (active_block) {
    table = GenerateTable(active_block, track->GetValueHintForInput(Track::kBlockInput, track->GetArrayIndexFromBlock(active_block)), Track::TransformRangeForBlock(active_block, range));
  }

  return table;
}


QVector2D NodeTraverser::GenerateResolution() const
{
  return QVector2D(video_params_.square_pixel_width(), video_params_.height());
}

void NodeTraverser::ResolveJobs(NodeValue &val, const TimeRange &range)
{
  if (val.type() == NodeValue::kTexture || val.type() == NodeValue::kSamples) {
    const QVariant &v = val.data();

    if (v.canConvert<ShaderJob>()) {

      ShaderJob job = v.value<ShaderJob>();

      VideoParams tex_params = GetCacheVideoParams();
      tex_params.set_channel_count(GetChannelCountFromJob(job));

      TexturePtr tex = CreateTexture(tex_params);

      PreProcessRow(range, job.GetValues());
      ProcessShader(tex, val.source(), range, job);

      val.set_data(QVariant::fromValue(tex));

    } else if (v.canConvert<GenerateJob>()) {

      GenerateJob job = v.value<GenerateJob>();

      VideoParams tex_params = GetCacheVideoParams();
      tex_params.set_channel_count(GetChannelCountFromJob(job));

      VideoParams upload_params = tex_params;
      if (job.GetRequestedFormat() != VideoParams::kFormatInvalid) {
        upload_params.set_format(job.GetRequestedFormat());
      }

      TexturePtr tex = CreateTexture(upload_params);

      PreProcessRow(range, job.GetValues());
      ProcessFrameGeneration(tex, val.source(), job);

      if (!job.GetColorspace().isEmpty()) {
        // Convert to reference space
        TexturePtr dest = CreateTexture(tex_params);

        ConvertToReferenceSpace(dest, tex, job.GetColorspace());

        tex = dest;
      }

      val.set_data(QVariant::fromValue(tex));

    } else if (v.canConvert<ColorTransformJob>()) {

      ColorTransformJob job = v.value<ColorTransformJob>();

      VideoParams src_params = job.GetInputTexture()->params();
      src_params.set_channel_count(GetChannelCountFromJob(job));

      TexturePtr dest = CreateTexture(src_params);

      ProcessColorTransform(dest, val.source(), job);

      val.set_data(QVariant::fromValue(dest));

    } else if (v.canConvert<FootageJob>()) {

      FootageJob job = v.value<FootageJob>();

      if (job.type() == Track::kVideo) {

        rational footage_time = Footage::AdjustTimeByLoopMode(range.in(), job.loop_mode(), job.length(), job.video_params().video_type(), job.video_params().frame_rate_as_time_base());

        TexturePtr tex;

        // Adjust footage job's divider
        VideoParams render_params = GetCacheVideoParams();
        VideoParams job_params = job.video_params();

        // HACK/FIXME: Override old cached probe data that contains an invalid divider. Might be
        //             good in the future to version the probe data so we can automatically
        //             ignore older stuff.
        job_params.set_divider(render_params.divider());

        // See if we can make this divider larger (i.e. if the footage is smaller)
        while (job_params.divider() > 1
               && VideoParams::GetScaledDimension(job_params.width(), job_params.divider()-1) < render_params.effective_width()
               && VideoParams::GetScaledDimension(job_params.height(), job_params.divider()-1) < render_params.effective_height()) {
          job_params.set_divider(job_params.divider() - 1);
        }
        job.set_video_params(job_params);

        if (footage_time.isNaN()) {
          // Push dummy texture
          tex = CreateDummyTexture(job.video_params());
        } else {
          VideoParams managed_params = job.video_params();
          managed_params.set_format(GetCacheVideoParams().format());

          tex = CreateTexture(job.video_params());
          ProcessVideoFootage(tex, job, footage_time);
        }

        val.set_data(QVariant::fromValue(tex));

      } else if (job.type() == Track::kAudio) {

        SampleBufferPtr buffer = CreateSampleBuffer(GetCacheAudioParams(), range.length());
        ProcessAudioFootage(buffer, job, range);
        val.set_data(QVariant::fromValue(buffer));

      }

    } else if (v.canConvert<SampleJob>()) {

      SampleJob job = v.value<SampleJob>();
      SampleBufferPtr output_buffer = CreateSampleBuffer(job.samples()->audio_params(), job.samples()->sample_count());
      ProcessSamples(output_buffer, val.source(), range, job);
      val.set_data(QVariant::fromValue(output_buffer));

    }

  }
}

void NodeTraverser::PreProcessRow(const TimeRange &range, NodeValueRow &row)
{
  QByteArray cached_node_hash;

  // Resolve any jobs
  for (auto it=row.begin(); it!=row.end(); it++) {
    // Jobs will almost always be submitted with one of these types
    NodeValue &val = it.value();

    ResolveJobs(val, range);
  }
}

TexturePtr NodeTraverser::CreateDummyTexture(const VideoParams &p)
{
  return std::make_shared<Texture>(p);
}

}