/***

  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 PLAYBACKCACHE_H
#define PLAYBACKCACHE_H

#include <QDir>
#include <QObject>
#include <QUuid>

#include "common/jobtime.h"
#include "common/timerange.h"

namespace olive {

class Node;
class Project;
class ViewerOutput;

class PlaybackCache : public QObject
{
  Q_OBJECT
public:
  PlaybackCache(QObject* parent = nullptr);

  const QUuid &GetUuid() const { return uuid_; }
  void SetUuid(const QUuid &u) { uuid_ = u; }

  bool IsAutomatic() const { return automatic_; }
  void SetIsAutomatic(bool e);

  TimeRangeList GetInvalidatedRanges(TimeRange intersecting);
  TimeRangeList GetInvalidatedRanges(const rational &length)
  {
    return GetInvalidatedRanges(TimeRange(0, length));
  }

  bool HasInvalidatedRanges(const TimeRange &intersecting);
  bool HasInvalidatedRanges(const rational &length)
  {
    return HasInvalidatedRanges(TimeRange(0, length));
  }

  QString GetCacheDirectory() const;

  void Invalidate(const TimeRange& r);

  const TimeRangeList &GetValidatedRanges() const { return validated_; }

  Node *parent() const;

  QDir GetThisCacheDirectory() const;
  static QDir GetThisCacheDirectory(const QString &cache_path, const QUuid &cache_id);

  enum RequestType {
    kCacheOnly,
    kPreviewsOnly
  };

  void LoadState();
  void SaveState();

public slots:
  void InvalidateAll();

signals:
  void Invalidated(const olive::TimeRange& r);

  void Validated(const olive::TimeRange& r);

  void Request(const olive::TimeRange& r, olive::PlaybackCache::RequestType type);

  void AutomaticChanged(bool e);

protected:
  void Validate(const TimeRange& r, bool signal = true);

  virtual void InvalidateEvent(const TimeRange& range);

  virtual void LoadStateEvent(QDataStream &stream){}

  virtual void SaveStateEvent(QDataStream &stream){}

  Project* GetProject() const;

private:
  TimeRangeList validated_;

  QUuid uuid_;

  bool automatic_;

};

}

#endif // PLAYBACKCACHE_H