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