track_list.h

Go to the documentation of this file.

/*
 * Copyright © 2013 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>
 */
#ifndef CORE_UBUNTU_MEDIA_TRACK_LIST_H_
#define CORE_UBUNTU_MEDIA_TRACK_LIST_H_
 
#include <core/media/track.h>
 
#include <core/property.h>
#include <core/signal.h>
 
#include <functional>
#include <iosfwd>
#include <memory>
#include <string>
#include <vector>
 
namespace core
{
namespace ubuntu
{
namespace media
{
class Player;
 
class TrackList : public std::enable_shared_from_this<TrackList>
{
  public:
    typedef std::vector<Track::Id> Container;
    typedef std::vector<Track::UriType> ContainerURI;
    typedef std::tuple<std::vector<Track::Id>, Track::Id> ContainerTrackIdTuple;
    typedef std::tuple<Track::Id, Track::Id> TrackIdTuple;
    typedef Container::iterator Iterator;
    typedef Container::const_iterator ConstIterator;
 
    struct Errors
    {
        Errors() = delete;
 
        struct InsufficientPermissionsToAddTrack : public std::runtime_error
        {
            InsufficientPermissionsToAddTrack();
        };
 
        struct FailedToMoveTrack : public std::runtime_error
        {
            FailedToMoveTrack();
        };
 
        struct FailedToFindMoveTrackSource : public std::runtime_error
        {
            FailedToFindMoveTrackSource(const std::string& err);
        };
 
        struct FailedToFindMoveTrackDest : public std::runtime_error
        {
            FailedToFindMoveTrackDest(const std::string& err);
        };
 
        struct TrackNotFound : public std::runtime_error
        {
            TrackNotFound();
        };
    };
 
    static const Track::Id& after_empty_track();
 
    TrackList(const TrackList&) = delete;
    ~TrackList();
 
    TrackList& operator=(const TrackList&) = delete;
    bool operator==(const TrackList&) const = delete;
 
    virtual const core::Property<bool>& can_edit_tracks() const = 0;
 
    virtual const core::Property<Container>& tracks() const = 0;
 
    virtual Track::MetaData query_meta_data_for_track(const Track::Id& id) = 0;
 
    virtual Track::UriType query_uri_for_track(const Track::Id& id) = 0;
 
    virtual void add_track_with_uri_at(const Track::UriType& uri, const Track::Id& position, bool make_current) = 0;
 
    virtual void add_tracks_with_uri_at(const ContainerURI& uris, const Track::Id& position) = 0;
 
    virtual bool move_track(const Track::Id& id, const Track::Id& to) = 0;
 
    virtual void remove_track(const Track::Id& id) = 0;
 
    virtual void go_to(const Track::Id& track) = 0;
 
    bool has_next() const;
 
    bool has_previous() const;
 
    virtual Track::Id next() = 0;
 
    virtual Track::Id previous() = 0;
 
    virtual void reset() = 0;
 
    virtual const core::Signal<ContainerTrackIdTuple>& on_track_list_replaced() const = 0;
 
    virtual const core::Signal<Track::Id>& on_track_added() const = 0;
 
    virtual const core::Signal<ContainerURI>& on_tracks_added() const = 0;
 
    virtual const core::Signal<TrackIdTuple>& on_track_moved() const = 0;
 
    virtual const core::Signal<Track::Id>& on_track_removed() const = 0;
 
    virtual const core::Signal<void>& on_track_list_reset() const = 0;
 
    virtual const core::Signal<Track::Id>& on_track_changed() const = 0;
 
    virtual const core::Signal<Track::Id>& on_go_to_track() const = 0;
 
    virtual const core::Signal<void>& on_end_of_tracklist() const = 0;
 
protected:
    TrackList();
};
 
}
}
}
 
#endif // CORE_UBUNTU_MEDIA_TRACK_LIST_H_