gtk2_ardour/port_group.h

   1 /*
   2     Copyright (C) 2002-2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef  __gtk_ardour_port_group_h__
  21 #define  __gtk_ardour_port_group_h__
  22
  23 #include <vector>
  24 #include <string>
  25 #include <set>
  26 #include <gtkmm/widget.h>
  27 #include <gtkmm/checkbutton.h>
  28 #include <boost/shared_ptr.hpp>
  29 #include "ardour/data_type.h"
  30 #include "ardour/types.h"
  31
  32 namespace ARDOUR {
  33         class Session;
  34         class Bundle;
  35         class Processor;
  36         class IO;
  37 }
  38
  39 class PortMatrix;
  40 class RouteBundle;
  41
  42 /** A list of bundles and ports, grouped by some aspect of their
  43  *  type e.g. busses, tracks, system.  Each group has 0 or more bundles
  44  *  and 0 or more ports, where the ports are not in the bundles.
  45  */
  46 class PortGroup : public sigc::trackable
  47 {
  48 public:
  49         PortGroup (std::string const & n);
  50
  51         void add_bundle (boost::shared_ptr<ARDOUR::Bundle>);
  52         void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
  53         boost::shared_ptr<ARDOUR::Bundle> only_bundle ();
  54         void clear ();
  55         uint32_t total_channels () const;
  56
  57         std::string name; ///< name for the group
  58
  59         ARDOUR::BundleList const & bundles () const {
  60                 return _bundles;
  61         }
  62
  63         bool visible () const {
  64                 return _visible;
  65         }
  66
  67         void set_visible (bool v) {
  68                 _visible = v;
  69                 Modified ();
  70         }
  71
  72         bool has_port (std::string const &) const;
  73
  74         sigc::signal<void> Modified;
  75         sigc::signal<void, ARDOUR::Bundle::Change> BundleChanged;
  76
  77 private:
  78         void bundle_changed (ARDOUR::Bundle::Change);
  79
  80         ARDOUR::BundleList _bundles;
  81
  82         typedef std::map<boost::shared_ptr<ARDOUR::Bundle>, sigc::connection> ConnectionList;
  83         ConnectionList _bundle_changed_connections;
  84
  85         bool _visible; ///< true if the group is visible in the UI
  86 };
  87
  88 /// A list of PortGroups
  89 class PortGroupList : public sigc::trackable
  90 {
  91   public:
  92         PortGroupList ();
  93
  94         typedef std::vector<boost::shared_ptr<PortGroup> > List;
  95
  96         void add_group (boost::shared_ptr<PortGroup>);
  97         void set_type (ARDOUR::DataType);
  98         void gather (ARDOUR::Session &, bool);
  99         ARDOUR::BundleList const & bundles () const;
 100         void clear ();
 101         void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
 102         uint32_t total_visible_channels () const;
 103         uint32_t size () const {
 104                 return _groups.size();
 105         }
 106
 107         void suspend_signals ();
 108         void resume_signals ();
 109
 110         List::const_iterator begin () const {
 111                 return _groups.begin();
 112         }
 113
 114         List::const_iterator end () const {
 115                 return _groups.end();
 116         }
 117
 118         sigc::signal<void> Changed;
 119
 120   private:
 121         bool port_has_prefix (std::string const &, std::string const &) const;
 122         std::string common_prefix (std::vector<std::string> const &) const;
 123         std::string common_prefix_before (std::vector<std::string> const &, std::string const &) const;
 124         void emit_changed ();
 125         boost::shared_ptr<ARDOUR::Bundle> make_bundle_from_ports (std::vector<std::string> const &, bool) const;
 126         void maybe_add_processor_to_bundle (boost::weak_ptr<ARDOUR::Processor>, boost::shared_ptr<RouteBundle>, bool, std::set<boost::shared_ptr<ARDOUR::IO> > &);
 127
 128         ARDOUR::DataType _type;
 129         mutable ARDOUR::BundleList _bundles;
 130         List _groups;
 131         std::vector<sigc::connection> _bundle_changed_connections;
 132         bool _signals_suspended;
 133         bool _pending_change;
 134 };
 135
 136
 137 class RouteBundle : public ARDOUR::Bundle
 138 {
 139 public:
 140         RouteBundle (boost::shared_ptr<ARDOUR::Bundle>);
 141
 142         void add_processor_bundle (boost::shared_ptr<ARDOUR::Bundle>);
 143
 144 private:
 145         void reread_component_bundles ();
 146
 147         boost::shared_ptr<ARDOUR::Bundle> _route;
 148         std::vector<boost::shared_ptr<ARDOUR::Bundle> > _processor;
 149 };
 150
 151 #endif /* __gtk_ardour_port_group_h__ */