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