Drumkit.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_DRUMKIT_H
#define H2C_DRUMKIT_H
 
#include <memory>
 
#include <core/Object.h>
#include <core/Helpers/Filesystem.h>
#include <core/License.h>
#include <core/Basics/InstrumentList.h>
 
namespace H2Core
{
 
class XMLDoc;
class XMLNode;
class DrumkitComponent;

class Drumkit : public H2Core::Object<Drumkit>
{
                H2_OBJECT(Drumkit)
        public:
                Drumkit();
                Drumkit( std::shared_ptr<Drumkit> other );
                ~Drumkit();

                static std::shared_ptr<Drumkit> load( const QString& dk_dir,
                                                                                          bool bUpgrade = true,
                                                                                          bool* pLegacyFormatEncountered = nullptr,
                                                                                          bool bSilent = false );
                void load_samples();
                void unload_samples();

        static License loadLicenseFrom( const QString& sDrumkitDir, bool bSilent = false );
        
        QString getFolderName() const;
        QString getExportName( const QString& sComponentName, bool bRecentVersion ) const;
                
                static void upgrade_drumkit( std::shared_ptr<Drumkit> pDrumkit,
                                                                         const QString& dk_path,
                                                                         bool bSilent = false );

                bool save( const QString& sDrumkitPath = "",
                                   int nComponentID = -1,
                                   bool bRecentVersion = true,
                                   bool bSilent = false );

        static bool install( const QString& sSourcePath,
                                                 const QString& sTargetPath = "",
                                                 QString* pInstalledPath = nullptr,
                                                 bool* pEncodingIssuesDetected = nullptr,
                                                 bool bSilent = false );

        bool exportTo( const QString& sTargetDir, const QString& sComponentName = "",
                                   bool bRecentVersion = true, bool* pUtf8Encoded = nullptr,
                                   bool bSilent = false );
                static bool remove( const QString& sDrumkitDir );

                void set_instruments( std::shared_ptr<InstrumentList> instruments );
                std::shared_ptr<InstrumentList> get_instruments() const;

                void set_path( const QString& path );
                const QString& get_path() const;
                void set_name( const QString& name );
                const QString& get_name() const;
                void set_author( const QString& author );
                const QString& get_author() const;
                void set_info( const QString& info );
                const QString& get_info() const;
                void set_license( const License& license );
                const License& get_license() const;
                void set_image( const QString& image );
                const QString& get_image() const;
                void set_image_license( const License& imageLicense );
                const License& get_image_license() const;
                const bool samples_loaded() const;
 
                std::shared_ptr<DrumkitComponent> getComponent( int nID ) const;
                int findUnusedComponentId() const;
 
                void addComponent( std::shared_ptr<DrumkitComponent> pComponent );
                void addInstrument( std::shared_ptr<Instrument> pInstrument );
 
        std::shared_ptr<std::vector<std::shared_ptr<DrumkitComponent>>> get_components();
        void set_components( std::shared_ptr<std::vector<std::shared_ptr<DrumkitComponent>>> components );

        void propagateLicense();
        std::vector<std::shared_ptr<InstrumentList::Content>> summarizeContent() const;
        
                QString toQString( const QString& sPrefix = "", bool bShort = true ) const override;
 
        private:
                QString __path;                                   
                QString __name;                                   
                QString __author;                               
                QString __info;                                   
                License __license;                              
                QString __image;                         
                License __imageLicense;                    
 
                bool __samples_loaded;                  
                std::shared_ptr<InstrumentList> __instruments;  
        std::shared_ptr<std::vector<std::shared_ptr<DrumkitComponent>>> __components;  

        bool save_image( const QString& dk_dir, bool bSilent = false ) const;
        bool save_samples( const QString& dk_dir, bool bSilent = false ) const;
                /*
                 * save the drumkit within the given XMLNode
                 * \param node the XMLNode to feed
                 * \param component_id to chose the component to save or -1 for all
                 * \param bRecentVersion Whether the drumkit format should be
                 * supported by Hydrogen 0.9.7 or higher (whether it should be
                 * composed of DrumkitComponents).
                 */
        void save_to( XMLNode* node, int component_id=-1, bool bRecentVersion = true, bool bSilent = false ) const;
        static std::shared_ptr<Drumkit> load_from(
                XMLNode* node,
                const QString& dk_path,
                bool* pLegacyFormatEncountered = nullptr,
                bool bSilent = false );

        static bool loadDoc( const QString& sDrumkitDir, XMLDoc* pDoc, bool bSilent = false );
 
};
 
// DEFINITIONS
 
inline std::shared_ptr<InstrumentList> Drumkit::get_instruments() const
{
        return __instruments;
}
 
inline void Drumkit::set_path( const QString& path )
{
        __path = path;
}
 
inline const QString& Drumkit::get_path() const
{
        return __path;
}
 
inline void Drumkit::set_name( const QString& name )
{
        __name = name;
}
 
inline const QString& Drumkit::get_name() const
{
        return __name;
}
 
inline void Drumkit::set_author( const QString& author )
{
        __author = author;
        __license.setCopyrightHolder( author );
        __imageLicense.setCopyrightHolder( author );
}
 
inline const QString& Drumkit::get_author() const
{
        return __author;
}
 
inline void Drumkit::set_info( const QString& info )
{
        __info = info;
}
 
inline const QString& Drumkit::get_info() const
{
        return __info;
}
 
inline void Drumkit::set_license( const License& license )
{
        __license = license;
}
 
inline const License& Drumkit::get_license() const
{
        return __license;
}
 
inline void Drumkit::set_image( const QString& image )
{
        __image = image;
}
 
inline const QString& Drumkit::get_image() const
{
        return __image;
}
 
inline void Drumkit::set_image_license( const License& imageLicense )
{
        __imageLicense = imageLicense;
}
 
inline const License& Drumkit::get_image_license() const
{
        return __imageLicense;
}
 
inline const bool Drumkit::samples_loaded() const
{
        return __samples_loaded;
}
 
inline std::shared_ptr<std::vector<std::shared_ptr<DrumkitComponent>>> Drumkit::get_components()
{
        return __components;
}
 
};
 
#endif // H2C_DRUMKIT_H
 
/* vim: set softtabstop=4 noexpandtab: */