Music Hub  ..
A session-wide music playback service
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
engine.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013-2014 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_ENGINE_H_
20 #define CORE_UBUNTU_MEDIA_ENGINE_H_
21 
22 #include <core/media/player.h>
23 #include <core/media/track.h>
24 
25 #include <core/property.h>
26 
27 #include <chrono>
28 
29 namespace core
30 {
31 namespace ubuntu
32 {
33 namespace media
34 {
35 class Engine
36 {
37 public:
38 
39  enum class State
40  {
41  ready,
42  busy,
43  playing,
44  paused,
45  stopped
46  };
47 
48  struct Xesam
49  {
50  static const std::string& album();
51  static const std::string& album_artist();
52  static const std::string& artist();
53  static const std::string& as_text();
54  static const std::string& audio_bpm();
55  static const std::string& auto_rating();
56  static const std::string& comment();
57  static const std::string& composer();
58  static const std::string& content_created();
59  static const std::string& disc_number();
60  static const std::string& first_used();
61  static const std::string& genre();
62  static const std::string& last_used();
63  static const std::string& lyricist();
64  static const std::string& title();
65  static const std::string& track_number();
66  static const std::string& url();
67  static const std::string& use_count();
68  static const std::string& user_rating();
69  };
70 
71  struct Volume
72  {
73  static double min();
74  static double max();
75 
76  explicit Volume(double v = max());
77 
78  bool operator!=(const Volume& rhs) const;
79  bool operator==(const Volume& rhs) const;
80 
81  double value;
82  };
83 
85  {
86  public:
88 
89  protected:
90  MetaDataExtractor() = default;
91  MetaDataExtractor(const MetaDataExtractor&) = delete;
92  virtual ~MetaDataExtractor() = default;
93 
95  };
96 
97  virtual const std::shared_ptr<MetaDataExtractor>& meta_data_extractor() const = 0;
98 
99  virtual const core::Property<State>& state() const = 0;
100 
101  virtual bool open_resource_for_uri(const Track::UriType& uri) = 0;
102  virtual void create_video_sink(uint32_t texture_id) = 0;
103 
104  virtual bool play() = 0;
105  virtual bool stop() = 0;
106  virtual bool pause() = 0;
107  virtual bool seek_to(const std::chrono::microseconds& ts) = 0;
108 
109  virtual const core::Property<bool>& is_video_source() const = 0;
110  virtual const core::Property<bool>& is_audio_source() const = 0;
111 
112  virtual const core::Property<uint64_t>& position() const = 0;
113  virtual const core::Property<uint64_t>& duration() const = 0;
114 
115  virtual const core::Property<Volume>& volume() const = 0;
116  virtual core::Property<Volume>& volume() = 0;
117 
118  virtual const core::Property<core::ubuntu::media::Player::AudioStreamRole>& audio_stream_role() const = 0;
119  virtual core::Property<core::ubuntu::media::Player::AudioStreamRole>& audio_stream_role() = 0;
120 
121  virtual const core::Property<std::tuple<Track::UriType, Track::MetaData>>& track_meta_data() const = 0;
122 
123  virtual const core::Signal<void>& about_to_finish_signal() const = 0;
124  virtual const core::Signal<uint64_t>& seeked_to_signal() const = 0;
125  virtual const core::Signal<void>& client_disconnected_signal() const = 0;
126  virtual const core::Signal<void>& end_of_stream_signal() const = 0;
127  virtual const core::Signal<core::ubuntu::media::Player::PlaybackStatus>& playback_status_changed_signal() const = 0;
128 };
129 }
130 }
131 }
132 
133 #endif // CORE_UBUNTU_MEDIA_ENGINE_H_
static const std::string & lyricist()
Definition: engine.cpp:105
virtual const core::Property< State > & state() const =0
static const std::string & comment()
Definition: engine.cpp:63
static const std::string & track_number()
Definition: engine.cpp:117
static const std::string & use_count()
Definition: engine.cpp:129
Definition: player.h:29
static const std::string & auto_rating()
Definition: engine.cpp:57
MetaDataExtractor & operator=(const MetaDataExtractor &)=delete
virtual const core::Property< core::ubuntu::media::Player::AudioStreamRole > & audio_stream_role() const =0
virtual const core::Signal< uint64_t > & seeked_to_signal() const =0
virtual void create_video_sink(uint32_t texture_id)=0
static const std::string & audio_bpm()
Definition: engine.cpp:51
bool operator!=(const Volume &rhs) const
Definition: engine.cpp:157
virtual const core::Property< uint64_t > & duration() const =0
virtual const core::Signal< core::ubuntu::media::Player::PlaybackStatus > & playback_status_changed_signal() const =0
static const std::string & as_text()
Definition: engine.cpp:45
virtual bool open_resource_for_uri(const Track::UriType &uri)=0
virtual const std::shared_ptr< MetaDataExtractor > & meta_data_extractor() const =0
virtual const core::Property< bool > & is_audio_source() const =0
virtual const core::Property< std::tuple< Track::UriType, Track::MetaData > > & track_meta_data() const =0
virtual bool seek_to(const std::chrono::microseconds &ts)=0
virtual const core::Signal< void > & end_of_stream_signal() const =0
static const std::string & genre()
Definition: engine.cpp:93
static const std::string & title()
Definition: engine.cpp:111
static const std::string & artist()
Definition: engine.cpp:39
static const std::string & content_created()
Definition: engine.cpp:75
static const std::string & first_used()
Definition: engine.cpp:87
virtual Track::MetaData meta_data_for_track_with_uri(const Track::UriType &uri)=0
static const std::string & last_used()
Definition: engine.cpp:99
static const std::string & user_rating()
Definition: engine.cpp:135
static const std::string & album_artist()
Definition: engine.cpp:33
virtual const core::Signal< void > & about_to_finish_signal() const =0
std::string UriType
Definition: track.h:40
virtual const core::Property< uint64_t > & position() const =0
static const std::string & album()
Definition: engine.cpp:27
virtual const core::Property< Volume > & volume() const =0
static const std::string & composer()
Definition: engine.cpp:69
static const std::string & disc_number()
Definition: engine.cpp:81
static const std::string & url()
Definition: engine.cpp:123
bool operator==(const Volume &rhs) const
Definition: engine.cpp:162
virtual const core::Signal< void > & client_disconnected_signal() const =0
virtual const core::Property< bool > & is_video_source() const =0