/*
Copyright 2010-2015 Canonical Ltd.
Copyright 2021 Robert Tari

Authors:
    Conor Curran <conor.curran@canonical.com>
    Robert Tari <robert@tari.in>

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU 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 warranties of
MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

const string MPRIS_PREFIX = "org.mpris.MediaPlayer2.";
const string MPRIS_MEDIA_PLAYER_PATH = "/org/mpris/MediaPlayer2";

[DBus (name = "org.mpris.MediaPlayer2")]
public interface MprisRoot : Object {
  // properties
  public abstract bool HasTracklist{owned get; set;}
  public abstract bool CanQuit{owned get; set;}
  public abstract bool CanRaise{owned get; set;}
  public abstract string Identity{owned get; set;}
  public abstract string DesktopEntry{owned get; set;}
  // methods
  public abstract async void Quit() throws GLib.DBusError, GLib.IOError;
  public abstract async void Raise() throws GLib.DBusError, GLib.IOError;
}

[DBus (name = "org.mpris.MediaPlayer2.Player")]
public interface MprisPlayer : Object {
  // properties
  public abstract HashTable<string, Variant?> Metadata{owned get; set;}
  public abstract int64 Position{owned get; set;}
  public abstract string? PlaybackStatus{owned get; set;}
  public abstract bool CanPlay{owned get; set;}
  public abstract bool CanGoNext{owned get; set;}
  public abstract bool CanGoPrevious{owned get; set;}
  // methods
  public abstract async void PlayPause() throws GLib.DBusError, GLib.IOError;
  public abstract async void Next() throws GLib.DBusError, GLib.IOError;
  public abstract async void Previous() throws GLib.DBusError, GLib.IOError;
  public abstract async void Seek(int64 offset) throws GLib.DBusError, GLib.IOError;
  // signals
  public signal void Seeked(int64 new_position);
}

// Playlist container
public struct PlaylistDetails{
  public ObjectPath? path;
  public string? name;
  public string? icon_path;
}

// Active playlist property container
public struct ActivePlaylistContainer{
  public bool valid;
  public PlaylistDetails? details;
}

[DBus (name = "org.mpris.MediaPlayer2.Playlists")]
public interface MprisPlaylists : Object {
  //properties
  public abstract string[] Orderings{owned get; set;}
  public abstract uint32 PlaylistCount{owned get; set;}
  public abstract ActivePlaylistContainer? ActivePlaylist {owned get; set;}

  //methods
  public abstract async void ActivatePlaylist(ObjectPath playlist_id) throws GLib.DBusError, GLib.IOError;
  public abstract async PlaylistDetails[]? GetPlaylists ( uint32 index,
                                                          uint32 max_count,
                                                          string order,
                                                          bool reverse_order ) throws GLib.DBusError, GLib.IOError;
  //signals
  public signal void PlaylistChanged (PlaylistDetails details);

}
