oak-editor/app/common/timerange.h

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2022 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 TIMERANGE_H
#define TIMERANGE_H

#include "rational.h"
#include "timecodefunctions.h"

namespace olive {

class TimeRange {
public:
  TimeRange() = default;
  TimeRange(const rational& in, const rational& out);

  const rational& in() const;
  const rational& out() const;
  const rational& length() const;

  void set_in(const rational& in);
  void set_out(const rational& out);
  void set_range(const rational& in, const rational& out);

  bool operator==(const TimeRange& r) const;
  bool operator!=(const TimeRange& r) const;

  bool OverlapsWith(const TimeRange& a, bool in_inclusive = true, bool out_inclusive = true) const;
  bool Contains(const TimeRange& a, bool in_inclusive = true, bool out_inclusive = true) const;
  bool Contains(const rational& r) const;

  TimeRange Combined(const TimeRange& a) const;
  static TimeRange Combine(const TimeRange &a, const TimeRange &b);
  TimeRange Intersected(const TimeRange& a) const;
  static TimeRange Intersect(const TimeRange &a, const TimeRange &b);

  TimeRange operator+(const rational& rhs) const;
  TimeRange operator-(const rational& rhs) const;

  const TimeRange& operator+=(const rational &rhs);
  const TimeRange& operator-=(const rational &rhs);

  std::list<TimeRange> Split(const int &chunk_size) const;

private:
  void normalize();

  rational in_;
  rational out_;
  rational length_;

};

class TimeRangeList {
public:
  TimeRangeList() = default;

  TimeRangeList(std::initializer_list<TimeRange> r) :
    array_(r)
  {
  }

  void insert(const TimeRangeList &list_to_add);
  void insert(TimeRange range_to_add);

  void remove(const TimeRange& remove);
  void remove(const TimeRangeList &list);

  template <typename T>
  static void util_remove(QVector<T> *list, const TimeRange &remove)
  {
    int sz = list->size();

    for (int i=0;i<sz;i++) {
      T& compare = (*list)[i];

      if (remove.Contains(compare)) {
        // This element is entirely encompassed in this range, remove it
        list->removeAt(i);
        i--;
        sz--;
      } else if (compare.Contains(remove, false, false)) {
        // The remove range is within this element, only choice is to split the element into two
        T new_range = compare;
        new_range.set_in(remove.out());
        compare.set_out(remove.in());
        list->append(new_range);
        break;
      } else if (compare.in() < remove.in() && compare.out() > remove.in()) {
        // This element's out point overlaps the range's in, we'll trim it
        compare.set_out(remove.in());
      } else if (compare.in() < remove.out() && compare.out() > remove.out()) {
        // This element's in point overlaps the range's out, we'll trim it
        compare.set_in(remove.out());
      }
    }
  }

  bool contains(const TimeRange& range, bool in_inclusive = true, bool out_inclusive = true) const;

  bool contains(const rational &r) const
  {
    for (const TimeRange &range : array_) {
      if (range.Contains(r)) {
        return true;
      }
    }

    return false;
  }

  bool isEmpty() const
  {
    return array_.isEmpty();
  }

  void clear()
  {
    array_.clear();
  }

  int size() const
  {
    return array_.size();
  }

  void shift(const rational& diff);

  void trim_in(const rational& diff);

  void trim_out(const rational& diff);

  TimeRangeList Intersects(const TimeRange& range) const;

  using const_iterator = QVector<TimeRange>::const_iterator;

  const_iterator begin() const
  {
    return array_.constBegin();
  }

  const_iterator end() const
  {
    return array_.constEnd();
  }

  const_iterator cbegin() const
  {
    return begin();
  }

  const_iterator cend() const
  {
    return end();
  }

  const TimeRange& first() const
  {
    return array_.first();
  }

  const TimeRange& last() const
  {
    return array_.last();
  }

  const TimeRange& at(int index) const
  {
    return array_.at(index);
  }

  const QVector<TimeRange>& internal_array() const
  {
    return array_;
  }

  bool operator==(const TimeRangeList &rhs) const
  {
    return array_ == rhs.array_;
  }

private:
  QVector<TimeRange> array_;

};

class TimeRangeListFrameIterator
{
public:
  TimeRangeListFrameIterator();
  TimeRangeListFrameIterator(const TimeRangeList &list, const rational &timebase);

  rational Snap(const rational &r) const;

  bool GetNext(rational *out);

  bool HasNext() const;

  QVector<rational> ToVector() const
  {
    TimeRangeListFrameIterator copy(list_, timebase_);
    QVector<rational> times;
    rational r;
    while (copy.GetNext(&r)) {
      times.append(r);
    }
    return times;
  }

  int size();

  void reset()
  {
    *this = TimeRangeListFrameIterator();
  }

  void insert(const TimeRange &range)
  {
    list_.insert(range);
  }

  void insert(const TimeRangeList &list)
  {
    list_.insert(list);
  }

  bool IsCustomRange() const
  {
    return custom_range_;
  }

  void SetCustomRange(bool e)
  {
    custom_range_ = e;
  }

  int frame_index() const
  {
    return frame_index_;
  }

private:
  void UpdateIndexIfNecessary();

  TimeRangeList list_;

  rational timebase_;

  rational current_;

  int range_index_;

  int size_;

  int frame_index_;

  bool custom_range_;

};

uint qHash(const TimeRange& r, uint seed = 0);

}

QDebug operator<<(QDebug debug, const olive::TimeRange& r);
QDebug operator<<(QDebug debug, const olive::TimeRangeList& r);

Q_DECLARE_METATYPE(olive::TimeRange)

#endif // TIMERANGE_H