moved 2.1-staging to trunk @ rev 1765
[ardour.git] / gtk2_ardour / route_ui.h
1 /*
2     Copyright (C) 2002 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 __ardour_route_ui__
21 #define __ardour_route_ui__
22
23 #include <list>
24
25 #include <pbd/xml++.h>
26 #include <ardour/ardour.h>
27 #include <ardour/route.h>
28 #include <ardour/track.h>
29
30 #include "axis_view.h"
31
32 namespace ARDOUR {
33         class AudioTrack;
34 }
35
36 namespace Gtk {
37         class Menu;
38         class CheckMenuItem;
39         class Widget;
40 }
41
42 class BindableToggleButton;
43
44 class RouteUI : public virtual AxisView
45 {
46   public:
47         RouteUI(boost::shared_ptr<ARDOUR::Route>, ARDOUR::Session&, const char*, const char*, const char*);
48         virtual ~RouteUI();
49
50         bool is_track() const;
51         bool is_audio_track() const;
52
53         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
54         
55         // FIXME: make these return shared_ptr
56         ARDOUR::Track*      track() const;
57         ARDOUR::AudioTrack* audio_track() const;
58         
59         boost::shared_ptr<ARDOUR::Diskstream> get_diskstream() const;
60
61         string name() const;
62
63         // protected: XXX sigh this should be here
64
65         boost::shared_ptr<ARDOUR::Route> _route;
66         
67         void set_color (const Gdk::Color & c);
68         bool choose_color ();
69
70         bool ignore_toggle;
71         bool wait_for_release;
72
73         BindableToggleButton* mute_button;
74         BindableToggleButton* solo_button;
75         BindableToggleButton* rec_enable_button;
76         
77         virtual string solo_button_name () const { return "SoloButton"; }
78         virtual string safe_solo_button_name () const { return "SafeSoloButton"; }
79         
80         Gtk::Menu* mute_menu;
81         Gtk::Menu* solo_menu;
82         Gtk::Menu* remote_control_menu;
83
84         XMLNode *xml_node;
85         void ensure_xml_node ();
86
87         XMLNode* get_child_xml_node (const string & childname);
88         
89         bool mute_press(GdkEventButton*);
90         bool mute_release(GdkEventButton*);
91         bool solo_press(GdkEventButton*);
92         bool solo_release(GdkEventButton*);
93         bool rec_enable_press(GdkEventButton*);
94         bool rec_enable_release(GdkEventButton*);
95
96         void solo_changed(void*);
97         void solo_changed_so_update_mute ();
98         void mute_changed(void*);
99         virtual void redirects_changed (void *) {}
100         void route_rec_enable_changed();
101         void session_rec_enable_changed();
102
103         void build_solo_menu (void);
104         void build_remote_control_menu (void);
105         void refresh_remote_control_menu ();
106
107         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
108         void toggle_solo_safe (Gtk::CheckMenuItem*);
109
110         void toggle_mute_menu(ARDOUR::mute_type, Gtk::CheckMenuItem*);
111         void pre_fader_toggle(void*, Gtk::CheckMenuItem*);
112         void post_fader_toggle(void*, Gtk::CheckMenuItem*);
113         void control_outs_toggle(void*, Gtk::CheckMenuItem*);
114         void main_outs_toggle(void*, Gtk::CheckMenuItem*);
115
116         void build_mute_menu(void);
117         void init_mute_menu(ARDOUR::mute_type, Gtk::CheckMenuItem*);
118         
119         void set_mix_group_solo(boost::shared_ptr<ARDOUR::Route>, bool);
120         void set_mix_group_mute(boost::shared_ptr<ARDOUR::Route>, bool);
121         void set_mix_group_rec_enable(boost::shared_ptr<ARDOUR::Route>, bool);
122
123         int  set_color_from_route ();
124
125         sigc::connection blink_connection;
126
127         void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
128         
129         void remove_this_route ();
130         static gint idle_remove_this_route (RouteUI *);
131
132         void route_rename();
133         
134         virtual void name_changed (void *src);
135         void route_removed ();
136
137         Gtk::CheckMenuItem *route_active_menu_item;
138         void toggle_route_active ();
139         virtual void route_active_changed ();
140
141         Gtk::CheckMenuItem *polarity_menu_item;
142         void toggle_polarity ();
143         virtual void polarity_changed ();
144
145         void disconnect_input ();
146         void disconnect_output ();
147
148         virtual void update_rec_display ();
149         void update_mute_display ();
150
151         bool was_solo_safe;
152         void update_solo_display ();
153
154         virtual void map_frozen ();
155
156         void set_remote_control_id (uint32_t id, Gtk::CheckMenuItem* item);
157
158         void reversibly_apply_route_boolean (string name, void (ARDOUR::Route::*func)(bool, void*), bool, void *);
159         void reversibly_apply_audio_track_boolean (string name, void (ARDOUR::AudioTrack::*func)(bool, void*), bool, void *);
160 };
161
162 #endif /* __ardour_route_ui__ */