code.vuplus.com Git - vuplus_xbmc/blob - xbmc/PlayListPlayer.h

   1 #pragma once
   2 /*
   3  *      Copyright (C) 2005-2008 Team XBMC
   4  *      http://www.xbmc.org
   5  *
   6  *  This Program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This Program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with XBMC; see the file COPYING.  If not, write to
  18  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *  http://www.gnu.org/copyleft/gpl.html
  20  *
  21  */
  22
  23 #include "guilib/IMsgTargetCallback.h"
  24 #include <boost/shared_ptr.hpp>
  25
  26 #define PLAYLIST_NONE    -1
  27 #define PLAYLIST_MUSIC   0
  28 #define PLAYLIST_VIDEO   1
  29 #define PLAYLIST_PICTURE 2
  30
  31 class CFileItem; typedef boost::shared_ptr<CFileItem> CFileItemPtr;
  32 class CFileItemList;
  33
  34 namespace PLAYLIST
  35 {
  36 /*!
  37  \ingroup windows
  38  \brief Manages playlist playing.
  39  */
  40 enum REPEAT_STATE { REPEAT_NONE = 0, REPEAT_ONE, REPEAT_ALL };
  41
  42 class CPlayList;
  43
  44 class CPlayListPlayer : public IMsgTargetCallback
  45 {
  46
  47 public:
  48   CPlayListPlayer(void);
  49   virtual ~CPlayListPlayer(void);
  50   virtual bool OnMessage(CGUIMessage &message);
  51
  52   /*! \brief Play the next (or another) entry in the current playlist
  53    \param offset The offset from the current entry (defaults to 1, i.e. the next entry).
  54    \param autoPlay Whether we should start playing if not already (defaults to false).
  55    */
  56   bool PlayNext(int offset = 1, bool autoPlay = false);
  57
  58   /*! \brief Play the previous entry in the current playlist
  59    \sa PlayNext
  60    */
  61   bool PlayPrevious();
  62   bool PlaySongId(int songId);
  63   bool Play();
  64
  65   /*! \brief Start playing a particular entry in the current playlist
  66    \param index the index of the item to play. This value is modified to ensure it lies within the current playlist.
  67    \param replace whether this item should replace the currently playing item. See CApplication::PlayFile (defaults to false).
  68    \param playPreviousOnFail whether to go back to the previous item if playback fails (default to false)
  69    */
  70   bool Play(int index, bool replace = false, bool playPreviousOnFail = false);
  71
  72   /*! \brief Returns the index of the current item in active playlist.
  73    \return Current item in the active playlist.
  74    \sa SetCurrentSong
  75    */
  76   int GetCurrentSong() const;
  77
  78   /*! \brief Change the current item in the active playlist.
  79    \param index item index in playlist. Set only if the index is within the range of the current playlist.
  80    \sa GetCurrentSong
  81    */
  82   void SetCurrentSong(int index);
  83
  84   int GetNextSong();
  85
  86   /*! \brief Get the index in the playlist that is offset away from the current index in the current playlist.
  87    Obeys any repeat settings (eg repeat one will return the current index regardless of offset)
  88    \return the index of the entry, or -1 if there is no current playlist. There is no guarantee that the returned index is valid.
  89    */
  90   int GetNextSong(int offset) const;
  91
  92   /*! \brief Set the active playlist
  93    \param playList Values can be PLAYLIST_NONE, PLAYLIST_MUSIC or PLAYLIST_VIDEO
  94    \sa GetCurrentPlaylist
  95    */
  96   void SetCurrentPlaylist(int playlist);
  97
  98   /*! \brief Get the currently active playlist
  99    \return PLAYLIST_NONE, PLAYLIST_MUSIC or PLAYLIST_VIDEO
 100    \sa SetCurrentPlaylist, GetPlaylist
 101    */
 102   int GetCurrentPlaylist() const;
 103
 104   /*! \brief Get a particular playlist object
 105    \param playList Values can be PLAYLIST_MUSIC or PLAYLIST_VIDEO
 106    \return A reference to the CPlayList object.
 107    \sa GetCurrentPlaylist
 108    */
 109   CPlayList& GetPlaylist(int playlist);
 110   const CPlayList& GetPlaylist(int iPlaylist) const;
 111
 112   /*! \brief Removes any item from all playlists located on a removable share
 113    \return Number of items removed from PLAYLIST_MUSIC and PLAYLIST_VIDEO
 114    */
 115   int RemoveDVDItems();
 116
 117   /*! \brief Resets the current song and unplayable counts.
 118    Does not alter the active playlist.
 119   */
 120   void Reset();
 121
 122   void ClearPlaylist(int iPlaylist);
 123   void Clear();
 124
 125   /*! \brief Set shuffle state of a playlist.
 126    If the shuffle state changes, the playlist is shuffled or unshuffled.
 127    Has no effect if Party Mode is enabled.
 128    \param playlist the playlist to (un)shuffle, PLAYLIST_MUSIC or PLAYLIST_VIDEO.
 129    \param shuffle set true to shuffle, false to unshuffle.
 130    \param notify notify the user with a Toast notification (defaults to false)
 131    \sa IsShuffled
 132    */
 133   void SetShuffle(int playlist, bool shuffle, bool notify = false);
 134
 135   /*! \brief Return whether a playlist is shuffled.
 136    If partymode is enabled, this always returns false.
 137    \param playlist the playlist to query for shuffle state, PLAYLIST_MUSIC or PLAYLIST_VIDEO.
 138    \return true if the given playlist is shuffled and party mode isn't enabled, false otherwise.
 139    \sa SetShuffle
 140    */
 141   bool IsShuffled(int iPlaylist) const;
 142
 143   /*! \brief Return whether or not something has been played yet from the current playlist.
 144    \return true if something has been played, false otherwise.
 145    */
 146   bool HasPlayedFirstFile() const;
 147
 148   /*! \brief Set repeat state of a playlist.
 149    If called while in Party Mode, repeat is disabled.
 150    \param playlist the playlist to set repeat state for, PLAYLIST_MUSIC or PLAYLIST_VIDEO.
 151    \param state set to REPEAT_NONE, REPEAT_ONE or REPEAT_ALL
 152    \param notify notify the user with a Toast notification
 153    \sa GetRepeat
 154    */
 155   void SetRepeat(int iPlaylist, REPEAT_STATE state, bool notify = false);
 156   REPEAT_STATE GetRepeat(int iPlaylist) const;
 157
 158   // add items via the playlist player
 159   void Add(int iPlaylist, CPlayList& playlist);
 160   void Add(int iPlaylist, const CFileItemPtr &pItem);
 161   void Add(int iPlaylist, CFileItemList& items);
 162   void Insert(int iPlaylist, CPlayList& playlist, int iIndex);
 163   void Insert(int iPlaylist, const CFileItemPtr &pItem, int iIndex);
 164   void Insert(int iPlaylist, CFileItemList& items, int iIndex);
 165   void Remove(int iPlaylist, int iPosition);
 166   void Swap(int iPlaylist, int indexItem1, int indexItem2);
 167 protected:
 168   /*! \brief Returns true if the given is set to repeat all
 169    \param playlist Playlist to be query
 170    \return true if the given playlist is set to repeat all, false otherwise.
 171    */
 172   bool Repeated(int playlist) const;
 173
 174   /*! \brief Returns true if the given is set to repeat one
 175    \param playlist Playlist to be query
 176    \return true if the given playlist is set to repeat one, false otherwise.
 177    */
 178   bool RepeatedOne(int playlist) const;
 179
 180   void ReShuffle(int iPlaylist, int iPosition);
 181
 182   bool m_bPlayedFirstFile;
 183   bool m_bPlaybackStarted;
 184   int m_iFailedSongs;
 185   unsigned int m_failedSongsStart;
 186   int m_iCurrentSong;
 187   int m_iCurrentPlayList;
 188   CPlayList* m_PlaylistMusic;
 189   CPlayList* m_PlaylistVideo;
 190   CPlayList* m_PlaylistEmpty;
 191   REPEAT_STATE m_repeatState[2];
 192 };
 193
 194 }
 195
 196 /*!
 197  \ingroup windows
 198  \brief Global instance of playlist player
 199  */
 200 extern PLAYLIST::CPlayListPlayer g_playlistPlayer;