ardour/ardour/control_group.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016-2017 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 <map>
#include <memory>
#include <vector>
 
#include "pbd/controllable.h"
#include "pbd/rwlock.h"
 
#include "evoral/Parameter.h"
 
#include "ardour/automation_control.h"
#include "ardour/types.h"
 
namespace ARDOUR {
 
class CoreSelection;
class RouteGroup;
class Stripable;
 
class LIBARDOUR_API ControlGroup : public std::enable_shared_from_this<ControlGroup>
{
  public:
        ControlGroup (Evoral::Parameter p);
        virtual ~ControlGroup ();
 
        enum Mode {
                Relative = 0x1,
                Inverted = 0x2,
        };
 
        void fill_from_stripable_list (StripableList&, Evoral::Parameter const &);
 
        int add_control (std::shared_ptr<AutomationControl>, bool push = false);
        int remove_control (std::shared_ptr<AutomationControl>, bool pop = false);
 
        void pop_all ();
 
        AutomationControlList controls () const;
 
        void clear (bool pop = false);
 
        void set_active (bool);
        bool active() const { return _active; }
 
        void set_mode (Mode m);
        Mode mode () const { return _mode; }
 
        Evoral::Parameter parameter() const { return _parameter; }
 
        virtual void set_group_value (std::shared_ptr<AutomationControl>, double val);
        virtual void pre_realtime_queue_stuff (double val);
 
        bool use_me (PBD::Controllable::GroupControlDisposition gcd) const {
                switch (gcd) {
                case PBD::Controllable::ForGroup:
                        return false;
                case PBD::Controllable::NoGroup:
                        return false;
                case PBD::Controllable::InverseGroup:
                        return !_active;
                default:
                        return _active;
                }
        }
 
        typedef std::map<PBD::ID,std::shared_ptr<AutomationControl> > ControlMap;
        ControlMap::size_type size() const { PBD::RWLock::ReaderLock lm (controls_lock); return _controls.size(); }
 
  protected:
        Evoral::Parameter _parameter;
        mutable PBD::RWLock controls_lock;
        ControlMap _controls;
        bool _active;
        Mode _mode;
        PBD::ScopedConnectionList member_connections;
        bool propagating;
 
        void control_going_away (std::weak_ptr<AutomationControl>);
};
 
 
class LIBARDOUR_API GainControlGroup : public ControlGroup
{
  public:
        GainControlGroup (ARDOUR::AutomationType = GainAutomation);
 
        void set_group_value (std::shared_ptr<AutomationControl>, double val);
 
  private:
        gain_t get_max_factor (gain_t);
        gain_t get_min_factor (gain_t);
};
 
} /* namespace */