slavable.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2017 Robin Gareus <robin@gareus.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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef __ardour_slavable_h__
#define __ardour_slavable_h__
 
#include <memory>
#include <set>
#include <string>
#include <stdint.h>
 
 
#include "pbd/signals.h"
 
#include "evoral/Parameter.h"
 
#include "ardour/types.h"
#include "ardour/libardour_visibility.h"
 
class XMLNode;
 
namespace ARDOUR {
 
class VCA;
class VCAManager;
class AutomationControl;
class SlavableAutomationControl;
 
class LIBARDOUR_API Slavable
{
public:
        Slavable ();
        virtual ~Slavable() {}
 
        XMLNode& get_state () const;
        int set_state (XMLNode const&, int);
 
        virtual void assign (std::shared_ptr<VCA>);
        void unassign (std::shared_ptr<VCA>);
 
        PBD::Signal2<void,std::shared_ptr<VCA>,bool> AssignmentChange;
 
        virtual std::shared_ptr<AutomationControl> automation_control (const Evoral::Parameter&) = 0;
 
        static std::string xml_node_name;
 
        /* signal sent VCAManager once assignment is possible */
        static PBD::Signal1<void,VCAManager*> Assign;
 
        std::vector<std::shared_ptr<VCA> > masters (VCAManager*) const;
 
        bool assigned_to (VCAManager*, std::shared_ptr<VCA>) const;
 
protected:
        virtual SlavableAutomationControlList slavables () const = 0;
 
private:
        bool assign_controls (std::shared_ptr<VCA>);
        void unassign_controls (std::shared_ptr<VCA>);
 
        bool assign_control (std::shared_ptr<VCA>, std::shared_ptr<SlavableAutomationControl>);
        void unassign_control (std::shared_ptr<VCA>, std::shared_ptr<SlavableAutomationControl>);
 
        mutable Glib::Threads::RWLock master_lock;
        std::set<uint32_t> _masters;
        PBD::ScopedConnection assign_connection;
        PBD::ScopedConnectionList unassign_connections;
 
        int do_assign (VCAManager* s);
        void weak_unassign (std::weak_ptr<VCA>);
};
 
} // namespace ARDOUR
 
#endif /* __ardour_slavable_h__ */