qmmp.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2008-2025 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 QMMP_H
#define QMMP_H

#include <QString>
#include "qmmp_export.h"

#define QMMP_VERSION_MAJOR 1
#define QMMP_VERSION_MINOR 7
#define QMMP_VERSION_PATCH 3

#define QMMP_VERSION_INT (QMMP_VERSION_MAJOR<<16 | QMMP_VERSION_MINOR<<8 | QMMP_VERSION_PATCH)

#ifdef Q_OS_WIN
#  define QStringToFileName(s) TagLib::FileName(reinterpret_cast<const wchar_t *>(s.utf16()))
#else
#  define QStringToFileName(s) s.toLocal8Bit().constData()
#endif

#ifndef qPrintable
#  define qPrintable(s) QString(s).toLocal8Bit().constData()
#endif

#ifndef qUtf8Printable
#  define qUtf8Printable(s) QString(s).toUtf8().constData()
#endif

#ifndef QmmpPrintable
#  define QmmpPrintable(s) Qmmp::generatePrintable(s).constData()
#endif

#define CSTR_TO_QSTR(codec, str, utf) codec->toUnicode(str.toCString(utf)).trimmed()

#ifndef TTK_LIBRARY
#if QT_VERSION < QT_VERSION_CHECK(5,7,0)
// this adds const to non-const objects (like std::as_const)
template <typename T>
Q_DECL_CONSTEXPR typename std::add_const<T>::type &qAsConst(T &t) noexcept { return t; }
// prevent rvalue arguments:
template <typename T>
void qAsConst(const T &&) = delete;
#elif QT_VERSION >= QT_VERSION_CHECK(6,6,0)
#  define qAsConst std::as_const
#endif

#if QT_VERSION < QT_VERSION_CHECK(5,10,0)
using qsizetype = QIntegerForSizeof<std::size_t>::Signed;
#endif
#endif

class QMMP_EXPORT Qmmp
{
public:
    enum State
    {
        Playing = 0, 
        Paused,      
        Stopped,     
        Buffering,   
        NormalError, 
        FatalError   
    };
    enum MetaData
    {
        UNKNOWN = -1,
        TITLE = 0,  
        ARTIST,     
        ALBUMARTIST,
        ALBUM,      
        COMMENT,    
        GENRE,      
        COMPOSER,   
        YEAR,       
        TRACK,      
        DISCNUMBER  
    };
    enum TrackProperty
    {
        UNKNOWN_PROPERTY = -1,
        BITRATE = 0,
        SAMPLERATE,
        CHANNELS,
        BITS_PER_SAMPLE,
        FORMAT_NAME,
        DECODER,
        FILE_SIZE
    };
    enum ReplayGainKey
    {
        REPLAYGAIN_TRACK_GAIN = 0, 
        REPLAYGAIN_TRACK_PEAK,     
        REPLAYGAIN_ALBUM_GAIN,     
        REPLAYGAIN_ALBUM_PEAK      
    };
    enum AudioFormat
    {
        PCM_UNKNOWN = -1, 
        PCM_S8 = 0, 
        PCM_U8,     
        PCM_S16LE,  
        PCM_S16BE,  
        PCM_U16LE,  
        PCM_U16BE,  
        PCM_S24LE,  
        PCM_S24BE,  
        PCM_U24LE,  
        PCM_U24BE,  
        PCM_S32LE,  
        PCM_S32BE,  
        PCM_U32LE,  
        PCM_U32BE,  
        PCM_FLOAT   
    };

    enum ChannelPosition
    {
        CHAN_NULL         = 0x00,   
        CHAN_FRONT_LEFT   = 0x01,   
        CHAN_FRONT_RIGHT  = 0x02,   
        CHAN_REAR_LEFT    = 0x04,   
        CHAN_REAR_RIGHT   = 0x08,   
        CHAN_FRONT_CENTER = 0x10,   
        CHAN_REAR_CENTER  = 0x20,   
        CHAN_SIDE_LEFT    = 0x40,   
        CHAN_SIDE_RIGHT   = 0x80,   
        CHAN_LFE          = 0x100,  
    };

    static QString configFile();
    static QString configDir();
    static QString cacheDir();
    static QString strVersion();
    static QString pluginPath();
    static QStringList findPlugins(const QString &prefix);
    static QString ttkPluginPath();
    static QByteArray generatePrintable(const QString &text);
};

#endif