xbmc/application/ApplicationStackHelper.h

   1 /*
   2  *  Copyright (C) 2017-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "application/IApplicationComponent.h"
  12 #include "threads/CriticalSection.h"
  13
  14 #include <map>
  15 #include <memory>
  16 #include <string>
  17
  18 class CFileItem;
  19 class CFileItemList;
  20
  21 class CApplicationStackHelper : public IApplicationComponent
  22 {
  23 public:
  24   CApplicationStackHelper(void);
  25   ~CApplicationStackHelper() = default;
  26
  27   void Clear();
  28   void OnPlayBackStarted(const CFileItem& item);
  29
  30   /*!
  31   \brief Initialize stack
  32   \param item the FileItem object that is the stack
  33   */
  34   bool InitializeStack(const CFileItem& item);
  35
  36   /*!
  37   \brief Initialize stack times for each part, start & end, total time, and current part number if resume offset is specified.
  38   \param item the FileItem object that is the stack
  39   */
  40   int InitializeStackStartPartAndOffset(const CFileItem& item);
  41
  42   /*!
  43   \brief returns the current part number
  44   */
  45   int GetCurrentPartNumber() const { return m_currentStackPosition; }
  46
  47   /*!
  48   \brief Returns true if Application is currently playing an ISO stack
  49   */
  50   bool IsPlayingISOStack() const;
  51
  52   /*!
  53   \brief Returns true if Application is currently playing a Regular (non-ISO) stack
  54   */
  55   bool IsPlayingRegularStack() const;
  56
  57   /*!
  58   \brief returns true if there is a next part available
  59   */
  60   bool HasNextStackPartFileItem() const;
  61
  62   /*!
  63   \brief sets the next stack part as the current and returns a reference to it
  64   */
  65   const CFileItem& SetNextStackPartCurrentFileItem()
  66   {
  67     return GetStackPartFileItem(++m_currentStackPosition);
  68   }
  69
  70   /*!
  71   \brief sets a given stack part as the current and returns a reference to it
  72   \param partNumber the number of the part that needs to become the current one
  73   */
  74   const CFileItem& SetStackPartCurrentFileItem(int partNumber)
  75   {
  76     return GetStackPartFileItem(m_currentStackPosition = partNumber);
  77   }
  78
  79   /*!
  80   \brief Returns the FileItem currently playing back as part of a (non-ISO) stack playback
  81   */
  82   const CFileItem& GetCurrentStackPartFileItem() const
  83   {
  84     return GetStackPartFileItem(m_currentStackPosition);
  85   }
  86
  87   /*!
  88   \brief Returns the end time of a FileItem part of a (non-ISO) stack playback
  89   \param partNumber the requested part number in the stack
  90   */
  91   uint64_t GetStackPartEndTimeMs(int partNumber) const;
  92
  93   /*!
  94   \brief Returns the start time of a FileItem part of a (non-ISO) stack playback
  95   \param partNumber the requested part number in the stack
  96   */
  97   uint64_t GetStackPartStartTimeMs(int partNumber) const { return (partNumber > 0) ? GetStackPartEndTimeMs(partNumber - 1) : 0; }
  98
  99   /*!
 100   \brief Returns the start time of the current FileItem part of a (non-ISO) stack playback
 101   */
 102   uint64_t GetCurrentStackPartStartTimeMs() const { return GetStackPartStartTimeMs(m_currentStackPosition); }
 103
 104   /*!
 105   \brief Returns the total time of a (non-ISO) stack playback
 106   */
 107   uint64_t GetStackTotalTimeMs() const;
 108
 109   /*!
 110   \brief Returns the stack part number corresponding to the given timestamp in a (non-ISO) stack playback
 111   \param msecs the requested timestamp in the stack (in milliseconds)
 112   */
 113   int GetStackPartNumberAtTimeMs(uint64_t msecs);
 114
 115   // Stack information registration methods
 116
 117   /*!
 118   \brief Clear all entries in the item-stack map. To be called upon playback stopped.
 119   */
 120   void ClearAllRegisteredStackInformation();
 121
 122   /*!
 123   \brief Returns a smart pointer to the stack CFileItem.
 124   */
 125   std::shared_ptr<const CFileItem> GetRegisteredStack(const CFileItem& item) const;
 126
 127   /*!
 128   \brief Returns true if there is a registered stack for the given CFileItem part.
 129   \param item the reference to the item that is part of a stack
 130   */
 131   bool HasRegisteredStack(const CFileItem& item) const;
 132
 133   /*!
 134   \brief Stores a smart pointer to the stack CFileItem in the item-stack map.
 135   \param item the reference to the item that is part of a stack
 136   \param stackItem the smart pointer to the stack CFileItem
 137   */
 138   void SetRegisteredStack(const CFileItem& item, std::shared_ptr<CFileItem> stackItem);
 139
 140   /*!
 141   \brief Returns the part number of the part in the parameter
 142   \param item the reference to the item that is part of a stack
 143   */
 144   int GetRegisteredStackPartNumber(const CFileItem& item);
 145
 146   /*!
 147   \brief Stores the part number in the item-stack map.
 148   \param item the reference to the item that is part of a stack
 149   \param partNumber the part number of the part in other parameter
 150   */
 151   void SetRegisteredStackPartNumber(const CFileItem& item, int partNumber);
 152
 153   /*!
 154   \brief Returns the start time of the part in the parameter
 155   \param item the reference to the item that is part of a stack
 156   */
 157   uint64_t GetRegisteredStackPartStartTimeMs(const CFileItem& item) const;
 158
 159   /*!
 160   \brief Stores the part start time in the item-stack map.
 161   \param item the reference to the item that is part of a stack
 162   \param startTime the start time of the part in other parameter
 163   */
 164   void SetRegisteredStackPartStartTimeMs(const CFileItem& item, uint64_t startTimeMs);
 165
 166   /*!
 167   \brief Returns the total time of the stack associated to the part in the parameter
 168   \param item the reference to the item that is part of a stack
 169   */
 170   uint64_t GetRegisteredStackTotalTimeMs(const CFileItem& item) const;
 171
 172   /*!
 173   \brief Stores the stack's total time associated to the part in the item-stack map.
 174   \param item the reference to the item that is part of a stack
 175   \param totalTime the total time of the stack
 176   */
 177   void SetRegisteredStackTotalTimeMs(const CFileItem& item, uint64_t totalTimeMs);
 178
 179   CCriticalSection m_critSection;
 180
 181 protected:
 182   /*!
 183   \brief Returns a FileItem part of a (non-ISO) stack playback
 184   \param partNumber the requested part number in the stack
 185   */
 186   CFileItem& GetStackPartFileItem(int partNumber);
 187   const CFileItem& GetStackPartFileItem(int partNumber) const;
 188
 189   class StackPartInformation
 190   {
 191   public:
 192     StackPartInformation()
 193     {
 194       m_lStackPartNumber = 0;
 195       m_lStackPartStartTimeMs = 0;
 196       m_lStackTotalTimeMs = 0;
 197     };
 198     uint64_t m_lStackPartStartTimeMs;
 199     uint64_t m_lStackTotalTimeMs;
 200     int m_lStackPartNumber;
 201     std::shared_ptr<CFileItem> m_pStack;
 202   };
 203
 204   typedef std::shared_ptr<StackPartInformation> StackPartInformationPtr;
 205   typedef std::map<std::string, StackPartInformationPtr> Stackmap;
 206   Stackmap m_stackmap;
 207   StackPartInformationPtr GetStackPartInformation(const std::string& key);
 208   StackPartInformationPtr GetStackPartInformation(const std::string& key) const;
 209
 210   std::unique_ptr<CFileItemList> m_currentStack;
 211   int m_currentStackPosition = 0;
 212   bool m_currentStackIsDiscImageStack = false;
 213 };