Music Hub  ..
A session-wide music playback service
player.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013-2015 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voß <thomas.voss@canonical.com>
17  * Jim Hodapp <jim.hodapp@canonical.com>
18  */
19 #ifndef CORE_UBUNTU_MEDIA_PLAYER_H_
20 #define CORE_UBUNTU_MEDIA_PLAYER_H_
21 
22 #include <core/media/track.h>
23 
25 #include <core/media/video/sink.h>
26 
27 #include <core/property.h>
28 
29 #include <chrono>
30 #include <memory>
31 
32 namespace core
33 {
34 namespace ubuntu
35 {
36 namespace media
37 {
38 class Service;
39 class TrackList;
40 
41 class Player : public std::enable_shared_from_this<Player>
42 {
43  public:
44  typedef double PlaybackRate;
45  typedef double Volume;
46  typedef uint32_t PlayerKey;
47  typedef void* GLConsumerWrapperHybris;
48  typedef std::map<std::string, std::string> HeadersType;
49 
50  struct Errors
51  {
52  Errors() = delete;
53 
54  struct OutOfProcessBufferStreamingNotSupported : public std::runtime_error
55  {
57  };
58  };
59 
60  struct Configuration;
61 
62  struct Client
63  {
64  Client() = delete;
65 
66  static const Configuration& default_configuration();
67  };
68 
70  {
76  };
77 
79  {
83  };
84 
91  {
96  };
97 
99  {
104  };
105 
106  enum Lifetime
107  {
110  };
111 
112  enum Error
113  {
120  };
121 
122  Player(const Player&) = delete;
123  virtual ~Player();
124 
125  Player& operator=(const Player&) = delete;
126  bool operator==(const Player&) const = delete;
127 
128  virtual std::shared_ptr<TrackList> track_list() = 0;
129  virtual PlayerKey key() const = 0;
130 
131  virtual video::Sink::Ptr create_gl_texture_video_sink(std::uint32_t texture_id) = 0;
132 
133  virtual bool open_uri(const Track::UriType& uri) = 0;
134  virtual bool open_uri(const Track::UriType& uri, const HeadersType&) = 0;
135  virtual void next() = 0;
136  virtual void previous() = 0;
137  virtual void play() = 0;
138  virtual void pause() = 0;
139  virtual void stop() = 0;
140  virtual void seek_to(const std::chrono::microseconds& offset) = 0;
141 
142  virtual const core::Property<bool>& can_play() const = 0;
143  virtual const core::Property<bool>& can_pause() const = 0;
144  virtual const core::Property<bool>& can_seek() const = 0;
145  virtual const core::Property<bool>& can_go_previous() const = 0;
146  virtual const core::Property<bool>& can_go_next() const = 0;
147  virtual const core::Property<bool>& is_video_source() const = 0;
148  virtual const core::Property<bool>& is_audio_source() const = 0;
149  virtual const core::Property<PlaybackStatus>& playback_status() const = 0;
150  virtual const core::Property<LoopStatus>& loop_status() const = 0;
151  virtual const core::Property<PlaybackRate>& playback_rate() const = 0;
152  virtual const core::Property<bool>& is_shuffle() const = 0;
153  virtual const core::Property<Track::MetaData>& meta_data_for_current_track() const = 0;
154  virtual const core::Property<Volume>& volume() const = 0;
155  virtual const core::Property<PlaybackRate>& minimum_playback_rate() const = 0;
156  virtual const core::Property<PlaybackRate>& maximum_playback_rate() const = 0;
157  virtual const core::Property<int64_t>& position() const = 0;
158  virtual const core::Property<int64_t>& duration() const = 0;
159  virtual const core::Property<AudioStreamRole>& audio_stream_role() const = 0;
160  virtual const core::Property<Orientation>& orientation() const = 0;
161  virtual const core::Property<Lifetime>& lifetime() const = 0;
162 
163  virtual core::Property<LoopStatus>& loop_status() = 0;
164  virtual core::Property<PlaybackRate>& playback_rate() = 0;
165  virtual core::Property<bool>& is_shuffle() = 0;
166  virtual core::Property<Volume>& volume() = 0;
167  virtual core::Property<AudioStreamRole>& audio_stream_role() = 0;
168  virtual core::Property<Lifetime>& lifetime() = 0;
169 
170  virtual const core::Signal<int64_t>& seeked_to() const = 0;
171  virtual const core::Signal<void>& about_to_finish() const = 0;
172  virtual const core::Signal<void>& end_of_stream() const = 0;
173  virtual core::Signal<PlaybackStatus>& playback_status_changed() = 0;
174  virtual const core::Signal<video::Dimensions>& video_dimension_changed() const = 0;
176  virtual const core::Signal<Error>& error() const = 0;
177  protected:
178  Player();
179 
180 };
181 }
182 }
183 }
184 
185 #endif // CORE_UBUNTU_MEDIA_PLAYER_H_
virtual const core::Property< PlaybackStatus > & playback_status() const =0
void * GLConsumerWrapperHybris
Definition: player.h:47
virtual const core::Property< int64_t > & position() const =0
virtual const core::Property< bool > & is_video_source() const =0
virtual const core::Property< bool > & can_play() const =0
bool operator==(const Player &) const =delete
virtual const core::Property< bool > & can_seek() const =0
virtual const core::Property< Track::MetaData > & meta_data_for_current_track() const =0
virtual void previous()=0
virtual const core::Property< int64_t > & duration() const =0
Definition: player.h:32
virtual const core::Property< bool > & can_go_previous() const =0
virtual core::Signal< PlaybackStatus > & playback_status_changed()=0
std::map< std::string, std::string > HeadersType
Definition: player.h:48
virtual const core::Property< bool > & is_audio_source() const =0
virtual const core::Signal< video::Dimensions > & video_dimension_changed() const =0
virtual const core::Property< PlaybackRate > & playback_rate() const =0
Player & operator=(const Player &)=delete
virtual const core::Property< Volume > & volume() const =0
virtual const core::Signal< void > & about_to_finish() const =0
virtual bool open_uri(const Track::UriType &uri)=0
virtual const core::Property< bool > & can_pause() const =0
std::shared_ptr< Sink > Ptr
To save us some typing.
Definition: sink.h:39
virtual video::Sink::Ptr create_gl_texture_video_sink(std::uint32_t texture_id)=0
virtual const core::Property< bool > & can_go_next() const =0
static const Configuration & default_configuration()
Definition: player.cpp:30
virtual const core::Signal< void > & end_of_stream() const =0
virtual const core::Property< bool > & is_shuffle() const =0
virtual const core::Property< PlaybackRate > & maximum_playback_rate() const =0
virtual const core::Property< Lifetime > & lifetime() const =0
std::string UriType
Definition: track.h:40
virtual PlayerKey key() const =0
virtual const core::Property< AudioStreamRole > & audio_stream_role() const =0
virtual const core::Signal< Error > & error() const =0
virtual const core::Property< PlaybackRate > & minimum_playback_rate() const =0
virtual const core::Signal< int64_t > & seeked_to() const =0
virtual const core::Property< LoopStatus > & loop_status() const =0
virtual const core::Property< Orientation > & orientation() const =0
virtual std::shared_ptr< TrackList > track_list()=0
virtual void seek_to(const std::chrono::microseconds &offset)=0