decoder.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2014-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 DECODER_H
#define DECODER_H

#include <QStringList>
#include <QMap>
#include <QIODevice>
#include "audioparameters.h"
#include "channelmap.h"
#include "regularexpression.h"

class QmmpPluginCache;
class DecoderFactory;

class QMMP_EXPORT Decoder
{
public:
    explicit Decoder(QIODevice *input = nullptr);
    virtual ~Decoder() = default;

    virtual bool initialize() = 0;
    virtual qint64 totalTime() const = 0;
    virtual void seek(qint64 time) = 0;
    virtual qint64 read(unsigned char *data, qint64 maxSize) = 0;
    virtual int bitrate() const = 0;
    virtual void next();
    virtual const QString nextURL() const;
    const AudioParameters &audioParameters() const;
    const QMap<Qmmp::ReplayGainKey, double> &replayGainInfo() const;
    void setReplayGainInfo(const QMap<Qmmp::ReplayGainKey,double> &rg);
    QIODevice *input();
    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);
    QMap<Qmmp::TrackProperty, QString> properties() const;
    static DecoderFactory *findByFilePath(const QString &path, bool useContent = false);
    static DecoderFactory *findByMime(const QString &mime);
    static DecoderFactory *findByContent(QIODevice *input);
    static DecoderFactory *findByProtocol(const QString &p);
    static QList<DecoderFactory *> findByFileExtension(const QString &path);
    static QList<DecoderFactory*> factories();
    static QList<DecoderFactory*> enabledFactories();
    static QStringList nameFilters();
    static QStringList contentTypes();
    static QString file(const DecoderFactory *factory);
    static QStringList protocols();
    static void setEnabled(DecoderFactory *factory, bool enable = true);
    static bool isEnabled(const DecoderFactory* factory);

protected:
    void configure(quint32 srate, const ChannelMap &map, Qmmp::AudioFormat f = Qmmp::PCM_S16LE);
    void configure(quint32 srate, int channels, Qmmp::AudioFormat f = Qmmp::PCM_S16LE);
    void configure(const AudioParameters &p);

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

    AudioParameters m_parameters;
    QMap<Qmmp::TrackProperty, QString> m_properties;
    QIODevice *m_input = nullptr;
    bool m_hasMetaData = false;
    QMap<Qmmp::MetaData, QString> m_metaData;
    QMap<Qmmp::ReplayGainKey, double> m_rg; //replay gain information

};

#endif