ApplicationStackHelper.h

/*
 *  Copyright (C) 2017-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 "application/IApplicationComponent.h"
#include "threads/CriticalSection.h"

#include <map>
#include <memory>
#include <optional>
#include <string>

class CFileItem;
class CFileItemList;

class CApplicationStackHelper : public IApplicationComponent
{
public:
  CApplicationStackHelper(void);
  ~CApplicationStackHelper() = default;

  void Clear();
  void OnPlayBackStarted(const CFileItem& item);

  bool InitializeStack(const CFileItem& item);

  std::optional<int64_t> InitializeStackStartPartAndOffset(const CFileItem& item);

  int GetCurrentPartNumber() const { return m_currentStackPosition; }

  bool IsPlayingISOStack() const;

  bool IsPlayingRegularStack() const;

  bool HasNextStackPartFileItem() const;

  const CFileItem& SetNextStackPartCurrentFileItem()
  {
    return GetStackPartFileItem(++m_currentStackPosition);
  }

  const CFileItem& SetStackPartCurrentFileItem(int partNumber)
  {
    return GetStackPartFileItem(m_currentStackPosition = partNumber);
  }

  const CFileItem& GetCurrentStackPartFileItem() const
  {
    return GetStackPartFileItem(m_currentStackPosition);
  }

  uint64_t GetStackPartEndTimeMs(int partNumber) const;

  uint64_t GetStackPartStartTimeMs(int partNumber) const { return (partNumber > 0) ? GetStackPartEndTimeMs(partNumber - 1) : 0; }

  uint64_t GetCurrentStackPartStartTimeMs() const { return GetStackPartStartTimeMs(m_currentStackPosition); }

  uint64_t GetStackTotalTimeMs() const;

  int GetStackPartNumberAtTimeMs(uint64_t msecs);

  // Stack information registration methods

  void ClearAllRegisteredStackInformation();

  std::shared_ptr<const CFileItem> GetRegisteredStack(const CFileItem& item) const;

  bool HasRegisteredStack(const CFileItem& item) const;

  void SetRegisteredStack(const CFileItem& item, std::shared_ptr<CFileItem> stackItem);

  int GetRegisteredStackPartNumber(const CFileItem& item);

  void SetRegisteredStackPartNumber(const CFileItem& item, int partNumber);

  uint64_t GetRegisteredStackPartStartTimeMs(const CFileItem& item) const;

  void SetRegisteredStackPartStartTimeMs(const CFileItem& item, uint64_t startTimeMs);

  uint64_t GetRegisteredStackTotalTimeMs(const CFileItem& item) const;

  void SetRegisteredStackTotalTimeMs(const CFileItem& item, uint64_t totalTimeMs);

  CCriticalSection m_critSection;

protected:
  CFileItem& GetStackPartFileItem(int partNumber);
  const CFileItem& GetStackPartFileItem(int partNumber) const;

  class StackPartInformation
  {
  public:
    StackPartInformation()
    {
      m_lStackPartNumber = 0;
      m_lStackPartStartTimeMs = 0;
      m_lStackTotalTimeMs = 0;
    };
    uint64_t m_lStackPartStartTimeMs;
    uint64_t m_lStackTotalTimeMs;
    int m_lStackPartNumber;
    std::shared_ptr<CFileItem> m_pStack;
  };

  typedef std::shared_ptr<StackPartInformation> StackPartInformationPtr;
  typedef std::map<std::string, StackPartInformationPtr> Stackmap;
  Stackmap m_stackmap;
  StackPartInformationPtr GetStackPartInformation(const std::string& key);
  StackPartInformationPtr GetStackPartInformation(const std::string& key) const;

  std::unique_ptr<CFileItemList> m_currentStack;
  int m_currentStackPosition = 0;
  bool m_currentStackIsDiscImageStack = false;
};