MidiAction.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 ACTION_H
#define ACTION_H
#include <core/Object.h>
#include <map>
#include <memory>
#include <string>
#include <cassert>

class Action : public H2Core::Object<Action> {
        H2_OBJECT(Action)
        public:
        static QString getNullActionType() {
                return "NOTHING";
        }
 
        Action( QString sType = getNullActionType() );
        Action( std::shared_ptr<Action> pOther );

        bool isNull() const;
 
                void setParameter1( QString text ){
                        m_sParameter1 = text;
                }
 
                void setParameter2( QString text ){
                        m_sParameter2 = text;
                }
 
                void setParameter3( QString text ){
                        m_sParameter3 = text;
                }
 
                void setValue( QString text ){
                        m_sValue = text;
                }
 
                QString getParameter1() const {
                        return m_sParameter1;
                }
 
                QString getParameter2() const {
                        return m_sParameter2;
                }
 
                QString getParameter3() const {
                        return m_sParameter3;
                }
 
                QString getValue() const {
                        return m_sValue;
                }
 
                QString getType() const {
                        return m_sType;
                }

        bool isEquivalentTo( std::shared_ptr<Action> pOther );
 
        friend bool operator ==(const Action& lhs, const Action& rhs ) {
                return ( lhs.m_sType == rhs.m_sType &&
                                 lhs.m_sParameter1 == rhs.m_sParameter1 &&
                                 lhs.m_sParameter2 == rhs.m_sParameter2 &&
                                 lhs.m_sParameter3 == rhs.m_sParameter3 &&
                                 lhs.m_sValue == rhs.m_sValue );
        }
        friend bool operator !=(const Action& lhs, const Action& rhs ) {
                return ( lhs.m_sType != rhs.m_sType ||
                                 lhs.m_sParameter1 != rhs.m_sParameter1 ||
                                 lhs.m_sParameter2 != rhs.m_sParameter2 ||
                                 lhs.m_sParameter3 != rhs.m_sParameter3 ||
                                 lhs.m_sValue != rhs.m_sValue );
        }
        friend bool operator ==(std::shared_ptr<Action> lhs, std::shared_ptr<Action> rhs ) {
                return ( lhs->m_sType == rhs->m_sType &&
                                 lhs->m_sParameter1 == rhs->m_sParameter1 &&
                                 lhs->m_sParameter2 == rhs->m_sParameter2 &&
                                 lhs->m_sParameter3 == rhs->m_sParameter3 &&
                                 lhs->m_sValue == rhs->m_sValue );
        }
        friend bool operator !=(std::shared_ptr<Action> lhs, std::shared_ptr<Action> rhs ) {
                return ( lhs->m_sType != rhs->m_sType ||
                                 lhs->m_sParameter1 != rhs->m_sParameter1 ||
                                 lhs->m_sParameter2 != rhs->m_sParameter2 ||
                                 lhs->m_sParameter3 != rhs->m_sParameter3 ||
                                 lhs->m_sValue != rhs->m_sValue );
        }

                QString toQString( const QString& sPrefix = "", bool bShort = true ) const override;
 
        private:
                QString m_sType;
                QString m_sParameter1;
                QString m_sParameter2;
                QString m_sParameter3;
                QString m_sValue;
};
 
namespace H2Core
{
        class Hydrogen;
}

class MidiActionManager : public H2Core::Object<MidiActionManager>
{
        H2_OBJECT(MidiActionManager)
        private:
                static MidiActionManager *__instance;

        QStringList m_actionList;
 
                typedef bool (MidiActionManager::*action_f)(std::shared_ptr<Action> , H2Core::Hydrogen * );
        std::map<QString, std::pair<action_f,int>> m_actionMap;
                bool play(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool play_stop_pause_toggle(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool stop(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool pause(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool record_ready(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool record_strobe_toggle(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool record_strobe(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool record_exit(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool mute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool unmute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool mute_toggle(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool strip_mute_toggle(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool strip_solo_toggle(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool next_bar(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool previous_bar(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool bpm_increase(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool bpm_decrease(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool bpm_cc_relative(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool bpm_fine_cc_relative(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool master_volume_relative(std::shared_ptr<Action> , H2Core::Hydrogen *);
                bool master_volume_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool strip_volume_relative(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool strip_volume_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool effect_level_relative(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool effect_level_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool select_next_pattern(std::shared_ptr<Action> , H2Core::Hydrogen * );
        bool select_only_next_pattern(std::shared_ptr<Action> , H2Core::Hydrogen * );
        bool select_only_next_pattern_cc_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool select_next_pattern_cc_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool select_next_pattern_relative(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool select_and_play_pattern(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool pan_relative(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool pan_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
        bool pan_absolute_sym(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool instrument_pitch(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool filter_cutoff_level_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool beatcounter(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool tap_tempo(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool playlist_song(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool playlist_next_song(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool playlist_previous_song(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool toggle_metronome(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool select_instrument(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool undo_action(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool redo_action(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool gain_level_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool pitch_level_absolute(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool clear_selected_instrument(std::shared_ptr<Action> , H2Core::Hydrogen * );
                bool clear_pattern(std::shared_ptr<Action> , H2Core::Hydrogen * );
 
                int m_nLastBpmChangeCCParameter;
 
        bool setSong( int nSongNumber, H2Core::Hydrogen* pHydrogen );
        bool nextPatternSelection( int nPatternNumber );
        bool onlyNextPatternSelection( int nPatternNumber );
 
        public:

        bool handleActions( std::vector<std::shared_ptr<Action>> actions );
                bool handleAction( std::shared_ptr<Action> action );
                static void create_instance();
                static MidiActionManager* get_instance() { assert(__instance); return __instance; }
 
                QStringList getActionList(){
                        return m_actionList;
                }

        int getParameterNumber( const QString& sActionType ) const;
 
                MidiActionManager();
                ~MidiActionManager();
};
#endif