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 <boost/shared_ptr.hpp>
  27 #include "pbd/signals.h"
  28
  29 #include <gtkmm/widget.h>
  30 #include <gtkmm/checkbutton.h>
  31
  32 #include "ardour/data_type.h"
  33 #include "ardour/types.h"
  34
  35 namespace ARDOUR {
  36         class Session;
  37         class Bundle;
  38         class Processor;
  39         class IO;
  40 }
  41
  42 class PortMatrix;
  43 class RouteBundle;
  44 class PublicEditor;
  45
  46 /** A list of bundles grouped by some aspect of their type e.g. busses, tracks, system.
  47  *  A group has 0 or more bundles.
  48  */
  49 class PortGroup : public sigc::trackable
  50 {
  51 public:
  52         PortGroup (std::string const & n);
  53         ~PortGroup ();
  54
  55         void add_bundle (boost::shared_ptr<ARDOUR::Bundle>, bool allow_dups = false);
  56         void add_bundle (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO> io);
  57         void add_bundle (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, Gdk::Color);
  58         void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
  59         boost::shared_ptr<ARDOUR::Bundle> only_bundle ();
  60         void clear ();
  61         uint32_t total_channels () const;
  62         boost::shared_ptr<ARDOUR::IO> io_from_bundle (boost::shared_ptr<ARDOUR::Bundle>) const;
  63         void remove_duplicates ();
  64
  65         std::string name; ///< name for the group
  66
  67         bool has_port (std::string const &) const;
  68
  69         /** The bundle list has changed in some way; a bundle has been added or removed, or the list cleared etc. */
  70         PBD::Signal0<void> Changed;
  71
  72         /** An individual bundle on our list has changed in some way */
  73         PBD::Signal1<void,ARDOUR::Bundle::Change> BundleChanged;
  74
  75         struct BundleRecord {
  76             boost::shared_ptr<ARDOUR::Bundle> bundle;
  77             /** IO whose ports are in the bundle, or 0.  This is so that we can do things like adding
  78                 ports to the IO from matrix editor menus. */
  79             boost::shared_ptr<ARDOUR::IO> io;
  80             Gdk::Color colour;
  81             bool has_colour;
  82             PBD::ScopedConnection changed_connection;
  83
  84             BundleRecord (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, Gdk::Color, bool has_colour);
  85         };
  86
  87         typedef std::list<BundleRecord*> BundleList;
  88
  89         BundleList const & bundles () const {
  90                 return _bundles;
  91         }
  92
  93 private:
  94         void bundle_changed (ARDOUR::Bundle::Change);
  95         void add_bundle_internal (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, bool, Gdk::Color, bool);
  96
  97         BundleList _bundles;
  98 };
  99
 100 /// A list of PortGroups
 101 class PortGroupList : public sigc::trackable
 102 {
 103   public:
 104         PortGroupList ();
 105         ~PortGroupList();
 106
 107         typedef std::vector<boost::shared_ptr<PortGroup> > List;
 108
 109         void add_group (boost::shared_ptr<PortGroup>);
 110         void add_group_if_not_empty (boost::shared_ptr<PortGroup>);
 111         void set_type (ARDOUR::DataType);
 112         void gather (ARDOUR::Session *, bool, bool);
 113         PortGroup::BundleList const & bundles () const;
 114         void clear ();
 115         void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
 116         uint32_t total_channels () const;
 117         uint32_t size () const {
 118                 return _groups.size();
 119         }
 120         boost::shared_ptr<ARDOUR::IO> io_from_bundle (boost::shared_ptr<ARDOUR::Bundle>) const;
 121
 122         void suspend_signals ();
 123         void resume_signals ();
 124
 125         List::const_iterator begin () const {
 126                 return _groups.begin ();
 127         }
 128
 129         List::const_iterator end () const {
 130                 return _groups.end ();
 131         }
 132
 133         bool empty () const;
 134
 135         /** The group list has changed in some way; a group has been added or removed, or the list cleared etc. */
 136         PBD::Signal0<void> Changed;
 137
 138         /** A bundle in one of our groups has changed */
 139         PBD::Signal1<void,ARDOUR::Bundle::Change> BundleChanged;
 140
 141   private:
 142         bool port_has_prefix (std::string const &, std::string const &) const;
 143         std::string common_prefix (std::vector<std::string> const &) const;
 144         std::string common_prefix_before (std::vector<std::string> const &, std::string const &) const;
 145         void emit_changed ();
 146         void emit_bundle_changed (ARDOUR::Bundle::Change);
 147         boost::shared_ptr<ARDOUR::Bundle> make_bundle_from_ports (std::vector<std::string> const &, bool) const;
 148         void maybe_add_processor_to_list (
 149                 boost::weak_ptr<ARDOUR::Processor>, std::list<boost::shared_ptr<ARDOUR::Bundle> > *, bool, std::set<boost::shared_ptr<ARDOUR::IO> > &
 150                 );
 151
 152         ARDOUR::DataType _type;
 153         mutable PortGroup::BundleList _bundles;
 154         List _groups;
 155         PBD::ScopedConnectionList _bundle_changed_connections;
 156         PBD::ScopedConnectionList _changed_connections;
 157         bool _signals_suspended;
 158         bool _pending_change;
 159         ARDOUR::Bundle::Change _pending_bundle_change;
 160 };
 161
 162 #endif /* __gtk_ardour_port_group_h__ */