inputsource.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2009-2024 by Ilya Kotov                                 *
 *   forkotov02@ya.ru                                                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
 ***************************************************************************/

#ifndef INPUTSOURCE_H
#define INPUTSOURCE_H

#include <QIODevice>
#include <QMap>
#include <QHash>
#include "qmmp.h"
#include "inputsourcefactory.h"

class QmmpPluginCache;

class QMMP_EXPORT InputSource : public QObject
{
    Q_OBJECT
public:
    explicit InputSource(const QString &path, QObject *parent = nullptr);

    virtual QIODevice *ioDevice() const = 0;
    virtual bool initialize() = 0;
    virtual bool isReady() const = 0;
    virtual bool isWaiting() const;
    virtual QString contentType() const;
    virtual void stop();
    QString path() const;
    qint64 offset() const;
    void setOffset(qint64 offset);
    void addMetaData(const QMap<Qmmp::MetaData, QString> &metaData);
    bool hasMetaData() const;
    QMap<Qmmp::MetaData, QString> takeMetaData();
    void setProperty(Qmmp::TrackProperty key, const QVariant &value);
    void setProperties(const QMap<Qmmp::TrackProperty, QString> &properties);
    const QMap<Qmmp::TrackProperty, QString> &properties() const;
    void addStreamInfo(const QHash<QString, QString> &info);
    bool hasStreamInfo() const;
    QHash<QString, QString> takeStreamInfo();
    static InputSource *create(const QString &path, QObject *parent = nullptr);
    static QList<InputSourceFactory *> factories();
    static QList<InputSourceFactory *> enabledFactories();
    static QString file(const InputSourceFactory *factory);
    static QStringList protocols();
    static QList<RegularExpression> regExps();
    static InputSourceFactory *findByUrl(const QString &url);
    static void setEnabled(InputSourceFactory *factory, bool enable = true);
    static bool isEnabled(const InputSourceFactory* factory);

signals:
    void ready();
    void error();

private:
    QString m_path;
    qint64 m_offset = -1;
    QMap<Qmmp::MetaData, QString> m_metaData;
    QMap<Qmmp::TrackProperty, QString> m_properties;
    QHash<QString, QString> m_streamInfo;
    bool m_hasMetaData = false, m_hasStreamInfo = false;

    static void loadPlugins();
    static QList<QmmpPluginCache*> *m_cache;
    static QStringList m_disabledNames;

};

#endif