summaryrefslogtreecommitdiff
path: root/gtk2_ardour/port_group.h
blob: d631f8ac0515d9ea180f1236a5f2f02b831e7509 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/*
    Copyright (C) 2002-2009 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef  __gtk_ardour_port_group_h__
#define  __gtk_ardour_port_group_h__

#include <vector>
#include <string>
#include <set>
#include <boost/shared_ptr.hpp>
#include "pbd/signals.h"

#include <gtkmm/widget.h>
#include <gtkmm/checkbutton.h>

#include "ardour/data_type.h"
#include "ardour/types.h"

namespace ARDOUR {
	class Session;
	class Bundle;
	class Processor;
	class IO;
}

class PortMatrix;
class PublicEditor;

/** A list of bundles grouped by some aspect of their type e.g. busses, tracks, system.
 *  A group has 0 or more bundles.
 */
class PortGroup : public sigc::trackable
{
public:
	PortGroup (std::string const & n);
	~PortGroup ();

	void add_bundle (boost::shared_ptr<ARDOUR::Bundle>, bool allow_dups = false);
	void add_bundle (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO> io);
	void add_bundle (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, Gdk::Color);
	void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
	boost::shared_ptr<ARDOUR::Bundle> only_bundle ();
	void clear ();
	ARDOUR::ChanCount total_channels () const;
	boost::shared_ptr<ARDOUR::IO> io_from_bundle (boost::shared_ptr<ARDOUR::Bundle>) const;
	void remove_duplicates ();

	std::string name; ///< name for the group

	bool has_port (std::string const &) const;

	/** The bundle list has changed in some way; a bundle has been added or removed, or the list cleared etc. */
	PBD::Signal0<void> Changed;

	/** An individual bundle on our list has changed in some way */
	PBD::Signal1<void,ARDOUR::Bundle::Change> BundleChanged;

	struct BundleRecord {
	    boost::shared_ptr<ARDOUR::Bundle> bundle;
	    /** IO whose ports are in the bundle, or 0.  This is so that we can do things like adding
		ports to the IO from matrix editor menus. */
	    boost::weak_ptr<ARDOUR::IO> io;
	    Gdk::Color colour;
	    bool has_colour;
	    PBD::ScopedConnection changed_connection;

	    BundleRecord (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, Gdk::Color, bool has_colour);
	};

	typedef std::list<BundleRecord*> BundleList;

	BundleList const & bundles () const {
		return _bundles;
	}

private:
	void bundle_changed (ARDOUR::Bundle::Change);
	void add_bundle_internal (boost::shared_ptr<ARDOUR::Bundle>, boost::shared_ptr<ARDOUR::IO>, bool, Gdk::Color, bool);

	BundleList _bundles;
};

/// A list of PortGroups
class PortGroupList : public sigc::trackable
{
  public:
	PortGroupList ();
	~PortGroupList();

	typedef std::vector<boost::shared_ptr<PortGroup> > List;

	void add_group (boost::shared_ptr<PortGroup>);
	void add_group_if_not_empty (boost::shared_ptr<PortGroup>);
	void gather (ARDOUR::Session *, ARDOUR::DataType, bool, bool, bool);
	PortGroup::BundleList const & bundles () const;
	void clear ();
	void remove_bundle (boost::shared_ptr<ARDOUR::Bundle>);
	ARDOUR::ChanCount total_channels () const;
	uint32_t size () const {
		return _groups.size();
	}
	boost::shared_ptr<ARDOUR::IO> io_from_bundle (boost::shared_ptr<ARDOUR::Bundle>) const;

	void suspend_signals ();
	void resume_signals ();

	List::const_iterator begin () const {
		return _groups.begin ();
	}

	List::const_iterator end () const {
		return _groups.end ();
	}

	bool empty () const;

	/** The group list has changed in some way; a group has been added or removed, or the list cleared etc. */
	PBD::Signal0<void> Changed;

	/** A bundle in one of our groups has changed */
	PBD::Signal1<void,ARDOUR::Bundle::Change> BundleChanged;

  private:
	bool port_has_prefix (std::string const &, std::string const &) const;
	std::string common_prefix (std::vector<std::string> const &) const;
	std::string common_prefix_before (std::vector<std::string> const &, std::string const &) const;
	void emit_changed ();
	void emit_bundle_changed (ARDOUR::Bundle::Change);
	boost::shared_ptr<ARDOUR::Bundle> make_bundle_from_ports (std::vector<std::string> const &, ARDOUR::DataType, bool, std::string const& bundle_name = std::string()) const;
	void maybe_add_processor_to_list (
		boost::weak_ptr<ARDOUR::Processor>, std::list<boost::shared_ptr<ARDOUR::IO> > *, bool, std::set<boost::shared_ptr<ARDOUR::IO> > &
		);

	mutable PortGroup::BundleList _bundles;
	List _groups;
	PBD::ScopedConnectionList _bundle_changed_connections;
	PBD::ScopedConnectionList _changed_connections;
	bool _signals_suspended;
	bool _pending_change;
	ARDOUR::Bundle::Change _pending_bundle_change;
};

#endif /* __gtk_ardour_port_group_h__ */