Timeline.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 TIMELINE_H
#define TIMELINE_H
 
#include <memory>
 
#include <core/Object.h>
 
namespace H2Core
{

class Timeline : public H2Core::Object<Timeline>
{
        H2_OBJECT(Timeline)
 
public:
        Timeline();
        ~Timeline();

        struct TempoMarker
        {
                int             nColumn;         // beat position in timeline
                float   fBpm;               // tempo in beats per minute

                QString getPrettyString( int nDecimals = 2 ) const;
                QString toQString( const QString& sPrefix = "", bool bShort = true ) const;
        };

        struct Tag
        {
                int             nColumn;         // beat position in timeline
                QString sTag;               // tag
 
                QString toQString( const QString& sPrefix = "", bool bShort = true ) const;
        };

        void activate();
        void deactivate();
 
                void setDefaultBpm( float fDefaultBpm );

        void            addTempoMarker( int nColumn, float fBpm );
        void            deleteTempoMarker( int nColumn );
        void            deleteAllTempoMarkers();
        float           getTempoAtColumn( int nColumn ) const;
 
        bool hasColumnTempoMarker( int nColumn ) const;
        std::shared_ptr<const Timeline::TempoMarker> getTempoMarkerAtColumn( int nColumn ) const;
        const std::vector<std::shared_ptr<const TempoMarker>> getAllTempoMarkers() const;

        bool isFirstTempoMarkerSpecial() const;

        void            addTag( int nColumn, QString sTag );
        void            deleteTag( int nColumn );
        void            deleteAllTags();
 
        const QString getTagAtColumn( int nColumn ) const;
        const std::vector<std::shared_ptr<const Tag>> getAllTags() const;
        bool hasColumnTag( int nColumn ) const;
        
        QString toQString( const QString& sPrefix = "", bool bShort = true ) const override;
private:
        void            sortTempoMarkers();
        void            sortTags();
 
        std::vector<std::shared_ptr<const TempoMarker>> m_tempoMarkers;
        std::vector<std::shared_ptr<const Tag>> m_tags;

        float m_fDefaultBpm;
        
        struct TempoMarkerComparator
        {
                bool operator()( const std::shared_ptr<const TempoMarker> lhs, const std::shared_ptr<const TempoMarker> rhs)
                {
                        return lhs->nColumn < rhs->nColumn;
                }
        };
        struct TagComparator
        {
                bool operator()( const std::shared_ptr<const Tag> lhs, const std::shared_ptr<const Tag> rhs)
                {
                        return lhs->nColumn < rhs->nColumn;
                }
        };
};
        
inline void Timeline::deleteAllTempoMarkers() {
                m_tempoMarkers.clear();
}
inline void Timeline::deleteAllTags() {
        m_tags.clear();
}
inline const std::vector<std::shared_ptr<const Timeline::Tag>> Timeline::getAllTags() const {
        return m_tags;
}
};
#endif // TIMELINE_H