Merge branch 'master' into saveas
[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 "time_axis_view.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 TimeAxisView
76 {
77 public:
78         RouteTimeAxisView (PublicEditor&, ARDOUR::Session*, ArdourCanvas::Canvas& canvas);
79         virtual ~RouteTimeAxisView ();
80
81         void set_route (boost::shared_ptr<ARDOUR::Route>);
82
83         void show_selection (TimeSelection&);
84         void set_button_names ();
85
86         void set_samples_per_pixel (double);
87         void set_height (uint32_t h, TrackHeightMode m = OnlySelf);
88         void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
89         void hide_timestretch ();
90         void selection_click (GdkEventButton*);
91         void set_selected_points (PointSelection&);
92         void set_selected_regionviews (RegionSelection&);
93         void get_selectables (ARDOUR::framepos_t start, ARDOUR::framepos_t end, double top, double bot, std::list<Selectable *>&, bool within = false);
94         void get_inverted_selectables (Selection&, std::list<Selectable*>&);
95         void set_layer_display (LayerDisplay d, bool apply_to_selection = false);
96         LayerDisplay layer_display () const;
97
98         boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t pos, ARDOUR::RegionPoint, int32_t dir);
99         framepos_t find_next_region_boundary (framepos_t pos, int32_t dir);
100
101         /* Editing operations */
102         void cut_copy_clear (Selection&, Editing::CutCopyOp);
103         bool paste (ARDOUR::framepos_t, const Selection&, PasteContext& ctx);
104         RegionView* combine_regions ();
105         void uncombine_regions ();
106         void uncombine_region (RegionView*);
107         void toggle_automation_track (const Evoral::Parameter& param);
108         void fade_range (TimeSelection&);
109
110         /* The editor calls these when mapping an operation across multiple tracks */
111         void use_new_playlist (bool prompt, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
112         void use_copy_playlist (bool prompt, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
113         void clear_playlist ();
114
115         /* group playlist name resolving */
116         std::string resolve_new_group_playlist_name(std::string &, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
117
118         void build_playlist_menu ();
119
120         void add_underlay (StreamView*, bool update_xml = true);
121         void remove_underlay (StreamView*);
122         void build_underlay_menu(Gtk::Menu*);
123
124         int set_state (const XMLNode&, int version);
125
126         virtual void create_automation_child (const Evoral::Parameter& param, bool show) = 0;
127
128         typedef std::map<Evoral::Parameter, boost::shared_ptr<AutomationTimeAxisView> > AutomationTracks;
129         const AutomationTracks& automation_tracks() const { return _automation_tracks; }
130
131         boost::shared_ptr<AutomationTimeAxisView> automation_child(Evoral::Parameter param);
132         virtual Gtk::CheckMenuItem* automation_child_menu_item (Evoral::Parameter);
133
134         std::string         name() const;
135         StreamView*         view() const { return _view; }
136         ARDOUR::RouteGroup* route_group() const;
137         boost::shared_ptr<ARDOUR::Playlist> playlist() const;
138
139         void fast_update ();
140         void hide_meter ();
141         void show_meter ();
142         void reset_meter ();
143         void clear_meter ();
144         void io_changed (ARDOUR::IOChange, void *);
145         void meter_changed ();
146         void effective_gain_display () { gm.effective_gain_display(); }
147
148         std::string state_id() const;
149
150 protected:
151         friend class StreamView;
152
153         struct ProcessorAutomationNode {
154                 Evoral::Parameter                         what;
155                 Gtk::CheckMenuItem*                       menu_item;
156                 boost::shared_ptr<AutomationTimeAxisView> view;
157                 RouteTimeAxisView&                        parent;
158
159             ProcessorAutomationNode (Evoral::Parameter w, Gtk::CheckMenuItem* mitem, RouteTimeAxisView& p)
160                     : what (w), menu_item (mitem), parent (p) {}
161
162             ~ProcessorAutomationNode ();
163         };
164
165         struct ProcessorAutomationInfo {
166             boost::shared_ptr<ARDOUR::Processor> processor;
167             bool                                 valid;
168             Gtk::Menu*                           menu;
169             std::vector<ProcessorAutomationNode*>     lines;
170
171             ProcessorAutomationInfo (boost::shared_ptr<ARDOUR::Processor> i)
172                     : processor (i), valid (true), menu (0) {}
173
174             ~ProcessorAutomationInfo ();
175         };
176
177
178         void update_diskstream_display ();
179
180         gint route_group_click  (GdkEventButton *);
181
182         void processors_changed (ARDOUR::RouteProcessorChange);
183
184         virtual void add_processor_to_subplugin_menu (boost::weak_ptr<ARDOUR::Processor>);
185         void remove_processor_automation_node (ProcessorAutomationNode* pan);
186
187         void processor_menu_item_toggled (RouteTimeAxisView::ProcessorAutomationInfo*,
188                                          RouteTimeAxisView::ProcessorAutomationNode*);
189
190         void processor_automation_track_hidden (ProcessorAutomationNode*,
191                                                boost::shared_ptr<ARDOUR::Processor>);
192
193         void automation_track_hidden (Evoral::Parameter param);
194
195         ProcessorAutomationNode*
196         find_processor_automation_node (boost::shared_ptr<ARDOUR::Processor> i, Evoral::Parameter);
197
198         boost::shared_ptr<AutomationLine>
199         find_processor_automation_curve (boost::shared_ptr<ARDOUR::Processor> i, Evoral::Parameter);
200
201         void add_processor_automation_curve (boost::shared_ptr<ARDOUR::Processor> r, Evoral::Parameter);
202         void add_existing_processor_automation_curves (boost::weak_ptr<ARDOUR::Processor>);
203
204         void add_automation_child(Evoral::Parameter param, boost::shared_ptr<AutomationTimeAxisView> track, bool show=true);
205
206         void reset_processor_automation_curves ();
207
208         void take_name_changed (void *src);
209         void route_property_changed (const PBD::PropertyChange&);
210         void name_entry_changed ();
211
212         void blink_rec_display (bool onoff);
213
214         virtual void label_view ();
215
216         void reset_samples_per_pixel ();
217
218         virtual void build_automation_action_menu (bool);
219         virtual void append_extra_display_menu_items () {}
220         void         build_display_menu ();
221
222         void set_align_choice (Gtk::RadioMenuItem*, ARDOUR::AlignChoice, bool apply_to_selection = false);
223
224         void         playlist_click ();
225         void         show_playlist_selector ();
226         void         playlist_changed ();
227
228         void rename_current_playlist ();
229
230         void         automation_click ();
231
232         virtual void show_all_automation (bool apply_to_selection = false);
233         virtual void show_existing_automation (bool apply_to_selection = false);
234         virtual void hide_all_automation (bool apply_to_selection = false);
235
236         void timestretch (framepos_t start, framepos_t end);
237         void speed_changed ();
238         void map_frozen ();
239         void color_handler ();
240         void region_view_added (RegionView*);
241         void create_gain_automation_child (const Evoral::Parameter &, bool);
242         void create_mute_automation_child (const Evoral::Parameter &, bool);
243         void setup_processor_menu_and_curves ();
244         void route_color_changed ();
245         bool can_edit_name() const;
246
247         boost::shared_ptr<AutomationTimeAxisView> gain_track;
248         boost::shared_ptr<AutomationTimeAxisView> mute_track;
249
250         StreamView*           _view;
251         ArdourCanvas::Canvas& parent_canvas;
252         bool                  no_redraw;
253
254         Gtk::HBox   other_button_hbox;
255         Gtk::Table  button_table;
256         ArdourButton route_group_button;
257         ArdourButton playlist_button;
258         ArdourButton automation_button;
259         ArdourButton number_label;
260
261         Gtk::Menu           subplugin_menu;
262         Gtk::Menu*          automation_action_menu;
263         Gtk::MenuItem*      plugins_submenu_item;
264         RouteGroupMenu*     route_group_menu;
265         Gtk::Menu*          playlist_action_menu;
266         Gtk::MenuItem*      playlist_item;
267         Gtk::Menu*          mode_menu;
268         Gtk::Menu*          color_mode_menu;
269
270         virtual Gtk::Menu* build_color_mode_menu() { return 0; }
271
272         void use_playlist (Gtk::RadioMenuItem *item, boost::weak_ptr<ARDOUR::Playlist> wpl);
273
274         ArdourCanvas::Rectangle* timestretch_rect;
275
276         void set_track_mode (ARDOUR::TrackMode, bool apply_to_selection = false);
277
278         /** Information about all automatable processor parameters that apply to
279          *  this route.  The Amp processor is not included in this list.
280          */
281         std::list<ProcessorAutomationInfo*> processor_automation;
282
283         typedef std::vector<boost::shared_ptr<AutomationLine> > ProcessorAutomationCurves;
284         ProcessorAutomationCurves processor_automation_curves;
285
286         AutomationTracks _automation_tracks;
287         typedef std::map<Evoral::Parameter, Gtk::CheckMenuItem*> ParameterMenuMap;
288         /** parameter -> menu item map for the main automation menu */
289         ParameterMenuMap _main_automation_menu_map;
290         /** parameter -> menu item map for the plugin automation menu */
291         ParameterMenuMap _subplugin_menu_map;
292
293         void post_construct ();
294
295         GainMeterBase gm;
296
297         XMLNode* underlay_xml_node;
298         bool set_underlay_state();
299
300         typedef std::list<StreamView*> UnderlayList;
301         UnderlayList _underlay_streams;
302         typedef std::list<RouteTimeAxisView*> UnderlayMirrorList;
303         UnderlayMirrorList _underlay_mirrors;
304
305         bool _ignore_set_layer_display;
306
307 protected:
308         void update_gain_track_visibility ();
309         void update_mute_track_visibility ();
310         void update_pan_track_visibility ();
311
312         /** Ensure that we have the appropriate automation lanes for panners.
313          *
314          *  @param show true to show any new views that we create, otherwise false.
315          */
316         void ensure_pan_views (bool show = true);
317
318         Gtk::CheckMenuItem* gain_automation_item;
319         Gtk::CheckMenuItem* mute_automation_item;
320         std::list<boost::shared_ptr<AutomationTimeAxisView> > pan_tracks;
321         Gtk::CheckMenuItem* pan_automation_item;
322
323 private:
324
325         void remove_child (boost::shared_ptr<TimeAxisView>);
326         void update_playlist_tip ();
327         void parameter_changed (std::string const & p);
328         void update_track_number_visibility();
329 };
330
331 #endif /* __ardour_route_time_axis_h__ */
332