oak-editor/app/node/block/block.h

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2020 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/>.

***/

#ifndef BLOCK_H
#define BLOCK_H

#include "node/node.h"
#include "timeline/timelinecommon.h"

namespace olive {

class TransitionBlock;

/**
 * @brief A Node that represents a block of time, also displayable on a Timeline
 */
class Block : public Node
{
  Q_OBJECT
public:
  Block();

  enum Type {
    kClip,
    kGap,
    kTransition
  };

  virtual Type type() const = 0;

  virtual QVector<CategoryID> Category() const override;

  const rational& in() const
  {
    return in_point_;
  }

  const rational& out() const
  {
    return out_point_;
  }

  void set_in(const rational& in)
  {
    in_point_ = in;
  }

  void set_out(const rational& out)
  {
    out_point_ = out;
  }

  rational length() const;
  void set_length_and_media_out(const rational &length);
  void set_length_and_media_in(const rational &length);

  TimeRange range() const
  {
    return TimeRange(in(), out());
  }

  Block* previous() const
  {
    return previous_;
  }

  Block* next() const
  {
    return next_;
  }

  void set_previous(Block* previous)
  {
    previous_ = previous;
  }

  void set_next(Block* next)
  {
    next_ = next;
  }

  rational media_in() const;
  void set_media_in(const rational& media_in);

  Track* track() const
  {
    return track_;
  }

  void set_track(Track* track)
  {
    track_ = track;
  }

  bool is_enabled() const;
  void set_enabled(bool e);

  static bool Link(Block* a, Block* b);
  static void Link(const QList<Block*>& blocks);
  static bool Unlink(Block* a, Block* b);
  static void Unlink(const QList<Block*>& blocks);
  static bool AreLinked(Block* a, Block* b);

  const QVector<Block*>& linked_clips() const
  {
    return linked_clips_;
  }

  bool HasLinks() const
  {
    return !linked_clips_.isEmpty();
  }

  virtual void Retranslate() override;

  NodeInput* length_input() const
  {
    return length_input_;
  }

  NodeInput* media_in_input() const
  {
    return media_in_input_;
  }

  NodeInput* speed_input() const
  {
    return speed_input_;
  }

  TransitionBlock* in_transition()
  {
    return in_transition_;
  }

  void set_in_transition(TransitionBlock* t)
  {
    in_transition_ = t;
  }

  TransitionBlock* out_transition()
  {
    return out_transition_;
  }

  void set_out_transition(TransitionBlock* t)
  {
    out_transition_ = t;
  }

  virtual void Hash(QCryptographicHash &hash, const rational &time) const override;

public slots:

signals:
  void LinksChanged();

  void EnabledChanged();

  void LengthChanged();

protected:
  rational SequenceToMediaTime(const rational& sequence_time) const;

  rational MediaToSequenceTime(const rational& media_time) const;

  virtual void LoadInternal(QXmlStreamReader* reader, XMLNodeData& xml_node_data) override;

  virtual void SaveInternal(QXmlStreamWriter* writer) const override;

  virtual QVector<NodeInput*> GetInputsToHash() const override;

  Block* previous_;
  Block* next_;

private:
  void set_length_internal(const rational &length);

  NodeInput* length_input_;
  NodeInput* media_in_input_;
  NodeInput* speed_input_;
  NodeInput* enabled_input_;

  rational in_point_;
  rational out_point_;
  Track* track_;

  TransitionBlock* in_transition_;
  TransitionBlock* out_transition_;

  QVector<Block*> linked_clips_;

};

}

#endif // BLOCK_H