ryzom/client/src/interface_v3/music_player.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21
  22 #ifndef NL_MUSIC_PLAYER_H
  23 #define NL_MUSIC_PLAYER_H
  24
  25 #include "nel/misc/types_nl.h"
  26 #include "nel/misc/stream.h"
  27 #include "dbctrl_sheet.h"
  28 #include "nel/gui/group_container.h"
  29
  30 // ***************************************************************************
  31 /*
  32 Music player manager.
  33 This class handle the music player playlist actions.
  34 */
  35 class CMusicPlayer
  36 {
  37 public:
  38
  39         CMusicPlayer ();
  40
  41         /* Play list commands */
  42         class CSongs
  43         {
  44         public:
  45                 CSongs(std::string file = std::string(), std::string title = std::string(), float length = 0.f)
  46                 : Filename(file), Title(title), Length(length)
  47                 { }
  48
  49                 std::string     Filename;
  50                 std::string     Title;
  51                 float       Length;
  52         };
  53
  54         void playSongs (const std::vector<std::string> &filenames);
  55         void play (sint index = -1);                                            // Play the song at current position, if playing, restart. If paused, resume.
  56         void pause ();
  57         void stop ();
  58         void previous ();
  59         void next ();
  60
  61         /* Update the playlist. Call it in the main loop */
  62
  63         void update ();
  64
  65         // update currently playing song info/duration on main gui
  66         void updatePlayingInfo(const std::string info);
  67         void clearPlayingInfo();
  68
  69         bool isRepeatEnabled() const;
  70         bool isShuffleEnabled() const;
  71
  72         // Build playlist UI from songs
  73         void rebuildPlaylist();
  74         // Randomize playlist and rebuild the ui
  75         void shuffleAndRebuildPlaylist();
  76         // Update playlist active row
  77         void updatePlaylist(sint prevIndex = -1);
  78         // set/remove playlist highlight
  79         void updatePlaylist(uint index, bool state);
  80
  81         // Update single song title/duration on _Songs and on playlist
  82         void updateSong(const CSongs &song);
  83
  84         // Update _Songs and playlist from _SongUpdateQueue
  85         void updateSongs();
  86
  87         // update song from worker thread
  88         void updateSong(const std::string filename, const std::string title, float length);
  89
  90         // scan music folder and rebuild playlist
  91         void createPlaylistFromMusic();
  92
  93 private:
  94
  95         // The playlist
  96         CSongs                                                          _CurrentSong;
  97         uint                                                            _CurrentSongIndex;      // If (!_Songs.empty()) must always be <_Songs.size()
  98         std::vector<CSongs>                                     _Songs;
  99         // updated info from worker thread
 100         std::vector<CSongs>                                     _SongUpdateQueue;
 101
 102         // State
 103         enum TState { Stopped, Playing, Paused }        _State;
 104
 105         TTime _PlayStart;
 106         TTime _PauseTime;
 107 };
 108
 109 extern CMusicPlayer MusicPlayer;
 110
 111 // ***************************************************************************
 112
 113 #endif // NL_MUSIC_PLAYER_H
 114
 115 /* End of music_player.h */