Edl.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "cores/EdlEdit.h"

#include <string>
#include <vector>

class CFileItem;

class CEdl
{
public:
  CEdl();

  // FIXME: remove const modifier for fFramesPerSecond as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  bool ReadEditDecisionLists(const CFileItem& fileItem, const float fFramesPerSecond);
  void Clear();

  bool HasEdits() const;

  bool HasCuts() const;

  bool HasSceneMarker() const;

  int GetTotalCutTime() const;

  int GetTimeWithoutCuts(int seek) const;

  double GetTimeAfterRestoringCuts(double seek) const;

  const std::vector<EDL::Edit>& GetRawEditList() const { return m_vecEdits; }

  const std::vector<EDL::Edit> GetEditList() const;

  const std::vector<int64_t> GetCutMarkers() const;

  const std::vector<int64_t> GetSceneMarkers() const;

  bool InEdit(int iSeek, EDL::Edit* pEdit = nullptr);

  int GetLastEditTime() const;

  void SetLastEditTime(int editTime);

  void ResetLastEditTime();

  void SetLastEditActionType(EDL::Action action);

  EDL::Action GetLastEditActionType() const;

  // FIXME: remove const modifier for iClock as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  bool GetNextSceneMarker(bool bPlus, const int iClock, int *iSceneMarker);

  // FIXME: remove const modifier as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  static std::string MillisecondsToTimeString(const int iMilliseconds);

private:
  // total cut time (edl cuts) in ms
  int m_totalCutTime;
  std::vector<EDL::Edit> m_vecEdits;
  std::vector<int> m_vecSceneMarkers;

  int m_lastEditTime;

  EDL::Action m_lastEditActionType{EDL::EDL_ACTION_NONE};

  // FIXME: remove const modifier for fFramesPerSecond as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  bool ReadEdl(const std::string& strMovie, const float fFramesPerSecond);
  // FIXME: remove const modifier for fFramesPerSecond as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  bool ReadComskip(const std::string& strMovie, const float fFramesPerSecond);
  // FIXME: remove const modifier for strMovie as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  bool ReadVideoReDo(const std::string& strMovie);
  // FIXME: remove const modifier for strMovie as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  bool ReadBeyondTV(const std::string& strMovie);
  bool ReadPvr(const CFileItem& fileItem);

  bool AddEdit(const EDL::Edit& newEdit);

  // FIXME: remove const modifier for strMovie as it makes no sense as it means nothing
  // for the reader of the interface, but limits the implementation
  // to not modify the parameter on stack
  bool AddSceneMarker(const int sceneMarker);

  void MergeShortCommBreaks();

  void AddSceneMarkersAtStartAndEndOfEdits();
};