Prepare VCA Automation Lanes -- refactor TAV
[ardour.git] / gtk2_ardour / route_time_axis.h
1 /*
2     Copyright (C) 2006 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_time_axis_h__
21 #define __ardour_route_time_axis_h__
22
23 #include <list>
24 #include <set>
25
26 #include <gtkmm/table.h>
27 #include <gtkmm/button.h>
28 #include <gtkmm/box.h>
29 #include <gtkmm/menu.h>
30 #include <gtkmm/menuitem.h>
31 #include <gtkmm/radiomenuitem.h>
32 #include <gtkmm/checkmenuitem.h>
33 #include <gtkmm/adjustment.h>
34
35 #include <gtkmm2ext/selector.h>
36 #include <gtkmm2ext/slider_controller.h>
37
38 #include "ardour/playlist.h"
39 #include "ardour/types.h"
40
41 #include "ardour_button.h"
42 #include "ardour_dialog.h"
43 #include "route_ui.h"
44 #include "enums.h"
45 #include "stripable_time_axis.h"
46 #include "gain_meter.h"
47
48 namespace ARDOUR {
49         class Session;
50         class Region;
51         class RouteGroup;
52         class IOProcessor;
53         class Processor;
54         class Location;
55         class Playlist;
56 }
57
58 namespace ArdourCanvas {
59         class Rectangle;
60 }
61
62 class PublicEditor;
63 class RegionView;
64 class StreamView;
65 class Selection;
66 class RegionSelection;
67 class Selectable;
68 class AutomationTimeAxisView;
69 class AutomationLine;
70 class ProcessorAutomationLine;
71 class TimeSelection;
72 class RouteGroupMenu;
73 class ItemCounts;
74
75 class RouteTimeAxisView : public RouteUI, public StripableTimeAxisView
76 {
77 public:
78         RouteTimeAxisView (PublicEditor&, ARDOUR::Session*, ArdourCanvas::Canvas& canvas);
79         virtual ~RouteTimeAxisView ();
80
81         std::string name()  const;
82         Gdk::Color color () const;
83         bool marked_for_display () const;
84         bool set_marked_for_display (bool);
85
86         boost::shared_ptr<ARDOUR::Stripable> stripable() const { return RouteUI::stripable(); }
87
88         void set_route (boost::shared_ptr<ARDOUR::Route>);
89
90         void show_selection (TimeSelection&);
91         void set_button_names ();
92
93         void set_samples_per_pixel (double);
94         void set_height (uint32_t h, TrackHeightMode m = OnlySelf);
95         void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
96         void hide_timestretch ();
97         void selection_click (GdkEventButton*);
98         void set_selected_points (PointSelection&);
99         void set_selected_regionviews (RegionSelection&);
100         void get_selectables (ARDOUR::framepos_t start, ARDOUR::framepos_t end, double top, double bot, std::list<Selectable *>&, bool within = false);
101         void get_inverted_selectables (Selection&, std::list<Selectable*>&);
102         void set_layer_display (LayerDisplay d, bool apply_to_selection = false);
103         LayerDisplay layer_display () const;
104
105         boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t pos, ARDOUR::RegionPoint, int32_t dir);
106         framepos_t find_next_region_boundary (framepos_t pos, int32_t dir);
107
108         /* Editing operations */
109         void cut_copy_clear (Selection&, Editing::CutCopyOp);
110         bool paste (ARDOUR::framepos_t, const Selection&, PasteContext& ctx, const int32_t sub_num);
111         RegionView* combine_regions ();
112         void uncombine_regions ();
113         void uncombine_region (RegionView*);
114         void toggle_automation_track (const Evoral::Parameter& param);
115         void fade_range (TimeSelection&);
116
117         /* The editor calls these when mapping an operation across multiple tracks */
118         void use_new_playlist (bool prompt, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &, bool copy);
119         void clear_playlist ();
120
121         /* group playlist name resolving */
122         std::string resolve_new_group_playlist_name(std::string &, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
123
124         void build_playlist_menu ();
125
126         void add_underlay (StreamView*, bool update_xml = true);
127         void remove_underlay (StreamView*);
128         void build_underlay_menu(Gtk::Menu*);
129
130         int set_state (const XMLNode&, int version);
131
132         virtual Gtk::CheckMenuItem* automation_child_menu_item (Evoral::Parameter);
133
134         StreamView*         view() const { return _view; }
135         ARDOUR::RouteGroup* route_group() const;
136         boost::shared_ptr<ARDOUR::Playlist> playlist() const;
137
138         void fast_update ();
139         void hide_meter ();
140         void show_meter ();
141         void reset_meter ();
142         void clear_meter ();
143         void io_changed (ARDOUR::IOChange, void *);
144         void meter_changed ();
145         void effective_gain_display () { gm.effective_gain_display(); }
146
147         std::string state_id() const;
148
149 protected:
150         friend class StreamView;
151
152         struct ProcessorAutomationNode {
153                 Evoral::Parameter                         what;
154                 Gtk::CheckMenuItem*                       menu_item;
155                 boost::shared_ptr<AutomationTimeAxisView> view;
156                 RouteTimeAxisView&                        parent;
157
158             ProcessorAutomationNode (Evoral::Parameter w, Gtk::CheckMenuItem* mitem, RouteTimeAxisView& p)
159                     : what (w), menu_item (mitem), parent (p) {}
160
161             ~ProcessorAutomationNode ();
162         };
163
164         struct ProcessorAutomationInfo {
165             boost::shared_ptr<ARDOUR::Processor> processor;
166             bool                                 valid;
167             Gtk::Menu*                           menu;
168             std::vector<ProcessorAutomationNode*>     lines;
169
170             ProcessorAutomationInfo (boost::shared_ptr<ARDOUR::Processor> i)
171                     : processor (i), valid (true), menu (0) {}
172
173             ~ProcessorAutomationInfo ();
174         };
175
176
177         void update_diskstream_display ();
178
179         bool route_group_click  (GdkEventButton *);
180
181         void processors_changed (ARDOUR::RouteProcessorChange);
182
183         virtual void add_processor_to_subplugin_menu (boost::weak_ptr<ARDOUR::Processor>);
184         void remove_processor_automation_node (ProcessorAutomationNode* pan);
185
186         void processor_menu_item_toggled (RouteTimeAxisView::ProcessorAutomationInfo*,
187                                          RouteTimeAxisView::ProcessorAutomationNode*);
188
189         void processor_automation_track_hidden (ProcessorAutomationNode*,
190                                                boost::shared_ptr<ARDOUR::Processor>);
191
192
193         ProcessorAutomationNode*
194         find_processor_automation_node (boost::shared_ptr<ARDOUR::Processor> i, Evoral::Parameter);
195
196         boost::shared_ptr<AutomationLine>
197         find_processor_automation_curve (boost::shared_ptr<ARDOUR::Processor> i, Evoral::Parameter);
198
199         void add_processor_automation_curve (boost::shared_ptr<ARDOUR::Processor> r, Evoral::Parameter);
200         void add_existing_processor_automation_curves (boost::weak_ptr<ARDOUR::Processor>);
201
202
203         void reset_processor_automation_curves ();
204
205         void take_name_changed (void *src);
206         void route_property_changed (const PBD::PropertyChange&);
207         bool name_entry_changed (std::string const&);
208
209         virtual void toggle_channel_selector () {}
210
211         void blink_rec_display (bool onoff);
212
213         virtual void label_view ();
214
215         virtual void build_automation_action_menu (bool);
216         virtual void append_extra_display_menu_items () {}
217         void         build_display_menu ();
218
219         void set_align_choice (Gtk::RadioMenuItem*, ARDOUR::AlignChoice, bool apply_to_selection = false);
220
221         bool         playlist_click (GdkEventButton *);
222         void         show_playlist_selector ();
223         void         playlist_changed ();
224
225         void rename_current_playlist ();
226
227         bool         automation_click (GdkEventButton *);
228
229         virtual void show_all_automation (bool apply_to_selection = false);
230         virtual void show_existing_automation (bool apply_to_selection = false);
231         virtual void hide_all_automation (bool apply_to_selection = false);
232
233         void timestretch (framepos_t start, framepos_t end);
234         void speed_changed ();
235         void map_frozen ();
236         void color_handler ();
237         void region_view_added (RegionView*);
238         void create_gain_automation_child (const Evoral::Parameter &, bool);
239         void create_trim_automation_child (const Evoral::Parameter &, bool);
240         void create_mute_automation_child (const Evoral::Parameter &, bool);
241         void setup_processor_menu_and_curves ();
242         void route_color_changed ();
243         bool can_edit_name() const;
244
245         StreamView*           _view;
246
247         Gtk::HBox   other_button_hbox;
248         Gtk::Table  button_table;
249         ArdourButton route_group_button;
250         ArdourButton playlist_button;
251         ArdourButton automation_button;
252         ArdourButton number_label;
253
254         Gtk::Menu           subplugin_menu;
255         Gtk::Menu*          automation_action_menu;
256         Gtk::MenuItem*      plugins_submenu_item;
257         RouteGroupMenu*     route_group_menu;
258         Gtk::Menu*          playlist_action_menu;
259         Gtk::MenuItem*      playlist_item;
260         Gtk::Menu*          mode_menu;
261         Gtk::Menu*          color_mode_menu;
262
263         virtual Gtk::Menu* build_color_mode_menu() { return 0; }
264
265         void use_playlist (Gtk::RadioMenuItem *item, boost::weak_ptr<ARDOUR::Playlist> wpl);
266
267         ArdourCanvas::Rectangle* timestretch_rect;
268
269 #ifdef XXX_OLD_DESTRUCTIVE_API_XXX
270         void set_track_mode (ARDOUR::TrackMode, bool apply_to_selection = false);
271 #endif
272
273         /** Information about all automatable processor parameters that apply to
274          *  this route.  The Amp processor is not included in this list.
275          */
276         std::list<ProcessorAutomationInfo*> processor_automation;
277
278         typedef std::vector<boost::shared_ptr<AutomationLine> > ProcessorAutomationCurves;
279         ProcessorAutomationCurves processor_automation_curves;
280         /** parameter -> menu item map for the plugin automation menu */
281         ParameterMenuMap _subplugin_menu_map;
282
283         void post_construct ();
284
285         GainMeterBase gm;
286
287         XMLNode* underlay_xml_node;
288         bool set_underlay_state();
289
290         typedef std::list<StreamView*> UnderlayList;
291         UnderlayList _underlay_streams;
292         typedef std::list<RouteTimeAxisView*> UnderlayMirrorList;
293         UnderlayMirrorList _underlay_mirrors;
294
295         bool _ignore_set_layer_display;
296
297 protected:
298         void update_pan_track_visibility ();
299
300         /** Ensure that we have the appropriate automation lanes for panners.
301          *
302          *  @param show true to show any new views that we create, otherwise false.
303          */
304         void ensure_pan_views (bool show = true);
305
306         std::list<boost::shared_ptr<AutomationTimeAxisView> > pan_tracks;
307         Gtk::CheckMenuItem* pan_automation_item;
308
309 private:
310
311         void remove_child (boost::shared_ptr<TimeAxisView>);
312         void update_playlist_tip ();
313         void parameter_changed (std::string const & p);
314         void update_track_number_visibility();
315 };
316
317 #endif /* __ardour_route_time_axis_h__ */