scale_provider.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Paul Davis <paul@linuxaudiosystems.com>
 *
 * 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include "pbd/properties.h"
 
#include "ardour/libardour_visibility.h"
 
namespace Temporal {
        class timepos_t;
}
 
namespace ARDOUR {
        namespace Properties {
                LIBARDOUR_API extern PBD::PropertyDescriptor<bool> musical_mode; /* type is irrelevant */
                LIBARDOUR_API extern PBD::PropertyDescriptor<KeyEnforcementPolicy> key_enforcement;
        }
 
class MusicalKey;
 
class LIBARDOUR_API ScaleProvider : public virtual PBD::Stateful {
   public:
        ScaleProvider (ScaleProvider* parent);
        virtual ~ScaleProvider ();
 
        ScaleProvider* parent() const  { return _parent; }
        virtual MusicalKey const * key() const;
        virtual MusicalKey const * key_at (Temporal::timepos_t const &) const {
                /* by default, ignore time since there's only 1 answer */
                return key();
        }
        void set_key (MusicalKey const *);
 
        static void make_property_quarks ();
 
        XMLNode& get_state () const;
        int set_state (const XMLNode&, int version);
 
        void parent_prop_change (PBD::PropertyChange const &);
 
        virtual void set_key_enforcement_policy (KeyEnforcementPolicy kep);
        KeyEnforcementPolicy key_enforcement_policy() const;
 
        ScaleProvider const * scale_provider_origin() const;
        bool own_scale() const { return scale_provider_origin() == this; }
 
  private:
        ScaleProvider* _parent;
        MusicalKey const * _key;
        KeyEnforcementPolicy _key_enforcement_policy;
        PBD::ScopedConnection parent_connection;
};
 
} // namespace