InstrumentList.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_INSTRUMENT_LIST_H
#define H2C_INSTRUMENT_LIST_H
 
#include <vector>
#include <memory>
#include <core/License.h>
#include <core/Object.h>
 
namespace H2Core
{
 
class XMLNode;
class Instrument;
class DrumkitComponent;

class InstrumentList : public H2Core::Object<InstrumentList>
{
                H2_OBJECT(InstrumentList)
        public:
 
                struct Content {
                        QString m_sInstrumentName;
                        QString m_sComponentName;
                        QString m_sSampleName;
                        QString m_sFullSamplePath;
                        License m_license;
 
                        Content( const QString& sInstrumentName,
                                         const QString& sComponentName,
                                         const QString& sSampleName,
                                         const QString& sFullSamplePath,
                                         const License& license ) :
                                m_sInstrumentName( sInstrumentName ),
                                m_sComponentName( sComponentName ),
                                m_sSampleName( sSampleName ),
                                m_sFullSamplePath( sFullSamplePath ),
                                m_license( license ) {
                        };
                        
                        QString toQString( const QString& sPrefix = "", bool bShort = true ) const;
                };
                
                InstrumentList();
                ~InstrumentList();
                InstrumentList( std::shared_ptr<InstrumentList> other );

                int size() const;
                void operator<<( std::shared_ptr<Instrument> instrument );
                std::shared_ptr<Instrument> operator[]( int idx );
        bool operator==( std::shared_ptr<InstrumentList> pOther ) const;
        bool operator!=( std::shared_ptr<InstrumentList> pOther ) const;
                void add( std::shared_ptr<Instrument> instrument );
                void insert( int idx, std::shared_ptr<Instrument> instrument );
                
                bool is_valid_index( int idx ) const;
                std::shared_ptr<Instrument> get( int idx ) const;
                std::shared_ptr<Instrument> del( int idx );
                std::shared_ptr<Instrument> del( std::shared_ptr<Instrument> instrument );
                int index( std::shared_ptr<Instrument> instrument );
                std::shared_ptr<Instrument> find( const int i );
                std::shared_ptr<Instrument> find( const QString& name );
                std::shared_ptr<Instrument> findMidiNote( const int note );
                void swap( int idx_a, int idx_b );
                void move( int idx_a, int idx_b );

                void load_samples( float fBpm = 120 );
                void unload_samples();
        void save_to( XMLNode* node, int component_id, bool bRecentVersion = true, bool bFull = false );
        static std::shared_ptr<InstrumentList> load_from(
                XMLNode* node,
                const QString& sDrumkitPath,
                const QString& sDrumkitName,
                const License& license = License(),
                bool* pLegacyFormatEncountered = nullptr,
                bool bSilent = false );
        std::vector<std::shared_ptr<Content>> summarizeContent( const std::shared_ptr<std::vector<std::shared_ptr<DrumkitComponent>>> pDrumkitComponents ) const;

                void fix_issue_307();

                bool has_all_midi_notes_same() const;

                void set_default_midi_out_notes();
                QString toQString( const QString& sPrefix = "", bool bShort = true ) const override;

        std::vector<std::shared_ptr<Instrument>>::iterator begin();
        std::vector<std::shared_ptr<Instrument>>::iterator end();

                bool isAnyInstrumentSoloed();
 
        private:
                std::vector<std::shared_ptr<Instrument>> __instruments;            
};
 
// DEFINITIONS
 
inline int InstrumentList::size() const
{
        return __instruments.size();
}
 
};
 
#endif // H2C_INSTRUMENT_LIST_H
 
/* vim: set softtabstop=4 noexpandtab: */