oak-editor/app/node/param.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 "param.h"

#include <QColor>
#include <QDebug>
#include <QMatrix4x4>
#include <QVector2D>
#include <QVector3D>
#include <QVector4D>

#include "node/node.h"
#include "node/input.h"
#include "node/output.h"

NodeParam::NodeParam(const QString &id) :
  in_(-1),
  out_(-1),
  value_caching_(true),
  id_(id)
{
  Q_ASSERT(!id_.isEmpty());
}

const QString NodeParam::id()
{
  return id_;
}

QString NodeParam::name()
{
  if (name_.isEmpty()) {
    return tr("Value");
  }

  return name_;
}

void NodeParam::set_name(const QString &name)
{
  name_ = name;
}

Node *NodeParam::parent()
{
  return static_cast<Node*>(QObject::parent());
}

int NodeParam::index()
{
  return parent()->IndexOfParameter(this);
}

bool NodeParam::IsConnected()
{
  return !edges_.isEmpty();
}

const QVector<NodeEdgePtr> &NodeParam::edges()
{
  return edges_;
}

void NodeParam::DisconnectAll()
{
  while (!edges_.isEmpty()) {
    DisconnectEdge(edges_.first());
  }
}

NodeEdgePtr NodeParam::ConnectEdge(NodeOutput *output, NodeInput *input)
{
  // If the input can only accept one input (the default) and has one already, disconnect it
  DisconnectForNewOutput(input);

  // Make sure it's not a duplicate of an edge that already exists
  foreach (NodeEdgePtr existing, input->edges()) {
    if (existing->output() == output) {
      return nullptr;
    }
  }

  // Ensure both nodes are in the same graph
  if (output->parent()->parent() != input->parent()->parent()) {
    qWarning() << tr("Tried to connect two nodes that aren't part of the same graph");
    return nullptr;
  }

  NodeEdgePtr edge = std::make_shared<NodeEdge>(output, input);

  // The nodes should never be the same, and since we lock both nodes here, this can lead to a entire program freeze
  // that's difficult to diagnose. This makes that issue very clear.
  Q_ASSERT(output->parent() != input->parent());

  output->parent()->Lock();
  input->parent()->Lock();

  output->edges_.append(edge);
  input->edges_.append(edge);

  input->ClearCachedValue();

  output->parent()->Unlock();
  input->parent()->Unlock();

  // Emit a signal than an edge was added (only one signal needs emitting)
  emit input->EdgeAdded(edge);

  return edge;
}

void NodeParam::DisconnectEdge(NodeEdgePtr edge)
{
  NodeOutput* output = edge->output();
  NodeInput* input = edge->input();

  output->parent()->Lock();
  input->parent()->Lock();

  output->edges_.removeAll(edge);
  input->edges_.removeAll(edge);

  input->ClearCachedValue();

  output->parent()->Unlock();
  input->parent()->Unlock();

  emit input->EdgeRemoved(edge);
}

void NodeParam::DisconnectEdge(NodeOutput *output, NodeInput *input)
{
  for (int i=0;i<output->edges_.size();i++) {
    NodeEdgePtr edge = output->edges_.at(i);
    if (edge->input() == input) {
      DisconnectEdge(edge);
      break;
    }
  }
}

NodeEdgePtr NodeParam::DisconnectForNewOutput(NodeInput *input)
{
  // If the input can only accept one input (the default) and has one already, disconnect it
  if (!input->edges_.isEmpty()) {
    NodeEdgePtr edge = input->edges_.first();

    DisconnectEdge(edge);

    return edge;
  }

  return nullptr;
}

QString NodeParam::GetDefaultDataTypeName(const DataType& type)
{
  switch (type) {
  case kNone: return tr("None");
  case kInt: return tr("Integer");
  case kFloat: return tr("Float");
  case kColor: return tr("Color");
  case kString: return tr("String");
  case kBoolean: return tr("Boolean");
  case kFont: return tr("Font");
  case kFile: return tr("File");
  case kTexture: return tr("Texture");
  case kMatrix: return tr("Matrix");
  case kBlock: return tr("Block");
  case kFootage: return tr("Footage");
  case kTrack: return tr("Track");
  case kRational: return tr("Rational");
  case kVec2: return tr("Vector2D");
  case kVec3: return tr("Vector3D");
  case kVec4: return tr("Vector4D");
  case kSamples: return tr("Samples");
  case kAny: return tr("Any");
  }

  return QString();
}

QByteArray NodeParam::ValueToBytes(const NodeParam::DataType &type, const QVariant &value)
{
  switch (type) {
  case kInt: return ValueToBytesInternal<int>(value);
  case kFloat: return ValueToBytesInternal<float>(value);
  case kColor: return ValueToBytesInternal<QColor>(value);
  case kString: return ValueToBytesInternal<QString>(value);
  case kBoolean: return ValueToBytesInternal<bool>(value);
  case kFont: return ValueToBytesInternal<QString>(value); // FIXME: This should probably be a QFont?
  case kFile: return ValueToBytesInternal<QString>(value);
  case kMatrix: return ValueToBytesInternal<QMatrix4x4>(value);
  case kFootage: return ValueToBytesInternal<float>(value); // FIXME: Unsustainble, find some other way to match Footage
  case kRational: return ValueToBytesInternal<rational>(value);
  case kVec2: return ValueToBytesInternal<QVector2D>(value);
  case kVec3: return ValueToBytesInternal<QVector3D>(value);
  case kVec4: return ValueToBytesInternal<QVector4D>(value);

  // These types have no persistent input
  case kNone:
  case kTexture:
  case kBlock:
  case kTrack:
  case kSamples:
  case kAny:
    break;
  }

  return QByteArray();
}

void NodeParam::ClearCachedValue()
{
  // Since get_value() will (read: should) never receive a negative number, this will effectively invalidate any value
  // currently cached
  in_ = -1;
  out_ = -1;
}

const rational &NodeParam::LastRequestedIn()
{
  return in_;
}

bool NodeParam::ValueCachingEnabled()
{
  return value_caching_;
}

void NodeParam::SetValueCachingEnabled(bool enabled)
{
  value_caching_ = enabled;
}

template<typename T>
QByteArray NodeParam::ValueToBytesInternal(const QVariant &v)
{
  QByteArray bytes;

  int size_of_type = sizeof(T);

  bytes.resize(size_of_type);
  T raw_val = v.value<T>();
  memcpy(bytes.data(), &raw_val, static_cast<size_t>(size_of_type));

  return bytes;
}