player.h

Go to the documentation of this file.

/*
 * Copyright © 2013-2015 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 *              Jim Hodapp <jim.hodapp@canonical.com>
 */
#ifndef CORE_UBUNTU_MEDIA_PLAYER_H_
#define CORE_UBUNTU_MEDIA_PLAYER_H_
 
#include <core/media/track.h>
 
#include <core/media/video/dimensions.h>
#include <core/media/video/sink.h>
 
#include <core/property.h>
 
#include <chrono>
#include <iosfwd>
#include <memory>
 
namespace core
{
namespace ubuntu
{
namespace media
{
class Service;
class TrackList;
 
struct AVBackend
{
    enum Backend
    {
        none,
        hybris,
        mir
    };
 
    static Backend get_backend_type();
};
 
class Player : public std::enable_shared_from_this<Player>
{
  public:
    typedef double PlaybackRate;
    typedef double Volume;
    typedef uint32_t PlayerKey;
    typedef void* GLConsumerWrapperHybris;
    typedef std::map<std::string, std::string> HeadersType;
 
    struct Errors
    {
        Errors() = delete;
 
        struct OutOfProcessBufferStreamingNotSupported : public std::runtime_error
        {
            OutOfProcessBufferStreamingNotSupported();
        };
 
        struct InsufficientAppArmorPermissions : public std::runtime_error
        {
            InsufficientAppArmorPermissions(const std::string& err);
        };
 
        struct UriNotFound : public std::runtime_error
        {
            UriNotFound(const std::string& err);
        };
    };
 
    struct Configuration;
 
    struct Client
    {
        Client() = delete;
 
        static const Configuration& default_configuration();
    };
 
    enum PlaybackStatus
    {
        null,
        ready,
        playing,
        paused,
        stopped
    };
 
    enum LoopStatus
    {
        none,
        track,
        playlist
    };
 
    enum AudioStreamRole
    {
        alarm,
        alert,
        multimedia,
        phone
    };
 
    enum Orientation
    {
        rotate0,
        rotate90,
        rotate180,
        rotate270
    };
 
    enum Lifetime
    {
        normal,
        resumable
    };
 
    enum Error
    {
        no_error,
        resource_error,
        format_error,
        network_error,
        access_denied_error,
        service_missing_error
    };
 
    Player(const Player&) = delete;
    virtual ~Player();
 
    Player& operator=(const Player&) = delete;
    bool operator==(const Player&) const = delete;
 
    virtual std::string uuid() const = 0;
    virtual void reconnect() = 0;
    virtual void abandon() = 0;
 
    virtual std::shared_ptr<TrackList> track_list() = 0;
    virtual PlayerKey key() const = 0;
 
    virtual video::Sink::Ptr create_gl_texture_video_sink(std::uint32_t texture_id) = 0;
 
    virtual bool open_uri(const Track::UriType& uri) = 0;
    virtual bool open_uri(const Track::UriType& uri, const HeadersType&) = 0;
    virtual void next() = 0;
    virtual void previous() = 0;
    virtual void play() = 0;
    virtual void pause() = 0;
    virtual void stop() = 0;
    virtual void seek_to(const std::chrono::microseconds& offset) = 0;
 
    virtual const core::Property<bool>& can_play() const = 0;
    virtual const core::Property<bool>& can_pause() const = 0;
    virtual const core::Property<bool>& can_seek() const = 0;
    virtual const core::Property<bool>& can_go_previous() const = 0;
    virtual const core::Property<bool>& can_go_next() const = 0;
    virtual const core::Property<bool>& is_video_source() const = 0;
    virtual const core::Property<bool>& is_audio_source() const = 0;
    virtual const core::Property<PlaybackStatus>& playback_status() const = 0;
    virtual const core::Property<AVBackend::Backend>& backend() const = 0;
    virtual const core::Property<LoopStatus>& loop_status() const = 0;
    virtual const core::Property<PlaybackRate>& playback_rate() const = 0;
    virtual const core::Property<bool>& shuffle() const = 0;
    virtual const core::Property<Track::MetaData>& meta_data_for_current_track() const = 0;
    virtual const core::Property<Volume>& volume() const = 0;
    virtual const core::Property<PlaybackRate>& minimum_playback_rate() const = 0;
    virtual const core::Property<PlaybackRate>& maximum_playback_rate() const = 0;
    virtual const core::Property<int64_t>& position() const = 0;
    virtual const core::Property<int64_t>& duration() const = 0;
    virtual const core::Property<AudioStreamRole>& audio_stream_role() const = 0;
    virtual const core::Property<Orientation>& orientation() const = 0;
    virtual const core::Property<Lifetime>& lifetime() const = 0;
 
    virtual core::Property<LoopStatus>& loop_status() = 0;
    virtual core::Property<PlaybackRate>& playback_rate() = 0;
    virtual core::Property<bool>& shuffle() = 0;
    virtual core::Property<Volume>& volume() = 0;
    virtual core::Property<AudioStreamRole>& audio_stream_role() = 0;
    virtual core::Property<Lifetime>& lifetime() = 0;
 
    virtual const core::Signal<int64_t>& seeked_to() const = 0;
    virtual const core::Signal<void>& about_to_finish() const = 0;
    virtual const core::Signal<void>& end_of_stream() const = 0;
    virtual core::Signal<PlaybackStatus>& playback_status_changed() = 0;
    virtual const core::Signal<video::Dimensions>& video_dimension_changed() const = 0;
    virtual const core::Signal<Error>& error() const = 0;
    virtual const core::Signal<int>& buffering_changed() const = 0;
 
  protected:
    Player();
 
};
 
// operator<< pretty prints the given playback status to the given output stream.
inline std::ostream& operator<<(std::ostream& out, Player::PlaybackStatus status)
{
    switch (status)
    {
        case Player::PlaybackStatus::null:
            return out << "PlaybackStatus::null";
        case Player::PlaybackStatus::ready:
            return out << "PlaybackStatus::ready";
        case Player::PlaybackStatus::playing:
            return out << "PlaybackStatus::playing";
        case Player::PlaybackStatus::paused:
            return out << "PlaybackStatus::paused";
        case Player::PlaybackStatus::stopped:
            return out << "PlaybackStatus::stopped";
    }
 
    return out;
}
 
inline std::ostream& operator<<(std::ostream& out, Player::LoopStatus loop_status)
{
    switch (loop_status)
    {
        case Player::LoopStatus::none:
            return out << "LoopStatus::none";
        case Player::LoopStatus::track:
            return out << "LoopStatus::track";
        case Player::LoopStatus::playlist:
            return out << "LoopStatus::playlist";
    }
 
    return out;
}
 
inline std::ostream& operator<<(std::ostream& out, Player::Error e)
{
    switch (e)
    {
        case Player::Error::no_error:
            return out << "Error::no_error";
        case Player::Error::resource_error:
            return out << "Error::resource_error";
        case Player::Error::format_error:
            return out << "Error::format_error";
        case Player::Error::network_error:
            return out << "Error::network_error";
        case Player::Error::access_denied_error:
            return out << "Error::access_denied_error";
        case Player::Error::service_missing_error:
            return out << "Error::service_missing_error";
        default:
            return out << "Unsupported Player error: " << e;
    }
 
    return out;
}
 
}
}
}
 
#endif // CORE_UBUNTU_MEDIA_PLAYER_H_