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 <gtkmm/widget.h>
  26 #include <gtkmm/checkbutton.h>
  27 #include <boost/shared_ptr.hpp>
  28 #include <ardour/data_type.h>
  29 #include <ardour/types.h>
  30
  31 namespace ARDOUR {
  32         class Session;
  33         class Bundle;
  34 }
  35
  36 class PortMatrix;
  37
  38 /** A list of bundles and ports, grouped by some aspect of their
  39  *  type e.g. busses, tracks, system.  Each group has 0 or more bundles
  40  *  and 0 or more ports, where the ports are not in the bundles.
  41  */
  42 class PortGroup : public sigc::trackable
  43 {
  44 public:
  45         PortGroup (std::string const & n);
  46
  47         void add_bundle (boost::shared_ptr<ARDOUR::Bundle>);
  48         void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
  49         boost::shared_ptr<ARDOUR::Bundle> only_bundle ();
  50         void clear ();
  51         uint32_t total_channels () const;
  52
  53         std::string name; ///< name for the group
  54
  55         ARDOUR::BundleList const & bundles () const {
  56                 return _bundles;
  57         }
  58
  59         bool visible () const {
  60                 return _visible;
  61         }
  62
  63         void set_visible (bool v) {
  64                 _visible = v;
  65                 Modified ();
  66         }
  67
  68         bool has_port (std::string const &) const;
  69
  70         sigc::signal<void> Modified;
  71         sigc::signal<void, ARDOUR::Bundle::Change> BundleChanged;
  72
  73 private:
  74         void bundle_changed (ARDOUR::Bundle::Change);
  75
  76         ARDOUR::BundleList _bundles;
  77
  78         typedef std::map<boost::shared_ptr<ARDOUR::Bundle>, sigc::connection> ConnectionList;
  79         ConnectionList _bundle_changed_connections;
  80
  81         bool _visible; ///< true if the group is visible in the UI
  82 };
  83
  84 /// A list of PortGroups
  85 class PortGroupList : public sigc::trackable
  86 {
  87   public:
  88         PortGroupList ();
  89
  90         typedef std::vector<boost::shared_ptr<PortGroup> > List;
  91
  92         void add_group (boost::shared_ptr<PortGroup>);
  93         void set_type (ARDOUR::DataType);
  94         void gather (ARDOUR::Session &, bool);
  95         ARDOUR::BundleList const & bundles () const;
  96         void clear ();
  97         void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
  98         uint32_t total_visible_channels () const;
  99         uint32_t size () const {
 100                 return _groups.size();
 101         }
 102
 103         void suspend_signals ();
 104         void resume_signals ();
 105
 106         List::const_iterator begin () const {
 107                 return _groups.begin();
 108         }
 109
 110         List::const_iterator end () const {
 111                 return _groups.end();
 112         }
 113
 114         sigc::signal<void> Changed;
 115
 116   private:
 117         bool port_has_prefix (std::string const &, std::string const &) const;
 118         std::string common_prefix (std::vector<std::string> const &) const;
 119         std::string common_prefix_before (std::vector<std::string> const &, std::string const &) const;
 120         void emit_changed ();
 121         boost::shared_ptr<ARDOUR::Bundle> make_bundle_from_ports (std::vector<std::string> const &, bool) const;
 122
 123         ARDOUR::DataType _type;
 124         mutable ARDOUR::BundleList _bundles;
 125         List _groups;
 126         std::vector<sigc::connection> _bundle_changed_connections;
 127         bool _signals_suspended;
 128         bool _pending_change;
 129 };
 130
 131
 132 class RouteBundle : public ARDOUR::Bundle
 133 {
 134 public:
 135         RouteBundle (boost::shared_ptr<ARDOUR::Bundle>);
 136
 137         void add_processor_bundle (boost::shared_ptr<ARDOUR::Bundle>);
 138
 139 private:
 140         void reread_component_bundles ();
 141
 142         boost::shared_ptr<ARDOUR::Bundle> _route;
 143         std::vector<boost::shared_ptr<ARDOUR::Bundle> > _processor;
 144 };
 145
 146 #endif /* __gtk_ardour_port_group_h__ */