CoreActionController.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 CORE_ACTION_CONTROLLER_H
#define CORE_ACTION_CONTROLLER_H
 
#include <vector>
#include <memory>
 
#include <core/Object.h>
#include <core/Basics/Song.h>
 
namespace H2Core
{
        class Drumkit;
        class Instrument;

class CoreActionController : public H2Core::Object<CoreActionController> {
        H2_OBJECT(CoreActionController)
        
        public:
                CoreActionController();
                ~CoreActionController();
        
                bool setMasterVolume( float masterVolumeValue );
                bool setStripVolume( int nStrip, float fVolumeValue, bool bSelectStrip );
                bool setStripPan( int nStrip, float fValue, bool bSelectStrip );
                bool setStripPanSym( int nStrip, float fValue, bool bSelectStrip );
                bool setInstrumentPitch( int nInstrument, float fValue );
                bool setMetronomeIsActive( bool isActive );
                bool setMasterIsMuted( bool isMuted );
                
                bool setStripIsMuted( int nStrip, bool isMuted );
                bool toggleStripIsMuted( int nStrip );
                
                bool setStripIsSoloed( int nStrip, bool isSoloed );
                bool toggleStripIsSoloed( int nStrip );
                
                bool initExternalControlInterfaces();
        
                // -----------------------------------------------------------
                // Actions required for session management.
                
                bool newSong( const QString& songPath );
        bool openSong( const QString& songPath, const QString& sRecoverSongPath = "" );
                bool openSong( std::shared_ptr<Song> pSong, bool bRelinking = true );
                bool saveSong();
                bool saveSongAs( const QString& sNewFilename );
                bool savePreferences();
                bool quit();
 
                // -----------------------------------------------------------
                // Further OSC commands

                bool activateTimeline( bool bActivate );
                bool addTempoMarker( int nPosition, float fBpm );
                bool deleteTempoMarker( int nPosition );
                bool addTag( int nPosition, const QString& sText );
                bool deleteTag( int nPosition );
                bool activateJackTransport( bool bActivate );
                bool activateJackTimebaseControl( bool bActivate );

                bool activateSongMode( bool bActivate );
                bool activateLoopMode( bool bActivate );
        bool setDrumkit( const QString& sDrumkit, bool bConditional = true );
        bool setDrumkit( std::shared_ptr<Drumkit> pDrumkit, bool bConditional = true );
        bool upgradeDrumkit( const QString& sDrumkitPath, const QString& sNewPath = "" );

        bool validateDrumkit( const QString& sDrumkitPath, bool bCheckLegacyVersions = false );
                bool extractDrumkit( const QString& sDrumkitPath,
                                                         const QString& sTargetDir = "",
                                                         QString* pInstalledPath = nullptr,
                                                         bool* pEncodingIssuesDetected = nullptr );
                bool locateToColumn( int nPatternGroup );
                bool locateToTick( long nTick, bool bWithJackBroadcast = true );

        bool newPattern( const QString& sPatternName );
        bool openPattern( const QString& sPath, int nPatternNumber = -1 );
                bool setPattern( Pattern* pPattern, int nPatternNumber );
        bool removePattern( int nPatternNumber );
                bool clearInstrumentInPattern( int nInstrumentNumber,
                                                                           int nPatternNumber = -1 );
        bool toggleGridCell( int nColumn, int nRow );

                bool handleNote( int nNote, float fVelocity, bool bNoteOff = false );

        void updatePreferences();
private:
        bool sendMasterVolumeFeedback();
        bool sendStripVolumeFeedback( int nStrip );
        bool sendMetronomeIsActiveFeedback();
        bool sendMasterIsMutedFeedback();
        bool sendStripIsMutedFeedback( int nStrip );
        bool sendStripIsSoloedFeedback( int nStrip );
        bool sendStripPanFeedback( int nStrip );
        bool sendStripPanSymFeedback( int nStrip );
        
        bool handleOutgoingControlChanges( std::vector<int> params, int nValue);
        std::shared_ptr<Instrument> getStrip( int nStrip ) const;
        
        // -----------------------------------------------------------
        // Actions required for session management.
                
                bool setSong( std::shared_ptr<Song> pSong, bool bRelinking = true );

        std::shared_ptr<Drumkit> retrieveDrumkit(
                const QString& sDrumkitPath,
                bool* bIsCompressed,
                QString* sDrumkitDir,
                QString* sTemporaryFolder,
                bool* pLegacyFormatEncountered );
        void insertRecentFile( const QString sFilename );
                
                const int m_nDefaultMidiFeedbackChannel;
};
 
}
#endif