Music Hub  ..
A session-wide music playback service
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
player_stub.cpp
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 
20 #include <core/media/service.h>
21 #include <core/media/track_list.h>
22 
23 #include "codec.h"
24 #include "player_stub.h"
25 #include "player_traits.h"
26 #include "property_stub.h"
27 #include "the_session_bus.h"
28 #include "track_list_stub.h"
29 
30 #include "mpris/player.h"
31 
32 #include <core/dbus/property.h>
33 #include <core/dbus/types/object_path.h>
34 
35 // Hybris
36 #include <hybris/media/media_codec_layer.h>
37 #include <hybris/media/surface_texture_client_hybris.h>
38 
39 #include <limits>
40 
41 #define UNUSED __attribute__((unused))
42 
43 namespace dbus = core::dbus;
44 namespace media = core::ubuntu::media;
45 
47 {
48  Private(const std::shared_ptr<Service>& parent,
49  const std::shared_ptr<core::dbus::Object>& object
50  ) : parent(parent),
51  texture_id(0),
52  igbc_wrapper(nullptr),
53  glc_wrapper(nullptr),
54  decoding_session(decoding_service_create_session()),
55  frame_available_cb(nullptr),
56  frame_available_context(nullptr),
57  object(object),
59  {
60  object->get_property<mpris::Player::Properties::CanPlay>(),
61  object->get_property<mpris::Player::Properties::CanPause>(),
62  object->get_property<mpris::Player::Properties::CanSeek>(),
63  object->get_property<mpris::Player::Properties::CanControl>(),
64  object->get_property<mpris::Player::Properties::CanGoNext>(),
65  object->get_property<mpris::Player::Properties::CanGoPrevious>(),
66  object->get_property<mpris::Player::Properties::IsVideoSource>(),
67  object->get_property<mpris::Player::Properties::IsAudioSource>(),
68  object->get_property<mpris::Player::Properties::TypedPlaybackStatus>(),
69  object->get_property<mpris::Player::Properties::TypedLoopStatus>(),
70  object->get_property<mpris::Player::Properties::PlaybackRate>(),
71  object->get_property<mpris::Player::Properties::Shuffle>(),
72  object->get_property<mpris::Player::Properties::TypedMetaData>(),
73  object->get_property<mpris::Player::Properties::Volume>(),
74  object->get_property<mpris::Player::Properties::Position>(),
75  object->get_property<mpris::Player::Properties::Duration>(),
76  object->get_property<mpris::Player::Properties::AudioStreamRole>(),
77  object->get_property<mpris::Player::Properties::MinimumRate>(),
78  object->get_property<mpris::Player::Properties::MaximumRate>()
79  },
80  signals
81  {
82  object->get_signal<mpris::Player::Signals::Seeked>(),
83  object->get_signal<mpris::Player::Signals::EndOfStream>(),
84  object->get_signal<mpris::Player::Signals::PlaybackStatusChanged>()
85  }
86  {
87  }
88 
90  {
91  }
92 
93  static void on_frame_available_cb(UNUSED GLConsumerWrapperHybris wrapper, void *context)
94  {
95  if (context != nullptr) {
96  Private *p = static_cast<Private*>(context);
97  p->on_frame_available();
98  }
99  else
100  std::cerr << "context is nullptr, can't call on_frame_available()" << std::endl;
101  }
102 
104  {
105  if (frame_available_cb != nullptr) {
107  }
108  else
109  std::cerr << "frame_available_cb is nullptr, can't call frame_available_cb()" << std::endl;
110  }
111 
112  void set_frame_available_cb(FrameAvailableCb cb, void *context)
113  {
114  frame_available_cb = cb;
115  frame_available_context = context;
116 
117  gl_consumer_set_frame_available_cb(glc_wrapper, &Private::on_frame_available_cb, static_cast<void*>(this));
118  }
119 
123  {
124  igbc_wrapper = decoding_service_get_igraphicbufferconsumer();
125  glc_wrapper = gl_consumer_create_by_id_with_igbc(texture_id, igbc_wrapper);
126 
127  }
128 
129  std::shared_ptr<Service> parent;
130  std::shared_ptr<TrackList> track_list;
131 
132  uint32_t texture_id;
133  IGBCWrapperHybris igbc_wrapper;
135 
136  DSSessionWrapperHybris decoding_session;
137 
140 
141  dbus::Object::Ptr object;
142 
143  struct
144  {
145  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanPlay>> can_play;
146  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanPause>> can_pause;
147  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanSeek>> can_seek;
148  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanControl>> can_control;
149  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanGoNext>> can_go_next;
150  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanGoPrevious>> can_go_previous;
151  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::IsVideoSource>> is_video_source;
152  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::IsAudioSource>> is_audio_source;
153 
154  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::TypedPlaybackStatus>> playback_status;
155  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::TypedLoopStatus>> loop_status;
156  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::PlaybackRate>> playback_rate;
157  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Shuffle>> is_shuffle;
158  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::TypedMetaData>> meta_data_for_current_track;
159  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Volume>> volume;
160  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Position>> position;
161  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Duration>> duration;
162  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::AudioStreamRole>> audio_role;
163  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::MinimumRate>> minimum_playback_rate;
164  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::MaximumRate>> maximum_playback_rate;
165  } properties;
166 
167  struct Signals
168  {
169  typedef core::dbus::Signal<mpris::Player::Signals::Seeked, mpris::Player::Signals::Seeked::ArgumentType> DBusSeekedToSignal;
170  typedef core::dbus::Signal<mpris::Player::Signals::EndOfStream, mpris::Player::Signals::EndOfStream::ArgumentType> DBusEndOfStreamSignal;
171  typedef core::dbus::Signal<mpris::Player::Signals::PlaybackStatusChanged, mpris::Player::Signals::PlaybackStatusChanged::ArgumentType> DBusPlaybackStatusChangedSignal;
172 
173  Signals(const std::shared_ptr<DBusSeekedToSignal>& seeked,
174  const std::shared_ptr<DBusEndOfStreamSignal>& eos,
175  const std::shared_ptr<DBusPlaybackStatusChangedSignal>& status)
176  : dbus
177  {
178  seeked,
179  eos,
180  status
181  },
182  playback_complete_cb(nullptr),
183  playback_complete_context(nullptr),
184  seeked_to(),
185  end_of_stream(),
187  {
188  dbus.seeked_to->connect([this](std::uint64_t value)
189  {
190  std::cout << "seeked_to signal arrived via the bus." << std::endl;
191  seeked_to(value);
192  });
193 
194  dbus.end_of_stream->connect([this]()
195  {
196  std::cout << "EndOfStream signal arrived via the bus." << std::endl;
199  end_of_stream();
200  });
201 
202  dbus.playback_status_changed->connect([this](const media::Player::PlaybackStatus& status)
203  {
204  std::cout << "PlaybackStatusChanged signal arrived via the bus." << std::endl;
205  playback_status_changed(status);
206  });
207  }
208 
209  struct DBus
210  {
211  std::shared_ptr<DBusSeekedToSignal> seeked_to;
212  std::shared_ptr<DBusEndOfStreamSignal> end_of_stream;
213  std::shared_ptr<DBusPlaybackStatusChangedSignal> playback_status_changed;
214  } dbus;
215 
217  {
219  playback_complete_context = context;
220  }
221 
224  core::Signal<int64_t> seeked_to;
225  core::Signal<void> end_of_stream;
226  core::Signal<media::Player::PlaybackStatus> playback_status_changed;
227  } signals;
228 };
229 
231  const std::shared_ptr<Service>& parent,
232  const std::shared_ptr<core::dbus::Object>& object)
233  : d(new Private{parent, object})
234 {
235  auto bus = the_session_bus();
236  worker = std::move(std::thread([bus]()
237  {
238  bus->run();
239  }));
240 }
241 
243 {
244  auto bus = the_session_bus();
245  bus->stop();
246 
247  if (worker.joinable())
248  worker.join();
249 }
250 
251 std::shared_ptr<media::TrackList> media::PlayerStub::track_list()
252 {
253  if (!d->track_list)
254  {
255  d->track_list = std::make_shared<media::TrackListStub>(
256  shared_from_this(),
257  dbus::types::ObjectPath(d->object->path().as_string() + "/TrackList"));
258  }
259  return d->track_list;
260 }
261 
263 {
264  auto op = d->object->invoke_method_synchronously<mpris::Player::Key, media::Player::PlayerKey>();
265 
266  return op.value();
267 }
268 
270 {
271  auto op = d->object->invoke_method_synchronously<mpris::Player::OpenUri, bool>(uri);
272 
273  return op.value();
274 }
275 
276 void media::PlayerStub::create_video_sink(uint32_t texture_id)
277 {
278  auto op = d->object->invoke_method_synchronously<mpris::Player::CreateVideoSink, void>(texture_id);
279  d->texture_id = texture_id;
280  d->get_gl_consumer();
281 
282  if (op.is_error())
283  throw std::runtime_error("Problem creating new video sink instance on remote object");
284 }
285 
287 {
288  return d->glc_wrapper;
289 }
290 
292 {
293  auto op = d->object->invoke_method_synchronously<mpris::Player::Next, void>();
294 
295  if (op.is_error())
296  throw std::runtime_error("Problem switching to next track on remote object");
297 }
298 
300 {
301  auto op = d->object->invoke_method_synchronously<mpris::Player::Previous, void>();
302 
303  if (op.is_error())
304  throw std::runtime_error("Problem switching to previous track on remote object");
305 }
306 
308 {
309  auto op = d->object->invoke_method_synchronously<mpris::Player::Play, void>();
310 
311  if (op.is_error())
312  throw std::runtime_error("Problem starting playback on remote object");
313 }
314 
316 {
317  auto op = d->object->invoke_method_synchronously<mpris::Player::Pause, void>();
318 
319  if (op.is_error())
320  throw std::runtime_error("Problem pausing playback on remote object");
321 }
322 
323 void media::PlayerStub::seek_to(const std::chrono::microseconds& offset)
324 {
325  auto op = d->object->invoke_method_synchronously<mpris::Player::Seek, void, uint64_t>(offset.count());
326 
327  if (op.is_error())
328  throw std::runtime_error("Problem seeking on remote object");
329 }
330 
332 {
333  auto op = d->object->invoke_method_synchronously<mpris::Player::Stop, void>();
334 
335  if (op.is_error())
336  throw std::runtime_error("Problem stopping playback on remote object");
337 }
338 
340 {
341  d->set_frame_available_cb(cb, context);
342 }
343 
345 {
346  d->signals.set_playback_complete_cb(cb, context);
347 }
348 
349 const core::Property<bool>& media::PlayerStub::can_play() const
350 {
351  return *d->properties.can_play;
352 }
353 
354 const core::Property<bool>& media::PlayerStub::can_pause() const
355 {
356  return *d->properties.can_pause;
357 }
358 
359 const core::Property<bool>& media::PlayerStub::can_seek() const
360 {
361  return *d->properties.can_seek;
362 }
363 
364 const core::Property<bool>& media::PlayerStub::can_go_previous() const
365 {
366  return *d->properties.can_go_previous;
367 }
368 
369 const core::Property<bool>& media::PlayerStub::can_go_next() const
370 {
371  return *d->properties.can_go_next;
372 }
373 
374 const core::Property<bool>& media::PlayerStub::is_video_source() const
375 {
376  return *d->properties.is_video_source;
377 }
378 
379 const core::Property<bool>& media::PlayerStub::is_audio_source() const
380 {
381  return *d->properties.is_audio_source;
382 }
383 
384 const core::Property<media::Player::PlaybackStatus>& media::PlayerStub::playback_status() const
385 {
386  return *d->properties.playback_status;
387 }
388 
389 const core::Property<media::Player::LoopStatus>& media::PlayerStub::loop_status() const
390 {
391  return *d->properties.loop_status;
392 }
393 
394 const core::Property<media::Player::PlaybackRate>& media::PlayerStub::playback_rate() const
395 {
396  return *d->properties.playback_rate;
397 }
398 
399 const core::Property<bool>& media::PlayerStub::is_shuffle() const
400 {
401  return *d->properties.is_shuffle;
402 }
403 
404 const core::Property<media::Track::MetaData>& media::PlayerStub::meta_data_for_current_track() const
405 {
406  return *d->properties.meta_data_for_current_track;
407 }
408 
409 const core::Property<media::Player::Volume>& media::PlayerStub::volume() const
410 {
411  return *d->properties.volume;
412 }
413 
414 const core::Property<int64_t>& media::PlayerStub::position() const
415 {
416  return *d->properties.position;
417 }
418 
419 const core::Property<int64_t>& media::PlayerStub::duration() const
420 {
421  return *d->properties.duration;
422 }
423 
424 const core::Property<media::Player::AudioStreamRole>& media::PlayerStub::audio_stream_role() const
425 {
426  return *d->properties.audio_role;
427 }
428 
429 const core::Property<media::Player::PlaybackRate>& media::PlayerStub::minimum_playback_rate() const
430 {
431  return *d->properties.minimum_playback_rate;
432 }
433 
434 const core::Property<media::Player::PlaybackRate>& media::PlayerStub::maximum_playback_rate() const
435 {
436  return *d->properties.maximum_playback_rate;
437 }
438 
439 core::Property<media::Player::LoopStatus>& media::PlayerStub::loop_status()
440 {
441  return *d->properties.loop_status;
442 }
443 
444 core::Property<media::Player::PlaybackRate>& media::PlayerStub::playback_rate()
445 {
446  return *d->properties.playback_rate;
447 }
448 
449 core::Property<bool>& media::PlayerStub::is_shuffle()
450 {
451  return *d->properties.is_shuffle;
452 }
453 
454 core::Property<media::Player::Volume>& media::PlayerStub::volume()
455 {
456  return *d->properties.volume;
457 }
458 
459 core::Property<media::Player::AudioStreamRole>& media::PlayerStub::audio_stream_role()
460 {
461  return *d->properties.audio_role;
462 }
463 
464 const core::Signal<int64_t>& media::PlayerStub::seeked_to() const
465 {
466  return d->signals.seeked_to;
467 }
468 
469 const core::Signal<void>& media::PlayerStub::end_of_stream() const
470 {
471  return d->signals.end_of_stream;
472 }
473 
474 core::Signal<media::Player::PlaybackStatus>& media::PlayerStub::playback_status_changed()
475 {
476  return d->signals.playback_status_changed;
477 }
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::CanPlay > > can_play
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::CanControl > > can_control
void * GLConsumerWrapperHybris
Definition: player.h:44
IGBCWrapperHybris igbc_wrapper
std::shared_ptr< DBusEndOfStreamSignal > end_of_stream
void set_frame_available_cb(FrameAvailableCb cb, void *context)
virtual void create_video_sink(uint32_t texture_id)
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::IsAudioSource > > is_audio_source
virtual const core::Property< int64_t > & position() const
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::MinimumRate > > minimum_playback_rate
virtual const core::Property< bool > & is_video_source() const
struct media::PlayerStub::Private::Signals signals
virtual const core::Signal< void > & end_of_stream() const
core::Signal< void > end_of_stream
static void on_frame_available_cb(UNUSED GLConsumerWrapperHybris wrapper, void *context)
Definition: player_stub.cpp:93
dbus::Object::Ptr object
virtual const core::Property< int64_t > & duration() const
std::shared_ptr< DBusSeekedToSignal > seeked_to
virtual const core::Property< bool > & is_audio_source() const
core::dbus::Signal< mpris::Player::Signals::EndOfStream, mpris::Player::Signals::EndOfStream::ArgumentType > DBusEndOfStreamSignal
std::shared_ptr< Service > parent
virtual const core::Property< bool > & can_pause() const
GLConsumerWrapperHybris glc_wrapper
void(* FrameAvailableCb)(void *context)
Definition: player.h:48
virtual const core::Property< Volume > & volume() const
virtual void set_playback_complete_callback(PlaybackCompleteCb cb, void *context)
struct media::PlayerStub::Private::Signals::DBus dbus
virtual const core::Property< bool > & can_play() const
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::Volume > > volume
virtual GLConsumerWrapperHybris gl_consumer() const
struct media::PlayerStub::Private::@18 properties
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::TypedLoopStatus > > loop_status
virtual const core::Property< bool > & can_go_next() const
core::dbus::Signal< mpris::Player::Signals::Seeked, mpris::Player::Signals::Seeked::ArgumentType > DBusSeekedToSignal
virtual const core::Property< Track::MetaData > & meta_data_for_current_track() const
core::dbus::Signal< mpris::Player::Signals::PlaybackStatusChanged, mpris::Player::Signals::PlaybackStatusChanged::ArgumentType > DBusPlaybackStatusChangedSignal
PlayerStub(const std::shared_ptr< Service > &parent, const std::shared_ptr< core::dbus::Object > &object)
virtual const core::Property< bool > & is_shuffle() const
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::CanPause > > can_pause
void(* PlaybackCompleteCb)(void *context)
Definition: player.h:49
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::CanGoPrevious > > can_go_previous
virtual core::Signal< PlaybackStatus > & playback_status_changed()
Private(const std::shared_ptr< Service > &parent, const std::shared_ptr< core::dbus::Object > &object)
Definition: player_stub.cpp:48
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::Shuffle > > is_shuffle
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::Duration > > duration
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::TypedMetaData > > meta_data_for_current_track
virtual const core::Signal< int64_t > & seeked_to() const
std::shared_ptr< TrackList > track_list
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::CanSeek > > can_seek
DSSessionWrapperHybris decoding_session
virtual const core::Property< PlaybackStatus > & playback_status() const
virtual const core::Property< AudioStreamRole > & audio_stream_role() const
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::AudioStreamRole > > audio_role
virtual PlayerKey key() const
#define UNUSED
Definition: player_stub.cpp:41
core::dbus::Bus::Ptr the_session_bus()
virtual const core::Property< PlaybackRate > & minimum_playback_rate() const
virtual const core::Property< bool > & can_seek() const
virtual void set_frame_available_callback(FrameAvailableCb cb, void *context)
FrameAvailableCb frame_available_cb
virtual bool open_uri(const Track::UriType &uri)
std::string UriType
Definition: track.h:40
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::Position > > position
core::Signal< int64_t > seeked_to
void set_playback_complete_cb(PlaybackCompleteCb cb, void *context)
PlaybackCompleteCb playback_complete_cb
virtual void seek_to(const std::chrono::microseconds &offset)
virtual std::shared_ptr< TrackList > track_list()
Signals(const std::shared_ptr< DBusSeekedToSignal > &seeked, const std::shared_ptr< DBusEndOfStreamSignal > &eos, const std::shared_ptr< DBusPlaybackStatusChangedSignal > &status)
std::shared_ptr< DBusPlaybackStatusChangedSignal > playback_status_changed
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::TypedPlaybackStatus > > playback_status
virtual const core::Property< PlaybackRate > & playback_rate() const
virtual const core::Property< bool > & can_go_previous() const
virtual const core::Property< PlaybackRate > & maximum_playback_rate() const
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::PlaybackRate > > playback_rate
core::Signal< media::Player::PlaybackStatus > playback_status_changed
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::MaximumRate > > maximum_playback_rate
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::IsVideoSource > > is_video_source
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::CanGoNext > > can_go_next
virtual const core::Property< LoopStatus > & loop_status() const