ialbumartprovider.h

Go to the documentation of this file.

/**********************************************************************
 * 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 <QString>
#include <QList>
#include <QImage>
#include <QHash>
#include <QMetaType>

class QUrl;

namespace Media
{
    struct AlbumInfo
    {
        QString Artist_;

        QString Album_;
    };

    inline bool operator== (const AlbumInfo& a1, const AlbumInfo& a2)
    {
        return a1.Artist_ == a2.Artist_ &&
            a1.Album_ == a2.Album_;
    }

    inline uint qHash (const AlbumInfo& info)
    {
        return qHash (info.Album_.toUtf8 () + '\0' + info.Artist_.toUtf8 ());
    }

    class IPendingAlbumArt
    {
    public:
        virtual ~IPendingAlbumArt () {}

        virtual QObject* GetQObject () = 0;

        virtual AlbumInfo GetAlbumInfo () const = 0;

        virtual QList<QImage> GetImages () const = 0;

        virtual QList<QUrl> GetImageUrls () const = 0;
    protected:
        virtual void ready (const AlbumInfo& info, const QList<QImage>& images) = 0;

        virtual void urlsReady (const AlbumInfo& info, const QList<QUrl>& urls) = 0;
    };

    class Q_DECL_EXPORT IAlbumArtProvider
    {
    public:
        virtual ~IAlbumArtProvider () {}

        virtual QString GetAlbumArtProviderName () const = 0;

        virtual IPendingAlbumArt* RequestAlbumArt (const AlbumInfo& album) const = 0;
    };
}

Q_DECLARE_METATYPE (Media::AlbumInfo)
Q_DECLARE_INTERFACE (Media::IAlbumArtProvider, "org.LeechCraft.Media.IAlbumArtProvider/1.0")
Q_DECLARE_INTERFACE (Media::IPendingAlbumArt, "org.LeechCraft.Media.IPendingAlbumArt/1.0")