summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/route_group.h
blob: 194aa84582a88c202ed33ad961c86fb92fd5285b (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
/*
    Copyright (C) 2000 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 __ardour_route_group_h__
#define __ardour_route_group_h__

#include <list>
#include <set>
#include <string>
#include <stdint.h>
#include <sigc++/signal.h>
#include "pbd/stateful.h"
#include "ardour/types.h"

namespace ARDOUR {

class Route;
class Track;
class AudioTrack;
class Session;

class RouteGroup : public PBD::Stateful, public sigc::trackable {
public:
	enum Flag {
		Relative = 0x1,
		Active = 0x2,
		Hidden = 0x4
	};

	enum Property {
		Gain = 0x1,
		Mute = 0x2,
		Solo = 0x4,
		RecEnable = 0x8,
		Select = 0x10,
		Edit = 0x20
	};

	RouteGroup (Session& s, const std::string &n, Flag f = Flag(0), Property p = Property(0));

	const std::string& name() { return _name; }
	void set_name (std::string str);

	bool is_active () const { return _flags & Active; }
	bool is_relative () const { return _flags & Relative; }
	bool is_hidden () const { return _flags & Hidden; }
	bool empty() const {return routes.empty();}

	gain_t get_max_factor(gain_t factor);
	gain_t get_min_factor(gain_t factor);

	int size() { return routes.size();}

	void set_active (bool yn, void *src);
	void set_relative (bool yn, void *src);
	void set_hidden (bool yn, void *src);

	bool property (Property p) const {
		return ((_properties & p) == p);
	}

	bool active_property (Property p) const {
		return is_active() && property (p);
	}

	void set_property (Property p, bool v) {
		_properties = (Property) (_properties & ~p);
		if (v) {
			_properties = (Property) (_properties | p);
		}
	}

	int add (Route *);

	int remove (Route *);

	void apply (void (Route::*func)(void *), void *src) {
		for (std::list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
			((*i)->*func)(src);
		}
	}

	template<class T> void apply (void (Route::*func)(T, void *), T val, void *src) {
		for (std::list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
			((*i)->*func)(val, src);
		}
	}

	template<class T> void foreach_route (T *obj, void (T::*func)(Route&)) {
		for (std::list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
			(obj->*func)(**i);
		}
	}

	/* to use these, #include "ardour/route_group_specialized.h" */

	template<class T> void apply (void (Track::*func)(T, void *), T val, void *src);

	/* fills at_set with all members of the group that are AudioTracks */

	void audio_track_group (std::set<AudioTrack*>& at_set);

	void clear () {
		routes.clear ();
		changed();
	}

	void make_subgroup ();
	void destroy_subgroup ();

	const std::list<Route*>& route_list() { return routes; }

	sigc::signal<void> changed;
	sigc::signal<void,void*> FlagsChanged;

	XMLNode& get_state ();

	int set_state (const XMLNode&);

private:
	Session& _session;
	std::list<Route *> routes;
	boost::shared_ptr<Route> subgroup_bus;
	std::string _name;
	Flag _flags;
	Property _properties;

	void remove_when_going_away (Route*);
};

} /* namespace */

#endif /* __ardour_route_group_h__ */