2 Copyright (C) 2002-2009 Paul Davis
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.
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.
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.
20 #ifndef __gtk_ardour_port_group_h__
21 #define __gtk_ardour_port_group_h__
26 #include <boost/shared_ptr.hpp>
27 #include <boost/signals2.hpp>
29 #include <gtkmm/widget.h>
30 #include <gtkmm/checkbutton.h>
32 #include "ardour/data_type.h"
33 #include "ardour/types.h"
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.
49 class PortGroup : public sigc::trackable
52 PortGroup (std::string const & n);
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 ();
61 uint32_t total_channels () const;
62 boost::shared_ptr<ARDOUR::IO> io_from_bundle (boost::shared_ptr<ARDOUR::Bundle>) const;
64 std::string name; ///< name for the group
66 bool has_port (std::string const &) const;
68 /** The bundle list has changed in some way; a bundle has been added or removed, or the list cleared etc. */
69 sigc::signal<void> Changed;
71 /** An individual bundle on our list has changed in some way */
72 boost::signals2::signal<void(ARDOUR::Bundle::Change)> BundleChanged;
75 boost::shared_ptr<ARDOUR::Bundle> bundle;
76 /** IO whose ports are in the bundle, or 0. This is so that we can do things like adding
77 ports to the IO from matrix editor menus. */
78 boost::shared_ptr<ARDOUR::IO> io;
81 boost::signals2::scoped_connection changed_connection;
83 BundleRecord (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, Gdk::Color, bool has_colour);
86 typedef std::list<BundleRecord*> BundleList;
88 BundleList const & bundles () const {
93 void bundle_changed (ARDOUR::Bundle::Change);
94 void add_bundle_internal (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, bool, Gdk::Color, bool);
99 /// A list of PortGroups
100 class PortGroupList : public sigc::trackable
106 typedef std::vector<boost::shared_ptr<PortGroup> > List;
108 void add_group (boost::shared_ptr<PortGroup>);
109 void add_group_if_not_empty (boost::shared_ptr<PortGroup>);
110 void set_type (ARDOUR::DataType);
111 void gather (ARDOUR::Session *, bool, bool);
112 PortGroup::BundleList const & bundles () const;
114 void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
115 uint32_t total_channels () const;
116 uint32_t size () const {
117 return _groups.size();
119 boost::shared_ptr<ARDOUR::IO> io_from_bundle (boost::shared_ptr<ARDOUR::Bundle>) const;
121 void suspend_signals ();
122 void resume_signals ();
124 List::const_iterator begin () const {
125 return _groups.begin ();
128 List::const_iterator end () const {
129 return _groups.end ();
134 /** The group list has changed in some way; a group has been added or removed, or the list cleared etc. */
135 boost::signals2::signal<void()> Changed;
137 /** A bundle in one of our groups has changed */
138 boost::signals2::signal<void(ARDOUR::Bundle::Change)> BundleChanged;
141 bool port_has_prefix (std::string const &, std::string const &) const;
142 std::string common_prefix (std::vector<std::string> const &) const;
143 std::string common_prefix_before (std::vector<std::string> const &, std::string const &) const;
144 void emit_changed ();
145 void emit_bundle_changed (ARDOUR::Bundle::Change);
146 boost::shared_ptr<ARDOUR::Bundle> make_bundle_from_ports (std::vector<std::string> const &, bool) const;
147 void maybe_add_processor_to_list (
148 boost::weak_ptr<ARDOUR::Processor>, std::list<boost::shared_ptr<ARDOUR::Bundle> > *, bool, std::set<boost::shared_ptr<ARDOUR::IO> > &
151 ARDOUR::DataType _type;
152 mutable PortGroup::BundleList _bundles;
154 PBD::ScopedConnectionList _bundle_changed_connections;
155 bool _signals_suspended;
156 bool _pending_change;
157 ARDOUR::Bundle::Change _pending_bundle_change;
160 #endif /* __gtk_ardour_port_group_h__ */