Player.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 "AddonCallback.h"
#include "AddonString.h"
#include "Alternative.h"
#include "Exception.h"
#include "InfoTagGame.h"
#include "InfoTagMusic.h"
#include "InfoTagRadioRDS.h"
#include "InfoTagVideo.h"
#include "ListItem.h"
#include "PlayList.h"
#include "cores/IPlayerCallback.h"
#include "swighelper.h"

#include <vector>

namespace XBMCAddon
{
  namespace xbmc
  {
    XBMCCOMMONS_STANDARD_EXCEPTION(PlayerException);

    typedef Alternative<String, const PlayList* > PlayParameter;

    // This class is a merge of what was previously in xbmcmodule/player.h
    //  and xbmcmodule/PythonPlayer.h without the python references. The
    //  queuing and handling of asynchronous callbacks is done internal to
    //  this class.

    //
    //
    class Player : public AddonCallback, public IPlayerCallback
    {
    private:
      int iPlayList;

      void playStream(const String& item = emptyString, const XBMCAddon::xbmcgui::ListItem* listitem = NULL, bool windowed = false);
      void playPlaylist(const PlayList* playlist = NULL,
      bool windowed = false, int startpos=-1);
      void playCurrent(bool windowed = false);

    public:
#if !defined SWIG && !defined DOXYGEN_SHOULD_SKIP_THIS
      static PlayParameter defaultPlayParameter;
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS
      // Construct a Player proxying the given generated binding. The
      //  construction of a Player needs to identify whether or not any
      //  callbacks will be executed asynchronously or not.
      explicit Player();
      ~Player(void) override;
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      play(...);
#else
      void play(const PlayParameter& item = Player::defaultPlayParameter,
                const XBMCAddon::xbmcgui::ListItem* listitem = NULL, bool windowed = false, int startpos = -1);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      stop();
#else
      void stop();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      pause();
#else
      void pause();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      playnext();
#else
      void playnext();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      playprevious();
#else
      void playprevious();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      playselected(...);
#else
      void playselected(int selected);
#endif

      //
      //

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackStarted();
#else
      virtual void onPlayBackStarted();
#endif


#ifdef DOXYGEN_SHOULD_USE_THIS
      onAVStarted();
#else
      virtual void onAVStarted();
#endif


#ifdef DOXYGEN_SHOULD_USE_THIS
      onAVChange();
#else
      virtual void onAVChange();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackEnded();
#else
      virtual void onPlayBackEnded();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackStopped();
#else
      virtual void onPlayBackStopped();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackError();
#else
      virtual void onPlayBackError();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackPaused();
#else
      virtual void onPlayBackPaused();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackResumed();
#else
      virtual void onPlayBackResumed();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onQueueNextItem();
#else
      virtual void onQueueNextItem();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackSpeedChanged(int speed);
#else
      virtual void onPlayBackSpeedChanged(int speed);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackSeek(...);
#else
      virtual void onPlayBackSeek(int time, int seekOffset);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      onPlayBackSeekChapter(...);
#else
      virtual void onPlayBackSeekChapter(int chapter);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      isPlaying();
#else
      bool isPlaying();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      isPlayingAudio();
#else
      bool isPlayingAudio();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      isPlayingVideo();
#else
      bool isPlayingVideo();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      isPlayingRDS();
#else
      bool isPlayingRDS();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      isPlayingGame();
#else
      bool isPlayingGame();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      isExternalPlayer();
#else
      bool isExternalPlayer();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getPlayingFile();
#else
      String getPlayingFile();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getPlayingItem();
#else
      XBMCAddon::xbmcgui::ListItem* getPlayingItem();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getTime();
#else
      double getTime();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      seekTime(...);
#else
      void seekTime(double seekTime);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      setSubtitles(...);
#else
      void setSubtitles(const char* subtitleFile);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      showSubtitles(...);
#else
      void showSubtitles(bool bVisible);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getSubtitles();
#else
      String getSubtitles();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getAvailableSubtitleStreams();
#else
      std::vector<String> getAvailableSubtitleStreams();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      setSubtitleStream(...);
#else
      void setSubtitleStream(int iStream);
#endif

      // Player_UpdateInfoTag
#ifdef DOXYGEN_SHOULD_USE_THIS
      updateInfoTag();
#else
      void updateInfoTag(const XBMCAddon::xbmcgui::ListItem* item);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getGameInfoTag();
#else
      InfoTagGame* getGameInfoTag();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getVideoInfoTag();
#else
      InfoTagVideo* getVideoInfoTag();
#endif

      // Player_GetMusicInfoTag
#ifdef DOXYGEN_SHOULD_USE_THIS
      getMusicInfoTag();
#else
      InfoTagMusic* getMusicInfoTag();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getRadioRDSInfoTag();
#else
      InfoTagRadioRDS* getRadioRDSInfoTag();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getTotalTime();
#else
      double getTotalTime();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getAvailableAudioStreams();
#else
      std::vector<String> getAvailableAudioStreams();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      setAudioStream(...);
#else
      void setAudioStream(int iStream);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      getAvailableVideoStreams();
#else
      std::vector<String> getAvailableVideoStreams();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
      setVideoStream(...);
#else
      void setVideoStream(int iStream);
#endif

#if !defined SWIG && !defined DOXYGEN_SHOULD_SKIP_THIS
      void OnPlayBackStarted(const CFileItem& file) override;
      void OnAVStarted(const CFileItem& file) override;
      void OnAVChange() override;
      void OnPlayBackEnded() override;
      void OnPlayBackStopped() override;
      void OnPlayBackError() override;
      void OnPlayBackPaused() override;
      void OnPlayBackResumed() override;
      void OnQueueNextItem() override;
      void OnPlayBackSpeedChanged(int iSpeed) override;
      void OnPlayBackSeek(int64_t iTime, int64_t seekOffset) override;
      void OnPlayBackSeekChapter(int iChapter) override;
#endif

    protected:
    };
  }
}