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  // Link the properties from the server side to the client side over the bus
61  object->get_property<mpris::Player::Properties::CanPlay>(),
62  object->get_property<mpris::Player::Properties::CanPause>(),
63  object->get_property<mpris::Player::Properties::CanSeek>(),
64  object->get_property<mpris::Player::Properties::CanControl>(),
65  object->get_property<mpris::Player::Properties::CanGoNext>(),
66  object->get_property<mpris::Player::Properties::CanGoPrevious>(),
67  object->get_property<mpris::Player::Properties::IsVideoSource>(),
68  object->get_property<mpris::Player::Properties::IsAudioSource>(),
69  object->get_property<mpris::Player::Properties::TypedPlaybackStatus>(),
70  object->get_property<mpris::Player::Properties::TypedLoopStatus>(),
71  object->get_property<mpris::Player::Properties::PlaybackRate>(),
72  object->get_property<mpris::Player::Properties::Shuffle>(),
73  object->get_property<mpris::Player::Properties::TypedMetaData>(),
74  object->get_property<mpris::Player::Properties::Volume>(),
75  object->get_property<mpris::Player::Properties::Position>(),
76  object->get_property<mpris::Player::Properties::Duration>(),
77  object->get_property<mpris::Player::Properties::AudioStreamRole>(),
78  object->get_property<mpris::Player::Properties::Orientation>(),
79  object->get_property<mpris::Player::Properties::MinimumRate>(),
80  object->get_property<mpris::Player::Properties::MaximumRate>()
81  },
82  signals
83  {
84  object->get_signal<mpris::Player::Signals::Seeked>(),
85  object->get_signal<mpris::Player::Signals::EndOfStream>(),
86  object->get_signal<mpris::Player::Signals::PlaybackStatusChanged>(),
87  object->get_signal<mpris::Player::Signals::VideoDimensionChanged>()
88  }
89  {
90  }
91 
93  {
94  }
95 
96  static void on_frame_available_cb(UNUSED GLConsumerWrapperHybris wrapper, void *context)
97  {
98  if (context != nullptr) {
99  Private *p = static_cast<Private*>(context);
100  p->on_frame_available();
101  }
102  else
103  std::cerr << "context is nullptr, can't call on_frame_available()" << std::endl;
104  }
105 
107  {
108  if (frame_available_cb != nullptr) {
110  }
111  else
112  std::cerr << "frame_available_cb is nullptr, can't call frame_available_cb()" << std::endl;
113  }
114 
115  void set_frame_available_cb(FrameAvailableCb cb, void *context)
116  {
117  frame_available_cb = cb;
118  frame_available_context = context;
119 
120  gl_consumer_set_frame_available_cb(glc_wrapper, &Private::on_frame_available_cb, static_cast<void*>(this));
121  }
122 
126  {
127  igbc_wrapper = decoding_service_get_igraphicbufferconsumer();
128  glc_wrapper = gl_consumer_create_by_id_with_igbc(texture_id, igbc_wrapper);
129 
130  }
131 
132  std::shared_ptr<Service> parent;
133  std::shared_ptr<TrackList> track_list;
134 
135  uint32_t texture_id;
136  IGBCWrapperHybris igbc_wrapper;
138 
139  DSSessionWrapperHybris decoding_session;
140 
143 
144  dbus::Object::Ptr object;
145 
146  struct
147  {
148  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanPlay>> can_play;
149  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanPause>> can_pause;
150  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanSeek>> can_seek;
151  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanControl>> can_control;
152  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanGoNext>> can_go_next;
153  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::CanGoPrevious>> can_go_previous;
154  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::IsVideoSource>> is_video_source;
155  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::IsAudioSource>> is_audio_source;
156 
157  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::TypedPlaybackStatus>> playback_status;
158  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::TypedLoopStatus>> loop_status;
159  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::PlaybackRate>> playback_rate;
160  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Shuffle>> is_shuffle;
161  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::TypedMetaData>> meta_data_for_current_track;
162  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Volume>> volume;
163  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Position>> position;
164  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Duration>> duration;
165  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::AudioStreamRole>> audio_role;
166  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::Orientation>> orientation;
167  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::MinimumRate>> minimum_playback_rate;
168  std::shared_ptr<core::dbus::Property<mpris::Player::Properties::MaximumRate>> maximum_playback_rate;
169  } properties;
170 
171  struct Signals
172  {
173  typedef core::dbus::Signal<mpris::Player::Signals::Seeked, mpris::Player::Signals::Seeked::ArgumentType> DBusSeekedToSignal;
174  typedef core::dbus::Signal<mpris::Player::Signals::EndOfStream, mpris::Player::Signals::EndOfStream::ArgumentType> DBusEndOfStreamSignal;
175  typedef core::dbus::Signal<mpris::Player::Signals::PlaybackStatusChanged, mpris::Player::Signals::PlaybackStatusChanged::ArgumentType> DBusPlaybackStatusChangedSignal;
176  typedef core::dbus::Signal<mpris::Player::Signals::VideoDimensionChanged, mpris::Player::Signals::VideoDimensionChanged::ArgumentType> DBusVideoDimensionChangedSignal;
177 
178  Signals(const std::shared_ptr<DBusSeekedToSignal>& seeked,
179  const std::shared_ptr<DBusEndOfStreamSignal>& eos,
180  const std::shared_ptr<DBusPlaybackStatusChangedSignal>& status,
181  const std::shared_ptr<DBusVideoDimensionChangedSignal>& d)
182  : dbus
183  {
184  seeked,
185  eos,
186  status,
187  d
188  },
189  playback_complete_cb(nullptr),
190  playback_complete_context(nullptr),
191  seeked_to(),
192  end_of_stream(),
195  {
196  dbus.seeked_to->connect([this](std::uint64_t value)
197  {
198  std::cout << "seeked_to signal arrived via the bus." << std::endl;
199  seeked_to(value);
200  });
201 
202  dbus.end_of_stream->connect([this]()
203  {
204  std::cout << "EndOfStream signal arrived via the bus." << std::endl;
207  end_of_stream();
208  });
209 
210  dbus.playback_status_changed->connect([this](const media::Player::PlaybackStatus& status)
211  {
212  std::cout << "PlaybackStatusChanged signal arrived via the bus." << std::endl;
213  playback_status_changed(status);
214  });
215 
216  dbus.video_dimension_changed->connect([this](uint64_t mask)
217  {
218  std::cout << "VideoDimensionChanged signal arrived via the bus." << std::endl;
220  });
221  }
222 
223  struct DBus
224  {
225  std::shared_ptr<DBusSeekedToSignal> seeked_to;
226  std::shared_ptr<DBusEndOfStreamSignal> end_of_stream;
227  std::shared_ptr<DBusPlaybackStatusChangedSignal> playback_status_changed;
228  std::shared_ptr<DBusVideoDimensionChangedSignal> video_dimension_changed;
229  } dbus;
230 
232  {
234  playback_complete_context = context;
235  }
236 
239  core::Signal<int64_t> seeked_to;
240  core::Signal<void> end_of_stream;
241  core::Signal<media::Player::PlaybackStatus> playback_status_changed;
242  core::Signal<uint64_t> video_dimension_changed;
243  } signals;
244 };
245 
247  const std::shared_ptr<Service>& parent,
248  const std::shared_ptr<core::dbus::Object>& object)
249  : d(new Private{parent, object})
250 {
251 }
252 
254 {
255 }
256 
257 std::shared_ptr<media::TrackList> media::PlayerStub::track_list()
258 {
259  if (!d->track_list)
260  {
261  d->track_list = std::make_shared<media::TrackListStub>(
262  shared_from_this(),
263  dbus::types::ObjectPath(d->object->path().as_string() + "/TrackList"));
264  }
265  return d->track_list;
266 }
267 
269 {
270  auto op = d->object->invoke_method_synchronously<mpris::Player::Key, media::Player::PlayerKey>();
271 
272  return op.value();
273 }
274 
276 {
277  auto op = d->object->invoke_method_synchronously<mpris::Player::OpenUri, bool>(uri);
278 
279  return op.value();
280 }
281 
282 void media::PlayerStub::create_video_sink(uint32_t texture_id)
283 {
284  auto op = d->object->invoke_method_synchronously<mpris::Player::CreateVideoSink, void>(texture_id);
285  d->texture_id = texture_id;
286  d->get_gl_consumer();
287 
288  if (op.is_error())
289  throw std::runtime_error("Problem creating new video sink instance on remote object");
290 }
291 
293 {
294  return d->glc_wrapper;
295 }
296 
298 {
299  auto op = d->object->invoke_method_synchronously<mpris::Player::Next, void>();
300 
301  if (op.is_error())
302  throw std::runtime_error("Problem switching to next track on remote object");
303 }
304 
306 {
307  auto op = d->object->invoke_method_synchronously<mpris::Player::Previous, void>();
308 
309  if (op.is_error())
310  throw std::runtime_error("Problem switching to previous track on remote object");
311 }
312 
314 {
315  auto op = d->object->invoke_method_synchronously<mpris::Player::Play, void>();
316 
317  if (op.is_error())
318  throw std::runtime_error("Problem starting playback on remote object");
319 }
320 
322 {
323  auto op = d->object->invoke_method_synchronously<mpris::Player::Pause, void>();
324 
325  if (op.is_error())
326  throw std::runtime_error("Problem pausing playback on remote object");
327 }
328 
329 void media::PlayerStub::seek_to(const std::chrono::microseconds& offset)
330 {
331  auto op = d->object->invoke_method_synchronously<mpris::Player::Seek, void, uint64_t>(offset.count());
332 
333  if (op.is_error())
334  throw std::runtime_error("Problem seeking on remote object");
335 }
336 
338 {
339  auto op = d->object->invoke_method_synchronously<mpris::Player::Stop, void>();
340 
341  if (op.is_error())
342  throw std::runtime_error("Problem stopping playback on remote object");
343 }
344 
346 {
347  d->set_frame_available_cb(cb, context);
348 }
349 
351 {
352  d->signals.set_playback_complete_cb(cb, context);
353 }
354 
355 const core::Property<bool>& media::PlayerStub::can_play() const
356 {
357  return *d->properties.can_play;
358 }
359 
360 const core::Property<bool>& media::PlayerStub::can_pause() const
361 {
362  return *d->properties.can_pause;
363 }
364 
365 const core::Property<bool>& media::PlayerStub::can_seek() const
366 {
367  return *d->properties.can_seek;
368 }
369 
370 const core::Property<bool>& media::PlayerStub::can_go_previous() const
371 {
372  return *d->properties.can_go_previous;
373 }
374 
375 const core::Property<bool>& media::PlayerStub::can_go_next() const
376 {
377  return *d->properties.can_go_next;
378 }
379 
380 const core::Property<bool>& media::PlayerStub::is_video_source() const
381 {
382  return *d->properties.is_video_source;
383 }
384 
385 const core::Property<bool>& media::PlayerStub::is_audio_source() const
386 {
387  return *d->properties.is_audio_source;
388 }
389 
390 const core::Property<media::Player::PlaybackStatus>& media::PlayerStub::playback_status() const
391 {
392  return *d->properties.playback_status;
393 }
394 
395 const core::Property<media::Player::LoopStatus>& media::PlayerStub::loop_status() const
396 {
397  return *d->properties.loop_status;
398 }
399 
400 const core::Property<media::Player::PlaybackRate>& media::PlayerStub::playback_rate() const
401 {
402  return *d->properties.playback_rate;
403 }
404 
405 const core::Property<bool>& media::PlayerStub::is_shuffle() const
406 {
407  return *d->properties.is_shuffle;
408 }
409 
410 const core::Property<media::Track::MetaData>& media::PlayerStub::meta_data_for_current_track() const
411 {
412  return *d->properties.meta_data_for_current_track;
413 }
414 
415 const core::Property<media::Player::Volume>& media::PlayerStub::volume() const
416 {
417  return *d->properties.volume;
418 }
419 
420 const core::Property<int64_t>& media::PlayerStub::position() const
421 {
422  return *d->properties.position;
423 }
424 
425 const core::Property<int64_t>& media::PlayerStub::duration() const
426 {
427  return *d->properties.duration;
428 }
429 
430 const core::Property<media::Player::AudioStreamRole>& media::PlayerStub::audio_stream_role() const
431 {
432  return *d->properties.audio_role;
433 }
434 
435 const core::Property<media::Player::Orientation>& media::PlayerStub::orientation() const
436 {
437  return *d->properties.orientation;
438 }
439 
440 const core::Property<media::Player::PlaybackRate>& media::PlayerStub::minimum_playback_rate() const
441 {
442  return *d->properties.minimum_playback_rate;
443 }
444 
445 const core::Property<media::Player::PlaybackRate>& media::PlayerStub::maximum_playback_rate() const
446 {
447  return *d->properties.maximum_playback_rate;
448 }
449 
450 core::Property<media::Player::LoopStatus>& media::PlayerStub::loop_status()
451 {
452  return *d->properties.loop_status;
453 }
454 
455 core::Property<media::Player::PlaybackRate>& media::PlayerStub::playback_rate()
456 {
457  return *d->properties.playback_rate;
458 }
459 
460 core::Property<bool>& media::PlayerStub::is_shuffle()
461 {
462  return *d->properties.is_shuffle;
463 }
464 
465 core::Property<media::Player::Volume>& media::PlayerStub::volume()
466 {
467  return *d->properties.volume;
468 }
469 
470 core::Property<media::Player::AudioStreamRole>& media::PlayerStub::audio_stream_role()
471 {
472  return *d->properties.audio_role;
473 }
474 
475 const core::Signal<int64_t>& media::PlayerStub::seeked_to() const
476 {
477  return d->signals.seeked_to;
478 }
479 
480 const core::Signal<void>& media::PlayerStub::end_of_stream() const
481 {
482  return d->signals.end_of_stream;
483 }
484 
485 core::Signal<media::Player::PlaybackStatus>& media::PlayerStub::playback_status_changed()
486 {
487  return d->signals.playback_status_changed;
488 }
489 
490 const core::Signal<uint64_t>& media::PlayerStub::video_dimension_changed() const
491 {
492  return d->signals.video_dimension_changed;
493 }
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
std::shared_ptr< DBusVideoDimensionChangedSignal > video_dimension_changed
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
virtual const core::Property< Orientation > & orientation() 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< uint64_t > & video_dimension_changed() const
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:96
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
core::dbus::Signal< mpris::Player::Signals::VideoDimensionChanged, mpris::Player::Signals::VideoDimensionChanged::ArgumentType > DBusVideoDimensionChangedSignal
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
Signals(const std::shared_ptr< DBusSeekedToSignal > &seeked, const std::shared_ptr< DBusEndOfStreamSignal > &eos, const std::shared_ptr< DBusPlaybackStatusChangedSignal > &status, const std::shared_ptr< DBusVideoDimensionChangedSignal > &d)
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
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
core::Signal< uint64_t > video_dimension_changed
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)
std::shared_ptr< core::dbus::Property< mpris::Player::Properties::Orientation > > orientation
virtual std::shared_ptr< TrackList > track_list()
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