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         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 void create_automation_child (const Evoral::Parameter& param, bool show) = 0;
 133
 134         typedef std::map<Evoral::Parameter, boost::shared_ptr<AutomationTimeAxisView> > AutomationTracks;
 135         const AutomationTracks& automation_tracks() const { return _automation_tracks; }
 136
 137         boost::shared_ptr<AutomationTimeAxisView> automation_child(Evoral::Parameter param);
 138         virtual Gtk::CheckMenuItem* automation_child_menu_item (Evoral::Parameter);
 139
 140         StreamView*         view() const { return _view; }
 141         ARDOUR::RouteGroup* route_group() const;
 142         boost::shared_ptr<ARDOUR::Playlist> playlist() const;
 143
 144         void fast_update ();
 145         void hide_meter ();
 146         void show_meter ();
 147         void reset_meter ();
 148         void clear_meter ();
 149         void io_changed (ARDOUR::IOChange, void *);
 150         void meter_changed ();
 151         void effective_gain_display () { gm.effective_gain_display(); }
 152
 153         std::string state_id() const;
 154
 155 protected:
 156         friend class StreamView;
 157
 158         struct ProcessorAutomationNode {
 159                 Evoral::Parameter                         what;
 160                 Gtk::CheckMenuItem*                       menu_item;
 161                 boost::shared_ptr<AutomationTimeAxisView> view;
 162                 RouteTimeAxisView&                        parent;
 163
 164             ProcessorAutomationNode (Evoral::Parameter w, Gtk::CheckMenuItem* mitem, RouteTimeAxisView& p)
 165                     : what (w), menu_item (mitem), parent (p) {}
 166
 167             ~ProcessorAutomationNode ();
 168         };
 169
 170         struct ProcessorAutomationInfo {
 171             boost::shared_ptr<ARDOUR::Processor> processor;
 172             bool                                 valid;
 173             Gtk::Menu*                           menu;
 174             std::vector<ProcessorAutomationNode*>     lines;
 175
 176             ProcessorAutomationInfo (boost::shared_ptr<ARDOUR::Processor> i)
 177                     : processor (i), valid (true), menu (0) {}
 178
 179             ~ProcessorAutomationInfo ();
 180         };
 181
 182
 183         void update_diskstream_display ();
 184
 185         bool route_group_click  (GdkEventButton *);
 186
 187         void processors_changed (ARDOUR::RouteProcessorChange);
 188
 189         virtual void add_processor_to_subplugin_menu (boost::weak_ptr<ARDOUR::Processor>);
 190         void remove_processor_automation_node (ProcessorAutomationNode* pan);
 191
 192         void processor_menu_item_toggled (RouteTimeAxisView::ProcessorAutomationInfo*,
 193                                          RouteTimeAxisView::ProcessorAutomationNode*);
 194
 195         void processor_automation_track_hidden (ProcessorAutomationNode*,
 196                                                boost::shared_ptr<ARDOUR::Processor>);
 197
 198         void automation_track_hidden (Evoral::Parameter param);
 199
 200         ProcessorAutomationNode*
 201         find_processor_automation_node (boost::shared_ptr<ARDOUR::Processor> i, Evoral::Parameter);
 202
 203         boost::shared_ptr<AutomationLine>
 204         find_processor_automation_curve (boost::shared_ptr<ARDOUR::Processor> i, Evoral::Parameter);
 205
 206         void add_processor_automation_curve (boost::shared_ptr<ARDOUR::Processor> r, Evoral::Parameter);
 207         void add_existing_processor_automation_curves (boost::weak_ptr<ARDOUR::Processor>);
 208
 209         void add_automation_child(Evoral::Parameter param, boost::shared_ptr<AutomationTimeAxisView> track, bool show=true);
 210
 211         void reset_processor_automation_curves ();
 212
 213         void take_name_changed (void *src);
 214         void route_property_changed (const PBD::PropertyChange&);
 215         bool name_entry_changed (std::string const&);
 216
 217         virtual void toggle_channel_selector () {}
 218
 219         void blink_rec_display (bool onoff);
 220
 221         virtual void label_view ();
 222
 223         void reset_samples_per_pixel ();
 224
 225         virtual void build_automation_action_menu (bool);
 226         virtual void append_extra_display_menu_items () {}
 227         void         build_display_menu ();
 228
 229         void set_align_choice (Gtk::RadioMenuItem*, ARDOUR::AlignChoice, bool apply_to_selection = false);
 230
 231         bool         playlist_click (GdkEventButton *);
 232         void         show_playlist_selector ();
 233         void         playlist_changed ();
 234
 235         void rename_current_playlist ();
 236
 237         bool         automation_click (GdkEventButton *);
 238
 239         virtual void show_all_automation (bool apply_to_selection = false);
 240         virtual void show_existing_automation (bool apply_to_selection = false);
 241         virtual void hide_all_automation (bool apply_to_selection = false);
 242
 243         void timestretch (framepos_t start, framepos_t end);
 244         void speed_changed ();
 245         void map_frozen ();
 246         void color_handler ();
 247         void region_view_added (RegionView*);
 248         void create_gain_automation_child (const Evoral::Parameter &, bool);
 249         void create_trim_automation_child (const Evoral::Parameter &, bool);
 250         void create_mute_automation_child (const Evoral::Parameter &, bool);
 251         void setup_processor_menu_and_curves ();
 252         void route_color_changed ();
 253         bool can_edit_name() const;
 254
 255         boost::shared_ptr<AutomationTimeAxisView> gain_track;
 256         boost::shared_ptr<AutomationTimeAxisView> trim_track;
 257         boost::shared_ptr<AutomationTimeAxisView> mute_track;
 258
 259         StreamView*           _view;
 260         ArdourCanvas::Canvas& parent_canvas;
 261         bool                  no_redraw;
 262
 263         Gtk::HBox   other_button_hbox;
 264         Gtk::Table  button_table;
 265         ArdourButton route_group_button;
 266         ArdourButton playlist_button;
 267         ArdourButton automation_button;
 268         ArdourButton number_label;
 269
 270         Gtk::Menu           subplugin_menu;
 271         Gtk::Menu*          automation_action_menu;
 272         Gtk::MenuItem*      plugins_submenu_item;
 273         RouteGroupMenu*     route_group_menu;
 274         Gtk::Menu*          playlist_action_menu;
 275         Gtk::MenuItem*      playlist_item;
 276         Gtk::Menu*          mode_menu;
 277         Gtk::Menu*          color_mode_menu;
 278
 279         virtual Gtk::Menu* build_color_mode_menu() { return 0; }
 280
 281         void use_playlist (Gtk::RadioMenuItem *item, boost::weak_ptr<ARDOUR::Playlist> wpl);
 282
 283         ArdourCanvas::Rectangle* timestretch_rect;
 284
 285 #ifdef XXX_OLD_DESTRUCTIVE_API_XXX
 286         void set_track_mode (ARDOUR::TrackMode, bool apply_to_selection = false);
 287 #endif
 288
 289         /** Information about all automatable processor parameters that apply to
 290          *  this route.  The Amp processor is not included in this list.
 291          */
 292         std::list<ProcessorAutomationInfo*> processor_automation;
 293
 294         typedef std::vector<boost::shared_ptr<AutomationLine> > ProcessorAutomationCurves;
 295         ProcessorAutomationCurves processor_automation_curves;
 296
 297         AutomationTracks _automation_tracks;
 298         typedef std::map<Evoral::Parameter, Gtk::CheckMenuItem*> ParameterMenuMap;
 299         /** parameter -> menu item map for the main automation menu */
 300         ParameterMenuMap _main_automation_menu_map;
 301         /** parameter -> menu item map for the plugin automation menu */
 302         ParameterMenuMap _subplugin_menu_map;
 303
 304         void post_construct ();
 305
 306         GainMeterBase gm;
 307
 308         XMLNode* underlay_xml_node;
 309         bool set_underlay_state();
 310
 311         typedef std::list<StreamView*> UnderlayList;
 312         UnderlayList _underlay_streams;
 313         typedef std::list<RouteTimeAxisView*> UnderlayMirrorList;
 314         UnderlayMirrorList _underlay_mirrors;
 315
 316         bool _ignore_set_layer_display;
 317
 318 protected:
 319         void update_gain_track_visibility ();
 320         void update_trim_track_visibility ();
 321         void update_mute_track_visibility ();
 322         void update_pan_track_visibility ();
 323
 324         /** Ensure that we have the appropriate automation lanes for panners.
 325          *
 326          *  @param show true to show any new views that we create, otherwise false.
 327          */
 328         void ensure_pan_views (bool show = true);
 329
 330         Gtk::CheckMenuItem* gain_automation_item;
 331         Gtk::CheckMenuItem* trim_automation_item;
 332         Gtk::CheckMenuItem* mute_automation_item;
 333         std::list<boost::shared_ptr<AutomationTimeAxisView> > pan_tracks;
 334         Gtk::CheckMenuItem* pan_automation_item;
 335
 336 private:
 337
 338         void remove_child (boost::shared_ptr<TimeAxisView>);
 339         void update_playlist_tip ();
 340         void parameter_changed (std::string const & p);
 341         void update_track_number_visibility();
 342 };
 343
 344 #endif /* __ardour_route_time_axis_h__ */