Playlist.h

Go to the documentation of this file.

/*
 * Hydrogen
 * Copyright(c) 2002-2008 by Alex >Comix< Cominu [comix@users.sourceforge.net]
 * Copyright(c) 2008-2025 The hydrogen development team [hydrogen-devel@lists.sourceforge.net]
 *
 * http://www.hydrogen-music.org
 *
 * 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, see https://www.gnu.org/licenses
 *
 */
 
#ifndef H2C_PLAYLIST_H
#define H2C_PLAYLIST_H
 
#include <core/Object.h>
 
namespace H2Core
{

class Playlist : public H2Core::Object<Playlist>
 
{
                H2_OBJECT(Playlist)
 
        public:
                struct Entry
                {
                        QString filePath;
                        bool fileExists;
                        QString scriptPath;
                        bool scriptEnabled;
                };
                
                static void create_instance();
                static Playlist* get_instance() { assert(__instance); return __instance; }
 
                ~Playlist();
 
                void    activateSong (int SongNumber );
 
                int             size() const;
                Entry*  get( int idx );
 
                void    clear();
                void    add( Entry* entry );
 
                void    setNextSongByNumber( int SongNumber );
                int             getSelectedSongNr();
                void    setSelectedSongNr( int songNumber );
 
                int             getActiveSongNumber();
                void    setActiveSongNumber( int ActiveSongNumber );
                
                bool    getSongFilenameByNumber( int songNumber, QString& fileName);
 
                const QString& getFilename();
                void setFilename( const QString& filename );
                bool getIsModified();
                void setIsModified( bool IsModified );
 
                static Playlist* load( const QString& filename, bool useRelativePaths );
                static Playlist* load_file( const QString& pl_path, bool useRelativePaths );
                bool save_file( const QString& pl_path, const QString& name, bool overwrite, bool useRelativePaths );
                QString toQString( const QString& sPrefix = "", bool bShort = true ) const override;
 
        private:
                static Playlist* __instance;
                QString __filename;
 
                std::vector<Entry*> __entries;
 
                int m_nSelectedSongNumber;
                int m_nActiveSongNumber;
 
                bool m_bIsModified;
 
                Playlist();
 
                void execScript( int index );
 
                void save_to( XMLNode* node, bool useRelativePaths );
};
 
inline int Playlist::size() const
{
        return __entries.size();
}
 
inline Playlist::Entry* Playlist::get( int idx )
{
        assert( idx >= 0 && idx < size() );
        return __entries[ idx ];
}
 
inline void Playlist::add( Entry* entry )
{
        __entries.push_back( entry );
}
 
inline int Playlist::getSelectedSongNr()
{
        return m_nSelectedSongNumber;
}
 
inline void Playlist::setSelectedSongNr( int songNumber )
{
        m_nSelectedSongNumber = songNumber;
}
 
inline int Playlist::getActiveSongNumber()
{
        return m_nActiveSongNumber;
}
 
inline void Playlist::setActiveSongNumber( int ActiveSongNumber )
{
        m_nActiveSongNumber = ActiveSongNumber ;
}
 
inline const QString& Playlist::getFilename()
{
        return __filename;
}
 
inline void Playlist::setFilename( const QString& filename )
{
        __filename = filename;
}
 
inline bool Playlist::getIsModified()
{
        return m_bIsModified;
}
 
inline void Playlist::setIsModified( bool IsModified )
{
        m_bIsModified = IsModified;
}
 
};
 
#endif // H2C_PLAYLIST_H