xbmc/video/VideoFileItemClassify.h

   1 /*
   2  *  Copyright (C) 2005-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 class CFileItem;
  12
  13 namespace KODI::VIDEO
  14 {
  15
  16 //! \brief Check whether an item is a blu-ray file.
  17 bool IsBDFile(const CFileItem& item);
  18
  19 //! \brief Check whether an item is a disc stub.
  20 bool IsDiscStub(const CFileItem& item);
  21
  22 //! \brief Check whether an item is a DVD file.
  23 bool IsDVDFile(const CFileItem& item, bool bVobs = true, bool bIfos = true);
  24
  25 //! \brief Checks whether item points to a protected blu-ray disc.
  26 bool IsProtectedBlurayDisc(const CFileItem& item);
  27
  28 //! \brief Checks whether item points to a blu-ray playlist (.mpls)
  29 bool IsBlurayPlaylist(const CFileItem& item);
  30
  31 //! \brief Check whether an item is a subtitle file.
  32 bool IsSubtitle(const CFileItem& item);
  33
  34 //! \brief Check whether an item is a video item.
  35 //! \details Note that this returns true for anything with a video info tag,
  36 //!          so that may include eg. folders.
  37 bool IsVideo(const CFileItem& item);
  38
  39 //! \brief Is the item a video asset, excluding folders
  40 //! \param[in] item the item
  41 //! \return true if it is, false otherwise
  42 bool IsVideoAssetFile(const CFileItem& item);
  43
  44 //! \brief Check whether an item is a video database item.
  45 bool IsVideoDb(const CFileItem& item);
  46
  47 //! \brief Check whether an item is a video extras folder item.
  48 bool IsVideoExtrasFolder(const CFileItem& item);
  49
  50 } // namespace KODI::VIDEO