/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/

#pragma once

#include <QDateTime>
#include "audiostructs.h"

namespace Media
{
	/** @brief Interface for plugins that support scrobbling.
	 *
	 * Plugins supporting scrobbling listened tracks to services like
	 * Last.FM or Jamendo should implement this interface.
	 */
	class Q_DECL_EXPORT IAudioScrobbler
	{
	public:
		virtual ~IAudioScrobbler () {}

		using BackdatedTrack_t = QPair<Media::AudioInfo, QDateTime>;
		using BackdatedTracks_t = QList<BackdatedTrack_t>;

		enum class Feature
		{
			Backdating
		};

		virtual bool SupportsFeature (Feature feature) const = 0;

		/** @brief Returns the service name.
		 *
		 * This string returns a human-readable string with the service
		 * name, like "Last.FM".
		 *
		 * @return The human-readable service name.
		 */
		virtual QString GetServiceName () const = 0;

		/** @brief Notifies the scrobbler that a new track is playing.
		 *
		 * This function should be called by an audio player when a new
		 * track is playing. The track data is contained in the audio
		 * parameter.
		 *
		 * This function should only be called when a track has been
		 * changed, or when the user has explicitly restarted track
		 * playback. This function should \em not be called after pausing
		 * and resuming playback.
		 *
		 * @param[in] audio The information about currently playing track.
		 */
		virtual void NowPlaying (const AudioInfo& audio) = 0;

		virtual void SendBackdated (const BackdatedTracks_t& list) = 0;

		/** @brief Notifies the scrobbler that playback is stopped.
		 *
		 * This function should be called when user stops the playback of
		 * the current track. This function should \em not be called on
		 * pausing.
		 */
		virtual void PlaybackStopped () = 0;

		/** @brief Notifies the scrobbler that user loves current track.
		 *
		 * This function should be called when user explicitly states
		 * that he loves the current track, that is, the track described
		 * by the last call to NowPlaying().
		 *
		 * @sa BanCurrentTrack()
		 */
		virtual void LoveCurrentTrack () = 0;

		/** @brief Notifies the scrobbler that user hates current track.
		 *
		 * This function should be called when user explicitly states
		 * that he hates the current track, that is, the track described
		 * by the last call to NowPlaying().
		 *
		 * @sa LoveCurrentTrack()
		 */
		virtual void BanCurrentTrack () = 0;
	};
}

Q_DECLARE_INTERFACE (Media::IAudioScrobbler, "org.LeechCraft.Media.IAudioScrobbler/1.0")
